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_database_t *
248 _alloc_notmuch (const char *database_path, const char *config_path, const char *profile)
250 notmuch_database_t *notmuch;
252 notmuch = talloc_zero (NULL, notmuch_database_t);
256 notmuch->exception_reported = false;
257 notmuch->status_string = NULL;
258 notmuch->writable_xapian_db = NULL;
259 notmuch->config_path = NULL;
260 notmuch->atomic_nesting = 0;
261 notmuch->transaction_count = 0;
262 notmuch->transaction_threshold = 0;
265 notmuch->params = NOTMUCH_PARAM_NONE;
267 notmuch->params |= NOTMUCH_PARAM_DATABASE;
269 notmuch->params |= NOTMUCH_PARAM_CONFIG;
271 notmuch->params |= NOTMUCH_PARAM_PROFILE;
276 static notmuch_status_t
277 _trial_open (const char *xapian_path, char **message_ptr)
280 Xapian::Database db (xapian_path);
281 } catch (const Xapian::DatabaseOpeningError &error) {
282 IGNORE_RESULT (asprintf (message_ptr,
283 "Cannot open Xapian database at %s: %s\n",
285 error.get_msg ().c_str ()));
286 return NOTMUCH_STATUS_PATH_ERROR;
287 } catch (const Xapian::Error &error) {
288 IGNORE_RESULT (asprintf (message_ptr,
289 "A Xapian exception occurred opening database: %s\n",
290 error.get_msg ().c_str ()));
291 return NOTMUCH_STATUS_XAPIAN_EXCEPTION;
293 return NOTMUCH_STATUS_SUCCESS;
297 _notmuch_choose_xapian_path (void *ctx, const char *database_path,
298 const char **xapian_path, char **message_ptr)
300 notmuch_status_t status;
301 const char *trial_path, *notmuch_path;
303 status = _db_dir_exists (database_path, message_ptr);
307 trial_path = talloc_asprintf (ctx, "%s/xapian", database_path);
308 status = _trial_open (trial_path, message_ptr);
309 if (status != NOTMUCH_STATUS_PATH_ERROR)
315 notmuch_path = talloc_asprintf (ctx, "%s/.notmuch", database_path);
316 status = _db_dir_exists (notmuch_path, message_ptr);
320 trial_path = talloc_asprintf (ctx, "%s/xapian", notmuch_path);
321 status = _trial_open (trial_path, message_ptr);
324 if (status == NOTMUCH_STATUS_SUCCESS)
325 *xapian_path = trial_path;
330 _set_database_path (notmuch_database_t *notmuch,
331 const char *database_path)
333 char *path = talloc_strdup (notmuch, database_path);
335 strip_trailing (path, '/');
337 _notmuch_config_cache (notmuch, NOTMUCH_CONFIG_DATABASE_PATH, path);
341 _load_database_state (notmuch_database_t *notmuch)
343 std::string last_thread_id;
344 std::string last_mod;
346 notmuch->last_doc_id = notmuch->xapian_db->get_lastdocid ();
347 last_thread_id = notmuch->xapian_db->get_metadata ("last_thread_id");
348 if (last_thread_id.empty ()) {
349 notmuch->last_thread_id = 0;
354 str = last_thread_id.c_str ();
355 notmuch->last_thread_id = strtoull (str, &end, 16);
357 INTERNAL_ERROR ("Malformed database last_thread_id: %s", str);
360 /* Get current highest revision number. */
361 last_mod = notmuch->xapian_db->get_value_upper_bound (
362 NOTMUCH_VALUE_LAST_MOD);
363 if (last_mod.empty ())
364 notmuch->revision = 0;
366 notmuch->revision = Xapian::sortable_unserialise (last_mod);
367 notmuch->uuid = talloc_strdup (
368 notmuch, notmuch->xapian_db->get_uuid ().c_str ());
371 static notmuch_status_t
372 _finish_open (notmuch_database_t *notmuch,
374 notmuch_database_mode_t mode,
378 notmuch_status_t status = NOTMUCH_STATUS_SUCCESS;
379 char *incompat_features;
380 char *message = NULL;
381 const char *autocommit_str;
382 char *autocommit_end;
383 unsigned int version;
384 const char *database_path = notmuch_database_get_path (notmuch);
388 if (mode == NOTMUCH_DATABASE_MODE_READ_WRITE) {
389 notmuch->writable_xapian_db = new Xapian::WritableDatabase (notmuch->xapian_path,
391 notmuch->xapian_db = notmuch->writable_xapian_db;
393 notmuch->xapian_db = new Xapian::Database (notmuch->xapian_path);
396 /* Check version. As of database version 3, we represent
397 * changes in terms of features, so assume a version bump
398 * means a dramatically incompatible change. */
399 version = notmuch_database_get_version (notmuch);
400 if (version > NOTMUCH_DATABASE_VERSION) {
401 IGNORE_RESULT (asprintf (&message,
402 "Error: Notmuch database at %s\n"
403 " has a newer database format version (%u) than supported by this\n"
404 " version of notmuch (%u).\n",
405 database_path, version, NOTMUCH_DATABASE_VERSION));
406 status = NOTMUCH_STATUS_FILE_ERROR;
410 /* Check features. */
411 incompat_features = NULL;
412 notmuch->features = _notmuch_database_parse_features (
413 notmuch, notmuch->xapian_db->get_metadata ("features").c_str (),
414 version, mode == NOTMUCH_DATABASE_MODE_READ_WRITE ? 'w' : 'r',
416 if (incompat_features) {
417 IGNORE_RESULT (asprintf (&message,
418 "Error: Notmuch database at %s\n"
419 " requires features (%s)\n"
420 " not supported by this version of notmuch.\n",
421 database_path, incompat_features));
422 status = NOTMUCH_STATUS_FILE_ERROR;
426 _load_database_state (notmuch);
428 notmuch->query_parser = new Xapian::QueryParser;
429 notmuch->term_gen = new Xapian::TermGenerator;
430 notmuch->term_gen->set_stemmer (Xapian::Stem ("english"));
431 notmuch->value_range_processor = new Xapian::NumberRangeProcessor (NOTMUCH_VALUE_TIMESTAMP);
432 notmuch->date_range_processor = new ParseTimeRangeProcessor (NOTMUCH_VALUE_TIMESTAMP,
434 notmuch->last_mod_range_processor = new Xapian::NumberRangeProcessor (NOTMUCH_VALUE_LAST_MOD,
436 notmuch->query_parser->set_default_op (Xapian::Query::OP_AND);
437 notmuch->query_parser->set_database (*notmuch->xapian_db);
438 notmuch->stemmer = new Xapian::Stem ("english");
439 notmuch->query_parser->set_stemmer (*notmuch->stemmer);
440 notmuch->query_parser->set_stemming_strategy (Xapian::QueryParser::STEM_SOME);
441 notmuch->query_parser->add_rangeprocessor (notmuch->value_range_processor);
442 notmuch->query_parser->add_rangeprocessor (notmuch->date_range_processor);
443 notmuch->query_parser->add_rangeprocessor (notmuch->last_mod_range_processor);
445 /* Configuration information is needed to set up query parser */
446 status = _notmuch_config_load_from_database (notmuch);
451 status = _notmuch_config_load_from_file (notmuch, key_file);
455 status = _choose_dir (notmuch, profile,
456 NOTMUCH_CONFIG_HOOK_DIR,
464 status = _choose_dir (notmuch, profile,
465 NOTMUCH_CONFIG_BACKUP_DIR,
472 status = _notmuch_config_load_defaults (notmuch);
476 autocommit_str = notmuch_config_get (notmuch, NOTMUCH_CONFIG_AUTOCOMMIT);
477 if (unlikely (! autocommit_str)) {
478 INTERNAL_ERROR ("missing configuration for autocommit");
480 notmuch->transaction_threshold = strtoul (autocommit_str, &autocommit_end, 10);
481 if (*autocommit_end != '\0')
482 INTERNAL_ERROR ("Malformed database database.autocommit value: %s", autocommit_str);
484 status = _notmuch_database_setup_standard_query_fields (notmuch);
488 status = _notmuch_database_setup_user_query_fields (notmuch);
492 } catch (const Xapian::Error &error) {
493 IGNORE_RESULT (asprintf (&message, "A Xapian exception occurred opening database: %s\n",
494 error.get_msg ().c_str ()));
495 status = NOTMUCH_STATUS_XAPIAN_EXCEPTION;
499 *message_ptr = message;
504 notmuch_database_open_with_config (const char *database_path,
505 notmuch_database_mode_t mode,
506 const char *config_path,
508 notmuch_database_t **database,
509 char **status_string)
511 notmuch_status_t status = NOTMUCH_STATUS_SUCCESS;
512 notmuch_database_t *notmuch = NULL;
513 char *message = NULL;
514 GKeyFile *key_file = NULL;
518 notmuch = _alloc_notmuch (database_path, config_path, profile);
520 status = NOTMUCH_STATUS_OUT_OF_MEMORY;
524 status = _load_key_file (notmuch, config_path, profile, &key_file);
526 message = strdup ("Error: cannot load config file.\n");
530 if ((status = _choose_database_path (notmuch, profile, key_file,
535 status = _db_dir_exists (database_path, &message);
539 _set_database_path (notmuch, database_path);
541 status = _notmuch_choose_xapian_path (notmuch, database_path,
542 ¬much->xapian_path, &message);
546 status = _finish_open (notmuch, profile, mode, key_file, &message);
550 g_key_file_free (key_file);
554 *status_string = message;
559 if (status && notmuch) {
560 notmuch_database_destroy (notmuch);
568 notmuch->open = true;
574 notmuch_database_create (const char *path, notmuch_database_t **database)
576 char *status_string = NULL;
577 notmuch_status_t status;
579 status = notmuch_database_create_verbose (path, database,
583 fputs (status_string, stderr);
584 free (status_string);
591 notmuch_database_create_verbose (const char *path,
592 notmuch_database_t **database,
593 char **status_string)
595 return notmuch_database_create_with_config (path, "", NULL, database, status_string);
599 notmuch_database_create_with_config (const char *database_path,
600 const char *config_path,
602 notmuch_database_t **database,
603 char **status_string)
605 notmuch_status_t status = NOTMUCH_STATUS_SUCCESS;
606 notmuch_database_t *notmuch = NULL;
607 const char *notmuch_path = NULL;
608 char *message = NULL;
609 GKeyFile *key_file = NULL;
614 notmuch = _alloc_notmuch (database_path, config_path, profile);
616 status = NOTMUCH_STATUS_OUT_OF_MEMORY;
620 status = _load_key_file (notmuch, config_path, profile, &key_file);
622 message = strdup ("Error: cannot load config file.\n");
626 if ((status = _choose_database_path (notmuch, profile, key_file,
627 &database_path, &message)))
630 status = _db_dir_exists (database_path, &message);
634 _set_database_path (notmuch, database_path);
636 if (key_file && ! (notmuch->params & NOTMUCH_PARAM_SPLIT)) {
637 char *mail_root = notmuch_canonicalize_file_name (
638 g_key_file_get_string (key_file, "database", "mail_root", NULL));
639 char *db_path = notmuch_canonicalize_file_name (database_path);
641 if (mail_root && (0 != strcmp (mail_root, db_path)))
642 notmuch->params |= NOTMUCH_PARAM_SPLIT;
648 if (notmuch->params & NOTMUCH_PARAM_SPLIT) {
649 notmuch_path = database_path;
651 if (! (notmuch_path = talloc_asprintf (notmuch, "%s/%s", database_path, ".notmuch"))) {
652 status = NOTMUCH_STATUS_OUT_OF_MEMORY;
656 err = mkdir (notmuch_path, 0755);
658 if (errno != EEXIST) {
659 IGNORE_RESULT (asprintf (&message, "Error: Cannot create directory %s: %s.\n",
660 notmuch_path, strerror (errno)));
661 status = NOTMUCH_STATUS_FILE_ERROR;
667 if (! (notmuch->xapian_path = talloc_asprintf (notmuch, "%s/%s", notmuch_path, "xapian"))) {
668 status = NOTMUCH_STATUS_OUT_OF_MEMORY;
672 status = _trial_open (notmuch->xapian_path, &message);
673 if (status == NOTMUCH_STATUS_SUCCESS) {
674 notmuch_database_destroy (notmuch);
676 status = NOTMUCH_STATUS_DATABASE_EXISTS;
683 status = _finish_open (notmuch,
685 NOTMUCH_DATABASE_MODE_READ_WRITE,
691 /* Upgrade doesn't add these feature to existing databases, but
692 * new databases have them. */
693 notmuch->features |= NOTMUCH_FEATURE_FROM_SUBJECT_ID_VALUES;
694 notmuch->features |= NOTMUCH_FEATURE_INDEXED_MIMETYPES;
695 notmuch->features |= NOTMUCH_FEATURE_UNPREFIX_BODY_ONLY;
697 status = notmuch_database_upgrade (notmuch, NULL, NULL);
699 notmuch_database_close (notmuch);
705 g_key_file_free (key_file);
709 *status_string = message;
713 if (status && notmuch) {
714 notmuch_database_destroy (notmuch);
722 notmuch->open = true;
727 notmuch_database_reopen (notmuch_database_t *notmuch,
728 notmuch_database_mode_t new_mode)
730 notmuch_database_mode_t cur_mode = _notmuch_database_mode (notmuch);
732 if (notmuch->xapian_db == NULL) {
733 _notmuch_database_log (notmuch, "Cannot reopen closed or nonexistent database\n");
734 return NOTMUCH_STATUS_ILLEGAL_ARGUMENT;
738 if (cur_mode == new_mode &&
739 new_mode == NOTMUCH_DATABASE_MODE_READ_ONLY) {
740 notmuch->xapian_db->reopen ();
742 notmuch->xapian_db->close ();
744 delete notmuch->xapian_db;
745 notmuch->xapian_db = NULL;
746 /* no need to free the same object twice */
747 notmuch->writable_xapian_db = NULL;
749 if (new_mode == NOTMUCH_DATABASE_MODE_READ_WRITE) {
750 notmuch->writable_xapian_db = new Xapian::WritableDatabase (notmuch->xapian_path,
752 notmuch->xapian_db = notmuch->writable_xapian_db;
754 notmuch->xapian_db = new Xapian::Database (notmuch->xapian_path,
759 _load_database_state (notmuch);
760 } catch (const Xapian::Error &error) {
761 if (! notmuch->exception_reported) {
762 _notmuch_database_log (notmuch, "Error: A Xapian exception reopening database: %s\n",
763 error.get_msg ().c_str ());
764 notmuch->exception_reported = true;
766 return NOTMUCH_STATUS_XAPIAN_EXCEPTION;
770 notmuch->open = true;
771 return NOTMUCH_STATUS_SUCCESS;
774 static notmuch_status_t
775 _maybe_load_config_from_database (notmuch_database_t *notmuch,
777 const char *database_path,
780 char *message; /* ignored */
782 if (_db_dir_exists (database_path, &message))
783 return NOTMUCH_STATUS_NO_DATABASE;
785 _set_database_path (notmuch, database_path);
787 if (_notmuch_choose_xapian_path (notmuch, database_path, ¬much->xapian_path, &message))
788 return NOTMUCH_STATUS_NO_DATABASE;
790 (void) _finish_open (notmuch, profile, NOTMUCH_DATABASE_MODE_READ_ONLY, key_file, &message);
792 return NOTMUCH_STATUS_SUCCESS;
796 notmuch_database_load_config (const char *database_path,
797 const char *config_path,
799 notmuch_database_t **database,
800 char **status_string)
802 notmuch_status_t status = NOTMUCH_STATUS_SUCCESS, warning = NOTMUCH_STATUS_SUCCESS;
803 notmuch_database_t *notmuch = NULL;
804 char *message = NULL;
805 GKeyFile *key_file = NULL;
809 notmuch = _alloc_notmuch (database_path, config_path, profile);
811 status = NOTMUCH_STATUS_OUT_OF_MEMORY;
815 status = _load_key_file (notmuch, config_path, profile, &key_file);
817 case NOTMUCH_STATUS_SUCCESS:
819 case NOTMUCH_STATUS_NO_CONFIG:
823 message = strdup ("Error: cannot load config file.\n");
827 status = _choose_database_path (notmuch, profile, key_file,
828 &database_path, &message);
830 case NOTMUCH_STATUS_NO_DATABASE:
831 case NOTMUCH_STATUS_SUCCESS:
841 status = _maybe_load_config_from_database (notmuch, key_file, database_path, profile);
843 case NOTMUCH_STATUS_NO_DATABASE:
844 case NOTMUCH_STATUS_SUCCESS:
854 status = _notmuch_config_load_from_file (notmuch, key_file);
858 status = _notmuch_config_load_defaults (notmuch);
864 *status_string = message;
867 status != NOTMUCH_STATUS_NO_DATABASE
868 && status != NOTMUCH_STATUS_NO_CONFIG) {
869 notmuch_database_destroy (notmuch);