lib-storage: rename get_real_mail to get_backend_mail

Also change the function signature so that it returns an int to indicate
success or failure.

diff --git a/src/lib-storage/fail-mail.c b/src/lib-storage/fail-mail.c
index 7e4d9f5cc60917aa400d1e24ce37e2c60124d924..6ac4c9b5e69118e6ed3ab7c736a26a5e7cda7b4f 100644 (file)
--- a/src/lib-storage/fail-mail.c
+++ b/src/lib-storage/fail-mail.c
@@ -194,9 +194,11 @@ fail_mail_get_special(struct mail *mail ATTR_UNUSED,
        return -1;
 }
 
-static struct mail * fail_mail_get_real_mail(struct mail *mail)
+static int fail_mail_get_backend_mail(struct mail *mail,
+                                     struct mail **real_mail_r)
 {
-       return mail;
+       *real_mail_r = mail;
+       return 0;
 }
 
 static void
@@ -256,7 +258,7 @@ struct mail_vfuncs fail_mail_vfuncs = {
        fail_mail_get_stream,
        fail_mail_get_binary_stream,
        fail_mail_get_special,
-       fail_mail_get_real_mail,
+       fail_mail_get_backend_mail,
        fail_mail_update_flags,
        fail_mail_update_keywords,
        fail_mail_update_modseq,

diff --git a/src/lib-storage/index/cydir/cydir-mail.c b/src/lib-storage/index/cydir/cydir-mail.c
index 3c3604272f958d614b4c3be3676cd29f32349659..4b62ac405a4db35711be4de7b7136901220f58c9 100644 (file)
--- a/src/lib-storage/index/cydir/cydir-mail.c
+++ b/src/lib-storage/index/cydir/cydir-mail.c
@@ -157,7 +157,7 @@ struct mail_vfuncs cydir_mail_vfuncs = {
        cydir_mail_get_stream,
        index_mail_get_binary_stream,
        index_mail_get_special,
-       index_mail_get_real_mail,
+       index_mail_get_backend_mail,
        index_mail_update_flags,
        index_mail_update_keywords,
        index_mail_update_modseq,

diff --git a/src/lib-storage/index/dbox-multi/mdbox-mail.c b/src/lib-storage/index/dbox-multi/mdbox-mail.c
index 8608a02ed758369464a98c7336235e91c22bcafc..b36e3828a69f4238f25e35f198e88a7ecb292515 100644 (file)
--- a/src/lib-storage/index/dbox-multi/mdbox-mail.c
+++ b/src/lib-storage/index/dbox-multi/mdbox-mail.c
@@ -253,7 +253,7 @@ struct mail_vfuncs mdbox_mail_vfuncs = {
        dbox_mail_get_stream,
        index_mail_get_binary_stream,
        mdbox_mail_get_special,
-       index_mail_get_real_mail,
+       index_mail_get_backend_mail,
        mdbox_mail_update_flags,
        index_mail_update_keywords,
        index_mail_update_modseq,

diff --git a/src/lib-storage/index/dbox-single/sdbox-mail.c b/src/lib-storage/index/dbox-single/sdbox-mail.c
index 4f848f8b69fe4d1b418b573075ccfe7d82c45502..90c5334d738839075d8c071cbf382189275623ee 100644 (file)
--- a/src/lib-storage/index/dbox-single/sdbox-mail.c
+++ b/src/lib-storage/index/dbox-single/sdbox-mail.c
@@ -162,7 +162,7 @@ struct mail_vfuncs sdbox_mail_vfuncs = {
        dbox_mail_get_stream,
        index_mail_get_binary_stream,
        sdbox_mail_get_special,
-       index_mail_get_real_mail,
+       index_mail_get_backend_mail,
        index_mail_update_flags,
        index_mail_update_keywords,
        index_mail_update_modseq,

diff --git a/src/lib-storage/index/imapc/imapc-mail.c b/src/lib-storage/index/imapc/imapc-mail.c
index a39d02f039a96597240529c5aaa193656d9db1b9..c29777cafeb577c23b817f08dd7304275179eed9 100644 (file)
--- a/src/lib-storage/index/imapc/imapc-mail.c
+++ b/src/lib-storage/index/imapc/imapc-mail.c
@@ -603,7 +603,7 @@ struct mail_vfuncs imapc_mail_vfuncs = {
        imapc_mail_get_stream,
        index_mail_get_binary_stream,
        imapc_mail_get_special,
-       index_mail_get_real_mail,
+       index_mail_get_backend_mail,
        index_mail_update_flags,
        index_mail_update_keywords,
        index_mail_update_modseq,

diff --git a/src/lib-storage/index/index-mail.c b/src/lib-storage/index/index-mail.c
index 6eb9a1f322d57eb48f26037882f05c014be5d25f..3c5a542ca49a01487e9eb81db9aa2d02e623048a 100644 (file)
--- a/src/lib-storage/index/index-mail.c
+++ b/src/lib-storage/index/index-mail.c
@@ -1459,9 +1459,11 @@ int index_mail_get_special(struct mail *_mail,
        }
 }
 
-struct mail *index_mail_get_real_mail(struct mail *mail)
+int index_mail_get_backend_mail(struct mail *mail,
+                               struct mail **real_mail_r)
 {
-       return mail;
+       *real_mail_r = mail;
+       return 0;
 }
 
 struct mail *

diff --git a/src/lib-storage/index/index-mail.h b/src/lib-storage/index/index-mail.h
index 8a9c177a7aebadaef23c1d9cbb1db9bd0f34b14f..7daf60837df09fc6901731aee3b1cbee135daa22 100644 (file)
--- a/src/lib-storage/index/index-mail.h
+++ b/src/lib-storage/index/index-mail.h
@@ -225,7 +225,7 @@ int index_mail_get_binary_stream(struct mail *_mail,
                                 struct istream **stream_r);
 int index_mail_get_special(struct mail *_mail, enum mail_fetch_field field,
                           const char **value_r);
-struct mail *index_mail_get_real_mail(struct mail *mail);
+int index_mail_get_backend_mail(struct mail *mail, struct mail **real_mail_r);
 
 void index_mail_update_flags(struct mail *mail, enum modify_type modify_type,
                             enum mail_flags flags);

diff --git a/src/lib-storage/index/maildir/maildir-mail.c b/src/lib-storage/index/maildir/maildir-mail.c
index 7dc5e3ec00351f31579e07761a6bacbeb0791f07..f968504ab0a6c1ba8f54091bf8800f0149058868 100644 (file)
--- a/src/lib-storage/index/maildir/maildir-mail.c
+++ b/src/lib-storage/index/maildir/maildir-mail.c
@@ -792,7 +792,7 @@ struct mail_vfuncs maildir_mail_vfuncs = {
        maildir_mail_get_stream,
        index_mail_get_binary_stream,
        maildir_mail_get_special,
-       index_mail_get_real_mail,
+       index_mail_get_backend_mail,
        index_mail_update_flags,
        index_mail_update_keywords,
        index_mail_update_modseq,

diff --git a/src/lib-storage/index/mbox/mbox-mail.c b/src/lib-storage/index/mbox/mbox-mail.c
index 946b94d70973437ef723d38b8a8bda5354166164..a3606f442bba467e83b7e5ebdedbefe5bb5f1bad 100644 (file)
--- a/src/lib-storage/index/mbox/mbox-mail.c
+++ b/src/lib-storage/index/mbox/mbox-mail.c
@@ -438,7 +438,7 @@ struct mail_vfuncs mbox_mail_vfuncs = {
        mbox_mail_get_stream,
        index_mail_get_binary_stream,
        mbox_mail_get_special,
-       index_mail_get_real_mail,
+       index_mail_get_backend_mail,
        index_mail_update_flags,
        index_mail_update_keywords,
        index_mail_update_modseq,

diff --git a/src/lib-storage/index/pop3c/pop3c-mail.c b/src/lib-storage/index/pop3c/pop3c-mail.c
index 7db2c36329032071579c8d228ac5c1608cb60b3c..388584a0d6c40d9535d4f99469d69da5ab3204f5 100644 (file)
--- a/src/lib-storage/index/pop3c/pop3c-mail.c
+++ b/src/lib-storage/index/pop3c/pop3c-mail.c
@@ -294,7 +294,7 @@ struct mail_vfuncs pop3c_mail_vfuncs = {
        pop3c_mail_get_stream,
        index_mail_get_binary_stream,
        pop3c_mail_get_special,
-       index_mail_get_real_mail,
+       index_mail_get_backend_mail,
        index_mail_update_flags,
        index_mail_update_keywords,
        index_mail_update_modseq,

diff --git a/src/lib-storage/index/raw/raw-mail.c b/src/lib-storage/index/raw/raw-mail.c
index dacf3ab79213b890f1c4511738d72505d8055302..5126839565177f99ba21f6ca4716b5af69df909a 100644 (file)
--- a/src/lib-storage/index/raw/raw-mail.c
+++ b/src/lib-storage/index/raw/raw-mail.c
@@ -141,7 +141,7 @@ struct mail_vfuncs raw_mail_vfuncs = {
        raw_mail_get_stream,
        index_mail_get_binary_stream,
        raw_mail_get_special,
-       index_mail_get_real_mail,
+       index_mail_get_backend_mail,
        index_mail_update_flags,
        index_mail_update_keywords,
        index_mail_update_modseq,

diff --git a/src/lib-storage/mail-storage-private.h b/src/lib-storage/mail-storage-private.h
index 44305a064e26fbccee6ebc0d450ce152fb601980..c9a3261c14f7ef5f58c4c7d115fdaffcead4d30d 100644 (file)
--- a/src/lib-storage/mail-storage-private.h
+++ b/src/lib-storage/mail-storage-private.h
@@ -461,10 +461,7 @@ struct mail_vfuncs {
 
        int (*get_special)(struct mail *mail, enum mail_fetch_field field,
                           const char **value_r);
-       /* FIXME: v2.3 API should change this to return -1 on failure.
-          for now NULL means failure so we don't break backwards
-          compatibility. */
-       struct mail *(*get_real_mail)(struct mail *mail);
+       int (*get_backend_mail)(struct mail *mail, struct mail **real_mail_r);
 
        void (*update_flags)(struct mail *mail, enum modify_type modify_type,
                             enum mail_flags flags);

diff --git a/src/lib-storage/mail-storage.h b/src/lib-storage/mail-storage.h
index 06cbaeadce86713ea06c180b70659bd333f1ce82..f5c2dbaaefecb42197d2c50113ed689c22b29f7e 100644 (file)
--- a/src/lib-storage/mail-storage.h
+++ b/src/lib-storage/mail-storage.h
@@ -889,9 +889,6 @@ int mail_get_special(struct mail *mail, enum mail_fetch_field field,
 /* Returns the mail for the physical message. Normally this is the mail itself,
    but in virtual mailboxes it points to the backend mailbox. */
 int mail_get_backend_mail(struct mail *mail, struct mail **real_mail_r);
-/* FIXME: For backwards compatibility for now, use mail_get_backend_mail()
-   instead. */
-struct mail *mail_get_real_mail(struct mail *mail);
 
 /* Update message flags. */
 void mail_update_flags(struct mail *mail, enum modify_type modify_type,

diff --git a/src/lib-storage/mail.c b/src/lib-storage/mail.c
index 8c41a83a36b4973824d45da32655165c5cba0a8a..903feade58b6377e941b35a92ade9681894f6334 100644 (file)
--- a/src/lib-storage/mail.c
+++ b/src/lib-storage/mail.c
@@ -342,20 +342,7 @@ int mail_get_special(struct mail *mail, enum mail_fetch_field field,
 int mail_get_backend_mail(struct mail *mail, struct mail **real_mail_r)
 {
        struct mail_private *p = (struct mail_private *)mail;
-
-       *real_mail_r = p->v.get_real_mail(mail);
-       return *real_mail_r == NULL ? -1 : 0;
-}
-
-struct mail *mail_get_real_mail(struct mail *mail)
-{
-       struct mail *backend_mail;
-
-       if (mail_get_backend_mail(mail, &backend_mail) < 0) {
-               i_panic("FIXME: Error occurred in mail_get_real_mail(), "
-                       "switch to using mail_get_backend_mail() instead");
-       }
-       return backend_mail;
+       return p->v.get_backend_mail(mail, real_mail_r);
 }
 
 void mail_update_flags(struct mail *mail, enum modify_type modify_type,

diff --git a/src/plugins/virtual/virtual-mail.c b/src/plugins/virtual/virtual-mail.c
index 21e7519091352c97e21445d5a3895d273f8706e8..36aa9bcfde6c326cad781c755b8561666742dbd2 100644 (file)
--- a/src/plugins/virtual/virtual-mail.c
+++ b/src/plugins/virtual/virtual-mail.c
@@ -450,17 +450,18 @@ virtual_mail_get_special(struct mail *mail, enum mail_fetch_field field,
        return 0;
 }
 
-static struct mail *virtual_mail_get_real_mail(struct mail *mail)
+static int virtual_mail_get_backend_mail(struct mail *mail,
+                                        struct mail **real_mail_r)
 {
        struct virtual_mail *vmail = (struct virtual_mail *)mail;
-       struct mail *backend_mail, *real_mail;
+       struct mail *backend_mail;
 
        if (backend_mail_get(vmail, &backend_mail) < 0)
-               return NULL;
+               return -1;
 
-       if (mail_get_backend_mail(backend_mail, &real_mail) < 0)
-               return NULL;
-       return real_mail;
+       if (mail_get_backend_mail(backend_mail, real_mail_r) < 0)
+               return -1;
+       return 0;
 }
 
 static void virtual_mail_update_pop3_uidl(struct mail *mail, const char *uidl)
@@ -523,7 +524,7 @@ struct mail_vfuncs virtual_mail_vfuncs = {
        virtual_mail_get_stream,
        index_mail_get_binary_stream,
        virtual_mail_get_special,
-       virtual_mail_get_real_mail,
+       virtual_mail_get_backend_mail,
        index_mail_update_flags,
        index_mail_update_keywords,
        index_mail_update_modseq,