From: David Bremner <david@tethera.net>
To: notmuch@notmuchmail.org
Cc: David Bremner <david@tethera.net>
Subject: [PATCH 04/22] lib: support reopening databases for write access.
Date: Sun, 7 Mar 2021 13:27:16 -0400 [thread overview]
Message-ID: <20210307172734.1091264-5-david@tethera.net> (raw)
In-Reply-To: <20210307172734.1091264-1-david@tethera.net>
In the future xapian will apparently support this more conveniently
for the cases other than READ_ONLY => READ_ONLY
---
lib/database.cc | 23 --------
lib/notmuch.h | 6 +++
lib/open.cc | 46 ++++++++++++++++
test/T595-reopen.sh | 125 ++++++++++++++++++++++++++++++++++++++++++++
4 files changed, 177 insertions(+), 23 deletions(-)
create mode 100755 test/T595-reopen.sh
diff --git a/lib/database.cc b/lib/database.cc
index 799c008f..7ce07c46 100644
--- a/lib/database.cc
+++ b/lib/database.cc
@@ -516,29 +516,6 @@ notmuch_database_close (notmuch_database_t *notmuch)
return status;
}
-notmuch_status_t
-notmuch_database_reopen (notmuch_database_t *notmuch,
- unused(notmuch_database_mode_t mode))
-{
- if (_notmuch_database_mode (notmuch) != NOTMUCH_DATABASE_MODE_READ_ONLY)
- return NOTMUCH_STATUS_UNSUPPORTED_OPERATION;
-
- try {
- notmuch->xapian_db->reopen ();
- } catch (const Xapian::Error &error) {
- if (! notmuch->exception_reported) {
- _notmuch_database_log (notmuch, "Error: A Xapian exception reopening database: %s\n",
- error.get_msg ().c_str ());
- notmuch->exception_reported = true;
- }
- return NOTMUCH_STATUS_XAPIAN_EXCEPTION;
- }
-
- notmuch->view++;
-
- return NOTMUCH_STATUS_SUCCESS;
-}
-
static int
unlink_cb (const char *path,
unused (const struct stat *sb),
diff --git a/lib/notmuch.h b/lib/notmuch.h
index 05edac31..15ef77e7 100644
--- a/lib/notmuch.h
+++ b/lib/notmuch.h
@@ -882,6 +882,12 @@ notmuch_database_get_all_tags (notmuch_database_t *db);
/**
* Reopen an open notmuch database.
*
+ * @param [in] db open notmuch database
+ * @param [in] mode mode (read only or read-write) for reopened database.
+ *
+ * @retval #NOTMUCH_STATUS_SUCCESS
+ * @retval #NOTMUCH_STATUS_ILLEGAL_ARGUMENT The passed database was not open.
+ * @retval #NOTMUCH_STATUS_XAPIAN_EXCEPTION A Xapian exception occured
*/
notmuch_status_t
notmuch_database_reopen (notmuch_database_t *db, notmuch_database_mode_t mode);
diff --git a/lib/open.cc b/lib/open.cc
index c9cb78e6..4d01117d 100644
--- a/lib/open.cc
+++ b/lib/open.cc
@@ -509,3 +509,49 @@ notmuch_database_create_with_config (const char *database_path,
talloc_free (notmuch);
return status;
}
+
+notmuch_status_t
+notmuch_database_reopen (notmuch_database_t *notmuch,
+ notmuch_database_mode_t new_mode)
+{
+ notmuch_database_mode_t cur_mode = _notmuch_database_mode (notmuch);
+
+ if (notmuch->xapian_db == NULL) {
+ _notmuch_database_log (notmuch, "Cannot reopen closed or nonexistent database\n");
+ return NOTMUCH_STATUS_ILLEGAL_ARGUMENT;
+ }
+
+ try {
+ if (cur_mode == new_mode &&
+ new_mode == NOTMUCH_DATABASE_MODE_READ_ONLY) {
+ notmuch->xapian_db->reopen ();
+ } else {
+ notmuch->xapian_db->close ();
+
+ delete notmuch->xapian_db;
+ notmuch->xapian_db = NULL;
+ /* no need to free the same object twice */
+ notmuch->writable_xapian_db = NULL;
+
+ if (new_mode == NOTMUCH_DATABASE_MODE_READ_WRITE) {
+ notmuch->writable_xapian_db = new Xapian::WritableDatabase (notmuch->xapian_path,
+ DB_ACTION);
+ notmuch->xapian_db = notmuch->writable_xapian_db;
+ } else {
+ notmuch->xapian_db = new Xapian::Database (notmuch->xapian_path,
+ DB_ACTION);
+ }
+ }
+ } catch (const Xapian::Error &error) {
+ if (! notmuch->exception_reported) {
+ _notmuch_database_log (notmuch, "Error: A Xapian exception reopening database: %s\n",
+ error.get_msg ().c_str ());
+ notmuch->exception_reported = true;
+ }
+ return NOTMUCH_STATUS_XAPIAN_EXCEPTION;
+ }
+
+ notmuch->view++;
+ notmuch->open = true;
+ return NOTMUCH_STATUS_SUCCESS;
+}
diff --git a/test/T595-reopen.sh b/test/T595-reopen.sh
new file mode 100755
index 00000000..7375e2ac
--- /dev/null
+++ b/test/T595-reopen.sh
@@ -0,0 +1,125 @@
+#!/usr/bin/env bash
+test_description="library reopen API"
+
+. $(dirname "$0")/test-lib.sh || exit 1
+
+add_email_corpus
+
+cat <<EOF > c_head
+#include <string.h>
+#include <stdlib.h>
+#include <notmuch-test.h>
+
+int main (int argc, char** argv)
+{
+ notmuch_database_t *db;
+ char *val;
+ notmuch_status_t stat;
+ notmuch_database_mode_t mode = NOTMUCH_DATABASE_MODE_READ_ONLY;
+
+ char *msg = NULL;
+
+ for (int i = 1; i < argc; i++)
+ if (strcmp (argv[i], "%NULL%") == 0) argv[i] = NULL;
+
+ if (argv[2] && (argv[2][0] == 'w' || argv[2][0] == 'W'))
+ mode = NOTMUCH_DATABASE_MODE_READ_WRITE;
+
+ stat = notmuch_database_open_with_config (argv[1],
+ mode,
+ argv[3],
+ argv[4],
+ &db,
+ &msg);
+ if (stat != NOTMUCH_STATUS_SUCCESS) {
+ fprintf (stderr, "error opening database: %d %s\n", stat, msg ? msg : "");
+ exit (1);
+ }
+EOF
+
+cat <<EOF > c_tail
+ EXPECT0(notmuch_database_destroy(db));
+}
+EOF
+
+# The sequence of tests is important here
+
+test_begin_subtest "notmuch_database_reopen (read=>write)"
+cat c_head - c_tail <<'EOF' | test_C ${MAIL_DIR} read ${NOTMUCH_CONFIG}
+{
+ EXPECT0(notmuch_database_reopen (db, NOTMUCH_DATABASE_MODE_READ_WRITE));
+ EXPECT0(notmuch_database_set_config (db, "test.key1", "testvalue1"));
+ EXPECT0(notmuch_database_set_config (db, "test.key2", "testvalue2"));
+ EXPECT0(notmuch_database_get_config (db, "test.key1", &val));
+ printf("test.key1 = %s\n", val);
+ EXPECT0(notmuch_database_get_config (db, "test.key2", &val));
+ printf("test.key2 = %s\n", val);
+}
+EOF
+cat <<'EOF' >EXPECTED
+== stdout ==
+test.key1 = testvalue1
+test.key2 = testvalue2
+== stderr ==
+EOF
+test_expect_equal_file EXPECTED OUTPUT
+
+test_begin_subtest "notmuch_database_reopen (read=>read)"
+cat c_head - c_tail <<'EOF' | test_C ${MAIL_DIR} read ${NOTMUCH_CONFIG}
+{
+ EXPECT0(notmuch_database_reopen (db, NOTMUCH_DATABASE_MODE_READ_ONLY));
+ EXPECT0(notmuch_database_get_config (db, "test.key1", &val));
+ printf("test.key1 = %s\n", val);
+ EXPECT0(notmuch_database_get_config (db, "test.key2", &val));
+ printf("test.key2 = %s\n", val);
+}
+EOF
+cat <<'EOF' >EXPECTED
+== stdout ==
+test.key1 = testvalue1
+test.key2 = testvalue2
+== stderr ==
+EOF
+test_expect_equal_file EXPECTED OUTPUT
+
+test_begin_subtest "notmuch_database_reopen (write=>read)"
+cat c_head - c_tail <<'EOF' | test_C ${MAIL_DIR} write ${NOTMUCH_CONFIG}
+{
+ EXPECT0(notmuch_database_reopen (db, NOTMUCH_DATABASE_MODE_READ_ONLY));
+ EXPECT0(notmuch_database_get_config (db, "test.key1", &val));
+ printf("test.key1 = %s\n", val);
+ EXPECT0(notmuch_database_get_config (db, "test.key2", &val));
+ printf("test.key2 = %s\n", val);
+}
+EOF
+cat <<'EOF' >EXPECTED
+== stdout ==
+test.key1 = testvalue1
+test.key2 = testvalue2
+== stderr ==
+EOF
+test_expect_equal_file EXPECTED OUTPUT
+
+test_begin_subtest "notmuch_database_reopen (write=>write)"
+cat c_head - c_tail <<'EOF' | test_C ${MAIL_DIR} write ${NOTMUCH_CONFIG}
+{
+ EXPECT0(notmuch_database_reopen (db, NOTMUCH_DATABASE_MODE_READ_WRITE));
+ EXPECT0(notmuch_database_set_config (db, "test.key3", "testvalue3"));
+ EXPECT0(notmuch_database_get_config (db, "test.key1", &val));
+ printf("test.key1 = %s\n", val);
+ EXPECT0(notmuch_database_get_config (db, "test.key2", &val));
+ printf("test.key2 = %s\n", val);
+ EXPECT0(notmuch_database_get_config (db, "test.key3", &val));
+ printf("test.key3 = %s\n", val);
+}
+EOF
+cat <<'EOF' >EXPECTED
+== stdout ==
+test.key1 = testvalue1
+test.key2 = testvalue2
+test.key3 = testvalue3
+== stderr ==
+EOF
+test_expect_equal_file EXPECTED OUTPUT
+
+test_done
--
2.30.1
next prev parent reply other threads:[~2021-03-07 17:29 UTC|newest]
Thread overview: 26+ messages / expand[flat|nested] mbox.gz Atom feed top
2021-03-07 17:27 v3 support flexible database location David Bremner
2021-03-07 17:27 ` [PATCH 01/22] test/setup: add check for config exists, but no database David Bremner
2021-03-07 17:27 ` [PATCH 02/22] lib: publish API for notmuch_database_reopen David Bremner
2021-03-07 17:27 ` [PATCH 03/22] lib: save path of xapian database in notmuch struct David Bremner
2021-03-07 17:27 ` David Bremner [this message]
2021-03-07 17:27 ` [PATCH 05/22] CLI/show: complete conversion to new configuration framework David Bremner
2021-03-07 17:27 ` [PATCH 06/22] lib/open: support NOTMUCH_DATABASE environment variable David Bremner
2021-03-07 17:27 ` [PATCH 07/22] lib/open: allocate notmuch_t struct early David Bremner
2021-03-07 17:27 ` [PATCH 08/22] lib: remove "path" from notmuch struct David Bremner
2021-03-07 17:27 ` [PATCH 09/22] lib/open: factor out library initialization David Bremner
2021-03-07 17:27 ` [PATCH 10/22] lib/open: reuse directory checks from n_d_c_with_config David Bremner
2021-03-07 17:27 ` [PATCH 11/22] lib/open: factor out the second half of n_d_open_with_config David Bremner
2021-03-07 17:27 ` [PATCH 12/22] lib/open: use _finish_open in n_d_create_with_config David Bremner
2021-03-07 17:27 ` [PATCH 13/22] lib/open: Use check for existing database by trial opening David Bremner
2021-03-07 17:27 ` [PATCH 14/22] support splitting mail from database location David Bremner
2021-03-07 17:27 ` [PATCH 15/22] lib/open: check for split configuration when creating database David Bremner
2021-03-07 17:27 ` [PATCH 16/22] CLI/new: support split database and mail location David Bremner
2021-03-07 17:27 ` [PATCH 17/22] lib/open: support XDG_DATA_HOME as a fallback database location David Bremner
2021-03-07 17:27 ` [PATCH 18/22] CLI/insert: support split database and mail root David Bremner
2021-03-07 17:27 ` [PATCH 19/22] lib/compact: enable split config David Bremner
2021-03-07 17:27 ` [PATCH 20/22] lib/open: fix hook directory calculation in split configuration David Bremner
2021-03-07 17:27 ` [PATCH 21/22] lib/config: add configuration variable for backup directory David Bremner
2021-03-07 17:27 ` [PATCH 22/22] CLI/new: use " David Bremner
-- strict thread matches above, loose matches on Subject: below --
2021-03-14 14:01 v4 flexible path location David Bremner
2021-03-14 14:01 ` [PATCH 04/22] lib: support reopening databases for write access David Bremner
2021-03-18 11:11 ` David Bremner
2021-03-04 13:31 v2 support flexible database location David Bremner
2021-03-04 13:31 ` [PATCH 04/22] lib: support reopening databases for write access David Bremner
Reply instructions:
You may reply publicly to this message via plain-text email
using any one of the following methods:
* Save the following mbox file, import it into your mail client,
and reply-to-all from there: mbox
Avoid top-posting and favor interleaved quoting:
https://en.wikipedia.org/wiki/Posting_style#Interleaved_style
List information: https://notmuchmail.org/
* Reply using the --to, --cc, and --in-reply-to
switches of git-send-email(1):
git send-email \
--in-reply-to=20210307172734.1091264-5-david@tethera.net \
--to=david@tethera.net \
--cc=notmuch@notmuchmail.org \
/path/to/YOUR_REPLY
https://kernel.org/pub/software/scm/git/docs/git-send-email.html
* If your mail client supports setting the In-Reply-To header
via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line
before the message body.
Code repositories for project(s) associated with this public inbox
https://yhetil.org/notmuch.git/
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox;
as well as URLs for read-only IMAP folder(s) and NNTP newsgroup(s).