[WIP PATCH 3/4] lib: API to retrieve database revision and UUID
authorAustin Clements <aclements@csail.mit.edu>
Mon, 13 Oct 2014 06:20:02 +0000 (02:20 +2000)
committerW. Trevor King <wking@tremily.us>
Fri, 7 Nov 2014 18:05:14 +0000 (10:05 -0800)
64/97e1a3986b6a46c97a9aff7b712392fbe60342 [new file with mode: 0644]

diff --git a/64/97e1a3986b6a46c97a9aff7b712392fbe60342 b/64/97e1a3986b6a46c97a9aff7b712392fbe60342
new file mode 100644 (file)
index 0000000..fc5bdc2
--- /dev/null
@@ -0,0 +1,157 @@
+Return-Path: <aclements@csail.mit.edu>\r
+X-Original-To: notmuch@notmuchmail.org\r
+Delivered-To: notmuch@notmuchmail.org\r
+Received: from localhost (localhost [127.0.0.1])\r
+       by olra.theworths.org (Postfix) with ESMTP id 11A88431FC4\r
+       for <notmuch@notmuchmail.org>; Sun, 12 Oct 2014 23:20:23 -0700 (PDT)\r
+X-Virus-Scanned: Debian amavisd-new at olra.theworths.org\r
+X-Spam-Flag: NO\r
+X-Spam-Score: -2.3\r
+X-Spam-Level: \r
+X-Spam-Status: No, score=-2.3 tagged_above=-999 required=5\r
+       tests=[RCVD_IN_DNSWL_MED=-2.3] autolearn=disabled\r
+Received: from olra.theworths.org ([127.0.0.1])\r
+       by localhost (olra.theworths.org [127.0.0.1]) (amavisd-new, port 10024)\r
+       with ESMTP id CpgXZeBr3HDH for <notmuch@notmuchmail.org>;\r
+       Sun, 12 Oct 2014 23:20:17 -0700 (PDT)\r
+Received: from dmz-mailsec-scanner-8.mit.edu (dmz-mailsec-scanner-8.mit.edu\r
+       [18.7.68.37])\r
+       (using TLSv1 with cipher DHE-RSA-AES256-SHA (256/256 bits))\r
+       (No client certificate requested)\r
+       by olra.theworths.org (Postfix) with ESMTPS id 799C8431FB6\r
+       for <notmuch@notmuchmail.org>; Sun, 12 Oct 2014 23:20:13 -0700 (PDT)\r
+X-AuditID: 12074425-f79e46d000002583-64-543b6f1bf69b\r
+Received: from mailhub-auth-3.mit.edu ( [18.9.21.43])\r
+       (using TLS with cipher AES256-SHA (256/256 bits))\r
+       (Client did not present a certificate)\r
+       by dmz-mailsec-scanner-8.mit.edu (Symantec Messaging Gateway) with SMTP\r
+       id B0.94.09603.B1F6B345; Mon, 13 Oct 2014 02:20:11 -0400 (EDT)\r
+Received: from outgoing.mit.edu (outgoing-auth-1.mit.edu [18.9.28.11])\r
+       by mailhub-auth-3.mit.edu (8.13.8/8.9.2) with ESMTP id s9D6K8pR021370; \r
+       Mon, 13 Oct 2014 02:20:08 -0400\r
+Received: from drake.dyndns.org ([73.162.189.21]) (authenticated bits=0)\r
+       (User authenticated as amdragon@ATHENA.MIT.EDU)\r
+       by outgoing.mit.edu (8.13.8/8.12.4) with ESMTP id s9D6K58Q031971\r
+       (version=TLSv1/SSLv3 cipher=AES128-SHA bits=128 verify=NOT);\r
+       Mon, 13 Oct 2014 02:20:07 -0400\r
+Received: from amthrax by drake.dyndns.org with local (Exim 4.84)\r
+       (envelope-from <aclements@csail.mit.edu>)\r
+       id 1XdYzF-0000UG-AX; Mon, 13 Oct 2014 02:20:05 -0400\r
+From: Austin Clements <aclements@csail.mit.edu>\r
+To: notmuch@notmuchmail.org\r
+Subject: [WIP PATCH 3/4] lib: API to retrieve database revision and UUID\r
+Date: Mon, 13 Oct 2014 02:20:02 -0400\r
+Message-Id: <1413181203-1676-4-git-send-email-aclements@csail.mit.edu>\r
+X-Mailer: git-send-email 2.1.0\r
+In-Reply-To: <1413181203-1676-1-git-send-email-aclements@csail.mit.edu>\r
+References: <1413181203-1676-1-git-send-email-aclements@csail.mit.edu>\r
+X-Brightmail-Tracker:\r
+ H4sIAAAAAAAAA+NgFtrEIsWRmVeSWpSXmKPExsUixCmqrSudbx1i0LxW3OL6zZnMDowez1bd\r
+       Yg5gjOKySUnNySxLLdK3S+DK2LrhClPBDbGKFe9eMTUwzhLqYuTkkBAwkbj5ejkzhC0mceHe\r
+       erYuRi4OIYHZTBK/jl9hhHA2Mkp03N7OClIlJLCcSeLU/1KIxBJGiRuvNjKBJNgE9CVWrJ0E\r
+       ViQiIC2x8+5sIJuDg1lAV6K5XRkkLCzgIfFlZwcLiM0ioCpx8GwDO4jNK+Am0TJ9A9QVchIb\r
+       dv9nBLE5BdwlLk48ywyx103iWNs1lgmM/AsYGVYxyqbkVunmJmbmFKcm6xYnJ+blpRbpWujl\r
+       ZpbopaaUbmIEBQ27i+oOxgmHlA4xCnAwKvHwWvyxChFiTSwrrsw9xCjJwaQkyhuQZh0ixJeU\r
+       n1KZkVicEV9UmpNafIhRgoNZSYT3rQ1QjjclsbIqtSgfJiXNwaIkzrvpB1+IkEB6Yklqdmpq\r
+       QWoRTFaGg0NJgvdENlCjYFFqempFWmZOCUKaiYMTZDgP0HApkBre4oLE3OLMdIj8KUZFKXHe\r
+       q1lACQGQREZpHlwvLKpfMYoDvSLMGwjSzgNMCHDdr4AGMwENPtplDjK4JBEhJdXAuNzSssXr\r
+       yr7yQLf2qf94DQ+8u+OVp/Mquudx78J/7cpbPuvcVbX+WbT8IKtN+azDXzbIrLfnen7WYsOP\r
+       TZecX/ZHz/WZfHHpZptQhY8SR+Ysjz1yJNv48H0V/RM7NJe+/+sTLfOYYYfuV9mA/UVRf1M5\r
+       n+9UCrllfdsoiG1yWsv96bG5hxvlHJRYijMSDbWYi4oTAVlYbiLFAgAA\r
+Cc: Austin Clements <aclements@csail.mit.edu>\r
+X-BeenThere: notmuch@notmuchmail.org\r
+X-Mailman-Version: 2.1.13\r
+Precedence: list\r
+List-Id: "Use and development of the notmuch mail system."\r
+       <notmuch.notmuchmail.org>\r
+List-Unsubscribe: <http://notmuchmail.org/mailman/options/notmuch>,\r
+       <mailto:notmuch-request@notmuchmail.org?subject=unsubscribe>\r
+List-Archive: <http://notmuchmail.org/pipermail/notmuch>\r
+List-Post: <mailto:notmuch@notmuchmail.org>\r
+List-Help: <mailto:notmuch-request@notmuchmail.org?subject=help>\r
+List-Subscribe: <http://notmuchmail.org/mailman/listinfo/notmuch>,\r
+       <mailto:notmuch-request@notmuchmail.org?subject=subscribe>\r
+X-List-Received-Date: Mon, 13 Oct 2014 06:20:23 -0000\r
+\r
+This exposes the committed database revision to library users along\r
+with a UUID that can be used to detect when revision numbers are no\r
+longer comparable (e.g., because the database has been replaced).\r
+---\r
+ lib/database-private.h |  1 +\r
+ lib/database.cc        | 11 +++++++++++\r
+ lib/notmuch.h          | 18 ++++++++++++++++++\r
+ 3 files changed, 30 insertions(+)\r
+\r
+diff --git a/lib/database-private.h b/lib/database-private.h\r
+index 465065d..0977229 100644\r
+--- a/lib/database-private.h\r
++++ b/lib/database-private.h\r
+@@ -157,6 +157,7 @@ struct _notmuch_database {\r
+      * under a higher revision number, which can be generated with\r
+      * notmuch_database_new_revision. */\r
+     unsigned long revision;\r
++    const char *uuid;\r
\r
+     Xapian::QueryParser *query_parser;\r
+     Xapian::TermGenerator *term_gen;\r
+diff --git a/lib/database.cc b/lib/database.cc\r
+index 45d32ab..9bec170 100644\r
+--- a/lib/database.cc\r
++++ b/lib/database.cc\r
+@@ -905,6 +905,8 @@ notmuch_database_open (const char *path,\r
+           notmuch->revision = 0;\r
+       else\r
+           notmuch->revision = Xapian::sortable_unserialise (last_mod);\r
++      notmuch->uuid = talloc_strdup (\r
++          notmuch, notmuch->xapian_db->get_uuid ().c_str ());\r
\r
+       notmuch->query_parser = new Xapian::QueryParser;\r
+       notmuch->term_gen = new Xapian::TermGenerator;\r
+@@ -1562,6 +1564,15 @@ DONE:\r
+     return NOTMUCH_STATUS_SUCCESS;\r
+ }\r
\r
++unsigned long\r
++notmuch_database_get_revisison (notmuch_database_t *notmuch,\r
++                              const char **uuid)\r
++{\r
++    if (*uuid)\r
++      *uuid = notmuch->uuid;\r
++    return notmuch->revision;\r
++}\r
++\r
+ /* We allow the user to use arbitrarily long paths for directories. But\r
+  * we have a term-length limit. So if we exceed that, we'll use the\r
+  * SHA-1 of the path for the database term.\r
+diff --git a/lib/notmuch.h b/lib/notmuch.h\r
+index 92594b9..898f7b9 100644\r
+--- a/lib/notmuch.h\r
++++ b/lib/notmuch.h\r
+@@ -433,6 +433,24 @@ notmuch_status_t\r
+ notmuch_database_end_atomic (notmuch_database_t *notmuch);\r
\r
+ /**\r
++ * Return the committed database revision and UUID.\r
++ *\r
++ * The database revision number increases monotonically with each\r
++ * commit to the database.  Hence, all messages and message changes\r
++ * committed to the database (that is, visible to readers) have a last\r
++ * modification revision <= the committed database revision.  Any\r
++ * messages committed in the future will be assigned a modification\r
++ * revision > the committed database revision.\r
++ *\r
++ * The UUID is a NUL-terminated opaque string that uniquely identifies\r
++ * this database.  Two revision numbers are only comparable if they\r
++ * have the same database UUID.\r
++ */\r
++unsigned long\r
++notmuch_database_get_revisison (notmuch_database_t *notmuch,\r
++                              const char **uuid);\r
++\r
++/**\r
+  * Retrieve a directory object from the database for 'path'.\r
+  *\r
+  * Here, 'path' should be a path relative to the path of 'database'\r
+-- \r
+2.1.0\r
+\r