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 notmuch_status_t status;
214 *database_path = _xdg_dir (ctx, "XDG_DATA_HOME", ".local/share", profile);
215 status = _db_dir_exists (*database_path, message);
217 *database_path = NULL;
223 if (! *database_path) {
224 notmuch_status_t status;
226 *database_path = talloc_asprintf (ctx, "%s/mail", getenv ("HOME"));
227 status = _db_dir_exists (*database_path, message);
229 *database_path = NULL;
233 if (*database_path == NULL) {
234 *message = strdup ("Error: could not locate database.\n");
235 return NOTMUCH_STATUS_NO_DATABASE;
238 if (*database_path[0] != '/') {
239 *message = strdup ("Error: Database path must be absolute.\n");
240 return NOTMUCH_STATUS_PATH_ERROR;
242 return NOTMUCH_STATUS_SUCCESS;
245 static notmuch_database_t *
248 notmuch_database_t *notmuch;
250 notmuch = talloc_zero (NULL, notmuch_database_t);
254 notmuch->exception_reported = false;
255 notmuch->status_string = NULL;
256 notmuch->writable_xapian_db = NULL;
257 notmuch->config_path = NULL;
258 notmuch->atomic_nesting = 0;
263 static notmuch_status_t
264 _trial_open (const char *xapian_path, char **message_ptr)
267 Xapian::Database db (xapian_path);
268 } catch (const Xapian::DatabaseOpeningError &error) {
269 IGNORE_RESULT (asprintf (message_ptr,
270 "Cannot open Xapian database at %s: %s\n",
272 error.get_msg ().c_str ()));
273 return NOTMUCH_STATUS_PATH_ERROR;
274 } catch (const Xapian::Error &error) {
275 IGNORE_RESULT (asprintf (message_ptr,
276 "A Xapian exception occurred opening database: %s\n",
277 error.get_msg ().c_str ()));
278 return NOTMUCH_STATUS_XAPIAN_EXCEPTION;
280 return NOTMUCH_STATUS_SUCCESS;
284 _notmuch_choose_xapian_path (void *ctx, const char *database_path,
285 const char **xapian_path, char **message_ptr)
287 notmuch_status_t status;
288 const char *trial_path, *notmuch_path;
290 status = _db_dir_exists (database_path, message_ptr);
294 trial_path = talloc_asprintf (ctx, "%s/xapian", database_path);
295 status = _trial_open (trial_path, message_ptr);
296 if (status != NOTMUCH_STATUS_PATH_ERROR)
302 notmuch_path = talloc_asprintf (ctx, "%s/.notmuch", database_path);
303 status = _db_dir_exists (notmuch_path, message_ptr);
307 trial_path = talloc_asprintf (ctx, "%s/xapian", notmuch_path);
308 status = _trial_open (trial_path, message_ptr);
311 if (status == NOTMUCH_STATUS_SUCCESS)
312 *xapian_path = trial_path;
317 _set_database_path (notmuch_database_t *notmuch,
318 const char *database_path)
320 char *path = talloc_strdup (notmuch, database_path);
322 strip_trailing (path, '/');
324 _notmuch_config_cache (notmuch, NOTMUCH_CONFIG_DATABASE_PATH, path);
328 _load_database_state (notmuch_database_t *notmuch)
330 std::string last_thread_id;
331 std::string last_mod;
333 notmuch->last_doc_id = notmuch->xapian_db->get_lastdocid ();
334 last_thread_id = notmuch->xapian_db->get_metadata ("last_thread_id");
335 if (last_thread_id.empty ()) {
336 notmuch->last_thread_id = 0;
341 str = last_thread_id.c_str ();
342 notmuch->last_thread_id = strtoull (str, &end, 16);
344 INTERNAL_ERROR ("Malformed database last_thread_id: %s", str);
347 /* Get current highest revision number. */
348 last_mod = notmuch->xapian_db->get_value_upper_bound (
349 NOTMUCH_VALUE_LAST_MOD);
350 if (last_mod.empty ())
351 notmuch->revision = 0;
353 notmuch->revision = Xapian::sortable_unserialise (last_mod);
354 notmuch->uuid = talloc_strdup (
355 notmuch, notmuch->xapian_db->get_uuid ().c_str ());
358 static notmuch_status_t
359 _finish_open (notmuch_database_t *notmuch,
361 notmuch_database_mode_t mode,
365 notmuch_status_t status = NOTMUCH_STATUS_SUCCESS;
366 char *incompat_features;
367 char *message = NULL;
368 unsigned int version;
369 const char *database_path = notmuch_database_get_path (notmuch);
373 if (mode == NOTMUCH_DATABASE_MODE_READ_WRITE) {
374 notmuch->writable_xapian_db = new Xapian::WritableDatabase (notmuch->xapian_path,
376 notmuch->xapian_db = notmuch->writable_xapian_db;
378 notmuch->xapian_db = new Xapian::Database (notmuch->xapian_path);
381 /* Check version. As of database version 3, we represent
382 * changes in terms of features, so assume a version bump
383 * means a dramatically incompatible change. */
384 version = notmuch_database_get_version (notmuch);
385 if (version > NOTMUCH_DATABASE_VERSION) {
386 IGNORE_RESULT (asprintf (&message,
387 "Error: Notmuch database at %s\n"
388 " has a newer database format version (%u) than supported by this\n"
389 " version of notmuch (%u).\n",
390 database_path, version, NOTMUCH_DATABASE_VERSION));
391 notmuch_database_destroy (notmuch);
393 status = NOTMUCH_STATUS_FILE_ERROR;
397 /* Check features. */
398 incompat_features = NULL;
399 notmuch->features = _notmuch_database_parse_features (
400 notmuch, notmuch->xapian_db->get_metadata ("features").c_str (),
401 version, mode == NOTMUCH_DATABASE_MODE_READ_WRITE ? 'w' : 'r',
403 if (incompat_features) {
404 IGNORE_RESULT (asprintf (&message,
405 "Error: Notmuch database at %s\n"
406 " requires features (%s)\n"
407 " not supported by this version of notmuch.\n",
408 database_path, incompat_features));
409 notmuch_database_destroy (notmuch);
411 status = NOTMUCH_STATUS_FILE_ERROR;
415 _load_database_state (notmuch);
417 notmuch->query_parser = new Xapian::QueryParser;
418 notmuch->term_gen = new Xapian::TermGenerator;
419 notmuch->term_gen->set_stemmer (Xapian::Stem ("english"));
420 notmuch->value_range_processor = new Xapian::NumberRangeProcessor (NOTMUCH_VALUE_TIMESTAMP);
421 notmuch->date_range_processor = new ParseTimeRangeProcessor (NOTMUCH_VALUE_TIMESTAMP,
423 notmuch->last_mod_range_processor = new Xapian::NumberRangeProcessor (NOTMUCH_VALUE_LAST_MOD,
425 notmuch->query_parser->set_default_op (Xapian::Query::OP_AND);
426 notmuch->query_parser->set_database (*notmuch->xapian_db);
427 notmuch->query_parser->set_stemmer (Xapian::Stem ("english"));
428 notmuch->query_parser->set_stemming_strategy (Xapian::QueryParser::STEM_SOME);
429 notmuch->query_parser->add_rangeprocessor (notmuch->value_range_processor);
430 notmuch->query_parser->add_rangeprocessor (notmuch->date_range_processor);
431 notmuch->query_parser->add_rangeprocessor (notmuch->last_mod_range_processor);
433 /* Configuration information is needed to set up query parser */
434 status = _notmuch_config_load_from_database (notmuch);
439 status = _notmuch_config_load_from_file (notmuch, key_file);
443 status = _choose_dir (notmuch, profile,
444 NOTMUCH_CONFIG_HOOK_DIR,
452 status = _choose_dir (notmuch, profile,
453 NOTMUCH_CONFIG_BACKUP_DIR,
460 status = _notmuch_config_load_defaults (notmuch);
464 status = _notmuch_database_setup_standard_query_fields (notmuch);
468 status = _notmuch_database_setup_user_query_fields (notmuch);
472 } catch (const Xapian::Error &error) {
473 IGNORE_RESULT (asprintf (&message, "A Xapian exception occurred opening database: %s\n",
474 error.get_msg ().c_str ()));
475 notmuch_database_destroy (notmuch);
477 status = NOTMUCH_STATUS_XAPIAN_EXCEPTION;
481 *message_ptr = message;
486 notmuch_database_open_with_config (const char *database_path,
487 notmuch_database_mode_t mode,
488 const char *config_path,
490 notmuch_database_t **database,
491 char **status_string)
493 notmuch_status_t status = NOTMUCH_STATUS_SUCCESS;
494 void *local = talloc_new (NULL);
495 notmuch_database_t *notmuch = NULL;
496 char *message = NULL;
497 GKeyFile *key_file = NULL;
502 notmuch = _alloc_notmuch ();
504 status = NOTMUCH_STATUS_OUT_OF_MEMORY;
508 status = _load_key_file (notmuch, config_path, profile, &key_file);
510 message = strdup ("Error: cannot load config file.\n");
514 if ((status = _choose_database_path (local, profile, key_file,
515 &database_path, &split,
519 status = _db_dir_exists (database_path, &message);
523 _set_database_path (notmuch, database_path);
525 status = _notmuch_choose_xapian_path (notmuch, database_path,
526 ¬much->xapian_path, &message);
530 status = _finish_open (notmuch, profile, mode, key_file, &message);
536 g_key_file_free (key_file);
540 *status_string = message;
548 talloc_free (notmuch);
551 notmuch->open = true;
557 notmuch_database_create (const char *path, notmuch_database_t **database)
559 char *status_string = NULL;
560 notmuch_status_t status;
562 status = notmuch_database_create_verbose (path, database,
566 fputs (status_string, stderr);
567 free (status_string);
574 notmuch_database_create_verbose (const char *path,
575 notmuch_database_t **database,
576 char **status_string)
578 return notmuch_database_create_with_config (path, "", NULL, database, status_string);
582 notmuch_database_create_with_config (const char *database_path,
583 const char *config_path,
585 notmuch_database_t **database,
586 char **status_string)
588 notmuch_status_t status = NOTMUCH_STATUS_SUCCESS;
589 notmuch_database_t *notmuch = NULL;
590 const char *notmuch_path = NULL;
591 char *message = NULL;
592 GKeyFile *key_file = NULL;
593 void *local = talloc_new (NULL);
599 notmuch = _alloc_notmuch ();
601 status = NOTMUCH_STATUS_OUT_OF_MEMORY;
605 status = _load_key_file (notmuch, config_path, profile, &key_file);
607 message = strdup ("Error: cannot load config file.\n");
611 if ((status = _choose_database_path (local, profile, key_file,
612 &database_path, &split, &message)))
615 status = _db_dir_exists (database_path, &message);
619 _set_database_path (notmuch, database_path);
621 if (key_file && ! split) {
622 char *mail_root = notmuch_canonicalize_file_name (
623 g_key_file_get_value (key_file, "database", "mail_root", NULL));
624 char *db_path = notmuch_canonicalize_file_name (database_path);
626 split = (mail_root && (0 != strcmp (mail_root, db_path)));
633 notmuch_path = database_path;
635 if (! (notmuch_path = talloc_asprintf (local, "%s/%s", database_path, ".notmuch"))) {
636 status = NOTMUCH_STATUS_OUT_OF_MEMORY;
640 err = mkdir (notmuch_path, 0755);
642 if (errno == EEXIST) {
643 status = NOTMUCH_STATUS_DATABASE_EXISTS;
644 talloc_free (notmuch);
647 IGNORE_RESULT (asprintf (&message, "Error: Cannot create directory %s: %s.\n",
648 notmuch_path, strerror (errno)));
649 status = NOTMUCH_STATUS_FILE_ERROR;
655 if (! (notmuch->xapian_path = talloc_asprintf (notmuch, "%s/%s", notmuch_path, "xapian"))) {
656 status = NOTMUCH_STATUS_OUT_OF_MEMORY;
660 status = _trial_open (notmuch->xapian_path, &message);
661 if (status == NOTMUCH_STATUS_SUCCESS) {
662 notmuch_database_destroy (notmuch);
664 status = NOTMUCH_STATUS_DATABASE_EXISTS;
671 status = _finish_open (notmuch,
673 NOTMUCH_DATABASE_MODE_READ_WRITE,
679 /* Upgrade doesn't add these feature to existing databases, but
680 * new databases have them. */
681 notmuch->features |= NOTMUCH_FEATURE_FROM_SUBJECT_ID_VALUES;
682 notmuch->features |= NOTMUCH_FEATURE_INDEXED_MIMETYPES;
683 notmuch->features |= NOTMUCH_FEATURE_UNPREFIX_BODY_ONLY;
685 status = notmuch_database_upgrade (notmuch, NULL, NULL);
687 notmuch_database_close (notmuch);
695 g_key_file_free (key_file);
699 *status_string = message;
706 talloc_free (notmuch);
711 notmuch_database_reopen (notmuch_database_t *notmuch,
712 notmuch_database_mode_t new_mode)
714 notmuch_database_mode_t cur_mode = _notmuch_database_mode (notmuch);
716 if (notmuch->xapian_db == NULL) {
717 _notmuch_database_log (notmuch, "Cannot reopen closed or nonexistent database\n");
718 return NOTMUCH_STATUS_ILLEGAL_ARGUMENT;
722 if (cur_mode == new_mode &&
723 new_mode == NOTMUCH_DATABASE_MODE_READ_ONLY) {
724 notmuch->xapian_db->reopen ();
726 notmuch->xapian_db->close ();
728 delete notmuch->xapian_db;
729 notmuch->xapian_db = NULL;
730 /* no need to free the same object twice */
731 notmuch->writable_xapian_db = NULL;
733 if (new_mode == NOTMUCH_DATABASE_MODE_READ_WRITE) {
734 notmuch->writable_xapian_db = new Xapian::WritableDatabase (notmuch->xapian_path,
736 notmuch->xapian_db = notmuch->writable_xapian_db;
738 notmuch->xapian_db = new Xapian::Database (notmuch->xapian_path,
743 _load_database_state (notmuch);
744 } catch (const Xapian::Error &error) {
745 if (! notmuch->exception_reported) {
746 _notmuch_database_log (notmuch, "Error: A Xapian exception reopening database: %s\n",
747 error.get_msg ().c_str ());
748 notmuch->exception_reported = true;
750 return NOTMUCH_STATUS_XAPIAN_EXCEPTION;
754 notmuch->open = true;
755 return NOTMUCH_STATUS_SUCCESS;
758 static notmuch_status_t
759 _maybe_load_config_from_database (notmuch_database_t *notmuch,
761 const char *database_path,
764 char *message; /* ignored */
766 if (_db_dir_exists (database_path, &message))
767 return NOTMUCH_STATUS_NO_DATABASE;
769 _set_database_path (notmuch, database_path);
771 if (_notmuch_choose_xapian_path (notmuch, database_path, ¬much->xapian_path, &message))
772 return NOTMUCH_STATUS_NO_DATABASE;
774 (void) _finish_open (notmuch, profile, NOTMUCH_DATABASE_MODE_READ_ONLY, key_file, &message);
776 return NOTMUCH_STATUS_SUCCESS;
780 notmuch_database_load_config (const char *database_path,
781 const char *config_path,
783 notmuch_database_t **database,
784 char **status_string)
786 notmuch_status_t status = NOTMUCH_STATUS_SUCCESS, warning = NOTMUCH_STATUS_SUCCESS;
787 void *local = talloc_new (NULL);
788 notmuch_database_t *notmuch = NULL;
789 char *message = NULL;
790 GKeyFile *key_file = NULL;
795 notmuch = _alloc_notmuch ();
797 status = NOTMUCH_STATUS_OUT_OF_MEMORY;
801 status = _load_key_file (notmuch, config_path, profile, &key_file);
803 case NOTMUCH_STATUS_SUCCESS:
805 case NOTMUCH_STATUS_NO_CONFIG:
809 message = strdup ("Error: cannot load config file.\n");
813 status = _choose_database_path (local, profile, key_file,
814 &database_path, &split, &message);
816 case NOTMUCH_STATUS_NO_DATABASE:
817 case NOTMUCH_STATUS_SUCCESS:
827 status = _maybe_load_config_from_database (notmuch, key_file, database_path, profile);
829 case NOTMUCH_STATUS_NO_DATABASE:
830 case NOTMUCH_STATUS_SUCCESS:
840 status = _notmuch_config_load_from_file (notmuch, key_file);
844 status = _notmuch_config_load_defaults (notmuch);
852 *status_string = message;