]> git.notmuchmail.org Git - notmuch/blobdiff - lib/open.cc
lib/open: support XDG_DATA_HOME as a fallback database location.
[notmuch] / lib / open.cc
index ad74ccd6f0ee3a1fceba16aedd026bf27689e4ea..25691a8ac6df76de11ad024d701d474d393cdae9 100644 (file)
@@ -68,6 +68,44 @@ _xdg_dir (void *ctx,
                            profile_name);
 }
 
+static notmuch_status_t
+_choose_hook_dir (notmuch_database_t *notmuch,
+                 const char *profile,
+                 char **message)
+{
+    const char *config;
+    const char *hook_dir;
+    struct stat st;
+    int err;
+
+    hook_dir = notmuch_config_get (notmuch, NOTMUCH_CONFIG_HOOK_DIR);
+
+    if (hook_dir)
+       return NOTMUCH_STATUS_SUCCESS;
+
+    config = _xdg_dir (notmuch, "XDG_CONFIG_HOME", ".config", profile);
+    if (! config)
+       return NOTMUCH_STATUS_PATH_ERROR;
+
+    hook_dir = talloc_asprintf (notmuch, "%s/hooks", config);
+
+    err = stat (hook_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);
+       } else {
+           IGNORE_RESULT (asprintf (message, "Error: Cannot stat %s: %s.\n",
+                                    hook_dir, strerror (errno)));
+           return NOTMUCH_STATUS_FILE_ERROR;
+       }
+    }
+
+    _notmuch_config_cache (notmuch, NOTMUCH_CONFIG_HOOK_DIR, hook_dir);
+
+    return NOTMUCH_STATUS_SUCCESS;
+}
+
 static notmuch_status_t
 _load_key_file (const char *path,
                const char *profile,
@@ -87,7 +125,7 @@ _load_key_file (const char *path,
 
        if (dir) {
            path = talloc_asprintf (local, "%s/config", dir);
-           if (access (path, R_OK) !=0)
+           if (access (path, R_OK) != 0)
                path = NULL;
        }
     }
@@ -106,73 +144,166 @@ _load_key_file (const char *path,
 
     *key_file = g_key_file_new ();
     if (! g_key_file_load_from_file (*key_file, path, G_KEY_FILE_NONE, NULL)) {
-       status = NOTMUCH_STATUS_FILE_ERROR;
+       status = NOTMUCH_STATUS_NO_CONFIG;
     }
 
-DONE:
+  DONE:
     talloc_free (local);
     return status;
 }
 
-notmuch_status_t
-notmuch_database_open_with_config (const char *database_path,
-                                  notmuch_database_mode_t mode,
-                                  const char *config_path,
-                                  unused(const char *profile),
-                                  notmuch_database_t **database,
-                                  char **status_string)
+static notmuch_status_t
+_db_dir_exists (const char *database_path, char **message)
 {
-    notmuch_status_t status = NOTMUCH_STATUS_SUCCESS;
-    void *local = talloc_new (NULL);
-    notmuch_database_t *notmuch = NULL;
-    char *notmuch_path, *xapian_path, *incompat_features;
-    char *message = NULL;
     struct stat st;
     int err;
-    unsigned int version;
-    GKeyFile *key_file = NULL;
-    static int initialized = 0;
 
-    status = _load_key_file (config_path, profile, &key_file);
+    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;
+
+    status = _load_key_file (config_path, profile, key_file);
     if (status) {
-       message = strdup ("Error: cannot load config file");
-       goto DONE;
+       *message = strdup ("Error: cannot load config file.\n");
+       return status;
     }
-       
-    if (! database_path && key_file)
-       database_path = g_key_file_get_value (key_file, "database", "path", NULL);
 
-    if (database_path == NULL) {
-       message = strdup ("Error: Cannot open a database for a NULL path.\n");
-       status = NOTMUCH_STATUS_NULL_POINTER;
-       goto DONE;
+    if (! *database_path) {
+       *database_path = getenv ("NOTMUCH_DATABASE");
     }
 
-    if (database_path[0] != '/') {
-       message = strdup ("Error: Database path must be absolute.\n");
-       status = NOTMUCH_STATUS_PATH_ERROR;
-       goto DONE;
+    if (! *database_path && *key_file) {
+       char *path = g_key_file_get_value (*key_file, "database", "path", NULL);
+       if (path) {
+           *database_path = talloc_strdup (ctx, path);
+           g_free (path);
+       }
     }
 
-    if (! (notmuch_path = talloc_asprintf (local, "%s/%s", database_path, ".notmuch"))) {
-       message = strdup ("Out of memory\n");
-       status = NOTMUCH_STATUS_OUT_OF_MEMORY;
-       goto DONE;
+    if (! *database_path) {
+       *database_path = _xdg_dir (ctx, "XDG_DATA_HOME", ".local/share", profile);
+       *split = true;
     }
 
-    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;
+    if (*database_path == NULL) {
+       *message = strdup ("Error: Cannot open a database for a NULL path.\n");
+       return NOTMUCH_STATUS_NULL_POINTER;
     }
 
-    if (! (xapian_path = talloc_asprintf (local, "%s/%s", notmuch_path, "xapian"))) {
-       message = strdup ("Out of memory\n");
-       status = NOTMUCH_STATUS_OUT_OF_MEMORY;
-       goto DONE;
+    if (*database_path[0] != '/') {
+       *message = strdup ("Error: Database path must be absolute.\n");
+       return NOTMUCH_STATUS_PATH_ERROR;
+    }
+    return NOTMUCH_STATUS_SUCCESS;
+}
+
+notmuch_database_t *
+_alloc_notmuch ()
+{
+    notmuch_database_t *notmuch;
+
+    notmuch = talloc_zero (NULL, notmuch_database_t);
+    if (! notmuch)
+       return NULL;
+
+    notmuch->exception_reported = false;
+    notmuch->status_string = NULL;
+    notmuch->writable_xapian_db = NULL;
+    notmuch->atomic_nesting = 0;
+    notmuch->view = 1;
+    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;
+}
+
+static notmuch_status_t
+_choose_xapian_path (void *ctx, const char *database_path, const char **xapian_path,
+                    char **message_ptr)
+{
+    notmuch_status_t status;
+    const char *trial_path, *notmuch_path;
+
+    status = _db_dir_exists (database_path, message_ptr);
+    if (status)
+       goto DONE;
+
+    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_asprintf (ctx, "%s/.notmuch", database_path);
+    status = _db_dir_exists (notmuch_path, message_ptr);
+    if (status)
+       goto DONE;
+
+    trial_path = talloc_asprintf (ctx, "%s/xapian", notmuch_path);
+    status = _trial_open (trial_path, message_ptr);
+
+  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)
@@ -184,27 +315,31 @@ notmuch_database_open_with_config (const char *database_path,
        g_mime_init ();
        initialized = 1;
     }
+}
 
-    notmuch = talloc_zero (NULL, notmuch_database_t);
-    notmuch->exception_reported = false;
-    notmuch->status_string = NULL;
-    notmuch->path = talloc_strdup (notmuch, database_path);
-
-    strip_trailing (notmuch->path, '/');
+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);
 
-    notmuch->writable_xapian_db = NULL;
-    notmuch->atomic_nesting = 0;
-    notmuch->view = 1;
     try {
        std::string last_thread_id;
        std::string last_mod;
 
        if (mode == NOTMUCH_DATABASE_MODE_READ_WRITE) {
-           notmuch->writable_xapian_db = new Xapian::WritableDatabase (xapian_path,
+           notmuch->writable_xapian_db = new Xapian::WritableDatabase (notmuch->xapian_path,
                                                                        DB_ACTION);
            notmuch->xapian_db = notmuch->writable_xapian_db;
        } else {
-           notmuch->xapian_db = new Xapian::Database (xapian_path);
+           notmuch->xapian_db = new Xapian::Database (notmuch->xapian_path);
        }
 
        /* Check version.  As of database version 3, we represent
@@ -216,7 +351,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;
@@ -226,7 +361,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) {
@@ -234,7 +369,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;
@@ -269,8 +404,10 @@ notmuch_database_open_with_config (const char *database_path,
        notmuch->term_gen = new Xapian::TermGenerator;
        notmuch->term_gen->set_stemmer (Xapian::Stem ("english"));
        notmuch->value_range_processor = new Xapian::NumberRangeProcessor (NOTMUCH_VALUE_TIMESTAMP);
-       notmuch->date_range_processor = new ParseTimeRangeProcessor (NOTMUCH_VALUE_TIMESTAMP, "date:");
-       notmuch->last_mod_range_processor = new Xapian::NumberRangeProcessor (NOTMUCH_VALUE_LAST_MOD, "lastmod:");
+       notmuch->date_range_processor = new ParseTimeRangeProcessor (NOTMUCH_VALUE_TIMESTAMP,
+                                                                    "date:");
+       notmuch->last_mod_range_processor = new Xapian::NumberRangeProcessor (NOTMUCH_VALUE_LAST_MOD,
+                                                                             "lastmod:");
        notmuch->query_parser->set_default_op (Xapian::Query::OP_AND);
        notmuch->query_parser->set_database (*notmuch->xapian_db);
        notmuch->query_parser->set_stemmer (Xapian::Stem ("english"));
@@ -289,6 +426,10 @@ notmuch_database_open_with_config (const char *database_path,
        if (status)
            goto DONE;
 
+       status = _choose_hook_dir (notmuch, profile, &message);
+       if (status)
+           goto DONE;
+
        status = _notmuch_config_load_defaults (notmuch);
        if (status)
            goto DONE;
@@ -308,10 +449,58 @@ 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 = _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);
 
+    if (key_file)
+       g_key_file_free (key_file);
+
     if (message) {
        if (status_string)
            *status_string = message;
@@ -329,3 +518,197 @@ notmuch_database_open_with_config (const char *database_path,
 
     return status;
 }
+
+notmuch_status_t
+notmuch_database_create (const char *path, notmuch_database_t **database)
+{
+    char *status_string = NULL;
+    notmuch_status_t status;
+
+    status = notmuch_database_create_verbose (path, database,
+                                             &status_string);
+
+    if (status_string) {
+       fputs (status_string, stderr);
+       free (status_string);
+    }
+
+    return status;
+}
+
+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;
+    const char *notmuch_path = NULL;
+    char *message = NULL;
+    GKeyFile *key_file = NULL;
+    void *local = talloc_new (NULL);
+    int err;
+    bool split = false;
+
+    _init_libs ();
+
+    notmuch = _alloc_notmuch ();
+    if (! notmuch) {
+       status = NOTMUCH_STATUS_OUT_OF_MEMORY;
+       goto DONE;
+    }
+
+    _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);
+    }
+
+    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;
+               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;
+    }
+
+    status = _finish_open (notmuch,
+                          profile,
+                          NOTMUCH_DATABASE_MODE_READ_WRITE,
+                          key_file,
+                          &message);
+    if (status)
+       goto DONE;
+
+    /* Upgrade doesn't add these feature to existing databases, but
+     * new databases have them. */
+    notmuch->features |= NOTMUCH_FEATURE_FROM_SUBJECT_ID_VALUES;
+    notmuch->features |= NOTMUCH_FEATURE_INDEXED_MIMETYPES;
+    notmuch->features |= NOTMUCH_FEATURE_UNPREFIX_BODY_ONLY;
+
+    status = notmuch_database_upgrade (notmuch, NULL, NULL);
+    if (status) {
+       notmuch_database_close (notmuch);
+       notmuch = NULL;
+    }
+
+  DONE:
+    talloc_free (local);
+
+    if (key_file)
+       g_key_file_free (key_file);
+
+    if (message) {
+       if (status_string)
+           *status_string = message;
+       else
+           free (message);
+    }
+    if (database)
+       *database = notmuch;
+    else
+       talloc_free (notmuch);
+    return status;
+}
+
+notmuch_status_t
+notmuch_database_reopen (notmuch_database_t *notmuch,
+                        notmuch_database_mode_t new_mode)
+{
+    notmuch_database_mode_t cur_mode = _notmuch_database_mode (notmuch);
+
+    if (notmuch->xapian_db == NULL) {
+       _notmuch_database_log (notmuch, "Cannot reopen closed or nonexistent database\n");
+       return NOTMUCH_STATUS_ILLEGAL_ARGUMENT;
+    }
+
+    try {
+       if (cur_mode == new_mode &&
+           new_mode == NOTMUCH_DATABASE_MODE_READ_ONLY) {
+           notmuch->xapian_db->reopen ();
+       } else {
+           notmuch->xapian_db->close ();
+
+           delete notmuch->xapian_db;
+           notmuch->xapian_db = NULL;
+           /* no need to free the same object twice */
+           notmuch->writable_xapian_db = NULL;
+
+           if (new_mode == NOTMUCH_DATABASE_MODE_READ_WRITE) {
+               notmuch->writable_xapian_db = new Xapian::WritableDatabase (notmuch->xapian_path,
+                                                                           DB_ACTION);
+               notmuch->xapian_db = notmuch->writable_xapian_db;
+           } else {
+               notmuch->xapian_db = new Xapian::Database (notmuch->xapian_path,
+                                                          DB_ACTION);
+           }
+       }
+    } catch (const Xapian::Error &error) {
+       if (! notmuch->exception_reported) {
+           _notmuch_database_log (notmuch, "Error: A Xapian exception reopening database: %s\n",
+                                  error.get_msg ().c_str ());
+           notmuch->exception_reported = true;
+       }
+       return NOTMUCH_STATUS_XAPIAN_EXCEPTION;
+    }
+
+    notmuch->view++;
+    notmuch->open = true;
+    return NOTMUCH_STATUS_SUCCESS;
+}