XMPP: Support XEP-0461: Message Replies #134
There are no files selected for viewing
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -8,6 +8,7 @@ import ( | |
| "sync" | ||
| "time" | ||
|
|
||
| lru "github.com/hashicorp/golang-lru/v2" | ||
| "github.com/jpillora/backoff" | ||
| "github.com/matterbridge-org/matterbridge/bridge" | ||
| "github.com/matterbridge-org/matterbridge/bridge/config" | ||
|
|
@@ -29,10 +30,12 @@ type UploadBufferEntry struct { | |
| type Bxmpp struct { | ||
| *bridge.Config | ||
|
|
||
| startTime time.Time | ||
| xc *xmpp.Client | ||
| xmppMap map[string]string | ||
| connected bool | ||
| stanzaIDs *lru.Cache[string, string] | ||
| replyHeaders *lru.Cache[string, xmpp.Reply] | ||
| sync.RWMutex | ||
|
|
||
| avatarAvailability map[string]bool | ||
|
|
@@ -58,12 +61,23 @@ type Bxmpp struct { | |
| } | ||
|
|
||
| func New(cfg *bridge.Config) bridge.Bridger { | ||
| stanzaIDs, err := lru.New[string, string](5000) | ||
| if err != nil { | ||
| cfg.Log.Fatalf("Could not create LRU cache: %v", err) | ||
| } | ||
| replyHeaders, err := lru.New[string, xmpp.Reply](5000) | ||
| if err != nil { | ||
| cfg.Log.Fatalf("Could not create LRU cache: %v", err) | ||
| } | ||
|
|
||
| return &Bxmpp{ | ||
| Config: cfg, | ||
| xmppMap: make(map[string]string), | ||
| avatarAvailability: make(map[string]bool), | ||
| avatarMap: make(map[string]string), | ||
| httpUploadBuffer: make(map[string]*UploadBufferEntry), | ||
| stanzaIDs: stanzaIDs, | ||
| replyHeaders: replyHeaders, | ||
| } | ||
| } | ||
|
|
||
|
|
@@ -142,19 +156,27 @@ func (b *Bxmpp) Send(msg config.Message) (string, error) { | |
| } | ||
| } | ||
|
|
||
| // XEP-0461: populate reply fields if this message is a reply. | ||
| var reply *xmpp.Reply | ||
| if msg.ParentValid() { | ||
| if _reply, ok := b.replyHeaders.Get(msg.ParentID); ok { | ||
| reply = &_reply | ||
| } | ||
| } | ||
|
|
||
| // Post normal message. | ||
| b.Log.Debugf("=> Sending message %#v", msg) | ||
| // Generate a dummy ID because to avoid collision with other internal messages | ||
| msgID := xid.New().String() | ||
| if _, err := b.xc.Send(xmpp.Chat{ | ||
| Type: "groupchat", | ||
| Remote: msg.Channel + "@" + b.GetString("Muc"), | ||
| Text: msg.Username + msg.Text, | ||
| OriginID: msgID, | ||
| Reply: reply, | ||
| }); err != nil { | ||
| return "", err | ||
| } | ||
| return msgID, nil | ||
| } | ||
|
|
||
|
|
@@ -300,6 +322,13 @@ func (b *Bxmpp) handleXMPP() error { | |
| if v.Type == "groupchat" { | ||
| b.Log.Debugf("== Receiving %#v", v) | ||
|
|
||
| if v.StanzaID.ID != "" { | ||
| // Here the stanza-id has been set by the server and can be used to provide replies | ||
| // as explained in XEP-0461 https://xmpp.org/extensions/xep-0461.html#business-id | ||
| b.stanzaIDs.Add(v.StanzaID.ID, v.ID) | ||
| b.replyHeaders.Add(v.ID, xmpp.Reply{ID: v.StanzaID.ID, To: v.Remote}) | ||
| } | ||
|
Comment on lines
+325
to
+330
There was a problem hiding this comment. I don't want to be noisy in another project's repo so I'm following-up on this here, although the issue crosses both projects. Why
|
||
|
|
||
| // Skip invalid messages. | ||
| if b.skipMessage(v) { | ||
| continue | ||
|
|
@@ -320,18 +349,42 @@ func (b *Bxmpp) handleXMPP() error { | |
| avatar = getAvatar(b.avatarMap, v.Remote, b.General) | ||
| } | ||
|
|
||
| // If there was a <reply>, map the StanzaID to the local matterbridge message ID | ||
| // so we can inform the other bridges of this message has a parent | ||
| var parentID string | ||
| var parentText string | ||
| if v.Reply != nil { | ||
| if _parentID, ok := b.stanzaIDs.Get(v.Reply.ID); ok { | ||
| parentID = _parentID | ||
| } | ||
| body := v.Text | ||
| // Capture quoted lines into parentText so destination bridges can decide | ||
| // how they should be displayed. | ||
| for strings.HasPrefix(body, "> ") { | ||
| lineIdx := strings.IndexRune(body, '\n') | ||
| if lineIdx == -1 { | ||
| parentText += body[2:] | ||
| body = "" | ||
| } else { | ||
| parentText += body[2:lineIdx] + "\n" | ||
| body = body[(lineIdx + 1):] | ||
| } | ||
| } | ||
| parentText = strings.TrimRight(parentText, "\n") | ||
| v.Text = body | ||
| } | ||
|
|
||
| rmsg := config.Message{ | ||
| Username: b.parseNick(v.Remote), | ||
| Text: v.Text, | ||
| Channel: b.parseChannel(v.Remote), | ||
| Account: b.Account, | ||
| Avatar: avatar, | ||
| UserID: v.Remote, | ||
| ID: v.ID, | ||
| Event: event, | ||
| ParentID: parentID, | ||
| ParentText: parentText, | ||
| } | ||
|
|
||
| // Check if we have an action event. | ||
|
|
||
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Currently matterbridge insists on knowing a message ID right after
bridge.Send. I believe this may be a wrong architecture designed around synchronous operations, but we really want to make matterbridge asynchronous by nature.I think your interpretation of the codebase is correct and "should work". I'm ok to merge this (after more review etc), but i would also appreciate if we took some time in the coming month to document the reply system entirely and make it fully asynchronous.