dbox-storage.h revision 804fa3f03bd9170272168a5ad214053bbe3160c7
5f5870385cff47efd2f58e7892f251cf13761528Timo Sirainen#ifndef DBOX_STORAGE_H
e8762c2b4914db7997fa9eb644a91586952d1876Timo Sirainen#define DBOX_STORAGE_H
e8762c2b4914db7997fa9eb644a91586952d1876Timo Sirainen
e8762c2b4914db7997fa9eb644a91586952d1876Timo Sirainen#include "mail-storage-private.h"
b9f564d00b7a115f465ffd6840341c7b8f9bfc8aTimo Sirainen
e8762c2b4914db7997fa9eb644a91586952d1876Timo Sirainenstruct dbox_file;
b9f564d00b7a115f465ffd6840341c7b8f9bfc8aTimo Sirainenstruct dbox_mail;
e8762c2b4914db7997fa9eb644a91586952d1876Timo Sirainenstruct dbox_storage;
e8762c2b4914db7997fa9eb644a91586952d1876Timo Sirainenstruct dbox_save_context;
e8762c2b4914db7997fa9eb644a91586952d1876Timo Sirainen
e8762c2b4914db7997fa9eb644a91586952d1876Timo Sirainen#define DBOX_SUBSCRIPTION_FILE_NAME "subscriptions"
b9f564d00b7a115f465ffd6840341c7b8f9bfc8aTimo Sirainen#define DBOX_UIDVALIDITY_FILE_NAME "dovecot-uidvalidity"
b9f564d00b7a115f465ffd6840341c7b8f9bfc8aTimo Sirainen#define DBOX_TEMP_FILE_PREFIX ".temp."
b9f564d00b7a115f465ffd6840341c7b8f9bfc8aTimo Sirainen#define DBOX_ALT_SYMLINK_NAME "dbox-alt-root"
b9f564d00b7a115f465ffd6840341c7b8f9bfc8aTimo Sirainen
b9f564d00b7a115f465ffd6840341c7b8f9bfc8aTimo Sirainen#define DBOX_MAILBOX_DIR_NAME "mailboxes"
b9f564d00b7a115f465ffd6840341c7b8f9bfc8aTimo Sirainen#define DBOX_TRASH_DIR_NAME "trash"
c59b9c273b41f7bcf51f6803110b67813879ff05Timo Sirainen#define DBOX_MAILDIR_NAME "dbox-Mails"
b9f564d00b7a115f465ffd6840341c7b8f9bfc8aTimo Sirainen
b9f564d00b7a115f465ffd6840341c7b8f9bfc8aTimo Sirainen/* Delete temp files having ctime older than this. */
b9f564d00b7a115f465ffd6840341c7b8f9bfc8aTimo Sirainen#define DBOX_TMP_DELETE_SECS (36*60*60)
b9f564d00b7a115f465ffd6840341c7b8f9bfc8aTimo Sirainen
b9f564d00b7a115f465ffd6840341c7b8f9bfc8aTimo Sirainen/* Flag specifies if the message should be in primary or alternative storage */
b9f564d00b7a115f465ffd6840341c7b8f9bfc8aTimo Sirainen#define DBOX_INDEX_FLAG_ALT MAIL_INDEX_MAIL_FLAG_BACKEND
b9f564d00b7a115f465ffd6840341c7b8f9bfc8aTimo Sirainen
b9f564d00b7a115f465ffd6840341c7b8f9bfc8aTimo Sirainenenum dbox_index_header_flags {
b9f564d00b7a115f465ffd6840341c7b8f9bfc8aTimo Sirainen /* messages' metadata contain POP3 UIDLs */
b9f564d00b7a115f465ffd6840341c7b8f9bfc8aTimo Sirainen DBOX_INDEX_HEADER_FLAG_HAVE_POP3_UIDLS = 0x01,
b9f564d00b7a115f465ffd6840341c7b8f9bfc8aTimo Sirainen /* messages' metadata contain POP3 orders */
b9f564d00b7a115f465ffd6840341c7b8f9bfc8aTimo Sirainen DBOX_INDEX_HEADER_FLAG_HAVE_POP3_ORDERS = 0x02
b9f564d00b7a115f465ffd6840341c7b8f9bfc8aTimo Sirainen};
b9f564d00b7a115f465ffd6840341c7b8f9bfc8aTimo Sirainen
b9f564d00b7a115f465ffd6840341c7b8f9bfc8aTimo Sirainenstruct dbox_storage_vfuncs {
b9f564d00b7a115f465ffd6840341c7b8f9bfc8aTimo Sirainen /* dbox file has zero references now. it should be either freed or
b9f564d00b7a115f465ffd6840341c7b8f9bfc8aTimo Sirainen left open in case it's accessed again soon */
b9f564d00b7a115f465ffd6840341c7b8f9bfc8aTimo Sirainen void (*file_unrefed)(struct dbox_file *file);
b9f564d00b7a115f465ffd6840341c7b8f9bfc8aTimo Sirainen /* create a new file using the same permissions as file.
b9f564d00b7a115f465ffd6840341c7b8f9bfc8aTimo Sirainen if parents=TRUE, create the directory if necessary */
b9f564d00b7a115f465ffd6840341c7b8f9bfc8aTimo Sirainen int (*file_create_fd)(struct dbox_file *file, const char *path,
b9f564d00b7a115f465ffd6840341c7b8f9bfc8aTimo Sirainen bool parents);
b9f564d00b7a115f465ffd6840341c7b8f9bfc8aTimo Sirainen /* open the mail and return its file/offset */
b9f564d00b7a115f465ffd6840341c7b8f9bfc8aTimo Sirainen int (*mail_open)(struct dbox_mail *mail, uoff_t *offset_r,
b9f564d00b7a115f465ffd6840341c7b8f9bfc8aTimo Sirainen struct dbox_file **file_r);
b9f564d00b7a115f465ffd6840341c7b8f9bfc8aTimo Sirainen /* create/update mailbox indexes */
b9f564d00b7a115f465ffd6840341c7b8f9bfc8aTimo Sirainen int (*mailbox_create_indexes)(struct mailbox *box,
b9f564d00b7a115f465ffd6840341c7b8f9bfc8aTimo Sirainen const struct mailbox_update *update,
b9f564d00b7a115f465ffd6840341c7b8f9bfc8aTimo Sirainen struct mail_index_transaction *trans);
b9f564d00b7a115f465ffd6840341c7b8f9bfc8aTimo Sirainen /* returns attachment path suffix. mdbox returns "", sdbox returns
b9f564d00b7a115f465ffd6840341c7b8f9bfc8aTimo Sirainen "-<mailbox_guid>-<uid>" */
b9f564d00b7a115f465ffd6840341c7b8f9bfc8aTimo Sirainen const char *(*get_attachment_path_suffix)(struct dbox_file *file);
b9f564d00b7a115f465ffd6840341c7b8f9bfc8aTimo Sirainen /* mark the mailbox corrupted */
b9f564d00b7a115f465ffd6840341c7b8f9bfc8aTimo Sirainen void (*set_mailbox_corrupted)(struct mailbox *box);
b9f564d00b7a115f465ffd6840341c7b8f9bfc8aTimo Sirainen /* mark the file corrupted */
b9f564d00b7a115f465ffd6840341c7b8f9bfc8aTimo Sirainen void (*set_file_corrupted)(struct dbox_file *file);
b9f564d00b7a115f465ffd6840341c7b8f9bfc8aTimo Sirainen};
b9f564d00b7a115f465ffd6840341c7b8f9bfc8aTimo Sirainen
b9f564d00b7a115f465ffd6840341c7b8f9bfc8aTimo Sirainenstruct dbox_storage {
b9f564d00b7a115f465ffd6840341c7b8f9bfc8aTimo Sirainen struct mail_storage storage;
b9f564d00b7a115f465ffd6840341c7b8f9bfc8aTimo Sirainen struct dbox_storage_vfuncs v;
b9f564d00b7a115f465ffd6840341c7b8f9bfc8aTimo Sirainen
b9f564d00b7a115f465ffd6840341c7b8f9bfc8aTimo Sirainen struct fs *attachment_fs;
de62ce819d59a529530da4b57be1b8d6dad13d6bTimo Sirainen const char *attachment_dir;
b9f564d00b7a115f465ffd6840341c7b8f9bfc8aTimo Sirainen};
b9f564d00b7a115f465ffd6840341c7b8f9bfc8aTimo Sirainen
c59b9c273b41f7bcf51f6803110b67813879ff05Timo Sirainen#define DBOX_STORAGE(s) container_of(s, struct dbox_storage, storage)
c59b9c273b41f7bcf51f6803110b67813879ff05Timo Sirainen
c59b9c273b41f7bcf51f6803110b67813879ff05Timo Sirainenvoid dbox_storage_get_list_settings(const struct mail_namespace *ns,
c59b9c273b41f7bcf51f6803110b67813879ff05Timo Sirainen struct mailbox_list_settings *set);
c59b9c273b41f7bcf51f6803110b67813879ff05Timo Sirainenint dbox_storage_create(struct mail_storage *storage,
b9f564d00b7a115f465ffd6840341c7b8f9bfc8aTimo Sirainen struct mail_namespace *ns,
b9f564d00b7a115f465ffd6840341c7b8f9bfc8aTimo Sirainen const char **error_r);
b9f564d00b7a115f465ffd6840341c7b8f9bfc8aTimo Sirainenvoid dbox_storage_destroy(struct mail_storage *storage);
b9f564d00b7a115f465ffd6840341c7b8f9bfc8aTimo Sirainenuint32_t dbox_get_uidvalidity_next(struct mailbox_list *list);
b9f564d00b7a115f465ffd6840341c7b8f9bfc8aTimo Sirainenvoid dbox_notify_changes(struct mailbox *box);
b9f564d00b7a115f465ffd6840341c7b8f9bfc8aTimo Sirainenint dbox_mailbox_check_existence(struct mailbox *box, time_t *path_ctime_r);
b9f564d00b7a115f465ffd6840341c7b8f9bfc8aTimo Sirainenint dbox_mailbox_open(struct mailbox *box, time_t path_ctime);
c59b9c273b41f7bcf51f6803110b67813879ff05Timo Sirainenint dbox_mailbox_create(struct mailbox *box,
c59b9c273b41f7bcf51f6803110b67813879ff05Timo Sirainen const struct mailbox_update *update, bool directory);
b9f564d00b7a115f465ffd6840341c7b8f9bfc8aTimo Sirainenint dbox_mailbox_create_indexes(struct mailbox *box,
b9f564d00b7a115f465ffd6840341c7b8f9bfc8aTimo Sirainen const struct mailbox_update *update);
b9f564d00b7a115f465ffd6840341c7b8f9bfc8aTimo Sirainenint dbox_verify_alt_storage(struct mailbox_list *list);
b9f564d00b7a115f465ffd6840341c7b8f9bfc8aTimo Sirainenbool dbox_header_have_flag(struct mailbox *box, uint32_t ext_id,
b9f564d00b7a115f465ffd6840341c7b8f9bfc8aTimo Sirainen unsigned int flags_offset, uint8_t flag);
e8762c2b4914db7997fa9eb644a91586952d1876Timo Sirainen
e8762c2b4914db7997fa9eb644a91586952d1876Timo Sirainen#endif
e8762c2b4914db7997fa9eb644a91586952d1876Timo Sirainen