%s%s", html.EscapeString(step.DisplayAndWaitParams.Data)), false, true)
- case bridgev2.LoginDisplayTypeNothing:
- // Do nothing
- default:
- ce.Reply("Unsupported display type %q", step.DisplayAndWaitParams.Type)
- login.Cancel()
- return
- }
- nextStep, err := login.Wait(cancelCtx)
- // Redact the QR code, unless the next step is refreshing the code (in which case the event is just edited)
- if *prevEvent != "" && (nextStep == nil || nextStep.StepID != step.StepID) {
- _, _ = ce.Bot.SendMessage(ce.Ctx, ce.RoomID, event.EventRedaction, &event.Content{
- Parsed: &event.RedactionEventContent{
- Redacts: *prevEvent,
- },
- }, nil)
- *prevEvent = ""
- }
- if err != nil {
- ce.Reply("Login failed: %v", err)
- return
- }
- doLoginStep(ce, login, nextStep, override)
-}
-
-type cookieLoginCommandState struct {
- Login bridgev2.LoginProcessCookies
- Data *bridgev2.LoginCookiesParams
- Override *bridgev2.UserLogin
-}
-
-func (clcs *cookieLoginCommandState) prompt(ce *Event) {
- ce.Reply("Login URL: <%s>", clcs.Data.URL)
- StoreCommandState(ce.User, &CommandState{
- Next: MinimalCommandHandlerFunc(clcs.submit),
- Action: "Login",
- Meta: clcs,
- Cancel: clcs.Login.Cancel,
- })
-}
-
-func (clcs *cookieLoginCommandState) submit(ce *Event) {
- ce.Redact()
-
- cookiesInput := make(map[string]string)
- if strings.HasPrefix(strings.TrimSpace(ce.RawArgs), "curl") {
- parsed, err := curl.Parse(ce.RawArgs)
- if err != nil {
- ce.Reply("Failed to parse curl: %v", err)
- return
- }
- reqCookies := make(map[string]string)
- for _, cookie := range parsed.Cookies() {
- reqCookies[cookie.Name], err = url.PathUnescape(cookie.Value)
- if err != nil {
- ce.Reply("Failed to parse cookie %s: %v", cookie.Name, err)
- return
- }
- }
- var missingKeys, unsupportedKeys []string
- for _, field := range clcs.Data.Fields {
- var value string
- var supported bool
- for _, src := range field.Sources {
- switch src.Type {
- case bridgev2.LoginCookieTypeCookie:
- supported = true
- value = reqCookies[src.Name]
- case bridgev2.LoginCookieTypeRequestHeader:
- supported = true
- value = parsed.Header.Get(src.Name)
- case bridgev2.LoginCookieTypeRequestBody:
- supported = true
- switch {
- case parsed.MultipartForm != nil:
- values, ok := parsed.MultipartForm.Value[src.Name]
- if ok && len(values) > 0 {
- value = values[0]
- }
- case parsed.ParsedJSON != nil:
- untypedValue, ok := parsed.ParsedJSON[src.Name]
- if ok {
- value = fmt.Sprintf("%v", untypedValue)
- }
- }
- }
- if value != "" {
- cookiesInput[field.ID] = value
- break
- }
- }
- if value == "" && field.Required {
- if supported {
- missingKeys = append(missingKeys, field.ID)
- } else {
- unsupportedKeys = append(unsupportedKeys, field.ID)
- }
- }
- }
- if len(unsupportedKeys) > 0 {
- ce.Reply("Some keys can't be extracted from a cURL request: %+v\n\nPlease provide a JSON object instead.", unsupportedKeys)
- return
- } else if len(missingKeys) > 0 {
- ce.Reply("Missing some keys: %+v", missingKeys)
- return
- }
- } else {
- err := json.Unmarshal([]byte(ce.RawArgs), &cookiesInput)
- if err != nil {
- ce.Reply("Failed to parse input as JSON: %v", err)
- return
- }
- for _, field := range clcs.Data.Fields {
- val, ok := cookiesInput[field.ID]
- if ok {
- cookiesInput[field.ID] = maybeURLDecodeCookie(val, &field)
- }
- }
- }
- var missingKeys []string
- for _, field := range clcs.Data.Fields {
- val, ok := cookiesInput[field.ID]
- if !ok && field.Required {
- missingKeys = append(missingKeys, field.ID)
- }
- if match, _ := regexp.MatchString(field.Pattern, val); !match {
- ce.Reply("Invalid value for %s: `%s` doesn't match regex `%s`", field.ID, val, field.Pattern)
- return
- }
- }
- if len(missingKeys) > 0 {
- ce.Reply("Missing some keys: %+v", missingKeys)
- return
- }
- StoreCommandState(ce.User, nil)
- nextStep, err := clcs.Login.SubmitCookies(ce.Ctx, cookiesInput)
- if err != nil {
- ce.Reply("Login failed: %v", err)
- return
- }
- doLoginStep(ce, clcs.Login, nextStep, clcs.Override)
-}
-
-func maybeURLDecodeCookie(val string, field *bridgev2.LoginCookieField) string {
- if val == "" {
- return val
- }
- isCookie := slices.ContainsFunc(field.Sources, func(src bridgev2.LoginCookieFieldSource) bool {
- return src.Type == bridgev2.LoginCookieTypeCookie
- })
- if !isCookie {
- return val
- }
- decoded, err := url.PathUnescape(val)
- if err != nil {
- return val
- }
- return decoded
-}
-
-func doLoginStep(ce *Event, login bridgev2.LoginProcess, step *bridgev2.LoginStep, override *bridgev2.UserLogin) {
- ce.Log.Debug().Any("next_step", step).Msg("Got next login step")
- if step.Instructions != "" {
- ce.Reply(step.Instructions)
- }
-
- switch step.Type {
- case bridgev2.LoginStepTypeDisplayAndWait:
- doLoginDisplayAndWait(ce, login.(bridgev2.LoginProcessDisplayAndWait), step, override)
- case bridgev2.LoginStepTypeCookies:
- (&cookieLoginCommandState{
- Login: login.(bridgev2.LoginProcessCookies),
- Data: step.CookiesParams,
- Override: override,
- }).prompt(ce)
- case bridgev2.LoginStepTypeUserInput:
- err := sendUserInputAttachments(ce, step.UserInputParams.Attachments)
- if err != nil {
- ce.Reply("Failed to send attachments: %v", err)
- }
- (&userInputLoginCommandState{
- Login: login.(bridgev2.LoginProcessUserInput),
- RemainingFields: step.UserInputParams.Fields,
- Data: make(map[string]string),
- Override: override,
- }).promptNext(ce)
- case bridgev2.LoginStepTypeComplete:
- if override != nil && override.ID != step.CompleteParams.UserLoginID {
- ce.Log.Info().
- Str("old_login_id", string(override.ID)).
- Str("new_login_id", string(step.CompleteParams.UserLoginID)).
- Msg("Login resulted in different remote ID than what was being overridden. Deleting previous login")
- override.Delete(ce.Ctx, status.BridgeState{
- StateEvent: status.StateLoggedOut,
- Reason: "LOGIN_OVERRIDDEN",
- }, bridgev2.DeleteOpts{LogoutRemote: true})
- }
- default:
- panic(fmt.Errorf("unknown login step type %q", step.Type))
- }
-}
-
-var CommandListLogins = &FullHandler{
- Func: fnListLogins,
- Name: "list-logins",
- Help: HelpMeta{
- Section: HelpSectionAuth,
- Description: "List your logins",
- },
- RequiresLoginPermission: true,
-}
-
-func fnListLogins(ce *Event) {
- logins := ce.User.GetFormattedUserLogins()
- if len(logins) == 0 {
- ce.Reply("You're not logged in")
- } else {
- ce.Reply("%s", logins)
- }
-}
-
-var CommandLogout = &FullHandler{
- Func: fnLogout,
- Name: "logout",
- Help: HelpMeta{
- Section: HelpSectionAuth,
- Description: "Log out of the bridge",
- Args: "<_login ID_>",
- },
-}
-
-func fnLogout(ce *Event) {
- if len(ce.Args) == 0 {
- ce.Reply("Usage: `$cmdprefix logout %s not found", html.EscapeString(identifier)), false, true)
- return
- }
- formattedName := formatResolveIdentifierResult(resp)
- if createChat {
- name := resp.Portal.Name
- if name == "" {
- name = resp.Portal.MXID.String()
- }
- if !resp.JustCreated {
- ce.Reply("You already have a direct chat with %s at [%s](%s)", formattedName, name, resp.Portal.MXID.URI().MatrixToURL())
- } else {
- 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",
- Help: HelpMeta{
- Section: HelpSectionChats,
- Description: "Search for users on the remote network",
- Args: "<_query_>",
- },
- RequiresLogin: true,
- NetworkAPI: NetworkAPIImplements[bridgev2.UserSearchingNetworkAPI],
-}
-
-func fnSearch(ce *Event) {
- if len(ce.Args) == 0 {
- 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) - } - mediaPart.ID = textPart.ID - return mediaPart -} - -func (cm *ConvertedMessage) MergeCaption() bool { - if len(cm.Parts) != 2 { - return false - } - textPart, mediaPart := cm.Parts[1], cm.Parts[0] - if textPart.Content.MsgType != event.MsgText { - textPart, mediaPart = mediaPart, textPart - } - if (!mediaPart.Content.MsgType.IsMedia() && mediaPart.Content.MsgType != event.MsgNotice) || textPart.Content.MsgType != event.MsgText { - return false - } - merged := MergeCaption(textPart, mediaPart) - if merged != nil { - cm.Parts = []*ConvertedMessagePart{merged} - return true - } - return false -} - -type ConvertedEditPart struct { - Part *database.Message - - Type event.Type - // The Content and Extra fields will be put inside `m.new_content` automatically. - // SetEdit must NOT be called by the network connector. - Content *event.MessageEventContent - Extra map[string]any - // TopLevelExtra can be used to specify custom fields at the top level of the content rather than inside `m.new_content`. - TopLevelExtra map[string]any - // NewMentions can be used to specify new mentions that should ping the users again. - // Mentions inside the edited content will not ping. - NewMentions *event.Mentions - - DontBridge bool -} - -type ConvertedEdit struct { - ModifiedParts []*ConvertedEditPart - DeletedParts []*database.Message - // Warning: added parts will be sent at the end of the room. - // If other messages have been sent after the message being edited, - // these new parts will not be next to the existing parts. - AddedParts *ConvertedMessage -} - -// BridgeName contains information about the network that a connector bridges to. -type BridgeName struct { - // The displayname of the network, e.g. `Discord` - DisplayName string `json:"displayname"` - // The URL to the website of the network, e.g. `https://discord.com` - NetworkURL string `json:"network_url"` - // The icon of the network as a mxc:// URI - NetworkIcon id.ContentURIString `json:"network_icon"` - // An identifier uniquely identifying the network, e.g. `discord` - NetworkID string `json:"network_id"` - // An identifier uniquely identifying the bridge software. - // The Go import path is a good choice here (e.g. github.com/octocat/discordbridge) - BeeperBridgeType string `json:"beeper_bridge_type"` - // The default appservice port to use in the example config, defaults to 8080 if unset - // Official mautrix bridges will use ports defined in https://mau.fi/ports - DefaultPort uint16 `json:"default_port,omitempty"` - // The default command prefix to use in the example config, defaults to NetworkID if unset. Must include the ! prefix. - DefaultCommandPrefix string `json:"default_command_prefix,omitempty"` -} - -func (bn BridgeName) AsBridgeInfoSection() event.BridgeInfoSection { - return event.BridgeInfoSection{ - ID: bn.BeeperBridgeType, - DisplayName: bn.DisplayName, - AvatarURL: bn.NetworkIcon, - ExternalURL: bn.NetworkURL, - } -} - -// NetworkConnector is the main interface that a network connector must implement. -type NetworkConnector interface { - // Init is called when the bridge is initialized. The connector should store the bridge instance for later use. - // This should not do any network calls or other blocking operations. - Init(*Bridge) - // Start is called when the bridge is starting. - // The connector should do any non-user-specific startup actions necessary. - // User logins will be loaded separately, so the connector should not load them here. - Start(context.Context) error - - // GetName returns the name of the bridge and some additional metadata, - // which is used to fill `m.bridge` events among other things. - // - // The first call happens *before* the config is loaded, because the data here is also used to - // fill parts of the example config (like the default username template and bot localpart). - // The output can still be adjusted based on config variables, but the function must have - // default values when called without a config. - GetName() BridgeName - // GetDBMetaTypes returns struct types that are used to store connector-specific metadata in various tables. - // All fields are optional. If a field isn't provided, then the corresponding table will have no custom metadata. - // This will be called before Init, it should have a hardcoded response. - GetDBMetaTypes() database.MetaTypes - // GetCapabilities returns the general capabilities of the network connector. - // Note that most capabilities are scoped to rooms and are returned by [NetworkAPI.GetCapabilities] instead. - GetCapabilities() *NetworkGeneralCapabilities - // GetConfig returns all the parts of the network connector's config file. Specifically: - // - example: a string containing an example config file - // - data: an interface to unmarshal the actual config into - // - upgrader: a config upgrader to ensure all fields are present and to do any migrations from old configs - GetConfig() (example string, data any, upgrader configupgrade.Upgrader) - - // LoadUserLogin is called when a UserLogin is loaded from the database in order to fill the [UserLogin.Client] field. - // - // This is called within the bridge's global cache lock, so it must not do any slow operations, - // such as connecting to the network. Instead, connecting should happen when [NetworkAPI.Connect] is called later. - LoadUserLogin(ctx context.Context, login *UserLogin) error - - // GetLoginFlows returns a list of login flows that the network supports. - GetLoginFlows() []LoginFlow - // CreateLogin is called when a user wants to log in to the network. - // - // 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() -} - -// DirectMediableNetwork is an optional interface that network connectors can implement to support direct media access. -// -// If the Matrix connector has direct media enabled, SetUseDirectMedia will be called -// before the Start method of the network connector. Download will then be called -// whenever someone wants to download a direct media `mxc://` URI which was generated -// by calling GenerateContentURI on the Matrix connector. -type DirectMediableNetwork interface { - NetworkConnector - SetUseDirectMedia() - 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) -} - -// ConfigValidatingNetwork is an optional interface that network connectors can implement to validate config fields -// before the bridge is started. -// -// When the ValidateConfig method is called, the config data will already be unmarshaled into the -// object returned by [NetworkConnector.GetConfig]. -// -// This mechanism is usually used to refuse bridge startup if a mandatory field has an invalid value. -type ConfigValidatingNetwork interface { - NetworkConnector - ValidateConfig() error -} - -// MaxFileSizeingNetwork is an optional interface that network connectors can implement -// to find out the maximum file size that can be uploaded to Matrix. -// -// The SetMaxFileSize will be called asynchronously soon after startup. -// Before the function is called, the connector may assume a default limit of 50 MiB. -type MaxFileSizeingNetwork interface { - NetworkConnector - 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 { - DB *database.Message - StreamOrder int64 - // If Pending is set, the bridge will not save the provided message to the database. - // This should only be used if AddPendingToSave has been called. - Pending bool - // If RemovePending is set, the bridge will remove the provided transaction ID from pending messages - // after saving the provided message to the database. This should be used with AddPendingToIgnore. - RemovePending networkid.TransactionID - // An optional function that is called after the message is saved to the database. - // Will not be called if the message is not saved for some reason. - PostSave func(context.Context, *database.Message) -} - -type OutgoingTimeoutConfig struct { - CheckInterval time.Duration - NoEchoTimeout time.Duration - NoEchoMessage string - NoAckTimeout time.Duration - NoAckMessage string -} - -type NetworkGeneralCapabilities struct { - // Does the network connector support disappearing messages? - // This flag enables the message disappearing loop in the bridge. - DisappearingMessages bool - // 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 - // 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. -// -// Implementations of this interface are stored in [UserLogin.Client]. -// The [NetworkConnector.LoadUserLogin] method is responsible for filling the Client field with a NetworkAPI. -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. - // 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() - // IsLoggedIn should return whether the access tokens in this NetworkAPI are valid. - // This should not do any IO operations, it should only return cached data which is updated elsewhere. - IsLoggedIn() bool - // LogoutRemote should invalidate the access tokens in this NetworkAPI if possible - // and disconnect from the remote network. - LogoutRemote(ctx context.Context) - - // IsThisUser should return whether the given remote network user ID is the same as this login. - // This is used when the bridge wants to convert a user login ID to a user ID. - IsThisUser(ctx context.Context, userID networkid.UserID) bool - // GetChatInfo returns info for a given chat. Any fields that are nil will be ignored and not processed at all, - // while empty strings will change the relevant value in the room to be an empty string. - // For example, a nil name will mean the room name is not changed, while an empty string name will remove the name. - GetChatInfo(ctx context.Context, portal *Portal) (*ChatInfo, error) - // GetUserInfo returns info for a given user. Like chat info, fields can be nil to skip them. - GetUserInfo(ctx context.Context, ghost *Ghost) (*UserInfo, error) - // 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) *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, - // and return the info so the central bridge can store it in the database. - // - // This is only called for normal non-edit messages. For other types of events, see the optional extra interfaces (`XHandlingNetworkAPI`). - 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. - Portal *Portal - // When fetching messages inside a thread, the ID of the thread. - ThreadRoot networkid.MessageID - // Whether to fetch new messages instead of old ones. - Forward bool - // The oldest known message in the thread or the portal. If Forward is true, this is the newest known message instead. - // If the portal doesn't have any bridged messages, this will be nil. - AnchorMessage *database.Message - // The cursor returned by the previous call to FetchMessages with the same portal and thread root. - // This will not be present in Forward calls. - Cursor networkid.PaginationCursor - // The preferred number of messages to return. The returned batch can be bigger or smaller - // without any side effects, but the network connector should aim for this number. - Count int - - // When a forward backfill is triggered by a [RemoteChatResyncBackfillBundle], this will contain - // the bundled data returned by the event. It can be used as an optimization to avoid fetching - // messages that were already provided by the remote network, while still supporting fetching - // more messages if the limit is higher. - BundledData any - - // When the messages are being fetched for a queued backfill, this is the task object. - Task *database.BackfillTask -} - -// BackfillReaction is an individual reaction to a message in a history pagination request. -// -// The target message is always the BackfillMessage that contains this item. -// Optionally, the reaction can target a specific part by specifying TargetPart. -// If not specified, the first part (sorted lexicographically) is targeted. -type BackfillReaction struct { - // Optional part of the message that the reaction targets. - // If nil, the reaction targets the first part of the message. - TargetPart *networkid.PartID - // Optional timestamp for the reaction. - // If unset, the reaction will have a fake timestamp that is slightly after the message timestamp. - Timestamp time.Time - - Sender EventSender - EmojiID networkid.EmojiID - Emoji string - ExtraContent map[string]any - DBMetadata any -} - -// BackfillMessage is an individual message in a history pagination request. -type BackfillMessage struct { - *ConvertedMessage - Sender EventSender - ID networkid.MessageID - TxnID networkid.TransactionID - Timestamp time.Time - StreamOrder int64 - Reactions []*BackfillReaction - - ShouldBackfillThread bool - LastThreadMessage networkid.MessageID -} - -var ( - _ RemoteMessageWithTransactionID = (*BackfillMessage)(nil) - _ RemoteEventWithTimestamp = (*BackfillMessage)(nil) -) - -func (b *BackfillMessage) GetType() RemoteEventType { - return RemoteEventMessage -} - -func (b *BackfillMessage) GetPortalKey() networkid.PortalKey { - panic("GetPortalKey called for BackfillMessage") -} - -func (b *BackfillMessage) AddLogContext(c zerolog.Context) zerolog.Context { - return c -} - -func (b *BackfillMessage) GetSender() EventSender { - return b.Sender -} - -func (b *BackfillMessage) GetID() networkid.MessageID { - return b.ID -} - -func (b *BackfillMessage) GetTransactionID() networkid.TransactionID { - return b.TxnID -} - -func (b *BackfillMessage) GetTimestamp() time.Time { - return b.Timestamp -} - -func (b *BackfillMessage) ConvertMessage(ctx context.Context, portal *Portal, intent MatrixAPI) (*ConvertedMessage, error) { - return b.ConvertedMessage, nil -} - -// FetchMessagesResponse contains the response for a message history pagination request. -type FetchMessagesResponse struct { - // The messages to backfill. Messages should always be sorted in chronological order (oldest to newest). - Messages []*BackfillMessage - // The next cursor to use for fetching more messages. - Cursor networkid.PaginationCursor - // Whether there are more messages that can be backfilled. - // This field is required. If it is false, FetchMessages will not be called again. - HasMore bool - // Whether the batch contains new messages rather than old ones. - // Cursor, HasMore and the progress fields will be ignored when this is present. - Forward bool - // When sending forward backfill (or the first batch in a room), this field can be set - // to mark the messages as read immediately after backfilling. - MarkRead bool - - // Should the bridge check each message against the database to ensure it's not a duplicate before bridging? - // By default, the bridge will only drop messages that are older than the last bridged message for forward backfills, - // or newer than the first for backward. - AggressiveDeduplication bool - - // When HasMore is true, one of the following fields can be set to report backfill progress: - - // Approximate backfill progress as a number between 0 and 1. - ApproxProgress float64 - // Approximate number of messages remaining that can be backfilled. - ApproxRemainingCount int - // Approximate total number of messages in the chat. - ApproxTotalCount int - - // An optional function that is called after the backfill batch has been sent. - CompleteCallback func() -} - -// 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 -} - -// EditHandlingNetworkAPI is an optional interface that network connectors can implement to handle message edits. -type EditHandlingNetworkAPI interface { - NetworkAPI - // HandleMatrixEdit is called when a previously bridged message is edited in a portal room. - // The central bridge module will save the [*database.Message] after this function returns, - // so the network connector is allowed to mutate the provided object. - HandleMatrixEdit(ctx context.Context, msg *MatrixEdit) error -} - -type PollHandlingNetworkAPI interface { - NetworkAPI - HandleMatrixPollStart(ctx context.Context, msg *MatrixPollStart) (*MatrixMessageResponse, error) - HandleMatrixPollVote(ctx context.Context, msg *MatrixPollVote) (*MatrixMessageResponse, error) -} - -// ReactionHandlingNetworkAPI is an optional interface that network connectors can implement to handle message reactions. -type ReactionHandlingNetworkAPI interface { - NetworkAPI - // PreHandleMatrixReaction is called as the first step of handling a reaction. It returns the emoji ID, - // sender user ID and max reaction count to allow the central bridge module to de-duplicate the reaction - // if appropriate. - PreHandleMatrixReaction(ctx context.Context, msg *MatrixReaction) (MatrixReactionPreResponse, error) - // HandleMatrixReaction is called after confirming that the reaction is not a duplicate. - // This is the method that should actually send the reaction to the remote network. - // The returned [database.Reaction] object may be empty: the central bridge module already has - // all the required fields and will fill them automatically if they're empty. However, network - // connectors are allowed to set fields themselves if any extra fields are necessary. - HandleMatrixReaction(ctx context.Context, msg *MatrixReaction) (reaction *database.Reaction, err error) - // HandleMatrixReactionRemove is called when a redaction event is received pointing at a previously - // bridged reaction. The network connector should remove the reaction from the remote network. - HandleMatrixReactionRemove(ctx context.Context, msg *MatrixReactionRemove) error -} - -// RedactionHandlingNetworkAPI is an optional interface that network connectors can implement to handle message deletions. -type RedactionHandlingNetworkAPI interface { - NetworkAPI - // HandleMatrixMessageRemove is called when a previously bridged message is deleted in a portal room. - HandleMatrixMessageRemove(ctx context.Context, msg *MatrixMessageRemove) error -} - -// ReadReceiptHandlingNetworkAPI is an optional interface that network connectors can implement to handle read receipts. -type ReadReceiptHandlingNetworkAPI interface { - NetworkAPI - // HandleMatrixReadReceipt is called when a read receipt is sent in a portal room. - // This will be called even if the target message is not a bridged message. - // Network connectors must gracefully handle [MatrixReadReceipt.ExactMessage] being nil. - // The exact handling is up to the network connector. - 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 - // HandleMatrixTyping is called when a user starts typing in a portal room. - // In the future, the central bridge module will likely get a loop to automatically repeat - // calls to this function until the user stops typing. - HandleMatrixTyping(ctx context.Context, msg *MatrixTyping) error -} - -type MarkedUnreadHandlingNetworkAPI interface { - NetworkAPI - HandleMarkedUnread(ctx context.Context, msg *MatrixMarkedUnread) error -} - -type MuteHandlingNetworkAPI interface { - NetworkAPI - HandleMute(ctx context.Context, msg *MatrixMute) error -} - -type TagHandlingNetworkAPI interface { - NetworkAPI - HandleRoomTag(ctx context.Context, msg *MatrixRoomTag) error -} - -// RoomNameHandlingNetworkAPI is an optional interface that network connectors can implement to handle room name changes. -type RoomNameHandlingNetworkAPI interface { - NetworkAPI - // HandleMatrixRoomName is called when the name of a portal room is changed. - // This method should update the Name and NameSet fields of the Portal with - // the new name and return true if the change was successful. - // If the change is not successful, then the fields should not be updated. - HandleMatrixRoomName(ctx context.Context, msg *MatrixRoomName) (bool, error) -} - -// RoomAvatarHandlingNetworkAPI is an optional interface that network connectors can implement to handle room avatar changes. -type RoomAvatarHandlingNetworkAPI interface { - NetworkAPI - // HandleMatrixRoomAvatar is called when the avatar of a portal room is changed. - // This method should update the AvatarID, AvatarHash and AvatarMXC fields - // with the new avatar details and return true if the change was successful. - // If the change is not successful, then the fields should not be updated. - HandleMatrixRoomAvatar(ctx context.Context, msg *MatrixRoomAvatar) (bool, error) -} - -// RoomTopicHandlingNetworkAPI is an optional interface that network connectors can implement to handle room topic changes. -type RoomTopicHandlingNetworkAPI interface { - NetworkAPI - // HandleMatrixRoomTopic is called when the topic of a portal room is changed. - // This method should update the Topic and TopicSet fields of the Portal with - // the new topic and return true if the change was successful. - // If the change is not successful, then the fields should not be updated. - 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, - // and the central bridge module will not try to create a ghost if it is not set. - Ghost *Ghost - - // UserID is the user ID of the user that the identifier resolves to. - UserID networkid.UserID - // UserInfo contains the info of the user that the identifier resolves to. - // If both this and the Ghost field are set, the central bridge module will - // automatically update the ghost's info with the data here. - UserInfo *UserInfo - - // Chat contains info about the direct chat with the resolved user. - // This field is required when createChat is true in the ResolveIdentifier call, - // and optional otherwise. - 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. -type IdentifierResolvingNetworkAPI interface { - NetworkAPI - // ResolveIdentifier is called when the user wants to start a new chat. - // This can happen via the `resolve-identifier` or `start-chat` bridge bot commands, - // or the corresponding provisioning API endpoints. - 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 - GetContactList(ctx context.Context) ([]*ResolveIdentifierResponse, error) -} - -type UserSearchingNetworkAPI interface { - IdentifierResolvingNetworkAPI - SearchUsers(ctx context.Context, query string) ([]*ResolveIdentifierResponse, error) -} - -type GroupCreatingNetworkAPI interface { - IdentifierResolvingNetworkAPI - 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 { - From event.Membership - To event.Membership - IsSelf bool -} - -var ( - AcceptInvite = MembershipChangeType{From: event.MembershipInvite, To: event.MembershipJoin, IsSelf: true} - RevokeInvite = MembershipChangeType{From: event.MembershipInvite, To: event.MembershipLeave} - RejectInvite = MembershipChangeType{From: event.MembershipInvite, To: event.MembershipLeave, IsSelf: true} - BanInvited = MembershipChangeType{From: event.MembershipInvite, To: event.MembershipBan} - ProfileChange = MembershipChangeType{From: event.MembershipJoin, To: event.MembershipJoin, IsSelf: true} - Leave = MembershipChangeType{From: event.MembershipJoin, To: event.MembershipLeave, IsSelf: true} - Kick = MembershipChangeType{From: event.MembershipJoin, To: event.MembershipLeave} - BanJoined = MembershipChangeType{From: event.MembershipJoin, To: event.MembershipBan} - Invite = MembershipChangeType{From: event.MembershipLeave, To: event.MembershipInvite} - Join = MembershipChangeType{From: event.MembershipLeave, To: event.MembershipJoin} - BanLeft = MembershipChangeType{From: event.MembershipLeave, To: event.MembershipBan} - Knock = MembershipChangeType{From: event.MembershipLeave, To: event.MembershipKnock, IsSelf: true} - AcceptKnock = MembershipChangeType{From: event.MembershipKnock, To: event.MembershipInvite} - RejectKnock = MembershipChangeType{From: event.MembershipKnock, To: event.MembershipLeave} - RetractKnock = MembershipChangeType{From: event.MembershipKnock, To: event.MembershipLeave, IsSelf: true} - BanKnocked = MembershipChangeType{From: event.MembershipKnock, To: event.MembershipBan} - Unban = MembershipChangeType{From: event.MembershipBan, To: event.MembershipLeave} -) - -type GhostOrUserLogin interface { - isGhostOrUserLogin() -} - -func (*Ghost) isGhostOrUserLogin() {} -func (*UserLogin) isGhostOrUserLogin() {} - -type MatrixMembershipChange struct { - MatrixRoomMeta[*event.MemberEventContent] - Target GhostOrUserLogin - Type MembershipChangeType -} - -type MatrixMembershipResult struct { - RedirectTo networkid.UserID -} - -type MembershipHandlingNetworkAPI interface { - NetworkAPI - HandleMatrixMembership(ctx context.Context, msg *MatrixMembershipChange) (*MatrixMembershipResult, error) -} - -type SinglePowerLevelChange struct { - OrigLevel int - NewLevel int - NewIsSet bool -} - -type UserPowerLevelChange struct { - Target GhostOrUserLogin - SinglePowerLevelChange -} - -type MatrixPowerLevelChange struct { - MatrixRoomMeta[*event.PowerLevelsEventContent] - Users map[id.UserID]*UserPowerLevelChange - Events map[string]*SinglePowerLevelChange - UsersDefault *SinglePowerLevelChange - EventsDefault *SinglePowerLevelChange - StateDefault *SinglePowerLevelChange - Invite *SinglePowerLevelChange - Kick *SinglePowerLevelChange - Ban *SinglePowerLevelChange - Redact *SinglePowerLevelChange -} - -type PowerLevelHandlingNetworkAPI interface { - NetworkAPI - HandleMatrixPowerLevels(ctx context.Context, msg *MatrixPowerLevelChange) (bool, error) -} - -type PushType int - -func (pt PushType) String() string { - return pt.GoString() -} - -func PushTypeFromString(str string) PushType { - switch strings.TrimPrefix(strings.ToLower(str), "pushtype") { - case "web": - return PushTypeWeb - case "apns": - return PushTypeAPNs - case "fcm": - return PushTypeFCM - default: - return PushTypeUnknown - } -} - -func (pt PushType) GoString() string { - switch pt { - case PushTypeUnknown: - return "PushTypeUnknown" - case PushTypeWeb: - return "PushTypeWeb" - case PushTypeAPNs: - return "PushTypeAPNs" - case PushTypeFCM: - return "PushTypeFCM" - default: - return fmt.Sprintf("PushType(%d)", int(pt)) - } -} - -const ( - PushTypeUnknown PushType = iota - PushTypeWeb - PushTypeAPNs - PushTypeFCM -) - -type WebPushConfig struct { - VapidKey string `json:"vapid_key"` -} - -type FCMPushConfig struct { - SenderID string `json:"sender_id"` -} - -type APNsPushConfig struct { - BundleID string `json:"bundle_id"` -} - -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 { - switch ret { - case RemoteEventUnknown: - return "RemoteEventUnknown" - case RemoteEventMessage: - return "RemoteEventMessage" - case RemoteEventMessageUpsert: - return "RemoteEventMessageUpsert" - case RemoteEventEdit: - return "RemoteEventEdit" - case RemoteEventReaction: - return "RemoteEventReaction" - case RemoteEventReactionRemove: - return "RemoteEventReactionRemove" - case RemoteEventReactionSync: - return "RemoteEventReactionSync" - case RemoteEventMessageRemove: - return "RemoteEventMessageRemove" - case RemoteEventReadReceipt: - return "RemoteEventReadReceipt" - case RemoteEventDeliveryReceipt: - return "RemoteEventDeliveryReceipt" - case RemoteEventMarkUnread: - return "RemoteEventMarkUnread" - case RemoteEventTyping: - return "RemoteEventTyping" - case RemoteEventChatInfoChange: - return "RemoteEventChatInfoChange" - case RemoteEventChatResync: - return "RemoteEventChatResync" - case RemoteEventChatDelete: - return "RemoteEventChatDelete" - case RemoteEventBackfill: - return "RemoteEventBackfill" - default: - return fmt.Sprintf("RemoteEventType(%d)", int(ret)) - } -} - -const ( - RemoteEventUnknown RemoteEventType = iota - RemoteEventMessage - RemoteEventMessageUpsert - RemoteEventEdit - RemoteEventReaction - RemoteEventReactionRemove - RemoteEventReactionSync - RemoteEventMessageRemove - RemoteEventReadReceipt - RemoteEventDeliveryReceipt - RemoteEventMarkUnread - RemoteEventTyping - RemoteEventChatInfoChange - RemoteEventChatResync - RemoteEventChatDelete - RemoteEventBackfill -) - -// RemoteEvent represents a single event from the remote network, such as a message or a reaction. -// -// When a [NetworkAPI] receives an event from the remote network, it should convert it into a [RemoteEvent] -// and pass it to the bridge for processing using [Bridge.QueueRemoteEvent]. -type RemoteEvent interface { - GetType() RemoteEventType - GetPortalKey() networkid.PortalKey - AddLogContext(c zerolog.Context) zerolog.Context - GetSender() EventSender -} - -type RemoteEventWithUncertainPortalReceiver interface { - RemoteEvent - PortalReceiverIsUncertain() bool -} - -type RemotePreHandler interface { - RemoteEvent - PreHandle(ctx context.Context, portal *Portal) -} - -type RemotePostHandler interface { - RemoteEvent - PostHandle(ctx context.Context, portal *Portal) -} - -type RemoteChatInfoChange interface { - RemoteEvent - GetChatInfoChange(ctx context.Context) (*ChatInfoChange, error) -} - -type RemoteChatResync interface { - RemoteEvent -} - -type RemoteChatResyncWithInfo interface { - RemoteChatResync - GetChatInfo(ctx context.Context, portal *Portal) (*ChatInfo, error) -} - -type RemoteChatResyncBackfill interface { - RemoteChatResync - CheckNeedsBackfill(ctx context.Context, latestMessage *database.Message) (bool, error) -} - -type RemoteChatResyncBackfillBundle interface { - RemoteChatResyncBackfill - GetBundledBackfillData() any -} - -type RemoteBackfill interface { - RemoteEvent - GetBackfillData(ctx context.Context, portal *Portal) (*FetchMessagesResponse, error) -} - -type RemoteDeleteOnlyForMe interface { - RemoteEvent - DeleteOnlyForMe() bool -} - -type RemoteChatDelete interface { - RemoteDeleteOnlyForMe -} - -type RemoteChatDeleteWithChildren interface { - RemoteChatDelete - DeleteChildren() bool -} - -type RemoteEventThatMayCreatePortal interface { - RemoteEvent - ShouldCreatePortal() bool -} - -type RemoteEventWithTargetMessage interface { - RemoteEvent - GetTargetMessage() networkid.MessageID -} - -type RemoteEventWithBundledParts interface { - RemoteEventWithTargetMessage - GetTargetDBMessage() []*database.Message -} - -type RemoteEventWithTargetPart interface { - RemoteEventWithTargetMessage - GetTargetMessagePart() networkid.PartID -} - -type RemoteEventWithTimestamp interface { - RemoteEvent - GetTimestamp() time.Time -} - -type RemoteEventWithStreamOrder interface { - RemoteEvent - GetStreamOrder() int64 -} - -type RemoteMessage interface { - RemoteEvent - GetID() networkid.MessageID - ConvertMessage(ctx context.Context, portal *Portal, intent MatrixAPI) (*ConvertedMessage, error) -} - -type UpsertResult struct { - SubEvents []RemoteEvent - SaveParts bool - ContinueMessageHandling bool -} - -type RemoteMessageUpsert interface { - RemoteMessage - HandleExisting(ctx context.Context, portal *Portal, intent MatrixAPI, existing []*database.Message) (UpsertResult, error) -} - -type RemoteMessageWithTransactionID interface { - RemoteMessage - GetTransactionID() networkid.TransactionID -} - -type RemoteEdit interface { - RemoteEventWithTargetMessage - ConvertEdit(ctx context.Context, portal *Portal, intent MatrixAPI, existing []*database.Message) (*ConvertedEdit, error) -} - -type RemoteReaction interface { - RemoteEventWithTargetMessage - GetReactionEmoji() (string, networkid.EmojiID) -} - -type ReactionSyncUser struct { - Reactions []*BackfillReaction - // Whether the list contains all reactions the user has sent - HasAllReactions bool - // If the list doesn't contain all reactions from the user, - // then this field can be set to remove old reactions if there are more than a certain number. - MaxCount int -} - -type ReactionSyncData struct { - Users map[networkid.UserID]*ReactionSyncUser - // Whether the map contains all users who have reacted to the message - HasAllUsers bool -} - -func (rsd *ReactionSyncData) ToBackfill() []*BackfillReaction { - var reactions []*BackfillReaction - for _, user := range rsd.Users { - reactions = append(reactions, user.Reactions...) - } - return reactions -} - -type RemoteReactionSync interface { - RemoteEventWithTargetMessage - GetReactions() *ReactionSyncData -} - -type RemoteReactionWithExtraContent interface { - RemoteReaction - GetReactionExtraContent() map[string]any -} - -type RemoteReactionWithMeta interface { - RemoteReaction - GetReactionDBMetadata() any -} - -type RemoteReactionRemove interface { - RemoteEventWithTargetMessage - GetRemovedEmojiID() networkid.EmojiID -} - -type RemoteMessageRemove interface { - RemoteEventWithTargetMessage -} - -// Deprecated: Renamed to RemoteReadReceipt. -type RemoteReceipt = RemoteReadReceipt - -type RemoteReadReceipt interface { - RemoteEvent - GetLastReceiptTarget() networkid.MessageID - GetReceiptTargets() []networkid.MessageID - GetReadUpTo() time.Time -} - -type RemoteReadReceiptWithStreamOrder interface { - RemoteReadReceipt - GetReadUpToStreamOrder() int64 -} - -type RemoteDeliveryReceipt interface { - RemoteEvent - GetReceiptTargets() []networkid.MessageID -} - -type RemoteMarkUnread interface { - RemoteEvent - GetUnread() bool -} - -type RemoteTyping interface { - RemoteEvent - GetTimeout() time.Duration -} - -type TypingType int - -const ( - TypingTypeText TypingType = iota - TypingTypeUploadingMedia - TypingTypeRecordingMedia -) - -type RemoteTypingWithType interface { - RemoteTyping - GetTypingType() TypingType -} - -type OrigSender struct { - User *User - UserID id.UserID - - RequiresDisambiguation bool - DisambiguatedName string - FormattedName string - PerMessageProfile event.BeeperPerMessageProfile - - event.MemberEventContent -} - -type MatrixEventBase[ContentType any] struct { - // The raw event being bridged. - Event *event.Event - // The parsed content struct of the event. Custom fields can be found in Event.Content.Raw. - Content ContentType - // The room where the event happened. - Portal *Portal - - // 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 { - MatrixEventBase[*event.MessageEventContent] - EditTarget *database.Message -} - -type MatrixPollStart struct { - MatrixMessage - Content *event.PollStartEventContent -} - -type MatrixPollVote struct { - MatrixMessage - VoteTo *database.Message - Content *event.PollResponseEventContent -} - -type MatrixReaction struct { - MatrixEventBase[*event.ReactionEventContent] - TargetMessage *database.Message - PreHandleResp *MatrixReactionPreResponse - - // When EmojiID is blank and there's already an existing reaction, this is the old reaction that is being overridden. - ReactionToOverride *database.Reaction - // When MaxReactions is >0 in the pre-response, this is the list of previous reactions that should be preserved. - ExistingReactionsToKeep []*database.Reaction -} - -type MatrixReactionPreResponse struct { - SenderID networkid.UserID - EmojiID networkid.EmojiID - Emoji string - MaxReactions int -} - -type MatrixReactionRemove struct { - MatrixEventBase[*event.RedactionEventContent] - TargetReaction *database.Reaction -} - -type MatrixMessageRemove struct { - MatrixEventBase[*event.RedactionEventContent] - TargetMessage *database.Message -} - -type MatrixRoomMeta[ContentType any] struct { - MatrixEventBase[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 - // The event ID that the receipt is targeting - EventID id.EventID - // The exact message that was read. This may be nil if the event ID isn't a message. - ExactMessage *database.Message - // The timestamp that the user has read up to. This is either the timestamp of the message - // (if one is present) or the timestamp of the receipt. - ReadUpTo time.Time - // The ReadUpTo timestamp of the previous message - 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 { - Portal *Portal - IsTyping bool - 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 deleted file mode 100644 index 16aa703b..00000000 --- a/bridgev2/portal.go +++ /dev/null @@ -1,5436 +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 bridgev2 - -import ( - "cmp" - "context" - "errors" - "fmt" - "runtime/debug" - "strings" - "sync" - "sync/atomic" - "time" - - "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" - "golang.org/x/exp/slices" - - "maunium.net/go/mautrix" - "maunium.net/go/mautrix/bridgev2/database" - "maunium.net/go/mautrix/bridgev2/networkid" - "maunium.net/go/mautrix/event" - "maunium.net/go/mautrix/id" -) - -type portalMatrixEvent struct { - evt *event.Event - sender *User -} - -type portalRemoteEvent struct { - evt RemoteEvent - source *UserLogin - evtType RemoteEventType -} - -type portalCreateEvent struct { - ctx context.Context - source *UserLogin - info *ChatInfo - cb func(error) -} - -func (pme *portalMatrixEvent) isPortalEvent() {} -func (pre *portalRemoteEvent) isPortalEvent() {} -func (pre *portalCreateEvent) isPortalEvent() {} - -type portalEvent interface { - isPortalEvent() -} - -type outgoingMessage struct { - db *database.Message - evt *event.Event - ignore bool - handle func(RemoteMessage, *database.Message) (bool, error) - ackedAt time.Time - timeouted bool -} - -type Portal struct { - *database.Portal - Bridge *Bridge - Log zerolog.Logger - Parent *Portal - Relay *UserLogin - - currentlyTyping []id.UserID - currentlyTypingLogins map[id.UserID]*UserLogin - currentlyTypingLock sync.Mutex - currentlyTypingGhosts *exsync.Set[id.UserID] - - outgoingMessages map[networkid.TransactionID]*outgoingMessage - outgoingMessagesLock sync.Mutex - - lastCapUpdate time.Time - - 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 -} - -var PortalEventBuffer = 64 - -func (br *Bridge) loadPortal(ctx context.Context, dbPortal *database.Portal, queryErr error, key *networkid.PortalKey) (*Portal, error) { - if queryErr != nil { - return nil, fmt.Errorf("failed to query db: %w", queryErr) - } - if dbPortal == nil { - if key == nil { - return nil, nil - } - dbPortal = &database.Portal{ - BridgeID: br.ID, - PortalKey: *key, - } - err := br.DB.Portal.Insert(ctx, dbPortal) - if err != nil { - return nil, fmt.Errorf("failed to insert new portal: %w", err) - } - } - portal := &Portal{ - Portal: dbPortal, - Bridge: br, - - currentlyTypingLogins: make(map[id.UserID]*UserLogin), - 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 - } - var err error - 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() - 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)). - Str("portal_receiver", string(portal.Receiver)) - if portal.MXID != "" { - logWith = logWith.Stringer("portal_mxid", portal.MXID) - } - portal.Log = logWith.Logger() -} - -func (br *Bridge) loadManyPortals(ctx context.Context, portals []*database.Portal) ([]*Portal, error) { - output := make([]*Portal, 0, len(portals)) - for _, dbPortal := range portals { - if cached, ok := br.portalsByKey[dbPortal.PortalKey]; ok { - output = append(output, cached) - } else { - loaded, err := br.loadPortal(ctx, dbPortal, nil, nil) - if err != nil { - return nil, err - } else if loaded != nil { - output = append(output, loaded) - } - } - } - 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") - } - cached, ok := br.portalsByKey[key] - if ok { - return cached, nil - } - keyPtr := &key - if onlyIfExists { - keyPtr = nil - } - db, err := br.DB.Portal.GetByKey(ctx, key) - return br.loadPortal(ctx, db, err, keyPtr) -} - -func (br *Bridge) FindPortalReceiver(ctx context.Context, id networkid.PortalID, maybeReceiver networkid.UserLoginID) (networkid.PortalKey, error) { - key := br.FindCachedPortalReceiver(id, maybeReceiver) - if !key.IsEmpty() { - return key, nil - } - key, err := br.DB.Portal.FindReceiver(ctx, id, maybeReceiver) - if err != nil { - return networkid.PortalKey{}, err - } - return key, nil -} - -func (br *Bridge) FindCachedPortalReceiver(id networkid.PortalID, maybeReceiver networkid.UserLoginID) networkid.PortalKey { - if br.Config.SplitPortals { - return networkid.PortalKey{ID: id, Receiver: maybeReceiver} - } - br.cacheLock.Lock() - defer br.cacheLock.Unlock() - portal, ok := br.portalsByKey[networkid.PortalKey{ - ID: id, - Receiver: maybeReceiver, - }] - if ok { - return portal.PortalKey - } - portal, ok = br.portalsByKey[networkid.PortalKey{ID: id}] - if ok { - return portal.PortalKey - } - return networkid.PortalKey{} -} - -func (br *Bridge) GetPortalByMXID(ctx context.Context, mxid id.RoomID) (*Portal, error) { - br.cacheLock.Lock() - defer br.cacheLock.Unlock() - cached, ok := br.portalsByMXID[mxid] - if ok { - return cached, nil - } - db, err := br.DB.Portal.GetByMXID(ctx, mxid) - return br.loadPortal(ctx, db, err, nil) -} - -func (br *Bridge) GetAllPortalsWithMXID(ctx context.Context) ([]*Portal, error) { - br.cacheLock.Lock() - defer br.cacheLock.Unlock() - rows, err := br.DB.Portal.GetAllWithMXID(ctx) - if err != nil { - return nil, err - } - return br.loadManyPortals(ctx, rows) -} - -func (br *Bridge) GetAllPortals(ctx context.Context) ([]*Portal, error) { - br.cacheLock.Lock() - defer br.cacheLock.Unlock() - rows, err := br.DB.Portal.GetAll(ctx) - if err != nil { - return nil, err - } - return br.loadManyPortals(ctx, rows) -} - -func (br *Bridge) GetDMPortalsWith(ctx context.Context, otherUserID networkid.UserID) ([]*Portal, error) { - br.cacheLock.Lock() - defer br.cacheLock.Unlock() - rows, err := br.DB.Portal.GetAllDMsWith(ctx, otherUserID) - if err != nil { - return nil, err - } - 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() - return br.UnlockedGetPortalByKey(ctx, key, false) -} - -func (br *Bridge) GetExistingPortalByKey(ctx context.Context, key networkid.PortalKey) (*Portal, error) { - br.cacheLock.Lock() - defer br.cacheLock.Unlock() - if key.Receiver == "" || br.Config.SplitPortals { - return br.UnlockedGetPortalByKey(ctx, key, true) - } - cached, ok := br.portalsByKey[key] - if ok { - return cached, nil - } - cached, ok = br.portalsByKey[networkid.PortalKey{ID: key.ID}] - if ok { - return cached, nil - } - db, err := br.DB.Portal.GetByIDWithUncertainReceiver(ctx, key) - return br.loadPortal(ctx, db, err, nil) -} - -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() { - 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) handleSingleEventWithDelayLogging(idx int, rawEvt any) (outerRes EventHandlingResult) { - ctx := portal.getEventCtxWithLog(rawEvt, idx) - 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") - } - 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(). - 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 { - var logWith zerolog.Context - switch evt := rawEvt.(type) { - case *portalMatrixEvent: - logWith = portal.Log.With().Int("event_loop_index", idx). - Str("action", "handle matrix event"). - Stringer("event_id", evt.evt.ID). - Str("event_type", evt.evt.Type.Type) - if evt.evt.Type.Class != event.EphemeralEventType { - logWith = logWith. - Stringer("event_id", evt.evt.ID). - Stringer("sender", evt.sender.MXID) - } - case *portalRemoteEvent: - evt.evtType = evt.evt.GetType() - logWith = portal.Log.With().Int("event_loop_index", idx). - Str("action", "handle remote event"). - 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(portal.Bridge.BackgroundCtx) -} - -func (portal *Portal) handleSingleEvent(ctx context.Context, rawEvt any, doneCallback func(res EventHandlingResult)) { - log := zerolog.Ctx(ctx) - var res EventHandlingResult - defer func() { - 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()). - Msg("Event handling panicked") - switch evt := rawEvt.(type) { - case *portalMatrixEvent: - if evt.evt.ID != "" { - go portal.sendErrorStatus(ctx, evt.evt, ErrPanicInEventHandler) - } - 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: - 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: - res = portal.handleRemoteEvent(ctx, evt.source, evt.evtType, evt.evt) - case *portalCreateEvent: - 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 { - 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 - } - 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 - } - logins, err := portal.Bridge.DB.UserPortal.GetAllForUserInPortal(ctx, user.MXID, portal.PortalKey) - if err != nil { - return nil, nil, err - } - portal.Bridge.cacheLock.Lock() - defer portal.Bridge.cacheLock.Unlock() - for _, up := range logins { - login, ok := user.logins[up.LoginID] - if ok && login.Client != nil && login.Client.IsLoggedIn() { - return login, up, nil - } - } - if !allowRelay { - return nil, nil, ErrNotLoggedIn - } - // Portal has relay, use it - if portal.Relay != nil { - return nil, nil, nil - } - var firstLogin *UserLogin - for _, login := range user.logins { - firstLogin = login - break - } - 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") - return firstLogin, nil, nil - } else { - return nil, nil, ErrNotLoggedIn - } -} - -func (portal *Portal) sendSuccessStatus(ctx context.Context, evt *event.Event, streamOrder int64, newEventID id.EventID) { - info := StatusEventInfoFromEvent(evt) - info.StreamOrder = streamOrder - if newEventID != evt.ID { - info.NewEventID = newEventID - } - portal.Bridge.Matrix.SendMessageStatus(ctx, &MessageStatus{Status: event.MessageStatusSuccess}, info) -} - -func (portal *Portal) sendErrorStatus(ctx context.Context, evt *event.Event, err error) { - status := WrapErrorInStatus(err) - if status.Status == "" { - status.Status = event.MessageStatusRetriable - } - if status.ErrorReason == "" { - status.ErrorReason = event.MessageStatusGenericError - } - if status.InternalError == nil { - status.InternalError = err - } - portal.Bridge.Matrix.SendMessageStatus(ctx, &status, StatusEventInfoFromEvent(evt)) -} - -func (portal *Portal) checkConfusableName(ctx context.Context, userID id.UserID, name string) bool { - conn, ok := portal.Bridge.Matrix.(MatrixConnectorWithNameDisambiguation) - if !ok { - return false - } - confusableWith, err := conn.IsConfusableName(ctx, portal.MXID, userID, name) - if err != nil { - zerolog.Ctx(ctx).Err(err).Msg("Failed to check if name is confusable") - return true - } - for _, confusable := range confusableWith { - // Don't disambiguate names that only conflict with ghosts of this bridge - if !portal.Bridge.IsGhostMXID(confusable) { - return true - } - } - return false -} - -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: - return portal.handleMatrixReceipts(ctx, evt) - case event.EphemeralEventTyping: - return portal.handleMatrixTyping(ctx, evt) - case event.BeeperEphemeralEventAIStream: - return portal.handleMatrixAIStream(ctx, sender, evt) - default: - return EventHandlingResultIgnored - } - } - 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) { - shouldSendNotice := evt.Content.AsMessage().MsgType != event.MsgNotice - return EventHandlingResultFailed.WithMSSError( - WrapErrorInStatus(err).WithMessage("You're not logged in").WithIsCertain(true).WithSendNotice(shouldSendNotice), - ) - } else { - return EventHandlingResultFailed.WithMSSError( - WrapErrorInStatus(err).WithMessage("Failed to get login to handle event").WithIsCertain(true).WithSendNotice(true), - ) - } - } - var origSender *OrigSender - if login == nil { - if isStateRequest { - return EventHandlingResultFailed.WithMSSError(ErrCantRelayStateRequest) - } - login = portal.Relay - origSender = &OrigSender{ - User: sender, - UserID: sender.MXID, - } - - memberInfo, err := portal.Bridge.Matrix.GetMemberInfo(ctx, portal.MXID, sender.MXID) - if err != nil { - log.Warn().Err(err).Msg("Failed to get member info for user being relayed") - } else if memberInfo != nil { - origSender.MemberEventContent = *memberInfo - if memberInfo.Displayname == "" { - origSender.DisambiguatedName = sender.MXID.String() - } else if origSender.RequiresDisambiguation = portal.checkConfusableName(ctx, sender.MXID, memberInfo.Displayname); origSender.RequiresDisambiguation { - origSender.DisambiguatedName = fmt.Sprintf("%s (%s)", memberInfo.Displayname, sender.MXID) - } else { - origSender.DisambiguatedName = memberInfo.Displayname - } - } 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: - return portal.handleMatrixMessage(ctx, login, origSender, evt) - case event.EventReaction: - if origSender != nil { - log.Debug().Msg("Ignoring reaction event from relayed user") - return EventHandlingResultIgnored.WithMSSError(ErrIgnoringReactionFromRelayedUser) - } - return portal.handleMatrixReaction(ctx, login, evt) - case event.EventRedaction: - return portal.handleMatrixRedaction(ctx, login, origSender, evt) - case event.StateRoomName: - return handleMatrixRoomMeta(portal, ctx, login, origSender, evt, isStateRequest, RoomNameHandlingNetworkAPI.HandleMatrixRoomName) - case event.StateTopic: - return handleMatrixRoomMeta(portal, ctx, login, origSender, evt, isStateRequest, RoomTopicHandlingNetworkAPI.HandleMatrixRoomTopic) - case event.StateRoomAvatar: - 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: - return handleMatrixAccountData(portal, ctx, login, evt, MarkedUnreadHandlingNetworkAPI.HandleMarkedUnread) - case event.AccountDataRoomTags: - return handleMatrixAccountData(portal, ctx, login, evt, TagHandlingNetworkAPI.HandleRoomTag) - case event.AccountDataBeeperMute: - return handleMatrixAccountData(portal, ctx, login, evt, MuteHandlingNetworkAPI.HandleMute) - case event.StateMember: - return portal.handleMatrixMembership(ctx, login, origSender, evt, isStateRequest) - case event.StatePowerLevels: - 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) EventHandlingResult { - content, ok := evt.Content.Parsed.(*event.ReceiptEventContent) - if !ok { - return EventHandlingResultFailed - } - for evtID, receipts := range *content { - readReceipts, ok := receipts[event.ReceiptTypeRead] - if !ok { - continue - } - for userID, receipt := range readReceipts { - sender, err := portal.Bridge.GetUserByMXID(ctx, userID) - if err != nil { - 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) { - log := zerolog.Ctx(ctx) - log.UpdateContext(func(c zerolog.Context) zerolog.Context { - return c. - Stringer("event_id", eventID). - Stringer("user_id", user.MXID). - Stringer("receipt_ts", receipt.Timestamp) - }) - login, userPortal, err := portal.FindPreferredLogin(ctx, user, false) - if err != nil { - if !errors.Is(err, ErrNotLoggedIn) { - log.Err(err).Msg("Failed to get preferred login for user") - } - return - } else if login == nil { - return - } - rrClient, ok := login.Client.(ReadReceiptHandlingNetworkAPI) - if !ok { - return - } - log.UpdateContext(func(c zerolog.Context) zerolog.Context { - return c.Str("user_login_id", string(login.ID)) - }) - evt := &MatrixReadReceipt{ - Portal: portal, - EventID: eventID, - Receipt: receipt, - } - 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) - }) - evt.ReadUpTo = evt.ExactMessage.Timestamp - } else { - evt.ReadUpTo = receipt.Timestamp - } - portal.callReadReceiptHandler(ctx, login, rrClient, evt, userPortal) -} - -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 EventHandlingResultFailed - } - portal.currentlyTypingLock.Lock() - defer portal.currentlyTypingLock.Unlock() - slices.Sort(content.UserIDs) - stoppedTyping, startedTyping := exslices.SortedDiff(portal.currentlyTyping, content.UserIDs, func(a, b id.UserID) int { - return strings.Compare(string(a), string(b)) - }) - 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) { - for _, userID := range userIDs { - login, ok := portal.currentlyTypingLogins[userID] - if !ok && !typing { - continue - } else if !ok { - user, err := portal.Bridge.GetUserByMXID(ctx, userID) - if err != nil { - zerolog.Ctx(ctx).Err(err).Stringer("user_id", userID).Msg("Failed to get user to send typing event") - continue - } else if user == nil { - continue - } - login, _, err = portal.FindPreferredLogin(ctx, user, false) - if err != nil { - if !errors.Is(err, ErrNotLoggedIn) { - zerolog.Ctx(ctx).Err(err).Stringer("user_id", userID).Msg("Failed to get user login to send typing event") - } - continue - } else if login == nil { - continue - } else if _, ok = login.Client.(TypingHandlingNetworkAPI); !ok { - continue - } - portal.currentlyTypingLogins[userID] = login - } - if !typing { - delete(portal.currentlyTypingLogins, userID) - } - typingAPI, ok := login.Client.(TypingHandlingNetworkAPI) - if !ok { - continue - } - err := typingAPI.HandleMatrixTyping(ctx, &MatrixTyping{ - Portal: portal, - IsTyping: typing, - Type: TypingTypeText, - }) - if err != nil { - zerolog.Ctx(ctx).Err(err).Stringer("user_id", userID).Msg("Failed to bridge Matrix typing event") - } else { - zerolog.Ctx(ctx).Debug(). - Stringer("user_id", userID). - Bool("typing", typing). - Msg("Sent typing event") - } - } -} - -func (portal *Portal) periodicTypingUpdater() { - // TODO actually call this function - log := portal.Log.With().Str("component", "typing updater").Logger() - ctx := log.WithContext(context.Background()) - for { - // TODO make delay configurable by network connector - time.Sleep(5 * time.Second) - portal.currentlyTypingLock.Lock() - if len(portal.currentlyTyping) == 0 { - portal.currentlyTypingLock.Unlock() - continue - } - for _, userID := range portal.currentlyTyping { - login, ok := portal.currentlyTypingLogins[userID] - if !ok { - continue - } - typingAPI, ok := login.Client.(TypingHandlingNetworkAPI) - if !ok { - continue - } - err := typingAPI.HandleMatrixTyping(ctx, &MatrixTyping{ - Portal: portal, - IsTyping: true, - Type: TypingTypeText, - }) - if err != nil { - log.Err(err).Stringer("user_id", userID).Msg("Failed to repeat Matrix typing event") - } else { - log.Debug(). - Stringer("user_id", userID). - Bool("typing", true). - Msg("Sent repeated typing event") - } - } - portal.currentlyTypingLock.Unlock() - } -} - -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.LocationMessage.Reject() { - return ErrLocationMessagesNotAllowed - } - 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 nil -} - -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 - var pollContent *event.PollStartEventContent - var pollResponseContent *event.PollResponseEventContent - var ok bool - if evt.Type == event.EventUnstablePollStart { - pollContent, ok = evt.Content.Parsed.(*event.PollStartEventContent) - relatesTo = pollContent.RelatesTo - } else if evt.Type == event.EventUnstablePollResponse { - pollResponseContent, ok = evt.Content.Parsed.(*event.PollResponseEventContent) - relatesTo = &pollResponseContent.RelatesTo - } 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") - 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") - return EventHandlingResultFailed.WithMSSError(fmt.Errorf("%w of polls", ErrEditsNotSupported)) - } - 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") - return EventHandlingResultIgnored.WithMSSError(ErrIgnoringPollFromRelayedUser) - } - 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 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") - return EventHandlingResultIgnored.WithMSSError(ErrPollsNotSupported) - } - } - - var threadRoot, replyTo, voteTo *database.Message - if evt.Type == event.EventUnstablePollResponse { - voteTo, err = portal.Bridge.DB.Message.GetPartByMXID(ctx, relatesTo.GetReferenceID()) - if err != nil { - log.Err(err).Msg("Failed to get poll target message from database") - // TODO send status - return EventHandlingResultFailed - } else if voteTo == nil { - log.Warn().Stringer("vote_to_id", relatesTo.GetReferenceID()).Msg("Poll target message not found") - // TODO send status - return EventHandlingResultFailed - } - } - var replyToID id.EventID - 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() - } - 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") - } else if replyTo == nil { - log.Warn().Stringer("reply_to_id", replyToID).Msg("Reply target message not found") - } else { - // Support replying to threads from non-thread-capable clients. - // 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.Thread.Partial() && threadRoot == nil && (replyTo.ThreadRoot != "" || !caps.Reply.Partial()) { - threadRootRemoteID := replyTo.ThreadRoot - if threadRootRemoteID == "" { - threadRootRemoteID = replyTo.ID - } - threadRoot, err = portal.Bridge.DB.Message.GetFirstThreadMessage(ctx, portal.PortalKey, threadRootRemoteID) - if err != nil { - log.Err(err).Msg("Failed to get thread root message from database (via reply fallback)") - } - } - 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]{ - Event: evt, - 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) - } else if pollContent != nil { - resp, err = sender.Client.(PollHandlingNetworkAPI).HandleMatrixPollStart(ctx, &MatrixPollStart{ - MatrixMessage: *wrappedMsgEvt, - Content: pollContent, - }) - } else if pollResponseContent != nil { - resp, err = sender.Client.(PollHandlingNetworkAPI).HandleMatrixPollVote(ctx, &MatrixPollVote{ - MatrixMessage: *wrappedMsgEvt, - VoteTo: voteTo, - Content: pollResponseContent, - }) - } else { - log.Error().Msg("Failed to handle Matrix message: all contents are nil?") - return EventHandlingResultFailed.WithMSSError(fmt.Errorf("all contents are nil")) - } - if err != nil { - log.Err(err).Msg("Failed to handle Matrix message") - return EventHandlingResultFailed.WithMSSError(err) - } - message := wrappedMsgEvt.fillDBMessage(resp.DB) - 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 { - if portal.Bridge.Config.OutgoingMessageReID { - message.MXID = portal.Bridge.Matrix.GenerateDeterministicEventID(portal.MXID, portal.PortalKey, message.ID, message.PartID) - } - // Hack to ensure the ghost row exists - // TODO move to better place (like login) - portal.Bridge.GetGhostByID(ctx, message.SenderID) - err = portal.Bridge.DB.Message.Insert(ctx, message) - if err != nil { - log.Err(err).Msg("Failed to save message to database") - } else if resp.PostSave != nil { - resp.PostSave(ctx, message) - } - if resp.RemovePending != "" { - portal.outgoingMessagesLock.Lock() - delete(portal.outgoingMessages, resp.RemovePending) - portal.outgoingMessagesLock.Unlock() - } - } - portal.sendSuccessStatus(ctx, evt, resp.StreamOrder, message.MXID) - } - 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, - 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. -// -// This should be used when the network connector will return the real message ID from HandleMatrixMessage. -// The [MatrixMessageResponse] should include RemovePending with the transaction ID sto remove it from the lit -// after saving to database. -// -// See also: [MatrixMessage.AddPendingToSave] -func (evt *MatrixMessage) AddPendingToIgnore(txnID networkid.TransactionID) { - evt.Portal.outgoingMessagesLock.Lock() - evt.Portal.outgoingMessages[txnID] = &outgoingMessage{ - ignore: true, - } - evt.Portal.outgoingMessagesLock.Unlock() -} - -// AddPendingToSave adds a transaction ID that should be processed and pointed at the existing event if encountered. -// -// This should be used when the network connector returns `Pending: true` from HandleMatrixMessage, -// i.e. when the network connector does not know the message ID at the end of the handler. -// The [MatrixMessageResponse] should set Pending to true to prevent saving the returned message to the database. -// -// The provided function will be called when the message is encountered. -func (evt *MatrixMessage) AddPendingToSave(message *database.Message, txnID networkid.TransactionID, handleEcho RemoteEchoHandler) { - 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() -} - -// RemovePending removes a transaction ID from the list of pending messages. -// 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() -} - -func (evt *MatrixMessage) fillDBMessage(message *database.Message) *database.Message { - if message == nil { - message = &database.Message{} - } - if message.MXID == "" { - message.MXID = evt.Event.ID - } - if message.Room.ID == "" { - message.Room = evt.Portal.PortalKey - } - if message.Timestamp.IsZero() { - message.Timestamp = time.UnixMilli(evt.Event.Timestamp) - } - if message.ReplyTo.MessageID == "" && evt.ReplyTo != nil { - message.ReplyTo.MessageID = evt.ReplyTo.ID - message.ReplyTo.PartID = &evt.ReplyTo.PartID - } - if message.ThreadRoot == "" && evt.ThreadRoot != nil { - message.ThreadRoot = evt.ThreadRoot.ID - if evt.ThreadRoot.ThreadRoot != "" { - message.ThreadRoot = evt.ThreadRoot.ThreadRoot - } - } - if message.SenderMXID == "" { - message.SenderMXID = evt.Event.Sender - } - if message.SendTxnID != "" { - message.SendTxnID = evt.InputTransactionID - } - return message -} - -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 { - return c.Stringer("edit_target_mxid", editTargetID) - }) - 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") - return EventHandlingResultFailed.WithMSSError(err) - } - } - - editingAPI, ok := sender.Client.(EditHandlingNetworkAPI) - if !ok { - log.Debug().Msg("Ignoring edit as network connector doesn't implement EditHandlingNetworkAPI") - return EventHandlingResultIgnored.WithMSSError(ErrEditsNotSupported) - } else if !caps.Edit.Partial() { - log.Debug().Msg("Ignoring edit as room doesn't support edits") - 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") - 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") - 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 { - return EventHandlingResultFailed.WithMSSError(ErrEditTargetTooManyEdits) - } - log.UpdateContext(func(c zerolog.Context) zerolog.Context { - return c.Str("edit_target_remote_id", string(editTarget.ID)) - }) - err = editingAPI.HandleMatrixEdit(ctx, &MatrixEdit{ - MatrixEventBase: MatrixEventBase[*event.MessageEventContent]{ - Event: evt, - 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") - return EventHandlingResultFailed.WithMSSError(err) - } - err = portal.Bridge.DB.Message.Update(ctx, editTarget) - if err != nil { - log.Err(err).Msg("Failed to save message to database after editing") - } - // 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) (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") - 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") - 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) - }) - 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") - 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") - 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)) - }) - react := &MatrixReaction{ - MatrixEventBase: MatrixEventBase[*event.ReactionEventContent]{ - 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") - return EventHandlingResultFailed.WithMSSError(err) - } - 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 - } - _, err := portal.Bridge.Bot.SendMessage(ctx, portal.MXID, event.EventRedaction, &event.Content{ - Parsed: &event.RedactionEventContent{ - 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, portal.Receiver, reactionTarget.ID, preResp.SenderID) - if err != nil { - log.Err(err).Msg("Failed to get all reactions to message by sender") - return EventHandlingResultFailed.WithMSSError(fmt.Errorf("%w: failed to get previous reactions: %w", ErrDatabaseError, err)) - } - if len(allReactions) < preResp.MaxReactions { - react.ExistingReactionsToKeep = allReactions - } else { - // Keep n-1 previous reactions and remove the rest - react.ExistingReactionsToKeep = allReactions[:preResp.MaxReactions-1] - for _, oldReaction := range allReactions[preResp.MaxReactions-1:] { - 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") - return EventHandlingResultFailed.WithMSSError(err) - } - if dbReaction == nil { - dbReaction = &database.Reaction{} - } - // Fill all fields that are known to allow omitting them in connector code - if dbReaction.Room.ID == "" { - dbReaction.Room = portal.PortalKey - } - if dbReaction.MessageID == "" { - dbReaction.MessageID = reactionTarget.ID - dbReaction.MessagePartID = reactionTarget.PartID - } - if deterministicID != "" { - dbReaction.MXID = deterministicID - } else if dbReaction.MXID == "" { - dbReaction.MXID = evt.ID - } - if dbReaction.Timestamp.IsZero() { - dbReaction.Timestamp = time.UnixMilli(evt.Timestamp) - } - if preResp.EmojiID == "" && dbReaction.EmojiID == "" { - if dbReaction.Emoji == "" { - dbReaction.Emoji = preResp.Emoji - } - } else if dbReaction.EmojiID == "" { - dbReaction.EmojiID = preResp.EmojiID - } - if dbReaction.SenderID == "" { - dbReaction.SenderID = preResp.SenderID - } - if dbReaction.SenderMXID == "" { - dbReaction.SenderMXID = evt.Sender - } - err = portal.Bridge.DB.Reaction.Upsert(ctx, dbReaction) - if err != nil { - log.Err(err).Msg("Failed to save reaction to database") - } - return EventHandlingResultSuccess.WithEventID(deterministicID) -} - -func handleMatrixRoomMeta[APIType any, ContentType any]( - portal *Portal, - ctx context.Context, - 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 { - 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") - 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 EventHandlingResultIgnored - } - case *event.TopicEventContent: - if typedContent.Topic == portal.Topic { - portal.sendSuccessStatus(ctx, evt, 0, "") - return EventHandlingResultIgnored - } - case *event.RoomAvatarEventContent: - if typedContent.URL == portal.AvatarMXC { - portal.sendSuccessStatus(ctx, evt, 0, "") - 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 - if evt.Unsigned.PrevContent != nil { - _ = evt.Unsigned.PrevContent.ParseRaw(evt.Type) - prevContent, _ = evt.Unsigned.PrevContent.Parsed.(ContentType) - } - - changed, err := fn(api, ctx, &MatrixRoomMeta[ContentType]{ - MatrixEventBase: MatrixEventBase[ContentType]{ - Event: evt, - Content: content, - Portal: portal, - OrigSender: origSender, - - InputTransactionID: portal.parseInputTransactionID(origSender, evt), - }, - IsStateRequest: isStateRequest, - PrevContent: prevContent, - }) - if err != nil { - log.Err(err).Msg("Failed to handle Matrix room metadata") - return EventHandlingResultFailed.WithMSSError(err) - } - if changed { - 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") - } - } - 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 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 EventHandlingResultFailed.WithError(fmt.Errorf("%w: %T", ErrUnexpectedParsedContentType, evt.Content.Parsed)) - } - var prevContent ContentType - if evt.Unsigned.PrevContent != nil { - _ = evt.Unsigned.PrevContent.ParseRaw(evt.Type) - prevContent, _ = evt.Unsigned.PrevContent.Parsed.(ContentType) - } - - err := fn(api, ctx, &MatrixRoomMeta[ContentType]{ - MatrixEventBase: MatrixEventBase[ContentType]{ - Event: evt, - Content: content, - Portal: portal, - }, - PrevContent: prevContent, - }) - 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) { - if targetGhost, err := portal.Bridge.GetGhostByMXID(ctx, userID); err != nil { - return nil, fmt.Errorf("failed to get ghost: %w", err) - } else if targetGhost != nil { - return targetGhost, nil - } else if targetUser, err := portal.Bridge.GetUserByMXID(ctx, userID); err != nil { - return nil, fmt.Errorf("failed to get user: %w", err) - } else if targetUserLogin, _, err := portal.FindPreferredLogin(ctx, targetUser, false); err != nil { - return nil, fmt.Errorf("failed to find preferred login: %w", err) - } else if targetUserLogin != nil { - return targetUserLogin, nil - } else { - // Return raw nil as a separate case to ensure a typed nil isn't returned - return nil, nil - } -} - -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") - return EventHandlingResultFailed.WithMSSError(fmt.Errorf("%w: %T", ErrUnexpectedParsedContentType, evt.Content.Parsed)) - } - prevContent := &event.MemberEventContent{Membership: event.MembershipLeave} - if evt.Unsigned.PrevContent != nil { - _ = evt.Unsigned.PrevContent.ParseRaw(evt.Type) - prevContent, _ = evt.Unsigned.PrevContent.Parsed.(*event.MemberEventContent) - } - log.UpdateContext(func(c zerolog.Context) zerolog.Context { - return c. - Str("membership", string(content.Membership)). - Str("prev_membership", string(prevContent.Membership)). - Str("target_user_id", evt.GetStateKey()) - }) - api, ok := sender.Client.(MembershipHandlingNetworkAPI) - if !ok { - 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") - 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") - return EventHandlingResultIgnored //.WithMSSError(ErrIgnoringLeaveEvent) - } - targetGhost, _ := target.(*Ghost) - membershipChange := &MatrixMembershipChange{ - MatrixRoomMeta: MatrixRoomMeta[*event.MemberEventContent]{ - MatrixEventBase: MatrixEventBase[*event.MemberEventContent]{ - Event: evt, - Content: content, - Portal: portal, - OrigSender: origSender, - - InputTransactionID: portal.parseInputTransactionID(origSender, evt), - }, - IsStateRequest: isStateRequest, - PrevContent: prevContent, - }, - Target: target, - Type: membershipChangeType, - } - res, err := api.HandleMatrixMembership(ctx, membershipChange) - if err != nil { - log.Err(err).Msg("Failed to handle Matrix membership change") - 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 { - if old == new { - return nil - } - return &SinglePowerLevelChange{OrigLevel: old, NewLevel: new, NewIsSet: newIsSet} -} - -func getUniqueKeys[Key comparable, Value any](maps ...map[Key]Value) map[Key]struct{} { - unique := make(map[Key]struct{}) - for _, m := range maps { - for k := range m { - unique[k] = struct{}{} - } - } - return unique -} - -func (portal *Portal) handleMatrixPowerLevels( - ctx context.Context, - 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") - 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 { - 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{ - MatrixRoomMeta: MatrixRoomMeta[*event.PowerLevelsEventContent]{ - MatrixEventBase: MatrixEventBase[*event.PowerLevelsEventContent]{ - Event: evt, - Content: content, - Portal: portal, - OrigSender: origSender, - - InputTransactionID: portal.parseInputTransactionID(origSender, evt), - }, - IsStateRequest: isStateRequest, - PrevContent: prevContent, - }, - Users: make(map[id.UserID]*UserPowerLevelChange), - Events: make(map[string]*SinglePowerLevelChange), - UsersDefault: makePLChange(prevContent.UsersDefault, content.UsersDefault, true), - EventsDefault: makePLChange(prevContent.EventsDefault, content.EventsDefault, true), - StateDefault: makePLChange(prevContent.StateDefault(), content.StateDefault(), content.StateDefaultPtr != nil), - Invite: makePLChange(prevContent.Invite(), content.Invite(), content.InvitePtr != nil), - Kick: makePLChange(prevContent.Kick(), content.Kick(), content.KickPtr != nil), - Ban: makePLChange(prevContent.Ban(), content.Ban(), content.BanPtr != nil), - Redact: makePLChange(prevContent.Redact(), content.Redact(), content.RedactPtr != nil), - } - for eventType := range getUniqueKeys(content.Events, prevContent.Events) { - newLevel, hasNewLevel := content.Events[eventType] - if !hasNewLevel { - // TODO this doesn't handle state events properly - newLevel = content.EventsDefault - } - if change := makePLChange(prevContent.Events[eventType], newLevel, hasNewLevel); change != nil { - plChange.Events[eventType] = change - } - } - for user := range getUniqueKeys(content.Users, prevContent.Users) { - _, hasNewLevel := content.Users[user] - change := makePLChange(prevContent.GetUserLevel(user), content.GetUserLevel(user), hasNewLevel) - if change == nil { - continue - } - target, err := portal.getTargetUser(ctx, user) - if err != nil { - log.Err(err).Stringer("target_user_id", user).Msg("Failed to get user for power level change") - } else { - plChange.Users[user] = &UserPowerLevelChange{ - Target: target, - SinglePowerLevelChange: *change, - } - } - } - _, err := api.HandleMatrixPowerLevels(ctx, plChange) - if err != nil { - log.Err(err).Msg("Failed to handle Matrix power level change") - return EventHandlingResultFailed.WithMSSError(err) - } - return EventHandlingResultSuccess.WithMSS() -} - -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") - return EventHandlingResultFailed.WithMSSError(fmt.Errorf("%w: %T", ErrUnexpectedParsedContentType, evt.Content.Parsed)) - } - if evt.Redacts != "" && content.Redacts != evt.Redacts { - content.Redacts = evt.Redacts - } - log.UpdateContext(func(c zerolog.Context) zerolog.Context { - return c.Stringer("redaction_target_mxid", content.Redacts) - }) - deletingAPI, deleteOK := sender.Client.(RedactionHandlingNetworkAPI) - 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") - 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") - 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") - return EventHandlingResultIgnored.WithMSSError(ErrRedactionsNotSupported) - } - err = deletingAPI.HandleMatrixMessageRemove(ctx, &MatrixMessageRemove{ - MatrixEventBase: MatrixEventBase[*event.RedactionEventContent]{ - Event: evt, - 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") - 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") - return EventHandlingResultIgnored.WithMSSError(ErrReactionsNotSupported) - } - // TODO ignore if sender doesn't match? - err = reactingAPI.HandleMatrixReactionRemove(ctx, &MatrixReactionRemove{ - MatrixEventBase: MatrixEventBase[*event.RedactionEventContent]{ - Event: evt, - Content: content, - Portal: portal, - OrigSender: origSender, - - InputTransactionID: portal.parseInputTransactionID(origSender, evt), - }, - TargetReaction: redactionTargetReaction, - }) - } else { - log.Debug().Msg("Redaction target message not found in database") - return EventHandlingResultIgnored.WithMSSError(fmt.Errorf("redaction %w", ErrTargetMessageNotFound)) - } - if err != nil { - log.Err(err).Msg("Failed to handle Matrix redaction") - return EventHandlingResultFailed.WithMSSError(err) - } - // TODO delete msg/reaction db row - return EventHandlingResultSuccess.WithMSS() -} - -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 EventHandlingResultIgnored - } - infoProvider, ok := mcp.(RemoteChatResyncWithInfo) - var info *ChatInfo - var err error - if ok { - info, err = infoProvider.GetChatInfo(ctx, portal) - if err != nil { - log.Err(err).Msg("Failed to get chat info for portal creation from chat resync event") - } - } - bundleProvider, ok := evt.(RemoteChatResyncBackfillBundle) - var bundle any - if ok { - bundle = bundleProvider.GetBundledBackfillData() - } - err = portal.createMatrixRoomInLoop(ctx, source, info, bundle) - if err != nil { - log.Err(err).Msg("Failed to create portal to handle event") - return EventHandlingResultFailed.WithError(err) - } - if evtType == RemoteEventChatResync { - log.Debug().Msg("Not handling chat resync event further as portal was created by it") - postHandler, ok := evt.(RemotePostHandler) - if ok { - postHandler.PostHandle(ctx, portal) - } - return EventHandlingResultSuccess - } - } - preHandler, ok := evt.(RemotePreHandler) - if ok { - preHandler.PreHandle(ctx, portal) - } - log.Debug().Msg("Handling remote event") - switch evtType { - case RemoteEventUnknown: - log.Debug().Msg("Ignoring remote event with type unknown") - res = EventHandlingResultIgnored - case RemoteEventMessage, RemoteEventMessageUpsert: - res = portal.handleRemoteMessage(ctx, source, evt.(RemoteMessage)) - case RemoteEventEdit: - res = portal.handleRemoteEdit(ctx, source, evt.(RemoteEdit)) - case RemoteEventReaction: - res = portal.handleRemoteReaction(ctx, source, evt.(RemoteReaction)) - case RemoteEventReactionRemove: - res = portal.handleRemoteReactionRemove(ctx, source, evt.(RemoteReactionRemove)) - case RemoteEventReactionSync: - res = portal.handleRemoteReactionSync(ctx, source, evt.(RemoteReactionSync)) - case RemoteEventMessageRemove: - res = portal.handleRemoteMessageRemove(ctx, source, evt.(RemoteMessageRemove)) - case RemoteEventReadReceipt: - res = portal.handleRemoteReadReceipt(ctx, source, evt.(RemoteReadReceipt)) - case RemoteEventMarkUnread: - res = portal.handleRemoteMarkUnread(ctx, source, evt.(RemoteMarkUnread)) - case RemoteEventDeliveryReceipt: - res = portal.handleRemoteDeliveryReceipt(ctx, source, evt.(RemoteDeliveryReceipt)) - case RemoteEventTyping: - res = portal.handleRemoteTyping(ctx, source, evt.(RemoteTyping)) - case RemoteEventChatInfoChange: - res = portal.handleRemoteChatInfoChange(ctx, source, evt.(RemoteChatInfoChange)) - case RemoteEventChatResync: - res = portal.handleRemoteChatResync(ctx, source, evt.(RemoteChatResync)) - case RemoteEventChatDelete: - res = portal.handleRemoteChatDelete(ctx, source, evt.(RemoteChatDelete)) - case RemoteEventBackfill: - res = portal.handleRemoteBackfill(ctx, source, evt.(RemoteBackfill)) - default: - log.Warn().Msg("Got remote event with unknown type") - } - postHandler, ok := evt.(RemotePostHandler) - if ok { - postHandler.PostHandle(ctx, portal) - } - return -} - -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 != "" { - 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 - } - ghost.UpdateInfoIfNecessary(ctx, source, evtType) - portal.ensureFunctionalMember(ctx, ghost) - } - if sender.IsFromMe { - intent = source.User.DoublePuppet(ctx) - if intent != nil { - return - } - extraUserID = source.UserMXID - } else if sender.SenderLogin != "" && portal.Receiver == "" { - senderLogin := portal.Bridge.GetCachedUserLoginByID(sender.SenderLogin) - if senderLogin != nil { - intent = senderLogin.User.DoublePuppet(ctx) - if intent != nil { - return - } - extraUserID = senderLogin.UserMXID - } - } - if sender.Sender != "" && portal.Receiver == "" && otherLogins != nil { - for _, login := range otherLogins { - if login.Client.IsThisUser(ctx, sender.Sender) { - intent = login.User.DoublePuppet(ctx) - if intent != nil { - return - } - extraUserID = login.UserMXID - } - } - } - if ghost != nil { - intent = ghost.Intent - } - return -} - -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, true -} - -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 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 || portal.Bridge.Config.OutgoingMessageReID { - // This is somewhat evil - replyTo = &database.Message{ - 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", *currentMsg.ReplyTo).Msg("Reply target message not found in database") - } - } - } - 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 || portal.Bridge.Config.OutgoingMessageReID { - threadRoot = &database.Message{ - MXID: portal.Bridge.Matrix.GenerateDeterministicEventID(portal.MXID, portal.PortalKey, *currentMsg.ThreadRoot, ""), - } - } else { - 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, *currentMsg.ThreadRoot); err != nil { - log.Err(err).Msg("Failed to get last thread message from database") - } - if prevThreadEvent == nil { - prevThreadEvent = ptr.Clone(threadRoot) - } - } - return -} - -func (portal *Portal) applyRelationMeta(ctx context.Context, content *event.MessageEventContent, replyTo, threadRoot, prevThreadEvent *database.Message) { - if content.Mentions == nil { - content.Mentions = &event.Mentions{} - } - if threadRoot != nil && prevThreadEvent != nil { - content.GetRelatesTo().SetThread(threadRoot.MXID, prevThreadEvent.MXID) - } - if replyTo != nil { - 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) - } -} - -func (portal *Portal) 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) { - if logContext == nil { - logContext = func(e *zerolog.Event) *zerolog.Event { - return e - } - } - log := zerolog.Ctx(ctx) - 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(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, - IsDoublePuppeted: intent.IsDoublePuppet(), - } - if part.DontBridge { - dbMessage.SetFakeMXID() - logContext(log.Debug()). - Stringer("event_id", dbMessage.MXID). - Str("part_id", string(part.ID)). - Msg("Not bridging message part with DontBridge flag to Matrix") - } else { - resp, err := intent.SendMessage(ctx, portal.MXID, part.Type, &event.Content{ - Parsed: part.Content, - Raw: part.Extra, - }, &MatrixSendExtra{ - Timestamp: ts, - MessageMeta: dbMessage, - StreamOrder: streamOrder, - PartIndex: i, - }) - 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()). - Stringer("event_id", resp.EventID). - Str("part_id", string(part.ID)). - Msg("Sent message part to Matrix") - dbMessage.MXID = resp.EventID - } - 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 != event.DisappearingTypeNone && !dbMessage.HasFakeMXID() { - if converted.Disappear.Type == event.DisappearingTypeAfterSend && converted.Disappear.DisappearAt.IsZero() { - converted.Disappear.DisappearAt = dbMessage.Timestamp.Add(converted.Disappear.Timer) - } - portal.Bridge.DisappearLoop.Add(ctx, &database.DisappearingMessage{ - RoomID: portal.MXID, - EventID: dbMessage.MXID, - Timestamp: dbMessage.Timestamp, - DisappearingSetting: converted.Disappear, - }) - } - if prevThreadEvent != nil && !dbMessage.HasFakeMXID() { - prevThreadEvent = dbMessage - } - output = append(output, dbMessage) - } - if !allSuccess { - return output, EventHandlingResultFailed - } - return output, EventHandlingResultSuccess -} - -func (portal *Portal) checkPendingMessage(ctx context.Context, evt RemoteMessage) (bool, *database.Message) { - evtWithTxn, ok := evt.(RemoteMessageWithTransactionID) - if !ok { - return false, nil - } - txnID := evtWithTxn.GetTransactionID() - if txnID == "" { - return false, nil - } - portal.outgoingMessagesLock.Lock() - defer portal.outgoingMessagesLock.Unlock() - pending, ok := portal.outgoingMessages[txnID] - if !ok { - return false, nil - } else if pending.ignore { - return true, nil - } - delete(portal.outgoingMessages, txnID) - pending.db.ID = evt.GetID() - if pending.db.SenderID == "" { - pending.db.SenderID = evt.GetSender().Sender - } - evtWithTimestamp, ok := evt.(RemoteEventWithTimestamp) - if ok { - ts := evtWithTimestamp.GetTimestamp() - if !ts.IsZero() { - pending.db.Timestamp = ts - } - } - var statusErr error - saveMessage := true - if pending.handle != nil { - saveMessage, statusErr = pending.handle(evt, pending.db) - } - if saveMessage { - if portal.Bridge.Config.OutgoingMessageReID { - pending.db.MXID = portal.Bridge.Matrix.GenerateDeterministicEventID(portal.MXID, portal.PortalKey, pending.db.ID, pending.db.PartID) - } - // Hack to ensure the ghost row exists - // TODO move to better place (like login) - portal.Bridge.GetGhostByID(ctx, pending.db.SenderID) - err := portal.Bridge.DB.Message.Insert(ctx, pending.db) - if err != nil { - zerolog.Ctx(ctx).Err(err).Msg("Failed to save message to database after receiving remote echo") - } - } - if !errors.Is(statusErr, ErrNoStatus) { - if statusErr != nil { - portal.sendErrorStatus(ctx, pending.evt, statusErr) - } else { - portal.sendSuccessStatus(ctx, pending.evt, getStreamOrder(evt), pending.evt.ID) - } - } - zerolog.Ctx(ctx).Debug().Stringer("event_id", pending.evt.ID).Msg("Received remote echo for message") - return true, pending.db -} - -func (portal *Portal) handleRemoteUpsert(ctx context.Context, source *UserLogin, evt RemoteMessageUpsert, existing []*database.Message) (handleRes EventHandlingResult, continueHandling bool) { - log := zerolog.Ctx(ctx) - 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) - } - } - } - if len(res.SubEvents) > 0 { - for _, subEvt := range res.SubEvents { - subType := subEvt.GetType() - log := portal.Log.With(). - Str("source_id", string(source.ID)). - Str("action", "handle remote subevent"). - Stringer("bridge_evt_type", subType). - Logger() - subRes := portal.handleRemoteEvent(log.WithContext(ctx), source, subType, subEvt) - if !subRes.Success { - handleRes.Success = false - } - } - } - continueHandling = res.ContinueMessageHandling - return -} - -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 { - res, _ = portal.handleRemoteUpsert(ctx, source, upsertEvt, []*database.Message{dbMessage}) - } else { - res = EventHandlingResultIgnored - } - return - } - existing, err := portal.Bridge.DB.Message.GetAllPartsByID(ctx, portal.Receiver, evt.GetID()) - if err != nil { - log.Err(err).Msg("Failed to check if message is a duplicate") - } else if len(existing) > 0 { - if isUpsert { - 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 res - } - } else { - log.Debug().Stringer("existing_mxid", existing[0].MXID).Msg("Ignoring duplicate message") - return EventHandlingResultIgnored - } - } - 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) - } - } - _, 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) { - resp, sendErr := intent.SendMessage(ctx, portal.MXID, event.EventMessage, &event.Content{ - Parsed: &event.MessageEventContent{ - MsgType: event.MsgNotice, - Body: fmt.Sprintf("An error occurred while processing an incoming %s", evtTypeName), - Mentions: &event.Mentions{}, - }, - Raw: map[string]any{ - "fi.mau.bridge.internal_error": err.Error(), - }, - }, &MatrixSendExtra{ - Timestamp: ts, - }) - if sendErr != nil { - zerolog.Ctx(ctx).Err(sendErr).Msg("Failed to send error notice after remote event handling failed") - } else { - zerolog.Ctx(ctx).Debug().Stringer("event_id", resp.EventID).Msg("Sent error notice after remote event handling failed") - } -} - -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 { - existing = bundledEvt.GetTargetDBMessage() - } - if existing == nil { - targetID := evt.GetTargetMessage() - var err error - 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 EventHandlingResultFailed.WithError(err) - } - } - if existing == nil { - log.Warn().Msg("Edit target message not found") - return EventHandlingResultIgnored - } - 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 EventHandlingResultIgnored - } else if err != nil { - log.Err(err).Msg("Failed to convert remote edit") - portal.sendRemoteErrorNotice(ctx, intent, err, ts, "edit") - return EventHandlingResultFailed.WithError(err) - } - 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( - ctx context.Context, - targetID networkid.MessageID, - senderID networkid.UserID, - converted *ConvertedEdit, - 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{} - } - overrideMXID := true - if part.Part.Room != portal.PortalKey { - part.Part.Room = portal.PortalKey - } else if !part.Part.HasFakeMXID() { - part.Content.SetEdit(part.Part.MXID) - overrideMXID = false - if part.NewMentions != nil { - part.Content.Mentions = part.NewMentions - } else { - part.Content.Mentions = &event.Mentions{} - } - } - if part.TopLevelExtra == nil { - part.TopLevelExtra = make(map[string]any) - } - if part.Extra != nil { - part.TopLevelExtra["m.new_content"] = part.Extra - } - wrappedContent := &event.Content{ - Parsed: part.Content, - Raw: part.TopLevelExtra, - } - if !part.DontBridge { - resp, err := intent.SendMessage(ctx, portal.MXID, part.Type, wrappedContent, &MatrixSendExtra{ - Timestamp: ts, - MessageMeta: part.Part, - StreamOrder: streamOrder, - PartIndex: i, - }) - if err != nil { - log.Err(err).Stringer("part_mxid", part.Part.MXID).Msg("Failed to edit message part") - allSuccess = false - continue - } else { - log.Debug(). - Stringer("event_id", resp.EventID). - Str("part_id", string(part.Part.ID)). - Msg("Sent message part edit to Matrix") - if overrideMXID { - part.Part.MXID = resp.EventID - } - } - } - 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 { - redactContent := &event.Content{ - Parsed: &event.RedactionEventContent{ - Redacts: part.MXID, - }, - } - resp, err := intent.SendMessage(ctx, portal.MXID, event.EventRedaction, redactContent, &MatrixSendExtra{ - Timestamp: ts, - }) - 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). - Stringer("redacted_event_id", part.MXID). - Str("part_id", string(part.ID)). - Msg("Sent redaction of message part to Matrix") - } - 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 { - _, 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) { - if partTargeter, ok := evt.(RemoteEventWithTargetPart); ok { - return portal.Bridge.DB.Message.GetPartByID(ctx, portal.Receiver, evt.GetTargetMessage(), partTargeter.GetTargetMessagePart()) - } else { - return portal.Bridge.DB.Message.GetFirstPartByID(ctx, portal.Receiver, evt.GetTargetMessage()) - } -} - -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, portal.Receiver, evt.GetTargetMessage(), partTargeter.GetTargetMessagePart(), evt.GetSender().Sender, evt.GetRemovedEmojiID()) - } else { - return portal.Bridge.DB.Reaction.GetByIDWithoutMessagePart(ctx, portal.Receiver, evt.GetTargetMessage(), evt.GetSender().Sender, evt.GetRemovedEmojiID()) - } -} - -func getEventTS(evt RemoteEvent) time.Time { - if tsProvider, ok := evt.(RemoteEventWithTimestamp); ok { - return tsProvider.GetTimestamp() - } - return time.Now() -} - -func getStreamOrder(evt RemoteEvent) int64 { - if streamProvider, ok := evt.(RemoteEventWithStreamOrder); ok { - return streamProvider.GetStreamOrder() - } - return 0 -} - -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 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 EventHandlingResultIgnored - } - var existingReactions []*database.Reaction - if partTargeter, ok := evt.(RemoteEventWithTargetPart); ok { - existingReactions, err = portal.Bridge.DB.Reaction.GetAllToMessagePart(ctx, portal.Receiver, evt.GetTargetMessage(), partTargeter.GetTargetMessagePart()) - } else { - 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 { - if existing[existingReaction.SenderID] == nil { - existing[existingReaction.SenderID] = make(map[networkid.EmojiID]*database.Reaction) - } - existing[existingReaction.SenderID][existingReaction.EmojiID] = existingReaction - } - - 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, - func(z *zerolog.Event) *zerolog.Event { - return z. - Any("reaction_sender_id", new.Sender). - Time("reaction_ts", new.Timestamp) - }, - ) - } - doRemoveReaction := func(old *database.Reaction, intent MatrixAPI, deleteRow bool) { - if intent == nil && old.SenderMXID != "" { - intent, err = portal.getIntentForMXID(ctx, old.SenderMXID) - if err != nil { - log.Err(err). - Stringer("reaction_sender_mxid", old.SenderMXID). - Msg("Failed to get intent for removing reaction") - } - } - if intent == nil { - log.Warn(). - Str("reaction_sender_id", string(old.SenderID)). - Stringer("reaction_sender_mxid", old.SenderMXID). - Msg("Didn't find intent for removing reaction, using bridge bot") - intent = portal.Bridge.Bot - } - _, err = intent.SendMessage(ctx, portal.MXID, event.EventRedaction, &event.Content{ - Parsed: &event.RedactionEventContent{ - Redacts: old.MXID, - }, - }, &MatrixSendExtra{Timestamp: eventTS}) - if err != nil { - log.Err(err).Msg("Failed to redact old reaction") - } - if deleteRow { - err = portal.Bridge.DB.Reaction.Delete(ctx, old) - if err != nil { - log.Err(err).Msg("Failed to delete old reaction row") - } - } - } - doOverwriteReaction := func(new *BackfillReaction, old *database.Reaction) { - intent, ok := portal.GetIntentFor(ctx, new.Sender, source, RemoteEventReactionSync) - if !ok { - return - } - doRemoveReaction(old, intent, false) - doAddReaction(new, intent) - } - - newData := evt.GetReactions() - for userID, reactions := range newData.Users { - existingUserReactions := existing[userID] - delete(existing, userID) - for _, reaction := range reactions.Reactions { - if reaction.Timestamp.IsZero() { - reaction.Timestamp = eventTS - } - existingReaction, ok := existingUserReactions[reaction.EmojiID] - if ok { - delete(existingUserReactions, reaction.EmojiID) - if reaction.EmojiID != "" || reaction.Emoji == existingReaction.Emoji { - continue - } - doOverwriteReaction(reaction, existingReaction) - } else { - doAddReaction(reaction, nil) - } - } - totalReactionCount := len(existingUserReactions) + len(reactions.Reactions) - if reactions.HasAllReactions { - for _, existingReaction := range existingUserReactions { - doRemoveReaction(existingReaction, nil, true) - } - } else if reactions.MaxCount > 0 && totalReactionCount > reactions.MaxCount { - remainingReactionList := maps.Values(existingUserReactions) - slices.SortFunc(remainingReactionList, func(a, b *database.Reaction) int { - diff := a.Timestamp.Compare(b.Timestamp) - if diff == 0 { - return cmp.Compare(a.EmojiID, b.EmojiID) - } - return diff - }) - numberToRemove := totalReactionCount - reactions.MaxCount - for i := 0; i < numberToRemove && i < len(remainingReactionList); i++ { - doRemoveReaction(remainingReactionList[i], nil, true) - } - } - } - if newData.HasAllUsers { - for _, userReactions := range existing { - for _, existingReaction := range userReactions { - doRemoveReaction(existingReaction, nil, true) - } - } - } - return EventHandlingResultSuccess -} - -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 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 EventHandlingResultIgnored - } - emoji, emojiID := evt.GetReactionEmoji() - 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 EventHandlingResultFailed.WithError(err) - } else if existingReaction != nil && (emojiID != "" || existingReaction.Emoji == emoji) { - log.Debug().Msg("Ignoring duplicate reaction") - return EventHandlingResultIgnored - } - ts := getEventTS(evt) - 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() - } - var dbMetadata any - if metaProvider, ok := evt.(RemoteReactionWithMeta); ok { - dbMetadata = metaProvider.GetReactionDBMetadata() - } - if existingReaction != nil { - _, err = intent.SendMessage(ctx, portal.MXID, event.EventRedaction, &event.Content{ - Parsed: &event.RedactionEventContent{ - Redacts: existingReaction.MXID, - }, - }, &MatrixSendExtra{Timestamp: ts}) - if err != nil { - 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 - } - } - log := zerolog.Ctx(ctx) - dbReaction := &database.Reaction{ - Room: portal.PortalKey, - MessageID: targetMessage.ID, - MessagePartID: targetMessage.PartID, - SenderID: senderID, - SenderMXID: intent.GetMXID(), - EmojiID: emojiID, - Timestamp: ts, - Metadata: dbMetadata, - } - if emojiID == "" { - dbReaction.Emoji = emoji - } - resp, err := intent.SendMessage(ctx, portal.MXID, event.EventReaction, &event.Content{ - Parsed: &event.ReactionEventContent{ - RelatesTo: event.RelatesTo{ - Type: event.RelAnnotation, - EventID: targetMessage.MXID, - Key: variationselector.Add(emoji), - }, - }, - Raw: extraContent, - }, &MatrixSendExtra{ - Timestamp: ts, - ReactionMeta: dbReaction, - }) - if err != nil { - logContext(log.Err(err)).Msg("Failed to send reaction to Matrix") - return EventHandlingResultFailed.WithError(err) - } - logContext(log.Debug()). - Stringer("event_id", resp.EventID). - Msg("Sent reaction to Matrix") - dbReaction.MXID = resp.EventID - 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) { - if userID == "" { - return nil, nil - } else if ghost, err := portal.Bridge.GetGhostByMXID(ctx, userID); err != nil { - return nil, fmt.Errorf("failed to get ghost: %w", err) - } else if ghost != nil { - return ghost.Intent, nil - } else if user, err := portal.Bridge.GetExistingUserByMXID(ctx, userID); err != nil { - return nil, fmt.Errorf("failed to get user: %w", err) - } else if user != nil { - return user.DoublePuppet(ctx), nil - } else { - return nil, nil - } -} - -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 EventHandlingResultFailed.WithError(err) - } else if targetReaction == nil { - log.Warn().Msg("Target reaction not found") - 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 { - 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{ - Parsed: &event.RedactionEventContent{ - Redacts: targetReaction.MXID, - }, - }, &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) 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 EventHandlingResultFailed.WithError(err) - } else if len(targetParts) == 0 { - log.Debug().Msg("Target message not found") - return EventHandlingResultIgnored - } - onlyForMeProvider, ok := evt.(RemoteDeleteOnlyForMe) - onlyForMe := ok && onlyForMeProvider.DeleteOnlyForMe() - if onlyForMe && portal.Receiver == "" { - _, 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, 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 { - log.Err(err).Stringer("sender_mxid", targetParts[0].SenderMXID).Msg("Failed to get intent for removing message") - } else if senderIntent != nil { - intent = senderIntent - } - } - 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) EventHandlingResult { - log := zerolog.Ctx(ctx) - var anyFailed bool - for _, part := range parts { - if part.HasFakeMXID() { - continue - } - resp, err := intent.SendMessage(ctx, portal.MXID, event.EventRedaction, &event.Content{ - Parsed: &event.RedactionEventContent{ - Redacts: part.MXID, - }, - }, &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). - Stringer("redacted_event_id", part.MXID). - Str("part_id", string(part.ID)). - 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) 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 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 { - for _, targetID := range evt.GetReceiptTargets() { - target, err := portal.Bridge.DB.Message.GetLastPartByID(ctx, portal.Receiver, targetID) - if err != nil { - log.Err(err).Str("target_id", string(targetID)). - Msg("Failed to get target message for read receipt") - return EventHandlingResultFailed.WithError(err) - } else if target != nil && !target.HasFakeMXID() && (lastTarget == nil || target.Timestamp.After(lastTarget.Timestamp)) { - lastTarget = target - } - } - } - if lastTarget == nil && !readUpTo.IsZero() { - 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") - } - } - sender := evt.GetSender() - 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 { - 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.StartAllBefore(ctx, portal.MXID, readUpTo) - } - return EventHandlingResultSuccess -} - -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 EventHandlingResultIgnored - } - dp := source.User.DoublePuppet(ctx) - if dp == nil { - 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) 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 - } - 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") - return EventHandlingResultFailed.WithError(err) - } else if len(targetParts) == 0 { - continue - } else if _, sentByGhost := portal.Bridge.Matrix.ParseGhostMXID(targetParts[0].SenderMXID); sentByGhost { - continue - } - for _, part := range targetParts { - portal.Bridge.Matrix.SendMessageStatus(ctx, &MessageStatus{ - Status: event.MessageStatusSuccess, - DeliveredTo: []id.UserID{intent.GetMXID()}, - }, &MessageStatusEventInfo{ - 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) EventHandlingResult { - var typingType TypingType - if typedEvt, ok := evt.(RemoteTypingWithType); ok { - typingType = typedEvt.GetTypingType() - } - 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) EventHandlingResult { - info, err := evt.GetChatInfoChange(ctx) - if err != nil { - zerolog.Ctx(ctx).Err(err).Msg("Failed to get chat info change") - 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) EventHandlingResult { - log := zerolog.Ctx(ctx) - infoProvider, ok := evt.(RemoteChatResyncWithInfo) - if ok { - info, err := infoProvider.GetChatInfo(ctx, portal) - if err != nil { - log.Err(err).Msg("Failed to get chat info from resync event") - } else if info != nil { - portal.UpdateInfo(ctx, info, source, nil, time.Time{}) - } else { - log.Debug().Msg("No chat info provided in resync event") - } - } - backfillChecker, ok := evt.(RemoteChatResyncBackfill) - 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") - } else if needsBackfill, err := backfillChecker.CheckNeedsBackfill(ctx, latestMessage); err != nil { - log.Err(err).Msg("Failed to check if backfill is needed") - } else if needsBackfill { - bundleProvider, ok := evt.(RemoteChatResyncBackfillBundle) - var bundle any - if ok { - bundle = bundleProvider.GetBundledBackfillData() - } - portal.doForwardBackfill(ctx, source, latestMessage, bundle) - } - } - return EventHandlingResultSuccess -} - -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() { - 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 { - 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 { - 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) (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 { - // The chat info that changed. Any fields that did not change can be left as nil. - ChatInfo *ChatInfo - // A list of member changes. - // This list should only include changes, not the whole member list. - // To resync the whole list, use the field inside ChatInfo. - MemberChanges *ChatMemberList -} - -func (portal *Portal) ProcessChatInfoChange(ctx context.Context, sender EventSender, source *UserLogin, change *ChatInfoChange, ts time.Time) { - intent, ok := portal.GetIntentFor(ctx, sender, source, RemoteEventChatInfoChange) - if !ok { - return - } - if change.ChatInfo != nil { - portal.UpdateInfo(ctx, change.ChatInfo, source, intent, ts) - } - if change.MemberChanges != nil { - err := portal.syncParticipants(ctx, change.MemberChanges, source, intent, ts) - if err != nil { - zerolog.Ctx(ctx).Err(err).Msg("Failed to sync room members") - } - } -} - -// Deprecated: Renamed to ChatInfo -type PortalInfo = ChatInfo - -type ChatMember struct { - EventSender - Membership event.Membership - // 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 - // 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. - IsFull bool - // 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 - - // For DM portals, the ID of the recipient user. - // This field is optional and will be automatically filled from MemberMap if there are only 2 entries in the map. - OtherUserID networkid.UserID - - // Deprecated: Use MemberMap instead to avoid duplicate entries - Members []ChatMember - MemberMap ChatMemberMap - PowerLevels *PowerLevelOverrides -} - -func (cml *ChatMemberList) memberListToMap(ctx context.Context) { - if cml.Members == nil || cml.MemberMap != nil { - return - } - cml.MemberMap = make(map[networkid.UserID]ChatMember, len(cml.Members)) - for _, member := range cml.Members { - if _, alreadyExists := cml.MemberMap[member.Sender]; alreadyExists { - zerolog.Ctx(ctx).Warn().Str("member_id", string(member.Sender)).Msg("Duplicate member in list") - } - cml.MemberMap[member.Sender] = member - } -} - -type PowerLevelOverrides struct { - Events map[event.Type]int - UsersDefault *int - EventsDefault *int - StateDefault *int - Invite *int - Kick *int - Ban *int - Redact *int - - Custom func(*event.PowerLevelsEventContent) bool -} - -// Deprecated: renamed to PowerLevelOverrides -type PowerLevelChanges = PowerLevelOverrides - -func allowChange(newLevel *int, oldLevel, actorLevel int) bool { - return newLevel != nil && - *newLevel <= actorLevel && oldLevel <= actorLevel && - oldLevel != *newLevel -} - -func (plc *PowerLevelOverrides) Apply(actor id.UserID, content *event.PowerLevelsEventContent) (changed bool) { - if plc == nil || content == nil { - return - } - for evtType, level := range plc.Events { - changed = content.EnsureEventLevelAs(actor, evtType, level) || changed - } - var actorLevel int - if actor != "" { - actorLevel = content.GetUserLevel(actor) - } else { - actorLevel = (1 << 31) - 1 - } - if allowChange(plc.UsersDefault, content.UsersDefault, actorLevel) { - changed = true - content.UsersDefault = *plc.UsersDefault - } - if allowChange(plc.EventsDefault, content.EventsDefault, actorLevel) { - changed = true - content.EventsDefault = *plc.EventsDefault - } - if allowChange(plc.StateDefault, content.StateDefault(), actorLevel) { - changed = true - content.StateDefaultPtr = plc.StateDefault - } - if allowChange(plc.Invite, content.Invite(), actorLevel) { - changed = true - content.InvitePtr = plc.Invite - } - if allowChange(plc.Kick, content.Kick(), actorLevel) { - changed = true - content.KickPtr = plc.Kick - } - if allowChange(plc.Ban, content.Ban(), actorLevel) { - changed = true - content.BanPtr = plc.Ban - } - if allowChange(plc.Redact, content.Redact(), actorLevel) { - changed = true - content.RedactPtr = plc.Redact - } - if plc.Custom != nil { - changed = plc.Custom(content) || changed - } - 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 - Avatar *Avatar - - Members *ChatMemberList - JoinRule *event.JoinRulesEventContent - - Type *database.RoomType - Disappear *database.DisappearingSetting - ParentID *networkid.PortalID - - UserLocal *UserLocalPortalInfo - MessageRequest *bool - CanBackfill bool - - ExcludeChangesFromTimeline bool - - ExtraUpdates ExtraUpdater[*Portal] -} - -type ExtraUpdater[T any] func(context.Context, T) bool - -func MergeExtraUpdaters[T any](funcs ...ExtraUpdater[T]) ExtraUpdater[T] { - funcs = slices.DeleteFunc(funcs, func(f ExtraUpdater[T]) bool { - return f == nil - }) - if len(funcs) == 0 { - return nil - } else if len(funcs) == 1 { - return funcs[0] - } - return func(ctx context.Context, p T) bool { - changed := false - for _, f := range funcs { - changed = f(ctx, p) || changed - } - return changed - } -} - -var Unmuted = time.Date(2024, 1, 1, 0, 0, 0, 0, time.UTC) - -type UserLocalPortalInfo struct { - // To signal an indefinite mute, use [event.MutedForever] as the value here. - // To unmute, set any time before now, e.g. [bridgev2.Unmuted]. - MutedUntil *time.Time - Tag *event.RoomTag -} - -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}, excludeFromTimeline, nil, - ) - return true -} - -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}, excludeFromTimeline, nil, - ) - return true -} - -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 - if sender == nil { - sender = portal.Bridge.Bot - } - if avatar.Remove { - portal.AvatarMXC = "" - portal.AvatarHash = [32]byte{} - } else { - newMXC, newHash, err := avatar.Reupload(ctx, sender, portal.AvatarHash, portal.AvatarMXC) - if err != nil { - portal.AvatarSet = false - zerolog.Ctx(ctx).Err(err).Msg("Failed to reupload room avatar") - return true - } 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}, excludeFromTimeline, nil, - ) - return true -} - -func (portal *Portal) GetTopLevelParent() *Portal { - if portal.Parent == nil { - if portal.RoomType != database.RoomTypeSpace { - return nil - } - return 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), - MessageRequest: portal.MessageRequest, - // TODO external URL? - }, - BeeperRoomTypeV2: string(portal.RoomType), - } - 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{ - ID: string(parent.ID), - DisplayName: parent.Name, - AvatarURL: parent.AvatarMXC, - // TODO external URL? - } - } - filler, ok := portal.Bridge.Network.(PortalBridgeInfoFillingNetwork) - if ok { - filler.FillPortalBridgeInfo(portal, &bridgeInfo) - } - return portal.getBridgeInfoStateKey(), bridgeInfo -} - -func (portal *Portal) UpdateBridgeInfo(ctx context.Context) { - if portal.MXID == "" { - return - } - stateKey, bridgeInfo := portal.getBridgeInfo() - 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) { - if sender == nil { - sender = portal.Bridge.Bot - } - resp, err = sender.SendState(ctx, portal.MXID, eventType, stateKey, content, ts) - if errors.Is(err, mautrix.MForbidden) && sender != portal.Bridge.Bot { - if content.Raw == nil { - content.Raw = make(map[string]any) - } - content.Raw["fi.mau.bridge.set_by"] = sender.GetMXID() - resp, err = portal.Bridge.Bot.SendState(ctx, portal.MXID, eventType, stateKey, content, ts) - } - return -} - -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 - } - 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["fi.mau.implicit_name"] = true - } - _, err := portal.sendStateWithIntentOrBot(ctx, sender, eventType, stateKey, &event.Content{ - Parsed: content, - Raw: extra, - }, ts) - if err != nil { - zerolog.Ctx(ctx).Err(err). - Str("event_type", eventType.Type). - 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} - return - } - var loginsInPortal []*UserLogin - if members.CheckAllLogins && !portal.Bridge.Config.SplitPortals { - loginsInPortal, err = portal.Bridge.GetUserLoginsInPortal(ctx, portal.PortalKey) - if err != nil { - err = fmt.Errorf("failed to get user logins in portal: %w", err) - return - } - } - 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 - } - if member.Sender != "" && member.UserInfo != nil { - ghost, err := portal.Bridge.GetGhostByID(ctx, member.Sender) - if err != nil { - zerolog.Ctx(ctx).Err(err).Str("ghost_id", string(member.Sender)).Msg("Failed to get ghost from member list to update info") - } else { - ghost.UpdateInfo(ctx, member.UserInfo) - } - } - 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 { - pl.EnsureUserLevel(extraUserID, *member.PowerLevel) - } - if intent != nil { - // If intent is present along with a user ID, it's the ghost of a logged-in user, - // so add it to the functional members list - functional = append(functional, intent.GetMXID()) - } - } - if intent != nil { - invite = append(invite, intent.GetMXID()) - if member.PowerLevel != nil { - pl.EnsureUserLevel(intent.GetMXID(), *member.PowerLevel) - } - } - } - portal.updateOtherUser(ctx, members) - return -} - -func (portal *Portal) updateOtherUser(ctx context.Context, members *ChatMemberList) (changed bool) { - members.memberListToMap(ctx) - var expectedUserID networkid.UserID - if portal.RoomType != database.RoomTypeDM { - // expected user ID is empty - } else if members.OtherUserID != "" { - expectedUserID = members.OtherUserID - } else if len(members.MemberMap) == 2 && members.IsFull { - vals := maps.Values(members.MemberMap) - if vals[0].IsFromMe && !vals[1].IsFromMe { - expectedUserID = vals[1].Sender - } else if vals[1].IsFromMe && !vals[0].IsFromMe { - expectedUserID = vals[0].Sender - } - } - if portal.OtherUserID != expectedUserID { - zerolog.Ctx(ctx).Debug(). - Str("old_other_user_id", string(portal.OtherUserID)). - Str("new_other_user_id", string(expectedUserID)). - Msg("Updating other user ID in DM portal") - portal.OtherUserID = expectedUserID - return true - } - return false -} - -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 - if members.CheckAllLogins && !portal.Bridge.Config.SplitPortals { - loginsInPortal, err = portal.Bridge.GetUserLoginsInPortal(ctx, portal.PortalKey) - if err != nil { - return fmt.Errorf("failed to get user logins in portal: %w", err) - } - } - if sender == nil { - sender = portal.Bridge.Bot - } - log := zerolog.Ctx(ctx) - currentPower, err := portal.Bridge.Matrix.GetPowerLevels(ctx, portal.MXID) - if err != nil { - return fmt.Errorf("failed to get current power levels: %w", err) - } - currentMembers, err := portal.Bridge.Matrix.GetMembers(ctx, portal.MXID) - if err != nil { - return fmt.Errorf("failed to get current members: %w", err) - } - delete(currentMembers, portal.Bridge.Bot.GetMXID()) - powerChanged := members.PowerLevels.Apply(portal.Bridge.Bot.GetMXID(), currentPower) - 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 - } - if member.PowerLevel != nil { - powerChanged = currentPower.EnsureUserLevelAs(portal.Bridge.Bot.GetMXID(), extraUserID, *member.PowerLevel) || powerChanged - } - currentMember, ok := currentMembers[extraUserID] - delete(currentMembers, extraUserID) - if ok && currentMember.Membership == member.Membership { - return false - } - if currentMember == nil { - currentMember = &event.MemberEventContent{Membership: event.MembershipLeave} - } - if member.PrevMembership != "" && member.PrevMembership != currentMember.Membership { - log.Trace(). - Stringer("user_id", extraUserID). - Str("expected_prev_membership", string(member.PrevMembership)). - Str("actual_prev_membership", string(currentMember.Membership)). - Str("target_membership", string(member.Membership)). - Msg("Not updating membership: prev membership mismatch") - return false - } - content := &event.MemberEventContent{ - Membership: member.Membership, - Displayname: currentMember.Displayname, - AvatarURL: currentMember.AvatarURL, - } - wrappedContent := &event.Content{Parsed: content, Raw: exmaps.NonNilClone(member.MemberEventExtra)} - addExcludeFromTimeline(wrappedContent.Raw) - thisEvtSender := sender - if member.Membership == event.MembershipJoin && (intent == nil || !portal.roomIsPublic(ctx)) { - content.Membership = event.MembershipInvite - 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 { - addLogContext(log.Err(err)). - Str("new_membership", string(unbanContent.Membership)). - Msg("Failed to unban user to update membership") - } else { - addLogContext(log.Trace()). - Str("new_membership", string(unbanContent.Membership)). - Msg("Unbanned user to update membership") - currentMember.Membership = event.MembershipLeave - } - } - 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 { - addLogContext(log.Err(err)). - Str("new_membership", string(content.Membership)). - Msg("Failed to update user membership") - } else { - 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, intent) { - return - } - if member.Membership == event.MembershipJoin || member.Membership == "" { - err = intent.EnsureJoined(ctx, portal.MXID) - if err != nil { - log.Err(err). - Stringer("user_id", intent.GetMXID()). - Msg("Failed to ensure user is joined to room") - } - } - } - 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 { - zerolog.Ctx(ctx).Err(err).Str("ghost_id", string(member.Sender)).Msg("Failed to get ghost from member list to update info") - } else { - ghost.UpdateInfo(ctx, member.UserInfo) - } - } - 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, nil) - } - } - if powerChanged { - _, err = portal.sendStateWithIntentOrBot(ctx, sender, event.StatePowerLevels, "", &event.Content{Parsed: currentPower}, ts) - if err != nil { - log.Err(err).Msg("Failed to update power levels") - } - } - portal.updateOtherUser(ctx, members) - if members.IsFull { - for extraMember, memberEvt := range currentMembers { - if memberEvt.Membership == event.MembershipLeave || memberEvt.Membership == event.MembershipBan { - continue - } - 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{ - Parsed: &event.MemberEventContent{ - Membership: event.MembershipLeave, - AvatarURL: memberEvt.AvatarURL, - 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). - Stringer("user_id", extraMember). - Msg("Failed to remove user from room") - } - } - } - return nil -} - -func (portal *Portal) updateUserLocalInfo(ctx context.Context, info *UserLocalPortalInfo, source *UserLogin, didJustCreate bool) { - if portal.MXID == "" { - return - } - dp := source.User.DoublePuppet(ctx) - if dp == nil { - return - } - dmMarkingMatrixAPI, canMarkDM := dp.(MarkAsDMMatrixAPI) - if canMarkDM && portal.OtherUserID != "" && portal.RoomType == database.RoomTypeDM { - dmGhost, err := portal.Bridge.GetGhostByID(ctx, portal.OtherUserID) - if err != nil { - zerolog.Ctx(ctx).Err(err).Msg("Failed to get DM ghost to mark room as DM") - } else if err = dmMarkingMatrixAPI.MarkAsDM(ctx, portal.MXID, dmGhost.Intent.GetMXID()); err != nil { - zerolog.Ctx(ctx).Err(err).Msg("Failed to mark room as DM") - } - } - if info == nil { - return - } - if info.MutedUntil != nil && (didJustCreate || !portal.Bridge.Config.MuteOnlyOnCreate) && (!didJustCreate || info.MutedUntil.After(time.Now())) { - err := dp.MuteRoom(ctx, portal.MXID, *info.MutedUntil) - if err != nil { - zerolog.Ctx(ctx).Err(err).Msg("Failed to mute room") - } - } - 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") - } - } -} - -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), - Mentions: &event.Mentions{}, - } - 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) - } - return content -} - -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 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") - } - } - if portal.MXID == "" { - return true - } - - if opts.Sender == nil { - opts.Sender = portal.Bridge.Bot - } - 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, - 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", opts.Implicit). - Msg("Sent disappearing messages notice") - } - return true -} - -func (portal *Portal) updateParent(ctx context.Context, newParentID networkid.PortalID, source *UserLogin) bool { - newParent := networkid.PortalKey{ID: newParentID} - if portal.Bridge.Config.SplitPortals { - newParent.Receiver = portal.Receiver - } - if portal.ParentKey == newParent { - return false - } - var err error - if portal.MXID != "" && portal.InSpace && portal.Parent != nil && portal.Parent.MXID != "" { - err = portal.toggleSpace(ctx, portal.Parent.MXID, false, true) - if err != nil { - zerolog.Ctx(ctx).Err(err).Stringer("old_space_mxid", portal.Parent.MXID).Msg("Failed to remove portal from old space") - } - } - portal.ParentKey = newParent - portal.InSpace = false - if newParent.ID != "" { - portal.Parent, err = portal.Bridge.GetPortalByKey(ctx, newParent) - if err != nil { - zerolog.Ctx(ctx).Err(err).Msg("Failed to get new parent portal") - } - } - if portal.MXID != "" && portal.Parent != nil && (source != nil || portal.Parent.MXID != "") { - if portal.Parent.MXID == "" { - zerolog.Ctx(ctx).Info().Msg("Parent portal doesn't exist, creating") - err = portal.Parent.CreateMatrixRoom(ctx, source, nil) - if err != nil { - zerolog.Ctx(ctx).Err(err).Msg("Failed to create parent portal") - } - } - if portal.Parent.MXID != "" { - portal.addToParentSpaceAndSave(ctx, false) - } - } - return true -} - -func (portal *Portal) lockedUpdateInfoFromGhost(ctx context.Context, ghost *Ghost) { - portal.roomCreateLock.Lock() - defer portal.roomCreateLock.Unlock() - portal.UpdateInfoFromGhost(ctx, ghost) -} - -func (portal *Portal) UpdateInfoFromGhost(ctx context.Context, ghost *Ghost) (changed bool) { - if portal.NameIsCustom || !portal.Bridge.Config.PrivateChatPortalMeta || (portal.OtherUserID == "" && ghost == nil) || portal.RoomType != database.RoomTypeDM { - return - } - var err error - if ghost == nil { - ghost, err = portal.Bridge.GetGhostByID(ctx, portal.OtherUserID) - if err != nil { - zerolog.Ctx(ctx).Err(err).Msg("Failed to get ghost to update info from") - return - } - } - 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{}, false) || changed - return -} - -func (portal *Portal) UpdateInfo(ctx context.Context, info *ChatInfo, source *UserLogin, sender MatrixAPI, ts time.Time) { - changed := false - 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, info.ExcludeChangesFromTimeline) || changed - } - if info.Topic != nil { - 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, info.ExcludeChangesFromTimeline) || changed - } - if info.Disappear != nil { - 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, info.ExcludeChangesFromTimeline, nil) - } - if info.Type != nil && portal.RoomType != *info.Type { - if portal.MXID != "" && (*info.Type == database.RoomTypeSpace || portal.RoomType == database.RoomTypeSpace) { - zerolog.Ctx(ctx).Warn(). - Str("current_type", string(portal.RoomType)). - Str("target_type", string(*info.Type)). - Msg("Tried to change existing room type from/to space") - } else { - changed = true - 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 { - zerolog.Ctx(ctx).Err(err).Msg("Failed to sync room members") - } - // TODO detect changes to functional members list? - } else if info.Members != nil { - portal.updateOtherUser(ctx, info.Members) - } - changed = portal.UpdateInfoFromGhost(ctx, nil) || changed - 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) - if err != nil { - zerolog.Ctx(ctx).Err(err).Msg("Failed to ensure backfill queue task exists") - } - // TODO wake up backfill queue if task was just created - } - if info.ExtraUpdates != nil { - changed = info.ExtraUpdates(ctx, portal) || changed - } - if changed { - portal.UpdateBridgeInfo(ctx) - err := portal.Save(ctx) - if err != nil { - zerolog.Ctx(ctx).Err(err).Msg("Failed to save portal to database after updating info") - } - } -} - -func (portal *Portal) CreateMatrixRoom(ctx context.Context, source *UserLogin, info *ChatInfo) (retErr error) { - if portal.MXID != "" { - if source != nil { - source.MarkInPortal(ctx, portal) - } - return nil - } - if portal.deleted.IsSet() { - return ErrPortalIsDeleted - } - waiter := make(chan struct{}) - closed := false - evt := &portalCreateEvent{ - ctx: ctx, - source: source, - info: info, - cb: func(err error) { - retErr = err - if !closed { - closed = true - close(waiter) - } - }, - } - 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() - case <-waiter: - return - } -} - -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 { - source.MarkInPortal(ctx, portal) - } - return nil - } - 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") - - var err error - if info == nil || info.Members == nil { - if info != nil { - log.Warn().Msg("CreateMatrixRoom got info without members. Refetching info") - } - 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(cancellableCtx, info, source, nil, time.Time{}) - if cancellableCtx.Err() != nil { - return cancellableCtx.Err() - } - - powerLevels := &event.PowerLevelsEventContent{ - Events: map[string]int{ - event.StateTombstone.Type: 100, - event.StateServerACL.Type: 100, - event.StateEncryption.Type: 100, - }, - Users: map[id.UserID]int{ - portal.Bridge.Bot.GetMXID(): 9001, - }, - } - 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 - } - powerLevels.EnsureUserLevel(portal.Bridge.Bot.GetMXID(), 9001) - - req := mautrix.ReqCreateRoom{ - Visibility: "private", - CreationContent: make(map[string]any), - InitialState: make([]*event.Event, 0, 6), - Preset: "private_chat", - IsDirect: portal.RoomType == database.RoomTypeDM, - PowerLevelOverride: powerLevels, - BeeperLocalRoomID: portal.Bridge.Matrix.GenerateDeterministicRoomID(portal.PortalKey), - } - autoJoinInvites := portal.Bridge.Matrix.GetCapabilities().AutoJoinInvites - if autoJoinInvites { - req.BeeperInitialMembers = initialMembers - // TODO remove this after initial_members is supported in hungryserv - req.BeeperAutoJoinInvites = true - req.Invite = initialMembers - } - if portal.RoomType == database.RoomTypeSpace { - 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, - Content: event.Content{Parsed: &event.ElementFunctionalMembersContent{ - ServiceMembers: append(extraFunctionalMembers, portal.Bridge.Bot.GetMXID()), - }}, - }, &event.Event{ - StateKey: &bridgeInfoStateKey, - Type: event.StateHalfShotBridge, - Content: event.Content{Parsed: &bridgeInfo}, - }, &event.Event{ - 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 roomFeatures.DisappearingTimer != nil { - req.InitialState = append(req.InitialState, &event.Event{ - 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}, - Raw: map[string]any{ - "com.beeper.exclude_from_timeline": true, - }, - }, - }) - } - if portal.Parent != nil && portal.Parent.MXID != "" { - req.InitialState = append(req.InitialState, &event.Event{ - StateKey: ptr.Ptr(portal.Parent.MXID.String()), - Type: event.StateSpaceParent, - Content: event.Content{Parsed: &event.SpaceParentEventContent{ - Via: []string{portal.Bridge.Matrix.ServerName()}, - Canonical: true, - }}, - }) - } - if info.JoinRule != nil { - req.InitialState = append(req.InitialState, &event.Event{ - Type: event.StateJoinRules, - 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") - return err - } - log.Info().Stringer("room_id", roomID).Msg("Matrix room created") - portal.AvatarSet = true - 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() - portal.updateLogger() - err = portal.Save(ctx) - if err != nil { - log.Err(err).Msg("Failed to save portal to database after creating Matrix room") - return err - } - if info.CanBackfill && portal.RoomType != database.RoomTypeSpace { - err = portal.Bridge.DB.BackfillTask.Upsert(ctx, &database.BackfillTask{ - PortalKey: portal.PortalKey, - UserLoginID: source.ID, - NextDispatchMinTS: time.Now().Add(BackfillMinBackoffAfterRoomCreate), - }) - if err != nil { - log.Err(err).Msg("Failed to create backfill queue task after creating room") - } - portal.Bridge.WakeupBackfillQueue() - } - withoutCancelCtx := zerolog.Ctx(ctx).WithContext(portal.Bridge.BackgroundCtx) - if portal.Parent != nil { - if portal.Parent.MXID != "" { - portal.addToParentSpaceAndSave(ctx, true) - } else { - log.Info().Msg("Parent portal doesn't exist, creating in background") - go portal.createParentAndAddToSpace(withoutCancelCtx, source) - } - } - portal.updateUserLocalInfo(ctx, info.UserLocal, source, true) - if !autoJoinInvites { - if info.Members == nil { - dp := source.User.DoublePuppet(ctx) - if dp != nil { - err = dp.EnsureJoined(ctx, portal.MXID) - if err != nil { - log.Err(err).Msg("Failed to ensure user is joined to room after creation") - } - } - } else { - err = portal.syncParticipants(ctx, info.Members, source, nil, time.Time{}) - if err != nil { - log.Err(err).Msg("Failed to sync participants after room creation") - } - } - } - 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.safeDBDelete(ctx) - if err != nil { - return err - } - portal.Bridge.cacheLock.Lock() - defer portal.Bridge.cacheLock.Unlock() - portal.unlockedDeleteCache() - 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 - } - portal.Bridge.cacheLock.Lock() - defer portal.Bridge.cacheLock.Unlock() - delete(portal.Bridge.portalsByMXID, portal.MXID) - return nil -} - -func (portal *Portal) removeInPortalCache(ctx context.Context) { - if portal.Receiver != "" { - login := portal.Bridge.GetCachedUserLoginByID(portal.Receiver) - if login != nil { - login.inPortalCache.Remove(portal.PortalKey) - } - return - } - userPortals, err := portal.Bridge.DB.UserPortal.GetAllInPortal(ctx, portal.PortalKey) - if err != nil { - zerolog.Ctx(ctx).Err(err).Msg("Failed to get user logins in portal to remove user portal cache") - } else { - for _, up := range userPortals { - login := portal.Bridge.GetCachedUserLoginByID(up.LoginID) - if login != nil { - login.inPortalCache.Remove(portal.PortalKey) - } - } - } -} - -func (portal *Portal) unlockedDelete(ctx context.Context) error { - if portal.deleted.IsSet() { - return nil - } - err := portal.safeDBDelete(ctx) - if err != nil { - return err - } - portal.unlockedDeleteCache() - return nil -} - -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 { - return portal.Bridge.DB.Portal.Update(ctx, portal.Portal) -} - -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 = "" - } else { - portal.RelayLoginID = relay.ID - } - err := portal.Save(ctx) - if err != nil { - return err - } - 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 deleted file mode 100644 index 879f07ae..00000000 --- a/bridgev2/portalbackfill.go +++ /dev/null @@ -1,584 +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 bridgev2 - -import ( - "context" - "fmt" - "slices" - "time" - - "github.com/rs/zerolog" - "go.mau.fi/util/ptr" - "go.mau.fi/util/variationselector" - - "maunium.net/go/mautrix" - "maunium.net/go/mautrix/bridgev2/database" - "maunium.net/go/mautrix/bridgev2/networkid" - "maunium.net/go/mautrix/event" - "maunium.net/go/mautrix/id" -) - -func (portal *Portal) doForwardBackfill(ctx context.Context, source *UserLogin, lastMessage *database.Message, bundledData any) { - log := zerolog.Ctx(ctx).With().Str("action", "forward backfill").Logger() - ctx = log.WithContext(ctx) - api, ok := source.Client.(BackfillingNetworkAPI) - if !ok { - log.Debug().Msg("Network API does not support backfilling") - return - } - logEvt := log.Info() - var limit int - if lastMessage != nil { - logEvt = logEvt.Str("latest_message_id", string(lastMessage.ID)) - limit = portal.Bridge.Config.Backfill.MaxCatchupMessages - } else { - logEvt = logEvt.Str("latest_message_id", "") - limit = portal.Bridge.Config.Backfill.MaxInitialMessages - } - if limit <= 0 { - logEvt.Discard().Send() - return - } - logEvt.Msg("Fetching messages for forward backfill") - resp, err := api.FetchMessages(ctx, FetchMessagesParams{ - Portal: portal, - ThreadRoot: "", - Forward: true, - AnchorMessage: lastMessage, - Count: limit, - BundledData: bundledData, - }) - if err != nil { - log.Err(err).Msg("Failed to fetch messages for forward backfill") - return - } else if resp == nil { - log.Debug().Msg("Didn't get backfill response") - return - } else if len(resp.Messages) == 0 { - log.Debug().Msg("No messages to backfill") - if resp.CompleteCallback != nil { - resp.CompleteCallback() - } - return - } - log.Debug(). - Int("message_count", len(resp.Messages)). - Bool("mark_read", resp.MarkRead). - Bool("aggressive_deduplication", resp.AggressiveDeduplication). - Msg("Fetched messages for forward backfill, deduplicating before sending") - // TODO mark backfill queue task as done if last message is nil (-> room was empty) and HasMore is false? - resp.Messages = portal.cutoffMessages(ctx, resp.Messages, resp.AggressiveDeduplication, true, lastMessage) - if len(resp.Messages) == 0 { - log.Warn().Msg("No messages left to backfill after cutting off old messages") - if resp.CompleteCallback != nil { - resp.CompleteCallback() - } - return - } - portal.sendBackfill(ctx, source, resp.Messages, true, resp.MarkRead, false, resp.CompleteCallback) -} - -func (portal *Portal) DoBackwardsBackfill(ctx context.Context, source *UserLogin, task *database.BackfillTask) error { - log := zerolog.Ctx(ctx) - api, ok := source.Client.(BackfillingNetworkAPI) - if !ok { - return fmt.Errorf("network API does not support backfilling") - } - firstMessage, err := portal.Bridge.DB.Message.GetFirstPortalMessage(ctx, portal.PortalKey) - if err != nil { - return fmt.Errorf("failed to get first portal message: %w", err) - } - logEvt := log.Info(). - Str("cursor", string(task.Cursor)). - Str("task_oldest_message_id", string(task.OldestMessageID)). - Int("current_batch_count", task.BatchCount) - if firstMessage != nil { - logEvt = logEvt.Str("db_oldest_message_id", string(firstMessage.ID)) - } else { - logEvt = logEvt.Str("db_oldest_message_id", "") - } - logEvt.Msg("Fetching messages for backward backfill") - resp, err := api.FetchMessages(ctx, FetchMessagesParams{ - Portal: portal, - ThreadRoot: "", - Forward: false, - Cursor: task.Cursor, - AnchorMessage: firstMessage, - Count: portal.Bridge.Config.Backfill.Queue.BatchSize, - Task: task, - }) - if err != nil { - return fmt.Errorf("failed to fetch messages for backward backfill: %w", err) - } else if resp == nil { - log.Debug().Msg("Didn't get backfill response, marking task as done") - task.IsDone = true - return nil - } - log.Debug(). - Str("new_cursor", string(resp.Cursor)). - Bool("has_more", resp.HasMore). - Int("message_count", len(resp.Messages)). - Msg("Fetched messages for backward backfill") - task.Cursor = resp.Cursor - if !resp.HasMore { - task.IsDone = true - } - if len(resp.Messages) == 0 { - if !resp.HasMore { - log.Debug().Msg("No messages to backfill, marking backfill task as done") - } else { - log.Warn().Msg("No messages to backfill, but HasMore is true") - } - if resp.CompleteCallback != nil { - resp.CompleteCallback() - } - return nil - } - resp.Messages = portal.cutoffMessages(ctx, resp.Messages, resp.AggressiveDeduplication, false, firstMessage) - if len(resp.Messages) == 0 { - if resp.CompleteCallback != nil { - resp.CompleteCallback() - } - return fmt.Errorf("no messages left to backfill after cutting off too new messages") - } - portal.sendBackfill(ctx, source, resp.Messages, false, resp.MarkRead, false, resp.CompleteCallback) - if len(resp.Messages) > 0 { - task.OldestMessageID = resp.Messages[0].ID - } - return nil -} - -func (portal *Portal) fetchThreadBackfill(ctx context.Context, source *UserLogin, anchor *database.Message) *FetchMessagesResponse { - log := zerolog.Ctx(ctx) - resp, err := source.Client.(BackfillingNetworkAPI).FetchMessages(ctx, FetchMessagesParams{ - Portal: portal, - ThreadRoot: anchor.ID, - Forward: true, - AnchorMessage: anchor, - Count: portal.Bridge.Config.Backfill.Threads.MaxInitialMessages, - }) - if err != nil { - log.Err(err).Msg("Failed to fetch messages for thread backfill") - return nil - } else if resp == nil { - log.Debug().Msg("Didn't get backfill response") - return nil - } else if len(resp.Messages) == 0 { - log.Debug().Msg("No messages to backfill") - return nil - } - resp.Messages = portal.cutoffMessages(ctx, resp.Messages, resp.AggressiveDeduplication, true, anchor) - if len(resp.Messages) == 0 { - log.Warn().Msg("No messages left to backfill after cutting off old messages") - if resp.CompleteCallback != nil { - resp.CompleteCallback() - } - return nil - } - return resp -} - -func (portal *Portal) doThreadBackfill(ctx context.Context, source *UserLogin, threadID networkid.MessageID) { - log := zerolog.Ctx(ctx).With(). - Str("subaction", "thread backfill"). - Str("thread_id", string(threadID)). - Logger() - ctx = log.WithContext(ctx) - log.Info().Msg("Backfilling thread inside other backfill") - anchorMessage, err := portal.Bridge.DB.Message.GetLastThreadMessage(ctx, portal.PortalKey, threadID) - 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 { - portal.sendBackfill(ctx, source, resp.Messages, true, resp.MarkRead, true, resp.CompleteCallback) - } -} - -func (portal *Portal) cutoffMessages(ctx context.Context, messages []*BackfillMessage, aggressiveDedup, forward bool, lastMessage *database.Message) []*BackfillMessage { - if lastMessage == nil { - return messages - } - if forward { - cutoff := -1 - for i, msg := range messages { - if msg.ID == lastMessage.ID || msg.Timestamp.Before(lastMessage.Timestamp) { - cutoff = i - } else { - break - } - } - if cutoff != -1 { - zerolog.Ctx(ctx).Debug(). - Int("cutoff_count", cutoff+1). - Int("total_count", len(messages)). - Time("last_bridged_ts", lastMessage.Timestamp). - Msg("Cutting off forward backfill messages older than latest bridged message") - messages = messages[cutoff+1:] - } - } else { - cutoff := -1 - for i := len(messages) - 1; i >= 0; i-- { - if messages[i].ID == lastMessage.ID || messages[i].Timestamp.After(lastMessage.Timestamp) { - cutoff = i - } else { - break - } - } - if cutoff != -1 { - zerolog.Ctx(ctx).Debug(). - Int("cutoff_count", len(messages)-cutoff). - Int("total_count", len(messages)). - Time("oldest_bridged_ts", lastMessage.Timestamp). - Msg("Cutting off backward backfill messages newer than oldest bridged message") - messages = messages[:cutoff] - } - } - if aggressiveDedup { - filteredMessages := messages[:0] - for _, msg := range messages { - existingMsg, err := portal.Bridge.DB.Message.GetFirstPartByID(ctx, portal.Receiver, msg.ID) - if err != nil { - zerolog.Ctx(ctx).Err(err).Str("message_id", string(msg.ID)).Msg("Failed to check for existing message") - } else if existingMsg != nil { - zerolog.Ctx(ctx).Err(err). - Str("message_id", string(msg.ID)). - Time("message_ts", msg.Timestamp). - Str("message_sender", string(msg.Sender.Sender)). - Msg("Ignoring duplicate message in backfill") - continue - } - if forward && msg.TxnID != "" { - wasPending, _ := portal.checkPendingMessage(ctx, msg) - if wasPending { - zerolog.Ctx(ctx).Err(err). - Str("transaction_id", string(msg.TxnID)). - Str("message_id", string(msg.ID)). - Time("message_ts", msg.Timestamp). - Msg("Found pending message in backfill") - continue - } - } - filteredMessages = append(filteredMessages, msg) - } - messages = filteredMessages - } - return messages -} - -func (portal *Portal) sendBackfill( - ctx context.Context, - source *UserLogin, - messages []*BackfillMessage, - forceForward, - markRead, - inThread bool, - done func(), -) { - canBatchSend := portal.Bridge.Matrix.GetCapabilities().BatchSending - unreadThreshold := time.Duration(portal.Bridge.Config.Backfill.UnreadHoursThreshold) * time.Hour - forceMarkRead := unreadThreshold > 0 && time.Since(messages[len(messages)-1].Timestamp) > unreadThreshold - zerolog.Ctx(ctx).Info(). - Int("message_count", len(messages)). - Bool("batch_send", canBatchSend). - Bool("mark_read", markRead). - Bool("mark_read_past_threshold", forceMarkRead). - Msg("Sending backfill messages") - if canBatchSend { - portal.sendBatch(ctx, source, messages, forceForward, markRead || forceMarkRead, inThread) - } else { - portal.sendLegacyBackfill(ctx, source, messages, markRead || forceMarkRead) - } - if done != nil { - done() - } - zerolog.Ctx(ctx).Debug().Msg("Backfill finished") - if !canBatchSend && !inThread && portal.Bridge.Config.Backfill.Threads.MaxInitialMessages > 0 { - for _, msg := range messages { - if msg.ShouldBackfillThread { - portal.doThreadBackfill(ctx, source, msg.ID) - } - } - } -} - -type compileBatchOutput struct { - PrevThreadEvents map[networkid.MessageID]id.EventID - - Events []*event.Event - Extras []*MatrixSendExtra - - DBMessages []*database.Message - DBReactions []*database.Reaction - Disappear []*database.DisappearingMessage -} - -func (portal *Portal) compileBatchMessage(ctx context.Context, source *UserLogin, msg *BackfillMessage, out *compileBatchOutput, inThread bool) { - if len(msg.Parts) == 0 { - return - } - 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] - } - var partIDs []networkid.PartID - partMap := make(map[networkid.PartID]*database.Message, len(msg.Parts)) - var firstPart *database.Message - for i, part := range msg.Parts { - partIDs = append(partIDs, part.ID) - 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, - IsDoublePuppeted: intent.IsDoublePuppet(), - } - if part.DontBridge { - dbMessage.SetFakeMXID() - out.DBMessages = append(out.DBMessages, dbMessage) - continue - } - out.Events = append(out.Events, &event.Event{ - Sender: intent.GetMXID(), - Type: part.Type, - Timestamp: msg.Timestamp.UnixMilli(), - ID: evtID, - RoomID: portal.MXID, - Content: event.Content{ - Parsed: part.Content, - Raw: part.Extra, - }, - }) - if firstPart == nil { - firstPart = dbMessage - } - partMap[part.ID] = dbMessage - out.Extras = append(out.Extras, &MatrixSendExtra{MessageMeta: dbMessage, StreamOrder: msg.StreamOrder, PartIndex: i}) - out.DBMessages = append(out.DBMessages, dbMessage) - if prevThreadEvent != nil { - prevThreadEvent.MXID = evtID - out.PrevThreadEvents[*msg.ThreadRoot] = evtID - } - 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 { - 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? - } - reactionMXID := portal.Bridge.Matrix.GenerateReactionEventID(portal.MXID, targetPart, reaction.Sender.Sender, reaction.EmojiID) - dbReaction := &database.Reaction{ - Room: portal.PortalKey, - MessageID: msg.ID, - MessagePartID: *reaction.TargetPart, - SenderID: reaction.Sender.Sender, - EmojiID: reaction.EmojiID, - MXID: reactionMXID, - Timestamp: reaction.Timestamp, - Emoji: reaction.Emoji, - Metadata: reaction.DBMetadata, - } - out.Events = append(out.Events, &event.Event{ - Sender: reactionIntent.GetMXID(), - Type: event.EventReaction, - Timestamp: reaction.Timestamp.UnixMilli(), - ID: reactionMXID, - RoomID: portal.MXID, - Content: event.Content{ - Parsed: &event.ReactionEventContent{ - RelatesTo: event.RelatesTo{ - Type: event.RelAnnotation, - EventID: portal.Bridge.Matrix.GenerateDeterministicEventID(portal.MXID, portal.PortalKey, msg.ID, *reaction.TargetPart), - Key: variationselector.Add(reaction.Emoji), - }, - }, - Raw: reaction.ExtraContent, - }, - }) - out.DBReactions = append(out.DBReactions, dbReaction) - out.Extras = append(out.Extras, &MatrixSendExtra{ReactionMeta: dbReaction}) - } - if firstPart != nil && !inThread && portal.Bridge.Config.Backfill.Threads.MaxInitialMessages > 0 && msg.ShouldBackfillThread { - portal.fetchThreadInsideBatch(ctx, source, firstPart, out) - } -} - -func (portal *Portal) fetchThreadInsideBatch(ctx context.Context, source *UserLogin, dbMsg *database.Message, out *compileBatchOutput) { - log := zerolog.Ctx(ctx).With(). - Str("subaction", "thread backfill in batch"). - Str("thread_id", string(dbMsg.ID)). - Logger() - ctx = log.WithContext(ctx) - resp := portal.fetchThreadBackfill(ctx, source, dbMsg) - if resp != nil { - for _, msg := range resp.Messages { - portal.compileBatchMessage(ctx, source, msg, out, true) - } - } -} - -func (portal *Portal) sendBatch(ctx context.Context, source *UserLogin, messages []*BackfillMessage, forceForward, markRead, inThread bool) { - out := &compileBatchOutput{ - PrevThreadEvents: make(map[networkid.MessageID]id.EventID), - Events: make([]*event.Event, 0, len(messages)), - Extras: make([]*MatrixSendExtra, 0, len(messages)), - DBMessages: make([]*database.Message, 0, len(messages)), - DBReactions: make([]*database.Reaction, 0), - Disappear: make([]*database.DisappearingMessage, 0), - } - for _, msg := range messages { - portal.compileBatchMessage(ctx, source, msg, out, inThread) - } - req := &mautrix.ReqBeeperBatchSend{ - ForwardIfNoMessages: !forceForward, - Forward: forceForward, - SendNotification: !markRead && forceForward && !inThread, - Events: out.Events, - } - if markRead { - req.MarkReadBy = source.UserMXID - } - _, err := portal.Bridge.Matrix.BatchSend(ctx, portal.MXID, req, out.Extras) - if err != nil { - zerolog.Ctx(ctx).Err(err).Msg("Failed to send backfill messages") - } - if len(out.Disappear) > 0 { - // TODO mass insert disappearing messages - go func() { - for _, msg := range out.Disappear { - portal.Bridge.DisappearLoop.Add(ctx, msg) - } - }() - } - // TODO mass insert db messages - for _, msg := range out.DBMessages { - err = portal.Bridge.DB.Message.Insert(ctx, msg) - if err != nil { - zerolog.Ctx(ctx).Err(err). - Str("message_id", string(msg.ID)). - Str("part_id", string(msg.PartID)). - Str("sender_id", string(msg.SenderID)). - Str("portal_id", string(msg.Room.ID)). - Str("portal_receiver", string(msg.Room.Receiver)). - Msg("Failed to insert backfilled message to database") - } - } - // TODO mass insert db reactions - for _, react := range out.DBReactions { - err = portal.Bridge.DB.Reaction.Upsert(ctx, react) - if err != nil { - zerolog.Ctx(ctx).Err(err). - Str("message_id", string(react.MessageID)). - Str("part_id", string(react.MessagePartID)). - Str("sender_id", string(react.SenderID)). - Str("portal_id", string(react.Room.ID)). - Str("portal_receiver", string(react.Room.Receiver)). - Msg("Failed to insert backfilled reaction to database") - } - } -} - -func (portal *Portal) sendLegacyBackfill(ctx context.Context, source *UserLogin, messages []*BackfillMessage, markRead bool) { - var lastPart id.EventID - for _, msg := range messages { - 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). - Time("message_ts", msg.Timestamp) - }) - if len(dbMessages) > 0 { - lastPart = dbMessages[len(dbMessages)-1].MXID - for _, reaction := range msg.Reactions { - 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 { - return dbMsg.PartID == *reaction.TargetPart - }) - if targetPartIdx != -1 { - targetPart = dbMessages[targetPartIdx] - } else { - // TODO warning log and/or skip reaction? - } - } - portal.sendConvertedReaction( - ctx, reaction.Sender.Sender, reactionIntent, targetPart, reaction.EmojiID, reaction.Emoji, - reaction.Timestamp, reaction.DBMetadata, reaction.ExtraContent, - func(z *zerolog.Event) *zerolog.Event { - return z. - Str("target_message_id", string(msg.ID)). - Str("target_part_id", string(targetPart.PartID)). - Any("reaction_sender_id", reaction.Sender). - Time("reaction_ts", reaction.Timestamp) - }, - ) - } - } - } - if markRead { - dp := source.User.DoublePuppet(ctx) - if dp != nil { - err := dp.MarkRead(ctx, portal.MXID, lastPart, time.Now()) - if err != nil { - zerolog.Ctx(ctx).Err(err).Msg("Failed to mark room as read after backfill") - } - } - } -} diff --git a/bridgev2/portalinternal.go b/bridgev2/portalinternal.go deleted file mode 100644 index 4c7e2447..00000000 --- a/bridgev2/portalinternal.go +++ /dev/null @@ -1,402 +0,0 @@ -// GENERATED BY portalinternal_generate.go; DO NOT EDIT - -//go:generate go run portalinternal_generate.go -//go:generate goimports -local maunium.net/go/mautrix -w portalinternal.go - -package bridgev2 - -import ( - "context" - "time" - - "github.com/rs/zerolog" - - "maunium.net/go/mautrix" - "maunium.net/go/mautrix/bridgev2/database" - "maunium.net/go/mautrix/bridgev2/networkid" - "maunium.net/go/mautrix/event" - "maunium.net/go/mautrix/id" -) - -type PortalInternals Portal - -// Deprecated: portal internals should be used carefully and only when necessary. -func (portal *Portal) Internal() *PortalInternals { - return (*PortalInternals)(portal) -} - -func (portal *PortalInternals) UpdateLogger() { - (*Portal)(portal).updateLogger() -} - -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) 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(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) -} - -func (portal *PortalInternals) SendErrorStatus(ctx context.Context, evt *event.Event, err error) { - (*Portal)(portal).sendErrorStatus(ctx, evt, err) -} - -func (portal *PortalInternals) CheckConfusableName(ctx context.Context, userID id.UserID, name string) bool { - return (*Portal)(portal).checkConfusableName(ctx, userID, name) -} - -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) 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) 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) { - (*Portal)(portal).sendTypings(ctx, userIDs, typing) -} - -func (portal *PortalInternals) PeriodicTypingUpdater() { - (*Portal)(portal).periodicTypingUpdater() -} - -func (portal *PortalInternals) CheckMessageContentCaps(caps *event.RoomFeatures, content *event.MessageEventContent) error { - return (*Portal)(portal).checkMessageContentCaps(caps, content) -} - -func (portal *PortalInternals) ParseInputTransactionID(origSender *OrigSender, evt *event.Event) networkid.RawTransactionID { - return (*Portal)(portal).parseInputTransactionID(origSender, evt) -} - -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) 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) HandleMatrixDeleteChat(ctx context.Context, sender *UserLogin, origSender *OrigSender, evt *event.Event) EventHandlingResult { - return (*Portal)(portal).handleMatrixDeleteChat(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) 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) HandleMatrixTombstone(ctx context.Context, evt *event.Event) EventHandlingResult { - return (*Portal)(portal).handleMatrixTombstone(ctx, evt) -} - -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, currentMsgID networkid.MessageID, currentMsg *ConvertedMessage, isBatchSend bool) (replyTo, threadRoot, prevThreadEvent *database.Message) { - return (*Portal)(portal).getRelationMeta(ctx, currentMsgID, currentMsg, isBatchSend) -} - -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, EventHandlingResult) { - return (*Portal)(portal).sendConvertedMessage(ctx, id, intent, senderID, converted, ts, streamOrder, logContext) -} - -func (portal *PortalInternals) CheckPendingMessage(ctx context.Context, evt RemoteMessage) (bool, *database.Message) { - return (*Portal)(portal).checkPendingMessage(ctx, evt) -} - -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) (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) 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) EventHandlingResult { - return (*Portal)(portal).sendConvertedEdit(ctx, targetID, senderID, converted, intent, ts, streamOrder) -} - -func (portal *PortalInternals) GetTargetMessagePart(ctx context.Context, evt RemoteEventWithTargetMessage) (*database.Message, error) { - return (*Portal)(portal).getTargetMessagePart(ctx, evt) -} - -func (portal *PortalInternals) GetTargetReaction(ctx context.Context, evt RemoteReactionRemove) (*database.Reaction, error) { - return (*Portal)(portal).getTargetReaction(ctx, 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) 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) 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) EventHandlingResult { - return (*Portal)(portal).handleRemoteReactionRemove(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) EventHandlingResult { - return (*Portal)(portal).redactMessageParts(ctx, parts, intent, ts) -} - -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) EventHandlingResult { - return (*Portal)(portal).handleRemoteMarkUnread(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) EventHandlingResult { - return (*Portal)(portal).handleRemoteTyping(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) EventHandlingResult { - return (*Portal)(portal).handleRemoteChatResync(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) HandleRemoteChatDelete(ctx context.Context, source *UserLogin, evt RemoteChatDelete) EventHandlingResult { - return (*Portal)(portal).handleRemoteChatDelete(ctx, source, evt) -} - -func (portal *PortalInternals) HandleRemoteBackfill(ctx context.Context, source *UserLogin, backfill RemoteBackfill) (res EventHandlingResult) { - return (*Portal)(portal).handleRemoteBackfill(ctx, source, backfill) -} - -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) 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) { - return (*Portal)(portal).getBridgeInfo() -} - -func (portal *PortalInternals) SendStateWithIntentOrBot(ctx context.Context, sender MatrixAPI, eventType event.Type, stateKey string, content *event.Content, ts time.Time) (resp *mautrix.RespSendEvent, err error) { - 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, 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) { - return (*Portal)(portal).getInitialMemberList(ctx, members, source, pl) -} - -func (portal *PortalInternals) UpdateOtherUser(ctx context.Context, members *ChatMemberList) (changed bool) { - 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) -} - -func (portal *PortalInternals) UpdateUserLocalInfo(ctx context.Context, info *UserLocalPortalInfo, source *UserLogin, didJustCreate bool) { - (*Portal)(portal).updateUserLocalInfo(ctx, info, source, didJustCreate) -} - -func (portal *PortalInternals) UpdateParent(ctx context.Context, newParentID networkid.PortalID, source *UserLogin) bool { - return (*Portal)(portal).updateParent(ctx, newParentID, source) -} - -func (portal *PortalInternals) LockedUpdateInfoFromGhost(ctx context.Context, ghost *Ghost) { - (*Portal)(portal).lockedUpdateInfoFromGhost(ctx, ghost) -} - -func (portal *PortalInternals) CreateMatrixRoomInLoop(ctx context.Context, source *UserLogin, info *ChatInfo, backfillBundle any) error { - 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) -} - -func (portal *PortalInternals) UnlockedDelete(ctx context.Context) error { - return (*Portal)(portal).unlockedDelete(ctx) -} - -func (portal *PortalInternals) UnlockedDeleteCache() { - (*Portal)(portal).unlockedDeleteCache() -} - -func (portal *PortalInternals) DoForwardBackfill(ctx context.Context, source *UserLogin, lastMessage *database.Message, bundledData any) { - (*Portal)(portal).doForwardBackfill(ctx, source, lastMessage, bundledData) -} - -func (portal *PortalInternals) FetchThreadBackfill(ctx context.Context, source *UserLogin, anchor *database.Message) *FetchMessagesResponse { - return (*Portal)(portal).fetchThreadBackfill(ctx, source, anchor) -} - -func (portal *PortalInternals) DoThreadBackfill(ctx context.Context, source *UserLogin, threadID networkid.MessageID) { - (*Portal)(portal).doThreadBackfill(ctx, source, threadID) -} - -func (portal *PortalInternals) CutoffMessages(ctx context.Context, messages []*BackfillMessage, aggressiveDedup, forward bool, lastMessage *database.Message) []*BackfillMessage { - return (*Portal)(portal).cutoffMessages(ctx, messages, aggressiveDedup, forward, lastMessage) -} - -func (portal *PortalInternals) SendBackfill(ctx context.Context, source *UserLogin, messages []*BackfillMessage, forceForward, markRead, inThread bool, done func()) { - (*Portal)(portal).sendBackfill(ctx, source, messages, forceForward, markRead, inThread, done) -} - -func (portal *PortalInternals) CompileBatchMessage(ctx context.Context, source *UserLogin, msg *BackfillMessage, out *compileBatchOutput, inThread bool) { - (*Portal)(portal).compileBatchMessage(ctx, source, msg, out, inThread) -} - -func (portal *PortalInternals) FetchThreadInsideBatch(ctx context.Context, source *UserLogin, dbMsg *database.Message, out *compileBatchOutput) { - (*Portal)(portal).fetchThreadInsideBatch(ctx, source, dbMsg, out) -} - -func (portal *PortalInternals) SendBatch(ctx context.Context, source *UserLogin, messages []*BackfillMessage, forceForward, markRead, inThread bool) { - (*Portal)(portal).sendBatch(ctx, source, messages, forceForward, markRead, inThread) -} - -func (portal *PortalInternals) SendLegacyBackfill(ctx context.Context, source *UserLogin, messages []*BackfillMessage, markRead bool) { - (*Portal)(portal).sendLegacyBackfill(ctx, source, messages, markRead) -} - -func (portal *PortalInternals) UnlockedReID(ctx context.Context, target networkid.PortalKey) error { - return (*Portal)(portal).unlockedReID(ctx, target) -} - -func (portal *PortalInternals) CreateParentAndAddToSpace(ctx context.Context, source *UserLogin) { - (*Portal)(portal).createParentAndAddToSpace(ctx, source) -} - -func (portal *PortalInternals) AddToParentSpaceAndSave(ctx context.Context, save bool) { - (*Portal)(portal).addToParentSpaceAndSave(ctx, save) -} - -func (portal *PortalInternals) ToggleSpace(ctx context.Context, spaceID id.RoomID, canonical, remove bool) error { - return (*Portal)(portal).toggleSpace(ctx, spaceID, canonical, remove) -} diff --git a/bridgev2/portalinternal_generate.go b/bridgev2/portalinternal_generate.go deleted file mode 100644 index 2ac6c898..00000000 --- a/bridgev2/portalinternal_generate.go +++ /dev/null @@ -1,173 +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/. - -//go:build ignore - -package main - -import ( - "fmt" - "go/ast" - "go/parser" - "go/token" - "os" - "strings" - - "go.mau.fi/util/exerrors" -) - -const header = `// GENERATED BY portalinternal_generate.go; DO NOT EDIT - -//go:generate go run portalinternal_generate.go -//go:generate goimports -local maunium.net/go/mautrix -w portalinternal.go - -package bridgev2 - -` -const postImportHeader = ` -type PortalInternals Portal - -// Deprecated: portal internals should be used carefully and only when necessary. -func (portal *Portal) Internal() *PortalInternals { - return (*PortalInternals)(portal) -} -` - -func getTypeName(expr ast.Expr) string { - switch e := expr.(type) { - case *ast.Ident: - return e.Name - case *ast.StarExpr: - return "*" + getTypeName(e.X) - case *ast.ArrayType: - return "[]" + getTypeName(e.Elt) - case *ast.MapType: - return fmt.Sprintf("map[%s]%s", getTypeName(e.Key), getTypeName(e.Value)) - case *ast.ChanType: - return fmt.Sprintf("chan %s", getTypeName(e.Value)) - case *ast.FuncType: - var params []string - for _, param := range e.Params.List { - params = append(params, getTypeName(param.Type)) - } - var results []string - if e.Results != nil { - for _, result := range e.Results.List { - results = append(results, getTypeName(result.Type)) - } - } - return fmt.Sprintf("func(%s) %s", strings.Join(params, ", "), strings.Join(results, ", ")) - case *ast.SelectorExpr: - return fmt.Sprintf("%s.%s", getTypeName(e.X), e.Sel.Name) - default: - panic(fmt.Errorf("unknown type %T", e)) - } -} - -var write func(str string) -var writef func(format string, args ...any) - -func main() { - fset := token.NewFileSet() - fileNames := []string{"portal.go", "portalbackfill.go", "portalreid.go", "space.go", "matrixinvite.go"} - files := make([]*ast.File, len(fileNames)) - for i, name := range fileNames { - files[i] = exerrors.Must(parser.ParseFile(fset, name, nil, parser.SkipObjectResolution)) - } - file := exerrors.Must(os.OpenFile("portalinternal.go", os.O_CREATE|os.O_WRONLY|os.O_TRUNC, 0644)) - write = func(str string) { - exerrors.Must(file.WriteString(str)) - } - writef = func(format string, args ...any) { - exerrors.Must(fmt.Fprintf(file, format, args...)) - } - write(header) - write("import (\n") - for _, i := range files[0].Imports { - write("\t") - if i.Name != nil { - writef("%s ", i.Name.Name) - } - writef("%s\n", i.Path.Value) - } - write(")\n") - write(postImportHeader) - for _, f := range files { - processFile(f) - } - exerrors.PanicIfNotNil(file.Close()) -} - -func processFile(f *ast.File) { - ast.Inspect(f, func(node ast.Node) (retVal bool) { - retVal = true - funcDecl, ok := node.(*ast.FuncDecl) - if !ok || funcDecl.Name.IsExported() { - return - } - if funcDecl.Recv == nil || len(funcDecl.Recv.List) == 0 || len(funcDecl.Recv.List[0].Names) == 0 || - funcDecl.Recv.List[0].Names[0].Name != "portal" { - return - } - writef("\nfunc (portal *PortalInternals) %s%s(", strings.ToUpper(funcDecl.Name.Name[0:1]), funcDecl.Name.Name[1:]) - for i, param := range funcDecl.Type.Params.List { - if i != 0 { - write(", ") - } - for j, name := range param.Names { - if j != 0 { - write(", ") - } - write(name.Name) - } - if len(param.Names) > 0 { - write(" ") - } - write(getTypeName(param.Type)) - } - write(") ") - if funcDecl.Type.Results != nil && len(funcDecl.Type.Results.List) > 0 { - needsParentheses := len(funcDecl.Type.Results.List) > 1 || len(funcDecl.Type.Results.List[0].Names) > 0 - if needsParentheses { - write("(") - } - for i, result := range funcDecl.Type.Results.List { - if i != 0 { - write(", ") - } - for j, name := range result.Names { - if j != 0 { - write(", ") - } - write(name.Name) - } - if len(result.Names) > 0 { - write(" ") - } - write(getTypeName(result.Type)) - } - if needsParentheses { - write(")") - } - write(" ") - } - write("{\n\t") - if funcDecl.Type.Results != nil { - write("return ") - } - writef("(*Portal)(portal).%s(", funcDecl.Name.Name) - for i, param := range funcDecl.Type.Params.List { - for j, name := range param.Names { - if i != 0 || j != 0 { - write(", ") - } - write(name.Name) - } - } - write(")\n}\n") - return - }) -} diff --git a/bridgev2/portalreid.go b/bridgev2/portalreid.go deleted file mode 100644 index c976d97c..00000000 --- a/bridgev2/portalreid.go +++ /dev/null @@ -1,161 +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 bridgev2 - -import ( - "context" - "fmt" - "time" - - "github.com/rs/zerolog" - - "maunium.net/go/mautrix/bridgev2/networkid" - "maunium.net/go/mautrix/event" -) - -type ReIDResult int - -const ( - ReIDResultError ReIDResult = iota - ReIDResultNoOp - ReIDResultSourceDeleted - ReIDResultSourceReIDd - ReIDResultTargetDeletedAndSourceReIDd - ReIDResultSourceTombstonedIntoTarget -) - -func (br *Bridge) ReIDPortal(ctx context.Context, source, target networkid.PortalKey) (ReIDResult, *Portal, error) { - if source == target { - return ReIDResultError, nil, fmt.Errorf("illegal re-ID call: source and target are the same") - } - 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") - }() - 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 - } - 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") - err = sourcePortal.unlockedDelete(ctx) - if err != nil { - return ReIDResultError, nil, fmt.Errorf("failed to delete source portal: %w", err) - } - return ReIDResultSourceDeleted, nil, nil - } - 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 - } - 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) - } - err = sourcePortal.unlockedReID(ctx, target) - if err != nil { - return ReIDResultError, nil, fmt.Errorf("failed to re-ID source portal after deleting target: %w", err) - } - return ReIDResultTargetDeletedAndSourceReIDd, sourcePortal, nil - } else { - log.UpdateContext(func(c zerolog.Context) zerolog.Context { - 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) - } - go func() { - _, err := br.Bot.SendState(ctx, sourcePortal.MXID, event.StateTombstone, "", &event.Content{ - Parsed: &event.TombstoneEventContent{ - Body: "This room has been merged", - ReplacementRoom: targetPortal.MXID, - }, - }, time.Now()) - if err != nil { - log.Err(err).Msg("Failed to send tombstone to source portal room") - } - err = br.Bot.DeleteRoom(ctx, sourcePortal.MXID, err == nil) - if err != nil { - log.Err(err).Msg("Failed to delete source portal room") - } - }() - return ReIDResultSourceTombstonedIntoTarget, targetPortal, nil - } -} - -func (portal *Portal) unlockedReID(ctx context.Context, target networkid.PortalKey) error { - err := portal.Bridge.DB.Portal.ReID(ctx, portal.PortalKey, target) - if err != nil { - return err - } - delete(portal.Bridge.portalsByKey, portal.PortalKey) - portal.Bridge.portalsByKey[target] = portal - portal.PortalKey = target - return nil -} diff --git a/bridgev2/provisionutil/creategroup.go b/bridgev2/provisionutil/creategroup.go deleted file mode 100644 index 72bacaff..00000000 --- a/bridgev2/provisionutil/creategroup.go +++ /dev/null @@ -1,149 +0,0 @@ -// 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 deleted file mode 100644 index ce163e67..00000000 --- a/bridgev2/provisionutil/listcontacts.go +++ /dev/null @@ -1,98 +0,0 @@ -// 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 deleted file mode 100644 index cfc388d0..00000000 --- a/bridgev2/provisionutil/resolveidentifier.go +++ /dev/null @@ -1,125 +0,0 @@ -// 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 deleted file mode 100644 index 3775c825..00000000 --- a/bridgev2/queue.go +++ /dev/null @@ -1,254 +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 bridgev2 - -import ( - "context" - "errors" - "fmt" - "strings" - "time" - - "github.com/rs/zerolog" - - "maunium.net/go/mautrix/event" - "maunium.net/go/mautrix/id" -) - -func rejectInvite(ctx context.Context, evt *event.Event, intent MatrixAPI, reason string) { - resp, err := intent.SendState(ctx, evt.RoomID, event.StateMember, intent.GetMXID().String(), &event.Content{ - Parsed: &event.MemberEventContent{ - Membership: event.MembershipLeave, - Reason: reason, - }, - }, time.Time{}) - if err != nil { - zerolog.Ctx(ctx).Err(err). - Stringer("room_id", evt.RoomID). - Stringer("inviter_id", evt.Sender). - Stringer("invitee_id", intent.GetMXID()). - Str("reason", reason). - Msg("Failed to reject invite") - } else { - zerolog.Ctx(ctx).Debug(). - Stringer("leave_event_id", resp.EventID). - Stringer("room_id", evt.RoomID). - Stringer("inviter_id", evt.Sender). - Stringer("invitee_id", intent.GetMXID()). - Str("reason", reason). - Msg("Rejected invite") - } -} - -func (br *Bridge) rejectInviteOnNoPermission(ctx context.Context, evt *event.Event, permType string) bool { - if evt.Type != event.StateMember || evt.Content.AsMember().Membership != event.MembershipInvite { - return false - } - userID := id.UserID(evt.GetStateKey()) - parsed, isGhost := br.Matrix.ParseGhostMXID(userID) - if userID != br.Bot.GetMXID() && !isGhost { - return false - } - var intent MatrixAPI - if userID == br.Bot.GetMXID() { - intent = br.Bot - } else { - intent = br.Matrix.GhostIntent(parsed) - } - rejectInvite(ctx, evt, intent, "You don't have permission to "+permType+" this bridge") - return true -} - -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) - var sender *User - if evt.Sender != "" { - var err error - sender, err = br.GetUserByMXID(ctx, evt.Sender) - if err != nil { - 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 EventHandlingResultFailed - } else if sender == nil { - log.Error().Msg("Couldn't get sender for incoming non-ephemeral Matrix event") - br.Matrix.SendMessageStatus(ctx, &ErrEventSenderUserNotFound, StatusEventInfoFromEvent(evt)) - return EventHandlingResultFailed - } else if !sender.Permissions.SendEvents { - if !br.rejectInviteOnNoPermission(ctx, evt, "interact with") { - br.Matrix.SendMessageStatus(ctx, &ErrNoPermissionToInteract, StatusEventInfoFromEvent(evt)) - } - return EventHandlingResultIgnored - } else if !sender.Permissions.Commands && br.rejectInviteOnNoPermission(ctx, evt, "send commands to") { - return EventHandlingResultIgnored - } - } else if evt.Type.Class != event.EphemeralEventType { - log.Error().Msg("Missing sender for incoming non-ephemeral Matrix event") - 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 { - br.Matrix.SendMessageStatus(ctx, &ErrNoPermissionForCommands, StatusEventInfoFromEvent(evt)) - return EventHandlingResultIgnored - } - go br.Commands.Handle( - ctx, - evt.RoomID, - evt.ID, - sender, - strings.TrimPrefix(msg.Body, br.Config.CommandPrefix+" "), - msg.RelatesTo.GetReplyTo(), - ) - return EventHandlingResultQueued - } - } - if evt.Type == event.StateMember && evt.GetStateKey() == br.Bot.GetMXID().String() && evt.Content.AsMember().Membership == event.MembershipInvite && sender != nil { - 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 EventHandlingResultFailed - } else if portal != nil { - 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 { - return br.handleGhostDMInvite(ctx, evt, sender) - } else { - status := WrapErrorInStatus(ErrNoPortal) - br.Matrix.SendMessageStatus(ctx, &status, StatusEventInfoFromEvent(evt)) - return EventHandlingResultIgnored - } -} - -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 (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(br.BackgroundCtx) - maybeUncertain, ok := evt.(RemoteEventWithUncertainPortalReceiver) - isUncertain := ok && maybeUncertain.PortalReceiverIsUncertain() - key := evt.GetPortalKey() - var portal *Portal - var err error - if isUncertain && !br.Config.SplitPortals { - portal, err = br.GetExistingPortalByKey(ctx, key) - } else { - portal, err = br.GetPortalByKey(ctx, key) - } - if err != nil { - log.Err(err).Object("portal_key", key).Bool("uncertain_receiver", isUncertain). - Msg("Failed to get portal to handle remote event") - 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 EventHandlingResultFailed.WithError(ErrPortalNotFoundInEventHandler) - } - // TODO put this in a better place, and maybe cache to avoid constant db queries - login.MarkInPortal(ctx, portal) - return portal.queueEvent(ctx, &portalRemoteEvent{ - evt: evt, - source: login, - }) -} diff --git a/bridgev2/simpleremoteevent.go b/bridgev2/simpleremoteevent.go deleted file mode 100644 index 66058e3e..00000000 --- a/bridgev2/simpleremoteevent.go +++ /dev/null @@ -1,133 +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 bridgev2 - -import ( - "context" - "time" - - "github.com/rs/zerolog" - - "maunium.net/go/mautrix/bridgev2/database" - "maunium.net/go/mautrix/bridgev2/networkid" -) - -// SimpleRemoteEvent is a simple implementation of RemoteEvent that can be used with struct fields and some callbacks. -// -// Using this type is only recommended for simple bridges. More advanced ones should implement -// the remote event interfaces themselves by wrapping the remote network library event types. -// -// Deprecated: use the types in the simplevent package instead. -type SimpleRemoteEvent[T any] struct { - Type RemoteEventType - LogContext func(c zerolog.Context) zerolog.Context - PortalKey networkid.PortalKey - Data T - CreatePortal bool - - ID networkid.MessageID - Sender EventSender - TargetMessage networkid.MessageID - EmojiID networkid.EmojiID - Emoji string - ReactionDBMeta any - Timestamp time.Time - ChatInfoChange *ChatInfoChange - - ResyncChatInfo *ChatInfo - ResyncBackfillNeeded bool - - BackfillData *FetchMessagesResponse - - ConvertMessageFunc func(ctx context.Context, portal *Portal, intent MatrixAPI, data T) (*ConvertedMessage, error) - ConvertEditFunc func(ctx context.Context, portal *Portal, intent MatrixAPI, existing []*database.Message, data T) (*ConvertedEdit, error) -} - -var ( - _ RemoteMessage = (*SimpleRemoteEvent[any])(nil) - _ RemoteEdit = (*SimpleRemoteEvent[any])(nil) - _ RemoteEventWithTimestamp = (*SimpleRemoteEvent[any])(nil) - _ RemoteReaction = (*SimpleRemoteEvent[any])(nil) - _ RemoteReactionWithMeta = (*SimpleRemoteEvent[any])(nil) - _ RemoteReactionRemove = (*SimpleRemoteEvent[any])(nil) - _ RemoteMessageRemove = (*SimpleRemoteEvent[any])(nil) - _ RemoteChatInfoChange = (*SimpleRemoteEvent[any])(nil) - _ RemoteChatResyncWithInfo = (*SimpleRemoteEvent[any])(nil) - _ RemoteChatResyncBackfill = (*SimpleRemoteEvent[any])(nil) - _ RemoteBackfill = (*SimpleRemoteEvent[any])(nil) -) - -func (sre *SimpleRemoteEvent[T]) AddLogContext(c zerolog.Context) zerolog.Context { - return sre.LogContext(c) -} - -func (sre *SimpleRemoteEvent[T]) GetPortalKey() networkid.PortalKey { - return sre.PortalKey -} - -func (sre *SimpleRemoteEvent[T]) GetTimestamp() time.Time { - if sre.Timestamp.IsZero() { - return time.Now() - } - return sre.Timestamp -} - -func (sre *SimpleRemoteEvent[T]) ConvertMessage(ctx context.Context, portal *Portal, intent MatrixAPI) (*ConvertedMessage, error) { - return sre.ConvertMessageFunc(ctx, portal, intent, sre.Data) -} - -func (sre *SimpleRemoteEvent[T]) ConvertEdit(ctx context.Context, portal *Portal, intent MatrixAPI, existing []*database.Message) (*ConvertedEdit, error) { - return sre.ConvertEditFunc(ctx, portal, intent, existing, sre.Data) -} - -func (sre *SimpleRemoteEvent[T]) GetID() networkid.MessageID { - return sre.ID -} - -func (sre *SimpleRemoteEvent[T]) GetSender() EventSender { - return sre.Sender -} - -func (sre *SimpleRemoteEvent[T]) GetTargetMessage() networkid.MessageID { - return sre.TargetMessage -} - -func (sre *SimpleRemoteEvent[T]) GetReactionEmoji() (string, networkid.EmojiID) { - return sre.Emoji, sre.EmojiID -} - -func (sre *SimpleRemoteEvent[T]) GetRemovedEmojiID() networkid.EmojiID { - return sre.EmojiID -} - -func (sre *SimpleRemoteEvent[T]) GetReactionDBMetadata() any { - return sre.ReactionDBMeta -} - -func (sre *SimpleRemoteEvent[T]) GetChatInfoChange(ctx context.Context) (*ChatInfoChange, error) { - return sre.ChatInfoChange, nil -} - -func (sre *SimpleRemoteEvent[T]) GetType() RemoteEventType { - return sre.Type -} - -func (sre *SimpleRemoteEvent[T]) ShouldCreatePortal() bool { - return sre.CreatePortal -} - -func (sre *SimpleRemoteEvent[T]) GetBackfillData(ctx context.Context, portal *Portal) (*FetchMessagesResponse, error) { - return sre.BackfillData, nil -} - -func (sre *SimpleRemoteEvent[T]) CheckNeedsBackfill(ctx context.Context, latestMessage *database.Message) (bool, error) { - return sre.ResyncBackfillNeeded, nil -} - -func (sre *SimpleRemoteEvent[T]) GetChatInfo(ctx context.Context, portal *Portal) (*ChatInfo, error) { - return sre.ResyncChatInfo, nil -} diff --git a/bridgev2/simplevent/chat.go b/bridgev2/simplevent/chat.go deleted file mode 100644 index 56e3a6b1..00000000 --- a/bridgev2/simplevent/chat.go +++ /dev/null @@ -1,92 +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 simplevent - -import ( - "context" - "time" - - "maunium.net/go/mautrix/bridgev2" - "maunium.net/go/mautrix/bridgev2/database" -) - -// ChatResync is a simple implementation of [bridgev2.RemoteChatResync]. -// -// If GetChatInfoFunc is set, it will be used to get the chat info. Otherwise, ChatInfo will be used. -// -// If CheckNeedsBackfillFunc is set, it will be used to determine if backfill is required. -// Otherwise, the latest database message timestamp is compared to LatestMessageTS. -// -// All four fields are optional. -type ChatResync struct { - EventMeta - - ChatInfo *bridgev2.ChatInfo - GetChatInfoFunc func(ctx context.Context, portal *bridgev2.Portal) (*bridgev2.ChatInfo, error) - - LatestMessageTS time.Time - CheckNeedsBackfillFunc func(ctx context.Context, latestMessage *database.Message) (bool, error) - BundledBackfillData any -} - -var ( - _ bridgev2.RemoteChatResync = (*ChatResync)(nil) - _ bridgev2.RemoteChatResyncWithInfo = (*ChatResync)(nil) - _ bridgev2.RemoteChatResyncBackfill = (*ChatResync)(nil) - _ bridgev2.RemoteChatResyncBackfillBundle = (*ChatResync)(nil) -) - -func (evt *ChatResync) CheckNeedsBackfill(ctx context.Context, latestMessage *database.Message) (bool, error) { - if evt.CheckNeedsBackfillFunc != nil { - return evt.CheckNeedsBackfillFunc(ctx, latestMessage) - } else if latestMessage == nil { - return !evt.LatestMessageTS.IsZero(), nil - } else { - return evt.LatestMessageTS.After(latestMessage.Timestamp), nil - } -} - -func (evt *ChatResync) GetBundledBackfillData() any { - return evt.BundledBackfillData -} - -func (evt *ChatResync) GetChatInfo(ctx context.Context, portal *bridgev2.Portal) (*bridgev2.ChatInfo, error) { - if evt.GetChatInfoFunc != nil { - return evt.GetChatInfoFunc(ctx, portal) - } - return evt.ChatInfo, nil -} - -// ChatDelete is a simple implementation of [bridgev2.RemoteChatDelete]. -type ChatDelete struct { - EventMeta - OnlyForMe bool - Children bool -} - -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 - - ChatInfoChange *bridgev2.ChatInfoChange -} - -var _ bridgev2.RemoteChatInfoChange = (*ChatInfoChange)(nil) - -func (evt *ChatInfoChange) GetChatInfoChange(ctx context.Context) (*bridgev2.ChatInfoChange, error) { - return evt.ChatInfoChange, nil -} diff --git a/bridgev2/simplevent/message.go b/bridgev2/simplevent/message.go deleted file mode 100644 index f8f8d7e1..00000000 --- a/bridgev2/simplevent/message.go +++ /dev/null @@ -1,115 +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 simplevent - -import ( - "context" - - "maunium.net/go/mautrix/bridgev2" - "maunium.net/go/mautrix/bridgev2/database" - "maunium.net/go/mautrix/bridgev2/networkid" -) - -// Message is a simple implementation of [bridgev2.RemoteMessage], [bridgev2.RemoteEdit] and [bridgev2.RemoteMessageUpsert]. -type Message[T any] struct { - EventMeta - Data T - - ID networkid.MessageID - TransactionID networkid.TransactionID - TargetMessage networkid.MessageID - - ConvertMessageFunc func(ctx context.Context, portal *bridgev2.Portal, intent bridgev2.MatrixAPI, data T) (*bridgev2.ConvertedMessage, error) - ConvertEditFunc func(ctx context.Context, portal *bridgev2.Portal, intent bridgev2.MatrixAPI, existing []*database.Message, data T) (*bridgev2.ConvertedEdit, error) - HandleExistingFunc func(ctx context.Context, portal *bridgev2.Portal, intent bridgev2.MatrixAPI, existing []*database.Message, data T) (bridgev2.UpsertResult, error) -} - -var ( - _ bridgev2.RemoteMessage = (*Message[any])(nil) - _ bridgev2.RemoteEdit = (*Message[any])(nil) - _ bridgev2.RemoteMessageUpsert = (*Message[any])(nil) - _ bridgev2.RemoteMessageWithTransactionID = (*Message[any])(nil) -) - -func (evt *Message[T]) ConvertMessage(ctx context.Context, portal *bridgev2.Portal, intent bridgev2.MatrixAPI) (*bridgev2.ConvertedMessage, error) { - return evt.ConvertMessageFunc(ctx, portal, intent, evt.Data) -} - -func (evt *Message[T]) ConvertEdit(ctx context.Context, portal *bridgev2.Portal, intent bridgev2.MatrixAPI, existing []*database.Message) (*bridgev2.ConvertedEdit, error) { - return evt.ConvertEditFunc(ctx, portal, intent, existing, evt.Data) -} - -func (evt *Message[T]) HandleExisting(ctx context.Context, portal *bridgev2.Portal, intent bridgev2.MatrixAPI, existing []*database.Message) (bridgev2.UpsertResult, error) { - return evt.HandleExistingFunc(ctx, portal, intent, existing, evt.Data) -} - -func (evt *Message[T]) GetID() networkid.MessageID { - return evt.ID -} - -func (evt *Message[T]) GetTargetMessage() networkid.MessageID { - return evt.TargetMessage -} - -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 - - TargetMessage networkid.MessageID - OnlyForMe bool -} - -var ( - _ bridgev2.RemoteMessageRemove = (*MessageRemove)(nil) - _ bridgev2.RemoteDeleteOnlyForMe = (*MessageRemove)(nil) -) - -func (evt *MessageRemove) GetTargetMessage() networkid.MessageID { - return evt.TargetMessage -} - -func (evt *MessageRemove) DeleteOnlyForMe() bool { - return evt.OnlyForMe -} diff --git a/bridgev2/simplevent/meta.go b/bridgev2/simplevent/meta.go deleted file mode 100644 index 449a8773..00000000 --- a/bridgev2/simplevent/meta.go +++ /dev/null @@ -1,144 +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 simplevent - -import ( - "context" - "time" - - "github.com/rs/zerolog" - - "maunium.net/go/mautrix/bridgev2" - "maunium.net/go/mautrix/bridgev2/networkid" -) - -// EventMeta is a struct containing metadata fields used by most event types. -type EventMeta struct { - Type bridgev2.RemoteEventType - LogContext func(c zerolog.Context) zerolog.Context - PortalKey networkid.PortalKey - UncertainReceiver bool - Sender bridgev2.EventSender - CreatePortal bool - Timestamp time.Time - StreamOrder int64 - - PreHandleFunc func(context.Context, *bridgev2.Portal) - PostHandleFunc func(context.Context, *bridgev2.Portal) -} - -var ( - _ bridgev2.RemoteEvent = (*EventMeta)(nil) - _ bridgev2.RemoteEventWithUncertainPortalReceiver = (*EventMeta)(nil) - _ 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 { - if evt.LogContext == nil { - return c - } - return evt.LogContext(c) -} - -func (evt *EventMeta) GetPortalKey() networkid.PortalKey { - return evt.PortalKey -} - -func (evt *EventMeta) PortalReceiverIsUncertain() bool { - return evt.UncertainReceiver -} - -func (evt *EventMeta) GetTimestamp() time.Time { - if evt.Timestamp.IsZero() { - return time.Now() - } - return evt.Timestamp -} - -func (evt *EventMeta) GetStreamOrder() int64 { - return evt.StreamOrder -} - -func (evt *EventMeta) GetSender() bridgev2.EventSender { - return evt.Sender -} - -func (evt *EventMeta) GetType() bridgev2.RemoteEventType { - return evt.Type -} - -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/reaction.go b/bridgev2/simplevent/reaction.go deleted file mode 100644 index 34e0b025..00000000 --- a/bridgev2/simplevent/reaction.go +++ /dev/null @@ -1,67 +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 simplevent - -import ( - "maunium.net/go/mautrix/bridgev2" - "maunium.net/go/mautrix/bridgev2/networkid" -) - -// Reaction is a simple implementation of [bridgev2.RemoteReaction] and [bridgev2.RemoteReactionRemove]. -type Reaction struct { - EventMeta - TargetMessage networkid.MessageID - EmojiID networkid.EmojiID - Emoji string - ExtraContent map[string]any - ReactionDBMeta any -} - -var ( - _ bridgev2.RemoteReaction = (*Reaction)(nil) - _ bridgev2.RemoteReactionWithMeta = (*Reaction)(nil) - _ bridgev2.RemoteReactionWithExtraContent = (*Reaction)(nil) - _ bridgev2.RemoteReactionRemove = (*Reaction)(nil) -) - -func (evt *Reaction) GetTargetMessage() networkid.MessageID { - return evt.TargetMessage -} - -func (evt *Reaction) GetReactionEmoji() (string, networkid.EmojiID) { - return evt.Emoji, evt.EmojiID -} - -func (evt *Reaction) GetRemovedEmojiID() networkid.EmojiID { - return evt.EmojiID -} - -func (evt *Reaction) GetReactionDBMetadata() any { - return evt.ReactionDBMeta -} - -func (evt *Reaction) GetReactionExtraContent() map[string]any { - return evt.ExtraContent -} - -type ReactionSync struct { - EventMeta - TargetMessage networkid.MessageID - Reactions *bridgev2.ReactionSyncData -} - -var ( - _ bridgev2.RemoteReactionSync = (*ReactionSync)(nil) -) - -func (evt *ReactionSync) GetTargetMessage() networkid.MessageID { - return evt.TargetMessage -} - -func (evt *ReactionSync) GetReactions() *bridgev2.ReactionSyncData { - return evt.Reactions -} diff --git a/bridgev2/simplevent/receipt.go b/bridgev2/simplevent/receipt.go deleted file mode 100644 index 41614e40..00000000 --- a/bridgev2/simplevent/receipt.go +++ /dev/null @@ -1,77 +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 simplevent - -import ( - "time" - - "maunium.net/go/mautrix/bridgev2" - "maunium.net/go/mautrix/bridgev2/networkid" -) - -type Receipt struct { - EventMeta - - LastTarget networkid.MessageID - Targets []networkid.MessageID - ReadUpTo time.Time - - ReadUpToStreamOrder int64 -} - -var ( - _ bridgev2.RemoteReadReceipt = (*Receipt)(nil) - _ bridgev2.RemoteDeliveryReceipt = (*Receipt)(nil) -) - -func (evt *Receipt) GetLastReceiptTarget() networkid.MessageID { - return evt.LastTarget -} - -func (evt *Receipt) GetReceiptTargets() []networkid.MessageID { - return evt.Targets -} - -func (evt *Receipt) GetReadUpTo() time.Time { - return evt.ReadUpTo -} - -func (evt *Receipt) GetReadUpToStreamOrder() int64 { - return evt.ReadUpToStreamOrder -} - -type MarkUnread struct { - EventMeta - Unread bool -} - -var ( - _ bridgev2.RemoteMarkUnread = (*MarkUnread)(nil) -) - -func (evt *MarkUnread) GetUnread() bool { - return evt.Unread -} - -type Typing struct { - EventMeta - Timeout time.Duration - Type bridgev2.TypingType -} - -var ( - _ bridgev2.RemoteTyping = (*Typing)(nil) - _ bridgev2.RemoteTypingWithType = (*Typing)(nil) -) - -func (evt *Typing) GetTimeout() time.Duration { - return evt.Timeout -} - -func (evt *Typing) GetTypingType() bridgev2.TypingType { - return evt.Type -} diff --git a/bridgev2/space.go b/bridgev2/space.go deleted file mode 100644 index 2ca2bce3..00000000 --- a/bridgev2/space.go +++ /dev/null @@ -1,193 +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 bridgev2 - -import ( - "context" - "fmt" - "time" - - "github.com/rs/zerolog" - - "maunium.net/go/mautrix" - "maunium.net/go/mautrix/bridgev2/database" - "maunium.net/go/mautrix/event" - "maunium.net/go/mautrix/id" -) - -func (ul *UserLogin) MarkInPortal(ctx context.Context, portal *Portal) { - if ul.inPortalCache.Has(portal.PortalKey) { - return - } - userPortal, err := ul.Bridge.DB.UserPortal.GetOrCreate(ctx, ul.UserLogin, portal.PortalKey) - if err != nil { - zerolog.Ctx(ctx).Err(err).Msg("Failed to ensure user portal row exists") - return - } - ul.inPortalCache.Add(portal.PortalKey) - if portal.MXID != "" { - dp := ul.User.DoublePuppet(ctx) - if dp != nil { - err = dp.EnsureJoined(ctx, portal.MXID) - if err != nil { - zerolog.Ctx(ctx).Err(err).Msg("Failed to ensure double puppet is joined to portal") - } - } else { - err = ul.Bridge.Bot.EnsureInvited(ctx, portal.MXID, ul.UserMXID) - if err != nil { - zerolog.Ctx(ctx).Err(err).Msg("Failed to ensure user is invited to portal") - } - } - if ul.Bridge.Config.PersonalFilteringSpaces && (userPortal.InSpace == nil || !*userPortal.InSpace) { - go ul.tryAddPortalToSpace(context.WithoutCancel(ctx), portal, userPortal.CopyWithoutValues()) - } - } -} - -func (ul *UserLogin) tryAddPortalToSpace(ctx context.Context, portal *Portal, userPortal *database.UserPortal) { - err := ul.AddPortalToSpace(ctx, portal, userPortal) - if err != nil { - zerolog.Ctx(ctx).Err(err).Msg("Failed to add portal to space") - } -} - -func (ul *UserLogin) AddPortalToSpace(ctx context.Context, portal *Portal, userPortal *database.UserPortal) error { - if portal.MXID == "" || portal.Parent != nil { - return nil - } - spaceRoom, err := ul.GetSpaceRoom(ctx) - if err != nil { - return fmt.Errorf("failed to get space room: %w", err) - } else if spaceRoom == "" { - return nil - } - err = portal.toggleSpace(ctx, spaceRoom, false, false) - if err != nil { - return fmt.Errorf("failed to add portal to space: %w", err) - } - inSpace := true - userPortal.InSpace = &inSpace - err = ul.Bridge.DB.UserPortal.Put(ctx, userPortal) - if err != nil { - return fmt.Errorf("failed to save user portal row: %w", err) - } - zerolog.Ctx(ctx).Debug().Stringer("space_room_id", spaceRoom).Msg("Added portal to space") - return nil -} - -func (portal *Portal) createParentAndAddToSpace(ctx context.Context, source *UserLogin) { - err := portal.Parent.CreateMatrixRoom(ctx, source, nil) - if err != nil { - zerolog.Ctx(ctx).Err(err).Msg("Failed to create parent portal") - } else { - portal.addToParentSpaceAndSave(ctx, true) - } -} - -func (portal *Portal) addToParentSpaceAndSave(ctx context.Context, save bool) { - err := portal.toggleSpace(ctx, portal.Parent.MXID, true, false) - if err != nil { - zerolog.Ctx(ctx).Err(err).Stringer("space_mxid", portal.Parent.MXID).Msg("Failed to add portal to space") - } else { - portal.InSpace = true - if save { - err = portal.Save(ctx) - if err != nil { - zerolog.Ctx(ctx).Err(err).Msg("Failed to save portal to database after adding to space") - } - } - } -} - -func (portal *Portal) toggleSpace(ctx context.Context, spaceID id.RoomID, canonical, remove bool) error { - via := []string{portal.Bridge.Matrix.ServerName()} - if remove { - via = nil - } - _, err := portal.Bridge.Bot.SendState(ctx, spaceID, event.StateSpaceChild, portal.MXID.String(), &event.Content{ - Parsed: &event.SpaceChildEventContent{ - Via: via, - }, - }, time.Now()) - if err != nil { - return err - } - if canonical { - _, err = portal.Bridge.Bot.SendState(ctx, portal.MXID, event.StateSpaceParent, spaceID.String(), &event.Content{ - Parsed: &event.SpaceParentEventContent{ - Via: via, - Canonical: !remove, - }, - }, time.Now()) - if err != nil { - return err - } - } - return nil -} - -func (ul *UserLogin) GetSpaceRoom(ctx context.Context) (id.RoomID, error) { - if !ul.Bridge.Config.PersonalFilteringSpaces { - return ul.SpaceRoom, nil - } - ul.spaceCreateLock.Lock() - defer ul.spaceCreateLock.Unlock() - if ul.SpaceRoom != "" { - return ul.SpaceRoom, nil - } - netName := ul.Bridge.Network.GetName() - var err error - autoJoin := ul.Bridge.Matrix.GetCapabilities().AutoJoinInvites - doublePuppet := ul.User.DoublePuppet(ctx) - req := &mautrix.ReqCreateRoom{ - Visibility: "private", - Name: fmt.Sprintf("%s (%s)", netName.DisplayName, ul.RemoteName), - Topic: fmt.Sprintf("Your %s bridged chats - %s", netName.DisplayName, ul.RemoteName), - InitialState: []*event.Event{{ - Type: event.StateRoomAvatar, - Content: event.Content{ - Parsed: &event.RoomAvatarEventContent{ - URL: netName.NetworkIcon, - }, - }, - }}, - CreationContent: map[string]any{ - "type": event.RoomTypeSpace, - }, - PowerLevelOverride: &event.PowerLevelsEventContent{ - Users: map[id.UserID]int{ - ul.Bridge.Bot.GetMXID(): 9001, - ul.UserMXID: 50, - }, - }, - Invite: []id.UserID{ul.UserMXID}, - } - if autoJoin { - req.BeeperInitialMembers = []id.UserID{ul.UserMXID} - // 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) - } - if !autoJoin && doublePuppet != nil { - err = doublePuppet.EnsureJoined(ctx, ul.SpaceRoom) - if err != nil { - zerolog.Ctx(ctx).Err(err).Msg("Failed to auto-join created space room with double puppet") - } - } - err = ul.Save(ctx) - if err != nil { - return "", fmt.Errorf("failed to save space room ID: %w", err) - } - return ul.SpaceRoom, nil -} diff --git a/bridgev2/status/localbridgestate.go b/bridgev2/status/localbridgestate.go deleted file mode 100644 index 3ad66538..00000000 --- a/bridgev2/status/localbridgestate.go +++ /dev/null @@ -1,23 +0,0 @@ -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/bridgev2/unorganized-docs/FEATURES.md b/bridgev2/unorganized-docs/FEATURES.md deleted file mode 100644 index 73da364d..00000000 --- a/bridgev2/unorganized-docs/FEATURES.md +++ /dev/null @@ -1,49 +0,0 @@ -# Megabridge features - -* [ ] Messages - * [x] Text (incl. formatting and mentions) - * [x] Attachments - * [ ] Polls - * [x] Replies - * [x] Threads - * [x] Edits - * [x] Reactions - * [x] Reaction mass-syncing - * [x] Deletions - * [x] Message status events and error notices - * [x] Backfilling history -* [x] Login -* [x] Logout -* [x] Re-login after credential expiry -* [x] Disappearing messages -* [x] Read receipts -* [ ] Presence -* [x] Typing notifications -* [x] Spaces -* [x] Relay mode -* [x] Chat metadata - * [x] Archive/low priority - * [x] Pin/favorite - * [x] Mark unread - * [x] Mute status - * [x] Temporary mutes ("snooze") -* [x] User metadata (name/avatar) -* [x] Group metadata - * [x] Initial meta and full resyncs - * [x] Name, avatar, topic - * [x] Members - * [x] Permissions - * [x] Change events - * [x] Name, avatar, topic - * [x] Members (join, leave, invite, kick, ban, knock) - * [x] Permissions (promote, demote) -* [ ] Misc actions - * [ ] Invites / accepting message requests - * [x] Create group - * [x] Create DM - * [x] Get contact list - * [x] Check if identifier is on remote network - * [x] Search users on remote network - * [ ] Delete chat - * [ ] Report spam -* [ ] Custom emojis diff --git a/bridgev2/unorganized-docs/README.md b/bridgev2/unorganized-docs/README.md deleted file mode 100644 index 62cc731a..00000000 --- a/bridgev2/unorganized-docs/README.md +++ /dev/null @@ -1,66 +0,0 @@ -# Megabridge -Megabridge, also known as bridgev2 (final naming is subject to change), is a -new high-level framework for writing puppeting Matrix bridges with hopefully -minimal boilerplate code. - -## General architecture -Megabridge is split into three components: network connectors, the central -bridge module, and Matrix connectors. - -* Network connectors are responsible for connecting to the remote (non-Matrix) - network and handling all the protocol-specific details. -* The central bridge module has most of the generic bridge logic, such as - keeping track of portal mappings and handling messages. -* Matrix connectors are responsible for connecting to Matrix. Initially there - will be two Matrix connectors: one for the standard setup that connects to - a Matrix homeserver as an application service, and another for Beeper's local - bridge system. However, in the future there could be a third connector which - uses a single bot account and [MSC4144] instead of an appservice with ghost - users. - - [MSC4144]: https://github.com/matrix-org/matrix-spec-proposals/pull/4144 - -The central bridge module defines interfaces that it uses to interact with the -connectors on both sides. Additionally, the connectors are allowed to directly -call interface methods on other side. - -## Getting started with a new network connector -To create a new network connector, you need to implement the -`NetworkConnector`, `LoginProcess`, `NetworkAPI` and `RemoteEvent` interfaces. - -* `NetworkConnector` is the main entry point to the remote network. It is - responsible for general non-user-specific things, as well as creating - `NetworkAPI`s and starting login flows. -* `LoginProcess` is a state machine for logging into the remote network. -* `NetworkAPI` is the remote network client for a single login. It is - responsible for maintaining the connection to the remote network, receiving - incoming events, sending outgoing events, and fetching information like - chat/user metadata. -* `RemoteEvent` represents a single event from the remote network, such as a - message or a reaction. When the NetworkAPI receives an event, it should create - a `RemoteEvent` object and pass it to the bridge using `Bridge.QueueRemoteEvent`. - -### Login -Logins are implemented by combining three types of steps: - -* `user_input` asks the user to enter some information, such as a phone number, - username, email, password, or 2FA code. -* `cookies` either asks the user to extract cookies from their browser, or opens - a webview to do it automatically (depending on whether the login is being done - via bridge commands or a more advanced client). -* `display_and_wait` displays a QR code or other data to the user and waits until - the remote network accepts the login. - -The general flow is: - -1. Login handler (bridge command or client) calls `NetworkConnector.GetLoginFlows` - to get available login flows, and asks the user to pick one (or alternatively - automatically picks the first one if there's only one option). -2. Login handler calls `NetworkConnector.CreateLogin` with the chosen flow ID and - the network connector returns a `LoginProcess` object that remembers the user - and flow. -3. Login handler calls `LoginProcess.Start` to get the first step. -4. Login handler calls the appropriate functions (`Wait`, `SubmitUserInput` or - `SubmitCookies`) based on the step data as many times as needed. -5. When the login is done, the login process creates the `UserLogin` object and - returns a `complete` step. diff --git a/bridgev2/unorganized-docs/incoming-matrix-message.uml b/bridgev2/unorganized-docs/incoming-matrix-message.uml deleted file mode 100644 index ae13ee74..00000000 --- a/bridgev2/unorganized-docs/incoming-matrix-message.uml +++ /dev/null @@ -1,23 +0,0 @@ -title Bridge v2 incoming Matrix message - -participant Network Library -participant Network Connector -participant Bridge -participant Portal -participant Database -participant Matrix - -Matrix->Bridge: QueueMatrixEvent(evt) -note over Bridge: GetPortalByID(evt.GetPortalID()) -Bridge->Portal: portal.events <- evt -loop event queue consumer - Portal->+Portal: \n evt := <-portal.events - note over Portal: Check for edit, reply/thread, etc - Portal->+Network Connector: HandleMatrixMessage(evt, replyTo) - Network Connector->Network Connector: msg := ConvertMatrixMessage(evt) - Network Connector->+Network Library: SendMessage(msg) - Network Library->-Network Connector: OK - Network Connector->-Portal: *database.Message{msg.ID} - Portal->-Database: Message.Insert() - Portal->Matrix: Success checkpoint -end diff --git a/bridgev2/unorganized-docs/incoming-remote-message.uml b/bridgev2/unorganized-docs/incoming-remote-message.uml deleted file mode 100644 index f86d6e65..00000000 --- a/bridgev2/unorganized-docs/incoming-remote-message.uml +++ /dev/null @@ -1,22 +0,0 @@ -title Bridge v2 incoming remote message - -participant Network Library -participant Network Connector -participant Bridge -participant Portal -participant Database -participant Matrix - -Network Library->Network Connector: New event -Network Connector->Bridge: QueueRemoteEvent(evt) -note over Bridge: GetPortalByID(evt.GetPortalID()) -Bridge->Portal: portal.events <- evt -loop event queue consumer - Portal->+Portal: \n evt := <-portal.events - note over Portal: CreateMatrixRoom() if applicable - Portal->+Network Connector: ConvertRemoteMessage(evt) - Network Connector->-Portal: *ConvertedMessage - Portal->+Matrix: SendMessage(convertedMsg) - Matrix->-Portal: event ID - Portal->-Database: Message.Insert() -end diff --git a/bridgev2/unorganized-docs/login-step.schema.json b/bridgev2/unorganized-docs/login-step.schema.json deleted file mode 100644 index b039354f..00000000 --- a/bridgev2/unorganized-docs/login-step.schema.json +++ /dev/null @@ -1,155 +0,0 @@ -{ - "$schema": "https://json-schema.org/draft/2020-12/schema", - "$id": "https://go.mau.fi/mautrix/bridgev2/login-step.json", - "title": "Login step data", - "type": "object", - "properties": { - "type": { - "type": "string", - "enum": ["user_input", "cookies", "display_and_wait", "complete"] - }, - "step_id": { - "type": "string", - "description": "An unique ID identifying this step. This can be used to implement special behavior in clients." - }, - "instructions": { - "type": "string", - "description": "Human-readable instructions for completing this login step." - }, - "user_input": { - "type": "object", - "title": "User input params", - "description": "Parameters for the `user_input` login type", - "properties": { - "fields": { - "type": "array", - "description": "The list of fields that the user must fill", - "items": { - "title": "Field", - "description": "A field that the user must fill", - "type": "object", - "properties": { - "type": { - "type": "string", - "enum": ["username", "phone_number", "email", "password", "2fa_code", "token"] - }, - "id": { - "type": "string", - "description": "The ID of the field. This should be used when submitting the form.", - "examples": ["uid", "email", "2fa_password", "meow"] - }, - "name": { - "type": "string", - "description": "The name of the field shown to the user", - "examples": ["Username", "Password", "Phone number", "2FA code", "Meow"] - }, - "description": { - "type": "string", - "description": "The description of the field shown to the user", - "examples": ["Include the country code with a +"] - }, - "pattern": { - "type": "string", - "description": "A regular expression that the field value must match" - } - }, - "required": ["type", "id", "name"] - } - } - }, - "required": ["fields"] - }, - "cookies": { - "type": "object", - "title": "Cookie params", - "description": "Parameters for the `cookies` login type", - "properties": { - "url": { - "type": "string", - "description": "The URL to open when using a webview to extract cookies" - }, - "user_agent": { - "type": "string", - "description": "The user agent to use when opening the URL" - }, - "fields": { - "type": "array", - "description": "The list of cookies (or other stored data) that must be extracted", - "items": { - "title": "Cookie Field", - "description": "A cookie (or other stored data) that must be extracted", - "type": "object", - "properties": { - "type": { - "type": "string", - "description": "The type of data to extract", - "enum": ["cookie", "local_storage", "request_header", "request_body", "special"] - }, - "name": { - "type": "string", - "description": "The name of the cookie or key in the storage" - }, - "request_url_regex": { - "type": "string", - "description": "For the `request_header` and `request_body` types, a regex that matches the URLs from which the values can be extracted." - }, - "cookie_domain": { - "type": "string", - "description": "For the `cookie` type, the domain of the cookie" - } - }, - "required": ["type", "name"] - } - }, - "extract_js": { - "type": "string", - "description": "JavaScript code that can be evaluated inside the webview to extract the special keys" - } - }, - "required": ["url"] - }, - "display_and_wait": { - "type": "object", - "title": "Display and wait params", - "description": "Parameters for the `display_and_wait` login type", - "properties": { - "type": { - "type": "string", - "description": "The type of thing to display", - "enum": ["qr", "emoji", "code", "nothing"] - }, - "data": { - "type": "string", - "description": "The thing to display (raw data for QR, unicode emoji for emoji, plain string for code)" - }, - "image_url": { - "type": "string", - "description": "An image containing the thing to display. If present, this is recommended over using data directly. For emojis, the URL to the canonical image representation of the emoji" - } - }, - "required": ["type"] - }, - "complete": { - "type": "object", - "title": "Login complete information", - "description": "Information about a successful login", - "properties": { - "user_login_id": { - "type": "string", - "description": "The ID of the user login entry" - } - } - } - }, - "required": [ - "type", - "step_id", - "instructions" - ], - "oneOf": [ - {"title":"User input type","properties":{"type": {"type":"string","const": "user_input"}}, "required": ["user_input"]}, - {"title":"Cookies type","properties":{"type": {"type":"string","const": "cookies"}}, "required": ["cookies"]}, - {"title":"Display and wait type","properties":{"type": {"type":"string","const": "display_and_wait"}}, "required": ["display_and_wait"]}, - {"title":"Login complete","properties":{"type": {"type":"string","const": "complete"}}} - ] -} diff --git a/bridgev2/unorganized-docs/login-steps.uml b/bridgev2/unorganized-docs/login-steps.uml deleted file mode 100644 index 5af9c88e..00000000 --- a/bridgev2/unorganized-docs/login-steps.uml +++ /dev/null @@ -1,43 +0,0 @@ -title Login flows - -participant User -participant Client -participant Bridge -participant User's device - -alt Username+Password/Phone number/2FA code - Client->+Bridge: /login - Bridge->-Client: step=user_input, fields=[...] - Client->User: input box(es) - User->Client: submit input - Client->+Bridge: /login/user_input - Bridge->-Client: success=true, step=next step -end - -alt Cookies - Client->+Bridge: /login - Bridge->-Client: step=cookies, url=..., cookies=[...] - Client->User: webview - User->Client: login in webview - Client->Bridge: /login/cookies - Bridge->-Client: success=true, step=next step -end - -alt QR/Emoji/Code - Client->+Bridge: /login - Bridge->-Client: step=display_and_wait, data=... - Client->+Bridge: /login/wait - Client->User: display QR/emoji/code - loop Refresh QR - Bridge->-Client: step=display_and_wait, data=new QR - Client->User: display new QR - Client->+Bridge: /login/wait - end -else Successful case - User->User's device: Scan QR/tap emoji/enter code - User's device->Bridge: Login successful - Bridge->-Client: success=true, step=next step -else Error - Bridge->Client: error=timeout - Client->User: error -end diff --git a/bridgev2/user.go b/bridgev2/user.go deleted file mode 100644 index 9a7896d6..00000000 --- a/bridgev2/user.go +++ /dev/null @@ -1,275 +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 bridgev2 - -import ( - "context" - "fmt" - "strings" - "sync" - "unsafe" - - "github.com/rs/zerolog" - "golang.org/x/exp/maps" - "golang.org/x/exp/slices" - - "maunium.net/go/mautrix" - "maunium.net/go/mautrix/bridgev2/bridgeconfig" - "maunium.net/go/mautrix/bridgev2/database" - "maunium.net/go/mautrix/bridgev2/networkid" - "maunium.net/go/mautrix/event" - "maunium.net/go/mautrix/id" -) - -type User struct { - *database.User - Bridge *Bridge - Log zerolog.Logger - - CommandState unsafe.Pointer - Permissions bridgeconfig.Permissions - - doublePuppetIntent MatrixAPI - doublePuppetInitialized bool - doublePuppetLock sync.Mutex - - managementCreateLock sync.Mutex - - logins map[networkid.UserLoginID]*UserLogin -} - -func (br *Bridge) loadUser(ctx context.Context, dbUser *database.User, queryErr error, userID *id.UserID) (*User, error) { - if queryErr != nil { - return nil, fmt.Errorf("failed to query db: %w", queryErr) - } - if dbUser == nil { - if userID == nil { - return nil, nil - } - dbUser = &database.User{ - BridgeID: br.ID, - MXID: *userID, - } - err := br.DB.User.Insert(ctx, dbUser) - if err != nil { - return nil, fmt.Errorf("failed to insert new user: %w", err) - } - } - user := &User{ - User: dbUser, - Bridge: br, - Log: br.Log.With().Stringer("user_mxid", dbUser.MXID).Logger(), - logins: make(map[networkid.UserLoginID]*UserLogin), - Permissions: br.Config.Permissions.Get(dbUser.MXID), - } - br.usersByMXID[user.MXID] = user - err := br.unlockedLoadUserLoginsByMXID(ctx, user) - if err != nil { - return nil, fmt.Errorf("failed to load user logins: %w", err) - } - return user, nil -} - -func (br *Bridge) unlockedGetUserByMXID(ctx context.Context, userID id.UserID, onlyIfExists bool) (*User, error) { - cached, ok := br.usersByMXID[userID] - if ok { - return cached, nil - } - idPtr := &userID - if onlyIfExists { - idPtr = nil - } - db, err := br.DB.User.GetByMXID(ctx, userID) - return br.loadUser(ctx, db, err, idPtr) -} - -func (br *Bridge) GetUserByMXID(ctx context.Context, userID id.UserID) (*User, error) { - br.cacheLock.Lock() - defer br.cacheLock.Unlock() - return br.unlockedGetUserByMXID(ctx, userID, false) -} - -func (br *Bridge) GetExistingUserByMXID(ctx context.Context, userID id.UserID) (*User, error) { - br.cacheLock.Lock() - defer br.cacheLock.Unlock() - return br.unlockedGetUserByMXID(ctx, userID, true) -} - -func (user *User) LogoutDoublePuppet(ctx context.Context) { - user.doublePuppetLock.Lock() - defer user.doublePuppetLock.Unlock() - user.AccessToken = "" - err := user.Save(ctx) - if err != nil { - zerolog.Ctx(ctx).Err(err).Msg("Failed to save removed access token") - } - user.doublePuppetIntent = nil - user.doublePuppetInitialized = false -} - -func (user *User) LoginDoublePuppet(ctx context.Context, token string) error { - if token == "" { - return fmt.Errorf("no token provided") - } - user.doublePuppetLock.Lock() - defer user.doublePuppetLock.Unlock() - intent, newToken, err := user.Bridge.Matrix.NewUserIntent(ctx, user.MXID, token) - if err != nil { - return err - } - user.AccessToken = newToken - user.doublePuppetIntent = intent - user.doublePuppetInitialized = true - err = user.Save(ctx) - if err != nil { - zerolog.Ctx(ctx).Err(err).Msg("Failed to save new access token") - } - if newToken != token { - return fmt.Errorf("logging in manually is not supported when automatic double puppeting is enabled") - } - return nil -} - -func (user *User) DoublePuppet(ctx context.Context) MatrixAPI { - user.doublePuppetLock.Lock() - defer user.doublePuppetLock.Unlock() - if user.doublePuppetInitialized { - return user.doublePuppetIntent - } - user.doublePuppetInitialized = true - log := user.Log.With().Str("action", "setup double puppet").Logger() - ctx = log.WithContext(ctx) - intent, newToken, err := user.Bridge.Matrix.NewUserIntent(ctx, user.MXID, user.AccessToken) - if err != nil { - log.Err(err).Msg("Failed to create new user intent") - return nil - } - user.doublePuppetIntent = intent - if newToken != user.AccessToken { - user.AccessToken = newToken - err = user.Save(ctx) - if err != nil { - log.Warn().Err(err).Msg("Failed to save new access token") - } - } - return intent -} - -func (user *User) GetUserLoginIDs() []networkid.UserLoginID { - user.Bridge.cacheLock.Lock() - defer user.Bridge.cacheLock.Unlock() - return maps.Keys(user.logins) -} - -// Deprecated: renamed to GetUserLogins -func (user *User) GetCachedUserLogins() []*UserLogin { - return user.GetUserLogins() -} - -func (user *User) GetUserLogins() []*UserLogin { - user.Bridge.cacheLock.Lock() - defer user.Bridge.cacheLock.Unlock() - 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) - `%s`", key, val.RemoteName, val.BridgeState.GetPrev().StateEvent)) - } - user.Bridge.cacheLock.Unlock() - return strings.Join(logins, "\n") -} - -func (user *User) GetDefaultLogin() *UserLogin { - user.Bridge.cacheLock.Lock() - defer user.Bridge.cacheLock.Unlock() - if len(user.logins) == 0 { - return nil - } - loginKeys := maps.Keys(user.logins) - slices.Sort(loginKeys) - return user.logins[loginKeys[0]] -} - -func (user *User) GetManagementRoom(ctx context.Context) (id.RoomID, error) { - user.managementCreateLock.Lock() - defer user.managementCreateLock.Unlock() - if user.ManagementRoom != "" { - return user.ManagementRoom, nil - } - netName := user.Bridge.Network.GetName() - var err error - autoJoin := user.Bridge.Matrix.GetCapabilities().AutoJoinInvites - doublePuppet := user.DoublePuppet(ctx) - req := &mautrix.ReqCreateRoom{ - Visibility: "private", - Name: netName.DisplayName, - Topic: fmt.Sprintf("%s bridge management room", netName.DisplayName), - InitialState: []*event.Event{{ - Type: event.StateRoomAvatar, - Content: event.Content{ - Parsed: &event.RoomAvatarEventContent{ - URL: netName.NetworkIcon, - }, - }, - }}, - PowerLevelOverride: &event.PowerLevelsEventContent{ - Users: map[id.UserID]int{ - user.Bridge.Bot.GetMXID(): 9001, - user.MXID: 50, - }, - }, - Invite: []id.UserID{user.MXID}, - IsDirect: true, - } - if autoJoin { - req.BeeperInitialMembers = []id.UserID{user.MXID} - // TODO remove this after initial_members is supported in hungryserv - req.BeeperAutoJoinInvites = true - } - user.ManagementRoom, err = user.Bridge.Bot.CreateRoom(ctx, req) - if err != nil { - return "", fmt.Errorf("failed to create management room: %w", err) - } - if !autoJoin && doublePuppet != nil { - err = doublePuppet.EnsureJoined(ctx, user.ManagementRoom) - if err != nil { - zerolog.Ctx(ctx).Err(err).Msg("Failed to auto-join created management room with double puppet") - } - } - err = user.Save(ctx) - if err != nil { - return "", fmt.Errorf("failed to save management room ID: %w", err) - } - return user.ManagementRoom, nil -} - -func (user *User) Save(ctx context.Context) error { - return user.Bridge.DB.User.Update(ctx, user.User) -} - -func (br *Bridge) TrackAnalytics(userID id.UserID, event string, props map[string]any) { - analyticSender, ok := br.Matrix.(MatrixConnectorWithAnalytics) - if ok { - analyticSender.TrackAnalytics(userID, event, props) - } -} - -func (user *User) TrackAnalytics(event string, props map[string]any) { - user.Bridge.TrackAnalytics(user.MXID, event, props) -} - -func (ul *UserLogin) TrackAnalytics(event string, props map[string]any) { - // TODO include user login ID? - ul.Bridge.TrackAnalytics(ul.UserMXID, event, props) -} diff --git a/bridgev2/userlogin.go b/bridgev2/userlogin.go deleted file mode 100644 index d56dc4cc..00000000 --- a/bridgev2/userlogin.go +++ /dev/null @@ -1,571 +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 bridgev2 - -import ( - "cmp" - "context" - "fmt" - "maps" - "slices" - "sync" - "time" - - "github.com/rs/zerolog" - "go.mau.fi/util/exsync" - - "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" -) - -type UserLogin struct { - *database.UserLogin - Bridge *Bridge - User *User - Log zerolog.Logger - - Client NetworkAPI - BridgeState *BridgeStateQueue - - inPortalCache *exsync.Set[networkid.PortalKey] - - spaceCreateLock sync.Mutex - deleteLock sync.Mutex - disconnectOnce sync.Once -} - -func (br *Bridge) loadUserLogin(ctx context.Context, user *User, dbUserLogin *database.UserLogin) (*UserLogin, error) { - if dbUserLogin == nil { - return nil, nil - } - if user == nil { - var err error - user, err = br.unlockedGetUserByMXID(ctx, dbUserLogin.UserMXID, true) - 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, - Bridge: br, - User: user, - Log: user.Log.With().Str("login_id", string(dbUserLogin.ID)).Logger(), - - inPortalCache: exsync.NewSet[networkid.PortalKey](), - } - err := br.Network.LoadUserLogin(ctx, userLogin) - 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 - br.userLoginsByID[userLogin.ID] = userLogin - return userLogin, nil -} - -func (br *Bridge) loadManyUserLogins(ctx context.Context, user *User, logins []*database.UserLogin) ([]*UserLogin, error) { - output := make([]*UserLogin, 0, len(logins)) - for _, dbLogin := range logins { - if cached, ok := br.userLoginsByID[dbLogin.ID]; ok { - output = append(output, cached) - } else { - loaded, err := br.loadUserLogin(ctx, user, dbLogin) - if err != nil { - return nil, err - } else if loaded != nil { - output = append(output, loaded) - } - } - } - return output, nil -} - -func (br *Bridge) unlockedLoadUserLoginsByMXID(ctx context.Context, user *User) error { - logins, err := br.DB.UserLogin.GetAllForUser(ctx, user.MXID) - if err != nil { - return err - } - _, err = br.loadManyUserLogins(ctx, user, logins) - return err -} - -func (br *Bridge) GetUserLoginsInPortal(ctx context.Context, portal networkid.PortalKey) ([]*UserLogin, error) { - if portal.Receiver != "" { - ul := br.GetCachedUserLoginByID(portal.Receiver) - if ul == nil { - return nil, nil - } - return []*UserLogin{ul}, nil - } - logins, err := br.DB.UserLogin.GetAllInPortal(ctx, portal) - if err != nil { - return nil, err - } - br.cacheLock.Lock() - defer br.cacheLock.Unlock() - return br.loadManyUserLogins(ctx, nil, logins) -} - -func (br *Bridge) GetExistingUserLoginByID(ctx context.Context, id networkid.UserLoginID) (*UserLogin, error) { - br.cacheLock.Lock() - defer br.cacheLock.Unlock() - return br.unlockedGetExistingUserLoginByID(ctx, id) -} - -func (br *Bridge) unlockedGetExistingUserLoginByID(ctx context.Context, id networkid.UserLoginID) (*UserLogin, error) { - cached, ok := br.userLoginsByID[id] - if ok { - return cached, nil - } - login, err := br.DB.UserLogin.GetByID(ctx, id) - if err != nil { - return nil, err - } - return br.loadUserLogin(ctx, nil, login) -} - -func (br *Bridge) GetCachedUserLoginByID(id networkid.UserLoginID) *UserLogin { - br.cacheLock.Lock() - defer br.cacheLock.Unlock() - 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() - if len(br.userLoginsByID) == 0 { - return []status.BridgeState{{ - StateEvent: status.StateUnconfigured, - }} - } - states = make([]status.BridgeState, len(br.userLoginsByID)) - i := 0 - for _, login := range br.userLoginsByID { - states[i] = login.BridgeState.GetPrev() - i++ - } - return -} - -type NewLoginParams struct { - LoadUserLogin func(context.Context, *UserLogin) error - DeleteOnConflict bool - DontReuseExisting bool -} - -// NewLogin creates a UserLogin object for this user with the given parameters. -// -// If a login already exists with the same ID, it is reused after updating the remote name -// and metadata from the provided data, unless DontReuseExisting is set in params. -// -// If the existing login belongs to another user, this returns an error, -// unless DeleteOnConflict is set in the params, in which case the existing login is deleted. -// -// This will automatically call LoadUserLogin after creating the UserLogin object. -// The load method defaults to the network connector's LoadUserLogin method, but it can be overridden in params. -func (user *User) NewLogin(ctx context.Context, data *database.UserLogin, params *NewLoginParams) (*UserLogin, error) { - user.Bridge.cacheLock.Lock() - defer user.Bridge.cacheLock.Unlock() - data.BridgeID = user.BridgeID - data.UserMXID = user.MXID - if data.Metadata == nil { - metaTypes := user.Bridge.Network.GetDBMetaTypes() - if metaTypes.UserLogin != nil { - data.Metadata = metaTypes.UserLogin() - } - } - if params == nil { - params = &NewLoginParams{} - } - if params.LoadUserLogin == nil { - params.LoadUserLogin = user.Bridge.Network.LoadUserLogin - } - ul, err := user.Bridge.unlockedGetExistingUserLoginByID(ctx, data.ID) - if err != nil { - return nil, fmt.Errorf("failed to check if login already exists: %w", err) - } - var doInsert bool - if ul != nil && ul.UserMXID != user.MXID { - if params.DeleteOnConflict { - ul.Delete(ctx, status.BridgeState{StateEvent: status.StateLoggedOut, Reason: "LOGIN_OVERRIDDEN_ANOTHER_USER"}, DeleteOpts{ - LogoutRemote: false, - unlocked: true, - }) - ul = nil - } else { - return nil, fmt.Errorf("%s is already logged in with that account", ul.UserMXID) - } - } - if ul != nil { - if params.DontReuseExisting { - return nil, fmt.Errorf("login already exists") - } - doInsert = false - ul.RemoteName = data.RemoteName - ul.RemoteProfile = ul.RemoteProfile.Merge(data.RemoteProfile) - if merger, ok := ul.Metadata.(database.MetaMerger); ok { - merger.CopyFrom(data.Metadata) - } else { - ul.Metadata = data.Metadata - } - } else { - doInsert = true - ul = &UserLogin{ - UserLogin: data, - Bridge: user.Bridge, - User: user, - Log: user.Log.With().Str("login_id", string(data.ID)).Logger(), - } - ul.BridgeState = user.Bridge.NewBridgeStateQueue(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(noCancelCtx, ul.UserLogin) - if err != nil { - return nil, err - } - user.Bridge.userLoginsByID[ul.ID] = ul - user.logins[ul.ID] = ul - } else { - err = ul.Save(noCancelCtx) - if err != nil { - return nil, err - } - } - return ul, nil -} - -func (ul *UserLogin) Save(ctx context.Context) error { - return ul.Bridge.DB.UserLogin.Update(ctx, ul.UserLogin) -} - -func (ul *UserLogin) Logout(ctx context.Context) { - ul.Delete(ctx, status.BridgeState{StateEvent: status.StateLoggedOut}, DeleteOpts{LogoutRemote: true}) -} - -type DeleteOpts struct { - LogoutRemote bool - DontCleanupRooms bool - BlockingCleanup bool - unlocked bool -} - -func (ul *UserLogin) Delete(ctx context.Context, state status.BridgeState, opts DeleteOpts) { - cleanupRooms := !opts.DontCleanupRooms && ul.Bridge.Config.CleanupOnLogout.Enabled - zerolog.Ctx(ctx).Info().Str("user_login_id", string(ul.ID)). - Bool("logout_remote", opts.LogoutRemote). - Bool("cleanup_rooms", cleanupRooms). - Msg("Deleting user login") - ul.deleteLock.Lock() - defer ul.deleteLock.Unlock() - if ul.BridgeState == nil { - return - } - if opts.LogoutRemote { - ul.Client.LogoutRemote(ctx) - } else { - // we probably shouldn't delete the login if disconnect isn't finished - ul.Disconnect() - } - var portals []*database.UserPortal - var err error - if cleanupRooms { - portals, err = ul.Bridge.DB.UserPortal.GetAllForLogin(ctx, ul.UserLogin) - if err != nil { - ul.Log.Err(err).Msg("Failed to get user portals") - } - } - err = ul.Bridge.DB.UserLogin.Delete(ctx, ul.ID) - if err != nil { - ul.Log.Err(err).Msg("Failed to delete user login") - } - if !opts.unlocked { - ul.Bridge.cacheLock.Lock() - } - delete(ul.User.logins, ul.ID) - delete(ul.Bridge.userLoginsByID, ul.ID) - if !opts.unlocked { - ul.Bridge.cacheLock.Unlock() - } - backgroundCtx := zerolog.Ctx(ctx).WithContext(ul.Bridge.BackgroundCtx) - if !opts.BlockingCleanup { - go ul.deleteSpace(backgroundCtx) - } else { - ul.deleteSpace(backgroundCtx) - } - if portals != nil { - 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) - } - ul.BridgeState.Destroy() - ul.BridgeState = nil -} - -func (ul *UserLogin) deleteSpace(ctx context.Context) { - if ul.SpaceRoom == "" { - return - } - err := ul.Bridge.Bot.DeleteRoom(ctx, ul.SpaceRoom, false) - if err != nil { - ul.Log.Err(err).Msg("Failed to delete space room") - } -} - -// KickUserFromPortalsForBadCredentials can be called to kick the user from portals without deleting the entire UserLogin object. -func (ul *UserLogin) KickUserFromPortalsForBadCredentials(ctx context.Context) { - log := zerolog.Ctx(ctx) - portals, err := ul.Bridge.DB.UserPortal.GetAllForLogin(ctx, ul.UserLogin) - if err != nil { - log.Err(err).Msg("Failed to get user portals") - } - ul.kickUserFromPortals(ctx, portals, true, true) -} - -func DeleteManyPortals(ctx context.Context, portals []*Portal, errorCallback func(portal *Portal, delete bool, err error)) { - // TODO is there a more sensible place/name for this function? - if len(portals) == 0 { - return - } - getDepth := func(portal *Portal) int { - depth := 0 - for portal.Parent != nil { - depth++ - portal = portal.Parent - } - return depth - } - // Sort portals so parents are last (to avoid errors caused by deleting parent portals before children) - slices.SortFunc(portals, func(a, b *Portal) int { - return cmp.Compare(getDepth(b), getDepth(a)) - }) - for _, portal := range portals { - err := portal.Delete(ctx) - if err != nil { - zerolog.Ctx(ctx).Err(err). - Stringer("portal_mxid", portal.MXID). - Object("portal_key", portal.PortalKey). - Msg("Failed to delete portal row from database") - if errorCallback != nil { - errorCallback(portal, false, err) - } - continue - } - if portal.MXID != "" { - err = portal.Bridge.Bot.DeleteRoom(ctx, portal.MXID, false) - if err != nil { - zerolog.Ctx(ctx).Err(err). - Stringer("portal_mxid", portal.MXID). - Msg("Failed to clean up portal room") - if errorCallback != nil { - errorCallback(portal, true, err) - } - } - } - } -} - -func (ul *UserLogin) kickUserFromPortals(ctx context.Context, portals []*database.UserPortal, badCredentials, deleteRow bool) { - var portalsToDelete []*Portal - for _, up := range portals { - portalToDelete, err := ul.kickUserFromPortal(ctx, up, badCredentials, deleteRow) - if err != nil { - zerolog.Ctx(ctx).Err(err). - Object("portal_key", up.Portal). - Stringer("user_mxid", up.UserMXID). - Msg("Failed to apply logout action") - } else if portalToDelete != nil { - portalsToDelete = append(portalsToDelete, portalToDelete) - } - } - DeleteManyPortals(ctx, portalsToDelete, nil) -} - -func (ul *UserLogin) kickUserFromPortal(ctx context.Context, up *database.UserPortal, badCredentials, deleteRow bool) (*Portal, error) { - portal, action, reason, err := ul.getLogoutAction(ctx, up, badCredentials) - if err != nil { - return nil, err - } else if portal == nil { - return nil, nil - } - zerolog.Ctx(ctx).Debug(). - Str("login_id", string(ul.ID)). - Stringer("user_mxid", ul.UserMXID). - Str("logout_action", string(action)). - Str("action_reason", reason). - Object("portal_key", portal.PortalKey). - Stringer("portal_mxid", portal.MXID). - Msg("Calculated portal action for logout processing") - switch action { - case bridgeconfig.CleanupActionNull, bridgeconfig.CleanupActionNothing: - // do nothing - case bridgeconfig.CleanupActionKick: - _, err = ul.Bridge.Bot.SendState(ctx, portal.MXID, event.StateMember, ul.UserMXID.String(), &event.Content{ - Parsed: &event.MemberEventContent{ - Membership: event.MembershipLeave, - Reason: "Logged out of bridge", - }, - }, time.Time{}) - if err != nil { - return nil, fmt.Errorf("failed to kick user from portal: %w", err) - } - zerolog.Ctx(ctx).Debug(). - Str("login_id", string(ul.ID)). - Stringer("user_mxid", ul.UserMXID). - Stringer("portal_mxid", portal.MXID). - Msg("Kicked user from portal") - if deleteRow { - err = ul.Bridge.DB.UserPortal.Delete(ctx, up) - if err != nil { - zerolog.Ctx(ctx).Warn(). - Str("login_id", string(ul.ID)). - Stringer("user_mxid", ul.UserMXID). - Stringer("portal_mxid", portal.MXID). - Msg("Failed to delete user portal row") - } - } - case bridgeconfig.CleanupActionDelete, bridgeconfig.CleanupActionUnbridge: - // return portal instead of deleting here to allow sorting by depth - return portal, nil - } - return nil, nil -} - -func (ul *UserLogin) getLogoutAction(ctx context.Context, up *database.UserPortal, badCredentials bool) (*Portal, bridgeconfig.CleanupAction, string, error) { - portal, err := ul.Bridge.GetExistingPortalByKey(ctx, up.Portal) - if err != nil { - return nil, bridgeconfig.CleanupActionNull, "", fmt.Errorf("failed to get full portal: %w", err) - } else if portal == nil || portal.MXID == "" { - return nil, bridgeconfig.CleanupActionNull, "portal not found", nil - } - actionsSet := ul.Bridge.Config.CleanupOnLogout.Manual - if badCredentials { - actionsSet = ul.Bridge.Config.CleanupOnLogout.BadCredentials - } - if portal.Receiver != "" { - return portal, actionsSet.Private, "portal has receiver", nil - } - otherUPs, err := ul.Bridge.DB.UserPortal.GetAllInPortal(ctx, portal.PortalKey) - if err != nil { - return portal, bridgeconfig.CleanupActionNull, "", fmt.Errorf("failed to get other logins in portal: %w", err) - } - hasOtherUsers := false - for _, otherUP := range otherUPs { - if otherUP.LoginID == ul.ID { - continue - } - if otherUP.UserMXID == ul.UserMXID { - otherUL := ul.Bridge.GetCachedUserLoginByID(otherUP.LoginID) - if otherUL != nil && otherUL.Client.IsLoggedIn() { - return portal, bridgeconfig.CleanupActionNull, "user has another login in portal", nil - } - } else { - hasOtherUsers = true - } - } - if portal.RelayLoginID != "" { - return portal, actionsSet.Relayed, "portal has relay login", nil - } else if hasOtherUsers { - return portal, actionsSet.SharedHasUsers, "portal has logins of other users", nil - } - return portal, actionsSet.SharedNoUsers, "portal doesn't have logins of other users", nil -} - -func (ul *UserLogin) MarkAsPreferredIn(ctx context.Context, portal *Portal) error { - return ul.Bridge.DB.UserPortal.MarkAsPreferred(ctx, ul.UserLogin, portal.PortalKey) -} - -var _ status.BridgeStateFiller = (*UserLogin)(nil) - -func (ul *UserLogin) FillBridgeState(state status.BridgeState) status.BridgeState { - state.UserID = ul.UserMXID - state.RemoteID = ul.ID - state.RemoteName = ul.RemoteName - state.RemoteProfile = ul.RemoteProfile - filler, ok := ul.Client.(status.BridgeStateFiller) - if ok { - return filler.FillBridgeState(state) - } - return state -} - -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) - } - for { - select { - case <-disconnected: - 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 7062d9b9..ad68e793 100644 --- a/client.go +++ b/client.go @@ -13,18 +13,12 @@ import ( "net/http" "net/url" "os" - "runtime" - "slices" "strconv" - "strings" "sync/atomic" "time" "github.com/rs/zerolog" - "go.mau.fi/util/ptr" - "go.mau.fi/util/random" "go.mau.fi/util/retryafter" - "golang.org/x/exp/maps" "maunium.net/go/mautrix/crypto/backup" "maunium.net/go/mautrix/event" @@ -41,86 +35,53 @@ type CryptoHelper interface { } type VerificationHelper interface { - // Init initializes the helper. This should be called before any other - // methods. Init(context.Context) error - - // StartVerification starts an interactive verification flow with the given - // user via a to-device event. StartVerification(ctx context.Context, to id.UserID) (id.VerificationTransactionID, error) - // StartInRoomVerification starts an interactive verification flow with the - // given user in the given room. StartInRoomVerification(ctx context.Context, roomID id.RoomID, to id.UserID) (id.VerificationTransactionID, error) - - // AcceptVerification accepts a verification request. AcceptVerification(ctx context.Context, txnID id.VerificationTransactionID) error - // DismissVerification dismisses a verification request. This will not send - // a cancellation to the other device. This method should only be called - // *before* the request has been accepted and will error otherwise. - DismissVerification(ctx context.Context, txnID id.VerificationTransactionID) error - // CancelVerification cancels a verification request. This method should - // only be called *after* the request has been accepted, although it will - // not error if called beforehand. CancelVerification(ctx context.Context, txnID id.VerificationTransactionID, code event.VerificationCancelCode, reason string) error - // HandleScannedQRData handles the data from a QR code scan. HandleScannedQRData(ctx context.Context, data []byte) error - // ConfirmQRCodeScanned confirms that our QR code has been scanned. ConfirmQRCodeScanned(ctx context.Context, txnID id.VerificationTransactionID) error - // StartSAS starts a SAS verification flow. StartSAS(ctx context.Context, txnID id.VerificationTransactionID) error - // ConfirmSAS indicates that the user has confirmed that the SAS matches - // SAS shown on the other user's device. ConfirmSAS(ctx context.Context, txnID id.VerificationTransactionID) error } // 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 - ExternalClient *http.Client // The HTTP client used for external (not matrix) media HTTP requests. + 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 Log zerolog.Logger RequestHook func(req *http.Request) - ResponseHook func(req *http.Request, resp *http.Response, err error, duration time.Duration) - - UpdateRequestOnRetry func(req *http.Request, cause error) *http.Request + ResponseHook func(req *http.Request, resp *http.Response, duration time.Duration) SyncPresence event.Presence - SyncTraceLog bool StreamSyncMinAge time.Duration // Number of times that mautrix will retry any HTTP request // if the request fails entirely or returns a HTTP gateway error (502-504) DefaultHTTPRetries int - // Amount of time to wait between HTTP retries, defaults to 4 seconds - DefaultHTTPBackoff time.Duration // 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? // See https://spec.matrix.org/v1.6/application-service-api/#identity-assertion SetAppServiceUserID bool - // Should the org.matrix.msc3202.device_id query parameter be set in requests? - // See https://github.com/matrix-org/matrix-spec-proposals/pull/3202 - SetAppServiceDeviceID bool syncingID uint32 // Identifies the current Sync. Only one Sync can be active at any given time. } @@ -142,12 +103,6 @@ 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, @@ -159,11 +114,10 @@ func DiscoverClientAPIWithClient(ctx context.Context, client *http.Client, serve return nil, err } - if runtime.GOOS != "js" { - req.Header.Set("Accept", "application/json") - req.Header.Set("User-Agent", DefaultUserAgent+" (.well-known fetcher)") - } + 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 @@ -172,15 +126,11 @@ func DiscoverClientAPIWithClient(ctx context.Context, client *http.Client, serve 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(io.LimitReader(resp.Body, WellKnownMaxSize)) + data, err := io.ReadAll(resp.Body) if err != nil { return nil, err - } else if len(data) >= WellKnownMaxSize { - return nil, errors.New(".well-known response too large") } var wellKnown ClientWellKnown @@ -247,20 +197,14 @@ func (cli *Client) SyncWithContext(ctx context.Context) error { } } lastSuccessfulSync := time.Now().Add(-cli.StreamSyncMinAge - 1*time.Hour) - // Always do first sync with 0 timeout - isFailing := true for { streamResp := false if cli.StreamSyncMinAge > 0 && time.Since(lastSuccessfulSync) > cli.StreamSyncMinAge { cli.Log.Debug().Msg("Last sync is old, will stream next response") streamResp = true } - timeout := 30000 - if isFailing || nextBatch == "" { - timeout = 0 - } resSync, err := cli.FullSyncRequest(ctx, ReqSync{ - Timeout: timeout, + Timeout: 30000, Since: nextBatch, FilterID: filterID, FullState: false, @@ -268,7 +212,6 @@ func (cli *Client) SyncWithContext(ctx context.Context) error { StreamResponse: streamResp, }) if err != nil { - isFailing = true if ctx.Err() != nil { return ctx.Err() } @@ -276,9 +219,6 @@ func (cli *Client) SyncWithContext(ctx context.Context) error { if err2 != nil { return err2 } - if duration <= 0 { - continue - } select { case <-ctx.Done(): return ctx.Err() @@ -286,7 +226,6 @@ func (cli *Client) SyncWithContext(ctx context.Context) error { continue } } - isFailing = false lastSuccessfulSync = time.Now() // Check that the syncing state hasn't changed @@ -330,38 +269,21 @@ type contextKey int const ( LogBodyContextKey contextKey = iota LogRequestIDContextKey - MaxAttemptsContextKey - SyncTokenContextKey ) func (cli *Client) RequestStart(req *http.Request) { - if cli != nil && cli.RequestHook != nil { + if 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() - } else if err != nil { + if err != nil { evt = zerolog.Ctx(req.Context()).Err(err) } else if handlerErr != nil { evt = zerolog.Ctx(req.Context()).Warn(). AnErr("body_parse_err", handlerErr) - } else if cli.SyncTraceLog && strings.HasSuffix(req.URL.Path, "/_matrix/client/v3/sync") { - evt = zerolog.Ctx(req.Context()).Trace() } else { evt = zerolog.Ctx(req.Context()).Debug() } @@ -369,10 +291,10 @@ func (cli *Client) LogRequestDone(req *http.Request, resp *http.Response, err er Str("method", req.Method). Str("url", req.URL.String()). Dur("duration", duration) - if cli.ResponseHook != nil { - cli.ResponseHook(req, resp, err, duration) - } if resp != nil { + if cli.ResponseHook != nil { + cli.ResponseHook(req, resp, duration) + } mime := resp.Header.Get("Content-Type") length := resp.ContentLength if length == -1 && contentLength > 0 { @@ -386,18 +308,9 @@ func (cli *Client) LogRequestDone(req *http.Request, resp *http.Response, err er } } if body := req.Context().Value(LogBodyContextKey); body != nil { - 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)) - } + evt.Interface("req_body", body) } - if errors.Is(err, context.Canceled) { - evt.Msg("Request canceled") - } else if err != nil { + if err != nil { evt.Msg("Request failed") } else if handlerErr != nil { evt.Msg("Request parsing failed") @@ -406,47 +319,33 @@ func (cli *Client) LogRequestDone(req *http.Request, resp *http.Response, err er } } -func (cli *Client) MakeRequest(ctx context.Context, method string, httpURL string, reqBody any, resBody any) ([]byte, error) { +func (cli *Client) MakeRequest(ctx context.Context, method string, httpURL string, reqBody interface{}, resBody interface{}) ([]byte, error) { return cli.MakeFullRequest(ctx, FullRequest{Method: method, URL: httpURL, RequestJSON: reqBody, ResponseJSON: resBody}) } -type ClientResponseHandler = func(req *http.Request, res *http.Response, responseJSON any, sizeLimit int64) ([]byte, error) +type ClientResponseHandler = func(req *http.Request, res *http.Response, responseJSON interface{}) ([]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 - ResponseSizeLimit int64 - 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 + SensitiveContent bool + Handler ClientResponseHandler + Logger *zerolog.Logger } 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 - var reqBody io.Reader - var reqLen int64 + reqBody := params.RequestBody if params.RequestJSON != nil { jsonStr, err := json.Marshal(params.RequestJSON) if err != nil { @@ -457,38 +356,29 @@ 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
deleted file mode 100644
index a86c726b..00000000
--- a/event/capabilities.go
+++ /dev/null
@@ -1,414 +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 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
deleted file mode 100644
index ce07c4c0..00000000
--- a/event/cmdschema/content.go
+++ /dev/null
@@ -1,78 +0,0 @@
-// 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
deleted file mode 100644
index 4193b297..00000000
--- a/event/cmdschema/parameter.go
+++ /dev/null
@@ -1,286 +0,0 @@
-// 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
deleted file mode 100644
index 92e69b60..00000000
--- a/event/cmdschema/parse.go
+++ /dev/null
@@ -1,478 +0,0 @@
-// 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
deleted file mode 100644
index 1e0d1817..00000000
--- a/event/cmdschema/parse_test.go
+++ /dev/null
@@ -1,118 +0,0 @@
-// 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
deleted file mode 100644
index 98c421fc..00000000
--- a/event/cmdschema/roomid.go
+++ /dev/null
@@ -1,135 +0,0 @@
-// 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
deleted file mode 100644
index c5c57c53..00000000
--- a/event/cmdschema/stringify.go
+++ /dev/null
@@ -1,122 +0,0 @@
-// 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
deleted file mode 100644
index e53382db..00000000
--- a/event/cmdschema/testdata/commands.schema.json
+++ /dev/null
@@ -1,281 +0,0 @@
-{
- "$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
deleted file mode 100644
index 6ce1f4da..00000000
--- a/event/cmdschema/testdata/commands/flags.json
+++ /dev/null
@@ -1,126 +0,0 @@
-{
- "$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
deleted file mode 100644
index 1351c292..00000000
--- a/event/cmdschema/testdata/commands/room_id_or_alias.json
+++ /dev/null
@@ -1,85 +0,0 @@
-{
- "$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
deleted file mode 100644
index aa266054..00000000
--- a/event/cmdschema/testdata/commands/room_reference_list.json
+++ /dev/null
@@ -1,106 +0,0 @@
-{
- "$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
deleted file mode 100644
index 94667323..00000000
--- a/event/cmdschema/testdata/commands/simple.json
+++ /dev/null
@@ -1,46 +0,0 @@
-{
- "$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
deleted file mode 100644
index 9782f8ec..00000000
--- a/event/cmdschema/testdata/commands/tail.json
+++ /dev/null
@@ -1,60 +0,0 @@
-{
- "$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/event/cmdschema/testdata/data.go b/event/cmdschema/testdata/data.go
deleted file mode 100644
index eceea3d2..00000000
--- a/event/cmdschema/testdata/data.go
+++ /dev/null
@@ -1,14 +0,0 @@
-// 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 testdata
-
-import (
- "embed"
-)
-
-//go:embed *
-var FS embed.FS
diff --git a/event/cmdschema/testdata/parse_quote.json b/event/cmdschema/testdata/parse_quote.json
deleted file mode 100644
index 8f52b7f5..00000000
--- a/event/cmdschema/testdata/parse_quote.json
+++ /dev/null
@@ -1,30 +0,0 @@
-[
- {"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
deleted file mode 100644
index 9f249116..00000000
--- a/event/cmdschema/testdata/parse_quote.schema.json
+++ /dev/null
@@ -1,46 +0,0 @@
-{
- "$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 814aeec4..bdb3eeb8 100644
--- a/event/content.go
+++ b/event/content.go
@@ -18,7 +18,6 @@ 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{}),
@@ -39,20 +38,7 @@ var TypeMap = map[Type]reflect.Type{
StateHalfShotBridge: reflect.TypeOf(BridgeEventContent{}),
StateSpaceParent: reflect.TypeOf(SpaceParentEventContent{}),
StateSpaceChild: reflect.TypeOf(SpaceChildEventContent{}),
-
- StateRoomPolicy: reflect.TypeOf(RoomPolicyEventContent{}),
- StateUnstableRoomPolicy: reflect.TypeOf(RoomPolicyEventContent{}),
-
- StateLegacyPolicyRoom: reflect.TypeOf(ModPolicyContent{}),
- StateLegacyPolicyServer: reflect.TypeOf(ModPolicyContent{}),
- StateLegacyPolicyUser: reflect.TypeOf(ModPolicyContent{}),
- StateUnstablePolicyRoom: reflect.TypeOf(ModPolicyContent{}),
- StateUnstablePolicyServer: reflect.TypeOf(ModPolicyContent{}),
- StateUnstablePolicyUser: reflect.TypeOf(ModPolicyContent{}),
-
- StateElementFunctionalMembers: reflect.TypeOf(ElementFunctionalMembersContent{}),
- StateBeeperRoomFeatures: reflect.TypeOf(RoomFeatures{}),
- StateBeeperDisappearingTimer: reflect.TypeOf(BeeperDisappearingTimer{}),
+ StateInsertionMarker: reflect.TypeOf(InsertionMarkerContent{}),
EventMessage: reflect.TypeOf(MessageEventContent{}),
EventSticker: reflect.TypeOf(MessageEventContent{}),
@@ -60,27 +46,16 @@ var TypeMap = map[Type]reflect.Type{
EventRedaction: reflect.TypeOf(RedactionEventContent{}),
EventReaction: reflect.TypeOf(ReactionEventContent{}),
- EventUnstablePollStart: reflect.TypeOf(PollStartEventContent{}),
- EventUnstablePollResponse: reflect.TypeOf(PollResponseEventContent{}),
-
- BeeperMessageStatus: reflect.TypeOf(BeeperMessageStatusEventContent{}),
- BeeperTranscription: reflect.TypeOf(BeeperTranscriptionEventContent{}),
- BeeperDeleteChat: reflect.TypeOf(BeeperChatDeleteEventContent{}),
- BeeperAcceptMessageRequest: reflect.TypeOf(BeeperAcceptMessageRequestEventContent{}),
- BeeperSendState: reflect.TypeOf(BeeperSendStateEventContent{}),
+ BeeperMessageStatus: reflect.TypeOf(BeeperMessageStatusEventContent{}),
AccountDataRoomTags: reflect.TypeOf(TagEventContent{}),
AccountDataDirectChats: reflect.TypeOf(DirectChatsEventContent{}),
AccountDataFullyRead: reflect.TypeOf(FullyReadEventContent{}),
AccountDataIgnoredUserList: reflect.TypeOf(IgnoredUserListEventContent{}),
- AccountDataMarkedUnread: reflect.TypeOf(MarkedUnreadEventContent{}),
- AccountDataBeeperMute: reflect.TypeOf(BeeperMuteEventContent{}),
- EphemeralEventTyping: reflect.TypeOf(TypingEventContent{}),
- EphemeralEventReceipt: reflect.TypeOf(ReceiptEventContent{}),
- EphemeralEventPresence: reflect.TypeOf(PresenceEventContent{}),
- EphemeralEventEncrypted: reflect.TypeOf(EncryptedEventContent{}),
- BeeperEphemeralEventAIStream: reflect.TypeOf(BeeperAIStreamEventContent{}),
+ EphemeralEventTyping: reflect.TypeOf(TypingEventContent{}),
+ EphemeralEventReceipt: reflect.TypeOf(ReceiptEventContent{}),
+ EphemeralEventPresence: reflect.TypeOf(PresenceEventContent{}),
InRoomVerificationReady: reflect.TypeOf(VerificationReadyEventContent{}),
InRoomVerificationStart: reflect.TypeOf(VerificationStartEventContent{}),
@@ -132,7 +107,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, then only the other is used. If both (Parsed and Raw) are nil, VeryRaw is used instead.
+// If one of them is nil, the 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{}
@@ -199,13 +174,6 @@ 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
@@ -243,7 +211,6 @@ func init() {
gob.Register(&BridgeEventContent{})
gob.Register(&SpaceChildEventContent{})
gob.Register(&SpaceParentEventContent{})
- gob.Register(&ElementFunctionalMembersContent{})
gob.Register(&RoomNameEventContent{})
gob.Register(&RoomAvatarEventContent{})
gob.Register(&TopicEventContent{})
@@ -271,15 +238,6 @@ func init() {
gob.Register(&RoomKeyWithheldEventContent{})
}
-func CastOrDefault[T any](content *Content) *T {
- casted, ok := content.Parsed.(*T)
- if ok {
- return casted
- }
- casted2, _ := content.Parsed.(T)
- return &casted2
-}
-
// Helper cast functions below
func (content *Content) AsMember() *MemberEventContent {
@@ -394,13 +352,6 @@ func (content *Content) AsSpaceParent() *SpaceParentEventContent {
}
return casted
}
-func (content *Content) AsElementFunctionalMembers() *ElementFunctionalMembersContent {
- casted, ok := content.Parsed.(*ElementFunctionalMembersContent)
- if !ok {
- return &ElementFunctionalMembersContent{}
- }
- return casted
-}
func (content *Content) AsMessage() *MessageEventContent {
casted, ok := content.Parsed.(*MessageEventContent)
if !ok {
@@ -457,13 +408,6 @@ func (content *Content) AsIgnoredUserList() *IgnoredUserListEventContent {
}
return casted
}
-func (content *Content) AsMarkedUnread() *MarkedUnreadEventContent {
- casted, ok := content.Parsed.(*MarkedUnreadEventContent)
- if !ok {
- return &MarkedUnreadEventContent{}
- }
- return casted
-}
func (content *Content) AsTyping() *TypingEventContent {
casted, ok := content.Parsed.(*TypingEventContent)
if !ok {
diff --git a/event/delayed.go b/event/delayed.go
deleted file mode 100644
index fefb62af..00000000
--- a/event/delayed.go
+++ /dev/null
@@ -1,70 +0,0 @@
-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 c60cb91a..cf9c2814 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 fmt.Errorf("ciphertext %w", id.ErrInputNotJSONString)
+ return id.InputNotJSONString
}
content.MegolmCiphertext = content.Ciphertext[1 : len(content.Ciphertext)-1]
}
@@ -132,9 +132,8 @@ type RoomKeyRequestEventContent struct {
type RequestedKeyInfo struct {
Algorithm id.Algorithm `json:"algorithm"`
RoomID id.RoomID `json:"room_id"`
- SessionID id.SessionID `json:"session_id"`
- // Deprecated: Matrix v1.3
SenderKey id.SenderKey `json:"sender_key"`
+ SessionID id.SessionID `json:"session_id"`
}
type RoomKeyWithheldCode string
diff --git a/event/events.go b/event/events.go
index 72c1e161..f7b4d4d6 100644
--- a/event/events.go
+++ b/event/events.go
@@ -118,9 +118,6 @@ 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 {
@@ -130,29 +127,27 @@ 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"`
- 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"`
+ 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"`
- 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"`
+ BeeperHSOrder int64 `json:"com.beeper.hs.order,omitempty"`
}
func (us *Unsigned) IsEmpty() bool {
- 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.BeeperHSOrderString.IsZero() &&
- !us.ElementSoftFailed
+ return us.PrevContent == nil && us.PrevSender == "" && us.ReplacesState == "" && us.Age == 0 &&
+ us.TransactionID == "" && us.RedactedBecause == nil && us.InviteRoomState == nil && us.Relations == nil
}
diff --git a/event/member.go b/event/member.go
index 9956a36b..ebafdcb7 100644
--- a/event/member.go
+++ b/event/member.go
@@ -7,6 +7,8 @@
package event
import (
+ "encoding/json"
+
"maunium.net/go/mautrix/id"
)
@@ -33,37 +35,19 @@ 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"`
- 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"`
+ 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"`
}
type ThirdPartyInvite struct {
- 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"`
+ DisplayName string `json:"display_name"`
+ Signed struct {
+ Token string `json:"token"`
+ Signatures json.RawMessage `json:"signatures"`
+ MXID string `json:"mxid"`
+ }
}
diff --git a/event/message.go b/event/message.go
index 3fb3dc82..d8b27c3d 100644
--- a/event/message.go
+++ b/event/message.go
@@ -8,11 +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"
)
@@ -21,24 +21,6 @@ import (
// https://spec.matrix.org/v1.2/client-server-api/#mroommessage-msgtypes
type MessageType string
-func (mt MessageType) IsText() bool {
- switch mt {
- case MsgText, MsgNotice, MsgEmote:
- return true
- default:
- return false
- }
-}
-
-func (mt MessageType) IsMedia() bool {
- switch mt {
- case MsgImage, MsgVideo, MsgAudio, MsgFile, CapMsgSticker:
- return true
- default:
- return false
- }
-}
-
// Msgtypes
const (
MsgText MessageType = "m.text"
@@ -130,68 +112,12 @@ type MessageEventContent struct {
replyFallbackRemoved bool
- MessageSendRetry *BeeperRetryMetadata `json:"com.beeper.message_send_retry,omitempty"`
- BeeperGalleryImages []*MessageEventContent `json:"com.beeper.gallery.images,omitempty"`
- 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"`
+ MessageSendRetry *BeeperRetryMetadata `json:"com.beeper.message_send_retry,omitempty"`
+ BeeperGalleryImages []*MessageEventContent `json:"com.beeper.gallery.images,omitempty"`
+ BeeperGalleryCaption string `json:"com.beeper.gallery.caption,omitempty"`
+ BeeperGalleryCaptionHTML string `json:"com.beeper.gallery.caption_html,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 {
- if content.FileName != "" {
- return content.FileName
- }
- return content.Body
-}
-
-func (content *MessageEventContent) GetCaption() string {
- if content.FileName != "" && content.Body != "" && content.Body != content.FileName {
- return content.Body
- }
- return ""
-}
-
-func (content *MessageEventContent) GetFormattedCaption() string {
- if content.Format == FormatHTML && content.FormattedBody != "" {
- return content.FormattedBody
- }
- return ""
}
func (content *MessageEventContent) GetRelatesTo() *RelatesTo {
@@ -215,7 +141,6 @@ 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
}
@@ -266,56 +191,24 @@ type Mentions struct {
Room bool `json:"room,omitempty"`
}
-func (m *Mentions) Add(userID id.UserID) {
- if userID != "" && !slices.Contains(m.UserIDs, userID) {
- m.UserIDs = append(m.UserIDs, userID)
- }
-}
-
-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
- ThumbnailInfo *FileInfo
- ThumbnailURL id.ContentURIString
- ThumbnailFile *EncryptedFileInfo
+ MimeType string `json:"mimetype,omitempty"`
+ ThumbnailInfo *FileInfo `json:"thumbnail_info,omitempty"`
+ ThumbnailURL id.ContentURIString `json:"thumbnail_url,omitempty"`
+ ThumbnailFile *EncryptedFileInfo `json:"thumbnail_file,omitempty"`
- Blurhash string
- AnoaBlurhash string
+ Blurhash string `json:"blurhash,omitempty"`
+ AnoaBlurhash string `json:"xyz.amorgan.blurhash,omitempty"`
- MauGIF bool
- IsAnimated bool
-
- Width int
- Height int
- Duration int
- Size int
+ Width int `json:"-"`
+ Height int `json:"-"`
+ Duration int `json:"-"`
+ Size int `json:"-"`
}
type serializableFileInfo struct {
@@ -327,9 +220,6 @@ 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"`
@@ -346,9 +236,6 @@ 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,
}
@@ -377,8 +264,6 @@ 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 c721df35..562a6622 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.NoError(t, err)
+ assert.Nil(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.Error(t, err)
+ assert.NotNil(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.NoError(t, err)
+ assert.Nil(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.NoError(t, err)
+ assert.Nil(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.NoError(t, err)
+ assert.Nil(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.NoError(t, err)
+ assert.Nil(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.NoError(t, err)
+ assert.Nil(t, err)
assert.Equal(t, expectedCustomMarshalResult, string(data))
}
diff --git a/event/poll.go b/event/poll.go
deleted file mode 100644
index 9082f65e..00000000
--- a/event/poll.go
+++ /dev/null
@@ -1,64 +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 event
-
-type PollResponseEventContent struct {
- RelatesTo RelatesTo `json:"m.relates_to"`
- Response struct {
- Answers []string `json:"answers"`
- } `json:"org.matrix.msc3381.poll.response"`
-}
-
-func (content *PollResponseEventContent) GetRelatesTo() *RelatesTo {
- return &content.RelatesTo
-}
-
-func (content *PollResponseEventContent) OptionalGetRelatesTo() *RelatesTo {
- if content.RelatesTo.Type == "" {
- return nil
- }
- return &content.RelatesTo
-}
-
-func (content *PollResponseEventContent) SetRelatesTo(rel *RelatesTo) {
- content.RelatesTo = *rel
-}
-
-type MSC1767Message struct {
- 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,omitempty"`
- Mentions *Mentions `json:"m.mentions,omitempty"`
- PollStart struct {
- Kind string `json:"kind"`
- MaxSelections int `json:"max_selections"`
- Question MSC1767Message `json:"question"`
- Answers []struct {
- ID string `json:"id"`
- MSC1767Message
- } `json:"answers"`
- } `json:"org.matrix.msc3381.poll.start"`
-}
-
-func (content *PollStartEventContent) GetRelatesTo() *RelatesTo {
- if content.RelatesTo == nil {
- content.RelatesTo = &RelatesTo{}
- }
- return content.RelatesTo
-}
-
-func (content *PollStartEventContent) OptionalGetRelatesTo() *RelatesTo {
- return content.RelatesTo
-}
-
-func (content *PollStartEventContent) SetRelatesTo(rel *RelatesTo) {
- content.RelatesTo = rel
-}
diff --git a/event/powerlevels.go b/event/powerlevels.go
index 668eb6d3..91d56611 100644
--- a/event/powerlevels.go
+++ b/event/powerlevels.go
@@ -7,13 +7,8 @@
package event
import (
- "math"
- "slices"
"sync"
- "go.mau.fi/util/ptr"
- "golang.org/x/exp/maps"
-
"maunium.net/go/mautrix/id"
)
@@ -28,9 +23,6 @@ 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"`
@@ -39,12 +31,25 @@ 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"`
+func copyPtr(ptr *int) *int {
+ if ptr == nil {
+ return nil
+ }
+ val := *ptr
+ return &val
+}
- // 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 copyMap[Key comparable](m map[Key]int) map[Key]int {
+ if m == nil {
+ return nil
+ }
+ copied := make(map[Key]int, len(m))
+ for k, v := range m {
+ copied[k] = v
+ }
+ return copied
}
func (pl *PowerLevelsEventContent) Clone() *PowerLevelsEventContent {
@@ -52,23 +57,18 @@ func (pl *PowerLevelsEventContent) Clone() *PowerLevelsEventContent {
return nil
}
return &PowerLevelsEventContent{
- Users: maps.Clone(pl.Users),
+ Users: copyMap(pl.Users),
UsersDefault: pl.UsersDefault,
- Events: maps.Clone(pl.Events),
+ Events: copyMap(pl.Events),
EventsDefault: pl.EventsDefault,
- BeeperEphemeral: maps.Clone(pl.BeeperEphemeral),
- StateDefaultPtr: ptr.Clone(pl.StateDefaultPtr),
+ StateDefaultPtr: copyPtr(pl.StateDefaultPtr),
Notifications: pl.Notifications.Clone(),
- InvitePtr: ptr.Clone(pl.InvitePtr),
- KickPtr: ptr.Clone(pl.KickPtr),
- BanPtr: ptr.Clone(pl.BanPtr),
- RedactPtr: ptr.Clone(pl.RedactPtr),
-
- BeeperEphemeralDefaultPtr: ptr.Clone(pl.BeeperEphemeralDefaultPtr),
-
- CreateEvent: pl.CreateEvent,
+ InvitePtr: copyPtr(pl.InvitePtr),
+ KickPtr: copyPtr(pl.KickPtr),
+ BanPtr: copyPtr(pl.BanPtr),
+ RedactPtr: copyPtr(pl.RedactPtr),
}
}
@@ -81,7 +81,7 @@ func (npl *NotificationPowerLevels) Clone() *NotificationPowerLevels {
return nil
}
return &NotificationPowerLevels{
- RoomPtr: ptr.Clone(npl.RoomPtr),
+ RoomPtr: copyPtr(npl.RoomPtr),
}
}
@@ -96,7 +96,7 @@ func (pl *PowerLevelsEventContent) Invite() int {
if pl.InvitePtr != nil {
return *pl.InvitePtr
}
- return 0
+ return 50
}
func (pl *PowerLevelsEventContent) Kick() int {
@@ -127,17 +127,7 @@ 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]
@@ -147,58 +137,20 @@ 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 {
- if pl.Users == nil {
- pl.Users = make(map[id.UserID]int)
- }
pl.Users[userID] = level
}
}
-func (pl *PowerLevelsEventContent) EnsureUserLevel(target id.UserID, level int) bool {
- 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 != "" && !pl.isCreator(actor) {
- actorLevel := pl.GetUserLevel(actor)
- if actorLevel <= existingLevel || actorLevel < level {
- return false
- }
- }
+func (pl *PowerLevelsEventContent) EnsureUserLevel(userID id.UserID, level int) bool {
+ existingLevel := pl.GetUserLevel(userID)
if existingLevel != level {
- pl.SetUserLevel(target, level)
+ pl.SetUserLevel(userID, level)
return true
}
return false
@@ -217,54 +169,18 @@ 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()
if (eventType.IsState() && level == pl.StateDefault()) || (!eventType.IsState() && level == pl.EventsDefault) {
delete(pl.Events, eventType.String())
} else {
- if pl.Events == nil {
- pl.Events = make(map[string]int)
- }
pl.Events[eventType.String()] = level
}
}
func (pl *PowerLevelsEventContent) EnsureEventLevel(eventType Type, level int) bool {
- return pl.EnsureEventLevelAs("", eventType, level)
-}
-
-func (pl *PowerLevelsEventContent) EnsureEventLevelAs(actor id.UserID, eventType Type, level int) bool {
existingLevel := pl.GetEventLevel(eventType)
- if actor != "" && !pl.isCreator(actor) {
- actorLevel := pl.GetUserLevel(actor)
- if existingLevel > actorLevel || level > actorLevel {
- return false
- }
- }
if existingLevel != level {
pl.SetEventLevel(eventType, level)
return true
diff --git a/event/powerlevels_ephemeral_test.go b/event/powerlevels_ephemeral_test.go
deleted file mode 100644
index f5861583..00000000
--- a/event/powerlevels_ephemeral_test.go
+++ /dev/null
@@ -1,67 +0,0 @@
-// 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 2316cbc7..ecd7a959 100644
--- a/event/relations.go
+++ b/event/relations.go
@@ -15,11 +15,10 @@ import (
type RelationType string
const (
- RelReplace RelationType = "m.replace"
- RelReference RelationType = "m.reference"
- RelAnnotation RelationType = "m.annotation"
- RelThread RelationType = "m.thread"
- RelBeeperTranscription RelationType = "com.beeper.transcription"
+ RelReplace RelationType = "m.replace"
+ RelReference RelationType = "m.reference"
+ RelAnnotation RelationType = "m.annotation"
+ RelThread RelationType = "m.thread"
)
type RelatesTo struct {
@@ -34,7 +33,7 @@ type RelatesTo struct {
type InReplyTo struct {
EventID id.EventID `json:"event_id,omitempty"`
- UnstableRoomID id.RoomID `json:"com.beeper.cross_room_id,omitempty"`
+ UnstableRoomID id.RoomID `json:"room_id,omitempty"`
}
func (rel *RelatesTo) Copy() *RelatesTo {
@@ -74,7 +73,7 @@ func (rel *RelatesTo) GetReplyTo() id.EventID {
}
func (rel *RelatesTo) GetNonFallbackReplyTo() id.EventID {
- if rel != nil && rel.InReplyTo != nil && (rel.Type != RelThread || !rel.IsFallingBack) {
+ if rel != nil && rel.InReplyTo != nil && !rel.IsFallingBack {
return rel.InReplyTo.EventID
}
return ""
@@ -101,10 +100,6 @@ 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 5f55bb80..73f8cfc7 100644
--- a/event/reply.go
+++ b/event/reply.go
@@ -1,4 +1,4 @@
-// Copyright (c) 2024 Tulir Asokan
+// Copyright (c) 2020 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,6 +7,7 @@
package event
import (
+ "fmt"
"regexp"
"strings"
@@ -32,13 +33,12 @@ func TrimReplyFallbackText(text string) string {
}
func (content *MessageEventContent) RemoveReplyFallback() {
- 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
+ if len(content.RelatesTo.GetReplyTo()) > 0 && !content.replyFallbackRemoved {
+ if content.Format == FormatHTML {
+ content.FormattedBody = TrimReplyFallbackHTML(content.FormattedBody)
}
+ content.Body = TrimReplyFallbackText(content.Body)
+ content.replyFallbackRemoved = true
}
}
@@ -47,28 +47,52 @@ func (content *MessageEventContent) GetReplyTo() id.EventID {
return content.RelatesTo.GetReplyTo()
}
-func (content *MessageEventContent) SetReply(inReplyTo *Event) {
- if content.RelatesTo == nil {
- content.RelatesTo = &RelatesTo{}
+const ReplyFormat = `In reply to %s
%s
"
@@ -42,55 +39,6 @@ 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)
@@ -101,30 +49,20 @@ func RenderMarkdownCustom(text string, renderer goldmark.Markdown) event.Message
return HTMLToContent(htmlBody)
}
-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)
+func HTMLToContent(html string) event.MessageEventContent {
+ text := HTMLToMarkdown(html)
if html != text {
return event.MessageEventContent{
FormattedBody: html,
Format: event.FormatHTML,
MsgType: event.MsgText,
Body: text,
- Mentions: mentions,
}
}
- return TextToContent(text)
-}
-
-func HTMLToContent(html string) event.MessageEventContent {
- return HTMLToContentFull(nil, html)
+ return event.MessageEventContent{
+ MsgType: event.MsgText,
+ Body: text,
+ }
}
func RenderMarkdown(text string, allowMarkdown, allowHTML bool) event.MessageEventContent {
@@ -140,6 +78,9 @@ func RenderMarkdown(text string, allowMarkdown, allowHTML bool) event.MessageEve
htmlBody = strings.Replace(text, "\n", "
", -1)
return HTMLToContent(htmlBody)
} else {
- return TextToContent(text)
+ return event.MessageEventContent{
+ MsgType: event.MsgText,
+ Body: text,
+ }
}
}
diff --git a/format/markdown_test.go b/format/markdown_test.go
index 46ea4886..179de6b6 100644
--- a/format/markdown_test.go
+++ b/format/markdown_test.go
@@ -17,20 +17,17 @@ import (
"maunium.net/go/mautrix/event"
"maunium.net/go/mautrix/format"
"maunium.net/go/mautrix/format/mdext"
- "maunium.net/go/mautrix/id"
)
func TestRenderMarkdown_PlainText(t *testing.T) {
content := format.RenderMarkdown("hello world", true, true)
- assert.Equal(t, event.MessageEventContent{MsgType: event.MsgText, Body: "hello world", Mentions: &event.Mentions{}}, content)
+ assert.Equal(t, event.MessageEventContent{MsgType: event.MsgText, Body: "hello world"}, content)
content = format.RenderMarkdown("hello world", true, false)
- assert.Equal(t, event.MessageEventContent{MsgType: event.MsgText, Body: "hello world", Mentions: &event.Mentions{}}, content)
+ assert.Equal(t, event.MessageEventContent{MsgType: event.MsgText, Body: "hello world"}, content)
content = format.RenderMarkdown("hello world", false, true)
- assert.Equal(t, event.MessageEventContent{MsgType: event.MsgText, Body: "hello world", Mentions: &event.Mentions{}}, content)
+ assert.Equal(t, event.MessageEventContent{MsgType: event.MsgText, Body: "hello world"}, content)
content = format.RenderMarkdown("hello world", false, false)
- assert.Equal(t, event.MessageEventContent{MsgType: event.MsgText, Body: "hello world", Mentions: &event.Mentions{}}, content)
- content = format.RenderMarkdown(`mention`, false, false)
- assert.Equal(t, event.MessageEventContent{MsgType: event.MsgText, Body: "mention", Mentions: &event.Mentions{}}, content)
+ assert.Equal(t, event.MessageEventContent{MsgType: event.MsgText, Body: "hello world"}, content)
}
func TestRenderMarkdown_EscapeHTML(t *testing.T) {
@@ -40,7 +37,6 @@ func TestRenderMarkdown_EscapeHTML(t *testing.T) {
Body: "hello world",
Format: event.FormatHTML,
FormattedBody: "<b>hello world</b>",
- Mentions: &event.Mentions{},
}, content)
}
@@ -51,7 +47,6 @@ func TestRenderMarkdown_HTML(t *testing.T) {
Body: "**hello world**",
Format: event.FormatHTML,
FormattedBody: "hello world",
- Mentions: &event.Mentions{},
}, content)
content = format.RenderMarkdown("hello world", true, true)
@@ -60,18 +55,6 @@ func TestRenderMarkdown_HTML(t *testing.T) {
Body: "**hello world**",
Format: event.FormatHTML,
FormattedBody: "hello world",
- Mentions: &event.Mentions{},
- }, content)
-
- content = format.RenderMarkdown(`[mention](https://matrix.to/#/@user:example.com)`, true, false)
- assert.Equal(t, event.MessageEventContent{
- MsgType: event.MsgText,
- Body: "mention",
- Format: event.FormatHTML,
- FormattedBody: `mention`,
- Mentions: &event.Mentions{
- UserIDs: []id.UserID{"@user:example.com"},
- },
}, content)
}
@@ -158,56 +141,3 @@ 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
deleted file mode 100644
index 2884a5ea..00000000
--- a/format/mdext/customemoji.go
+++ /dev/null
@@ -1,73 +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 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/indentableparagraph.go b/format/mdext/indentableparagraph.go
deleted file mode 100644
index a6ebd6c0..00000000
--- a/format/mdext/indentableparagraph.go
+++ /dev/null
@@ -1,28 +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 mdext
-
-import (
- "github.com/yuin/goldmark"
- "github.com/yuin/goldmark/parser"
- "github.com/yuin/goldmark/util"
-)
-
-// indentableParagraphParser is the default paragraph parser with CanAcceptIndentedLine.
-// Used when disabling CodeBlockParser (as disabling it without a replacement will make indented blocks disappear).
-type indentableParagraphParser struct {
- parser.BlockParser
-}
-
-var defaultIndentableParagraphParser = &indentableParagraphParser{BlockParser: parser.NewParagraphParser()}
-
-func (b *indentableParagraphParser) CanAcceptIndentedLine() bool {
- return true
-}
-
-// FixIndentedParagraphs is a goldmark option which fixes indented paragraphs when disabling CodeBlockParser.
-var FixIndentedParagraphs = goldmark.WithParserOptions(parser.WithBlockParsers(util.Prioritized(defaultIndentableParagraphParser, 500)))
diff --git a/format/mdext/math.go b/format/mdext/math.go
deleted file mode 100644
index e6a6ecc5..00000000
--- a/format/mdext/math.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 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/shortemphasis.go b/format/mdext/shortemphasis.go
deleted file mode 100644
index 62190326..00000000
--- a/format/mdext/shortemphasis.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 mdext
-
-import (
- "github.com/yuin/goldmark"
- "github.com/yuin/goldmark/ast"
- "github.com/yuin/goldmark/parser"
- "github.com/yuin/goldmark/text"
- "github.com/yuin/goldmark/util"
-)
-
-var ShortEmphasis goldmark.Extender = &shortEmphasisExtender{}
-
-type shortEmphasisExtender struct{}
-
-func (s *shortEmphasisExtender) Extend(m goldmark.Markdown) {
- m.Parser().AddOptions(parser.WithInlineParsers(
- util.Prioritized(&italicsParser{}, 500),
- util.Prioritized(&boldParser{}, 500),
- ))
-}
-
-type italicsDelimiterProcessor struct{}
-
-func (p *italicsDelimiterProcessor) IsDelimiter(b byte) bool {
- return b == '_'
-}
-
-func (p *italicsDelimiterProcessor) CanOpenCloser(opener, closer *parser.Delimiter) bool {
- return opener.Char == closer.Char
-}
-
-func (p *italicsDelimiterProcessor) OnMatch(consumes int) ast.Node {
- return ast.NewEmphasis(1)
-}
-
-var defaultItalicsDelimiterProcessor = &italicsDelimiterProcessor{}
-
-type italicsParser struct{}
-
-func (s *italicsParser) Trigger() []byte {
- return []byte{'_'}
-}
-
-func (s *italicsParser) Parse(parent ast.Node, block text.Reader, pc parser.Context) ast.Node {
- before := block.PrecendingCharacter()
- line, segment := block.PeekLine()
- node := parser.ScanDelimiter(line, before, 1, defaultItalicsDelimiterProcessor)
- if node == nil || node.OriginalLength > 1 || before == '_' {
- return nil
- }
- node.Segment = segment.WithStop(segment.Start + node.OriginalLength)
- block.Advance(node.OriginalLength)
- pc.PushDelimiter(node)
- return node
-}
-
-type boldDelimiterProcessor struct{}
-
-func (p *boldDelimiterProcessor) IsDelimiter(b byte) bool {
- return b == '*'
-}
-
-func (p *boldDelimiterProcessor) CanOpenCloser(opener, closer *parser.Delimiter) bool {
- return opener.Char == closer.Char
-}
-
-func (p *boldDelimiterProcessor) OnMatch(consumes int) ast.Node {
- return ast.NewEmphasis(2)
-}
-
-var defaultBoldDelimiterProcessor = &boldDelimiterProcessor{}
-
-type boldParser struct{}
-
-func (s *boldParser) Trigger() []byte {
- return []byte{'*'}
-}
-
-func (s *boldParser) Parse(parent ast.Node, block text.Reader, pc parser.Context) ast.Node {
- before := block.PrecendingCharacter()
- line, segment := block.PeekLine()
- node := parser.ScanDelimiter(line, before, 1, defaultBoldDelimiterProcessor)
- if node == nil || node.OriginalLength > 1 || before == '*' {
- return nil
- }
- node.Segment = segment.WithStop(segment.Start + node.OriginalLength)
- block.Advance(node.OriginalLength)
- pc.PushDelimiter(node)
- return node
-}
diff --git a/format/mdext/shortstrike.go b/format/mdext/shortstrike.go
deleted file mode 100644
index 00328f22..00000000
--- a/format/mdext/shortstrike.go
+++ /dev/null
@@ -1,76 +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 mdext
-
-import (
- "github.com/yuin/goldmark"
- gast "github.com/yuin/goldmark/ast"
- "github.com/yuin/goldmark/extension"
- "github.com/yuin/goldmark/extension/ast"
- "github.com/yuin/goldmark/parser"
- "github.com/yuin/goldmark/renderer"
- "github.com/yuin/goldmark/text"
- "github.com/yuin/goldmark/util"
-)
-
-var ShortStrike goldmark.Extender = &shortStrikeExtender{length: 1}
-var LongStrike goldmark.Extender = &shortStrikeExtender{length: 2}
-
-type shortStrikeExtender struct {
- length int
-}
-
-func (s *shortStrikeExtender) Extend(m goldmark.Markdown) {
- m.Parser().AddOptions(parser.WithInlineParsers(
- util.Prioritized(&strikethroughParser{length: s.length}, 500),
- ))
- m.Renderer().AddOptions(renderer.WithNodeRenderers(
- util.Prioritized(extension.NewStrikethroughHTMLRenderer(), 500),
- ))
-}
-
-type strikethroughDelimiterProcessor struct{}
-
-func (p *strikethroughDelimiterProcessor) IsDelimiter(b byte) bool {
- return b == '~'
-}
-
-func (p *strikethroughDelimiterProcessor) CanOpenCloser(opener, closer *parser.Delimiter) bool {
- return opener.Char == closer.Char
-}
-
-func (p *strikethroughDelimiterProcessor) OnMatch(consumes int) gast.Node {
- return ast.NewStrikethrough()
-}
-
-var defaultStrikethroughDelimiterProcessor = &strikethroughDelimiterProcessor{}
-
-type strikethroughParser struct {
- length int
-}
-
-func (s *strikethroughParser) Trigger() []byte {
- return []byte{'~'}
-}
-
-func (s *strikethroughParser) Parse(parent gast.Node, block text.Reader, pc parser.Context) gast.Node {
- before := block.PrecendingCharacter()
- line, segment := block.PeekLine()
- node := parser.ScanDelimiter(line, before, 1, defaultStrikethroughDelimiterProcessor)
- if node == nil || node.OriginalLength != s.length || before == '~' {
- return nil
- }
-
- node.Segment = segment.WithStop(segment.Start + node.OriginalLength)
- block.Advance(node.OriginalLength)
- pc.PushDelimiter(node)
- return node
-}
-
-func (s *strikethroughParser) CloseBlock(parent gast.Node, pc parser.Context) {
- // nothing to do
-}
diff --git a/go.mod b/go.mod
index 49a1d4e4..3e349953 100644
--- a/go.mod
+++ b/go.mod
@@ -1,42 +1,34 @@
module maunium.net/go/mautrix
-go 1.25.0
-
-toolchain go1.26.0
+go 1.21
require (
- filippo.io/edwards25519 v1.2.0
- github.com/chzyer/readline v1.5.1
- 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.34.0
- github.com/skip2/go-qrcode v0.0.0-20200617195104-da1b6568686e
- github.com/stretchr/testify v1.11.1
- github.com/tidwall/gjson v1.18.0
+ github.com/gorilla/mux v1.8.0
+ github.com/gorilla/websocket v1.5.0
+ github.com/lib/pq v1.10.9
+ github.com/mattn/go-sqlite3 v1.14.22
+ github.com/rs/zerolog v1.32.0
+ github.com/stretchr/testify v1.9.0
+ github.com/tidwall/gjson v1.17.1
github.com/tidwall/sjson v1.2.5
- 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
+ github.com/yuin/goldmark v1.7.0
+ go.mau.fi/util v0.4.1
+ go.mau.fi/zeroconfig v0.1.2
+ golang.org/x/crypto v0.21.0
+ golang.org/x/exp v0.0.0-20240314144324-c7f7c6466f7f
+ golang.org/x/net v0.22.0
gopkg.in/yaml.v3 v3.0.1
maunium.net/go/mauflag v1.0.0
)
require (
- github.com/coreos/go-systemd/v22 v22.6.0 // indirect
+ github.com/coreos/go-systemd/v22 v22.5.0 // indirect
github.com/davecgh/go-spew v1.1.1 // 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/mattn/go-colorable v0.1.13 // indirect
+ github.com/mattn/go-isatty v0.0.19 // indirect
github.com/pmezard/go-difflib v1.0.0 // indirect
github.com/tidwall/match v1.1.1 // 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
+ github.com/tidwall/pretty v1.2.0 // indirect
+ golang.org/x/sys v0.18.0 // indirect
gopkg.in/natefinch/lumberjack.v2 v2.2.1 // indirect
)
diff --git a/go.sum b/go.sum
index 871a5156..705282d4 100644
--- a/go.sum
+++ b/go.sum
@@ -1,77 +1,57 @@
-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=
-github.com/chzyer/logex v1.2.1/go.mod h1:JLbx6lG2kDbNRFnfkgvh4eRJRPX1QCoOIWomwysCBrQ=
-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/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 h1:RrqgGjYQKalulkV8NGVIfkXQf6YYmOyiJKk8iXXhfZs=
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/lib/pq v1.11.2 h1:x6gxUeu39V0BHZiugWe8LXZYZ+Utk7hSJGThs8sdzfs=
-github.com/lib/pq v1.11.2/go.mod h1:/p+8NSbOcwzAEI7wiMXFlgydTwcgTr3OSKMsD2BitpA=
+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/mattn/go-colorable v0.1.13 h1:fFA4WZxdEF4tXPZVKMLwD8oUnCTTo08duU7wxecdEvA=
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-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/mattn/go-sqlite3 v1.14.22 h1:2gZY6PC6kBnID23Tichd1K+Z0oS6nE/XwU+Vz/5o4kU=
+github.com/mattn/go-sqlite3 v1.14.22/go.mod h1:Uh1q+B4BYcTPb+yiD3kU8Ct7aC0hY9fxUwlHK0RXw+Y=
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/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.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.11.1 h1:7s2iGBzp5EwR7/aIZr8ao5+dra3wiQyKjjFuvgVKu7U=
-github.com/stretchr/testify v1.11.1/go.mod h1:wZwfW3scLgRK+23gO65QZefKpKQRnfz6sD981Nm4B6U=
+github.com/rs/xid v1.5.0/go.mod h1:trrq9SKmegXys3aeAKXMUTdJsYXVwGY3RLcfgqegfbg=
+github.com/rs/zerolog v1.32.0 h1:keLypqrlIjaFsbmJOBdB/qvyF8KEtCWHwobLp5l/mQ0=
+github.com/rs/zerolog v1.32.0/go.mod h1:/7mN4D5sKwJLZQ2b/znpjC3/GQWY/xaDXUM0kKWRHss=
+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/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/gjson v1.17.1 h1:wlYEnwqAHgzmhNUFfw7Xalt2JzQvsMx2Se4PcoFCT/U=
+github.com/tidwall/gjson v1.17.1/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.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=
+github.com/yuin/goldmark v1.7.0 h1:EfOIvIMZIzHdB/R/zVrikYLPPwJlfMcNczJFMs1m6sA=
+github.com/yuin/goldmark v1.7.0/go.mod h1:uzxRWxtg69N339t3louHJ7+O03ezfj6PlliRlaOzY1E=
+go.mau.fi/util v0.4.1 h1:3EC9KxIXo5+h869zDGf5OOZklRd/FjeVnimTwtm3owg=
+go.mau.fi/util v0.4.1/go.mod h1:GjkTEBsehYZbSh2LlE6cWEn+6ZIZTGrTMM/5DMNlmFY=
+go.mau.fi/zeroconfig v0.1.2 h1:DKOydWnhPMn65GbXZOafgkPm11BvFashZWLct0dGFto=
+go.mau.fi/zeroconfig v0.1.2/go.mod h1:NcSJkf180JT+1IId76PcMuLTNa1CzsFFZ0nBygIQM70=
+golang.org/x/crypto v0.21.0 h1:X31++rzVUdKhX5sWmSOFZxx8UW/ldWx55cbf08iNAMA=
+golang.org/x/crypto v0.21.0/go.mod h1:0BP7YvVV9gBbVKyeTG0Gyn+gZm94bibOW5BjDEYAOMs=
+golang.org/x/exp v0.0.0-20240314144324-c7f7c6466f7f h1:3CW0unweImhOzd5FmYuRsD4Y4oQFKZIjAnKbjV4WIrw=
+golang.org/x/exp v0.0.0-20240314144324-c7f7c6466f7f/go.mod h1:CxmFvTBINI24O/j8iY7H1xHzx2i4OsyguNBmN/uPtqc=
+golang.org/x/net v0.22.0 h1:9sGLhx7iRIHEiX0oAJ3MRZMUCElJgy7Br1nO+AMN3Tc=
+golang.org/x/net v0.22.0/go.mod h1:JKghWKKOSdJwpW2GEx0Ja7fmaKnMsbu+MWVZTokSYmg=
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.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=
+golang.org/x/sys v0.18.0 h1:DBdB3niSjOA/O0blCZBqDefyWNYveAYMNF1Wum0DYQ4=
+golang.org/x/sys v0.18.0/go.mod h1:/VUhepiaJMQUp4+oa/7Zr1D23ma6VTLIYjOOTFZPUcA=
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/id/contenturi.go b/id/contenturi.go
index 67127b6c..cfd00c3e 100644
--- a/id/contenturi.go
+++ b/id/contenturi.go
@@ -12,19 +12,12 @@ import (
"encoding/json"
"errors"
"fmt"
- "regexp"
"strings"
)
var (
- 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
+ InvalidContentURI = errors.New("invalid Matrix content URI")
+ InputNotJSONString = errors.New("input doesn't look like a JSON string")
)
// ContentURIString is a string that's expected to be a Matrix content URI.
@@ -61,9 +54,9 @@ func ParseContentURI(uri string) (parsed ContentURI, err error) {
if len(uri) == 0 {
return
} else if !strings.HasPrefix(uri, "mxc://") {
- err = ErrInvalidContentURI
+ err = InvalidContentURI
} else if index := strings.IndexRune(uri[6:], '/'); index == -1 || index == len(uri)-7 {
- err = ErrInvalidContentURI
+ err = InvalidContentURI
} else {
parsed.Homeserver = uri[6 : 6+index]
parsed.FileID = uri[6+index+1:]
@@ -77,9 +70,9 @@ func ParseContentURIBytes(uri []byte) (parsed ContentURI, err error) {
if len(uri) == 0 {
return
} else if !bytes.HasPrefix(uri, mxcBytes) {
- err = ErrInvalidContentURI
+ err = InvalidContentURI
} else if index := bytes.IndexRune(uri[6:], '/'); index == -1 || index == len(uri)-7 {
- err = ErrInvalidContentURI
+ err = InvalidContentURI
} else {
parsed.Homeserver = string(uri[6 : 6+index])
parsed.FileID = string(uri[6+index+1:])
@@ -92,7 +85,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 fmt.Errorf("ContentURI: %w", ErrInputNotJSONString)
+ return InputNotJSONString
}
parsed, err := ParseContentURIBytes(raw[1 : len(raw)-1])
if err != nil {
@@ -163,21 +156,3 @@ func (uri ContentURI) CUString() ContentURIString {
func (uri ContentURI) IsEmpty() bool {
return len(uri.Homeserver) == 0 || len(uri.FileID) == 0
}
-
-var simpleHomeserverRegex = regexp.MustCompile(`^[a-zA-Z0-9.:-]+$`)
-
-func (uri ContentURI) IsValid() bool {
- return IsValidMediaID(uri.FileID) && uri.Homeserver != "" && simpleHomeserverRegex.MatchString(uri.Homeserver)
-}
-
-func IsValidMediaID(mediaID string) bool {
- if len(mediaID) == 0 {
- return false
- }
- for _, char := range mediaID {
- if (char < 'A' || char > 'Z') && (char < 'a' || char > 'z') && (char < '0' || char > '9') && char != '-' && char != '_' {
- return false
- }
- }
- return true
-}
diff --git a/id/crypto.go b/id/crypto.go
index ee857f78..355a84a8 100644
--- a/id/crypto.go
+++ b/id/crypto.go
@@ -53,34 +53,6 @@ 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 d5c78bc7..5ec403e9 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 len(uri.Via) > 0 {
+ if uri.Via != nil && len(uri.Via) > 0 {
q["via"] = uri.Via
}
if len(uri.Action) > 0 {
@@ -65,9 +65,6 @@ func (uri *MatrixURI) getQuery() url.Values {
// String converts the parsed matrix: URI back into the string representation.
func (uri *MatrixURI) String() string {
- if uri == nil {
- return ""
- }
parts := []string{
SigilToPathSegment[uri.Sigil1],
url.PathEscape(uri.MXID1),
@@ -84,9 +81,6 @@ func (uri *MatrixURI) String() string {
// MatrixToURL converts to parsed matrix: URI into a matrix.to URL
func (uri *MatrixURI) MatrixToURL() string {
- if uri == nil {
- return ""
- }
fragment := fmt.Sprintf("#/%s", url.PathEscape(uri.PrimaryIdentifier()))
if uri.Sigil2 != 0 {
fragment = fmt.Sprintf("%s/%s", fragment, url.PathEscape(uri.SecondaryIdentifier()))
@@ -102,16 +96,13 @@ func (uri *MatrixURI) MatrixToURL() string {
// PrimaryIdentifier returns the first Matrix identifier in the URI.
// Currently room IDs, room aliases and user IDs can be in the primary identifier slot.
func (uri *MatrixURI) PrimaryIdentifier() string {
- if uri == nil {
- return ""
- }
return fmt.Sprintf("%c%s", uri.Sigil1, uri.MXID1)
}
// SecondaryIdentifier returns the second Matrix identifier in the URI.
// Currently only event IDs can be in the secondary identifier slot.
func (uri *MatrixURI) SecondaryIdentifier() string {
- if uri == nil || uri.Sigil2 == 0 {
+ if uri.Sigil2 == 0 {
return ""
}
return fmt.Sprintf("%c%s", uri.Sigil2, uri.MXID2)
@@ -119,7 +110,7 @@ func (uri *MatrixURI) SecondaryIdentifier() string {
// UserID returns the user ID from the URI if the primary identifier is a user ID.
func (uri *MatrixURI) UserID() UserID {
- if uri != nil && uri.Sigil1 == '@' {
+ if uri.Sigil1 == '@' {
return UserID(uri.PrimaryIdentifier())
}
return ""
@@ -127,7 +118,7 @@ func (uri *MatrixURI) UserID() UserID {
// RoomID returns the room ID from the URI if the primary identifier is a room ID.
func (uri *MatrixURI) RoomID() RoomID {
- if uri != nil && uri.Sigil1 == '!' {
+ if uri.Sigil1 == '!' {
return RoomID(uri.PrimaryIdentifier())
}
return ""
@@ -135,7 +126,7 @@ func (uri *MatrixURI) RoomID() RoomID {
// RoomAlias returns the room alias from the URI if the primary identifier is a room alias.
func (uri *MatrixURI) RoomAlias() RoomAlias {
- if uri != nil && uri.Sigil1 == '#' {
+ if uri.Sigil1 == '#' {
return RoomAlias(uri.PrimaryIdentifier())
}
return ""
@@ -143,7 +134,7 @@ func (uri *MatrixURI) RoomAlias() RoomAlias {
// EventID returns the event ID from the URI if the primary identifier is a room ID or alias and the secondary identifier is an event ID.
func (uri *MatrixURI) EventID() EventID {
- if uri != nil && (uri.Sigil1 == '!' || uri.Sigil1 == '#') && uri.Sigil2 == '$' {
+ if (uri.Sigil1 == '!' || uri.Sigil1 == '#') && uri.Sigil2 == '$' {
return EventID(uri.SecondaryIdentifier())
}
return ""
@@ -210,14 +201,10 @@ func ProcessMatrixURI(uri *url.URL) (*MatrixURI, error) {
if len(parts[1]) == 0 {
return nil, ErrEmptySecondSegment
}
- 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)
- }
+ parsed.MXID1 = parts[1]
// Step 6: if the first part is a room and the URI has 4 segments, construct a second level identifier
- if parsed.Sigil1 == '!' && len(parts) == 4 {
+ if (parsed.Sigil1 == '!' || parsed.Sigil1 == '#') && len(parts) == 4 {
// a: find the sigil from the third segment
switch parts[2] {
case "e", "event":
@@ -230,10 +217,7 @@ func ProcessMatrixURI(uri *url.URL) (*MatrixURI, error) {
if len(parts[3]) == 0 {
return nil, ErrEmptyFourthSegment
}
- 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)
- }
+ parsed.MXID2 = parts[3]
}
// Step 7: parse the query and extract via and action items
diff --git a/id/matrixuri_test.go b/id/matrixuri_test.go
index 90a0754d..d26d4bfd 100644
--- a/id/matrixuri_test.go
+++ b/id/matrixuri_test.go
@@ -16,11 +16,12 @@ 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"}
- 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"}
+ roomAliasEventLink = id.MatrixURI{Sigil1: '#', MXID1: "someroom: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"}
)
@@ -30,6 +31,7 @@ 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())
}
@@ -39,6 +41,7 @@ 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())
}
@@ -77,12 +80,8 @@ 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)
}
@@ -99,11 +98,19 @@ func TestParseMatrixURI_UserID(t *testing.T) {
}
func TestParseMatrixURI_EventID(t *testing.T) {
- parsed, err := id.ParseMatrixURI("matrix:roomid/7NdBVvkd4aLSbgKt9RXl:example.org/e/uOH4C9cK4HhMeFWkUXMbdF_dtndJ0j9je-kIK3XpV1s")
+ parsed1, err := id.ParseMatrixURI("matrix:r/someroom:example.org/e/uOH4C9cK4HhMeFWkUXMbdF_dtndJ0j9je-kIK3XpV1s")
require.NoError(t, err)
- require.NotNil(t, parsed)
+ 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)
- assert.Equal(t, roomIDEventLink, *parsed)
+ assert.Equal(t, roomAliasEventLink, *parsed1)
+ assert.Equal(t, roomAliasEventLink, *parsed2)
+ assert.Equal(t, roomIDEventLink, *parsed3)
}
func TestParseMatrixToURL_RoomAlias(t *testing.T) {
@@ -151,13 +158,21 @@ func TestParseMatrixToURL_UserID(t *testing.T) {
}
func TestParseMatrixToURL_EventID(t *testing.T) {
- parsed, err := id.ParseMatrixToURL("https://matrix.to/#/!7NdBVvkd4aLSbgKt9RXl:example.org/$uOH4C9cK4HhMeFWkUXMbdF_dtndJ0j9je-kIK3XpV1s")
+ parsed1, err := id.ParseMatrixToURL("https://matrix.to/#/#someroom:example.org/$uOH4C9cK4HhMeFWkUXMbdF_dtndJ0j9je-kIK3XpV1s")
require.NoError(t, err)
- require.NotNil(t, parsed)
- parsedEncoded, err := id.ParseMatrixToURL("https://matrix.to/#/%217NdBVvkd4aLSbgKt9RXl:example.org/%24uOH4C9cK4HhMeFWkUXMbdF_dtndJ0j9je-kIK3XpV1s")
+ require.NotNil(t, parsed1)
+ parsed2, err := id.ParseMatrixToURL("https://matrix.to/#/!7NdBVvkd4aLSbgKt9RXl:example.org/$uOH4C9cK4HhMeFWkUXMbdF_dtndJ0j9je-kIK3XpV1s")
require.NoError(t, err)
- require.NotNil(t, parsedEncoded)
+ 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)
- assert.Equal(t, roomIDEventLink, *parsed)
- assert.Equal(t, roomIDEventLink, *parsedEncoded)
+ assert.Equal(t, roomAliasEventLink, *parsed1)
+ assert.Equal(t, roomAliasEventLink, *parsed1Encoded)
+ assert.Equal(t, roomIDEventLink, *parsed2)
+ assert.Equal(t, roomIDEventLink, *parsed2Encoded)
}
diff --git a/id/opaque.go b/id/opaque.go
index c1ad4988..16863b95 100644
--- a/id/opaque.go
+++ b/id/opaque.go
@@ -32,17 +32,11 @@ 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)
}
func (roomID RoomID) URI(via ...string) *MatrixURI {
- if roomID == "" {
- return nil
- }
return &MatrixURI{
Sigil1: '!',
MXID1: string(roomID)[1:],
@@ -51,11 +45,6 @@ func (roomID RoomID) URI(via ...string) *MatrixURI {
}
func (roomID RoomID) EventURI(eventID EventID, via ...string) *MatrixURI {
- if roomID == "" {
- return nil
- } else if eventID == "" {
- return roomID.URI(via...)
- }
return &MatrixURI{
Sigil1: '!',
MXID1: string(roomID)[1:],
@@ -70,20 +59,13 @@ func (roomAlias RoomAlias) String() string {
}
func (roomAlias RoomAlias) URI() *MatrixURI {
- if roomAlias == "" {
- return nil
- }
return &MatrixURI{
Sigil1: '#',
MXID1: string(roomAlias)[1:],
}
}
-// Deprecated: room alias event links should not be used. Use room IDs instead.
func (roomAlias RoomAlias) EventURI(eventID EventID) *MatrixURI {
- if roomAlias == "" {
- return nil
- }
return &MatrixURI{
Sigil1: '#',
MXID1: string(roomAlias)[1:],
diff --git a/id/roomversion.go b/id/roomversion.go
deleted file mode 100644
index 578c10bd..00000000
--- a/id/roomversion.go
+++ /dev/null
@@ -1,265 +0,0 @@
-// 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
deleted file mode 100644
index 923705b6..00000000
--- a/id/servername.go
+++ /dev/null
@@ -1,58 +0,0 @@
-// 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 6255093e..04f6e36b 100644
--- a/id/trust.go
+++ b/id/trust.go
@@ -16,7 +16,6 @@ type TrustState int
const (
TrustStateBlacklisted TrustState = -100
- TrustStateDeviceKeyMismatch TrustState = -5
TrustStateUnset TrustState = 0
TrustStateUnknownDevice TrustState = 10
TrustStateForwarded TrustState = 20
@@ -24,7 +23,7 @@ const (
TrustStateCrossSignedTOFU TrustState = 100
TrustStateCrossSignedVerified TrustState = 200
TrustStateVerified TrustState = 300
- TrustStateInvalid TrustState = -2147483647
+ TrustStateInvalid TrustState = (1 << 31) - 1
)
func (ts *TrustState) UnmarshalText(data []byte) error {
@@ -45,8 +44,6 @@ 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":
@@ -70,8 +67,6 @@ 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 726a0d58..53b68b96 100644
--- a/id/userid.go
+++ b/id/userid.go
@@ -30,11 +30,10 @@ 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")
- ErrNoncompliantServerPart = errors.New("is not a valid server name")
+ 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")
)
// ParseCommonIdentifier parses a common identifier according to https://spec.matrix.org/v1.9/appendices/#common-identifier-format
@@ -44,10 +43,10 @@ func ParseCommonIdentifier[Stringish ~string](identifier Stringish) (sigil byte,
}
sigil = identifier[0]
strIdentifier := string(identifier)
- colonIdx := strings.IndexByte(strIdentifier, ':')
- if colonIdx > 0 {
- localpart = strIdentifier[1:colonIdx]
- homeserver = strIdentifier[colonIdx+1:]
+ if strings.ContainsRune(strIdentifier, ':') {
+ parts := strings.SplitN(strIdentifier, ":", 2)
+ localpart = parts[0][1:]
+ homeserver = parts[1]
} else {
localpart = strIdentifier[1:]
}
@@ -82,9 +81,6 @@ func (userID UserID) Homeserver() string {
//
// This does not parse or validate the user ID. Use the ParseAndValidate method if you want to ensure the user ID is valid first.
func (userID UserID) URI() *MatrixURI {
- if userID == "" {
- return nil
- }
return &MatrixURI{
Sigil1: '@',
MXID1: string(userID)[1:],
@@ -104,32 +100,21 @@ func ValidateUserLocalpart(localpart string) error {
return nil
}
-// 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()
+// 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()
if err == nil {
err = ValidateUserLocalpart(localpart)
}
- 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 {
+ if err == nil && 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.ParseAndValidateStrict()
+ localpart, homeserver, err = userID.ParseAndValidate()
if err == nil {
localpart, err = DecodeUserLocalpart(localpart)
}
@@ -219,15 +204,15 @@ func DecodeUserLocalpart(str string) (string, error) {
for i := 0; i < len(strBytes); i++ {
b := strBytes[i]
if !isValidByte(b) {
- return "", fmt.Errorf("invalid encoded byte at position %d: %c", i, b)
+ return "", fmt.Errorf("Byte pos %d: Invalid byte", i)
}
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("unexpected end of string after underscore at %d", i)
+ return "", fmt.Errorf("Byte pos %d: expected _[a-z_] encoding but ran out of string", i)
}
if !isValidEscapedChar(strBytes[i+1]) { // invalid escaping
- return "", fmt.Errorf("unexpected byte %c after underscore at %d", strBytes[i+1], i)
+ return "", fmt.Errorf("Byte pos %d: expected _[a-z_] encoding", i)
}
if strBytes[i+1] == '_' {
outputBuffer.WriteByte('_')
@@ -237,7 +222,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("unexpected end of string after equals sign at %d", i)
+ return "", fmt.Errorf("Byte pos: %d: expected quote-printable encoding but ran out of string", 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 57a88066..359bc687 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_ParseAndValidateStrict_Invalid(t *testing.T) {
+func TestUserID_ParseAndValidate_Invalid(t *testing.T) {
const inputUserID = "@s p a c e:maunium.net"
- _, _, err := id.UserID(inputUserID).ParseAndValidateStrict()
+ _, _, err := id.UserID(inputUserID).ParseAndValidate()
assert.Error(t, err)
assert.True(t, errors.Is(err, id.ErrNoncompliantLocalpart))
}
-func TestUserID_ParseAndValidateStrict_Empty(t *testing.T) {
+func TestUserID_ParseAndValidate_Empty(t *testing.T) {
const inputUserID = "@:ponies.im"
- _, _, err := id.UserID(inputUserID).ParseAndValidateStrict()
+ _, _, err := id.UserID(inputUserID).ParseAndValidate()
assert.Error(t, err)
assert.True(t, errors.Is(err, id.ErrEmptyLocalpart))
}
-func TestUserID_ParseAndValidateStrict_Long(t *testing.T) {
+func TestUserID_ParseAndValidate_Long(t *testing.T) {
const inputUserID = "@aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa:example.com"
- _, _, err := id.UserID(inputUserID).ParseAndValidateStrict()
+ _, _, err := id.UserID(inputUserID).ParseAndValidate()
assert.Error(t, err)
assert.True(t, errors.Is(err, id.ErrUserIDTooLong))
}
-func TestUserID_ParseAndValidateStrict_NotLong(t *testing.T) {
+func TestUserID_ParseAndValidate_NotLong(t *testing.T) {
const inputUserID = "@aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa:example.com"
- _, _, err := id.UserID(inputUserID).ParseAndValidateStrict()
+ _, _, err := id.UserID(inputUserID).ParseAndValidate()
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.ParseAndValidateStrict()
+ parsedLocalpart, parsedServerName, err := userID.ParseAndValidate()
assert.NoError(t, err)
assert.Equal(t, encodedLocalpart, parsedLocalpart)
assert.Equal(t, inputServerName, parsedServerName)
diff --git a/mediaproxy/mediaproxy.go b/mediaproxy/mediaproxy.go
deleted file mode 100644
index 4d2bc7cf..00000000
--- a/mediaproxy/mediaproxy.go
+++ /dev/null
@@ -1,525 +0,0 @@
-// 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 mediaproxy
-
-import (
- "context"
- "errors"
- "fmt"
- "io"
- "mime"
- "mime/multipart"
- "net/http"
- "net/textproto"
- "net/url"
- "os"
- "strconv"
- "strings"
- "time"
-
- "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 (*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
-}
-
-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
- ServerAuth *federation.ServerAuth
-
- GetMedia GetMediaFunc
- PrepareProxyRequest func(*http.Request)
-
- serverName string
- serverKey *federation.SigningKey
-
- FederationRouter *http.ServeMux
- ClientMediaRouter *http.ServeMux
-}
-
-func New(serverName string, serverKey string, getMedia GetMediaFunc) (*MediaProxy, error) {
- parsed, err := federation.ParseSynapseKey(serverKey)
- if err != nil {
- return nil, err
- }
- mp := &MediaProxy{
- serverName: serverName,
- serverKey: parsed,
- GetMedia: getMedia,
- KeyServer: &federation.KeyServer{
- KeyProvider: &federation.StaticServerKey{
- ServerName: serverName,
- Key: parsed,
- },
- WellKnownTarget: fmt.Sprintf("%s:443", serverName),
- Version: federation.ServerVersion{
- Name: "mautrix-go media proxy",
- Version: strings.TrimPrefix(mautrix.VersionWithCommit, "v"),
- },
- },
- }
- 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"`
- FederationAuth bool `yaml:"federation_auth" json:"federation_auth"`
- WellKnownResponse string `yaml:"well_known_response" json:"well_known_response"`
-}
-
-func NewFromConfig(cfg BasicConfig, getMedia GetMediaFunc) (*MediaProxy, error) {
- mp, err := New(cfg.ServerName, cfg.ServerKey, getMedia)
- if err != nil {
- return nil, err
- }
- if cfg.WellKnownResponse != "" {
- mp.KeyServer.WellKnownTarget = cfg.WellKnownResponse
- }
- if cfg.FederationAuth {
- mp.EnableServerAuth(nil, nil)
- }
- return mp, nil
-}
-
-type ServerConfig struct {
- Hostname string `yaml:"hostname" json:"hostname"`
- Port uint16 `yaml:"port" json:"port"`
-}
-
-func (mp *MediaProxy) Listen(cfg ServerConfig) error {
- router := http.NewServeMux()
- mp.RegisterRoutes(router, zerolog.Nop())
- return http.ListenAndServe(fmt.Sprintf("%s:%d", cfg.Hostname, cfg.Port), router)
-}
-
-func (mp *MediaProxy) GetServerName() string {
- return mp.serverName
-}
-
-func (mp *MediaProxy) GetServerKey() *federation.SigningKey {
- return mp.serverKey
-}
-
-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 *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()),
- }
- 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)
-}
-
-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 {
- 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 {
- 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
- }
-
- 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 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",
- "audio/x-pn-wav", "audio/flac", "audio/x-flac", "application/pdf":
- contentDisposition = "inline"
- }
- if fileName != "" {
- contentDisposition = mime.FormatMediaType(contentDisposition, map[string]string{
- "filename": fileName,
- })
- }
- w.Header().Set("Content-Disposition", contentDisposition)
- w.Header().Set("Content-Type", mimeType)
-}
-
-func (mp *MediaProxy) DownloadMedia(w http.ResponseWriter, r *http.Request) {
- ctx := r.Context()
- log := zerolog.Ctx(ctx)
- 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)
- if resp == nil {
- return
- }
-
- if urlResp, ok := resp.(*GetMediaResponseURL); ok {
- w.Header().Set("Location", urlResp.URL)
- expirySeconds := (time.Until(urlResp.ExpiresAt) - 5*time.Minute).Seconds()
- if urlResp.ExpiresAt.IsZero() {
- w.Header().Set("Cache-Control", "public, max-age=31536000, immutable")
- } else if expirySeconds > 0 {
- cacheControl := fmt.Sprintf("public, max-age=%d, immutable", int(expirySeconds))
- w.Header().Set("Cache-Control", cacheControl)
- } else {
- w.Header().Set("Cache-Control", "no-store")
- }
- w.WriteHeader(http.StatusTemporaryRedirect)
- } 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 := writerResp.WriteTo(w)
- if err != nil {
- log.Err(err).Msg("Failed to write media data")
- }
- } else {
- panic(fmt.Errorf("unknown GetMediaResponse type %T", resp))
- }
-}
-
-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) {
- ErrUploadNotSupported.Write(w)
-}
-
-func (mp *MediaProxy) PreviewURLNotSupported(w http.ResponseWriter, r *http.Request) {
- ErrPreviewURLNotSupported.Write(w)
-}
diff --git a/mockserver/mockserver.go b/mockserver/mockserver.go
deleted file mode 100644
index 507c24a5..00000000
--- a/mockserver/mockserver.go
+++ /dev/null
@@ -1,307 +0,0 @@
-// 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 b5a884b2..9838e88b 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 3c0aa168..a8f68415 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.NoError(t, err)
+ assert.Nil(t, err)
err = pa.UnmarshalJSON([]byte(`9001`))
- assert.NoError(t, err)
+ assert.Nil(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.NoError(t, err)
+ assert.Nil(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.NoError(t, err)
+ assert.Nil(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.NoError(t, err)
+ assert.Nil(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.NoError(t, err)
+ assert.Nil(t, err)
assert.Equal(t, []byte(`"something else"`), data)
}
diff --git a/pushrules/condition.go b/pushrules/condition.go
index caa717de..435178fb 100644
--- a/pushrules/condition.go
+++ b/pushrules/condition.go
@@ -15,10 +15,10 @@ import (
"unicode"
"github.com/tidwall/gjson"
- "go.mau.fi/util/glob"
"maunium.net/go/mautrix/event"
"maunium.net/go/mautrix/id"
+ "maunium.net/go/mautrix/pushrules/glob"
)
// Room is an interface with the functions that are needed for processing room-specific push conditions
@@ -27,11 +27,6 @@ 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
@@ -43,12 +38,11 @@ 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"
- KindSenderNotificationPermission PushCondKind = "sender_notification_permission"
+ KindEventMatch PushCondKind = "event_match"
+ KindContainsDisplayName PushCondKind = "contains_display_name"
+ KindRoomMemberCount PushCondKind = "room_member_count"
+ KindEventPropertyIs PushCondKind = "event_property_is"
+ KindEventPropertyContains PushCondKind = "event_property_contains"
// MSC3664: https://github.com/matrix-org/matrix-spec-proposals/pull/3664
@@ -88,8 +82,6 @@ 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
}
@@ -227,11 +219,11 @@ func (cond *PushCondition) matchValue(evt *event.Event) bool {
switch cond.Kind {
case KindEventMatch, KindRelatedEventMatch, KindUnstableRelatedEventMatch:
- pattern := glob.CompileWithImplicitContains(cond.Pattern)
- if pattern == nil {
+ pattern, err := glob.Compile(cond.Pattern)
+ if err != nil {
return false
}
- return pattern.Match(stringifyForPushCondition(val))
+ return pattern.MatchString(stringifyForPushCondition(val))
case KindEventPropertyIs:
return valueEquals(val, cond.Value)
case KindEventPropertyContains:
@@ -342,18 +334,3 @@ 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 37af3e34..0d3eaf7a 100644
--- a/pushrules/condition_test.go
+++ b/pushrules/condition_test.go
@@ -102,6 +102,14 @@ 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/glob/LICENSE b/pushrules/glob/LICENSE
new file mode 100644
index 00000000..cb00d952
--- /dev/null
+++ b/pushrules/glob/LICENSE
@@ -0,0 +1,22 @@
+Glob is licensed under the MIT "Expat" License:
+
+Copyright (c) 2016: Zachary Yedidia.
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.
+IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY
+CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
+TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE
+SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
diff --git a/pushrules/glob/README.md b/pushrules/glob/README.md
new file mode 100644
index 00000000..e2e6c649
--- /dev/null
+++ b/pushrules/glob/README.md
@@ -0,0 +1,28 @@
+# String globbing in Go
+
+[](http://godoc.org/github.com/zyedidia/glob)
+
+This package adds support for globs in Go.
+
+It simply converts glob expressions to regexps. I try to follow the standard defined [here](http://pubs.opengroup.org/onlinepubs/009695399/utilities/xcu_chap02.html#tag_02_13).
+
+# Example
+
+```go
+package main
+
+import "github.com/zyedidia/glob"
+
+func main() {
+ glob, err := glob.Compile("{*.go,*.c}")
+ if err != nil {
+ // Error
+ }
+
+ glob.Match([]byte("test.c")) // true
+ glob.Match([]byte("hello.go")) // true
+ glob.Match([]byte("test.d")) // false
+}
+```
+
+You can call all the same functions on a glob that you can call on a regexp.
diff --git a/pushrules/glob/glob.go b/pushrules/glob/glob.go
new file mode 100644
index 00000000..c270dbc5
--- /dev/null
+++ b/pushrules/glob/glob.go
@@ -0,0 +1,108 @@
+// Package glob provides objects for matching strings with globs
+package glob
+
+import "regexp"
+
+// Glob is a wrapper of *regexp.Regexp.
+// It should contain a glob expression compiled into a regular expression.
+type Glob struct {
+ *regexp.Regexp
+}
+
+// Compile a takes a glob expression as a string and transforms it
+// into a *Glob object (which is really just a regular expression)
+// Compile also returns a possible error.
+func Compile(pattern string) (*Glob, error) {
+ r, err := globToRegex(pattern)
+ return &Glob{r}, err
+}
+
+func globToRegex(glob string) (*regexp.Regexp, error) {
+ regex := ""
+ inGroup := 0
+ inClass := 0
+ firstIndexInClass := -1
+ arr := []byte(glob)
+
+ hasGlobCharacters := false
+
+ for i := 0; i < len(arr); i++ {
+ ch := arr[i]
+
+ switch ch {
+ case '\\':
+ i++
+ if i >= len(arr) {
+ regex += "\\"
+ } else {
+ next := arr[i]
+ switch next {
+ case ',':
+ // Nothing
+ case 'Q', 'E':
+ regex += "\\\\"
+ default:
+ regex += "\\"
+ }
+ regex += string(next)
+ }
+ case '*':
+ if inClass == 0 {
+ regex += ".*"
+ } else {
+ regex += "*"
+ }
+ hasGlobCharacters = true
+ case '?':
+ if inClass == 0 {
+ regex += "."
+ } else {
+ regex += "?"
+ }
+ hasGlobCharacters = true
+ case '[':
+ inClass++
+ firstIndexInClass = i + 1
+ regex += "["
+ hasGlobCharacters = true
+ case ']':
+ inClass--
+ regex += "]"
+ case '.', '(', ')', '+', '|', '^', '$', '@', '%':
+ if inClass == 0 || (firstIndexInClass == i && ch == '^') {
+ regex += "\\"
+ }
+ regex += string(ch)
+ hasGlobCharacters = true
+ case '!':
+ if firstIndexInClass == i {
+ regex += "^"
+ } else {
+ regex += "!"
+ }
+ hasGlobCharacters = true
+ case '{':
+ inGroup++
+ regex += "("
+ hasGlobCharacters = true
+ case '}':
+ inGroup--
+ regex += ")"
+ case ',':
+ if inGroup > 0 {
+ regex += "|"
+ hasGlobCharacters = true
+ } else {
+ regex += ","
+ }
+ default:
+ regex += string(ch)
+ }
+ }
+
+ if hasGlobCharacters {
+ return regexp.Compile("^" + regex + "$")
+ } else {
+ return regexp.Compile(regex)
+ }
+}
diff --git a/pushrules/pushrules_test.go b/pushrules/pushrules_test.go
index a5a0f5e7..a531ca28 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.NoError(t, err)
+ assert.Nil(t, err)
assert.NotNil(t, pushRuleset)
assert.IsType(t, pushRuleset.Override, pushrules.PushRuleArray{})
diff --git a/pushrules/rule.go b/pushrules/rule.go
index cf659695..0f7436f3 100644
--- a/pushrules/rule.go
+++ b/pushrules/rule.go
@@ -8,14 +8,10 @@ package pushrules
import (
"encoding/gob"
- "regexp"
- "strings"
-
- "go.mau.fi/util/exerrors"
- "go.mau.fi/util/glob"
"maunium.net/go/mautrix/event"
"maunium.net/go/mautrix/id"
+ "maunium.net/go/mautrix/pushrules/glob"
)
func init() {
@@ -168,20 +164,13 @@ func (rule *PushRule) matchConditions(room Room, evt *event.Event) bool {
}
func (rule *PushRule) matchPattern(room Room, evt *event.Event) bool {
+ pattern, err := glob.Compile(rule.Pattern)
+ if err != nil {
+ return false
+ }
msg, ok := evt.Content.Raw["body"].(string)
if !ok {
return false
}
- 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 7ff839a7..803c721e 100644
--- a/pushrules/rule_test.go
+++ b/pushrules/rule_test.go
@@ -186,34 +186,6 @@ 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 c42d4799..609997b4 100644
--- a/pushrules/ruleset.go
+++ b/pushrules/ruleset.go
@@ -68,9 +68,6 @@ 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 cc8b7266..cdf020a0 100644
--- a/requests.go
+++ b/requests.go
@@ -2,9 +2,7 @@ package mautrix
import (
"encoding/json"
- "fmt"
"strconv"
- "time"
"maunium.net/go/mautrix/crypto/signatures"
"maunium.net/go/mautrix/event"
@@ -40,40 +38,20 @@ 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[UIAType any] struct {
+type ReqRegister 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 UIAType `json:"auth,omitempty"`
+ Auth interface{} `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
@@ -105,7 +83,6 @@ type ReqLogin struct {
Token string `json:"token,omitempty"`
DeviceID id.DeviceID `json:"device_id,omitempty"`
InitialDeviceDisplayName string `json:"initial_device_display_name,omitempty"`
- RefreshToken bool `json:"refresh_token,omitempty"`
// Whether or not the returned credentials should be stored in the Client
StoreCredentials bool `json:"-"`
@@ -113,10 +90,6 @@ 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"`
@@ -141,17 +114,12 @@ type ReqCreateRoom struct {
InitialState []*event.Event `json:"initial_state,omitempty"`
Preset string `json:"preset,omitempty"`
IsDirect bool `json:"is_direct,omitempty"`
- RoomVersion id.RoomVersion `json:"room_version,omitempty"`
+ RoomVersion string `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"`
+ MeowRoomID id.RoomID `json:"fi.mau.room_id,omitempty"`
+ BeeperAutoJoinInvites bool `json:"com.beeper.auto_join_invites,omitempty"`
}
// ReqRedact is the JSON request for https://spec.matrix.org/v1.2/client-server-api/#put_matrixclientv3roomsroomidredacteventidtxnid
@@ -161,37 +129,12 @@ 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 {
@@ -220,8 +163,6 @@ 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
@@ -237,8 +178,7 @@ type ReqTyping struct {
}
type ReqPresence struct {
- Presence event.Presence `json:"presence"`
- StatusMsg string `json:"status_msg,omitempty"`
+ Presence event.Presence `json:"presence"`
}
type ReqAliasCreate struct {
@@ -283,7 +223,7 @@ func (otk *OneTimeKey) MarshalJSON() ([]byte, error) {
type ReqUploadKeys struct {
DeviceKeys *DeviceKeys `json:"device_keys,omitempty"`
- OneTimeKeys map[id.KeyID]OneTimeKey `json:"one_time_keys,omitempty"`
+ OneTimeKeys map[id.KeyID]OneTimeKey `json:"one_time_keys"`
}
type ReqKeysSignatures struct {
@@ -320,11 +260,11 @@ func (csk *CrossSigningKeys) FirstKey() id.Ed25519 {
return ""
}
-type UploadCrossSigningKeysReq[UIAType any] struct {
+type UploadCrossSigningKeysReq struct {
Master CrossSigningKeys `json:"master_key"`
SelfSigning CrossSigningKeys `json:"self_signing_key"`
UserSigning CrossSigningKeys `json:"user_signing_key"`
- Auth UIAType `json:"auth,omitempty"`
+ Auth interface{} `json:"auth,omitempty"`
}
type KeyMap map[id.DeviceKeyID]string
@@ -366,40 +306,20 @@ 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[UIAType any] struct {
- Auth UIAType `json:"auth,omitempty"`
+type ReqDeleteDevice struct {
+ Auth interface{} `json:"auth,omitempty"`
}
// ReqDeleteDevices is the JSON request for https://spec.matrix.org/v1.2/client-server-api/#post_matrixclientv3delete_devices
-type ReqDeleteDevices[UIAType any] struct {
+type ReqDeleteDevices struct {
Devices []id.DeviceID `json:"devices"`
- Auth UIAType `json:"auth,omitempty"`
+ Auth interface{} `json:"auth,omitempty"`
}
type ReqPutPushRule struct {
@@ -411,6 +331,18 @@ 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.
@@ -431,48 +363,10 @@ type ReqSetReadMarkers struct {
BeeperFullyReadExtra interface{} `json:"com.beeper.fully_read.extra,omitempty"`
}
-type BeeperInboxDone struct {
- Delta int64 `json:"at_delta"`
- AtOrder int64 `json:"at_order"`
-}
-
-type ReqSetBeeperInboxState struct {
- MarkedUnread *bool `json:"marked_unread,omitempty"`
- Done *BeeperInboxDone `json:"done,omitempty"`
- ReadMarkers *ReqSetReadMarkers `json:"read_markers,omitempty"`
-}
-
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.
@@ -560,59 +454,3 @@ type ReqKeyBackupData struct {
IsVerified bool `json:"is_verified"`
SessionData json.RawMessage `json:"session_data"`
}
-
-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 4fbe1fbc..9e5fd0aa 100644
--- a/responses.go
+++ b/responses.go
@@ -4,16 +4,13 @@ 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"
@@ -35,11 +32,6 @@ 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{}
@@ -105,29 +97,6 @@ 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
@@ -142,14 +111,10 @@ type RespMediaUpload struct {
// RespCreateMXC is the JSON response for https://spec.matrix.org/v1.7/client-server-api/#post_matrixmediav1create
type RespCreateMXC struct {
- ContentURI id.ContentURI `json:"content_uri"`
- UnusedExpiresAt jsontime.UnixMilli `json:"unused_expires_at,omitempty"`
+ ContentURI id.ContentURI `json:"content_uri"`
+ UnusedExpiresAt int `json:"unused_expires_at,omitempty"`
UnstableUploadURL string `json:"com.beeper.msc3870.upload_url,omitempty"`
-
- // Beeper extensions for uploading unique media only once
- BeeperUniqueID string `json:"com.beeper.unique_id,omitempty"`
- BeeperCompletedAt jsontime.UnixMilli `json:"com.beeper.completed_at,omitempty"`
}
// RespPreviewURL is the JSON response for https://spec.matrix.org/v1.2/client-server-api/#get_matrixmediav3preview_url
@@ -186,89 +151,8 @@ type RespUserDisplayName struct {
}
type RespUserProfile struct {
- 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"`
+ DisplayName string `json:"displayname"`
+ AvatarURL id.ContentURI `json:"avatar_url"`
}
// RespRegisterAvailable is the JSON response for https://spec.matrix.org/v1.4/client-server-api/#get_matrixclientv3registeravailable
@@ -319,9 +203,6 @@ 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
@@ -342,24 +223,6 @@ 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"`
}
@@ -455,7 +318,6 @@ 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"`
@@ -481,7 +343,16 @@ func (sjr SyncJoinedRoom) MarshalJSON() ([]byte, error) {
}
type SyncInvitedRoom struct {
- State SyncEventsList `json:"invite_state"`
+ 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)
}
type SyncKnockedRoom struct {
@@ -546,19 +417,29 @@ 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"`
- GetLoginToken *CapBooleanTrue `json:"m.get_login_token,omitempty"`
- UnstableAccountModeration *CapUnstableAccountModeration `json:"uk.timedout.msc4323,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"`
Custom map[string]interface{} `json:"-"`
}
@@ -667,44 +548,29 @@ 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 {
- PublicRoomInfo
- ChildrenState []*event.Event `json:"children_state"`
+ 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"`
}
type RespAppservicePing struct {
@@ -753,47 +619,3 @@ 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 73d82635..b23d85ad 100644
--- a/responses_test.go
+++ b/responses_test.go
@@ -8,6 +8,7 @@ package mautrix_test
import (
"encoding/json"
+ "fmt"
"testing"
"github.com/stretchr/testify/assert"
@@ -85,6 +86,7 @@ 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 4292bff5..c3ddb7e6 100644
--- a/room.go
+++ b/room.go
@@ -5,6 +5,8 @@ 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
@@ -23,8 +25,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 11957dfa..cd94215d 100644
--- a/sqlstatestore/statestore.go
+++ b/sqlstatestore/statestore.go
@@ -17,9 +17,7 @@ import (
"strings"
"github.com/rs/zerolog"
- "go.mau.fi/util/confusable"
"go.mau.fi/util/dbutil"
- "go.mau.fi/util/exslices"
"maunium.net/go/mautrix/event"
"maunium.net/go/mautrix/id"
@@ -39,8 +37,6 @@ const VersionTableName = "mx_version"
type SQLStateStore struct {
*dbutil.Database
IsBridge bool
-
- DisableNameDisambiguation bool
}
func NewSQLStateStore(db *dbutil.Database, log dbutil.DatabaseLogger, isBridge bool) *SQLStateStore {
@@ -62,9 +58,6 @@ 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
}
@@ -72,7 +65,6 @@ func (store *SQLStateStore) MarkRegistered(ctx context.Context, userID id.UserID
type Member struct {
id.UserID
event.MemberEventContent
- NameSkeleton [32]byte
}
func (store *SQLStateStore) GetRoomMembers(ctx context.Context, roomID id.RoomID, memberships ...event.Membership) (map[id.UserID]*event.MemberEventContent, error) {
@@ -88,11 +80,14 @@ 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.NewRowIterWithError(rows, func(row dbutil.Scannable) (ret Member, err error) {
+ return members, dbutil.NewRowIter(rows, func(row dbutil.Scannable) (ret Member, err error) {
err = row.Scan(&ret.UserID, &ret.Membership, &ret.Displayname, &ret.AvatarURL)
return
- }, err).Iter(func(m Member) (bool, error) {
+ }).Iter(func(m Member) (bool, error) {
members[m.UserID] = &m.MemberEventContent
return true, nil
})
@@ -159,7 +154,10 @@ func (store *SQLStateStore) FindSharedRooms(ctx context.Context, userID id.UserI
`
}
rows, err := store.Query(ctx, query, userID)
- return dbutil.NewRowIterWithError(rows, dbutil.ScanSingleColumn[id.RoomID], err).AsList()
+ if err != nil {
+ return nil, err
+ }
+ return dbutil.NewRowIter(rows, dbutil.ScanSingleColumn[id.RoomID]).AsList()
}
func (store *SQLStateStore) IsInRoom(ctx context.Context, roomID id.RoomID, userID id.UserID) bool {
@@ -185,11 +183,6 @@ 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
@@ -197,101 +190,14 @@ func (store *SQLStateStore) SetMembership(ctx context.Context, roomID id.RoomID,
return err
}
-const insertUserProfileQuery = `
- INSERT INTO mx_user_profile (room_id, user_id, membership, displayname, avatar_url, name_skeleton)
- VALUES ($1, $2, $3, $4, $5, $6)
- ON CONFLICT (room_id, user_id) DO UPDATE
- SET membership=excluded.membership,
- displayname=excluded.displayname,
- avatar_url=excluded.avatar_url,
- name_skeleton=excluded.name_skeleton
-`
-
-type userProfileRow struct {
- UserID id.UserID
- Membership event.Membership
- Displayname string
- AvatarURL id.ContentURIString
- NameSkeleton []byte
-}
-
-func (u *userProfileRow) GetMassInsertValues() [5]any {
- return [5]any{u.UserID, u.Membership, u.Displayname, u.AvatarURL, u.NameSkeleton}
-}
-
-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)
- nameSkeleton = nameSkeletonArr[:]
- }
- _, err := store.Exec(ctx, insertUserProfileQuery, roomID, userID, member.Membership, member.Displayname, member.AvatarURL, nameSkeleton)
+ _, err := store.Exec(ctx, `
+ INSERT INTO mx_user_profile (room_id, user_id, membership, displayname, avatar_url) VALUES ($1, $2, $3, $4, $5)
+ ON CONFLICT (room_id, user_id) DO UPDATE SET membership=excluded.membership, displayname=excluded.displayname, avatar_url=excluded.avatar_url
+ `, roomID, userID, member.Membership, member.Displayname, member.AvatarURL)
return err
}
-func (store *SQLStateStore) IsConfusableName(ctx context.Context, roomID id.RoomID, currentUser id.UserID, name string) ([]id.UserID, error) {
- if store.DisableNameDisambiguation {
- return nil, nil
- }
- skeleton := confusable.SkeletonHash(name)
- rows, err := store.Query(ctx, "SELECT user_id FROM mx_user_profile WHERE room_id=$1 AND name_skeleton=$2 AND user_id<>$3", roomID, skeleton[:], currentUser)
- return dbutil.NewRowIterWithError(rows, dbutil.ScanSingleColumn[id.UserID], err).AsList()
-}
-
-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 {
- return fmt.Errorf("failed to clear cached members: %w", err)
- }
- rows := make([]*userProfileRow, min(len(evts), userProfileMassInsertBatchSize))
- for _, evtsChunk := range exslices.Chunk(evts, userProfileMassInsertBatchSize) {
- rows = rows[:0]
- for _, evt := range evtsChunk {
- content, ok := evt.Content.Parsed.(*event.MemberEventContent)
- if !ok {
- continue
- }
- row := &userProfileRow{
- UserID: id.UserID(*evt.StateKey),
- Membership: content.Membership,
- Displayname: content.Displayname,
- AvatarURL: content.AvatarURL,
- }
- if !store.DisableNameDisambiguation && len(content.Displayname) > 0 {
- nameSkeletonArr := confusable.SkeletonHash(content.Displayname)
- row.NameSkeleton = nameSkeletonArr[:]
- }
- rows = append(rows, row)
- }
- query, args := userProfileMassInserter.Build([1]any{roomID}, rows)
- _, err = store.Exec(ctx, query, args...)
- if err != nil {
- return fmt.Errorf("failed to insert members: %w", err)
- }
- }
- if len(onlyMemberships) == 0 {
- err = store.MarkMembersFetched(ctx, roomID)
- if err != nil {
- return fmt.Errorf("failed to mark members as fetched: %w", err)
- }
- }
- return nil
- })
-}
-
func (store *SQLStateStore) ClearCachedMembers(ctx context.Context, roomID id.RoomID, memberships ...event.Membership) error {
query := "DELETE FROM mx_user_profile WHERE room_id=$1"
params := make([]any, len(memberships)+1)
@@ -305,57 +211,10 @@ func (store *SQLStateStore) ClearCachedMembers(ctx context.Context, roomID id.Ro
query += fmt.Sprintf(" AND membership IN (%s)", strings.Join(placeholders, ","))
}
_, err := store.Exec(ctx, query, params...)
- if err != nil {
- return err
- }
- _, err = store.Exec(ctx, "UPDATE mx_room_state SET members_fetched=false WHERE room_id=$1", roomID)
return err
}
-func (store *SQLStateStore) HasFetchedMembers(ctx context.Context, roomID id.RoomID) (fetched bool, err error) {
- 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
- }
- return
-}
-
-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
- `, roomID)
- return err
-}
-
-type userAndMembership struct {
- UserID id.UserID
- event.MemberEventContent
-}
-
-func (store *SQLStateStore) GetAllMembers(ctx context.Context, roomID id.RoomID) (map[id.UserID]*event.MemberEventContent, error) {
- rows, err := store.Query(ctx, "SELECT user_id, membership, displayname, avatar_url FROM mx_user_profile WHERE room_id=$1", roomID)
- if err != nil {
- return nil, err
- }
- output := make(map[id.UserID]*event.MemberEventContent)
- err = dbutil.NewRowIterWithError(rows, func(row dbutil.Scannable) (res userAndMembership, err error) {
- err = row.Scan(&res.UserID, &res.Membership, &res.Displayname, &res.AvatarURL)
- return
- }, err).Iter(func(member userAndMembership) (bool, error) {
- output[member.UserID] = &member.MemberEventContent
- return true, nil
- })
- return output, err
-}
-
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)
@@ -370,7 +229,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 AND encryption IS NOT NULL", roomID).
+ QueryRow(ctx, "SELECT encryption FROM mx_room_state WHERE room_id=$1", roomID).
Scan(&data)
if errors.Is(err, sql.ErrNoRows) {
return nil, nil
@@ -393,9 +252,6 @@ 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
@@ -404,92 +260,89 @@ 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, 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})
+ QueryRow(ctx, "SELECT power_levels FROM mx_room_state WHERE room_id=$1", roomID).
+ Scan(&dbutil.JSON{Data: &levels})
if errors.Is(err, sql.ErrNoRows) {
- return nil, nil
- } else if err != nil {
- return nil, err
- }
- if levels.CreateEvent != nil {
- err = levels.CreateEvent.Content.ParseRaw(event.StateCreate)
+ err = nil
}
return
}
func (store *SQLStateStore) GetPowerLevel(ctx context.Context, roomID id.RoomID, userID id.UserID) (int, error) {
- levels, err := store.GetPowerLevels(ctx, roomID)
- if err != nil {
- return 0, err
+ 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
}
- return levels.GetUserLevel(userID), nil
}
func (store *SQLStateStore) GetPowerLevelRequirement(ctx context.Context, roomID id.RoomID, eventType event.Type) (int, error) {
- levels, err := store.GetPowerLevels(ctx, roomID)
- if err != nil {
- return 0, err
+ 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
}
- return levels.GetEventLevel(eventType), nil
}
func (store *SQLStateStore) HasPowerLevel(ctx context.Context, roomID id.RoomID, userID id.UserID, eventType event.Type) (bool, error) {
- levels, err := store.GetPowerLevels(ctx, roomID)
- if err != nil {
- return false, err
+ 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
}
- 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 4679f1c6..41c2b9a1 100644
--- a/sqlstatestore/v00-latest-revision.sql
+++ b/sqlstatestore/v00-latest-revision.sql
@@ -1,4 +1,4 @@
--- v0 -> v10 (compatible with v3+): Latest revision
+-- v0 -> v5: Latest revision
CREATE TABLE mx_registrations (
user_id TEXT PRIMARY KEY
@@ -8,25 +8,16 @@ CREATE TABLE mx_registrations (
CREATE TYPE membership AS ENUM ('join', 'leave', 'invite', 'ban', 'knock');
CREATE TABLE mx_user_profile (
- room_id TEXT,
- user_id TEXT,
- membership membership NOT NULL,
- displayname TEXT NOT NULL DEFAULT '',
- avatar_url TEXT NOT NULL DEFAULT '',
-
- name_skeleton bytea,
-
+ room_id TEXT,
+ user_id TEXT,
+ membership membership NOT NULL,
+ displayname TEXT NOT NULL DEFAULT '',
+ avatar_url TEXT NOT NULL DEFAULT '',
PRIMARY KEY (room_id, user_id)
);
-CREATE INDEX mx_user_profile_membership_idx ON mx_user_profile (room_id, membership);
-CREATE INDEX mx_user_profile_name_skeleton_idx ON mx_user_profile (room_id, name_skeleton);
-
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
+ room_id TEXT PRIMARY KEY,
+ power_levels jsonb,
+ encryption jsonb
);
diff --git a/sqlstatestore/v05-mark-encryption-state-resync.go b/sqlstatestore/v05-mark-encryption-state-resync.go
index b7f2b1c2..bf44d308 100644
--- a/sqlstatestore/v05-mark-encryption-state-resync.go
+++ b/sqlstatestore/v05-mark-encryption-state-resync.go
@@ -8,7 +8,7 @@ import (
)
func init() {
- UpgradeTable.Register(-1, 5, 0, "Mark rooms that need crypto state event resynced", dbutil.TxnModeOn, func(ctx context.Context, db *dbutil.Database) error {
+ UpgradeTable.Register(-1, 5, 0, "Mark rooms that need crypto state event resynced", true, func(ctx context.Context, db *dbutil.Database) error {
portalExists, err := db.TableExists(ctx, "portal")
if err != nil {
return fmt.Errorf("failed to check if portal table exists")
diff --git a/sqlstatestore/v06-displayname-disambiguation.go b/sqlstatestore/v06-displayname-disambiguation.go
deleted file mode 100644
index d0d1d502..00000000
--- a/sqlstatestore/v06-displayname-disambiguation.go
+++ /dev/null
@@ -1,55 +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 sqlstatestore
-
-import (
- "context"
-
- "go.mau.fi/util/confusable"
- "go.mau.fi/util/dbutil"
-
- "maunium.net/go/mautrix/id"
-)
-
-type roomUserName struct {
- RoomID id.RoomID
- UserID id.UserID
- Name string
-}
-
-func init() {
- UpgradeTable.Register(-1, 6, 3, "Add disambiguation column for user profiles", dbutil.TxnModeOn, func(ctx context.Context, db *dbutil.Database) error {
- _, err := db.Exec(ctx, `
- ALTER TABLE mx_user_profile ADD COLUMN name_skeleton bytea;
- CREATE INDEX mx_user_profile_membership_idx ON mx_user_profile (room_id, membership);
- CREATE INDEX mx_user_profile_name_skeleton_idx ON mx_user_profile (room_id, name_skeleton);
- `)
- if err != nil {
- return err
- }
- const ChunkSize = 1000
- const GetEntriesChunkQuery = "SELECT room_id, user_id, displayname FROM mx_user_profile WHERE displayname<>'' LIMIT $1 OFFSET $2"
- const SetSkeletonHashQuery = `UPDATE mx_user_profile SET name_skeleton = $3 WHERE room_id = $1 AND user_id = $2`
- for offset := 0; ; offset += ChunkSize {
- entries, err := dbutil.NewSimpleReflectRowIter[roomUserName](db.Query(ctx, GetEntriesChunkQuery, ChunkSize, offset)).AsList()
- if err != nil {
- return err
- }
- for _, entry := range entries {
- skel := confusable.SkeletonHash(entry.Name)
- _, err = db.Exec(ctx, SetSkeletonHashQuery, entry.RoomID, entry.UserID, skel[:])
- if err != nil {
- return err
- }
- }
- if len(entries) < ChunkSize {
- break
- }
- }
- return nil
- })
-}
diff --git a/sqlstatestore/v07-full-member-flag.sql b/sqlstatestore/v07-full-member-flag.sql
deleted file mode 100644
index 32f2ef6c..00000000
--- a/sqlstatestore/v07-full-member-flag.sql
+++ /dev/null
@@ -1,2 +0,0 @@
--- v7 (compatible with v3+): Add flag for whether the full member list has been fetched
-ALTER TABLE mx_room_state ADD COLUMN members_fetched BOOLEAN NOT NULL DEFAULT false;
diff --git a/sqlstatestore/v08-create-event.sql b/sqlstatestore/v08-create-event.sql
deleted file mode 100644
index 9f1b55c9..00000000
--- a/sqlstatestore/v08-create-event.sql
+++ /dev/null
@@ -1,2 +0,0 @@
--- 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
deleted file mode 100644
index ca951068..00000000
--- a/sqlstatestore/v09-clear-empty-room-ids.sql
+++ /dev/null
@@ -1,3 +0,0 @@
--- 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
deleted file mode 100644
index 3074c46a..00000000
--- a/sqlstatestore/v10-join-rules.sql
+++ /dev/null
@@ -1,2 +0,0 @@
--- 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 2bd498dd..8fe5f8b3 100644
--- a/statestore.go
+++ b/statestore.go
@@ -8,7 +8,6 @@ package mautrix
import (
"context"
- "maps"
"sync"
"github.com/rs/zerolog"
@@ -27,41 +26,21 @@ type StateStore interface {
TryGetMember(ctx context.Context, roomID id.RoomID, userID id.UserID) (*event.MemberEventContent, error)
SetMembership(ctx context.Context, roomID id.RoomID, userID id.UserID, membership event.Membership) error
SetMember(ctx context.Context, roomID id.RoomID, userID id.UserID, member *event.MemberEventContent) error
- IsConfusableName(ctx context.Context, roomID id.RoomID, currentUser id.UserID, name string) ([]id.UserID, error)
ClearCachedMembers(ctx context.Context, roomID id.RoomID, memberships ...event.Membership) error
- ReplaceCachedMembers(ctx context.Context, roomID id.RoomID, evts []*event.Event, onlyMemberships ...event.Membership) error
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)
-
SetEncryptionEvent(ctx context.Context, roomID id.RoomID, content *event.EncryptionEventContent) error
IsEncrypted(ctx context.Context, roomID id.RoomID) (bool, error)
GetRoomJoinedOrInvitedMembers(ctx context.Context, roomID id.RoomID) ([]id.UserID, error)
}
-type StateStoreUpdater interface {
- UpdateState(ctx context.Context, evt *event.Event)
-}
-
func UpdateStateStore(ctx context.Context, store StateStore, evt *event.Event) {
if store == nil || evt == nil || evt.StateKey == nil {
return
}
- if directUpdater, ok := store.(StateStoreUpdater); ok {
- directUpdater.UpdateState(ctx, evt)
- return
- }
// We only care about events without a state key (power levels, encryption) or member events with state key
if evt.Type != event.StateMember && evt.GetStateKey() != "" {
return
@@ -74,19 +53,6 @@ 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, event.StateCreate:
- zerolog.Ctx(ctx).Warn().
- Stringer("event_id", evt.ID).
- Str("event_type", evt.Type.Type).
- Type("content_type", evt.Content.Parsed).
- Msg("Got known event type with unknown content type in UpdateStateStore")
- }
}
if err != nil {
zerolog.Ctx(ctx).Warn().Err(err).
@@ -106,30 +72,23 @@ func (cli *Client) StateStoreSyncHandler(ctx context.Context, evt *event.Event)
}
type MemoryStateStore struct {
- Registrations map[id.UserID]bool `json:"registrations"`
- Members map[id.RoomID]map[id.UserID]*event.MemberEventContent `json:"memberships"`
- 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"`
+ Registrations map[id.UserID]bool `json:"registrations"`
+ Members map[id.RoomID]map[id.UserID]*event.MemberEventContent `json:"memberships"`
+ PowerLevels map[id.RoomID]*event.PowerLevelsEventContent `json:"power_levels"`
+ Encryption map[id.RoomID]*event.EncryptionEventContent `json:"encryption"`
registrationsLock sync.RWMutex
membersLock sync.RWMutex
powerLevelsLock sync.RWMutex
encryptionLock sync.RWMutex
- joinRulesLock sync.RWMutex
}
func NewMemoryStateStore() StateStore {
return &MemoryStateStore{
- Registrations: make(map[id.UserID]bool),
- Members: make(map[id.RoomID]map[id.UserID]*event.MemberEventContent),
- 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),
+ Registrations: make(map[id.UserID]bool),
+ Members: make(map[id.RoomID]map[id.UserID]*event.MemberEventContent),
+ PowerLevels: make(map[id.RoomID]*event.PowerLevelsEventContent),
+ Encryption: make(map[id.RoomID]*event.EncryptionEventContent),
}
}
@@ -184,11 +143,6 @@ func (store *MemoryStateStore) GetMember(ctx context.Context, roomID id.RoomID,
return member, err
}
-func (store *MemoryStateStore) IsConfusableName(ctx context.Context, roomID id.RoomID, currentUser id.UserID, name string) ([]id.UserID, error) {
- // TODO implement?
- return nil, nil
-}
-
func (store *MemoryStateStore) TryGetMember(_ context.Context, roomID id.RoomID, userID id.UserID) (member *event.MemberEventContent, err error) {
store.membersLock.RLock()
defer store.membersLock.RUnlock()
@@ -269,40 +223,9 @@ func (store *MemoryStateStore) ClearCachedMembers(_ context.Context, roomID id.R
}
}
}
- store.MembersFetched[roomID] = false
return nil
}
-func (store *MemoryStateStore) HasFetchedMembers(ctx context.Context, roomID id.RoomID) (bool, error) {
- store.membersLock.RLock()
- defer store.membersLock.RUnlock()
- return store.MembersFetched[roomID], nil
-}
-
-func (store *MemoryStateStore) MarkMembersFetched(ctx context.Context, roomID id.RoomID) error {
- store.membersLock.Lock()
- defer store.membersLock.Unlock()
- store.MembersFetched[roomID] = true
- return nil
-}
-
-func (store *MemoryStateStore) ReplaceCachedMembers(ctx context.Context, roomID id.RoomID, evts []*event.Event, onlyMemberships ...event.Membership) error {
- _ = store.ClearCachedMembers(ctx, roomID, onlyMemberships...)
- for _, evt := range evts {
- UpdateStateStore(ctx, store, evt)
- }
- if len(onlyMemberships) == 0 {
- _ = store.MarkMembersFetched(ctx, roomID)
- }
- return nil
-}
-
-func (store *MemoryStateStore) GetAllMembers(ctx context.Context, roomID id.RoomID) (map[id.UserID]*event.MemberEventContent, error) {
- store.membersLock.RLock()
- defer store.membersLock.RUnlock()
- return maps.Clone(store.Members[roomID]), nil
-}
-
func (store *MemoryStateStore) SetPowerLevels(_ context.Context, roomID id.RoomID, levels *event.PowerLevelsEventContent) error {
store.powerLevelsLock.Lock()
store.PowerLevels[roomID] = levels
@@ -313,9 +236,6 @@ 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
}
@@ -332,23 +252,6 @@ 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
@@ -362,31 +265,7 @@ 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
}
-
-func (store *MemoryStateStore) FindSharedRooms(ctx context.Context, userID id.UserID) (rooms []id.RoomID, err error) {
- store.membersLock.RLock()
- defer store.membersLock.RUnlock()
- for roomID, members := range store.Members {
- if _, ok := members[userID]; ok {
- rooms = append(rooms, roomID)
- }
- }
- return rooms, nil
-}
diff --git a/synapseadmin/client.go b/synapseadmin/client.go
index 6925ca7d..775b4b13 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 {
- Client *mautrix.Client
+ *mautrix.Client
}
func (cli *Client) BuildAdminURL(path ...any) string {
- return cli.Client.BuildURL(mautrix.SynapseAdminURLPath(path))
+ return cli.BuildURL(mautrix.SynapseAdminURLPath(path))
}
diff --git a/synapseadmin/register.go b/synapseadmin/register.go
index 05e0729a..d7a94f6f 100644
--- a/synapseadmin/register.go
+++ b/synapseadmin/register.go
@@ -73,7 +73,11 @@ 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.Client.MakeRequest(ctx, http.MethodGet, cli.BuildAdminURL("v1", "register"), nil, &resp)
+ _, err := cli.MakeFullRequest(ctx, mautrix.FullRequest{
+ Method: http.MethodGet,
+ URL: cli.BuildURL(mautrix.SynapseAdminURLPath{"v1", "register"}),
+ ResponseJSON: &resp,
+ })
if err != nil {
return "", err
}
@@ -93,7 +97,12 @@ func (cli *Client) SharedSecretRegister(ctx context.Context, sharedSecret string
}
req.SHA1Checksum = req.Sign(sharedSecret)
var resp mautrix.RespRegister
- _, err = cli.Client.MakeRequest(ctx, http.MethodPost, cli.BuildAdminURL("v1", "register"), &req, &resp)
+ _, err = cli.MakeFullRequest(ctx, mautrix.FullRequest{
+ Method: http.MethodPost,
+ URL: cli.BuildURL(mautrix.SynapseAdminURLPath{"v1", "register"}),
+ RequestJSON: req,
+ ResponseJSON: &resp,
+ })
if err != nil {
return nil, err
}
diff --git a/synapseadmin/roomapi.go b/synapseadmin/roomapi.go
index 0925b748..0953377e 100644
--- a/synapseadmin/roomapi.go
+++ b/synapseadmin/roomapi.go
@@ -75,17 +75,16 @@ 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
- reqURL := cli.Client.BuildURLWithQuery(mautrix.SynapseAdminURLPath{"v1", "rooms"}, req.BuildQuery())
- _, err := cli.Client.MakeRequest(ctx, http.MethodGet, reqURL, nil, &resp)
+ var reqURL string
+ reqURL = cli.BuildURLWithQuery(mautrix.SynapseAdminURLPath{"v1", "rooms"}, req.BuildQuery())
+ _, err := cli.MakeFullRequest(ctx, mautrix.FullRequest{
+ Method: http.MethodGet,
+ URL: reqURL,
+ ResponseJSON: &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.
@@ -109,14 +108,17 @@ func (cli *Client) RoomMessages(ctx context.Context, roomID id.RoomID, from, to
if limit != 0 {
query["limit"] = strconv.Itoa(limit)
}
- urlPath := cli.Client.BuildURLWithQuery(mautrix.SynapseAdminURLPath{"v1", "rooms", roomID, "messages"}, query)
- _, err = cli.Client.MakeRequest(ctx, http.MethodGet, urlPath, nil, &resp)
+ urlPath := cli.BuildURLWithQuery(mautrix.SynapseAdminURLPath{"v1", "rooms", roomID, "messages"}, query)
+ _, err = cli.MakeFullRequest(ctx, mautrix.FullRequest{
+ Method: http.MethodGet,
+ URL: urlPath,
+ ResponseJSON: &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"`
@@ -127,19 +129,6 @@ 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.
@@ -148,35 +137,13 @@ type RespDeleteRoomStatus 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.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{
+ _, err := cli.MakeFullRequest(ctx, mautrix.FullRequest{
Method: http.MethodDelete,
URL: reqURL,
- RequestJSON: &req,
ResponseJSON: &resp,
- MaxAttempts: 1,
- // Use a fresh HTTP client without timeouts
- Client: httpClient,
+ RequestJSON: &req,
})
- httpClient.CloseIdleConnections()
- return
+ return resp, err
}
type RespRoomsMembers struct {
@@ -190,7 +157,11 @@ 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.Client.MakeRequest(ctx, http.MethodGet, reqURL, nil, &resp)
+ _, err := cli.MakeFullRequest(ctx, mautrix.FullRequest{
+ Method: http.MethodGet,
+ URL: reqURL,
+ ResponseJSON: &resp,
+ })
return resp, err
}
@@ -203,7 +174,11 @@ 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.Client.MakeRequest(ctx, http.MethodPost, reqURL, &req, nil)
+ _, err := cli.MakeFullRequest(ctx, mautrix.FullRequest{
+ Method: http.MethodPost,
+ URL: reqURL,
+ RequestJSON: &req,
+ })
return err
}
@@ -216,7 +191,11 @@ 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.Client.MakeRequest(ctx, http.MethodPost, reqURL, &req, nil)
+ _, err := cli.MakeFullRequest(ctx, mautrix.FullRequest{
+ Method: http.MethodPost,
+ URL: reqURL,
+ RequestJSON: &req,
+ })
return err
}
@@ -229,7 +208,11 @@ 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.Client.MakeRequest(ctx, http.MethodPut, reqURL, &req, nil)
+ _, err := cli.MakeFullRequest(ctx, mautrix.FullRequest{
+ Method: http.MethodPut,
+ URL: reqURL,
+ RequestJSON: &req,
+ })
return err
}
@@ -245,6 +228,10 @@ 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.Client.MakeRequest(ctx, http.MethodGet, reqURL, nil, &resp)
+ _, err := cli.MakeFullRequest(ctx, mautrix.FullRequest{
+ Method: http.MethodGet,
+ URL: reqURL,
+ ResponseJSON: &resp,
+ })
return resp, err
}
diff --git a/synapseadmin/userapi.go b/synapseadmin/userapi.go
index b1de55b6..31d0a6dc 100644
--- a/synapseadmin/userapi.go
+++ b/synapseadmin/userapi.go
@@ -32,7 +32,11 @@ 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.Client.MakeRequest(ctx, http.MethodPost, reqURL, &req, nil)
+ _, err := cli.MakeFullRequest(ctx, mautrix.FullRequest{
+ Method: http.MethodPost,
+ URL: reqURL,
+ RequestJSON: &req,
+ })
return err
}
@@ -43,8 +47,12 @@ 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.Client.BuildURLWithQuery(mautrix.SynapseAdminURLPath{"v1", "username_available"}, map[string]string{"username": username})
- _, err = cli.Client.MakeRequest(ctx, http.MethodGet, u, nil, &resp)
+ u := cli.BuildURLWithQuery(mautrix.SynapseAdminURLPath{"v1", "username_available"}, map[string]string{"username": username})
+ _, err = cli.MakeFullRequest(ctx, mautrix.FullRequest{
+ Method: http.MethodGet,
+ URL: u,
+ ResponseJSON: &resp,
+ })
if err == nil && !resp.Available {
err = fmt.Errorf(`request returned OK status without "available": true`)
}
@@ -65,7 +73,11 @@ 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.Client.MakeRequest(ctx, http.MethodGet, cli.BuildAdminURL("v2", "users", userID, "devices"), nil, &resp)
+ _, err = cli.MakeFullRequest(ctx, mautrix.FullRequest{
+ Method: http.MethodGet,
+ URL: cli.BuildAdminURL("v2", "users", userID, "devices"),
+ ResponseJSON: &resp,
+ })
return
}
@@ -89,7 +101,11 @@ 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.Client.MakeRequest(ctx, http.MethodGet, cli.BuildAdminURL("v2", "users", userID), nil, &resp)
+ _, err = cli.MakeFullRequest(ctx, mautrix.FullRequest{
+ Method: http.MethodGet,
+ URL: cli.BuildAdminURL("v2", "users", userID),
+ ResponseJSON: &resp,
+ })
return
}
@@ -102,20 +118,11 @@ 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.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)
+ _, err := cli.MakeFullRequest(ctx, mautrix.FullRequest{
+ Method: http.MethodPost,
+ URL: reqURL,
+ RequestJSON: &req,
+ })
return err
}
@@ -137,7 +144,11 @@ 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.Client.MakeRequest(ctx, http.MethodPut, reqURL, &req, nil)
+ _, err := cli.MakeFullRequest(ctx, mautrix.FullRequest{
+ Method: http.MethodPut,
+ URL: reqURL,
+ RequestJSON: &req,
+ })
return err
}
@@ -153,7 +164,11 @@ 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.Client.MakeRequest(ctx, http.MethodPost, reqURL, &req, nil)
+ _, err := cli.MakeFullRequest(ctx, mautrix.FullRequest{
+ Method: http.MethodPost,
+ URL: reqURL,
+ RequestJSON: &req,
+ })
return err
}
@@ -163,7 +178,11 @@ 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.Client.MakeRequest(ctx, http.MethodGet, cli.BuildAdminURL("v1", "users", userID, "override_ratelimit"), nil, &resp)
+ _, err = cli.MakeFullRequest(ctx, mautrix.FullRequest{
+ Method: http.MethodGet,
+ URL: cli.BuildAdminURL("v1", "users", userID, "override_ratelimit"),
+ ResponseJSON: &resp,
+ })
return
}
@@ -171,6 +190,9 @@ 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.Client.MakeRequest(ctx, http.MethodDelete, cli.BuildAdminURL("v1", "users", userID, "override_ratelimit"), nil, nil)
+ _, err = cli.MakeFullRequest(ctx, mautrix.FullRequest{
+ Method: http.MethodDelete,
+ URL: cli.BuildAdminURL("v1", "users", userID, "override_ratelimit"),
+ })
return
}
diff --git a/sync.go b/sync.go
index 598df8e0..d4208404 100644
--- a/sync.go
+++ b/sync.go
@@ -90,7 +90,6 @@ 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) {
@@ -98,38 +97,33 @@ func (s *DefaultSyncer) ProcessResponse(ctx context.Context, res *RespSync, sinc
}
}
- 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)
+ s.processSyncEvents(ctx, "", res.ToDevice.Events, event.SourceToDevice)
+ s.processSyncEvents(ctx, "", res.Presence.Events, event.SourcePresence)
+ s.processSyncEvents(ctx, "", res.AccountData.Events, event.SourceAccountData)
for roomID, roomData := range res.Rooms.Join {
- 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)
+ 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)
}
for roomID, roomData := range res.Rooms.Invite {
- s.processSyncEvents(ctx, roomID, roomData.State.Events, event.SourceInvite|event.SourceState, false)
+ s.processSyncEvents(ctx, roomID, roomData.State.Events, event.SourceInvite|event.SourceState)
}
for roomID, roomData := range res.Rooms.Leave {
- s.processSyncEvents(ctx, roomID, roomData.State.Events, event.SourceLeave|event.SourceState, false)
- s.processSyncEvents(ctx, roomID, roomData.Timeline.Events, event.SourceLeave|event.SourceTimeline, false)
+ s.processSyncEvents(ctx, roomID, roomData.State.Events, event.SourceLeave|event.SourceState)
+ s.processSyncEvents(ctx, roomID, roomData.Timeline.Events, event.SourceLeave|event.SourceTimeline)
}
return
}
-func (s *DefaultSyncer) processSyncEvents(ctx context.Context, roomID id.RoomID, events []*event.Event, source event.Source, ignoreState bool) {
+func (s *DefaultSyncer) processSyncEvents(ctx context.Context, roomID id.RoomID, events []*event.Event, source event.Source) {
for _, evt := range events {
- s.processSyncEvent(ctx, roomID, evt, source, ignoreState)
+ s.processSyncEvent(ctx, roomID, evt, source)
}
}
-func (s *DefaultSyncer) processSyncEvent(ctx context.Context, roomID id.RoomID, evt *event.Event, source event.Source, ignoreState bool) {
+func (s *DefaultSyncer) processSyncEvent(ctx context.Context, roomID id.RoomID, evt *event.Event, source event.Source) {
evt.RoomID = roomID
// Ensure the type class is correct. It's safe to mutate the class since the event type is not a pointer.
@@ -155,7 +149,6 @@ func (s *DefaultSyncer) processSyncEvent(ctx context.Context, roomID id.RoomID,
}
evt.Mautrix.EventSource = source
- evt.Mautrix.IgnoreState = ignoreState
s.Dispatch(ctx, evt)
}
@@ -198,8 +191,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,
},
},
@@ -264,7 +257,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.Event
+ var inviteState []event.StrippedState
var inviteEvt *event.Event
for _, evt := range meta.State.Events {
if evt.Type == event.StateMember && evt.GetStateKey() == cli.UserID.String() {
@@ -272,7 +265,12 @@ func (cli *Client) MoveInviteState(ctx context.Context, resp *RespSync, _ string
} else {
evt.Type.Class = event.StateEventType
_ = evt.Content.ParseRaw(evt.Type)
- inviteState = append(inviteState, evt)
+ inviteState = append(inviteState, event.StrippedState{
+ Content: evt.Content,
+ Type: evt.Type,
+ StateKey: evt.GetStateKey(),
+ Sender: evt.Sender,
+ })
}
}
if inviteEvt != nil {
diff --git a/url.go b/url.go
index 91b3d49d..4646b442 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.BuildURLWithFullQuery(urlPath, nil)
+ return cli.BuildURLWithQuery(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.BuildURLWithFullQuery(ClientURLPath(urlPath), nil)
+ return cli.BuildURLWithQuery(ClientURLPath(urlPath), nil)
}
type PrefixableURLPath interface {
@@ -97,30 +97,15 @@ 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 {
query.Set("user_id", string(cli.UserID))
}
- if cli.SetAppServiceDeviceID && cli.DeviceID != "" {
- query.Set("device_id", string(cli.DeviceID))
- query.Set("org.matrix.msc3202.device_id", string(cli.DeviceID))
- }
- if fn != nil {
- fn(query)
+ if urlQuery != nil {
+ for k, v := range urlQuery {
+ query.Set(k, v)
+ }
}
hsURL.RawQuery = query.Encode()
return hsURL.String()
diff --git a/version.go b/version.go
index f00bbf39..82817bca 100644
--- a/version.go
+++ b/version.go
@@ -4,11 +4,10 @@ import (
"fmt"
"regexp"
"runtime"
- "runtime/debug"
"strings"
)
-const Version = "v0.26.3"
+const Version = "v0.18.0"
var GoModVersion = ""
var Commit = ""
@@ -16,20 +15,11 @@ 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 := regexp.MustCompile(`v.+\d{14}-([0-9a-f]{12})`).FindStringSubmatch(GoModVersion)
+ match := goModVersionRegex.FindStringSubmatch(GoModVersion)
if match != nil {
Commit = match[1]
}
diff --git a/versions.go b/versions.go
index 61b2e4ea..d3dd3c67 100644
--- a/versions.go
+++ b/versions.go
@@ -19,9 +19,6 @@ type RespVersions struct {
}
func (versions *RespVersions) ContainsFunc(match func(found SpecVersion) bool) bool {
- if versions == nil {
- return false
- }
for _, found := range versions.Versions {
if match(found) {
return true
@@ -43,9 +40,6 @@ func (versions *RespVersions) ContainsGreaterOrEqual(version SpecVersion) bool {
}
func (versions *RespVersions) GetLatest() (latest SpecVersion) {
- if versions == nil {
- return
- }
for _, ver := range versions.Versions {
if ver.GreaterThan(latest) {
latest = ver
@@ -60,34 +54,16 @@ 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}
- 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"}
+ FeatureAppservicePing = UnstableFeature{UnstableFlag: "fi.mau.msc2659.stable", SpecVersion: SpecV17}
- 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"}
+ 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"}
)
func (versions *RespVersions) Supports(feature UnstableFeature) bool {
- if versions == nil {
- return false
- }
return versions.UnstableFeatures[feature.UnstableFlag] ||
(!feature.SpecVersion.IsEmpty() && versions.ContainsGreaterOrEqual(feature.SpecVersion))
}
@@ -119,14 +95,6 @@ var (
SpecV17 = MustParseSpecVersion("v1.7")
SpecV18 = MustParseSpecVersion("v1.8")
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 {