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_with_config (path, mode, "", NULL,
23 database, &status_string);
25 fputs (status_string, stderr);
33 notmuch_database_open_verbose (const char *path,
34 notmuch_database_mode_t mode,
35 notmuch_database_t **database,
38 return notmuch_database_open_with_config (path, mode, "", NULL,
39 database, status_string);
44 const char *xdg_root_variable,
45 const char *xdg_prefix,
46 const char *profile_name)
48 const char *xdg_root = getenv (xdg_root_variable);
51 const char *home = getenv ("HOME");
53 if (! home) return NULL;
55 xdg_root = talloc_asprintf (ctx,
62 profile_name = getenv ("NOTMUCH_PROFILE");
65 profile_name = "default";
67 return talloc_asprintf (ctx,
73 static notmuch_status_t
74 _choose_dir (notmuch_database_t *notmuch,
76 notmuch_config_key_t key,
78 const char *xdg_subdir,
80 char **message = NULL)
87 dir = notmuch_config_get (notmuch, key);
90 return NOTMUCH_STATUS_SUCCESS;
92 parent = _xdg_dir (notmuch, xdg_var, xdg_subdir, profile);
94 return NOTMUCH_STATUS_PATH_ERROR;
96 dir = talloc_asprintf (notmuch, "%s/%s", parent, subdir);
98 err = stat (dir, &st);
100 if (errno == ENOENT) {
101 char *notmuch_path = dirname (talloc_strdup (notmuch, notmuch->xapian_path));
102 dir = talloc_asprintf (notmuch, "%s/%s", notmuch_path, subdir);
104 IGNORE_RESULT (asprintf (message, "Error: Cannot stat %s: %s.\n",
105 dir, strerror (errno)));
106 return NOTMUCH_STATUS_FILE_ERROR;
110 _notmuch_config_cache (notmuch, key, dir);
112 return NOTMUCH_STATUS_SUCCESS;
115 static notmuch_status_t
116 _load_key_file (notmuch_database_t *notmuch,
121 notmuch_status_t status = NOTMUCH_STATUS_SUCCESS;
123 if (path && EMPTY_STRING (path))
127 path = getenv ("NOTMUCH_CONFIG");
130 path = talloc_strdup (notmuch, path);
132 const char *dir = _xdg_dir (notmuch, "XDG_CONFIG_HOME", ".config", profile);
135 path = talloc_asprintf (notmuch, "%s/config", dir);
136 if (access (path, R_OK) != 0)
142 const char *home = getenv ("HOME");
144 path = talloc_asprintf (notmuch, "%s/.notmuch-config", home);
147 profile = getenv ("NOTMUCH_PROFILE");
150 path = talloc_asprintf (notmuch, "%s.%s", path, profile);
153 *key_file = g_key_file_new ();
154 if (! g_key_file_load_from_file (*key_file, path, G_KEY_FILE_NONE, NULL)) {
155 status = NOTMUCH_STATUS_NO_CONFIG;
160 notmuch->config_path = path;
165 static notmuch_status_t
166 _db_dir_exists (const char *database_path, char **message)
171 err = stat (database_path, &st);
173 IGNORE_RESULT (asprintf (message, "Error: Cannot open database at %s: %s.\n",
174 database_path, strerror (errno)));
175 return NOTMUCH_STATUS_FILE_ERROR;
178 if (! S_ISDIR (st.st_mode)) {
179 IGNORE_RESULT (asprintf (message, "Error: Cannot open database at %s: "
180 "Not a directory.\n",
182 return NOTMUCH_STATUS_FILE_ERROR;
185 return NOTMUCH_STATUS_SUCCESS;
188 static notmuch_status_t
189 _choose_database_path (notmuch_database_t *notmuch,
192 const char **database_path,
195 if (! *database_path) {
196 *database_path = getenv ("NOTMUCH_DATABASE");
199 if (! *database_path && key_file) {
200 char *path = g_key_file_get_string (key_file, "database", "path", NULL);
203 *database_path = talloc_strdup (notmuch, path);
205 *database_path = talloc_asprintf (notmuch, "%s/%s", getenv ("HOME"), path);
209 if (! *database_path) {
210 notmuch_status_t status;
212 *database_path = _xdg_dir (notmuch, "XDG_DATA_HOME", ".local/share", profile);
213 status = _db_dir_exists (*database_path, message);
215 *database_path = NULL;
217 notmuch->params |= NOTMUCH_PARAM_SPLIT;
221 if (! *database_path) {
222 *database_path = getenv ("MAILDIR");
225 if (! *database_path) {
226 notmuch_status_t status;
228 *database_path = talloc_asprintf (notmuch, "%s/mail", getenv ("HOME"));
229 status = _db_dir_exists (*database_path, message);
231 *database_path = NULL;
235 if (*database_path == NULL) {
236 *message = strdup ("Error: could not locate database.\n");
237 return NOTMUCH_STATUS_NO_DATABASE;
240 if (*database_path[0] != '/') {
241 *message = strdup ("Error: Database path must be absolute.\n");
242 return NOTMUCH_STATUS_PATH_ERROR;
244 return NOTMUCH_STATUS_SUCCESS;
247 static notmuch_status_t
248 _mkdir (const char *path, char **message)
250 if (g_mkdir_with_parents (path, 0755)) {
251 IGNORE_RESULT (asprintf (message, "Error: Cannot create directory %s: %s.\n",
252 path, strerror (errno)));
253 return NOTMUCH_STATUS_FILE_ERROR;
255 return NOTMUCH_STATUS_SUCCESS;
259 static notmuch_database_t *
260 _alloc_notmuch (const char *database_path, const char *config_path, const char *profile)
262 notmuch_database_t *notmuch;
264 notmuch = talloc_zero (NULL, notmuch_database_t);
268 notmuch->exception_reported = false;
269 notmuch->status_string = NULL;
270 notmuch->writable_xapian_db = NULL;
271 notmuch->config_path = NULL;
272 notmuch->atomic_nesting = 0;
273 notmuch->transaction_count = 0;
274 notmuch->transaction_threshold = 0;
277 notmuch->params = NOTMUCH_PARAM_NONE;
279 notmuch->params |= NOTMUCH_PARAM_DATABASE;
281 notmuch->params |= NOTMUCH_PARAM_CONFIG;
283 notmuch->params |= NOTMUCH_PARAM_PROFILE;
288 static notmuch_status_t
289 _trial_open (const char *xapian_path, char **message_ptr)
292 Xapian::Database db (xapian_path);
293 } catch (const Xapian::DatabaseOpeningError &error) {
294 IGNORE_RESULT (asprintf (message_ptr,
295 "Cannot open Xapian database at %s: %s\n",
297 error.get_msg ().c_str ()));
298 return NOTMUCH_STATUS_PATH_ERROR;
299 } catch (const Xapian::Error &error) {
300 IGNORE_RESULT (asprintf (message_ptr,
301 "A Xapian exception occurred opening database: %s\n",
302 error.get_msg ().c_str ()));
303 return NOTMUCH_STATUS_XAPIAN_EXCEPTION;
305 return NOTMUCH_STATUS_SUCCESS;
309 _notmuch_choose_xapian_path (void *ctx, const char *database_path,
310 const char **xapian_path, char **message_ptr)
312 notmuch_status_t status;
313 const char *trial_path, *notmuch_path;
315 status = _db_dir_exists (database_path, message_ptr);
319 trial_path = talloc_asprintf (ctx, "%s/xapian", database_path);
320 status = _trial_open (trial_path, message_ptr);
321 if (status != NOTMUCH_STATUS_PATH_ERROR)
327 notmuch_path = talloc_asprintf (ctx, "%s/.notmuch", database_path);
328 status = _db_dir_exists (notmuch_path, message_ptr);
332 trial_path = talloc_asprintf (ctx, "%s/xapian", notmuch_path);
333 status = _trial_open (trial_path, message_ptr);
336 if (status == NOTMUCH_STATUS_SUCCESS)
337 *xapian_path = trial_path;
342 _set_database_path (notmuch_database_t *notmuch,
343 const char *database_path)
345 char *path = talloc_strdup (notmuch, database_path);
347 strip_trailing (path, '/');
349 _notmuch_config_cache (notmuch, NOTMUCH_CONFIG_DATABASE_PATH, path);
353 _load_database_state (notmuch_database_t *notmuch)
355 std::string last_thread_id;
356 std::string last_mod;
358 notmuch->last_doc_id = notmuch->xapian_db->get_lastdocid ();
359 last_thread_id = notmuch->xapian_db->get_metadata ("last_thread_id");
360 if (last_thread_id.empty ()) {
361 notmuch->last_thread_id = 0;
366 str = last_thread_id.c_str ();
367 notmuch->last_thread_id = strtoull (str, &end, 16);
369 INTERNAL_ERROR ("Malformed database last_thread_id: %s", str);
372 /* Get current highest revision number. */
373 last_mod = notmuch->xapian_db->get_value_upper_bound (
374 NOTMUCH_VALUE_LAST_MOD);
375 if (last_mod.empty ())
376 notmuch->revision = 0;
378 notmuch->revision = Xapian::sortable_unserialise (last_mod);
379 notmuch->uuid = talloc_strdup (
380 notmuch, notmuch->xapian_db->get_uuid ().c_str ());
383 static notmuch_status_t
384 _finish_open (notmuch_database_t *notmuch,
386 notmuch_database_mode_t mode,
390 notmuch_status_t status = NOTMUCH_STATUS_SUCCESS;
391 char *incompat_features;
392 char *message = NULL;
393 const char *autocommit_str;
394 char *autocommit_end;
395 unsigned int version;
396 const char *database_path = notmuch_database_get_path (notmuch);
400 if (mode == NOTMUCH_DATABASE_MODE_READ_WRITE) {
401 notmuch->writable_xapian_db = new Xapian::WritableDatabase (notmuch->xapian_path,
403 notmuch->xapian_db = notmuch->writable_xapian_db;
405 notmuch->xapian_db = new Xapian::Database (notmuch->xapian_path);
408 /* Check version. As of database version 3, we represent
409 * changes in terms of features, so assume a version bump
410 * means a dramatically incompatible change. */
411 version = notmuch_database_get_version (notmuch);
412 if (version > NOTMUCH_DATABASE_VERSION) {
413 IGNORE_RESULT (asprintf (&message,
414 "Error: Notmuch database at %s\n"
415 " has a newer database format version (%u) than supported by this\n"
416 " version of notmuch (%u).\n",
417 database_path, version, NOTMUCH_DATABASE_VERSION));
418 status = NOTMUCH_STATUS_FILE_ERROR;
422 /* Check features. */
423 incompat_features = NULL;
424 notmuch->features = _notmuch_database_parse_features (
425 notmuch, notmuch->xapian_db->get_metadata ("features").c_str (),
426 version, mode == NOTMUCH_DATABASE_MODE_READ_WRITE ? 'w' : 'r',
428 if (incompat_features) {
429 IGNORE_RESULT (asprintf (&message,
430 "Error: Notmuch database at %s\n"
431 " requires features (%s)\n"
432 " not supported by this version of notmuch.\n",
433 database_path, incompat_features));
434 status = NOTMUCH_STATUS_FILE_ERROR;
438 _load_database_state (notmuch);
440 notmuch->query_parser = new Xapian::QueryParser;
441 notmuch->term_gen = new Xapian::TermGenerator;
442 notmuch->term_gen->set_stemmer (Xapian::Stem ("english"));
443 notmuch->value_range_processor = new Xapian::NumberRangeProcessor (NOTMUCH_VALUE_TIMESTAMP);
444 notmuch->date_range_processor = new ParseTimeRangeProcessor (NOTMUCH_VALUE_TIMESTAMP,
446 notmuch->last_mod_range_processor = new Xapian::NumberRangeProcessor (NOTMUCH_VALUE_LAST_MOD,
448 notmuch->query_parser->set_default_op (Xapian::Query::OP_AND);
449 notmuch->query_parser->set_database (*notmuch->xapian_db);
450 notmuch->stemmer = new Xapian::Stem ("english");
451 notmuch->query_parser->set_stemmer (*notmuch->stemmer);
452 notmuch->query_parser->set_stemming_strategy (Xapian::QueryParser::STEM_SOME);
453 notmuch->query_parser->add_rangeprocessor (notmuch->value_range_processor);
454 notmuch->query_parser->add_rangeprocessor (notmuch->date_range_processor);
455 notmuch->query_parser->add_rangeprocessor (notmuch->last_mod_range_processor);
457 /* Configuration information is needed to set up query parser */
458 status = _notmuch_config_load_from_database (notmuch);
463 status = _notmuch_config_load_from_file (notmuch, key_file);
467 status = _choose_dir (notmuch, profile,
468 NOTMUCH_CONFIG_HOOK_DIR,
476 status = _choose_dir (notmuch, profile,
477 NOTMUCH_CONFIG_BACKUP_DIR,
484 status = _notmuch_config_load_defaults (notmuch);
488 autocommit_str = notmuch_config_get (notmuch, NOTMUCH_CONFIG_AUTOCOMMIT);
489 if (unlikely (! autocommit_str)) {
490 INTERNAL_ERROR ("missing configuration for autocommit");
492 notmuch->transaction_threshold = strtoul (autocommit_str, &autocommit_end, 10);
493 if (*autocommit_end != '\0')
494 INTERNAL_ERROR ("Malformed database database.autocommit value: %s", autocommit_str);
496 status = _notmuch_database_setup_standard_query_fields (notmuch);
500 status = _notmuch_database_setup_user_query_fields (notmuch);
504 } catch (const Xapian::Error &error) {
505 IGNORE_RESULT (asprintf (&message, "A Xapian exception occurred opening database: %s\n",
506 error.get_msg ().c_str ()));
507 status = NOTMUCH_STATUS_XAPIAN_EXCEPTION;
511 *message_ptr = message;
516 notmuch_database_open_with_config (const char *database_path,
517 notmuch_database_mode_t mode,
518 const char *config_path,
520 notmuch_database_t **database,
521 char **status_string)
523 notmuch_status_t status = NOTMUCH_STATUS_SUCCESS;
524 notmuch_database_t *notmuch = NULL;
525 char *message = NULL;
526 GKeyFile *key_file = NULL;
530 notmuch = _alloc_notmuch (database_path, config_path, profile);
532 status = NOTMUCH_STATUS_OUT_OF_MEMORY;
536 status = _load_key_file (notmuch, config_path, profile, &key_file);
538 message = strdup ("Error: cannot load config file.\n");
542 if ((status = _choose_database_path (notmuch, profile, key_file,
547 status = _db_dir_exists (database_path, &message);
551 _set_database_path (notmuch, database_path);
553 status = _notmuch_choose_xapian_path (notmuch, database_path,
554 ¬much->xapian_path, &message);
558 status = _finish_open (notmuch, profile, mode, key_file, &message);
562 g_key_file_free (key_file);
566 *status_string = message;
571 if (status && notmuch) {
572 notmuch_database_destroy (notmuch);
580 notmuch->open = true;
586 notmuch_database_create (const char *path, notmuch_database_t **database)
588 char *status_string = NULL;
589 notmuch_status_t status;
591 status = notmuch_database_create_verbose (path, database,
595 fputs (status_string, stderr);
596 free (status_string);
603 notmuch_database_create_verbose (const char *path,
604 notmuch_database_t **database,
605 char **status_string)
607 return notmuch_database_create_with_config (path, "", NULL, database, status_string);
611 notmuch_database_create_with_config (const char *database_path,
612 const char *config_path,
614 notmuch_database_t **database,
615 char **status_string)
617 notmuch_status_t status = NOTMUCH_STATUS_SUCCESS;
618 notmuch_database_t *notmuch = NULL;
619 const char *notmuch_path = NULL;
620 char *message = NULL;
621 GKeyFile *key_file = NULL;
625 notmuch = _alloc_notmuch (database_path, config_path, profile);
627 status = NOTMUCH_STATUS_OUT_OF_MEMORY;
631 status = _load_key_file (notmuch, config_path, profile, &key_file);
633 message = strdup ("Error: cannot load config file.\n");
637 if ((status = _choose_database_path (notmuch, profile, key_file,
638 &database_path, &message)))
641 status = _db_dir_exists (database_path, &message);
645 _set_database_path (notmuch, database_path);
647 if (key_file && ! (notmuch->params & NOTMUCH_PARAM_SPLIT)) {
648 char *mail_root = notmuch_canonicalize_file_name (
649 g_key_file_get_string (key_file, "database", "mail_root", NULL));
650 char *db_path = notmuch_canonicalize_file_name (database_path);
652 if (mail_root && (0 != strcmp (mail_root, db_path)))
653 notmuch->params |= NOTMUCH_PARAM_SPLIT;
659 if (notmuch->params & NOTMUCH_PARAM_SPLIT) {
660 notmuch_path = database_path;
662 if (! (notmuch_path = talloc_asprintf (notmuch, "%s/%s", database_path, ".notmuch"))) {
663 status = NOTMUCH_STATUS_OUT_OF_MEMORY;
667 status = _mkdir (notmuch_path, &message);
672 if (! (notmuch->xapian_path = talloc_asprintf (notmuch, "%s/%s", notmuch_path, "xapian"))) {
673 status = NOTMUCH_STATUS_OUT_OF_MEMORY;
677 status = _trial_open (notmuch->xapian_path, &message);
678 if (status == NOTMUCH_STATUS_SUCCESS) {
679 notmuch_database_destroy (notmuch);
681 status = NOTMUCH_STATUS_DATABASE_EXISTS;
688 status = _finish_open (notmuch,
690 NOTMUCH_DATABASE_MODE_READ_WRITE,
696 /* Upgrade doesn't add these feature to existing databases, but
697 * new databases have them. */
698 notmuch->features |= NOTMUCH_FEATURE_FROM_SUBJECT_ID_VALUES;
699 notmuch->features |= NOTMUCH_FEATURE_INDEXED_MIMETYPES;
700 notmuch->features |= NOTMUCH_FEATURE_UNPREFIX_BODY_ONLY;
702 status = notmuch_database_upgrade (notmuch, NULL, NULL);
704 notmuch_database_close (notmuch);
710 g_key_file_free (key_file);
714 *status_string = message;
718 if (status && notmuch) {
719 notmuch_database_destroy (notmuch);
727 notmuch->open = true;
732 notmuch_database_reopen (notmuch_database_t *notmuch,
733 notmuch_database_mode_t new_mode)
735 notmuch_database_mode_t cur_mode = _notmuch_database_mode (notmuch);
737 if (notmuch->xapian_db == NULL) {
738 _notmuch_database_log (notmuch, "Cannot reopen closed or nonexistent database\n");
739 return NOTMUCH_STATUS_ILLEGAL_ARGUMENT;
743 if (cur_mode == new_mode &&
744 new_mode == NOTMUCH_DATABASE_MODE_READ_ONLY) {
745 notmuch->xapian_db->reopen ();
747 notmuch->xapian_db->close ();
749 delete notmuch->xapian_db;
750 notmuch->xapian_db = NULL;
751 /* no need to free the same object twice */
752 notmuch->writable_xapian_db = NULL;
754 if (new_mode == NOTMUCH_DATABASE_MODE_READ_WRITE) {
755 notmuch->writable_xapian_db = new Xapian::WritableDatabase (notmuch->xapian_path,
757 notmuch->xapian_db = notmuch->writable_xapian_db;
759 notmuch->xapian_db = new Xapian::Database (notmuch->xapian_path,
764 _load_database_state (notmuch);
765 } catch (const Xapian::Error &error) {
766 if (! notmuch->exception_reported) {
767 _notmuch_database_log (notmuch, "Error: A Xapian exception reopening database: %s\n",
768 error.get_msg ().c_str ());
769 notmuch->exception_reported = true;
771 return NOTMUCH_STATUS_XAPIAN_EXCEPTION;
775 notmuch->open = true;
776 return NOTMUCH_STATUS_SUCCESS;
779 static notmuch_status_t
780 _maybe_load_config_from_database (notmuch_database_t *notmuch,
782 const char *database_path,
785 char *message; /* ignored */
787 if (_db_dir_exists (database_path, &message))
788 return NOTMUCH_STATUS_NO_DATABASE;
790 _set_database_path (notmuch, database_path);
792 if (_notmuch_choose_xapian_path (notmuch, database_path, ¬much->xapian_path, &message))
793 return NOTMUCH_STATUS_NO_DATABASE;
795 (void) _finish_open (notmuch, profile, NOTMUCH_DATABASE_MODE_READ_ONLY, key_file, &message);
797 return NOTMUCH_STATUS_SUCCESS;
801 notmuch_database_load_config (const char *database_path,
802 const char *config_path,
804 notmuch_database_t **database,
805 char **status_string)
807 notmuch_status_t status = NOTMUCH_STATUS_SUCCESS, warning = NOTMUCH_STATUS_SUCCESS;
808 notmuch_database_t *notmuch = NULL;
809 char *message = NULL;
810 GKeyFile *key_file = NULL;
814 notmuch = _alloc_notmuch (database_path, config_path, profile);
816 status = NOTMUCH_STATUS_OUT_OF_MEMORY;
820 status = _load_key_file (notmuch, config_path, profile, &key_file);
822 case NOTMUCH_STATUS_SUCCESS:
824 case NOTMUCH_STATUS_NO_CONFIG:
828 message = strdup ("Error: cannot load config file.\n");
832 status = _choose_database_path (notmuch, profile, key_file,
833 &database_path, &message);
835 case NOTMUCH_STATUS_NO_DATABASE:
836 case NOTMUCH_STATUS_SUCCESS:
846 status = _maybe_load_config_from_database (notmuch, key_file, database_path, profile);
848 case NOTMUCH_STATUS_NO_DATABASE:
849 case NOTMUCH_STATUS_SUCCESS:
859 status = _notmuch_config_load_from_file (notmuch, key_file);
863 status = _notmuch_config_load_defaults (notmuch);
869 *status_string = message;
872 status != NOTMUCH_STATUS_NO_DATABASE
873 && status != NOTMUCH_STATUS_NO_CONFIG) {
874 notmuch_database_destroy (notmuch);