From ac67cd84eea1148680ab3a377d35ae346073f138 Mon Sep 17 00:00:00 2001 From: David Bremner Date: Fri, 1 Jan 2021 20:43:14 -0400 Subject: [PATCH] lib: introduce notmuch_database_create_with_config This takes a config path parameter, and can use that to decide the new database location. --- bindings/python-cffi/tests/test_database.py | 2 +- lib/notmuch.h | 27 +++++++++++ lib/open.cc | 50 ++++++++++++--------- test/T560-lib-error.sh | 2 +- 4 files changed, 58 insertions(+), 23 deletions(-) diff --git a/bindings/python-cffi/tests/test_database.py b/bindings/python-cffi/tests/test_database.py index a2c69de6..9b3219c0 100644 --- a/bindings/python-cffi/tests/test_database.py +++ b/bindings/python-cffi/tests/test_database.py @@ -80,7 +80,7 @@ class TestCreate: db.create(tmppath) def test_create_existing(self, tmppath, db): - with pytest.raises(errors.FileError): + with pytest.raises(errors.DatabaseExistsError): dbmod.Database.create(path=tmppath) def test_close(self, db): diff --git a/lib/notmuch.h b/lib/notmuch.h index 6d22d328..5e07a01a 100644 --- a/lib/notmuch.h +++ b/lib/notmuch.h @@ -442,6 +442,33 @@ notmuch_database_open_with_config (const char *database_path, const char *profile, notmuch_database_t **database, char **error_message); +/** + * Create a new notmuch database located at 'database_path', using + * configuration in 'config_path'. + * + * For description of arguments, @see notmuch_database_open_with_config + * + * @retval NOTMUCH_STATUS_SUCCESS: Successfully created the database. + * + * @retval NOTMUCH_STATUS_DATABASE_EXISTS: Database already exists, not created + * + * @retval NOTMUCH_STATUS_OUT_OF_MEMORY: Out of memory. + * + * @retval NOTMUCH_STATUS_FILE_ERROR: An error occurred trying to open the + * database or config file (such as permission denied, or file not found, + * etc.) + * + * @retval NOTMUCH_STATUS_XAPIAN_EXCEPTION: A Xapian exception occurred. + * + * @since libnotmuch 5.4 (notmuch 0.32) + */ + +notmuch_status_t +notmuch_database_create_with_config (const char *database_path, + const char *config_path, + const char *profile, + notmuch_database_t **database, + char **error_message); /** * Retrieve last status string for given database. diff --git a/lib/open.cc b/lib/open.cc index 6046868a..577fc88a 100644 --- a/lib/open.cc +++ b/lib/open.cc @@ -363,30 +363,32 @@ notmuch_status_t notmuch_database_create_verbose (const char *path, notmuch_database_t **database, char **status_string) +{ + return notmuch_database_create_with_config (path, "", NULL, database, status_string); +} + +notmuch_status_t +notmuch_database_create_with_config (const char *database_path, + const char *config_path, + const char *profile, + notmuch_database_t **database, + char **status_string) { notmuch_status_t status = NOTMUCH_STATUS_SUCCESS; notmuch_database_t *notmuch = NULL; char *notmuch_path = NULL; char *message = NULL; + GKeyFile *key_file = NULL; struct stat st; int err; - if (path == NULL) { - message = strdup ("Error: Cannot create a database for a NULL path.\n"); - status = NOTMUCH_STATUS_NULL_POINTER; + if ((status = _choose_database_path (config_path, profile, &key_file, &database_path, &message))) goto DONE; - } - if (path[0] != '/') { - message = strdup ("Error: Database path must be absolute.\n"); - status = NOTMUCH_STATUS_PATH_ERROR; - goto DONE; - } - - err = stat (path, &st); + err = stat (database_path, &st); if (err) { IGNORE_RESULT (asprintf (&message, "Error: Cannot create database at %s: %s.\n", - path, strerror (errno))); + database_path, strerror (errno))); status = NOTMUCH_STATUS_FILE_ERROR; goto DONE; } @@ -394,25 +396,31 @@ notmuch_database_create_verbose (const char *path, if (! S_ISDIR (st.st_mode)) { IGNORE_RESULT (asprintf (&message, "Error: Cannot create database at %s: " "Not a directory.\n", - path)); + database_path)); status = NOTMUCH_STATUS_FILE_ERROR; goto DONE; } - notmuch_path = talloc_asprintf (NULL, "%s/%s", path, ".notmuch"); + notmuch_path = talloc_asprintf (NULL, "%s/%s", database_path, ".notmuch"); err = mkdir (notmuch_path, 0755); - if (err) { - IGNORE_RESULT (asprintf (&message, "Error: Cannot create directory %s: %s.\n", - notmuch_path, strerror (errno))); - status = NOTMUCH_STATUS_FILE_ERROR; + if (errno == EEXIST) { + status = NOTMUCH_STATUS_DATABASE_EXISTS; + } else { + IGNORE_RESULT (asprintf (&message, "Error: Cannot create directory %s: %s.\n", + notmuch_path, strerror (errno))); + status = NOTMUCH_STATUS_FILE_ERROR; + } goto DONE; } - status = notmuch_database_open_verbose (path, - NOTMUCH_DATABASE_MODE_READ_WRITE, - ¬much, &message); + /* XXX this reads the config file twice, which is a bit wasteful */ + status = notmuch_database_open_with_config (database_path, + NOTMUCH_DATABASE_MODE_READ_WRITE, + config_path, + profile, + ¬much, &message); if (status) goto DONE; diff --git a/test/T560-lib-error.sh b/test/T560-lib-error.sh index 260ac120..ade376ef 100755 --- a/test/T560-lib-error.sh +++ b/test/T560-lib-error.sh @@ -93,7 +93,7 @@ EOF cat <<'EOF' >EXPECTED == stdout == == stderr == -Error: Cannot create a database for a NULL path. +Error: Cannot open a database for a NULL path. EOF test_expect_equal_file EXPECTED OUTPUT