]> git.notmuchmail.org Git - notmuch/commitdiff
lib: provide notmuch_config_path
authorDavid Bremner <david@tethera.net>
Sun, 21 Feb 2021 11:34:52 +0000 (07:34 -0400)
committerDavid Bremner <david@tethera.net>
Sat, 27 Mar 2021 12:26:14 +0000 (09:26 -0300)
Since the library searches in several locations for a config file, the
caller does not know which of these is chosen in the usual case of
passing NULL as a config file. This changes provides an API for the
caller to retrieve the name of the config file chosen. It will be
tested in a following commit.

lib/config.cc
lib/database-private.h
lib/notmuch.h
lib/open.cc

index 26280842e496bf57c4bf6ffcce50374056540fb6..7a0da9716bf9a36ef4b1b5abad7cc5aabdee3049 100644 (file)
@@ -654,6 +654,12 @@ notmuch_config_get (notmuch_database_t *notmuch, notmuch_config_key_t key)
     return _notmuch_string_map_get (notmuch->config, _notmuch_config_key_to_string (key));
 }
 
     return _notmuch_string_map_get (notmuch->config, _notmuch_config_key_to_string (key));
 }
 
+const char *
+notmuch_config_path (notmuch_database_t *notmuch)
+{
+    return notmuch->config_path;
+}
+
 notmuch_status_t
 notmuch_config_set (notmuch_database_t *notmuch, notmuch_config_key_t key, const char *val)
 {
 notmuch_status_t
 notmuch_config_set (notmuch_database_t *notmuch, notmuch_config_key_t key, const char *val)
 {
index 2900382d52b5eb9e38d6e9d27d74c56b978109aa..0d12ec1efde57b4862f1001facdbfafe3dec54cd 100644 (file)
@@ -192,6 +192,9 @@ struct _notmuch_database {
     /* Path to actual database */
     const char *xapian_path;
 
     /* Path to actual database */
     const char *xapian_path;
 
+    /* Path to config loaded, if any */
+    const char *config_path;
+
     int atomic_nesting;
     /* true if changes have been made in this atomic section */
     bool atomic_dirty;
     int atomic_nesting;
     /* true if changes have been made in this atomic section */
     bool atomic_dirty;
index 9ea05fc5cfcd8f6b1e873b0bac48feb328c95b13..4b0539323da826d99aea2875cd0fd1583b60fb33 100644 (file)
@@ -454,7 +454,12 @@ notmuch_database_open_with_config (const char *database_path,
  *
  * For description of arguments, @see notmuch_database_open_with_config
  *
  *
  * For description of arguments, @see notmuch_database_open_with_config
  *
- * @retval NOTMUCH_STATUS_SUCCESS: Successfully loaded (some) configuration.
+ * @retval NOTMUCH_STATUS_SUCCESS: Successfully loaded configuration.
+ *
+ * @retval NOTMUCH_STATUS_NO_CONFIG: No config file was loaded. Not fatal.
+ *
+ * @retval NOTMUCH_STATUS_NO_DATABASE: No config information was
+ *     loaded from a database. Not fatal.
  *
  * @retval NOTMUCH_STATUS_OUT_OF_MEMORY: Out of memory.
  *
  *
  * @retval NOTMUCH_STATUS_OUT_OF_MEMORY: Out of memory.
  *
@@ -2737,6 +2742,15 @@ notmuch_status_t
 notmuch_config_get_bool (notmuch_database_t *notmuch,
                         notmuch_config_key_t key,
                         notmuch_bool_t *val);
 notmuch_config_get_bool (notmuch_database_t *notmuch,
                         notmuch_config_key_t key,
                         notmuch_bool_t *val);
+
+/**
+ * return the path of the config file loaded, if any
+ *
+ * @retval NULL if no config file was loaded
+ */
+const char *
+notmuch_config_path (notmuch_database_t *notmuch);
+
 /**
  * get the current default indexing options for a given database.
  *
 /**
  * get the current default indexing options for a given database.
  *
index 387e4ddb22dd5c92536be0f0230274af80caf61b..5d80a884fb35aecbc6f084505ccb80ce85c8fec7 100644 (file)
@@ -113,12 +113,12 @@ _choose_dir (notmuch_database_t *notmuch,
 }
 
 static notmuch_status_t
 }
 
 static notmuch_status_t
-_load_key_file (const char *path,
+_load_key_file (notmuch_database_t *notmuch,
+               const char *path,
                const char *profile,
                GKeyFile **key_file)
 {
     notmuch_status_t status = NOTMUCH_STATUS_SUCCESS;
                const char *profile,
                GKeyFile **key_file)
 {
     notmuch_status_t status = NOTMUCH_STATUS_SUCCESS;
-    void *local = talloc_new (NULL);
 
     if (path && EMPTY_STRING (path))
        goto DONE;
 
     if (path && EMPTY_STRING (path))
        goto DONE;
@@ -126,11 +126,13 @@ _load_key_file (const char *path,
     if (! path)
        path = getenv ("NOTMUCH_CONFIG");
 
     if (! path)
        path = getenv ("NOTMUCH_CONFIG");
 
-    if (! path) {
-       const char *dir = _xdg_dir (local, "XDG_CONFIG_HOME", ".config", profile);
+    if (path)
+       path = talloc_strdup (notmuch, path);
+    else {
+       const char *dir = _xdg_dir (notmuch, "XDG_CONFIG_HOME", ".config", profile);
 
        if (dir) {
 
        if (dir) {
-           path = talloc_asprintf (local, "%s/config", dir);
+           path = talloc_asprintf (notmuch, "%s/config", dir);
            if (access (path, R_OK) != 0)
                path = NULL;
        }
            if (access (path, R_OK) != 0)
                path = NULL;
        }
@@ -139,13 +141,13 @@ _load_key_file (const char *path,
     if (! path) {
        const char *home = getenv ("HOME");
 
     if (! path) {
        const char *home = getenv ("HOME");
 
-       path = talloc_asprintf (local, "%s/.notmuch-config", home);
+       path = talloc_asprintf (notmuch, "%s/.notmuch-config", home);
 
        if (! profile)
            profile = getenv ("NOTMUCH_PROFILE");
 
        if (profile)
 
        if (! profile)
            profile = getenv ("NOTMUCH_PROFILE");
 
        if (profile)
-           path = talloc_asprintf (local, "%s.%s", path, profile);
+           path = talloc_asprintf (notmuch, "%s.%s", path, profile);
     }
 
     *key_file = g_key_file_new ();
     }
 
     *key_file = g_key_file_new ();
@@ -154,7 +156,9 @@ _load_key_file (const char *path,
     }
 
   DONE:
     }
 
   DONE:
-    talloc_free (local);
+    if (path)
+       notmuch->config_path = path;
+
     return status;
 }
 
     return status;
 }
 
@@ -232,6 +236,7 @@ _alloc_notmuch ()
     notmuch->exception_reported = false;
     notmuch->status_string = NULL;
     notmuch->writable_xapian_db = NULL;
     notmuch->exception_reported = false;
     notmuch->status_string = NULL;
     notmuch->writable_xapian_db = NULL;
+    notmuch->config_path = NULL;
     notmuch->atomic_nesting = 0;
     notmuch->view = 1;
     return notmuch;
     notmuch->atomic_nesting = 0;
     notmuch->view = 1;
     return notmuch;
@@ -493,7 +498,7 @@ notmuch_database_open_with_config (const char *database_path,
        goto DONE;
     }
 
        goto DONE;
     }
 
-    status = _load_key_file (config_path, profile, &key_file);
+    status = _load_key_file (notmuch, config_path, profile, &key_file);
     if (status) {
        message = strdup ("Error: cannot load config file.\n");
        goto DONE;
     if (status) {
        message = strdup ("Error: cannot load config file.\n");
        goto DONE;
@@ -590,7 +595,7 @@ notmuch_database_create_with_config (const char *database_path,
        goto DONE;
     }
 
        goto DONE;
     }
 
-    status = _load_key_file (config_path, profile, &key_file);
+    status = _load_key_file (notmuch, config_path, profile, &key_file);
     if (status) {
        message = strdup ("Error: cannot load config file.\n");
        goto DONE;
     if (status) {
        message = strdup ("Error: cannot load config file.\n");
        goto DONE;
@@ -784,9 +789,10 @@ notmuch_database_load_config (const char *database_path,
        goto DONE;
     }
 
        goto DONE;
     }
 
-    status = _load_key_file (config_path, profile, &key_file);
+    status = _load_key_file (notmuch, config_path, profile, &key_file);
     switch (status) {
     case NOTMUCH_STATUS_SUCCESS:
     switch (status) {
     case NOTMUCH_STATUS_SUCCESS:
+       break;
     case NOTMUCH_STATUS_NO_CONFIG:
        warning = status;
        break;
     case NOTMUCH_STATUS_NO_CONFIG:
        warning = status;
        break;