4 #include "database-private.h"
5 #include "parse-time-vrp.h"
8 #if HAVE_XAPIAN_DB_RETRY_LOCK
9 #define DB_ACTION (Xapian::DB_CREATE_OR_OPEN | Xapian::DB_RETRY_LOCK)
11 #define DB_ACTION Xapian::DB_CREATE_OR_OPEN
15 notmuch_database_open (const char *path,
16 notmuch_database_mode_t mode,
17 notmuch_database_t **database)
19 char *status_string = NULL;
20 notmuch_status_t status;
22 status = notmuch_database_open_verbose (path, mode, database,
26 fputs (status_string, stderr);
34 notmuch_database_open_verbose (const char *path,
35 notmuch_database_mode_t mode,
36 notmuch_database_t **database,
39 return notmuch_database_open_with_config (path, mode, "", NULL,
40 database, status_string);
45 const char *xdg_root_variable,
46 const char *xdg_prefix,
47 const char *profile_name)
49 const char *xdg_root = getenv (xdg_root_variable);
52 const char *home = getenv ("HOME");
54 if (! home) return NULL;
56 xdg_root = talloc_asprintf (ctx,
63 profile_name = getenv ("NOTMUCH_PROFILE");
66 profile_name = "default";
68 return talloc_asprintf (ctx,
74 static notmuch_status_t
75 _choose_dir (notmuch_database_t *notmuch,
77 notmuch_config_key_t key,
79 const char *xdg_subdir,
81 char **message = NULL)
88 dir = notmuch_config_get (notmuch, key);
91 return NOTMUCH_STATUS_SUCCESS;
93 parent = _xdg_dir (notmuch, xdg_var, xdg_subdir, profile);
95 return NOTMUCH_STATUS_PATH_ERROR;
97 dir = talloc_asprintf (notmuch, "%s/%s", parent, subdir);
99 err = stat (dir, &st);
101 if (errno == ENOENT) {
102 char *notmuch_path = dirname (talloc_strdup (notmuch, notmuch->xapian_path));
103 dir = talloc_asprintf (notmuch, "%s/%s", notmuch_path, subdir);
105 IGNORE_RESULT (asprintf (message, "Error: Cannot stat %s: %s.\n",
106 dir, strerror (errno)));
107 return NOTMUCH_STATUS_FILE_ERROR;
111 _notmuch_config_cache (notmuch, key, dir);
113 return NOTMUCH_STATUS_SUCCESS;
116 static notmuch_status_t
117 _load_key_file (notmuch_database_t *notmuch,
122 notmuch_status_t status = NOTMUCH_STATUS_SUCCESS;
124 if (path && EMPTY_STRING (path))
128 path = getenv ("NOTMUCH_CONFIG");
131 path = talloc_strdup (notmuch, path);
133 const char *dir = _xdg_dir (notmuch, "XDG_CONFIG_HOME", ".config", profile);
136 path = talloc_asprintf (notmuch, "%s/config", dir);
137 if (access (path, R_OK) != 0)
143 const char *home = getenv ("HOME");
145 path = talloc_asprintf (notmuch, "%s/.notmuch-config", home);
148 profile = getenv ("NOTMUCH_PROFILE");
151 path = talloc_asprintf (notmuch, "%s.%s", path, profile);
154 *key_file = g_key_file_new ();
155 if (! g_key_file_load_from_file (*key_file, path, G_KEY_FILE_NONE, NULL)) {
156 status = NOTMUCH_STATUS_NO_CONFIG;
161 notmuch->config_path = path;
166 static notmuch_status_t
167 _db_dir_exists (const char *database_path, char **message)
172 err = stat (database_path, &st);
174 IGNORE_RESULT (asprintf (message, "Error: Cannot open database at %s: %s.\n",
175 database_path, strerror (errno)));
176 return NOTMUCH_STATUS_FILE_ERROR;
179 if (! S_ISDIR (st.st_mode)) {
180 IGNORE_RESULT (asprintf (message, "Error: Cannot open database at %s: "
181 "Not a directory.\n",
183 return NOTMUCH_STATUS_FILE_ERROR;
186 return NOTMUCH_STATUS_SUCCESS;
189 static notmuch_status_t
190 _choose_database_path (void *ctx,
193 const char **database_path,
197 if (! *database_path) {
198 *database_path = getenv ("NOTMUCH_DATABASE");
201 if (! *database_path && key_file) {
202 char *path = g_key_file_get_value (key_file, "database", "path", NULL);
205 *database_path = talloc_strdup (ctx, path);
207 *database_path = talloc_asprintf (ctx, "%s/%s", getenv ("HOME"), path);
211 if (! *database_path) {
212 *database_path = _xdg_dir (ctx, "XDG_DATA_HOME", ".local/share", profile);
216 if (*database_path == NULL) {
217 *message = strdup ("Error: could not locate database.\n");
218 return NOTMUCH_STATUS_NO_DATABASE;
221 if (*database_path[0] != '/') {
222 *message = strdup ("Error: Database path must be absolute.\n");
223 return NOTMUCH_STATUS_PATH_ERROR;
225 return NOTMUCH_STATUS_SUCCESS;
231 notmuch_database_t *notmuch;
233 notmuch = talloc_zero (NULL, notmuch_database_t);
237 notmuch->exception_reported = false;
238 notmuch->status_string = NULL;
239 notmuch->writable_xapian_db = NULL;
240 notmuch->config_path = NULL;
241 notmuch->atomic_nesting = 0;
246 static notmuch_status_t
247 _trial_open (const char *xapian_path, char **message_ptr)
250 Xapian::Database db (xapian_path);
251 } catch (const Xapian::DatabaseOpeningError &error) {
252 IGNORE_RESULT (asprintf (message_ptr,
253 "Cannot open Xapian database at %s: %s\n",
255 error.get_msg ().c_str ()));
256 return NOTMUCH_STATUS_PATH_ERROR;
257 } catch (const Xapian::Error &error) {
258 IGNORE_RESULT (asprintf (message_ptr,
259 "A Xapian exception occurred opening database: %s\n",
260 error.get_msg ().c_str ()));
261 return NOTMUCH_STATUS_XAPIAN_EXCEPTION;
263 return NOTMUCH_STATUS_SUCCESS;
267 _notmuch_choose_xapian_path (void *ctx, const char *database_path,
268 const char **xapian_path, char **message_ptr)
270 notmuch_status_t status;
271 const char *trial_path, *notmuch_path;
273 status = _db_dir_exists (database_path, message_ptr);
277 trial_path = talloc_asprintf (ctx, "%s/xapian", database_path);
278 status = _trial_open (trial_path, message_ptr);
279 if (status != NOTMUCH_STATUS_PATH_ERROR)
285 notmuch_path = talloc_asprintf (ctx, "%s/.notmuch", database_path);
286 status = _db_dir_exists (notmuch_path, message_ptr);
290 trial_path = talloc_asprintf (ctx, "%s/xapian", notmuch_path);
291 status = _trial_open (trial_path, message_ptr);
294 if (status == NOTMUCH_STATUS_SUCCESS)
295 *xapian_path = trial_path;
300 _set_database_path (notmuch_database_t *notmuch,
301 const char *database_path)
303 char *path = talloc_strdup (notmuch, database_path);
305 strip_trailing (path, '/');
307 _notmuch_config_cache (notmuch, NOTMUCH_CONFIG_DATABASE_PATH, path);
314 static int initialized = 0;
316 /* Initialize the GLib type system and threads */
317 #if ! GLIB_CHECK_VERSION (2, 35, 1)
321 /* Initialize gmime */
328 static notmuch_status_t
329 _finish_open (notmuch_database_t *notmuch,
331 notmuch_database_mode_t mode,
335 notmuch_status_t status = NOTMUCH_STATUS_SUCCESS;
336 char *incompat_features;
337 char *message = NULL;
338 unsigned int version;
339 const char *database_path = notmuch_database_get_path (notmuch);
342 std::string last_thread_id;
343 std::string last_mod;
345 if (mode == NOTMUCH_DATABASE_MODE_READ_WRITE) {
346 notmuch->writable_xapian_db = new Xapian::WritableDatabase (notmuch->xapian_path,
348 notmuch->xapian_db = notmuch->writable_xapian_db;
350 notmuch->xapian_db = new Xapian::Database (notmuch->xapian_path);
353 /* Check version. As of database version 3, we represent
354 * changes in terms of features, so assume a version bump
355 * means a dramatically incompatible change. */
356 version = notmuch_database_get_version (notmuch);
357 if (version > NOTMUCH_DATABASE_VERSION) {
358 IGNORE_RESULT (asprintf (&message,
359 "Error: Notmuch database at %s\n"
360 " has a newer database format version (%u) than supported by this\n"
361 " version of notmuch (%u).\n",
362 database_path, version, NOTMUCH_DATABASE_VERSION));
363 notmuch_database_destroy (notmuch);
365 status = NOTMUCH_STATUS_FILE_ERROR;
369 /* Check features. */
370 incompat_features = NULL;
371 notmuch->features = _notmuch_database_parse_features (
372 notmuch, notmuch->xapian_db->get_metadata ("features").c_str (),
373 version, mode == NOTMUCH_DATABASE_MODE_READ_WRITE ? 'w' : 'r',
375 if (incompat_features) {
376 IGNORE_RESULT (asprintf (&message,
377 "Error: Notmuch database at %s\n"
378 " requires features (%s)\n"
379 " not supported by this version of notmuch.\n",
380 database_path, incompat_features));
381 notmuch_database_destroy (notmuch);
383 status = NOTMUCH_STATUS_FILE_ERROR;
387 notmuch->last_doc_id = notmuch->xapian_db->get_lastdocid ();
388 last_thread_id = notmuch->xapian_db->get_metadata ("last_thread_id");
389 if (last_thread_id.empty ()) {
390 notmuch->last_thread_id = 0;
395 str = last_thread_id.c_str ();
396 notmuch->last_thread_id = strtoull (str, &end, 16);
398 INTERNAL_ERROR ("Malformed database last_thread_id: %s", str);
401 /* Get current highest revision number. */
402 last_mod = notmuch->xapian_db->get_value_upper_bound (
403 NOTMUCH_VALUE_LAST_MOD);
404 if (last_mod.empty ())
405 notmuch->revision = 0;
407 notmuch->revision = Xapian::sortable_unserialise (last_mod);
408 notmuch->uuid = talloc_strdup (
409 notmuch, notmuch->xapian_db->get_uuid ().c_str ());
411 notmuch->query_parser = new Xapian::QueryParser;
412 notmuch->term_gen = new Xapian::TermGenerator;
413 notmuch->term_gen->set_stemmer (Xapian::Stem ("english"));
414 notmuch->value_range_processor = new Xapian::NumberRangeProcessor (NOTMUCH_VALUE_TIMESTAMP);
415 notmuch->date_range_processor = new ParseTimeRangeProcessor (NOTMUCH_VALUE_TIMESTAMP,
417 notmuch->last_mod_range_processor = new Xapian::NumberRangeProcessor (NOTMUCH_VALUE_LAST_MOD,
419 notmuch->query_parser->set_default_op (Xapian::Query::OP_AND);
420 notmuch->query_parser->set_database (*notmuch->xapian_db);
421 notmuch->query_parser->set_stemmer (Xapian::Stem ("english"));
422 notmuch->query_parser->set_stemming_strategy (Xapian::QueryParser::STEM_SOME);
423 notmuch->query_parser->add_rangeprocessor (notmuch->value_range_processor);
424 notmuch->query_parser->add_rangeprocessor (notmuch->date_range_processor);
425 notmuch->query_parser->add_rangeprocessor (notmuch->last_mod_range_processor);
427 /* Configuration information is needed to set up query parser */
428 status = _notmuch_config_load_from_database (notmuch);
433 status = _notmuch_config_load_from_file (notmuch, key_file);
437 status = _choose_dir (notmuch, profile,
438 NOTMUCH_CONFIG_HOOK_DIR,
446 status = _choose_dir (notmuch, profile,
447 NOTMUCH_CONFIG_BACKUP_DIR,
454 status = _notmuch_config_load_defaults (notmuch);
458 status = _notmuch_database_setup_standard_query_fields (notmuch);
462 status = _notmuch_database_setup_user_query_fields (notmuch);
466 } catch (const Xapian::Error &error) {
467 IGNORE_RESULT (asprintf (&message, "A Xapian exception occurred opening database: %s\n",
468 error.get_msg ().c_str ()));
469 notmuch_database_destroy (notmuch);
471 status = NOTMUCH_STATUS_XAPIAN_EXCEPTION;
475 *message_ptr = message;
480 notmuch_database_open_with_config (const char *database_path,
481 notmuch_database_mode_t mode,
482 const char *config_path,
484 notmuch_database_t **database,
485 char **status_string)
487 notmuch_status_t status = NOTMUCH_STATUS_SUCCESS;
488 void *local = talloc_new (NULL);
489 notmuch_database_t *notmuch = NULL;
490 char *message = NULL;
491 GKeyFile *key_file = NULL;
496 notmuch = _alloc_notmuch ();
498 status = NOTMUCH_STATUS_OUT_OF_MEMORY;
502 status = _load_key_file (notmuch, config_path, profile, &key_file);
504 message = strdup ("Error: cannot load config file.\n");
508 if ((status = _choose_database_path (local, profile, key_file,
509 &database_path, &split,
513 status = _db_dir_exists (database_path, &message);
517 _set_database_path (notmuch, database_path);
519 status = _notmuch_choose_xapian_path (notmuch, database_path,
520 ¬much->xapian_path, &message);
524 status = _finish_open (notmuch, profile, mode, key_file, &message);
530 g_key_file_free (key_file);
534 *status_string = message;
542 talloc_free (notmuch);
545 notmuch->open = true;
551 notmuch_database_create (const char *path, notmuch_database_t **database)
553 char *status_string = NULL;
554 notmuch_status_t status;
556 status = notmuch_database_create_verbose (path, database,
560 fputs (status_string, stderr);
561 free (status_string);
568 notmuch_database_create_verbose (const char *path,
569 notmuch_database_t **database,
570 char **status_string)
572 return notmuch_database_create_with_config (path, "", NULL, database, status_string);
576 notmuch_database_create_with_config (const char *database_path,
577 const char *config_path,
579 notmuch_database_t **database,
580 char **status_string)
582 notmuch_status_t status = NOTMUCH_STATUS_SUCCESS;
583 notmuch_database_t *notmuch = NULL;
584 const char *notmuch_path = NULL;
585 char *message = NULL;
586 GKeyFile *key_file = NULL;
587 void *local = talloc_new (NULL);
593 notmuch = _alloc_notmuch ();
595 status = NOTMUCH_STATUS_OUT_OF_MEMORY;
599 status = _load_key_file (notmuch, config_path, profile, &key_file);
601 message = strdup ("Error: cannot load config file.\n");
605 if ((status = _choose_database_path (local, profile, key_file,
606 &database_path, &split, &message)))
609 status = _db_dir_exists (database_path, &message);
613 _set_database_path (notmuch, database_path);
615 if (key_file && ! split) {
616 char *mail_root = notmuch_canonicalize_file_name (
617 g_key_file_get_value (key_file, "database", "mail_root", NULL));
618 char *db_path = notmuch_canonicalize_file_name (database_path);
620 split = (mail_root && (0 != strcmp (mail_root, db_path)));
627 notmuch_path = database_path;
629 if (! (notmuch_path = talloc_asprintf (local, "%s/%s", database_path, ".notmuch"))) {
630 status = NOTMUCH_STATUS_OUT_OF_MEMORY;
634 err = mkdir (notmuch_path, 0755);
636 if (errno == EEXIST) {
637 status = NOTMUCH_STATUS_DATABASE_EXISTS;
638 talloc_free (notmuch);
641 IGNORE_RESULT (asprintf (&message, "Error: Cannot create directory %s: %s.\n",
642 notmuch_path, strerror (errno)));
643 status = NOTMUCH_STATUS_FILE_ERROR;
649 if (! (notmuch->xapian_path = talloc_asprintf (notmuch, "%s/%s", notmuch_path, "xapian"))) {
650 status = NOTMUCH_STATUS_OUT_OF_MEMORY;
654 status = _trial_open (notmuch->xapian_path, &message);
655 if (status == NOTMUCH_STATUS_SUCCESS) {
656 notmuch_database_destroy (notmuch);
658 status = NOTMUCH_STATUS_DATABASE_EXISTS;
665 status = _finish_open (notmuch,
667 NOTMUCH_DATABASE_MODE_READ_WRITE,
673 /* Upgrade doesn't add these feature to existing databases, but
674 * new databases have them. */
675 notmuch->features |= NOTMUCH_FEATURE_FROM_SUBJECT_ID_VALUES;
676 notmuch->features |= NOTMUCH_FEATURE_INDEXED_MIMETYPES;
677 notmuch->features |= NOTMUCH_FEATURE_UNPREFIX_BODY_ONLY;
679 status = notmuch_database_upgrade (notmuch, NULL, NULL);
681 notmuch_database_close (notmuch);
689 g_key_file_free (key_file);
693 *status_string = message;
700 talloc_free (notmuch);
705 notmuch_database_reopen (notmuch_database_t *notmuch,
706 notmuch_database_mode_t new_mode)
708 notmuch_database_mode_t cur_mode = _notmuch_database_mode (notmuch);
710 if (notmuch->xapian_db == NULL) {
711 _notmuch_database_log (notmuch, "Cannot reopen closed or nonexistent database\n");
712 return NOTMUCH_STATUS_ILLEGAL_ARGUMENT;
716 if (cur_mode == new_mode &&
717 new_mode == NOTMUCH_DATABASE_MODE_READ_ONLY) {
718 notmuch->xapian_db->reopen ();
720 notmuch->xapian_db->close ();
722 delete notmuch->xapian_db;
723 notmuch->xapian_db = NULL;
724 /* no need to free the same object twice */
725 notmuch->writable_xapian_db = NULL;
727 if (new_mode == NOTMUCH_DATABASE_MODE_READ_WRITE) {
728 notmuch->writable_xapian_db = new Xapian::WritableDatabase (notmuch->xapian_path,
730 notmuch->xapian_db = notmuch->writable_xapian_db;
732 notmuch->xapian_db = new Xapian::Database (notmuch->xapian_path,
736 } catch (const Xapian::Error &error) {
737 if (! notmuch->exception_reported) {
738 _notmuch_database_log (notmuch, "Error: A Xapian exception reopening database: %s\n",
739 error.get_msg ().c_str ());
740 notmuch->exception_reported = true;
742 return NOTMUCH_STATUS_XAPIAN_EXCEPTION;
746 notmuch->open = true;
747 return NOTMUCH_STATUS_SUCCESS;
751 _maybe_load_config_from_database (notmuch_database_t *notmuch,
753 const char *database_path,
756 char *message; /* ignored */
758 if (_db_dir_exists (database_path, &message))
759 return NOTMUCH_STATUS_NO_DATABASE;
761 _set_database_path (notmuch, database_path);
763 if (_notmuch_choose_xapian_path (notmuch, database_path, ¬much->xapian_path, &message))
764 return NOTMUCH_STATUS_NO_DATABASE;
766 (void) _finish_open (notmuch, profile, NOTMUCH_DATABASE_MODE_READ_ONLY, key_file, &message);
768 return NOTMUCH_STATUS_SUCCESS;
772 notmuch_database_load_config (const char *database_path,
773 const char *config_path,
775 notmuch_database_t **database,
776 char **status_string)
778 notmuch_status_t status = NOTMUCH_STATUS_SUCCESS, warning = NOTMUCH_STATUS_SUCCESS;
779 void *local = talloc_new (NULL);
780 notmuch_database_t *notmuch = NULL;
781 char *message = NULL;
782 GKeyFile *key_file = NULL;
787 notmuch = _alloc_notmuch ();
789 status = NOTMUCH_STATUS_OUT_OF_MEMORY;
793 status = _load_key_file (notmuch, config_path, profile, &key_file);
795 case NOTMUCH_STATUS_SUCCESS:
797 case NOTMUCH_STATUS_NO_CONFIG:
801 message = strdup ("Error: cannot load config file.\n");
805 status = _choose_database_path (local, profile, key_file,
806 &database_path, &split, &message);
808 case NOTMUCH_STATUS_NO_DATABASE:
809 case NOTMUCH_STATUS_SUCCESS:
819 status = _maybe_load_config_from_database (notmuch, key_file, database_path, profile);
821 case NOTMUCH_STATUS_NO_DATABASE:
822 case NOTMUCH_STATUS_SUCCESS:
832 status = _notmuch_config_load_from_file (notmuch, key_file);
836 status = _notmuch_config_load_defaults (notmuch);
844 *status_string = message;