maildir-sync.c revision 757726d9acbd04cf0d0d4be8ce14e11525476a0b
0c17af9d3f9323136a94e66605776ed4462a172dTimo Sirainen/* Copyright (C) 2004 Timo Sirainen */
0c17af9d3f9323136a94e66605776ed4462a172dTimo Sirainen Here's a description of how we handle Maildir synchronization and
0c17af9d3f9323136a94e66605776ed4462a172dTimo Sirainen it's problems:
0c17af9d3f9323136a94e66605776ed4462a172dTimo Sirainen We want to be as efficient as we can. The most efficient way to
0c17af9d3f9323136a94e66605776ed4462a172dTimo Sirainen check if changes have occured is to stat() the new/ and cur/
0c17af9d3f9323136a94e66605776ed4462a172dTimo Sirainen directories and uidlist file - if their mtimes haven't changed,
0c17af9d3f9323136a94e66605776ed4462a172dTimo Sirainen there's no changes and we don't need to do anything.
0c17af9d3f9323136a94e66605776ed4462a172dTimo Sirainen Problem 1: Multiple changes can happen within a single second -
0c17af9d3f9323136a94e66605776ed4462a172dTimo Sirainen nothing guarantees that once we synced it, someone else didn't just
0c17af9d3f9323136a94e66605776ed4462a172dTimo Sirainen then make a modification. Such modifications wouldn't get noticed
0c17af9d3f9323136a94e66605776ed4462a172dTimo Sirainen until a new modification occured later.
0c17af9d3f9323136a94e66605776ed4462a172dTimo Sirainen Problem 2: Syncing cur/ directory is much more costly than syncing
0c17af9d3f9323136a94e66605776ed4462a172dTimo Sirainen new/. Moving mails from new/ to cur/ will always change mtime of
0c17af9d3f9323136a94e66605776ed4462a172dTimo Sirainen cur/ causing us to sync it as well.
0c17af9d3f9323136a94e66605776ed4462a172dTimo Sirainen Problem 3: We may not be able to move mail from new/ to cur/
0c17af9d3f9323136a94e66605776ed4462a172dTimo Sirainen because we're out of quota, or simply because we're accessing a
0c17af9d3f9323136a94e66605776ed4462a172dTimo Sirainen read-only mailbox.
0c17af9d3f9323136a94e66605776ed4462a172dTimo Sirainen MAILDIR_SYNC_SECS
0c17af9d3f9323136a94e66605776ed4462a172dTimo Sirainen -----------------
0c17af9d3f9323136a94e66605776ed4462a172dTimo Sirainen Several checks below use MAILDIR_SYNC_SECS, which should be maximum
0c17af9d3f9323136a94e66605776ed4462a172dTimo Sirainen clock drift between all computers accessing the maildir (eg. via
0c17af9d3f9323136a94e66605776ed4462a172dTimo Sirainen NFS), rounded up to next second. Our default is 1 second, since
0c17af9d3f9323136a94e66605776ed4462a172dTimo Sirainen everyone should be using NTP.
0c17af9d3f9323136a94e66605776ed4462a172dTimo Sirainen Note that setting it to 0 works only if there's only one computer
0c17af9d3f9323136a94e66605776ed4462a172dTimo Sirainen accessing the maildir. It's practically impossible to make two
0c17af9d3f9323136a94e66605776ed4462a172dTimo Sirainen clocks _exactly_ synchronized.
0c17af9d3f9323136a94e66605776ed4462a172dTimo Sirainen It might be possible to only use file server's clock by looking at
0c17af9d3f9323136a94e66605776ed4462a172dTimo Sirainen the atime field, but I don't know how well that would actually work.
0c17af9d3f9323136a94e66605776ed4462a172dTimo Sirainen cur directory
0c17af9d3f9323136a94e66605776ed4462a172dTimo Sirainen -------------
0c17af9d3f9323136a94e66605776ed4462a172dTimo Sirainen We have dirty_cur_time variable which is set to cur/ directory's
0c17af9d3f9323136a94e66605776ed4462a172dTimo Sirainen mtime when it's >= time() - MAILDIR_SYNC_SECS and we _think_ we have
0c17af9d3f9323136a94e66605776ed4462a172dTimo Sirainen synchronized the directory.
0c17af9d3f9323136a94e66605776ed4462a172dTimo Sirainen When dirty_cur_time is non-zero, we don't synchronize the cur/
0c17af9d3f9323136a94e66605776ed4462a172dTimo Sirainen directory until
0c17af9d3f9323136a94e66605776ed4462a172dTimo Sirainen a) cur/'s mtime changes
0c17af9d3f9323136a94e66605776ed4462a172dTimo Sirainen b) opening a mail fails with ENOENT
0c17af9d3f9323136a94e66605776ed4462a172dTimo Sirainen c) time() > dirty_cur_time + MAILDIR_SYNC_SECS
0c17af9d3f9323136a94e66605776ed4462a172dTimo Sirainen This allows us to modify the maildir multiple times without having
0c17af9d3f9323136a94e66605776ed4462a172dTimo Sirainen to sync it at every change. The sync will eventually be done to
0c17af9d3f9323136a94e66605776ed4462a172dTimo Sirainen make sure we didn't miss any external changes.
0c17af9d3f9323136a94e66605776ed4462a172dTimo Sirainen The dirty_cur_time is set when:
0c17af9d3f9323136a94e66605776ed4462a172dTimo Sirainen - we change message flags
0c17af9d3f9323136a94e66605776ed4462a172dTimo Sirainen - we expunge messages
0c17af9d3f9323136a94e66605776ed4462a172dTimo Sirainen - we move mail from new/ to cur/
0c17af9d3f9323136a94e66605776ed4462a172dTimo Sirainen - we sync cur/ directory and it's mtime is >= time() - MAILDIR_SYNC_SECS
0c17af9d3f9323136a94e66605776ed4462a172dTimo Sirainen It's unset when we do the final syncing, ie. when mtime is
0c17af9d3f9323136a94e66605776ed4462a172dTimo Sirainen older than time() - MAILDIR_SYNC_SECS.
0c17af9d3f9323136a94e66605776ed4462a172dTimo Sirainen new directory
0c17af9d3f9323136a94e66605776ed4462a172dTimo Sirainen -------------
0c17af9d3f9323136a94e66605776ed4462a172dTimo Sirainen If new/'s mtime is >= time() - MAILDIR_SYNC_SECS, always synchronize
0c17af9d3f9323136a94e66605776ed4462a172dTimo Sirainen it. dirty_cur_time-like feature might save us a few syncs, but
0c17af9d3f9323136a94e66605776ed4462a172dTimo Sirainen that might break a client which saves a mail in one connection and
0c17af9d3f9323136a94e66605776ed4462a172dTimo Sirainen tries to fetch it in another one. new/ directory is almost always
0c17af9d3f9323136a94e66605776ed4462a172dTimo Sirainen empty, so syncing it should be very fast anyway. Actually this can
0c17af9d3f9323136a94e66605776ed4462a172dTimo Sirainen still happen if we sync only new/ dir while another client is also
0c17af9d3f9323136a94e66605776ed4462a172dTimo Sirainen moving mails from it to cur/ - it takes us a while to see them.
0c17af9d3f9323136a94e66605776ed4462a172dTimo Sirainen That's pretty unlikely to happen however, and only way to fix it
0c17af9d3f9323136a94e66605776ed4462a172dTimo Sirainen would be to always synchronize cur/ after new/.
0c17af9d3f9323136a94e66605776ed4462a172dTimo Sirainen Normally we move all mails from new/ to cur/ whenever we sync it. If
0c17af9d3f9323136a94e66605776ed4462a172dTimo Sirainen it's not possible for some reason, we mark the mail with "probably
0c17af9d3f9323136a94e66605776ed4462a172dTimo Sirainen exists in new/ directory" flag.
0c17af9d3f9323136a94e66605776ed4462a172dTimo Sirainen If rename() still fails because of ENOSPC or EDQUOT, we still save
0c17af9d3f9323136a94e66605776ed4462a172dTimo Sirainen the flag changes in index with dirty-flag on. When moving the mail
0c17af9d3f9323136a94e66605776ed4462a172dTimo Sirainen to cur/ directory, or when we notice it's already moved there, we
0c17af9d3f9323136a94e66605776ed4462a172dTimo Sirainen apply the flag changes to the filename, rename it and remove the
0c17af9d3f9323136a94e66605776ed4462a172dTimo Sirainen dirty flag. If there's dirty flags, this should be tried every time
0c17af9d3f9323136a94e66605776ed4462a172dTimo Sirainen after expunge or when closing the mailbox.
0c17af9d3f9323136a94e66605776ed4462a172dTimo Sirainen This file contains UID <-> filename mappings. It's updated only when
0c17af9d3f9323136a94e66605776ed4462a172dTimo Sirainen new mail arrives, so it may contain filenames that have already been
0c17af9d3f9323136a94e66605776ed4462a172dTimo Sirainen deleted. Updating is done by getting uidlist.lock file, writing the
0c17af9d3f9323136a94e66605776ed4462a172dTimo Sirainen whole uidlist into it and rename()ing it over the old uidlist. This
0c17af9d3f9323136a94e66605776ed4462a172dTimo Sirainen means there's no need to lock the file for reading.
0c17af9d3f9323136a94e66605776ed4462a172dTimo Sirainen Whenever uidlist is rewritten, it's mtime must be larger than the old
0c17af9d3f9323136a94e66605776ed4462a172dTimo Sirainen one's. Use utime() before rename() if needed. Note that inode checking
0c17af9d3f9323136a94e66605776ed4462a172dTimo Sirainen wouldn't have been sufficient as inode numbers can be reused.
0c17af9d3f9323136a94e66605776ed4462a172dTimo Sirainen This file is usually read the first time you need to know filename for
0c17af9d3f9323136a94e66605776ed4462a172dTimo Sirainen given UID. After that it's not re-read unless new mails come that we
0c17af9d3f9323136a94e66605776ed4462a172dTimo Sirainen don't know about.
0c17af9d3f9323136a94e66605776ed4462a172dTimo Sirainen broken clients
0c17af9d3f9323136a94e66605776ed4462a172dTimo Sirainen --------------
0c17af9d3f9323136a94e66605776ed4462a172dTimo Sirainen Originally the middle identifier in Maildir filename was specified
0c17af9d3f9323136a94e66605776ed4462a172dTimo Sirainen only as <process id>_<delivery counter>. That however created a
0c17af9d3f9323136a94e66605776ed4462a172dTimo Sirainen problem with randomized PIDs which made it possible that the same
0c17af9d3f9323136a94e66605776ed4462a172dTimo Sirainen PID was reused within one second.
0c17af9d3f9323136a94e66605776ed4462a172dTimo Sirainen So if within one second a mail was delivered, MUA moved it to cur/
0c17af9d3f9323136a94e66605776ed4462a172dTimo Sirainen and another mail was delivered by a new process using same PID as
0c17af9d3f9323136a94e66605776ed4462a172dTimo Sirainen the first one, we likely ended up overwriting the first mail when
0c17af9d3f9323136a94e66605776ed4462a172dTimo Sirainen the second mail was moved over it.
0c17af9d3f9323136a94e66605776ed4462a172dTimo Sirainen Nowadays everyone should be giving a bit more specific identifier,
0c17af9d3f9323136a94e66605776ed4462a172dTimo Sirainen for example include microseconds in it which Dovecot does.
0c17af9d3f9323136a94e66605776ed4462a172dTimo Sirainen There's a simple way to prevent this from happening in some cases:
0c17af9d3f9323136a94e66605776ed4462a172dTimo Sirainen Don't move the mail from new/ to cur/ if it's mtime is >= time() -
0c17af9d3f9323136a94e66605776ed4462a172dTimo Sirainen MAILDIR_SYNC_SECS. The second delivery's link() call then fails
0c17af9d3f9323136a94e66605776ed4462a172dTimo Sirainen because the file is already in new/, and it will then use a
0c17af9d3f9323136a94e66605776ed4462a172dTimo Sirainen different filename. There's a few problems with this however:
0c17af9d3f9323136a94e66605776ed4462a172dTimo Sirainen - it requires extra stat() call which is unneeded extra I/O
0c17af9d3f9323136a94e66605776ed4462a172dTimo Sirainen - another MUA might still move the mail to cur/
0c17af9d3f9323136a94e66605776ed4462a172dTimo Sirainen - if first file's flags are modified by either Dovecot or another
0c17af9d3f9323136a94e66605776ed4462a172dTimo Sirainen MUA, it's moved to cur/ (you _could_ just do the dirty-flagging
0c17af9d3f9323136a94e66605776ed4462a172dTimo Sirainen but that'd be ugly)
0c17af9d3f9323136a94e66605776ed4462a172dTimo Sirainen Because this is useful only for very few people and it requires
0c17af9d3f9323136a94e66605776ed4462a172dTimo Sirainen extra I/O, I decided not to implement this. It should be however
0c17af9d3f9323136a94e66605776ed4462a172dTimo Sirainen quite easy to do since we need to be able to deal with files in new/
0c17af9d3f9323136a94e66605776ed4462a172dTimo Sirainen It's also possible to never accidentally overwrite a mail by using
0c17af9d3f9323136a94e66605776ed4462a172dTimo Sirainen link() + unlink() rather than rename(). This however isn't very
0c17af9d3f9323136a94e66605776ed4462a172dTimo Sirainen good idea as it introduces potential race conditions when multiple
0c17af9d3f9323136a94e66605776ed4462a172dTimo Sirainen clients are accessing the mailbox:
0c17af9d3f9323136a94e66605776ed4462a172dTimo Sirainen Trying to move the same mail from new/ to cur/ at the same time:
0c17af9d3f9323136a94e66605776ed4462a172dTimo Sirainen a) Client 1 uses slightly different filename than client 2,
0c17af9d3f9323136a94e66605776ed4462a172dTimo Sirainen for example one sets read-flag on but the other doesn't.
0c17af9d3f9323136a94e66605776ed4462a172dTimo Sirainen You have the same mail duplicated now.
0c17af9d3f9323136a94e66605776ed4462a172dTimo Sirainen b) Client 3 sees the mail between Client 1's and 2's link() calls
0c17af9d3f9323136a94e66605776ed4462a172dTimo Sirainen and changes it's flag. You have the same mail duplicated now.
0c17af9d3f9323136a94e66605776ed4462a172dTimo Sirainen And it gets worse when they're unlink()ing in cur/ directory:
0c17af9d3f9323136a94e66605776ed4462a172dTimo Sirainen c) Client 1 changes mails's flag and client 2 changes it back
0c17af9d3f9323136a94e66605776ed4462a172dTimo Sirainen between 1's link() and unlink(). The mail is now expunged.
0c17af9d3f9323136a94e66605776ed4462a172dTimo Sirainen d) If you try to deal with the duplicates by unlink()ing another
0c17af9d3f9323136a94e66605776ed4462a172dTimo Sirainen one of them, you might end up unlinking both of them.
0c17af9d3f9323136a94e66605776ed4462a172dTimo Sirainen So, what should we do then if we notice a duplicate? First of all,
0c17af9d3f9323136a94e66605776ed4462a172dTimo Sirainen it might not be a duplicate at all, readdir() might have just
0c17af9d3f9323136a94e66605776ed4462a172dTimo Sirainen returned it twice because it was just renamed. What we should do is
0c17af9d3f9323136a94e66605776ed4462a172dTimo Sirainen create a completely new base name for it and rename() it to that.
0c17af9d3f9323136a94e66605776ed4462a172dTimo Sirainen If the call fails with ENOENT, it only means that it wasn't a
0c17af9d3f9323136a94e66605776ed4462a172dTimo Sirainen duplicate after all.
d4dcb9c30dba354cff7af6d303ecef7698194c55Timo Sirainen struct maildir_uidlist_sync_ctx *uidlist_sync_ctx;
fd3d711f219fd6813492acbe051e04327f0ca0f0Timo Sirainenstatic int maildir_expunge(struct index_mailbox *ibox, const char *path,
0cb2e8eb55e70f8ebe1e8349bdf49e4cbe5d8834Timo Sirainenstatic int maildir_sync_flags(struct index_mailbox *ibox, const char *path,
0cb2e8eb55e70f8ebe1e8349bdf49e4cbe5d8834Timo Sirainen struct maildir_index_sync_context *ctx = context;
b35f7104715edee0cfac6d46ab0b342033867eb7Timo Sirainen (void)maildir_filename_get_flags(path, &flags, keywords);
0cb2e8eb55e70f8ebe1e8349bdf49e4cbe5d8834Timo Sirainen mail_index_sync_flags_apply(&ctx->sync_rec, &flags8, keywords);
0cb2e8eb55e70f8ebe1e8349bdf49e4cbe5d8834Timo Sirainen newpath = maildir_filename_set_flags(path, flags8, keywords);
0c17af9d3f9323136a94e66605776ed4462a172dTimo Sirainen if ((flags8 & MAIL_INDEX_MAIL_FLAG_DIRTY) != 0)
b35f7104715edee0cfac6d46ab0b342033867eb7Timo Sirainen mail_index_update_flags(ctx->trans, ctx->seq, MODIFY_ADD,
0cb2e8eb55e70f8ebe1e8349bdf49e4cbe5d8834Timo Sirainenstatic int maildir_sync_record(struct index_mailbox *ibox,
0cb2e8eb55e70f8ebe1e8349bdf49e4cbe5d8834Timo Sirainen struct mail_index_sync_rec *sync_rec = &ctx->sync_rec;
0cb2e8eb55e70f8ebe1e8349bdf49e4cbe5d8834Timo Sirainen /* make it go through sequences to avoid looping through huge
659fe5d24825b160cae512538088020d97a60239Timo Sirainen holes in UID range */
659fe5d24825b160cae512538088020d97a60239Timo Sirainen if (mail_index_lookup_uid_range(view, sync_rec->uid1,
659fe5d24825b160cae512538088020d97a60239Timo Sirainen if (mail_index_lookup_uid(view, seq, &uid) < 0)
0cb2e8eb55e70f8ebe1e8349bdf49e4cbe5d8834Timo Sirainen if (maildir_file_do(ibox, uid, maildir_expunge,
0cb2e8eb55e70f8ebe1e8349bdf49e4cbe5d8834Timo Sirainen if (mail_index_lookup_uid_range(view, sync_rec->uid1,
659fe5d24825b160cae512538088020d97a60239Timo Sirainen for (ctx->seq = seq1; ctx->seq <= seq2; ctx->seq++) {
659fe5d24825b160cae512538088020d97a60239Timo Sirainen if (mail_index_lookup_uid(view, ctx->seq, &uid) < 0)
b92813e2f96d4b28f989528ed5dd6115da7d9bdbTimo Sirainen /* flag isn't dirty anymore */
0cb2e8eb55e70f8ebe1e8349bdf49e4cbe5d8834Timo Sirainenint maildir_sync_last_commit(struct index_mailbox *ibox)
65d6ca3fb5450b81df0190d9e9aa62c00fed5116Timo Sirainen ret = mail_index_sync_begin(ibox->index, &ctx.sync_ctx, &ctx.view,
0cb2e8eb55e70f8ebe1e8349bdf49e4cbe5d8834Timo Sirainen ctx.trans = mail_index_transaction_begin(ctx.view, FALSE);
b35f7104715edee0cfac6d46ab0b342033867eb7Timo Sirainen while ((ret = mail_index_sync_next(ctx.sync_ctx,
0cb2e8eb55e70f8ebe1e8349bdf49e4cbe5d8834Timo Sirainen if (mail_index_transaction_commit(ctx.trans, &seq, &offset) < 0)
0cb2e8eb55e70f8ebe1e8349bdf49e4cbe5d8834Timo Sirainenmaildir_sync_context_new(struct index_mailbox *ibox)
0cb2e8eb55e70f8ebe1e8349bdf49e4cbe5d8834Timo Sirainen ctx->new_dir = t_strconcat(ibox->path, "/new", NULL);
0cb2e8eb55e70f8ebe1e8349bdf49e4cbe5d8834Timo Sirainen ctx->cur_dir = t_strconcat(ibox->path, "/cur", NULL);
0cb2e8eb55e70f8ebe1e8349bdf49e4cbe5d8834Timo Sirainenstatic void maildir_sync_deinit(struct maildir_sync_context *ctx)
0cb2e8eb55e70f8ebe1e8349bdf49e4cbe5d8834Timo Sirainen (void)maildir_uidlist_sync_deinit(ctx->uidlist_sync_ctx);
d4dcb9c30dba354cff7af6d303ecef7698194c55Timo Sirainenstatic int maildir_fix_duplicate(struct index_mailbox *ibox, const char *dir,
0cb2e8eb55e70f8ebe1e8349bdf49e4cbe5d8834Timo Sirainen old_path = t_strconcat(dir, "/", old_fname, NULL);
0cb2e8eb55e70f8ebe1e8349bdf49e4cbe5d8834Timo Sirainen new_fname = maildir_generate_tmp_filename(&ioloop_timeval);
0cb2e8eb55e70f8ebe1e8349bdf49e4cbe5d8834Timo Sirainen new_path = t_strconcat(ibox->path, "/new/", new_fname, NULL);
0cb2e8eb55e70f8ebe1e8349bdf49e4cbe5d8834Timo Sirainen "rename(%s, %s) failed: %m", old_path, new_path);
0cb2e8eb55e70f8ebe1e8349bdf49e4cbe5d8834Timo Sirainenstatic int maildir_scan_dir(struct maildir_sync_context *ctx, int new_dir)
0cb2e8eb55e70f8ebe1e8349bdf49e4cbe5d8834Timo Sirainen struct mail_storage *storage = ctx->ibox->box.storage;
0cb2e8eb55e70f8ebe1e8349bdf49e4cbe5d8834Timo Sirainen const char *dir;
d77c309fccbc6a7594f8cb08fb01009fa613c568Timo Sirainen move_new = new_dir && !mailbox_is_readonly(&ctx->ibox->box) &&
7bd6001d84ecc1792ddfd54fe8efa63c509d90b1Timo Sirainen ret = maildir_uidlist_sync_next_pre(ctx->uidlist_sync_ctx,
8fcff4c5b52f24d9c681805fdf06b486f1d0fcbeTimo Sirainen /* new file and we couldn't lock uidlist, check this
8fcff4c5b52f24d9c681805fdf06b486f1d0fcbeTimo Sirainen later in next sync. */
0cb2e8eb55e70f8ebe1e8349bdf49e4cbe5d8834Timo Sirainen str_printfa(src, "%s/%s", ctx->new_dir, dp->d_name);
0cb2e8eb55e70f8ebe1e8349bdf49e4cbe5d8834Timo Sirainen str_printfa(dest, "%s/%s", ctx->cur_dir, dp->d_name);
ead79af955bccc360de08c150918474c1809748eTimo Sirainen /* we moved it - it's \Recent for us */
641f0c0900ee6e7cf9667f4b40ed95cec7d0cdcaTimo Sirainen /* someone else moved it already */
641f0c0900ee6e7cf9667f4b40ed95cec7d0cdcaTimo Sirainen /* not enough disk space, leave here */
641f0c0900ee6e7cf9667f4b40ed95cec7d0cdcaTimo Sirainen "rename(%s, %s) failed: %m",
0cb2e8eb55e70f8ebe1e8349bdf49e4cbe5d8834Timo Sirainen } else if (new_dir) {
641f0c0900ee6e7cf9667f4b40ed95cec7d0cdcaTimo Sirainen ret = maildir_uidlist_sync_next(ctx->uidlist_sync_ctx,
0cb2e8eb55e70f8ebe1e8349bdf49e4cbe5d8834Timo Sirainen /* possibly duplicate - try fixing it */
0cb2e8eb55e70f8ebe1e8349bdf49e4cbe5d8834Timo Sirainenstatic int maildir_sync_quick_check(struct maildir_sync_context *ctx,
0cb2e8eb55e70f8ebe1e8349bdf49e4cbe5d8834Timo Sirainen /* cur stamp is kept in index, we don't have to sync if
0cb2e8eb55e70f8ebe1e8349bdf49e4cbe5d8834Timo Sirainen someone else has done it and updated the index. make sure
bde6382cf65fba6165dc3603f5419e194d87f404Timo Sirainen we have a fresh index with latest sync_stamp. */
b7b81543899e306c71e6152516d8698416162bcbTimo Sirainen new_mtime >= ibox->last_new_sync_time - MAILDIR_SYNC_SECS) {
b7b81543899e306c71e6152516d8698416162bcbTimo Sirainen ioloop_time - ibox->dirty_cur_time > MAILDIR_SYNC_SECS)) {
0cb2e8eb55e70f8ebe1e8349bdf49e4cbe5d8834Timo Sirainen /* cur/ changed, or delayed cur/ check */
0cb2e8eb55e70f8ebe1e8349bdf49e4cbe5d8834Timo Sirainen cur_mtime >= ioloop_time - MAILDIR_SYNC_SECS ?
0cb2e8eb55e70f8ebe1e8349bdf49e4cbe5d8834Timo Sirainenint maildir_sync_index(struct index_mailbox *ibox, int partial)
d4dcb9c30dba354cff7af6d303ecef7698194c55Timo Sirainen if (mail_index_sync_begin(ibox->index, &sync_ctx.sync_ctx, &view,
d4dcb9c30dba354cff7af6d303ecef7698194c55Timo Sirainen i_assert(ret == 0); /* view is locked, can't happen */
d4dcb9c30dba354cff7af6d303ecef7698194c55Timo Sirainen uid_validity = maildir_uidlist_get_uid_validity(ibox->uidlist);
0cb2e8eb55e70f8ebe1e8349bdf49e4cbe5d8834Timo Sirainen uid_validity != 0 && hdr->uid_validity != 0) {
0cb2e8eb55e70f8ebe1e8349bdf49e4cbe5d8834Timo Sirainen /* uidvalidity changed and mailbox isn't being initialized,
0cb2e8eb55e70f8ebe1e8349bdf49e4cbe5d8834Timo Sirainen index must be rebuilt */
b7b81543899e306c71e6152516d8698416162bcbTimo Sirainen "Maildir %s sync: UIDVALIDITY changed (%u -> %u)",
d8b77aef97e89f1ccc5cbdaef77be9052279e35fTimo Sirainen (void)mail_index_sync_rollback(sync_ctx.sync_ctx);
de4288b7369945a31c4001add9445fd0195a358dTimo Sirainen trans = mail_index_transaction_begin(view, FALSE);
de4288b7369945a31c4001add9445fd0195a358dTimo Sirainen iter = maildir_uidlist_iter_init(ibox->uidlist);
de4288b7369945a31c4001add9445fd0195a358dTimo Sirainen while (maildir_uidlist_iter_next(iter, &uid, &uflags, &filename)) {
31ddc75584c5cde53d2e78a737587f2e7fdcb0d2Timo Sirainen maildir_filename_get_flags(filename, &flags, keywords);
92888ef30960c30ccc9e030fe7eab5d4d04a7d1cTimo Sirainen if ((uflags & MAILDIR_UIDLIST_REC_FLAG_RECENT) != 0 &&
92888ef30960c30ccc9e030fe7eab5d4d04a7d1cTimo Sirainen (uflags & MAILDIR_UIDLIST_REC_FLAG_NEW_DIR) != 0 &&
e06c0b65c16ccce69bbee009ead14d7d3d17a256Timo Sirainen (uflags & MAILDIR_UIDLIST_REC_FLAG_MOVED) == 0) {
e06c0b65c16ccce69bbee009ead14d7d3d17a256Timo Sirainen /* mail is recent for next session as well */
7c95b03620a03a43dd72d39608cea5fc77393ad6Timo Sirainen /* most likely a race condition: we read the
d4dcb9c30dba354cff7af6d303ecef7698194c55Timo Sirainen maildir, then someone else expunged messages
0cb2e8eb55e70f8ebe1e8349bdf49e4cbe5d8834Timo Sirainen and committed changes to index. so, this
0cb2e8eb55e70f8ebe1e8349bdf49e4cbe5d8834Timo Sirainen message shouldn't actually exist. mark it
0cb2e8eb55e70f8ebe1e8349bdf49e4cbe5d8834Timo Sirainen racy and check in next sync.
d8b77aef97e89f1ccc5cbdaef77be9052279e35fTimo Sirainen the difference between this and the later
0cb2e8eb55e70f8ebe1e8349bdf49e4cbe5d8834Timo Sirainen check is that this one happens when messages
d482b35af87f5fd872bad007da0475813a401a49Timo Sirainen are expunged from the end */
d482b35af87f5fd872bad007da0475813a401a49Timo Sirainen /* partial syncing */
0cb2e8eb55e70f8ebe1e8349bdf49e4cbe5d8834Timo Sirainen "Maildir %s sync: "
d67f54632110cfb6aafe2d7cd1f99b031c0b208aTimo Sirainen "UID < next_uid "
316689d0ef55e2fa4e2fb4ac5b1ea35ce65688d3Timo Sirainen "(%u < %u, file = %s)",
316689d0ef55e2fa4e2fb4ac5b1ea35ce65688d3Timo Sirainen mail_index_update_flags(trans, seq, MODIFY_REPLACE,
316689d0ef55e2fa4e2fb4ac5b1ea35ce65688d3Timo Sirainen /* expunged */
d67f54632110cfb6aafe2d7cd1f99b031c0b208aTimo Sirainen /* most likely a race condition: we read the
d67f54632110cfb6aafe2d7cd1f99b031c0b208aTimo Sirainen maildir, then someone else expunged messages and
0cb2e8eb55e70f8ebe1e8349bdf49e4cbe5d8834Timo Sirainen committed changes to index. so, this message
0cb2e8eb55e70f8ebe1e8349bdf49e4cbe5d8834Timo Sirainen shouldn't actually exist. mark it racy and check
d8b77aef97e89f1ccc5cbdaef77be9052279e35fTimo Sirainen in next sync. */
0cb2e8eb55e70f8ebe1e8349bdf49e4cbe5d8834Timo Sirainen /* partial syncing */
0cb2e8eb55e70f8ebe1e8349bdf49e4cbe5d8834Timo Sirainen if ((uflags & MAILDIR_UIDLIST_REC_FLAG_RACING) != 0) {
0cb2e8eb55e70f8ebe1e8349bdf49e4cbe5d8834Timo Sirainen "Maildir %s sync: "
0cb2e8eb55e70f8ebe1e8349bdf49e4cbe5d8834Timo Sirainen "UID inserted in the middle of mailbox "
0cb2e8eb55e70f8ebe1e8349bdf49e4cbe5d8834Timo Sirainen "(%u > %u, file = %s)",
316689d0ef55e2fa4e2fb4ac5b1ea35ce65688d3Timo Sirainen maildir_uidlist_add_flags(ibox->uidlist, filename,
316689d0ef55e2fa4e2fb4ac5b1ea35ce65688d3Timo Sirainen if ((uflags & MAILDIR_UIDLIST_REC_FLAG_NONSYNCED) != 0) {
316689d0ef55e2fa4e2fb4ac5b1ea35ce65688d3Timo Sirainen /* partial syncing */
a038139a470d2942759b9b86a9852aee7b460996Timo Sirainen if ((rec->flags & MAIL_INDEX_MAIL_FLAG_DIRTY) != 0) {
a038139a470d2942759b9b86a9852aee7b460996Timo Sirainen /* we haven't been able to update maildir with this
0cb2e8eb55e70f8ebe1e8349bdf49e4cbe5d8834Timo Sirainen record's flag changes. don't sync them. */
0aa66a8e037c08604e71446d6ba52150a17dfc21Timo Sirainen (rec->flags & (MAIL_FLAGS_MASK^MAIL_RECENT)) ||
0aa66a8e037c08604e71446d6ba52150a17dfc21Timo Sirainen /* FIXME: this is wrong if there's pending changes in
0aa66a8e037c08604e71446d6ba52150a17dfc21Timo Sirainen transaction log already. it gets fixed in next sync
0aa66a8e037c08604e71446d6ba52150a17dfc21Timo Sirainen mail_index_update_flags(trans, seq, MODIFY_REPLACE,
a33fde36c57839342dafdf3c8d4b5c009e3ef4bcTimo Sirainen /* just remove recent flag */
a33fde36c57839342dafdf3c8d4b5c009e3ef4bcTimo Sirainen mail_index_update_flags(trans, seq, MODIFY_REMOVE,
d482b35af87f5fd872bad007da0475813a401a49Timo Sirainen /* expunge the rest */
d482b35af87f5fd872bad007da0475813a401a49Timo Sirainen for (seq++; seq <= hdr->messages_count; seq++)
d482b35af87f5fd872bad007da0475813a401a49Timo Sirainen /* now, sync the index */
0cb2e8eb55e70f8ebe1e8349bdf49e4cbe5d8834Timo Sirainen while ((ret = mail_index_sync_next(sync_ctx.sync_ctx,
d482b35af87f5fd872bad007da0475813a401a49Timo Sirainen if (maildir_sync_record(ibox, &sync_ctx) < 0) {
0cb2e8eb55e70f8ebe1e8349bdf49e4cbe5d8834Timo Sirainen ibox->last_cur_mtime != (time_t)hdr->sync_stamp) {
b7b81543899e306c71e6152516d8698416162bcbTimo Sirainen offsetof(struct mail_index_header, sync_stamp),
714dfaac096e6190898aaa7cce315c2fa247f05aTimo Sirainen /* get the initial uidvalidity */
d4dcb9c30dba354cff7af6d303ecef7698194c55Timo Sirainen if (maildir_uidlist_update(ibox->uidlist) < 0)
d4dcb9c30dba354cff7af6d303ecef7698194c55Timo Sirainen uid_validity = maildir_uidlist_get_uid_validity(ibox->uidlist);
b35f7104715edee0cfac6d46ab0b342033867eb7Timo Sirainen maildir_uidlist_set_uid_validity(ibox->uidlist,
b35f7104715edee0cfac6d46ab0b342033867eb7Timo Sirainen } else if (uid_validity == 0) {
bde6382cf65fba6165dc3603f5419e194d87f404Timo Sirainen maildir_uidlist_set_uid_validity(ibox->uidlist,
e06c0b65c16ccce69bbee009ead14d7d3d17a256Timo Sirainen if (uid_validity != hdr->uid_validity && uid_validity != 0) {
e06c0b65c16ccce69bbee009ead14d7d3d17a256Timo Sirainen offsetof(struct mail_index_header, uid_validity),
92888ef30960c30ccc9e030fe7eab5d4d04a7d1cTimo Sirainen next_uid = maildir_uidlist_get_next_uid(ibox->uidlist);
92888ef30960c30ccc9e030fe7eab5d4d04a7d1cTimo Sirainen if (next_uid != 0 && hdr->next_uid != next_uid) {
92888ef30960c30ccc9e030fe7eab5d4d04a7d1cTimo Sirainen if (mail_index_transaction_commit(trans, &seq, &offset) < 0)
e06c0b65c16ccce69bbee009ead14d7d3d17a256Timo Sirainen else if (seq != 0) {
e06c0b65c16ccce69bbee009ead14d7d3d17a256Timo Sirainen if (mail_index_sync_commit(sync_ctx.sync_ctx) < 0)
0cb2e8eb55e70f8ebe1e8349bdf49e4cbe5d8834Timo Sirainenstatic int maildir_sync_context(struct maildir_sync_context *ctx, int forced)
0cb2e8eb55e70f8ebe1e8349bdf49e4cbe5d8834Timo Sirainen if (maildir_sync_quick_check(ctx, &new_changed, &cur_changed) < 0)
0cb2e8eb55e70f8ebe1e8349bdf49e4cbe5d8834Timo Sirainen /* we have to lock uidlist immediately, otherwise there's race
0cb2e8eb55e70f8ebe1e8349bdf49e4cbe5d8834Timo Sirainen conditions with other processes who might write older maildir
0cb2e8eb55e70f8ebe1e8349bdf49e4cbe5d8834Timo Sirainen file list into uidlist.
0cb2e8eb55e70f8ebe1e8349bdf49e4cbe5d8834Timo Sirainen alternative would be to lock it when new files are found, but
0cb2e8eb55e70f8ebe1e8349bdf49e4cbe5d8834Timo Sirainen the directory scans _must_ be restarted then.
a38ef15060e45e5060bb24c403a580b9a57a818cTimo Sirainen if we got here through maildir_sync_last_commit(), we can't sync
0cb2e8eb55e70f8ebe1e8349bdf49e4cbe5d8834Timo Sirainen index as it's already being synced. so, don't try locking uidlist
0cb2e8eb55e70f8ebe1e8349bdf49e4cbe5d8834Timo Sirainen either, we only want to find new filename for some mail.
a38ef15060e45e5060bb24c403a580b9a57a818cTimo Sirainen if ((ret = maildir_uidlist_try_lock(ctx->ibox->uidlist)) < 0)
a38ef15060e45e5060bb24c403a580b9a57a818cTimo Sirainen /* we didn't get a lock, don't do syncing unless we
a38ef15060e45e5060bb24c403a580b9a57a818cTimo Sirainen really want to check for expunges or renames. new
a38ef15060e45e5060bb24c403a580b9a57a818cTimo Sirainen files won't be added. */
d4dcb9c30dba354cff7af6d303ecef7698194c55Timo Sirainen maildir_uidlist_sync_init(ctx->ibox->uidlist, ctx->partial);
d4dcb9c30dba354cff7af6d303ecef7698194c55Timo Sirainen /* finish uidlist syncing, but keep it still locked */
d4dcb9c30dba354cff7af6d303ecef7698194c55Timo Sirainen maildir_uidlist_sync_finish(ctx->uidlist_sync_ctx);
d4dcb9c30dba354cff7af6d303ecef7698194c55Timo Sirainen if (maildir_sync_index(ctx->ibox, ctx->partial) < 0)
d4dcb9c30dba354cff7af6d303ecef7698194c55Timo Sirainen ret = maildir_uidlist_sync_deinit(ctx->uidlist_sync_ctx);
d4dcb9c30dba354cff7af6d303ecef7698194c55Timo Sirainenint maildir_storage_sync_force(struct index_mailbox *ibox)
d4dcb9c30dba354cff7af6d303ecef7698194c55Timo Sirainenmaildir_storage_sync_init(struct mailbox *box, enum mailbox_sync_flags flags)
d4dcb9c30dba354cff7af6d303ecef7698194c55Timo Sirainen struct index_mailbox *ibox = (struct index_mailbox *)box;
65d6ca3fb5450b81df0190d9e9aa62c00fed5116Timo Sirainen ibox->sync_last_check + MAILBOX_FULL_SYNC_INTERVAL <= ioloop_time) {