forked from keybase/client
-
Notifications
You must be signed in to change notification settings - Fork 0
/
outbox.go
433 lines (375 loc) · 11.2 KB
/
outbox.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
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
package storage
import (
"context"
"fmt"
"sort"
"github.com/keybase/client/go/chat/globals"
"github.com/keybase/client/go/chat/utils"
"github.com/keybase/client/go/libkb"
"github.com/keybase/client/go/protocol/chat1"
"github.com/keybase/client/go/protocol/gregor1"
"github.com/keybase/client/go/protocol/keybase1"
"github.com/keybase/clockwork"
)
type Outbox struct {
globals.Contextified
*baseBox
utils.DebugLabeler
clock clockwork.Clock
uid gregor1.UID
}
const outboxVersion = 3
type diskOutbox struct {
Version int `codec:"V"`
Records []chat1.OutboxRecord `codec:"O"`
}
func NewOutboxID() (chat1.OutboxID, error) {
rbs, err := libkb.RandBytes(8)
if err != nil {
return nil, err
}
return chat1.OutboxID(rbs), nil
}
func NewOutbox(g *globals.Context, uid gregor1.UID) *Outbox {
return &Outbox{
Contextified: globals.NewContextified(g),
DebugLabeler: utils.NewDebugLabeler(g.GetLog(), "Outbox", false),
baseBox: newBaseBox(g),
uid: uid,
clock: clockwork.NewRealClock(),
}
}
func (o *Outbox) GetUID() gregor1.UID {
return o.uid
}
func (o *Outbox) dbKey() libkb.DbKey {
return libkb.DbKey{
Typ: libkb.DBChatOutbox,
Key: fmt.Sprintf("ob:%s", o.uid),
}
}
func (o *Outbox) readDiskOutbox(ctx context.Context) (diskOutbox, Error) {
var obox diskOutbox
found, err := o.readDiskBox(ctx, o.dbKey(), &obox)
if err != nil {
return obox, NewInternalError(ctx, o.DebugLabeler, "failure to read chat outbox: %s",
err.Error())
}
if !found {
return obox, MissError{}
}
if obox.Version != outboxVersion {
o.Debug(ctx, "on disk version not equal to program version, clearing: disk :%d program: %d",
obox.Version, outboxVersion)
if cerr := o.clear(ctx); cerr != nil {
return obox, cerr
}
return diskOutbox{Version: outboxVersion}, nil
}
return obox, nil
}
func (o *Outbox) clear(ctx context.Context) Error {
err := o.G().LocalChatDb.Delete(o.dbKey())
if err != nil {
return NewInternalError(ctx, o.DebugLabeler, "error clearing outbox: uid: %s err: %s", o.uid,
err.Error())
}
return nil
}
type ByCtimeOrder []chat1.OutboxRecord
func (a ByCtimeOrder) Len() int { return len(a) }
func (a ByCtimeOrder) Swap(i, j int) { a[i], a[j] = a[j], a[i] }
func (a ByCtimeOrder) Less(i, j int) bool {
return a[i].Ctime.Before(a[j].Ctime)
}
func (o *Outbox) SetClock(cl clockwork.Clock) {
o.clock = cl
}
func (o *Outbox) PushMessage(ctx context.Context, convID chat1.ConversationID,
msg chat1.MessagePlaintext, suppliedOutboxID *chat1.OutboxID,
identifyBehavior keybase1.TLFIdentifyBehavior) (rec chat1.OutboxRecord, err Error) {
locks.Outbox.Lock()
defer locks.Outbox.Unlock()
// Read outbox for the user
obox, err := o.readDiskOutbox(ctx)
if err != nil {
if _, ok := err.(MissError); !ok {
return rec, o.maybeNuke(err, o.dbKey())
}
obox = diskOutbox{
Version: outboxVersion,
Records: []chat1.OutboxRecord{},
}
}
// Generate new outbox ID (unless the caller supplied it for us already)
var outboxID chat1.OutboxID
if suppliedOutboxID == nil {
var ierr error
outboxID, ierr = NewOutboxID()
if ierr != nil {
return rec, o.maybeNuke(NewInternalError(ctx, o.DebugLabeler,
"error getting outboxID: err: %s", ierr.Error()), o.dbKey())
}
} else {
outboxID = *suppliedOutboxID
}
// Append record
msg.ClientHeader.OutboxID = &outboxID
rec = chat1.OutboxRecord{
State: chat1.NewOutboxStateWithSending(0),
Msg: msg,
Ctime: gregor1.ToTime(o.clock.Now()),
ConvID: convID,
OutboxID: outboxID,
IdentifyBehavior: identifyBehavior,
}
obox.Records = append(obox.Records, rec)
// Write out box
obox.Version = outboxVersion
if err := o.writeDiskBox(ctx, o.dbKey(), obox); err != nil {
return rec, o.maybeNuke(NewInternalError(ctx, o.DebugLabeler,
"error writing outbox: err: %s", err.Error()), o.dbKey())
}
return rec, nil
}
// PullAllConversations grabs all outbox entries for the current outbox, and optionally deletes them
// from storage
func (o *Outbox) PullAllConversations(ctx context.Context, includeErrors bool, remove bool) ([]chat1.OutboxRecord, error) {
locks.Outbox.Lock()
defer locks.Outbox.Unlock()
// Read outbox for the user
obox, err := o.readDiskOutbox(ctx)
if err != nil {
return nil, o.maybeNuke(err, o.dbKey())
}
var res, errors []chat1.OutboxRecord
for _, obr := range obox.Records {
state, err := obr.State.State()
if err != nil {
o.Debug(ctx, "PullAllConversations: unknown state item: skipping: err: %s", err.Error())
continue
}
if state == chat1.OutboxStateType_ERROR {
if includeErrors {
res = append(res, obr)
} else {
errors = append(errors, obr)
}
} else {
res = append(res, obr)
}
}
if remove {
// Write out box
obox.Records = errors
obox.Version = outboxVersion
if err := o.writeDiskBox(ctx, o.dbKey(), obox); err != nil {
return nil, o.maybeNuke(NewInternalError(ctx, o.DebugLabeler,
"error writing outbox: err: %s", err.Error()), o.dbKey())
}
}
return res, nil
}
// RecordFailedAttempt will either modify an existing matching record (if sending) to next attempt
// number, or if the record doesn't exist it adds it in.
func (o *Outbox) RecordFailedAttempt(ctx context.Context, oldObr chat1.OutboxRecord) error {
locks.Outbox.Lock()
defer locks.Outbox.Unlock()
// Read outbox for the user
obox, err := o.readDiskOutbox(ctx)
if err != nil {
if _, ok := err.(MissError); !ok {
return o.maybeNuke(err, o.dbKey())
}
obox = diskOutbox{
Version: outboxVersion,
Records: []chat1.OutboxRecord{},
}
}
// Loop through what we have and make sure we don't already have this record in here
var recs []chat1.OutboxRecord
added := false
for _, obr := range obox.Records {
if obr.OutboxID.Eq(&oldObr.OutboxID) {
state, err := obr.State.State()
if err != nil {
return err
}
if state == chat1.OutboxStateType_SENDING {
obr.State = chat1.NewOutboxStateWithSending(obr.State.Sending() + 1)
}
added = true
}
recs = append(recs, obr)
}
if !added {
state, err := oldObr.State.State()
if err != nil {
return err
}
if state == chat1.OutboxStateType_SENDING {
oldObr.State = chat1.NewOutboxStateWithSending(oldObr.State.Sending() + 1)
}
recs = append(recs, oldObr)
sort.Sort(ByCtimeOrder(recs))
}
// Write out box
obox.Records = recs
if err := o.writeDiskBox(ctx, o.dbKey(), obox); err != nil {
return o.maybeNuke(NewInternalError(ctx, o.DebugLabeler,
"error writing outbox: err: %s", err.Error()), o.dbKey())
}
return nil
}
// MarkAsError will either mark an existing record as an error, or it will add the passed
// record as an error with the specified error state
func (o *Outbox) MarkAsError(ctx context.Context, obr chat1.OutboxRecord, errRec chat1.OutboxStateError) error {
locks.Outbox.Lock()
defer locks.Outbox.Unlock()
// Read outbox for the user
obox, err := o.readDiskOutbox(ctx)
if err != nil {
return o.maybeNuke(err, o.dbKey())
}
// Loop through and find record
var recs []chat1.OutboxRecord
added := false
for _, iobr := range obox.Records {
if iobr.OutboxID.Eq(&obr.OutboxID) {
iobr.State = chat1.NewOutboxStateWithError(errRec)
added = true
}
recs = append(recs, iobr)
}
if !added {
obr.State = chat1.NewOutboxStateWithError(errRec)
recs = append(recs, obr)
sort.Sort(ByCtimeOrder(recs))
}
// Write out box
obox.Records = recs
if err := o.writeDiskBox(ctx, o.dbKey(), obox); err != nil {
return o.maybeNuke(NewInternalError(ctx, o.DebugLabeler,
"error writing outbox: err: %s", err.Error()), o.dbKey())
}
return nil
}
func (o *Outbox) RetryMessage(ctx context.Context, obid chat1.OutboxID) error {
locks.Outbox.Lock()
defer locks.Outbox.Unlock()
// Read outbox for the user
obox, err := o.readDiskOutbox(ctx)
if err != nil {
return o.maybeNuke(err, o.dbKey())
}
// Loop through and find record
var recs []chat1.OutboxRecord
for _, obr := range obox.Records {
if obr.OutboxID.Eq(&obid) {
obr.State = chat1.NewOutboxStateWithSending(0)
}
recs = append(recs, obr)
}
// Write out box
obox.Records = recs
if err := o.writeDiskBox(ctx, o.dbKey(), obox); err != nil {
return o.maybeNuke(NewInternalError(ctx, o.DebugLabeler,
"error writing outbox: err: %s", err.Error()), o.dbKey())
}
return nil
}
func (o *Outbox) RemoveMessage(ctx context.Context, obid chat1.OutboxID) error {
locks.Outbox.Lock()
defer locks.Outbox.Unlock()
// Read outbox for the user
obox, err := o.readDiskOutbox(ctx)
if err != nil {
return o.maybeNuke(err, o.dbKey())
}
// Scan to find the message and don't include it
var recs []chat1.OutboxRecord
for _, obr := range obox.Records {
if !obr.OutboxID.Eq(&obid) {
recs = append(recs, obr)
}
}
obox.Records = recs
// Write out box
if err := o.writeDiskBox(ctx, o.dbKey(), obox); err != nil {
return o.maybeNuke(NewInternalError(ctx, o.DebugLabeler,
"error writing outbox: err: %s", err.Error()), o.dbKey())
}
return nil
}
func (o *Outbox) getMsgOrdinal(msg chat1.MessageUnboxed) chat1.MessageID {
typ, err := msg.State()
if err != nil {
return 0
}
switch typ {
case chat1.MessageUnboxedState_OUTBOX:
return msg.Outbox().Msg.ClientHeader.OutboxInfo.Prev
default:
return msg.GetMessageID()
}
}
func (o *Outbox) insertMessage(ctx context.Context, thread *chat1.ThreadView, obr chat1.OutboxRecord) error {
prev := obr.Msg.ClientHeader.OutboxInfo.Prev
inserted := false
var res []chat1.MessageUnboxed
// Check to see if outbox item is so old that it has no place in this thread view (but has
// a valid prev value)
if prev > 0 && len(thread.Messages) > 0 &&
prev < o.getMsgOrdinal(thread.Messages[len(thread.Messages)-1]) {
oldestMsg := thread.Messages[len(thread.Messages)-1]
o.Debug(ctx, "outbox item is too old to be included in this thread view: obid: %s prev: %d oldestMsg: %d", obr.OutboxID, prev, oldestMsg.GetMessageID())
return nil
}
for index, msg := range thread.Messages {
ord := o.getMsgOrdinal(msg)
if !inserted && prev >= ord {
res = append(res, chat1.NewMessageUnboxedWithOutbox(obr))
o.Debug(ctx, "inserting at: %d msgID: %d total: %d obid: %s prev: %d", index,
msg.GetMessageID(), len(thread.Messages), obr.OutboxID, prev)
inserted = true
}
res = append(res, msg)
}
// If we didn't insert this guy, then put it at the front just so the user can see it
if !inserted {
o.Debug(ctx, "failed to insert instream, placing at front: obid: %s prev: %d", obr.OutboxID,
prev)
res = append([]chat1.MessageUnboxed{chat1.NewMessageUnboxedWithOutbox(obr)},
res...)
}
thread.Messages = res
return nil
}
func (o *Outbox) SprinkleIntoThread(ctx context.Context, convID chat1.ConversationID,
thread *chat1.ThreadView) error {
locks.Outbox.Lock()
defer locks.Outbox.Unlock()
// Read outbox for the user
obox, err := o.readDiskOutbox(ctx)
if err != nil {
return o.maybeNuke(err, o.dbKey())
}
// Sprinkle each outbox message in
for _, obr := range obox.Records {
if !obr.ConvID.Eq(convID) {
continue
}
st, err := obr.State.State()
if err != nil {
continue
}
if st == chat1.OutboxStateType_ERROR && obr.State.Error().Typ == chat1.OutboxErrorType_DUPLICATE {
o.Debug(ctx, "skipping sprinkle on duplicate message error: %s", obr.OutboxID)
continue
}
if err := o.insertMessage(ctx, thread, obr); err != nil {
return err
}
}
return nil
}