- Notifications
You must be signed in to change notification settings - Fork80
/
Copy pathsync.go
290 lines (258 loc) · 10.7 KB
/
sync.go
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
// 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 mautrix
import (
"context"
"errors"
"fmt"
"runtime/debug"
"time"
"maunium.net/go/mautrix/event"
"maunium.net/go/mautrix/id"
)
// EventHandler handles a single event from a sync response.
typeEventHandlerfunc(ctx context.Context,evt*event.Event)
// SyncHandler handles a whole sync response. If the return value is false, handling will be stopped completely.
typeSyncHandlerfunc(ctx context.Context,resp*RespSync,sincestring)bool
// Syncer is an interface that must be satisfied in order to do /sync requests on a client.
typeSyncerinterface {
// ProcessResponse processes the /sync response. The since parameter is the since= value that was used to produce the response.
// This is useful for detecting the very first sync (since=""). If an error is return, Syncing will be stopped permanently.
ProcessResponse(ctx context.Context,resp*RespSync,sincestring)error
// OnFailedSync returns either the time to wait before retrying or an error to stop syncing permanently.
OnFailedSync(res*RespSync,errerror) (time.Duration,error)
// GetFilterJSON for the given user ID. NOT the filter ID.
GetFilterJSON(userID id.UserID)*Filter
}
typeExtensibleSyncerinterface {
OnSync(callbackSyncHandler)
OnEvent(callbackEventHandler)
OnEventType(eventType event.Type,callbackEventHandler)
}
typeDispatchableSyncerinterface {
Dispatch(ctx context.Context,evt*event.Event)
}
// DefaultSyncer is the default syncing implementation. You can either write your own syncer, or selectively
// replace parts of this default syncer (e.g. the ProcessResponse method). The default syncer uses the observer
// pattern to notify callers about incoming events. See DefaultSyncer.OnEventType for more information.
typeDefaultSyncerstruct {
// syncListeners want the whole sync response, e.g. the crypto machine
syncListeners []SyncHandler
// globalListeners want all events
globalListeners []EventHandler
// listeners want a specific event type
listenersmap[event.Type][]EventHandler
// ParseEventContent determines whether or not event content should be parsed before passing to handlers.
ParseEventContentbool
// ParseErrorHandler is called when event.Content.ParseRaw returns an error.
// If it returns false, the event will not be forwarded to listeners.
ParseErrorHandlerfunc(evt*event.Event,errerror)bool
// FilterJSON is used when the client starts syncing and doesn't get an existing filter ID from SyncStore's LoadFilterID.
FilterJSON*Filter
}
var_Syncer= (*DefaultSyncer)(nil)
var_ExtensibleSyncer= (*DefaultSyncer)(nil)
// NewDefaultSyncer returns an instantiated DefaultSyncer
funcNewDefaultSyncer()*DefaultSyncer {
return&DefaultSyncer{
listeners:make(map[event.Type][]EventHandler),
syncListeners: []SyncHandler{},
globalListeners: []EventHandler{},
ParseEventContent:true,
ParseErrorHandler:func(evt*event.Event,errerror)bool {
// By default, drop known events that can't be parsed, but let unknown events through
returnerrors.Is(err,event.ErrUnsupportedContentType)||
// Also allow events that had their content already parsed by some other function
errors.Is(err,event.ErrContentAlreadyParsed)
},
}
}
// ProcessResponse processes the /sync response in a way suitable for bots. "Suitable for bots" means a stream of
// unrepeating events. Returns a fatal error if a listener panics.
func (s*DefaultSyncer)ProcessResponse(ctx context.Context,res*RespSync,sincestring) (errerror) {
deferfunc() {
ifr:=recover();r!=nil {
err=fmt.Errorf("ProcessResponse panicked! since=%s panic=%s\n%s",since,r,debug.Stack())
}
}()
for_,listener:=ranges.syncListeners {
if!listener(ctx,res,since) {
return
}
}
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)
forroomID,roomData:=rangeres.Rooms.Join {
ifroomData.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)
}
forroomID,roomData:=rangeres.Rooms.Invite {
s.processSyncEvents(ctx,roomID,roomData.State.Events,event.SourceInvite|event.SourceState,false)
}
forroomID,roomData:=rangeres.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)
}
return
}
func (s*DefaultSyncer)processSyncEvents(ctx context.Context,roomID id.RoomID,events []*event.Event,source event.Source,ignoreStatebool) {
for_,evt:=rangeevents {
s.processSyncEvent(ctx,roomID,evt,source,ignoreState)
}
}
func (s*DefaultSyncer)processSyncEvent(ctx context.Context,roomID id.RoomID,evt*event.Event,source event.Source,ignoreStatebool) {
evt.RoomID=roomID
// Ensure the type class is correct. It's safe to mutate the class since the event type is not a pointer.
// Listeners are keyed by type structs, which means only the correct class will pass.
switch {
caseevt.StateKey!=nil:
evt.Type.Class=event.StateEventType
casesource==event.SourcePresence,source&event.SourceEphemeral!=0:
evt.Type.Class=event.EphemeralEventType
casesource&event.SourceAccountData!=0:
evt.Type.Class=event.AccountDataEventType
casesource==event.SourceToDevice:
evt.Type.Class=event.ToDeviceEventType
default:
evt.Type.Class=event.MessageEventType
}
ifs.ParseEventContent {
err:=evt.Content.ParseRaw(evt.Type)
iferr!=nil&&!s.ParseErrorHandler(evt,err) {
return
}
}
evt.Mautrix.EventSource=source
evt.Mautrix.IgnoreState=ignoreState
s.Dispatch(ctx,evt)
}
func (s*DefaultSyncer)Dispatch(ctx context.Context,evt*event.Event) {
for_,fn:=ranges.globalListeners {
fn(ctx,evt)
}
listeners,exists:=s.listeners[evt.Type]
ifexists {
for_,fn:=rangelisteners {
fn(ctx,evt)
}
}
}
// OnEventType allows callers to be notified when there are new events for the given event type.
// There are no duplicate checks.
func (s*DefaultSyncer)OnEventType(eventType event.Type,callbackEventHandler) {
_,exists:=s.listeners[eventType]
if!exists {
s.listeners[eventType]= []EventHandler{}
}
s.listeners[eventType]=append(s.listeners[eventType],callback)
}
func (s*DefaultSyncer)OnSync(callbackSyncHandler) {
s.syncListeners=append(s.syncListeners,callback)
}
func (s*DefaultSyncer)OnEvent(callbackEventHandler) {
s.globalListeners=append(s.globalListeners,callback)
}
// OnFailedSync always returns a 10 second wait period between failed /syncs, never a fatal error.
func (s*DefaultSyncer)OnFailedSync(res*RespSync,errerror) (time.Duration,error) {
iferrors.Is(err,MUnknownToken) {
return0,err
}
return10*time.Second,nil
}
vardefaultFilter=Filter{
Room:&RoomFilter{
Timeline:&FilterPart{
Limit:50,
},
},
}
// GetFilterJSON returns a filter with a timeline limit of 50.
func (s*DefaultSyncer)GetFilterJSON(userID id.UserID)*Filter {
ifs.FilterJSON==nil {
defaultFilterCopy:=defaultFilter
s.FilterJSON=&defaultFilterCopy
}
returns.FilterJSON
}
// DontProcessOldEvents is a sync handler that removes rooms that the user just joined.
// It's meant for bots to ignore events from before the bot joined the room.
//
// To use it, register it with your Syncer, e.g.:
//
//cli.Syncer.(mautrix.ExtensibleSyncer).OnSync(cli.DontProcessOldEvents)
func (cli*Client)DontProcessOldEvents(_ context.Context,resp*RespSync,sincestring)bool {
returndontProcessOldEvents(cli.UserID,resp,since)
}
var_SyncHandler= (*Client)(nil).DontProcessOldEvents
funcdontProcessOldEvents(userID id.UserID,resp*RespSync,sincestring)bool {
ifsince=="" {
returnfalse
}
// This is a horrible hack because /sync will return the most recent messages for a room
// as soon as you /join it. We do NOT want to process those events in that particular room
// because they may have already been processed (if you toggle the bot in/out of the room).
//
// Work around this by inspecting each room's timeline and seeing if an m.room.member event for us
// exists and is "join" and then discard processing that room entirely if so.
// TODO: We probably want to process messages from after the last join event in the timeline.
forroomID,roomData:=rangeresp.Rooms.Join {
fori:=len(roomData.Timeline.Events)-1;i>=0;i-- {
evt:=roomData.Timeline.Events[i]
ifevt.Type==event.StateMember&&evt.GetStateKey()==string(userID) {
membership,_:=evt.Content.Raw["membership"].(string)
ifmembership=="join" {
_,ok:=resp.Rooms.Join[roomID]
if!ok {
continue
}
delete(resp.Rooms.Join,roomID)// don't re-process messages
delete(resp.Rooms.Invite,roomID)// don't re-process invites
break
}
}
}
}
returntrue
}
// MoveInviteState is a sync handler that moves events from the state event list to the InviteRoomState in the invite event.
//
// To use it, register it with your Syncer, e.g.:
//
//cli.Syncer.(mautrix.ExtensibleSyncer).OnSync(cli.MoveInviteState)
func (cli*Client)MoveInviteState(ctx context.Context,resp*RespSync,_string)bool {
for_,meta:=rangeresp.Rooms.Invite {
varinviteState []event.StrippedState
varinviteEvt*event.Event
for_,evt:=rangemeta.State.Events {
ifevt.Type==event.StateMember&&evt.GetStateKey()==cli.UserID.String() {
inviteEvt=evt
}else {
evt.Type.Class=event.StateEventType
_=evt.Content.ParseRaw(evt.Type)
inviteState=append(inviteState, event.StrippedState{
Content:evt.Content,
Type:evt.Type,
StateKey:evt.GetStateKey(),
Sender:evt.Sender,
})
}
}
ifinviteEvt!=nil {
inviteEvt.Unsigned.InviteRoomState=inviteState
meta.State.Events= []*event.Event{inviteEvt}
}
}
returntrue
}
var_SyncHandler= (*Client)(nil).MoveInviteState