]> git.notmuchmail.org Git - notmuch/blobdiff - lib/open.cc
lib/config: add configuration variable for backup directory
[notmuch] / lib / open.cc
index 8bd73d6aec7e01c477e9e08cb84b105439ff27c7..8f572b0b4f5557a43e7ab516edbaf39580e75173 100644 (file)
@@ -1,4 +1,6 @@
 #include <unistd.h>
+#include <libgen.h>
+
 #include "database-private.h"
 #include "parse-time-vrp.h"
 
@@ -69,39 +71,43 @@ _xdg_dir (void *ctx,
 }
 
 static notmuch_status_t
-_choose_hook_dir (notmuch_database_t *notmuch,
-                 const char *profile,
-                 char **message)
+_choose_dir (notmuch_database_t *notmuch,
+            const char *profile,
+            notmuch_config_key_t key,
+            const char *xdg_var,
+            const char *xdg_subdir,
+            const char *subdir,
+            char **message = NULL)
 {
-    const char *config;
-    const char *hook_dir;
+    const char *parent;
+    const char *dir;
     struct stat st;
     int err;
 
-    hook_dir = notmuch_config_get (notmuch, NOTMUCH_CONFIG_HOOK_DIR);
+    dir = notmuch_config_get (notmuch, key);
 
-    if (hook_dir)
+    if (dir)
        return NOTMUCH_STATUS_SUCCESS;
 
-    config = _xdg_dir (notmuch, "XDG_CONFIG_HOME", ".config", profile);
-    if (! config)
+    parent = _xdg_dir (notmuch, xdg_var, xdg_subdir, profile);
+    if (! parent)
        return NOTMUCH_STATUS_PATH_ERROR;
 
-    hook_dir = talloc_asprintf (notmuch, "%s/hooks", config);
+    dir = talloc_asprintf (notmuch, "%s/%s", parent, subdir);
 
-    err = stat (hook_dir, &st);
+    err = stat (dir, &st);
     if (err) {
        if (errno == ENOENT) {
-           const char *database_path = notmuch_database_get_path (notmuch);
-           hook_dir = talloc_asprintf (notmuch, "%s/.notmuch/hooks", database_path);
+           char *notmuch_path = dirname (talloc_strdup (notmuch, notmuch->xapian_path));
+           dir = talloc_asprintf (notmuch, "%s/%s", notmuch_path, subdir);
        } else {
            IGNORE_RESULT (asprintf (message, "Error: Cannot stat %s: %s.\n",
-                                    hook_dir, strerror (errno)));
+                                    dir, strerror (errno)));
            return NOTMUCH_STATUS_FILE_ERROR;
        }
     }
 
-    _notmuch_config_cache (notmuch, NOTMUCH_CONFIG_HOOK_DIR, hook_dir);
+    _notmuch_config_cache (notmuch, key, dir);
 
     return NOTMUCH_STATUS_SUCCESS;
 }
@@ -152,12 +158,36 @@ _load_key_file (const char *path,
     return status;
 }
 
+static notmuch_status_t
+_db_dir_exists (const char *database_path, char **message)
+{
+    struct stat st;
+    int err;
+
+    err = stat (database_path, &st);
+    if (err) {
+       IGNORE_RESULT (asprintf (message, "Error: Cannot open database at %s: %s.\n",
+                                database_path, strerror (errno)));
+       return NOTMUCH_STATUS_FILE_ERROR;
+    }
+
+    if (! S_ISDIR (st.st_mode)) {
+       IGNORE_RESULT (asprintf (message, "Error: Cannot open database at %s: "
+                                "Not a directory.\n",
+                                database_path));
+       return NOTMUCH_STATUS_FILE_ERROR;
+    }
+
+    return NOTMUCH_STATUS_SUCCESS;
+}
+
 static notmuch_status_t
 _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;
@@ -180,6 +210,11 @@ _choose_database_path (void *ctx,
        }
     }
 
+    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;
@@ -209,57 +244,72 @@ _alloc_notmuch ()
     return notmuch;
 }
 
+static notmuch_status_t
+_trial_open (const char *xapian_path, char **message_ptr)
+{
+    try {
+       Xapian::Database db (xapian_path);
+    } catch (const Xapian::DatabaseOpeningError &error) {
+       IGNORE_RESULT (asprintf (message_ptr,
+                                "Cannot open Xapian database at %s: %s\n",
+                                xapian_path,
+                                error.get_msg ().c_str ()));
+       return NOTMUCH_STATUS_PATH_ERROR;
+    } catch (const Xapian::Error &error) {
+       IGNORE_RESULT (asprintf (message_ptr,
+                                "A Xapian exception occurred opening database: %s\n",
+                                error.get_msg ().c_str ()));
+       return NOTMUCH_STATUS_XAPIAN_EXCEPTION;
+    }
+    return NOTMUCH_STATUS_SUCCESS;
+}
+
 notmuch_status_t
-notmuch_database_open_with_config (const char *database_path,
-                                  notmuch_database_mode_t mode,
-                                  const char *config_path,
-                                  const char *profile,
-                                  notmuch_database_t **database,
-                                  char **status_string)
+_notmuch_choose_xapian_path (void *ctx, const char *database_path,
+                            const char **xapian_path, char **message_ptr)
 {
-    notmuch_status_t status = NOTMUCH_STATUS_SUCCESS;
-    void *local = talloc_new (NULL);
-    notmuch_database_t *notmuch = NULL;
-    char *notmuch_path, *incompat_features;
-    char *message = NULL;
-    struct stat st;
-    int err;
-    unsigned int version;
-    GKeyFile *key_file = NULL;
-    static int initialized = 0;
+    notmuch_status_t status;
+    const char *trial_path, *notmuch_path;
 
-    notmuch = _alloc_notmuch ();
-    if (! notmuch) {
-       status = NOTMUCH_STATUS_OUT_OF_MEMORY;
+    status = _db_dir_exists (database_path, message_ptr);
+    if (status)
        goto DONE;
-    }
 
-    if ((status = _choose_database_path (local, config_path, profile,
-                                        &key_file, &database_path, &message)))
+    trial_path = talloc_asprintf (ctx, "%s/xapian", database_path);
+    status = _trial_open (trial_path, message_ptr);
+    if (status != NOTMUCH_STATUS_PATH_ERROR)
        goto DONE;
 
-    notmuch->path = talloc_strdup (notmuch, database_path);
-    strip_trailing (notmuch->path, '/');
-
-    if (! (notmuch_path = talloc_asprintf (local, "%s/%s", database_path, ".notmuch"))) {
-       message = strdup ("Out of memory\n");
-       status = NOTMUCH_STATUS_OUT_OF_MEMORY;
+    notmuch_path = talloc_asprintf (ctx, "%s/.notmuch", database_path);
+    status = _db_dir_exists (notmuch_path, message_ptr);
+    if (status)
        goto DONE;
-    }
 
-    err = stat (notmuch_path, &st);
-    if (err) {
-       IGNORE_RESULT (asprintf (&message, "Error opening database at %s: %s\n",
-                                notmuch_path, strerror (errno)));
-       status = NOTMUCH_STATUS_FILE_ERROR;
-       goto DONE;
-    }
+    trial_path = talloc_asprintf (ctx, "%s/xapian", notmuch_path);
+    status = _trial_open (trial_path, message_ptr);
 
-    if (! (notmuch->xapian_path = talloc_asprintf (notmuch, "%s/%s", notmuch_path, "xapian"))) {
-       message = strdup ("Out of memory\n");
-       status = NOTMUCH_STATUS_OUT_OF_MEMORY;
-       goto DONE;
-    }
+  DONE:
+    if (status == NOTMUCH_STATUS_SUCCESS)
+       *xapian_path = trial_path;
+    return status;
+}
+
+static void
+_set_database_path (notmuch_database_t *notmuch,
+                   const char *database_path)
+{
+    char *path = talloc_strdup (notmuch, database_path);
+
+    strip_trailing (path, '/');
+
+    _notmuch_config_cache (notmuch, NOTMUCH_CONFIG_DATABASE_PATH, path);
+}
+
+static void
+_init_libs ()
+{
+
+    static int initialized = 0;
 
     /* Initialize the GLib type system and threads */
 #if ! GLIB_CHECK_VERSION (2, 35, 1)
@@ -271,6 +321,20 @@ notmuch_database_open_with_config (const char *database_path,
        g_mime_init ();
        initialized = 1;
     }
+}
+
+static notmuch_status_t
+_finish_open (notmuch_database_t *notmuch,
+             const char *profile,
+             notmuch_database_mode_t mode,
+             GKeyFile *key_file,
+             char **message_ptr)
+{
+    notmuch_status_t status = NOTMUCH_STATUS_SUCCESS;
+    char *incompat_features;
+    char *message = NULL;
+    unsigned int version;
+    const char *database_path = notmuch_database_get_path (notmuch);
 
     try {
        std::string last_thread_id;
@@ -293,7 +357,7 @@ notmuch_database_open_with_config (const char *database_path,
                                     "Error: Notmuch database at %s\n"
                                     "       has a newer database format version (%u) than supported by this\n"
                                     "       version of notmuch (%u).\n",
-                                    notmuch_path, version, NOTMUCH_DATABASE_VERSION));
+                                    database_path, version, NOTMUCH_DATABASE_VERSION));
            notmuch_database_destroy (notmuch);
            notmuch = NULL;
            status = NOTMUCH_STATUS_FILE_ERROR;
@@ -303,7 +367,7 @@ notmuch_database_open_with_config (const char *database_path,
        /* Check features. */
        incompat_features = NULL;
        notmuch->features = _notmuch_database_parse_features (
-           local, notmuch->xapian_db->get_metadata ("features").c_str (),
+           notmuch, notmuch->xapian_db->get_metadata ("features").c_str (),
            version, mode == NOTMUCH_DATABASE_MODE_READ_WRITE ? 'w' : 'r',
            &incompat_features);
        if (incompat_features) {
@@ -311,7 +375,7 @@ notmuch_database_open_with_config (const char *database_path,
                                     "Error: Notmuch database at %s\n"
                                     "       requires features (%s)\n"
                                     "       not supported by this version of notmuch.\n",
-                                    notmuch_path, incompat_features));
+                                    database_path, incompat_features));
            notmuch_database_destroy (notmuch);
            notmuch = NULL;
            status = NOTMUCH_STATUS_FILE_ERROR;
@@ -368,10 +432,23 @@ notmuch_database_open_with_config (const char *database_path,
        if (status)
            goto DONE;
 
-       status = _choose_hook_dir (notmuch, profile, &message);
+       status = _choose_dir (notmuch, profile,
+                             NOTMUCH_CONFIG_HOOK_DIR,
+                             "XDG_CONFIG_HOME",
+                             ".config",
+                             "hooks",
+                             &message);
        if (status)
            goto DONE;
 
+       status = _choose_dir (notmuch, profile,
+                             NOTMUCH_CONFIG_BACKUP_DIR,
+                             "XDG_DATA_HOME",
+                             ".local/share",
+                             "backups",
+                             &message);
+       if (status)
+           goto DONE;
        status = _notmuch_config_load_defaults (notmuch);
        if (status)
            goto DONE;
@@ -391,6 +468,52 @@ notmuch_database_open_with_config (const char *database_path,
        notmuch = NULL;
        status = NOTMUCH_STATUS_XAPIAN_EXCEPTION;
     }
+  DONE:
+    if (message_ptr)
+       *message_ptr = message;
+    return status;
+}
+
+notmuch_status_t
+notmuch_database_open_with_config (const char *database_path,
+                                  notmuch_database_mode_t mode,
+                                  const char *config_path,
+                                  const char *profile,
+                                  notmuch_database_t **database,
+                                  char **status_string)
+{
+    notmuch_status_t status = NOTMUCH_STATUS_SUCCESS;
+    void *local = talloc_new (NULL);
+    notmuch_database_t *notmuch = NULL;
+    char *message = NULL;
+    GKeyFile *key_file = NULL;
+    bool split = false;
+
+    _init_libs ();
+
+    notmuch = _alloc_notmuch ();
+    if (! notmuch) {
+       status = NOTMUCH_STATUS_OUT_OF_MEMORY;
+       goto DONE;
+    }
+
+    if ((status = _choose_database_path (local, config_path, profile,
+                                        &key_file, &database_path, &split,
+                                        &message)))
+       goto DONE;
+
+    status = _db_dir_exists (database_path, &message);
+    if (status)
+       goto DONE;
+
+    _set_database_path (notmuch, database_path);
+
+    status = _notmuch_choose_xapian_path (notmuch, database_path,
+                                         &notmuch->xapian_path, &message);
+    if (status)
+       goto DONE;
+
+    status = _finish_open (notmuch, profile, mode, key_file, &message);
 
   DONE:
     talloc_free (local);
@@ -450,53 +573,86 @@ 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;
-    struct stat st;
-    int err;
     void *local = talloc_new (NULL);
+    int err;
+    bool split = false;
 
-    if ((status = _choose_database_path (local, config_path, profile,
-                                        &key_file, &database_path, &message)))
-       goto DONE;
+    _init_libs ();
 
-    err = stat (database_path, &st);
-    if (err) {
-       IGNORE_RESULT (asprintf (&message, "Error: Cannot create database at %s: %s.\n",
-                                database_path, strerror (errno)));
-       status = NOTMUCH_STATUS_FILE_ERROR;
+    notmuch = _alloc_notmuch ();
+    if (! notmuch) {
+       status = NOTMUCH_STATUS_OUT_OF_MEMORY;
        goto DONE;
     }
 
-    if (! S_ISDIR (st.st_mode)) {
-       IGNORE_RESULT (asprintf (&message, "Error: Cannot create database at %s: "
-                                "Not a directory.\n",
-                                database_path));
-       status = NOTMUCH_STATUS_FILE_ERROR;
+    _init_libs ();
+
+    if ((status = _choose_database_path (local, config_path, profile,
+                                        &key_file, &database_path, &split,
+                                        &message)))
        goto DONE;
+
+    status = _db_dir_exists (database_path, &message);
+    if (status)
+       goto DONE;
+
+    _set_database_path (notmuch, database_path);
+
+    if (key_file && ! split) {
+       char *mail_root = canonicalize_file_name (
+           g_key_file_get_value (key_file, "database", "mail_root", NULL));
+       char *db_path = canonicalize_file_name (database_path);
+
+       split = (mail_root && (0 != strcmp (mail_root, db_path)));
+
+       free (mail_root);
+       free (db_path);
     }
 
-    notmuch_path = talloc_asprintf (local, "%s/%s", database_path, ".notmuch");
+    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;
+       }
 
-    err = mkdir (notmuch_path, 0755);
-    if (err) {
-       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;
+       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;
+    }
+
+    status = _trial_open (notmuch->xapian_path, &message);
+    if (status == NOTMUCH_STATUS_SUCCESS) {
+       notmuch_database_destroy (notmuch);
+       notmuch = NULL;
+       status = NOTMUCH_STATUS_DATABASE_EXISTS;
        goto DONE;
     }
 
-    /* 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,
-                                               &notmuch, &message);
+    status = _finish_open (notmuch,
+                          profile,
+                          NOTMUCH_DATABASE_MODE_READ_WRITE,
+                          key_file,
+                          &message);
     if (status)
        goto DONE;