From 349006bff8c4956ea0b2678882a6d0e6c5e4b280 Mon Sep 17 00:00:00 2001 From: Austin Clements Date: Wed, 30 Jul 2014 12:48:11 +2000 Subject: [PATCH] [PATCH v2 13/14] lib: Return an error from operations that require an upgrade --- 9a/98eb37d24cbf3f59551f5bbb813960941a58f2 | 218 ++++++++++++++++++++++ 1 file changed, 218 insertions(+) create mode 100644 9a/98eb37d24cbf3f59551f5bbb813960941a58f2 diff --git a/9a/98eb37d24cbf3f59551f5bbb813960941a58f2 b/9a/98eb37d24cbf3f59551f5bbb813960941a58f2 new file mode 100644 index 000000000..7a285daa9 --- /dev/null +++ b/9a/98eb37d24cbf3f59551f5bbb813960941a58f2 @@ -0,0 +1,218 @@ +Return-Path: +X-Original-To: notmuch@notmuchmail.org +Delivered-To: notmuch@notmuchmail.org +Received: from localhost (localhost [127.0.0.1]) + by olra.theworths.org (Postfix) with ESMTP id 109F8429E27 + for ; Tue, 29 Jul 2014 09:48:54 -0700 (PDT) +X-Virus-Scanned: Debian amavisd-new at olra.theworths.org +X-Spam-Flag: NO +X-Spam-Score: -2.3 +X-Spam-Level: +X-Spam-Status: No, score=-2.3 tagged_above=-999 required=5 + tests=[RCVD_IN_DNSWL_MED=-2.3] autolearn=disabled +Received: from olra.theworths.org ([127.0.0.1]) + by localhost (olra.theworths.org [127.0.0.1]) (amavisd-new, port 10024) + with ESMTP id 6wi0IWg979Eh for ; + Tue, 29 Jul 2014 09:48:47 -0700 (PDT) +Received: from dmz-mailsec-scanner-5.mit.edu (dmz-mailsec-scanner-5.mit.edu + [18.7.68.34]) + by olra.theworths.org (Postfix) with ESMTP id 7872F431FCF + for ; Tue, 29 Jul 2014 09:48:22 -0700 (PDT) +X-AuditID: 12074422-f79be6d000007518-ed-53d7d05395ff +Received: from mailhub-auth-3.mit.edu ( [18.9.21.43]) + (using TLS with cipher AES256-SHA (256/256 bits)) + (Client did not present a certificate) + by dmz-mailsec-scanner-5.mit.edu (Symantec Messaging Gateway) with SMTP + id C7.02.29976.350D7D35; Tue, 29 Jul 2014 12:48:19 -0400 (EDT) +Received: from outgoing.mit.edu (outgoing-auth-1.mit.edu [18.9.28.11]) + by mailhub-auth-3.mit.edu (8.13.8/8.9.2) with ESMTP id s6TGmI6r030917; + Tue, 29 Jul 2014 12:48:18 -0400 +Received: from drake.dyndns.org (31-33-71.wireless.csail.mit.edu + [128.31.33.71]) (authenticated bits=0) + (User authenticated as amdragon@ATHENA.MIT.EDU) + by outgoing.mit.edu (8.13.8/8.12.4) with ESMTP id s6TGmFRk030274 + (version=TLSv1/SSLv3 cipher=AES256-SHA bits=256 verify=NOT); + Tue, 29 Jul 2014 12:48:17 -0400 +Received: from amthrax by drake.dyndns.org with local (Exim 4.77) + (envelope-from ) + id 1XCAZT-0007HB-1I; Tue, 29 Jul 2014 12:48:15 -0400 +From: Austin Clements +To: notmuch@notmuchmail.org +Subject: [PATCH v2 13/14] lib: Return an error from operations that require an + upgrade +Date: Tue, 29 Jul 2014 12:48:11 -0400 +Message-Id: <1406652492-27803-14-git-send-email-amdragon@mit.edu> +X-Mailer: git-send-email 2.0.0 +In-Reply-To: <1406652492-27803-1-git-send-email-amdragon@mit.edu> +References: <1406652492-27803-1-git-send-email-amdragon@mit.edu> +X-Brightmail-Tracker: + H4sIAAAAAAAAA+NgFtrDIsWRmVeSWpSXmKPExsUixCmqrRt84XqwwZa96har5/JYXL85k9mB + yWPnrLvsHs9W3WIOYIrisklJzcksSy3St0vgyrh94zJzwQ3tiv6unawNjM0qXYycHBICJhL7 + JtxkhrDFJC7cW8/WxcjFISQwm0liwop+NpCEkMBGRon2GZIQiWNMEr+PTmOGcOYySszd084I + UsUmoCGxbf9yMFtEQFpi593ZrCA2s4CjxOf9i8AmCQuESUy9/AmshkVAVeLE8XksIDYvUE3b + y2YWiDPkJBpufAKr5wSK37p3lwniCgeJQ7M2s0xg5F/AyLCKUTYlt0o3NzEzpzg1Wbc4OTEv + L7VI11QvN7NELzWldBMjKJDYXZR2MP48qHSIUYCDUYmHd8Pca8FCrIllxZW5hxglOZiURHn1 + 9l0PFuJLyk+pzEgszogvKs1JLT7EKMHBrCTCy3cWKMebklhZlVqUD5OS5mBREud9a20VLCSQ + nliSmp2aWpBaBJOV4eBQkuA1Og/UKFiUmp5akZaZU4KQZuLgBBnOAzS8GaSGt7ggMbc4Mx0i + f4pRUUqcN/scUEIAJJFRmgfXC4v0V4ziQK8I87aBtPMAkwRc9yugwUxAg1ldwAaXJCKkpBoY + S78sOBr4WFjlydsDCdOlj06cc33++l5v+4RF7HnTFDY+67xzMoZRaNLS1XcVnF8GWDKt/Vze + vHde/LW+B25FkmeskyqEF8y/33w7Z8klm0N2nQrb2lI4uN3eH9yY8W/ajeCpm2q219aUJX9S + tU66tWjmjP1ec0UUJ6tcsnefZHvZxmLuhovsl5VYijMSDbWYi4oTAT5BzPHPAgAA +X-BeenThere: notmuch@notmuchmail.org +X-Mailman-Version: 2.1.13 +Precedence: list +List-Id: "Use and development of the notmuch mail system." + +List-Unsubscribe: , + +List-Archive: +List-Post: +List-Help: +List-Subscribe: , + +X-List-Received-Date: Tue, 29 Jul 2014 16:48:54 -0000 + +Previously, there was no protection against a caller invoking an +operation on an old database version that would effectively corrupt +the database by treating it like a newer version. + +According to notmuch.h, any caller that opens the database in +read/write mode is supposed to check if the database needs upgrading +and perform an upgrade if it does. This would protect against this, +but nobody (even the CLI) actually does this. + +However, with features, it's easy to protect against incompatible +operations on a fine-grained basis. This lightweight change allows +callers to safely operate on old database versions, while preventing +specific operations that would corrupt the database with an +informative error message. +--- + lib/database.cc | 5 +++++ + lib/directory.cc | 5 +++++ + lib/message.cc | 8 ++++++++ + lib/notmuch.h | 16 ++++++++++++++++ + 4 files changed, 34 insertions(+) + +diff --git a/lib/database.cc b/lib/database.cc +index 987b0a6..b323691 100644 +--- a/lib/database.cc ++++ b/lib/database.cc +@@ -310,6 +310,8 @@ notmuch_status_to_string (notmuch_status_t status) + return "Unbalanced number of calls to notmuch_database_begin_atomic/end_atomic"; + case NOTMUCH_STATUS_UNSUPPORTED_OPERATION: + return "Unsupported operation"; ++ case NOTMUCH_STATUS_UPGRADE_REQUIRED: ++ return "Operation requires a database upgrade"; + default: + case NOTMUCH_STATUS_LAST_STATUS: + return "Unknown error status value"; +@@ -2217,6 +2219,9 @@ notmuch_database_find_message_by_filename (notmuch_database_t *notmuch, + if (message_ret == NULL) + return NOTMUCH_STATUS_NULL_POINTER; + ++ if (! (notmuch->features & NOTMUCH_FEATURE_FILE_TERMS)) ++ return NOTMUCH_STATUS_UPGRADE_REQUIRED; ++ + /* return NULL on any failure */ + *message_ret = NULL; + +diff --git a/lib/directory.cc b/lib/directory.cc +index 6a3ffed..8daaec8 100644 +--- a/lib/directory.cc ++++ b/lib/directory.cc +@@ -105,6 +105,11 @@ _notmuch_directory_create (notmuch_database_t *notmuch, + const char *db_path; + notmuch_bool_t create = (flags & NOTMUCH_FIND_CREATE); + ++ if (! (notmuch->features & NOTMUCH_FEATURE_DIRECTORY_DOCS)) { ++ *status_ret = NOTMUCH_STATUS_UPGRADE_REQUIRED; ++ return NULL; ++ } ++ + *status_ret = NOTMUCH_STATUS_SUCCESS; + + path = _notmuch_database_relative_path (notmuch, path); +diff --git a/lib/message.cc b/lib/message.cc +index 4fc427f..1618e81 100644 +--- a/lib/message.cc ++++ b/lib/message.cc +@@ -653,6 +653,10 @@ _notmuch_message_add_filename (notmuch_message_t *message, + if (filename == NULL) + INTERNAL_ERROR ("Message filename cannot be NULL."); + ++ if (! (message->notmuch->features & NOTMUCH_FEATURE_FILE_TERMS) || ++ ! (message->notmuch->features & NOTMUCH_FEATURE_BOOL_FOLDER)) ++ return NOTMUCH_STATUS_UPGRADE_REQUIRED; ++ + relative = _notmuch_database_relative_path (message->notmuch, filename); + + status = _notmuch_database_split_path (local, relative, &directory, NULL); +@@ -697,6 +701,10 @@ _notmuch_message_remove_filename (notmuch_message_t *message, + notmuch_private_status_t private_status; + notmuch_status_t status; + ++ if (! (message->notmuch->features & NOTMUCH_FEATURE_FILE_TERMS) || ++ ! (message->notmuch->features & NOTMUCH_FEATURE_BOOL_FOLDER)) ++ return NOTMUCH_STATUS_UPGRADE_REQUIRED; ++ + status = _notmuch_database_filename_to_direntry ( + local, message->notmuch, filename, NOTMUCH_FIND_LOOKUP, &direntry); + if (status || !direntry) +diff --git a/lib/notmuch.h b/lib/notmuch.h +index 3c5ec98..cbf2ba5 100644 +--- a/lib/notmuch.h ++++ b/lib/notmuch.h +@@ -160,6 +160,10 @@ typedef enum _notmuch_status { + */ + NOTMUCH_STATUS_UNSUPPORTED_OPERATION, + /** ++ * The operation requires a database upgrade. ++ */ ++ NOTMUCH_STATUS_UPGRADE_REQUIRED, ++ /** + * Not an actual status value. Just a way to find out how many + * valid status values there are. + */ +@@ -438,6 +442,9 @@ notmuch_database_end_atomic (notmuch_database_t *notmuch); + * + * NOTMUCH_STATUS_XAPIAN_EXCEPTION: A Xapian exception occurred; + * directory not retrieved. ++ * ++ * NOTMUCH_STATUS_UPGRADE_REQUIRED: The caller must upgrade the ++ * database to use this function. + */ + notmuch_status_t + notmuch_database_get_directory (notmuch_database_t *database, +@@ -490,6 +497,9 @@ notmuch_database_get_directory (notmuch_database_t *database, + * + * NOTMUCH_STATUS_READ_ONLY_DATABASE: Database was opened in read-only + * mode so no message can be added. ++ * ++ * NOTMUCH_STATUS_UPGRADE_REQUIRED: The caller must upgrade the ++ * database to use this function. + */ + notmuch_status_t + notmuch_database_add_message (notmuch_database_t *database, +@@ -520,6 +530,9 @@ notmuch_database_add_message (notmuch_database_t *database, + * + * NOTMUCH_STATUS_READ_ONLY_DATABASE: Database was opened in read-only + * mode so no message can be removed. ++ * ++ * NOTMUCH_STATUS_UPGRADE_REQUIRED: The caller must upgrade the ++ * database to use this function. + */ + notmuch_status_t + notmuch_database_remove_message (notmuch_database_t *database, +@@ -575,6 +588,9 @@ notmuch_database_find_message (notmuch_database_t *database, + * NOTMUCH_STATUS_OUT_OF_MEMORY: Out of memory, creating the message object + * + * NOTMUCH_STATUS_XAPIAN_EXCEPTION: A Xapian exception occurred ++ * ++ * NOTMUCH_STATUS_UPGRADE_REQUIRED: The caller must upgrade the ++ * database to use this function. + */ + notmuch_status_t + notmuch_database_find_message_by_filename (notmuch_database_t *notmuch, +-- +2.0.0 + -- 2.26.2