From: David Bremner <david@tethera.net>
To: notmuch@notmuchmail.org
Cc: David Bremner <david@tethera.net>
Subject: [PATCH 14/23] lib/open: support XDG_DATA_HOME as a fallback database location.
Date: Sun, 7 Feb 2021 20:41:00 -0400 [thread overview]
Message-ID: <20210208004109.1192719-15-david@tethera.net> (raw)
In-Reply-To: <20210208004109.1192719-1-david@tethera.net>
This changes some error reporting, either intentionally by reporting
the highest level missing directory, or by side effect from looking in
XDG locations when given null database location.
---
lib/open.cc | 60 ++++++++++++++++++++++++++++------------
test/T055-path-config.sh | 34 +++++++++++++++++++++--
test/T560-lib-error.sh | 4 +--
test/T590-libconfig.sh | 4 +--
4 files changed, 79 insertions(+), 23 deletions(-)
diff --git a/lib/open.cc b/lib/open.cc
index 887bc44d..efb0d6a3 100644
--- a/lib/open.cc
+++ b/lib/open.cc
@@ -176,10 +176,12 @@ _db_dir_exists (const char *database_path, char **message)
}
static notmuch_status_t
-_choose_database_path (const char *config_path,
+_choose_database_path (void * ctx,
+ const char *config_path,
const char *profile,
GKeyFile **key_file,
const char **database_path,
+ bool *split,
char **message)
{
notmuch_status_t status;
@@ -197,6 +199,11 @@ _choose_database_path (const char *config_path,
if (! *database_path && *key_file)
*database_path = g_key_file_get_value (*key_file, "database", "path", NULL);
+ if (! *database_path) {
+ *database_path = _xdg_dir (ctx, "XDG_DATA_HOME", ".local/share", profile);
+ *split = true;
+ }
+
if (*database_path == NULL) {
*message = strdup ("Error: Cannot open a database for a NULL path.\n");
return NOTMUCH_STATUS_NULL_POINTER;
@@ -435,6 +442,7 @@ notmuch_database_open_with_config (const char *database_path,
notmuch_database_t *notmuch = NULL;
char *message = NULL;
GKeyFile *key_file = NULL;
+ bool split = false;
_init_libs ();
@@ -444,7 +452,9 @@ notmuch_database_open_with_config (const char *database_path,
goto DONE;
}
- if ((status = _choose_database_path (config_path, profile, &key_file, &database_path, &message)))
+ if ((status = _choose_database_path (local, config_path, profile,
+ &key_file, &database_path, &split,
+ &message)))
goto DONE;
status = _db_dir_exists (database_path, &message);
@@ -515,11 +525,12 @@ notmuch_database_create_with_config (const char *database_path,
{
notmuch_status_t status = NOTMUCH_STATUS_SUCCESS;
notmuch_database_t *notmuch = NULL;
- char *notmuch_path = NULL;
+ const char *notmuch_path = NULL;
char *message = NULL;
GKeyFile *key_file = NULL;
void *local = talloc_new (NULL);
int err;
+ bool split = false;
notmuch = _alloc_notmuch ();
if (! notmuch) {
@@ -527,7 +538,9 @@ notmuch_database_create_with_config (const char *database_path,
goto DONE;
}
- if ((status = _choose_database_path (config_path, profile, &key_file, &database_path, &message)))
+ if ((status = _choose_database_path (local, config_path, profile,
+ &key_file, &database_path, &split,
+ &message)))
goto DONE;
status = _db_dir_exists (database_path, &message);
@@ -537,22 +550,35 @@ notmuch_database_create_with_config (const char *database_path,
notmuch->path = talloc_strdup (notmuch, database_path);
strip_trailing (notmuch->path, '/');
- notmuch_path = talloc_asprintf (local, "%s/%s", database_path, ".notmuch");
+ if (key_file && !split) {
+ const char *mail_root = g_key_file_get_value (key_file, "database", "mail_root", NULL);
+ /* XXX compare canonicalized versions */
+ split = (mail_root && (0 != strcmp (mail_root, database_path)));
+ }
- err = mkdir (notmuch_path, 0755);
- if (err) {
- if (errno == EEXIST) {
- status = NOTMUCH_STATUS_DATABASE_EXISTS;
- talloc_free (notmuch);
- notmuch = NULL;
- } else {
- IGNORE_RESULT (asprintf (&message, "Error: Cannot create directory %s: %s.\n",
- notmuch_path, strerror (errno)));
- status = NOTMUCH_STATUS_FILE_ERROR;
+ if (split) {
+ notmuch_path = database_path;
+ } else {
+ if (! (notmuch_path = talloc_asprintf (local, "%s/%s", database_path, ".notmuch"))) {
+ status = NOTMUCH_STATUS_OUT_OF_MEMORY;
+ goto DONE;
}
- goto DONE;
- }
+ err = mkdir (notmuch_path, 0755);
+
+ if (err) {
+ if (errno == EEXIST) {
+ status = NOTMUCH_STATUS_DATABASE_EXISTS;
+ talloc_free (notmuch);
+ notmuch = NULL;
+ } else {
+ IGNORE_RESULT (asprintf (&message, "Error: Cannot create directory %s: %s.\n",
+ notmuch_path, strerror (errno)));
+ status = NOTMUCH_STATUS_FILE_ERROR;
+ }
+ goto DONE;
+ }
+ }
if (! (notmuch->xapian_path = talloc_asprintf (notmuch, "%s/%s", notmuch_path, "xapian"))) {
status = NOTMUCH_STATUS_OUT_OF_MEMORY;
goto DONE;
diff --git a/test/T055-path-config.sh b/test/T055-path-config.sh
index 59b12337..c82b6a14 100755
--- a/test/T055-path-config.sh
+++ b/test/T055-path-config.sh
@@ -27,9 +27,31 @@ split_config () {
DATABASE_PATH=$dir
}
+xdg_config () {
+ local dir
+ local profile=${1:-default}
+
+ if [[ $profile != default ]]; then
+ export NOTMUCH_PROFILE=$profile
+ fi
+
+ backup_config
+ DATABASE_PATH="${HOME}/.local/share/notmuch/${profile}"
+ rm -rf $DATABASE_PATH
+ mkdir -p $DATABASE_PATH
+
+ config_dir="${HOME}/.config/notmuch/${profile}"
+ mkdir -p ${config_dir}
+ CONFIG_PATH=$config_dir/config
+ mv ${NOTMUCH_CONFIG} $CONFIG_PATH
+ unset NOTMUCH_CONFIG
-for config in traditional split+prefix; do
- # start each set of tests with a known set of messages
+ notmuch --config=${CONFIG_PATH} config set database.mail_root ${TMP_DIRECTORY}/mail
+ notmuch --config=${CONFIG_PATH} config set database.path
+}
+
+for config in traditional split+prefix split XDG XDG+profile; do
+ #start each set of tests with an known set of messages
add_email_corpus
case $config in
@@ -44,6 +66,14 @@ for config in traditional split+prefix; do
split_config
mv mail/.notmuch/xapian $DATABASE_PATH
;;
+ XDG)
+ xdg_config
+ mv mail/.notmuch/xapian $DATABASE_PATH
+ ;;
+ XDG+profile)
+ xdg_config ${RANDOM}
+ mv mail/.notmuch/xapian $DATABASE_PATH
+ ;;
esac
test_begin_subtest "count ($config)"
diff --git a/test/T560-lib-error.sh b/test/T560-lib-error.sh
index 03df69d9..89447e9a 100755
--- a/test/T560-lib-error.sh
+++ b/test/T560-lib-error.sh
@@ -22,7 +22,7 @@ EOF
cat <<'EOF' >EXPECTED
== stdout ==
== stderr ==
-Error: Cannot open a database for a NULL path.
+Error: Cannot open database at CWD/home/.local/share/notmuch/default: No such file or directory.
EOF
test_expect_equal_file EXPECTED OUTPUT
@@ -93,7 +93,7 @@ EOF
cat <<'EOF' >EXPECTED
== stdout ==
== stderr ==
-Error: Cannot open a database for a NULL path.
+Error: Cannot open database at CWD/home/.local/share/notmuch/default: No such file or directory.
EOF
test_expect_equal_file EXPECTED OUTPUT
diff --git a/test/T590-libconfig.sh b/test/T590-libconfig.sh
index 5cf70987..c21c139b 100755
--- a/test/T590-libconfig.sh
+++ b/test/T590-libconfig.sh
@@ -519,8 +519,8 @@ cat <<'EOF' >EXPECTED
== stdout ==
== stderr ==
error opening database
-Erroneous NULL pointer
-Error: Cannot open a database for a NULL path.
+Something went wrong trying to read or write a file
+Error: Cannot open database at CWD/home/.local/share/notmuch/default: No such file or directory.
EOF
test_expect_equal_file EXPECTED OUTPUT
--
2.30.0
next prev parent reply other threads:[~2021-02-08 0:43 UTC|newest]
Thread overview: 24+ messages / expand[flat|nested] mbox.gz Atom feed top
2021-02-08 0:40 Support flexible database location David Bremner
2021-02-08 0:40 ` [PATCH 01/23] lib: publish API for notmuch_database_reopen David Bremner
2021-02-08 0:40 ` [PATCH 02/23] lib: save path of xapian database in notmuch struct David Bremner
2021-02-08 0:40 ` [PATCH 03/23] lib: support reopening databases for write access David Bremner
2021-02-08 0:40 ` [PATCH 04/23] CLI/show: complete conversion to new configuration framework David Bremner
2021-02-08 0:40 ` [PATCH 05/23] lib/open: support NOTMUCH_DATABASE environment variable David Bremner
2021-02-08 0:40 ` [PATCH 06/23] lib/open: allocate notmuch_t struct early David Bremner
2021-02-08 0:40 ` [PATCH 07/23] support splitting mail from database location David Bremner
2021-02-08 0:40 ` [PATCH 08/23] " David Bremner
2021-02-08 0:40 ` [PATCH 09/23] lib/open: factor out library intialization David Bremner
2021-02-08 0:40 ` [PATCH 10/23] lib/open: factor out the second half of n_d_open_with_config David Bremner
2021-02-08 0:40 ` [PATCH 11/23] lib/open: use _finish_open in n_d_create_with_config David Bremner
2021-02-08 0:40 ` [PATCH 12/23] lib/open: reuse directory checks from n_d_c_with_config David Bremner
2021-02-08 0:40 ` [PATCH 13/23] lib/open: open existing databases without .notmuch in path David Bremner
2021-02-08 0:41 ` David Bremner [this message]
2021-02-08 0:41 ` [PATCH 15/23] CLI/new: support split database and mail location David Bremner
2021-02-08 0:41 ` [PATCH 16/23] CLI/insert: support split database and mail root David Bremner
2021-02-08 0:41 ` [PATCH 17/23] lib: remove "path" from notmuch struct David Bremner
2021-02-08 0:41 ` [PATCH 18/23] CLI/show: add tests for raw output in split config David Bremner
2021-02-08 0:41 ` [PATCH 19/23] lib/compact: enable " David Bremner
2021-02-08 0:41 ` [PATCH 20/23] CLI/reply: tests for " David Bremner
2021-02-08 0:41 ` [PATCH 21/23] CLI/address: " David Bremner
2021-02-08 0:41 ` [PATCH 22/23] test: add tests for dump and restore in split configuration David Bremner
2021-02-08 0:41 ` [PATCH 23/23] test: add test for reindex in split configurations 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=20210208004109.1192719-15-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).