]> git.ipfire.org Git - thirdparty/dovecot/core.git/commitdiff
lib-imap-storage: Rename error_r sent to clients as client_error_r
authorMartti Rannanjärvi <martti.rannanjarvi@open-xchange.com>
Mon, 21 Jan 2019 10:59:45 +0000 (12:59 +0200)
committerVille Savolainen <ville.savolainen@dovecot.fi>
Thu, 21 Mar 2019 08:02:38 +0000 (10:02 +0200)
src/lib-imap-storage/imap-metadata.c
src/lib-imap-storage/imap-metadata.h
src/lib-imap-storage/imap-msgpart-url.c
src/lib-imap-storage/imap-msgpart-url.h

index 34025aa4913c4f80937ce74a32abd4b69c9c10aa..6b16138950339d8d0b7ece91d0a6cf1bbb0a4677 100644 (file)
@@ -15,36 +15,37 @@ struct imap_metadata_transaction {
        bool server:1;
 };
 
-bool imap_metadata_verify_entry_name(const char *name, const char **error_r)
+bool imap_metadata_verify_entry_name(const char *name,
+                                    const char **client_error_r)
 {
        unsigned int i;
        bool ok;
 
        if (name[0] != '/') {
-               *error_r = "Entry name must begin with '/'";
+               *client_error_r = "Entry name must begin with '/'";
                return FALSE;
        }
        for (i = 0; name[i] != '\0'; i++) {
                switch (name[i]) {
                case '/':
                        if (i > 0 && name[i-1] == '/') {
-                               *error_r = "Entry name can't contain consecutive '/'";
+                               *client_error_r = "Entry name can't contain consecutive '/'";
                                return FALSE;
                        }
                        if (name[i+1] == '\0') {
-                               *error_r = "Entry name can't end with '/'";
+                               *client_error_r = "Entry name can't end with '/'";
                                return FALSE;
                        }
                        break;
                case '*':
-                       *error_r = "Entry name can't contain '*'";
+                       *client_error_r = "Entry name can't contain '*'";
                        return FALSE;
                case '%':
-                       *error_r = "Entry name can't contain '%'";
+                       *client_error_r = "Entry name can't contain '%'";
                        return FALSE;
                default:
                        if (name[i] <= 0x19) {
-                               *error_r = "Entry name can't contain control chars";
+                               *client_error_r = "Entry name can't contain control chars";
                                return FALSE;
                        }
                        break;
@@ -58,7 +59,7 @@ bool imap_metadata_verify_entry_name(const char *name, const char **error_r)
                        strcasecmp(prefix, IMAP_METADATA_SHARED_PREFIX) == 0;
        } T_END;
        if (!ok) {
-               *error_r = "Entry name must begin with /private or /shared";
+               *client_error_r = "Entry name must begin with /private or /shared";
                return FALSE;
        }
        return TRUE;
@@ -259,7 +260,7 @@ imap_metadata_transaction_finish(struct imap_metadata_transaction **_imtrans)
 
 int imap_metadata_transaction_commit(
        struct imap_metadata_transaction **_imtrans,
-       enum mail_error *error_code_r, const char **error_r)
+       enum mail_error *error_code_r, const char **client_error_r)
 {
        struct imap_metadata_transaction *imtrans = *_imtrans;
        int ret = 0;
@@ -269,8 +270,8 @@ int imap_metadata_transaction_commit(
                ret = mailbox_transaction_commit(&imtrans->trans);
                if (ret < 0)
                        error = mailbox_get_last_error(imtrans->box, error_code_r);
-               if (error_r != NULL)
-                       *error_r = error;
+               if (client_error_r != NULL)
+                       *client_error_r = error;
        }
        imap_metadata_transaction_finish(_imtrans);
        return ret;
index 9213a07fbf7d1a214cdd862ec05765317564fd50..3de23b98ac1339237fce254d4824118a6ae22ff6 100644 (file)
@@ -9,7 +9,7 @@ struct imap_metadata_transaction;
 
 /* Checks whether IMAP metadata entry name is valid */
 bool imap_metadata_verify_entry_name(
-       const char *name, const char **error_r);
+       const char *name, const char **client_error_r);
 
 /* Set IMAP metadata entry to value. */
 int imap_metadata_set(struct imap_metadata_transaction *imtrans,
@@ -46,7 +46,7 @@ imap_metadata_transaction_begin_server(struct mail_user *user);
 
 int imap_metadata_transaction_commit(
        struct imap_metadata_transaction **_imtrans,
-       enum mail_error *error_code_r, const char **error_r);
+       enum mail_error *error_code_r, const char **client_error_r);
 void imap_metadata_transaction_rollback(
        struct imap_metadata_transaction **_imtrans);
 const char *
index a58350a791aa0beb6936f8ac08fe76eab401d929..d6c14721fcd2f25e8c95661e79566fcfc09ffb06 100644 (file)
@@ -32,7 +32,7 @@ struct imap_msgpart_url {
 
 int imap_msgpart_url_create(struct mail_user *user, const struct imap_url *url,
                            struct imap_msgpart_url **mpurl_r,
-                           const char **error_r)
+                           const char **client_error_r)
 {
        const char *section = url->section == NULL ? "" : url->section;
        struct imap_msgpart_url *mpurl;
@@ -40,11 +40,11 @@ int imap_msgpart_url_create(struct mail_user *user, const struct imap_url *url,
 
        if (url->mailbox == NULL || url->uid == 0 ||
            url->search_program != NULL) {
-               *error_r = "Invalid messagepart IMAP URL";
+               *client_error_r = "Invalid messagepart IMAP URL";
                return -1;
        }
        if (imap_msgpart_parse(section, &msgpart) < 0) {
-               *error_r = "Invalid section";
+               *client_error_r = "Invalid section";
                return -1;
        }
 
@@ -69,7 +69,7 @@ int imap_msgpart_url_create(struct mail_user *user, const struct imap_url *url,
 
 int imap_msgpart_url_parse(struct mail_user *user, struct mailbox *selected_box,
                           const char *urlstr, struct imap_msgpart_url **mpurl_r,
-                          const char **error_r)
+                          const char **client_error_r)
 {
        struct mailbox_status box_status;
        struct imap_url base_url, *url;
@@ -87,14 +87,14 @@ int imap_msgpart_url_parse(struct mail_user *user, struct mailbox *selected_box,
        /* parse url */
        if (imap_url_parse(urlstr, &base_url,
                           IMAP_URL_PARSE_REQUIRE_RELATIVE, &url, &error) < 0) {
-               *error_r = t_strconcat("Invalid IMAP URL: ", error, NULL);
+               *client_error_r = t_strconcat("Invalid IMAP URL: ", error, NULL);
                return 0;
        }
        if (url->mailbox == NULL) {
-               *error_r = "Mailbox-relative IMAP URL, but no mailbox selected";
+               *client_error_r = "Mailbox-relative IMAP URL, but no mailbox selected";
                return 0;
        }
-       if (imap_msgpart_url_create(user, url, mpurl_r, error_r) < 0)
+       if (imap_msgpart_url_create(user, url, mpurl_r, client_error_r) < 0)
                return -1;
        (*mpurl_r)->selected_box = selected_box;
        return 1;
@@ -107,7 +107,7 @@ struct mailbox *imap_msgpart_url_get_mailbox(struct imap_msgpart_url *mpurl)
 
 int imap_msgpart_url_open_mailbox(struct imap_msgpart_url *mpurl,
                                  struct mailbox **box_r, enum mail_error *error_code_r,
-                                 const char **error_r)
+                                 const char **client_error_r)
 {
        struct mailbox_status box_status;
        enum mailbox_flags flags = MAILBOX_FLAG_READONLY;
@@ -132,8 +132,8 @@ int imap_msgpart_url_open_mailbox(struct imap_msgpart_url *mpurl,
                mailbox_set_reason(box, "Read IMAP URL");
        }
        if (mailbox_open(box) < 0) {
-               *error_r = mail_storage_get_last_error(mailbox_get_storage(box),
-                                                      error_code_r);
+               *client_error_r = mail_storage_get_last_error(mailbox_get_storage(box),
+                                                             error_code_r);
                if (box != mpurl->selected_box)
                        mailbox_free(&box);
                return *error_code_r == MAIL_ERROR_TEMP ? -1 : 0;
@@ -143,7 +143,7 @@ int imap_msgpart_url_open_mailbox(struct imap_msgpart_url *mpurl,
        mailbox_get_open_status(box, STATUS_UIDVALIDITY, &box_status);
        if (mpurl->uidvalidity > 0 &&
            box_status.uidvalidity != mpurl->uidvalidity) {
-               *error_r = "Invalid UIDVALIDITY";
+               *client_error_r = "Invalid UIDVALIDITY";
                *error_code_r = MAIL_ERROR_EXPUNGED;
                if (box != mpurl->selected_box)
                        mailbox_free(&box);
@@ -155,7 +155,8 @@ int imap_msgpart_url_open_mailbox(struct imap_msgpart_url *mpurl,
 }
 
 int imap_msgpart_url_open_mail(struct imap_msgpart_url *mpurl,
-                              struct mail **mail_r, const char **error_r)
+                              struct mail **mail_r,
+                              const char **client_error_r)
 {
        struct mailbox_transaction_context *t;
        struct mailbox *box;
@@ -170,7 +171,7 @@ int imap_msgpart_url_open_mail(struct imap_msgpart_url *mpurl,
 
        /* open mailbox if it is not yet open */
        if ((ret = imap_msgpart_url_open_mailbox(mpurl, &box, &error_code,
-                                                error_r)) <= 0)
+                                                client_error_r)) <= 0)
                return ret;
 
        /* start transaction */
@@ -180,7 +181,7 @@ int imap_msgpart_url_open_mail(struct imap_msgpart_url *mpurl,
 
        /* find the message */
        if (!mail_set_uid(mail, mpurl->uid)) {
-               *error_r = "Message not found";
+               *client_error_r = "Message not found";
                mail_free(&mail);
                mailbox_transaction_rollback(&t);       
                return 0;
@@ -205,7 +206,7 @@ void imap_msgpart_url_set_decode_to_binary(struct imap_msgpart_url *mpurl)
 
 int imap_msgpart_url_read_part(struct imap_msgpart_url *mpurl,
                               struct imap_msgpart_open_result *result_r,
-                              const char **error_r)
+                              const char **client_error_r)
 {
        struct mail *mail;
        int ret;
@@ -217,14 +218,14 @@ int imap_msgpart_url_read_part(struct imap_msgpart_url *mpurl,
        }
 
        /* open mail if it is not yet open */
-       ret = imap_msgpart_url_open_mail(mpurl, &mail, error_r);
+       ret = imap_msgpart_url_open_mail(mpurl, &mail, client_error_r);
        if (ret <= 0)
                return ret;
 
        /* open the referenced part as a stream */
        ret = imap_msgpart_open(mail, mpurl->part, result_r);
        if (ret < 0) {
-               *error_r = mailbox_get_last_error(mpurl->box, NULL);
+               *client_error_r = mailbox_get_last_error(mpurl->box, NULL);
                return ret;
        }
 
@@ -233,7 +234,7 @@ int imap_msgpart_url_read_part(struct imap_msgpart_url *mpurl,
 }
 
 int imap_msgpart_url_verify(struct imap_msgpart_url *mpurl,
-                           const char **error_r)
+                           const char **client_error_r)
 {
        struct mail *mail;
        int ret;
@@ -242,27 +243,27 @@ int imap_msgpart_url_verify(struct imap_msgpart_url *mpurl,
                return 1;
 
        /* open mail if it is not yet open */
-       ret = imap_msgpart_url_open_mail(mpurl, &mail, error_r);
+       ret = imap_msgpart_url_open_mail(mpurl, &mail, client_error_r);
        return ret;
 }
 
 int imap_msgpart_url_get_bodypartstructure(struct imap_msgpart_url *mpurl,
                                           const char **bpstruct_r,
-                                          const char **error_r)
+                                          const char **client_error_r)
 {
        struct mail *mail;
        int ret;
 
        /* open mail if it is not yet open */
-       ret = imap_msgpart_url_open_mail(mpurl, &mail, error_r);
+       ret = imap_msgpart_url_open_mail(mpurl, &mail, client_error_r);
        if (ret <= 0)
                return ret;
 
        ret = imap_msgpart_bodypartstructure(mail, mpurl->part, bpstruct_r);
        if (ret < 0)
-               *error_r = mailbox_get_last_error(mpurl->box, NULL);
+               *client_error_r = mailbox_get_last_error(mpurl->box, NULL);
        else if (ret == 0)
-               *error_r = "Message part not found";
+               *client_error_r = "Message part not found";
        return ret;
 }
 
index 3f96adae97e9b89bd33b6b1e435f83801dec2df6..5bc72c2cb2d8bb0305da7f9a26c2f976e9ffb13e 100644 (file)
@@ -12,17 +12,18 @@ struct imap_msgpart_url;
 
 int imap_msgpart_url_create(struct mail_user *user, const struct imap_url *url,
                            struct imap_msgpart_url **url_r,
-                           const char **error_r);
+                           const char **client_error_r);
 int imap_msgpart_url_parse(struct mail_user *user, struct mailbox *selected_box,
                           const char *urlstr, struct imap_msgpart_url **url_r,
-                          const char **error_r);
+                          const char **client_error_r);
 
 int imap_msgpart_url_open_mailbox(struct imap_msgpart_url *mpurl,
                                  struct mailbox **box_r, enum mail_error *error_code_r,
-                                 const char **error_r);
+                                 const char **client_error_r);
 struct mailbox *imap_msgpart_url_get_mailbox(struct imap_msgpart_url *mpurl);
 int imap_msgpart_url_open_mail(struct imap_msgpart_url *mpurl,
-                              struct mail **mail_r, const char **error_r);
+                              struct mail **mail_r,
+                              const char **client_error_r);
 
 struct imap_msgpart *
 imap_msgpart_url_get_part(struct imap_msgpart_url *mpurl);
@@ -36,14 +37,14 @@ void imap_msgpart_url_set_decode_to_binary(struct imap_msgpart_url *mpurl);
    is larger than the size of the referenced part */
 int imap_msgpart_url_read_part(struct imap_msgpart_url *mpurl,
                               struct imap_msgpart_open_result *result_r,
-                              const char **error_r);
+                              const char **client_error_r);
 
 int imap_msgpart_url_get_bodypartstructure(struct imap_msgpart_url *mpurl,
                                           const char **bpstruct_r,
-                                          const char **error_r);
+                                          const char **client_error_r);
 
 int imap_msgpart_url_verify(struct imap_msgpart_url *mpurl,
-                           const char **error_r);
+                           const char **client_error_r);
 void imap_msgpart_url_free(struct imap_msgpart_url **mpurl);
 
 #endif