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
|
package backend
import (
"context"
"fmt"
"sync"
"github.com/ProtonMail/gluon/async"
"github.com/ProtonMail/gluon/connector"
"github.com/ProtonMail/gluon/db"
"github.com/ProtonMail/gluon/imap"
"github.com/ProtonMail/gluon/internal/ids"
"github.com/ProtonMail/gluon/internal/state"
"github.com/ProtonMail/gluon/internal/utils"
"github.com/ProtonMail/gluon/limits"
"github.com/ProtonMail/gluon/logging"
"github.com/ProtonMail/gluon/reporter"
"github.com/ProtonMail/gluon/store"
"github.com/bradenaw/juniper/xslices"
"github.com/sirupsen/logrus"
"golang.org/x/exp/maps"
)
type user struct {
userID string
connector connector.Connector
updateInjector *updateInjector
store *store.WriteControlledStore
delimiter string
db db.Client
states map[state.StateID]*state.State
statesLock sync.RWMutex
statesWG sync.WaitGroup
updateWG sync.WaitGroup
updateQuitCh chan struct{}
recoveryMailboxID imap.InternalMailboxID
imapLimits limits.IMAP
uidValidityGenerator imap.UIDValidityGenerator
panicHandler async.PanicHandler
recoveredMessageHashes *utils.MessageHashesMap
}
func newUser(
ctx context.Context,
userID string,
database db.Client,
conn connector.Connector,
st store.Store,
delimiter string,
imapLimits limits.IMAP,
uidValidityGenerator imap.UIDValidityGenerator,
panicHandler async.PanicHandler,
) (*user, error) {
recoveredMessageHashes := utils.NewMessageHashesMap()
// Create recovery mailbox if it does not exist
recoveryMBox, err := db.ClientWriteType(ctx, database, func(ctx context.Context, tx db.Transaction) (*db.Mailbox, error) {
uidValidity, err := uidValidityGenerator.Generate()
if err != nil {
return nil, err
}
mboxFlags := imap.NewFlagSet(imap.FlagSeen, imap.FlagFlagged, imap.FlagDeleted)
mbox := imap.Mailbox{
ID: ids.GluonInternalRecoveryMailboxRemoteID,
Name: []string{ids.GluonRecoveryMailboxName},
Flags: mboxFlags,
PermanentFlags: mboxFlags,
Attributes: imap.NewFlagSet(imap.AttrNoInferiors),
}
recoveryMBox, err := tx.GetOrCreateMailboxAlt(ctx, mbox, delimiter, uidValidity)
if err != nil {
return nil, err
}
// Pre-fill the message hashes map
messages, err := tx.GetMailboxMessageIDPairs(ctx, recoveryMBox.ID)
if err != nil {
return nil, err
}
for _, m := range messages {
literal, err := st.Get(m.InternalID)
if err != nil {
logrus.WithError(err).Errorf("Failed to load %v for store for recovered message hashes map", m.InternalID)
continue
}
if _, err := recoveredMessageHashes.Insert(m.InternalID, literal); err != nil {
logrus.WithError(err).Errorf("Failed insert literal for %v into recovered message hashes map", m.InternalID)
}
}
return recoveryMBox, nil
})
if err != nil {
return nil, err
}
user := &user{
userID: userID,
connector: conn,
updateInjector: newUpdateInjector(conn, userID, panicHandler),
store: store.NewWriteControlledStore(st),
delimiter: delimiter,
db: database,
states: make(map[state.StateID]*state.State),
updateQuitCh: make(chan struct{}),
recoveryMailboxID: recoveryMBox.ID,
imapLimits: imapLimits,
uidValidityGenerator: uidValidityGenerator,
panicHandler: panicHandler,
recoveredMessageHashes: recoveredMessageHashes,
}
if err := user.deleteAllMessagesMarkedDeleted(ctx); err != nil {
logrus.WithError(err).Error("Failed to remove deleted messages")
reporter.MessageWithContext(ctx,
"Failed to remove deleted messages",
reporter.Context{"error": err},
)
}
if err := user.cleanupStaleStoreData(ctx); err != nil {
logrus.WithError(err).Error("Failed to cleanup stale store data")
}
user.updateWG.Add(1)
// nolint:contextcheck
async.GoAnnotated(context.Background(), panicHandler, func(ctx context.Context) {
defer user.updateWG.Done()
updateCh := user.updateInjector.GetUpdates()
for {
select {
case update, ok := <-updateCh:
if !ok {
return
}
if err := user.apply(ctx, update); err != nil {
reporter.MessageWithContext(ctx,
"Failed to apply connector update",
reporter.Context{"error": err, "update": update.String()},
)
logrus.WithError(err).Errorf("Failed to apply update: %v", err)
}
case <-user.updateQuitCh:
return
}
}
}, logging.Labels{
"Action": "Applying connector updates",
"UserID": userID,
})
return user, nil
}
// close closes the backend user.
func (user *user) close(ctx context.Context) error {
close(user.updateQuitCh)
// Wait until the connector update go routine has finished.
user.updateWG.Wait()
if err := user.updateInjector.Close(ctx); err != nil {
return err
}
if err := user.connector.Close(ctx); err != nil {
return err
}
user.closeStates()
// Ensure we wait until all states have been removed/closed by any active sessions otherwise we run into issues
// since we close the database in this function.
user.statesWG.Wait()
if err := user.store.Close(); err != nil {
return fmt.Errorf("failed to close user client storage: %w", err)
}
if err := user.db.Close(); err != nil {
return fmt.Errorf("failed to close user db: %w", err)
}
return nil
}
func (user *user) deleteAllMessagesMarkedDeleted(ctx context.Context) error {
// Delete messages in database first before deleting from the storage to avoid data loss.
ids, err := db.ClientWriteType(ctx, user.db, func(ctx context.Context, tx db.Transaction) ([]imap.InternalMessageID, error) {
ids, err := tx.GetMessageIDsMarkedAsDelete(ctx)
if err != nil {
return nil, err
}
if err := tx.DeleteMessages(ctx, ids); err != nil {
return nil, err
}
return ids, nil
})
if err != nil {
return err
}
return user.store.Delete(ids...)
}
func (user *user) queueStateUpdate(updates ...state.Update) {
if err := user.forState(func(state *state.State) error {
for _, update := range updates {
if !state.QueueUpdates(update) {
logrus.Errorf("Failed to push update to state %v", state.StateID)
}
}
return nil
}); err != nil {
panic("unexpected, should not happen")
}
}
func (user *user) newState() (*state.State, error) {
user.statesLock.Lock()
defer user.statesLock.Unlock()
newState := state.NewState(
newStateUserInterfaceImpl(user, newStateConnectorImpl(user)),
user.delimiter,
user.imapLimits,
user.panicHandler,
)
user.states[newState.StateID] = newState
user.statesWG.Add(1)
return newState, nil
}
func (user *user) removeState(ctx context.Context, st *state.State) error {
messageIDs, err := db.ClientReadType(ctx, user.db, func(ctx context.Context, client db.ReadOnly) ([]imap.InternalMessageID, error) {
return client.GetMessageIDsMarkedAsDelete(ctx)
})
if err != nil {
return err
}
// We need to reduce the scope of this lock as it can deadlock when there's an IMAP update running
// at the same time as we remove a state. When the IMAP update propagates the info the order of the locks
// is inverse to the order we have here.
fn := func() (*state.State, error) {
user.statesLock.Lock()
defer user.statesLock.Unlock()
st, ok := user.states[st.StateID]
if !ok {
return nil, fmt.Errorf("no such state")
}
messageIDs = xslices.Filter(messageIDs, func(messageID imap.InternalMessageID) bool {
return xslices.CountFunc(maps.Values(user.states), func(other *state.State) bool {
return st != other && other.HasMessage(messageID)
}) == 0
})
delete(user.states, st.StateID)
return st, nil
}
state, err := fn()
if err != nil {
return err
}
// After this point we need to notify the WaitGroup or we risk deadlocks.
defer user.statesWG.Done()
// Delete messages in database first before deleting from the storage to avoid data loss.
if err := user.db.Write(ctx, func(ctx context.Context, tx db.Transaction) error {
if err := tx.DeleteMessages(ctx, messageIDs); err != nil {
return err
}
return nil
}); err != nil {
return err
}
// If we fail to delete messages on disk, it shouldn't count as an error at this point.
if err := user.store.Delete(messageIDs...); err != nil {
logrus.WithError(err).Error("Failed to delete messages during removeState")
}
return state.Close(ctx)
}
// forState iterates through all states.
func (user *user) forState(fn func(*state.State) error) error {
user.statesLock.RLock()
defer user.statesLock.RUnlock()
for _, state := range user.states {
if err := fn(state); err != nil {
return err
}
}
return nil
}
func (user *user) closeStates() {
user.statesLock.RLock()
defer user.statesLock.RUnlock()
for _, state := range user.states {
state.SignalClose()
}
}
func (user *user) cleanupStaleStoreData(ctx context.Context) error {
storeIds, err := user.store.List()
if err != nil {
return err
}
dbIdMap, err := db.ClientReadType(ctx, user.db, func(ctx context.Context, client db.ReadOnly) (map[imap.InternalMessageID]struct{}, error) {
return client.GetAllMessagesIDsAsMap(ctx)
})
if err != nil {
return err
}
idsToDelete := xslices.Filter(storeIds, func(id imap.InternalMessageID) bool {
_, ok := dbIdMap[id]
return !ok
})
return user.store.Delete(idsToDelete...)
}
|