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 *
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;
269 static notmuch_status_t
270 _trial_open (const char *xapian_path, char **message_ptr)
273 Xapian::Database db (xapian_path);
274 } catch (const Xapian::DatabaseOpeningError &error) {
275 IGNORE_RESULT (asprintf (message_ptr,
276 "Cannot open Xapian database at %s: %s\n",
278 error.get_msg ().c_str ()));
279 return NOTMUCH_STATUS_PATH_ERROR;
280 } catch (const Xapian::Error &error) {
281 IGNORE_RESULT (asprintf (message_ptr,
282 "A Xapian exception occurred opening database: %s\n",
283 error.get_msg ().c_str ()));
284 return NOTMUCH_STATUS_XAPIAN_EXCEPTION;
286 return NOTMUCH_STATUS_SUCCESS;
290 _notmuch_choose_xapian_path (void *ctx, const char *database_path,
291 const char **xapian_path, char **message_ptr)
293 notmuch_status_t status;
294 const char *trial_path, *notmuch_path;
296 status = _db_dir_exists (database_path, message_ptr);
300 trial_path = talloc_asprintf (ctx, "%s/xapian", database_path);
301 status = _trial_open (trial_path, message_ptr);
302 if (status != NOTMUCH_STATUS_PATH_ERROR)
308 notmuch_path = talloc_asprintf (ctx, "%s/.notmuch", database_path);
309 status = _db_dir_exists (notmuch_path, message_ptr);
313 trial_path = talloc_asprintf (ctx, "%s/xapian", notmuch_path);
314 status = _trial_open (trial_path, message_ptr);
317 if (status == NOTMUCH_STATUS_SUCCESS)
318 *xapian_path = trial_path;
323 _set_database_path (notmuch_database_t *notmuch,
324 const char *database_path)
326 char *path = talloc_strdup (notmuch, database_path);
328 strip_trailing (path, '/');
330 _notmuch_config_cache (notmuch, NOTMUCH_CONFIG_DATABASE_PATH, path);
334 _load_database_state (notmuch_database_t *notmuch)
336 std::string last_thread_id;
337 std::string last_mod;
339 notmuch->last_doc_id = notmuch->xapian_db->get_lastdocid ();
340 last_thread_id = notmuch->xapian_db->get_metadata ("last_thread_id");
341 if (last_thread_id.empty ()) {
342 notmuch->last_thread_id = 0;
347 str = last_thread_id.c_str ();
348 notmuch->last_thread_id = strtoull (str, &end, 16);
350 INTERNAL_ERROR ("Malformed database last_thread_id: %s", str);
353 /* Get current highest revision number. */
354 last_mod = notmuch->xapian_db->get_value_upper_bound (
355 NOTMUCH_VALUE_LAST_MOD);
356 if (last_mod.empty ())
357 notmuch->revision = 0;
359 notmuch->revision = Xapian::sortable_unserialise (last_mod);
360 notmuch->uuid = talloc_strdup (
361 notmuch, notmuch->xapian_db->get_uuid ().c_str ());
364 static notmuch_status_t
365 _finish_open (notmuch_database_t *notmuch,
367 notmuch_database_mode_t mode,
371 notmuch_status_t status = NOTMUCH_STATUS_SUCCESS;
372 char *incompat_features;
373 char *message = NULL;
374 const char *autocommit_str;
375 char *autocommit_end;
376 unsigned int version;
377 const char *database_path = notmuch_database_get_path (notmuch);
381 if (mode == NOTMUCH_DATABASE_MODE_READ_WRITE) {
382 notmuch->writable_xapian_db = new Xapian::WritableDatabase (notmuch->xapian_path,
384 notmuch->xapian_db = notmuch->writable_xapian_db;
386 notmuch->xapian_db = new Xapian::Database (notmuch->xapian_path);
389 /* Check version. As of database version 3, we represent
390 * changes in terms of features, so assume a version bump
391 * means a dramatically incompatible change. */
392 version = notmuch_database_get_version (notmuch);
393 if (version > NOTMUCH_DATABASE_VERSION) {
394 IGNORE_RESULT (asprintf (&message,
395 "Error: Notmuch database at %s\n"
396 " has a newer database format version (%u) than supported by this\n"
397 " version of notmuch (%u).\n",
398 database_path, version, NOTMUCH_DATABASE_VERSION));
399 notmuch_database_destroy (notmuch);
401 status = NOTMUCH_STATUS_FILE_ERROR;
405 /* Check features. */
406 incompat_features = NULL;
407 notmuch->features = _notmuch_database_parse_features (
408 notmuch, notmuch->xapian_db->get_metadata ("features").c_str (),
409 version, mode == NOTMUCH_DATABASE_MODE_READ_WRITE ? 'w' : 'r',
411 if (incompat_features) {
412 IGNORE_RESULT (asprintf (&message,
413 "Error: Notmuch database at %s\n"
414 " requires features (%s)\n"
415 " not supported by this version of notmuch.\n",
416 database_path, incompat_features));
417 notmuch_database_destroy (notmuch);
419 status = NOTMUCH_STATUS_FILE_ERROR;
423 _load_database_state (notmuch);
425 notmuch->query_parser = new Xapian::QueryParser;
426 notmuch->term_gen = new Xapian::TermGenerator;
427 notmuch->term_gen->set_stemmer (Xapian::Stem ("english"));
428 notmuch->value_range_processor = new Xapian::NumberRangeProcessor (NOTMUCH_VALUE_TIMESTAMP);
429 notmuch->date_range_processor = new ParseTimeRangeProcessor (NOTMUCH_VALUE_TIMESTAMP,
431 notmuch->last_mod_range_processor = new Xapian::NumberRangeProcessor (NOTMUCH_VALUE_LAST_MOD,
433 notmuch->query_parser->set_default_op (Xapian::Query::OP_AND);
434 notmuch->query_parser->set_database (*notmuch->xapian_db);
435 notmuch->stemmer = new Xapian::Stem ("english");
436 notmuch->query_parser->set_stemmer (*notmuch->stemmer);
437 notmuch->query_parser->set_stemming_strategy (Xapian::QueryParser::STEM_SOME);
438 notmuch->query_parser->add_rangeprocessor (notmuch->value_range_processor);
439 notmuch->query_parser->add_rangeprocessor (notmuch->date_range_processor);
440 notmuch->query_parser->add_rangeprocessor (notmuch->last_mod_range_processor);
442 /* Configuration information is needed to set up query parser */
443 status = _notmuch_config_load_from_database (notmuch);
448 status = _notmuch_config_load_from_file (notmuch, key_file);
452 status = _choose_dir (notmuch, profile,
453 NOTMUCH_CONFIG_HOOK_DIR,
461 status = _choose_dir (notmuch, profile,
462 NOTMUCH_CONFIG_BACKUP_DIR,
469 status = _notmuch_config_load_defaults (notmuch);
473 autocommit_str = notmuch_config_get (notmuch, NOTMUCH_CONFIG_AUTOCOMMIT);
474 if (unlikely (! autocommit_str)) {
475 INTERNAL_ERROR ("missing configuration for autocommit");
477 notmuch->transaction_threshold = strtoul (autocommit_str, &autocommit_end, 10);
478 if (*autocommit_end != '\0')
479 INTERNAL_ERROR ("Malformed database database.autocommit value: %s", autocommit_str);
481 status = _notmuch_database_setup_standard_query_fields (notmuch);
485 status = _notmuch_database_setup_user_query_fields (notmuch);
489 } catch (const Xapian::Error &error) {
490 IGNORE_RESULT (asprintf (&message, "A Xapian exception occurred opening database: %s\n",
491 error.get_msg ().c_str ()));
492 notmuch_database_destroy (notmuch);
494 status = NOTMUCH_STATUS_XAPIAN_EXCEPTION;
498 *message_ptr = message;
503 notmuch_database_open_with_config (const char *database_path,
504 notmuch_database_mode_t mode,
505 const char *config_path,
507 notmuch_database_t **database,
508 char **status_string)
510 notmuch_status_t status = NOTMUCH_STATUS_SUCCESS;
511 void *local = talloc_new (NULL);
512 notmuch_database_t *notmuch = NULL;
513 char *message = NULL;
514 GKeyFile *key_file = NULL;
519 notmuch = _alloc_notmuch ();
521 status = NOTMUCH_STATUS_OUT_OF_MEMORY;
525 status = _load_key_file (notmuch, config_path, profile, &key_file);
527 message = strdup ("Error: cannot load config file.\n");
531 if ((status = _choose_database_path (local, profile, key_file,
532 &database_path, &split,
536 status = _db_dir_exists (database_path, &message);
540 _set_database_path (notmuch, database_path);
542 status = _notmuch_choose_xapian_path (notmuch, database_path,
543 ¬much->xapian_path, &message);
547 status = _finish_open (notmuch, profile, mode, key_file, &message);
553 g_key_file_free (key_file);
557 *status_string = message;
565 talloc_free (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;
610 void *local = talloc_new (NULL);
616 notmuch = _alloc_notmuch ();
618 status = NOTMUCH_STATUS_OUT_OF_MEMORY;
622 status = _load_key_file (notmuch, config_path, profile, &key_file);
624 message = strdup ("Error: cannot load config file.\n");
628 if ((status = _choose_database_path (local, profile, key_file,
629 &database_path, &split, &message)))
632 status = _db_dir_exists (database_path, &message);
636 _set_database_path (notmuch, database_path);
638 if (key_file && ! split) {
639 char *mail_root = notmuch_canonicalize_file_name (
640 g_key_file_get_value (key_file, "database", "mail_root", NULL));
641 char *db_path = notmuch_canonicalize_file_name (database_path);
643 split = (mail_root && (0 != strcmp (mail_root, db_path)));
650 notmuch_path = database_path;
652 if (! (notmuch_path = talloc_asprintf (local, "%s/%s", database_path, ".notmuch"))) {
653 status = NOTMUCH_STATUS_OUT_OF_MEMORY;
657 err = mkdir (notmuch_path, 0755);
659 if (errno == EEXIST) {
660 status = NOTMUCH_STATUS_DATABASE_EXISTS;
661 talloc_free (notmuch);
664 IGNORE_RESULT (asprintf (&message, "Error: Cannot create directory %s: %s.\n",
665 notmuch_path, strerror (errno)));
666 status = NOTMUCH_STATUS_FILE_ERROR;
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);
712 g_key_file_free (key_file);
716 *status_string = message;
723 talloc_free (notmuch);
728 notmuch_database_reopen (notmuch_database_t *notmuch,
729 notmuch_database_mode_t new_mode)
731 notmuch_database_mode_t cur_mode = _notmuch_database_mode (notmuch);
733 if (notmuch->xapian_db == NULL) {
734 _notmuch_database_log (notmuch, "Cannot reopen closed or nonexistent database\n");
735 return NOTMUCH_STATUS_ILLEGAL_ARGUMENT;
739 if (cur_mode == new_mode &&
740 new_mode == NOTMUCH_DATABASE_MODE_READ_ONLY) {
741 notmuch->xapian_db->reopen ();
743 notmuch->xapian_db->close ();
745 delete notmuch->xapian_db;
746 notmuch->xapian_db = NULL;
747 /* no need to free the same object twice */
748 notmuch->writable_xapian_db = NULL;
750 if (new_mode == NOTMUCH_DATABASE_MODE_READ_WRITE) {
751 notmuch->writable_xapian_db = new Xapian::WritableDatabase (notmuch->xapian_path,
753 notmuch->xapian_db = notmuch->writable_xapian_db;
755 notmuch->xapian_db = new Xapian::Database (notmuch->xapian_path,
760 _load_database_state (notmuch);
761 } catch (const Xapian::Error &error) {
762 if (! notmuch->exception_reported) {
763 _notmuch_database_log (notmuch, "Error: A Xapian exception reopening database: %s\n",
764 error.get_msg ().c_str ());
765 notmuch->exception_reported = true;
767 return NOTMUCH_STATUS_XAPIAN_EXCEPTION;
771 notmuch->open = true;
772 return NOTMUCH_STATUS_SUCCESS;
775 static notmuch_status_t
776 _maybe_load_config_from_database (notmuch_database_t *notmuch,
778 const char *database_path,
781 char *message; /* ignored */
783 if (_db_dir_exists (database_path, &message))
784 return NOTMUCH_STATUS_NO_DATABASE;
786 _set_database_path (notmuch, database_path);
788 if (_notmuch_choose_xapian_path (notmuch, database_path, ¬much->xapian_path, &message))
789 return NOTMUCH_STATUS_NO_DATABASE;
791 (void) _finish_open (notmuch, profile, NOTMUCH_DATABASE_MODE_READ_ONLY, key_file, &message);
793 return NOTMUCH_STATUS_SUCCESS;
797 notmuch_database_load_config (const char *database_path,
798 const char *config_path,
800 notmuch_database_t **database,
801 char **status_string)
803 notmuch_status_t status = NOTMUCH_STATUS_SUCCESS, warning = NOTMUCH_STATUS_SUCCESS;
804 void *local = talloc_new (NULL);
805 notmuch_database_t *notmuch = NULL;
806 char *message = NULL;
807 GKeyFile *key_file = NULL;
812 notmuch = _alloc_notmuch ();
814 status = NOTMUCH_STATUS_OUT_OF_MEMORY;
818 status = _load_key_file (notmuch, config_path, profile, &key_file);
820 case NOTMUCH_STATUS_SUCCESS:
822 case NOTMUCH_STATUS_NO_CONFIG:
826 message = strdup ("Error: cannot load config file.\n");
830 status = _choose_database_path (local, profile, key_file,
831 &database_path, &split, &message);
833 case NOTMUCH_STATUS_NO_DATABASE:
834 case NOTMUCH_STATUS_SUCCESS:
844 status = _maybe_load_config_from_database (notmuch, key_file, database_path, profile);
846 case NOTMUCH_STATUS_NO_DATABASE:
847 case NOTMUCH_STATUS_SUCCESS:
857 status = _notmuch_config_load_from_file (notmuch, key_file);
861 status = _notmuch_config_load_defaults (notmuch);
869 *status_string = message;