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 *database_path = getenv ("MAILDIR");
227 if (! *database_path) {
228 notmuch_status_t status;
230 *database_path = talloc_asprintf (ctx, "%s/mail", getenv ("HOME"));
231 status = _db_dir_exists (*database_path, message);
233 *database_path = NULL;
237 if (*database_path == NULL) {
238 *message = strdup ("Error: could not locate database.\n");
239 return NOTMUCH_STATUS_NO_DATABASE;
242 if (*database_path[0] != '/') {
243 *message = strdup ("Error: Database path must be absolute.\n");
244 return NOTMUCH_STATUS_PATH_ERROR;
246 return NOTMUCH_STATUS_SUCCESS;
249 static notmuch_database_t *
250 _alloc_notmuch (const char *database_path, const char *config_path, const char *profile)
252 notmuch_database_t *notmuch;
254 notmuch = talloc_zero (NULL, notmuch_database_t);
258 notmuch->exception_reported = false;
259 notmuch->status_string = NULL;
260 notmuch->writable_xapian_db = NULL;
261 notmuch->config_path = NULL;
262 notmuch->atomic_nesting = 0;
263 notmuch->transaction_count = 0;
264 notmuch->transaction_threshold = 0;
267 notmuch->params = NOTMUCH_PARAM_NONE;
269 notmuch->params |= NOTMUCH_PARAM_DATABASE;
271 notmuch->params |= NOTMUCH_PARAM_CONFIG;
273 notmuch->params |= NOTMUCH_PARAM_PROFILE;
278 static notmuch_status_t
279 _trial_open (const char *xapian_path, char **message_ptr)
282 Xapian::Database db (xapian_path);
283 } catch (const Xapian::DatabaseOpeningError &error) {
284 IGNORE_RESULT (asprintf (message_ptr,
285 "Cannot open Xapian database at %s: %s\n",
287 error.get_msg ().c_str ()));
288 return NOTMUCH_STATUS_PATH_ERROR;
289 } catch (const Xapian::Error &error) {
290 IGNORE_RESULT (asprintf (message_ptr,
291 "A Xapian exception occurred opening database: %s\n",
292 error.get_msg ().c_str ()));
293 return NOTMUCH_STATUS_XAPIAN_EXCEPTION;
295 return NOTMUCH_STATUS_SUCCESS;
299 _notmuch_choose_xapian_path (void *ctx, const char *database_path,
300 const char **xapian_path, char **message_ptr)
302 notmuch_status_t status;
303 const char *trial_path, *notmuch_path;
305 status = _db_dir_exists (database_path, message_ptr);
309 trial_path = talloc_asprintf (ctx, "%s/xapian", database_path);
310 status = _trial_open (trial_path, message_ptr);
311 if (status != NOTMUCH_STATUS_PATH_ERROR)
317 notmuch_path = talloc_asprintf (ctx, "%s/.notmuch", database_path);
318 status = _db_dir_exists (notmuch_path, message_ptr);
322 trial_path = talloc_asprintf (ctx, "%s/xapian", notmuch_path);
323 status = _trial_open (trial_path, message_ptr);
326 if (status == NOTMUCH_STATUS_SUCCESS)
327 *xapian_path = trial_path;
332 _set_database_path (notmuch_database_t *notmuch,
333 const char *database_path)
335 char *path = talloc_strdup (notmuch, database_path);
337 strip_trailing (path, '/');
339 _notmuch_config_cache (notmuch, NOTMUCH_CONFIG_DATABASE_PATH, path);
343 _load_database_state (notmuch_database_t *notmuch)
345 std::string last_thread_id;
346 std::string last_mod;
348 notmuch->last_doc_id = notmuch->xapian_db->get_lastdocid ();
349 last_thread_id = notmuch->xapian_db->get_metadata ("last_thread_id");
350 if (last_thread_id.empty ()) {
351 notmuch->last_thread_id = 0;
356 str = last_thread_id.c_str ();
357 notmuch->last_thread_id = strtoull (str, &end, 16);
359 INTERNAL_ERROR ("Malformed database last_thread_id: %s", str);
362 /* Get current highest revision number. */
363 last_mod = notmuch->xapian_db->get_value_upper_bound (
364 NOTMUCH_VALUE_LAST_MOD);
365 if (last_mod.empty ())
366 notmuch->revision = 0;
368 notmuch->revision = Xapian::sortable_unserialise (last_mod);
369 notmuch->uuid = talloc_strdup (
370 notmuch, notmuch->xapian_db->get_uuid ().c_str ());
373 static notmuch_status_t
374 _finish_open (notmuch_database_t *notmuch,
376 notmuch_database_mode_t mode,
380 notmuch_status_t status = NOTMUCH_STATUS_SUCCESS;
381 char *incompat_features;
382 char *message = NULL;
383 const char *autocommit_str;
384 char *autocommit_end;
385 unsigned int version;
386 const char *database_path = notmuch_database_get_path (notmuch);
390 if (mode == NOTMUCH_DATABASE_MODE_READ_WRITE) {
391 notmuch->writable_xapian_db = new Xapian::WritableDatabase (notmuch->xapian_path,
393 notmuch->xapian_db = notmuch->writable_xapian_db;
395 notmuch->xapian_db = new Xapian::Database (notmuch->xapian_path);
398 /* Check version. As of database version 3, we represent
399 * changes in terms of features, so assume a version bump
400 * means a dramatically incompatible change. */
401 version = notmuch_database_get_version (notmuch);
402 if (version > NOTMUCH_DATABASE_VERSION) {
403 IGNORE_RESULT (asprintf (&message,
404 "Error: Notmuch database at %s\n"
405 " has a newer database format version (%u) than supported by this\n"
406 " version of notmuch (%u).\n",
407 database_path, version, NOTMUCH_DATABASE_VERSION));
408 status = NOTMUCH_STATUS_FILE_ERROR;
412 /* Check features. */
413 incompat_features = NULL;
414 notmuch->features = _notmuch_database_parse_features (
415 notmuch, notmuch->xapian_db->get_metadata ("features").c_str (),
416 version, mode == NOTMUCH_DATABASE_MODE_READ_WRITE ? 'w' : 'r',
418 if (incompat_features) {
419 IGNORE_RESULT (asprintf (&message,
420 "Error: Notmuch database at %s\n"
421 " requires features (%s)\n"
422 " not supported by this version of notmuch.\n",
423 database_path, incompat_features));
424 status = NOTMUCH_STATUS_FILE_ERROR;
428 _load_database_state (notmuch);
430 notmuch->query_parser = new Xapian::QueryParser;
431 notmuch->term_gen = new Xapian::TermGenerator;
432 notmuch->term_gen->set_stemmer (Xapian::Stem ("english"));
433 notmuch->value_range_processor = new Xapian::NumberRangeProcessor (NOTMUCH_VALUE_TIMESTAMP);
434 notmuch->date_range_processor = new ParseTimeRangeProcessor (NOTMUCH_VALUE_TIMESTAMP,
436 notmuch->last_mod_range_processor = new Xapian::NumberRangeProcessor (NOTMUCH_VALUE_LAST_MOD,
438 notmuch->query_parser->set_default_op (Xapian::Query::OP_AND);
439 notmuch->query_parser->set_database (*notmuch->xapian_db);
440 notmuch->stemmer = new Xapian::Stem ("english");
441 notmuch->query_parser->set_stemmer (*notmuch->stemmer);
442 notmuch->query_parser->set_stemming_strategy (Xapian::QueryParser::STEM_SOME);
443 notmuch->query_parser->add_rangeprocessor (notmuch->value_range_processor);
444 notmuch->query_parser->add_rangeprocessor (notmuch->date_range_processor);
445 notmuch->query_parser->add_rangeprocessor (notmuch->last_mod_range_processor);
447 /* Configuration information is needed to set up query parser */
448 status = _notmuch_config_load_from_database (notmuch);
453 status = _notmuch_config_load_from_file (notmuch, key_file);
457 status = _choose_dir (notmuch, profile,
458 NOTMUCH_CONFIG_HOOK_DIR,
466 status = _choose_dir (notmuch, profile,
467 NOTMUCH_CONFIG_BACKUP_DIR,
474 status = _notmuch_config_load_defaults (notmuch);
478 autocommit_str = notmuch_config_get (notmuch, NOTMUCH_CONFIG_AUTOCOMMIT);
479 if (unlikely (! autocommit_str)) {
480 INTERNAL_ERROR ("missing configuration for autocommit");
482 notmuch->transaction_threshold = strtoul (autocommit_str, &autocommit_end, 10);
483 if (*autocommit_end != '\0')
484 INTERNAL_ERROR ("Malformed database database.autocommit value: %s", autocommit_str);
486 status = _notmuch_database_setup_standard_query_fields (notmuch);
490 status = _notmuch_database_setup_user_query_fields (notmuch);
494 } catch (const Xapian::Error &error) {
495 IGNORE_RESULT (asprintf (&message, "A Xapian exception occurred opening database: %s\n",
496 error.get_msg ().c_str ()));
497 status = NOTMUCH_STATUS_XAPIAN_EXCEPTION;
501 *message_ptr = message;
506 notmuch_database_open_with_config (const char *database_path,
507 notmuch_database_mode_t mode,
508 const char *config_path,
510 notmuch_database_t **database,
511 char **status_string)
513 notmuch_status_t status = NOTMUCH_STATUS_SUCCESS;
514 void *local = talloc_new (NULL);
515 notmuch_database_t *notmuch = NULL;
516 char *message = NULL;
517 GKeyFile *key_file = NULL;
522 notmuch = _alloc_notmuch (database_path, config_path, profile);
524 status = NOTMUCH_STATUS_OUT_OF_MEMORY;
528 status = _load_key_file (notmuch, config_path, profile, &key_file);
530 message = strdup ("Error: cannot load config file.\n");
534 if ((status = _choose_database_path (local, profile, key_file,
535 &database_path, &split,
539 status = _db_dir_exists (database_path, &message);
543 _set_database_path (notmuch, database_path);
545 status = _notmuch_choose_xapian_path (notmuch, database_path,
546 ¬much->xapian_path, &message);
550 status = _finish_open (notmuch, profile, mode, key_file, &message);
556 g_key_file_free (key_file);
560 *status_string = message;
565 if (status && notmuch) {
566 notmuch_database_destroy (notmuch);
574 notmuch->open = true;
580 notmuch_database_create (const char *path, notmuch_database_t **database)
582 char *status_string = NULL;
583 notmuch_status_t status;
585 status = notmuch_database_create_verbose (path, database,
589 fputs (status_string, stderr);
590 free (status_string);
597 notmuch_database_create_verbose (const char *path,
598 notmuch_database_t **database,
599 char **status_string)
601 return notmuch_database_create_with_config (path, "", NULL, database, status_string);
605 notmuch_database_create_with_config (const char *database_path,
606 const char *config_path,
608 notmuch_database_t **database,
609 char **status_string)
611 notmuch_status_t status = NOTMUCH_STATUS_SUCCESS;
612 notmuch_database_t *notmuch = NULL;
613 const char *notmuch_path = NULL;
614 char *message = NULL;
615 GKeyFile *key_file = NULL;
616 void *local = talloc_new (NULL);
622 notmuch = _alloc_notmuch (database_path, config_path, profile);
624 status = NOTMUCH_STATUS_OUT_OF_MEMORY;
628 status = _load_key_file (notmuch, config_path, profile, &key_file);
630 message = strdup ("Error: cannot load config file.\n");
634 if ((status = _choose_database_path (local, profile, key_file,
635 &database_path, &split, &message)))
638 status = _db_dir_exists (database_path, &message);
642 _set_database_path (notmuch, database_path);
644 if (key_file && ! split) {
645 char *mail_root = notmuch_canonicalize_file_name (
646 g_key_file_get_value (key_file, "database", "mail_root", NULL));
647 char *db_path = notmuch_canonicalize_file_name (database_path);
649 split = (mail_root && (0 != strcmp (mail_root, db_path)));
656 notmuch_path = database_path;
658 if (! (notmuch_path = talloc_asprintf (local, "%s/%s", database_path, ".notmuch"))) {
659 status = NOTMUCH_STATUS_OUT_OF_MEMORY;
663 err = mkdir (notmuch_path, 0755);
665 if (errno == EEXIST) {
666 status = NOTMUCH_STATUS_DATABASE_EXISTS;
667 talloc_free (notmuch);
670 IGNORE_RESULT (asprintf (&message, "Error: Cannot create directory %s: %s.\n",
671 notmuch_path, strerror (errno)));
672 status = NOTMUCH_STATUS_FILE_ERROR;
678 if (! (notmuch->xapian_path = talloc_asprintf (notmuch, "%s/%s", notmuch_path, "xapian"))) {
679 status = NOTMUCH_STATUS_OUT_OF_MEMORY;
683 status = _trial_open (notmuch->xapian_path, &message);
684 if (status == NOTMUCH_STATUS_SUCCESS) {
685 notmuch_database_destroy (notmuch);
687 status = NOTMUCH_STATUS_DATABASE_EXISTS;
694 status = _finish_open (notmuch,
696 NOTMUCH_DATABASE_MODE_READ_WRITE,
702 /* Upgrade doesn't add these feature to existing databases, but
703 * new databases have them. */
704 notmuch->features |= NOTMUCH_FEATURE_FROM_SUBJECT_ID_VALUES;
705 notmuch->features |= NOTMUCH_FEATURE_INDEXED_MIMETYPES;
706 notmuch->features |= NOTMUCH_FEATURE_UNPREFIX_BODY_ONLY;
708 status = notmuch_database_upgrade (notmuch, NULL, NULL);
710 notmuch_database_close (notmuch);
718 g_key_file_free (key_file);
722 *status_string = message;
726 if (status && notmuch) {
727 notmuch_database_destroy (notmuch);
735 notmuch->open = true;
740 notmuch_database_reopen (notmuch_database_t *notmuch,
741 notmuch_database_mode_t new_mode)
743 notmuch_database_mode_t cur_mode = _notmuch_database_mode (notmuch);
745 if (notmuch->xapian_db == NULL) {
746 _notmuch_database_log (notmuch, "Cannot reopen closed or nonexistent database\n");
747 return NOTMUCH_STATUS_ILLEGAL_ARGUMENT;
751 if (cur_mode == new_mode &&
752 new_mode == NOTMUCH_DATABASE_MODE_READ_ONLY) {
753 notmuch->xapian_db->reopen ();
755 notmuch->xapian_db->close ();
757 delete notmuch->xapian_db;
758 notmuch->xapian_db = NULL;
759 /* no need to free the same object twice */
760 notmuch->writable_xapian_db = NULL;
762 if (new_mode == NOTMUCH_DATABASE_MODE_READ_WRITE) {
763 notmuch->writable_xapian_db = new Xapian::WritableDatabase (notmuch->xapian_path,
765 notmuch->xapian_db = notmuch->writable_xapian_db;
767 notmuch->xapian_db = new Xapian::Database (notmuch->xapian_path,
772 _load_database_state (notmuch);
773 } catch (const Xapian::Error &error) {
774 if (! notmuch->exception_reported) {
775 _notmuch_database_log (notmuch, "Error: A Xapian exception reopening database: %s\n",
776 error.get_msg ().c_str ());
777 notmuch->exception_reported = true;
779 return NOTMUCH_STATUS_XAPIAN_EXCEPTION;
783 notmuch->open = true;
784 return NOTMUCH_STATUS_SUCCESS;
787 static notmuch_status_t
788 _maybe_load_config_from_database (notmuch_database_t *notmuch,
790 const char *database_path,
793 char *message; /* ignored */
795 if (_db_dir_exists (database_path, &message))
796 return NOTMUCH_STATUS_NO_DATABASE;
798 _set_database_path (notmuch, database_path);
800 if (_notmuch_choose_xapian_path (notmuch, database_path, ¬much->xapian_path, &message))
801 return NOTMUCH_STATUS_NO_DATABASE;
803 (void) _finish_open (notmuch, profile, NOTMUCH_DATABASE_MODE_READ_ONLY, key_file, &message);
805 return NOTMUCH_STATUS_SUCCESS;
809 notmuch_database_load_config (const char *database_path,
810 const char *config_path,
812 notmuch_database_t **database,
813 char **status_string)
815 notmuch_status_t status = NOTMUCH_STATUS_SUCCESS, warning = NOTMUCH_STATUS_SUCCESS;
816 void *local = talloc_new (NULL);
817 notmuch_database_t *notmuch = NULL;
818 char *message = NULL;
819 GKeyFile *key_file = NULL;
824 notmuch = _alloc_notmuch (database_path, config_path, profile);
826 status = NOTMUCH_STATUS_OUT_OF_MEMORY;
830 status = _load_key_file (notmuch, config_path, profile, &key_file);
832 case NOTMUCH_STATUS_SUCCESS:
834 case NOTMUCH_STATUS_NO_CONFIG:
838 message = strdup ("Error: cannot load config file.\n");
842 status = _choose_database_path (local, profile, key_file,
843 &database_path, &split, &message);
845 case NOTMUCH_STATUS_NO_DATABASE:
846 case NOTMUCH_STATUS_SUCCESS:
856 status = _maybe_load_config_from_database (notmuch, key_file, database_path, profile);
858 case NOTMUCH_STATUS_NO_DATABASE:
859 case NOTMUCH_STATUS_SUCCESS:
869 status = _notmuch_config_load_from_file (notmuch, key_file);
873 status = _notmuch_config_load_defaults (notmuch);
881 *status_string = message;
884 status != NOTMUCH_STATUS_NO_DATABASE
885 && status != NOTMUCH_STATUS_NO_CONFIG) {
886 notmuch_database_destroy (notmuch);