lib: provide notmuch_config_path

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.
This commit is contained in:
David Bremner 2021-02-21 07:34:52 -04:00
parent 217f819608
commit f5d4349921
4 changed files with 41 additions and 12 deletions

View 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));
}
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)
{

View file

@ -192,6 +192,9 @@ struct _notmuch_database {
/* 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;

View file

@ -454,7 +454,12 @@ notmuch_database_open_with_config (const char *database_path,
*
* 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.
*
@ -2737,6 +2742,15 @@ notmuch_status_t
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.
*

View file

@ -113,12 +113,12 @@ _choose_dir (notmuch_database_t *notmuch,
}
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;
void *local = talloc_new (NULL);
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) {
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) {
path = talloc_asprintf (local, "%s/config", dir);
path = talloc_asprintf (notmuch, "%s/config", dir);
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");
path = talloc_asprintf (local, "%s/.notmuch-config", home);
path = talloc_asprintf (notmuch, "%s/.notmuch-config", home);
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 ();
@ -154,7 +156,9 @@ _load_key_file (const char *path,
}
DONE:
talloc_free (local);
if (path)
notmuch->config_path = path;
return status;
}
@ -232,6 +236,7 @@ _alloc_notmuch ()
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;
@ -493,7 +498,7 @@ notmuch_database_open_with_config (const char *database_path,
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;
@ -590,7 +595,7 @@ notmuch_database_create_with_config (const char *database_path,
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;
@ -784,9 +789,10 @@ notmuch_database_load_config (const char *database_path,
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:
break;
case NOTMUCH_STATUS_NO_CONFIG:
warning = status;
break;