maildir-keywords.c revision 32ee977e189266744ef69ac4e832fd3111d6f949
89a126810703c666309310d0f3189e9834d70b5bTimo Sirainen/* Copyright (c) 2005-2007 Dovecot authors, see the included COPYING file */
cce169a321c9c629e4f2db1a69dae3b75bbcb27aTimo Sirainen/* note that everything here depends on uidlist file being locked the whole
cce169a321c9c629e4f2db1a69dae3b75bbcb27aTimo Sirainen time. that's why we don't have any locking of our own, or that we do things
cce169a321c9c629e4f2db1a69dae3b75bbcb27aTimo Sirainen that would be racy otherwise. */
6e1e9e341ffe21a69a23229c2b896d03066a071eTimo Sirainen/* how many seconds to wait before overriding dovecot-keywords.lock */
cce169a321c9c629e4f2db1a69dae3b75bbcb27aTimo Sirainen unsigned int chridx_to_idx[MAILDIR_MAX_KEYWORDS];
cce169a321c9c629e4f2db1a69dae3b75bbcb27aTimo Sirainenstruct maildir_keywords *maildir_keywords_init(struct maildir_mailbox *mbox)
0ea17cea21df405e6e74a167d08e1ff0ee95dd13Timo Sirainen mk = maildir_keywords_init_readonly(&mbox->ibox.box);
0ea17cea21df405e6e74a167d08e1ff0ee95dd13Timo Sirainenmaildir_keywords_init_readonly(struct mailbox *box)
0ea17cea21df405e6e74a167d08e1ff0ee95dd13Timo Sirainen const char *dir;
0ea17cea21df405e6e74a167d08e1ff0ee95dd13Timo Sirainen dir = mail_storage_get_mailbox_control_dir(box->storage, box->name);
0ea17cea21df405e6e74a167d08e1ff0ee95dd13Timo Sirainen mk->path = i_strconcat(dir, "/" MAILDIR_KEYWORDS_NAME, NULL);
0449e50c99f3fab4485f9b983e3936aaa003c79aTimo Sirainen mk->pool = pool_alloconly_create("maildir keywords", 512);
91dca97b367c54a139c268b56a0c67f564bd9197Timo Sirainen i_array_init(&mk->list, MAILDIR_MAX_KEYWORDS);
cce169a321c9c629e4f2db1a69dae3b75bbcb27aTimo Sirainen mk->hash = hash_create(default_pool, mk->pool, 0,
cce169a321c9c629e4f2db1a69dae3b75bbcb27aTimo Sirainen strcase_hash, (hash_cmp_callback_t *)strcasecmp);
0ea17cea21df405e6e74a167d08e1ff0ee95dd13Timo Sirainen (box->storage->flags & MAIL_STORAGE_FLAG_DOTLOCK_USE_EXCL) != 0;
6e1e9e341ffe21a69a23229c2b896d03066a071eTimo Sirainen mk->dotlock_settings.timeout = KEYWORDS_LOCK_STALE_TIMEOUT + 2;
6e1e9e341ffe21a69a23229c2b896d03066a071eTimo Sirainen mk->dotlock_settings.stale_timeout = KEYWORDS_LOCK_STALE_TIMEOUT;
0ea17cea21df405e6e74a167d08e1ff0ee95dd13Timo Sirainen mailbox_list_get_temp_prefix(box->storage->list);
9740d55b228a670047c854484d5cc979a056a9afTimo Sirainenvoid maildir_keywords_deinit(struct maildir_keywords **_mk)
cce169a321c9c629e4f2db1a69dae3b75bbcb27aTimo Sirainenstatic void maildir_keywords_clear(struct maildir_keywords *mk)
cce169a321c9c629e4f2db1a69dae3b75bbcb27aTimo Sirainenstatic int maildir_keywords_sync(struct maildir_keywords *mk)
cce169a321c9c629e4f2db1a69dae3b75bbcb27aTimo Sirainen const char **strp;
1e47cfede3a0b62654105daab00e97b5d660bc6bTimo Sirainen /* Remember that we rely on uidlist file locking in here. That's why
1e47cfede3a0b62654105daab00e97b5d660bc6bTimo Sirainen we rely on stat()'s timestamp and don't bother handling ESTALE
0ea17cea21df405e6e74a167d08e1ff0ee95dd13Timo Sirainen if ((mk->storage->flags & MAIL_STORAGE_FLAG_NFS_FLUSH_STORAGE) != 0)
cce169a321c9c629e4f2db1a69dae3b75bbcb27aTimo Sirainen /* hasn't changed */
cce169a321c9c629e4f2db1a69dae3b75bbcb27aTimo Sirainen while ((line = i_stream_read_next_line(input)) != NULL) {
cce169a321c9c629e4f2db1a69dae3b75bbcb27aTimo Sirainen /* note that when converting .customflags file this
cce169a321c9c629e4f2db1a69dae3b75bbcb27aTimo Sirainen case happens in the first line. */
bd2e2500e64c00349ee00e28797809b4029db52fTimo Sirainen if (idx < 0 || idx >= MAILDIR_MAX_KEYWORDS || *p == '\0') {
cce169a321c9c629e4f2db1a69dae3b75bbcb27aTimo Sirainen /* shouldn't happen */
cce169a321c9c629e4f2db1a69dae3b75bbcb27aTimo Sirainen /* save it */
cce169a321c9c629e4f2db1a69dae3b75bbcb27aTimo Sirainen hash_insert(mk->hash, new_name, POINTER_CAST(idx + 1));
cce169a321c9c629e4f2db1a69dae3b75bbcb27aTimo Sirainenmaildir_keywords_lookup(struct maildir_keywords *mk, const char *name)
0ea17cea21df405e6e74a167d08e1ff0ee95dd13Timo Sirainen maildir_uidlist_is_locked(mk->mbox->uidlist));
cce169a321c9c629e4f2db1a69dae3b75bbcb27aTimo Sirainenmaildir_keywords_create(struct maildir_keywords *mk, const char *name,
cce169a321c9c629e4f2db1a69dae3b75bbcb27aTimo Sirainen unsigned int chridx)
cce169a321c9c629e4f2db1a69dae3b75bbcb27aTimo Sirainen const char **strp;
cce169a321c9c629e4f2db1a69dae3b75bbcb27aTimo Sirainen hash_insert(mk->hash, new_name, POINTER_CAST(chridx + 1));
8d80659e504ffb34bb0c6a633184fece35751b18Timo Sirainen strp = array_idx_modifiable(&mk->list, chridx);
cce169a321c9c629e4f2db1a69dae3b75bbcb27aTimo Sirainenmaildir_keywords_lookup_or_create(struct maildir_keywords *mk, const char *name)
cce169a321c9c629e4f2db1a69dae3b75bbcb27aTimo Sirainen const char *const *keywords;
cce169a321c9c629e4f2db1a69dae3b75bbcb27aTimo Sirainen unsigned int i, count;
3bc2b84acd8c5731a0bc9d69fbcd3103b68e9b52Timo Sirainen /* we couldn't open the dovecot-keywords file. */
cce169a321c9c629e4f2db1a69dae3b75bbcb27aTimo Sirainen /* see if we are full */
cce169a321c9c629e4f2db1a69dae3b75bbcb27aTimo Sirainen for (i = 0; i < count; i++) {
cce169a321c9c629e4f2db1a69dae3b75bbcb27aTimo Sirainen if (i == count && count >= MAILDIR_MAX_KEYWORDS)
cce169a321c9c629e4f2db1a69dae3b75bbcb27aTimo Sirainenstatic const char *
cce169a321c9c629e4f2db1a69dae3b75bbcb27aTimo Sirainenmaildir_keywords_idx(struct maildir_keywords *mk, unsigned int idx)
cce169a321c9c629e4f2db1a69dae3b75bbcb27aTimo Sirainen const char *const *keywords;
cce169a321c9c629e4f2db1a69dae3b75bbcb27aTimo Sirainen unsigned int count;
0ea17cea21df405e6e74a167d08e1ff0ee95dd13Timo Sirainen maildir_uidlist_is_locked(mk->mbox->uidlist));
8a6fc472a12c5ec09e2bd19f1b3acd553d75ff91Timo Sirainenstatic int maildir_keywords_write_fd(struct maildir_keywords *mk,
8a6fc472a12c5ec09e2bd19f1b3acd553d75ff91Timo Sirainen const char *const *keywords;
cce169a321c9c629e4f2db1a69dae3b75bbcb27aTimo Sirainen unsigned int i, count;
8a6fc472a12c5ec09e2bd19f1b3acd553d75ff91Timo Sirainen for (i = 0; i < count; i++) {
8a6fc472a12c5ec09e2bd19f1b3acd553d75ff91Timo Sirainen if (write_full(fd, str_data(str), str_len(str)) < 0) {
47001341950b8588c5f3a96b75864dab48e279aeTimo Sirainen if (st.st_gid != mbox->ibox.box.file_create_gid &&
47001341950b8588c5f3a96b75864dab48e279aeTimo Sirainen mbox->ibox.box.file_create_gid != (gid_t)-1) {
47001341950b8588c5f3a96b75864dab48e279aeTimo Sirainen if (fchown(fd, (uid_t)-1, mbox->ibox.box.file_create_gid) < 0) {
8a6fc472a12c5ec09e2bd19f1b3acd553d75ff91Timo Sirainen /* mtime must grow every time */
8a6fc472a12c5ec09e2bd19f1b3acd553d75ff91Timo Sirainen mk->synced_mtime = ioloop_time <= mk->synced_mtime ?
8a6fc472a12c5ec09e2bd19f1b3acd553d75ff91Timo Sirainenstatic int maildir_keywords_commit(struct maildir_keywords *mk)
cce169a321c9c629e4f2db1a69dae3b75bbcb27aTimo Sirainen lock_path = t_strconcat(mk->path, ".lock", NULL);
32ee977e189266744ef69ac4e832fd3111d6f949Timo Sirainen for (i = 0;; i++) {
32ee977e189266744ef69ac4e832fd3111d6f949Timo Sirainen /* we could just create the temp file directly, but doing it
32ee977e189266744ef69ac4e832fd3111d6f949Timo Sirainen this ways avoids potential problems with overwriting
32ee977e189266744ef69ac4e832fd3111d6f949Timo Sirainen contents in malicious symlinks */
32ee977e189266744ef69ac4e832fd3111d6f949Timo Sirainen old_mask = umask(0777 & ~mk->mbox->ibox.box.file_create_mode);
32ee977e189266744ef69ac4e832fd3111d6f949Timo Sirainen fd = file_dotlock_open(&mk->dotlock_settings, mk->path,
32ee977e189266744ef69ac4e832fd3111d6f949Timo Sirainen if (errno != ENOENT || i == MAILDIR_DELETE_RETRY_COUNT) {
32ee977e189266744ef69ac4e832fd3111d6f949Timo Sirainen "file_dotlock_open(%s) failed: %m", mk->path);
32ee977e189266744ef69ac4e832fd3111d6f949Timo Sirainen /* the control dir doesn't exist. create it unless the whole
32ee977e189266744ef69ac4e832fd3111d6f949Timo Sirainen mailbox was just deleted. */
8a6fc472a12c5ec09e2bd19f1b3acd553d75ff91Timo Sirainen if (maildir_keywords_write_fd(mk, lock_path, fd) < 0) {
cce169a321c9c629e4f2db1a69dae3b75bbcb27aTimo Sirainen "file_dotlock_replace(%s) failed: %m", mk->path);
cce169a321c9c629e4f2db1a69dae3b75bbcb27aTimo Sirainenmaildir_keywords_sync_init(struct maildir_keywords *mk,
cce169a321c9c629e4f2db1a69dae3b75bbcb27aTimo Sirainen ctx = i_new(struct maildir_keywords_sync_ctx, 1);
cce169a321c9c629e4f2db1a69dae3b75bbcb27aTimo Sirainen ctx->keywords = mail_index_get_keywords(index);
91dca97b367c54a139c268b56a0c67f564bd9197Timo Sirainen i_array_init(&ctx->idx_to_chr, MAILDIR_MAX_KEYWORDS);
9740d55b228a670047c854484d5cc979a056a9afTimo Sirainenvoid maildir_keywords_sync_deinit(struct maildir_keywords_sync_ctx **_ctx)
9740d55b228a670047c854484d5cc979a056a9afTimo Sirainen struct maildir_keywords_sync_ctx *ctx = *_ctx;
cce169a321c9c629e4f2db1a69dae3b75bbcb27aTimo Sirainenunsigned int maildir_keywords_char_idx(struct maildir_keywords_sync_ctx *ctx,
cce169a321c9c629e4f2db1a69dae3b75bbcb27aTimo Sirainen /* lookup / create */
cce169a321c9c629e4f2db1a69dae3b75bbcb27aTimo Sirainen /* name is lost. just generate one ourself. */
cce169a321c9c629e4f2db1a69dae3b75bbcb27aTimo Sirainen while (maildir_keywords_lookup(ctx->mk, name) >= 0) {
cce169a321c9c629e4f2db1a69dae3b75bbcb27aTimo Sirainen /* don't create a duplicate name.
cce169a321c9c629e4f2db1a69dae3b75bbcb27aTimo Sirainen keep changing the name until it doesn't exist */
cce169a321c9c629e4f2db1a69dae3b75bbcb27aTimo Sirainen maildir_keywords_create(ctx->mk, name, chridx);
6825360d446542046757b06064282301c4c6b27cTimo Sirainen mail_index_keyword_lookup_or_create(ctx->index, name, &idx);
cce169a321c9c629e4f2db1a69dae3b75bbcb27aTimo Sirainenchar maildir_keywords_idx_char(struct maildir_keywords_sync_ctx *ctx,
cce169a321c9c629e4f2db1a69dae3b75bbcb27aTimo Sirainen unsigned int idx)
cce169a321c9c629e4f2db1a69dae3b75bbcb27aTimo Sirainen const char *const *name_p;
8d80659e504ffb34bb0c6a633184fece35751b18Timo Sirainen chr_p = array_idx_modifiable(&ctx->idx_to_chr, idx);