File: mailbox.go

package info (click to toggle)
golang-github-protonmail-gluon 0.17.0-4
  • links: PTS, VCS
  • area: main
  • in suites: forky, sid, trixie
  • size: 16,020 kB
  • sloc: sh: 55; makefile: 5
file content (433 lines) | stat: -rw-r--r-- 12,564 bytes parent folder | download
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 state

import (
	"context"
	"errors"
	"fmt"
	"strings"
	"time"

	"github.com/ProtonMail/gluon/connector"
	"github.com/ProtonMail/gluon/db"
	"github.com/ProtonMail/gluon/imap"
	"github.com/ProtonMail/gluon/imap/command"
	"github.com/ProtonMail/gluon/internal/ids"
	"github.com/ProtonMail/gluon/internal/response"
	"github.com/ProtonMail/gluon/reporter"
	"github.com/ProtonMail/gluon/rfc822"
	"github.com/bradenaw/juniper/xslices"
	"github.com/sirupsen/logrus"
)

type Mailbox struct {
	id          db.MailboxIDPair
	name        string
	subscribed  bool
	uidValidity imap.UID

	state *State
	snap  *snapshot

	selected bool
	readOnly bool
}

type AppendOnlyMailbox interface {
	Append(ctx context.Context, literal []byte, flags imap.FlagSet, date time.Time) (imap.UID, error)
	Flush(ctx context.Context, permitExpunge bool) ([]response.Response, error)
	UIDValidity() imap.UID
	IsDrafts(ctx context.Context) (bool, error)
}

func newMailbox(mbox *db.Mailbox, state *State, snap *snapshot) *Mailbox {
	return &Mailbox{
		id:          db.NewMailboxIDPair(mbox),
		name:        mbox.Name,
		uidValidity: mbox.UIDValidity,

		state: state,

		selected: snap != nil,
		readOnly: state.ro,
		snap:     snap,
	}
}

func (m *Mailbox) Name() string {
	return m.name
}

func (m *Mailbox) Selected() bool {
	return m.selected
}

func (m *Mailbox) ReadOnly() bool {
	return m.readOnly
}

func (m *Mailbox) ExpungeIssued() bool {
	var issued bool

	for _, res := range m.state.res {
		switch res.(type) {
		case *expunge:
			issued = true
		}
	}

	return issued
}

func (m *Mailbox) Count() int {
	return m.snap.len()
}

func (m *Mailbox) Flags(ctx context.Context) (imap.FlagSet, error) {
	return stateDBReadResult(ctx, m.state, func(ctx context.Context, client db.ReadOnly) (imap.FlagSet, error) {
		return client.GetMailboxFlags(ctx, m.id.InternalID)
	})
}

func (m *Mailbox) PermanentFlags(ctx context.Context) (imap.FlagSet, error) {
	return stateDBReadResult(ctx, m.state, func(ctx context.Context, client db.ReadOnly) (imap.FlagSet, error) {
		return client.GetMailboxPermanentFlags(ctx, m.id.InternalID)
	})
}

func (m *Mailbox) Attributes(ctx context.Context) (imap.FlagSet, error) {
	return stateDBReadResult(ctx, m.state, func(ctx context.Context, client db.ReadOnly) (imap.FlagSet, error) {
		return client.GetMailboxAttributes(ctx, m.id.InternalID)
	})
}

func (m *Mailbox) UIDNext(ctx context.Context) (imap.UID, error) {
	return stateDBReadResult(ctx, m.state, func(ctx context.Context, client db.ReadOnly) (imap.UID, error) {
		return client.GetMailboxUID(ctx, m.id.InternalID)
	})
}

func (m *Mailbox) UIDValidity() imap.UID {
	return m.uidValidity
}

func (m *Mailbox) Subscribed() bool {
	return m.subscribed
}

func (m *Mailbox) GetMessagesWithFlag(flag string) []imap.SeqID {
	return xslices.Map(m.snap.getMessagesWithFlag(flag), func(msg snapMsgWithSeq) imap.SeqID {
		return msg.Seq
	})
}

func (m *Mailbox) GetFirstMessageWithFlag(flag string) (snapMsgWithSeq, bool) {
	msg, ok := m.snap.firstMessageWithFlag(flag)

	return msg, ok
}

func (m *Mailbox) GetFirstMessageWithoutFlag(flag string) (snapMsgWithSeq, bool) {
	msg, ok := m.snap.firstMessageWithoutFlag(flag)

	return msg, ok
}

func (m *Mailbox) GetMessagesWithFlagCount(flag string) int {
	return m.snap.getMessagesWithFlagCount(flag)
}

func (m *Mailbox) GetMessagesWithoutFlag(flag string) []imap.SeqID {
	return xslices.Map(m.snap.getMessagesWithoutFlag(flag), func(msg snapMsgWithSeq) imap.SeqID {
		return msg.Seq
	})
}

func (m *Mailbox) GetMessagesWithoutFlagCount(flag string) int {
	return m.snap.getMessagesWithoutFlagCount(flag)
}

func (m *Mailbox) AppendRegular(ctx context.Context, literal []byte, flags imap.FlagSet, date time.Time) (imap.UID, error) {
	if err := stateDBRead(ctx, m.state, func(ctx context.Context, client db.ReadOnly) error {
		if messageCount, uid, err := client.GetMailboxMessageCountAndUID(ctx, m.snap.mboxID.InternalID); err != nil {
			return err
		} else {
			if err := m.state.imapLimits.CheckMailBoxMessageCount(messageCount, 1); err != nil {
				return err
			}

			if err := m.state.imapLimits.CheckUIDCount(uid, 1); err != nil {
				return err
			}
		}

		return nil
	}); err != nil {
		return 0, err
	}

	var appendIntoDrafts bool

	attr, err := m.Attributes(ctx)
	if err != nil {
		return 0, err
	}

	// Force create message when appending to drafts so that IMAP clients can create new draft messages.
	if !attr.Contains(imap.AttrDrafts) {
		internalIDString, err := rfc822.GetHeaderValue(literal, ids.InternalIDKey)
		if err != nil {
			return 0, err
		}

		if len(internalIDString) > 0 {
			msgID, err := imap.InternalMessageIDFromString(internalIDString)
			if err != nil {
				return 0, err
			}

			if messageDeleted, err := stateDBReadResult(ctx, m.state, func(ctx context.Context, client db.ReadOnly) (bool, error) {
				return client.GetMessageDeletedFlag(ctx, msgID)
			}); err != nil {
				if !errors.Is(err, db.ErrNotFound) {
					return 0, err
				}

				logrus.WithError(err).Warn("The message has an unknown internal ID")
			} else if !messageDeleted {
				logrus.Debugf("Appending duplicate message with Internal ID:%v", msgID.ShortID())
				// Only shuffle around messages that haven't been marked for deletion.
				if res, err := stateDBWriteResult(ctx, m.state, func(ctx context.Context, tx db.Transaction) ([]Update, []db.UIDWithFlags, error) {
					remoteID, err := tx.GetMessageRemoteID(ctx, msgID)
					if err != nil {
						return nil, nil, err
					}

					return m.state.actionAddMessagesToMailbox(ctx, tx,
						[]db.MessageIDPair{{InternalID: msgID, RemoteID: remoteID}},
						m.id,
						m.snap == m.state.snap,
					)
				}); err != nil {
					return 0, err
				} else {
					return res[0].UID, nil
				}
			}
		}
	} else {
		appendIntoDrafts = true
		newLiteral, err := rfc822.EraseHeaderValue(literal, ids.InternalIDKey)
		if err != nil {
			logrus.WithError(err).Error("Failed to erase Gluon internal id from draft")
		} else {
			literal = newLiteral
		}
	}

	return stateDBWriteResult(ctx, m.state, func(ctx context.Context, tx db.Transaction) ([]Update, imap.UID, error) {
		return m.state.actionCreateMessage(ctx, tx, m.snap.mboxID, literal, flags, date, m.snap == m.state.snap, appendIntoDrafts)
	})
}

var ErrKnownRecoveredMessage = errors.New("known recovered message, possible duplication")

func (m *Mailbox) Append(ctx context.Context, literal []byte, flags imap.FlagSet, date time.Time) (imap.UID, error) {
	uid, err := m.AppendRegular(ctx, literal, flags, date)
	if err != nil {
		// Can't store messages that exceed size limits
		if errors.Is(err, connector.ErrMessageSizeExceedsLimits) {
			return uid, err
		}

		// Failed to append to mailbox attempt to insert into recovery mailbox.
		knownMessage, recoverErr := stateDBWriteResult(ctx, m.state, func(ctx context.Context, tx db.Transaction) ([]Update, bool, error) {
			return m.state.actionCreateRecoveredMessage(ctx, tx, literal, flags, date)
		})
		if recoverErr != nil && !knownMessage {
			logrus.WithError(recoverErr).Error("Failed to insert message into recovery mailbox")
			reporter.ExceptionWithContext(ctx, "Failed to insert message into recovery mailbox", reporter.Context{"error": recoverErr})
		}

		if knownMessage {
			err = fmt.Errorf("%v: %w", err, ErrKnownRecoveredMessage)
		}
	}

	return uid, err
}

func (m *Mailbox) IsDrafts(ctx context.Context) (bool, error) {
	attrs, err := m.Attributes(ctx)
	if err != nil {
		return false, err
	}

	return attrs.Contains(imap.AttrDrafts), nil
}

// Copy copies the messages represented by the given sequence set into the mailbox with the given name.
// If the context is a UID context, the sequence set refers to message UIDs.
// If no items are copied the response object will be nil.
func (m *Mailbox) Copy(ctx context.Context, seq []command.SeqRange, name string) (response.Item, error) {
	if strings.EqualFold(name, ids.GluonRecoveryMailboxName) {
		return nil, ErrOperationNotAllowed
	}

	mbox, err := stateDBReadResult(ctx, m.state, func(ctx context.Context, client db.ReadOnly) (*db.Mailbox, error) {
		return client.GetMailboxByName(ctx, name)
	})
	if err != nil {
		if errors.Is(err, db.ErrNotFound) {
			return nil, ErrNoSuchMailbox
		}

		return nil, err
	}

	messages, err := m.snap.getMessagesInRange(ctx, seq)
	if err != nil {
		return nil, err
	}

	msgIDs := make([]db.MessageIDPair, len(messages))
	msgUIDs := make([]imap.UID, len(messages))

	for i := 0; i < len(messages); i++ {
		snapMsg := messages[i]
		msgUIDs[i] = snapMsg.UID
		msgIDs[i] = snapMsg.ID
	}

	destUIDs, err := stateDBWriteResult(ctx, m.state, func(ctx context.Context, tx db.Transaction) ([]Update, []db.UIDWithFlags, error) {
		if m.state.user.GetRecoveryMailboxID().InternalID == m.snap.mboxID.InternalID {
			return m.state.actionCopyMessagesOutOfRecoveryMailbox(ctx, tx, msgIDs, db.NewMailboxIDPair(mbox))
		} else {
			return m.state.actionAddMessagesToMailbox(ctx, tx, msgIDs, db.NewMailboxIDPair(mbox), m.snap == m.state.snap)
		}
	})
	if err != nil {
		return nil, err
	}

	var res response.Item

	if len(destUIDs) > 0 {
		res = response.ItemCopyUID(mbox.UIDValidity, msgUIDs, xslices.Map(destUIDs, func(uid db.UIDWithFlags) imap.UID {
			return uid.UID
		}))
	}

	return res, nil
}

// Move moves the messages represented by the given sequence set into the mailbox with the given name.
// If the context is a UID context, the sequence set refers to message UIDs.
// If no items are moved the response object will be nil.
func (m *Mailbox) Move(ctx context.Context, seq []command.SeqRange, name string) (response.Item, error) {
	if strings.EqualFold(name, ids.GluonRecoveryMailboxName) {
		return nil, ErrOperationNotAllowed
	}

	mbox, err := stateDBReadResult(ctx, m.state, func(ctx context.Context, client db.ReadOnly) (*db.Mailbox, error) {
		return client.GetMailboxByName(ctx, name)
	})
	if err != nil {
		if errors.Is(err, db.ErrNotFound) {
			return nil, ErrNoSuchMailbox
		}

		return nil, err
	}

	messages, err := m.snap.getMessagesInRange(ctx, seq)
	if err != nil {
		return nil, err
	}

	msgIDs := make([]db.MessageIDPair, len(messages))
	msgUIDs := make([]imap.UID, len(messages))

	for i := 0; i < len(messages); i++ {
		snapMsg := messages[i]
		msgUIDs[i] = snapMsg.UID
		msgIDs[i] = snapMsg.ID
	}

	destUIDs, err := stateDBWriteResult(ctx, m.state, func(ctx context.Context, tx db.Transaction) ([]Update, []db.UIDWithFlags, error) {
		if m.state.user.GetRecoveryMailboxID().InternalID == m.snap.mboxID.InternalID {
			return m.state.actionMoveMessagesOutOfRecoveryMailbox(ctx, tx, msgIDs, db.NewMailboxIDPair(mbox))
		} else {
			return m.state.actionMoveMessages(ctx, tx, msgIDs, m.snap.mboxID, db.NewMailboxIDPair(mbox))
		}
	})
	if err != nil {
		return nil, err
	}

	var res response.Item

	if len(destUIDs) > 0 {
		res = response.ItemCopyUID(mbox.UIDValidity, msgUIDs, xslices.Map(destUIDs, func(uid db.UIDWithFlags) imap.UID {
			return uid.UID
		}))
	}

	return res, nil
}

func (m *Mailbox) Store(ctx context.Context, seqSet []command.SeqRange, action command.StoreAction, flags imap.FlagSet) error {
	messages, err := m.snap.getMessagesInRange(ctx, seqSet)
	if err != nil {
		return err
	}

	return stateDBWrite(ctx, m.state, func(ctx context.Context, tx db.Transaction) ([]Update, error) {
		switch action {
		case command.StoreActionAddFlags:
			return m.state.actionAddMessageFlags(ctx, tx, messages, flags)

		case command.StoreActionRemFlags:
			return m.state.actionRemoveMessageFlags(ctx, tx, messages, flags)

		case command.StoreActionSetFlags:
			return m.state.actionSetMessageFlags(ctx, tx, messages, flags)
		}

		return nil, fmt.Errorf("unknown flag action")
	})
}

func (m *Mailbox) Expunge(ctx context.Context, seq []command.SeqRange) error {
	var msgIDs []db.MessageIDPair

	if seq != nil {
		snapMsgs, err := m.snap.getMessagesInRange(ctx, seq)
		if err != nil {
			return err
		}

		msgIDs = make([]db.MessageIDPair, 0, len(snapMsgs))

		for _, v := range snapMsgs {
			if v.toExpunge {
				msgIDs = append(msgIDs, v.ID)
			}
		}
	} else {
		msgIDs = m.snap.getAllMessagesIDsMarkedDelete()
	}

	return stateDBWrite(ctx, m.state, func(ctx context.Context, tx db.Transaction) ([]Update, error) {
		return m.state.actionRemoveMessagesFromMailbox(ctx, tx, msgIDs, m.snap.mboxID)
	})
}

func (m *Mailbox) Flush(ctx context.Context, permitExpunge bool) ([]response.Response, error) {
	return m.state.flushResponses(ctx, permitExpunge)
}

func (m *Mailbox) Close(ctx context.Context) error {
	m.state.deleteConnMetadata()

	return m.state.close()
}