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;
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);
331 static int initialized = 0;
333 /* Initialize the GLib type system and threads */
334 #if ! GLIB_CHECK_VERSION (2, 35, 1)
338 /* Initialize gmime */
346 _load_database_state (notmuch_database_t *notmuch)
348 std::string last_thread_id;
349 std::string last_mod;
351 notmuch->last_doc_id = notmuch->xapian_db->get_lastdocid ();
352 last_thread_id = notmuch->xapian_db->get_metadata ("last_thread_id");
353 if (last_thread_id.empty ()) {
354 notmuch->last_thread_id = 0;
359 str = last_thread_id.c_str ();
360 notmuch->last_thread_id = strtoull (str, &end, 16);
362 INTERNAL_ERROR ("Malformed database last_thread_id: %s", str);
365 /* Get current highest revision number. */
366 last_mod = notmuch->xapian_db->get_value_upper_bound (
367 NOTMUCH_VALUE_LAST_MOD);
368 if (last_mod.empty ())
369 notmuch->revision = 0;
371 notmuch->revision = Xapian::sortable_unserialise (last_mod);
372 notmuch->uuid = talloc_strdup (
373 notmuch, notmuch->xapian_db->get_uuid ().c_str ());
376 static notmuch_status_t
377 _finish_open (notmuch_database_t *notmuch,
379 notmuch_database_mode_t mode,
383 notmuch_status_t status = NOTMUCH_STATUS_SUCCESS;
384 char *incompat_features;
385 char *message = NULL;
386 unsigned int version;
387 const char *database_path = notmuch_database_get_path (notmuch);
391 if (mode == NOTMUCH_DATABASE_MODE_READ_WRITE) {
392 notmuch->writable_xapian_db = new Xapian::WritableDatabase (notmuch->xapian_path,
394 notmuch->xapian_db = notmuch->writable_xapian_db;
396 notmuch->xapian_db = new Xapian::Database (notmuch->xapian_path);
399 /* Check version. As of database version 3, we represent
400 * changes in terms of features, so assume a version bump
401 * means a dramatically incompatible change. */
402 version = notmuch_database_get_version (notmuch);
403 if (version > NOTMUCH_DATABASE_VERSION) {
404 IGNORE_RESULT (asprintf (&message,
405 "Error: Notmuch database at %s\n"
406 " has a newer database format version (%u) than supported by this\n"
407 " version of notmuch (%u).\n",
408 database_path, version, NOTMUCH_DATABASE_VERSION));
409 notmuch_database_destroy (notmuch);
411 status = NOTMUCH_STATUS_FILE_ERROR;
415 /* Check features. */
416 incompat_features = NULL;
417 notmuch->features = _notmuch_database_parse_features (
418 notmuch, notmuch->xapian_db->get_metadata ("features").c_str (),
419 version, mode == NOTMUCH_DATABASE_MODE_READ_WRITE ? 'w' : 'r',
421 if (incompat_features) {
422 IGNORE_RESULT (asprintf (&message,
423 "Error: Notmuch database at %s\n"
424 " requires features (%s)\n"
425 " not supported by this version of notmuch.\n",
426 database_path, incompat_features));
427 notmuch_database_destroy (notmuch);
429 status = NOTMUCH_STATUS_FILE_ERROR;
433 _load_database_state (notmuch);
435 notmuch->query_parser = new Xapian::QueryParser;
436 notmuch->term_gen = new Xapian::TermGenerator;
437 notmuch->term_gen->set_stemmer (Xapian::Stem ("english"));
438 notmuch->value_range_processor = new Xapian::NumberRangeProcessor (NOTMUCH_VALUE_TIMESTAMP);
439 notmuch->date_range_processor = new ParseTimeRangeProcessor (NOTMUCH_VALUE_TIMESTAMP,
441 notmuch->last_mod_range_processor = new Xapian::NumberRangeProcessor (NOTMUCH_VALUE_LAST_MOD,
443 notmuch->query_parser->set_default_op (Xapian::Query::OP_AND);
444 notmuch->query_parser->set_database (*notmuch->xapian_db);
445 notmuch->query_parser->set_stemmer (Xapian::Stem ("english"));
446 notmuch->query_parser->set_stemming_strategy (Xapian::QueryParser::STEM_SOME);
447 notmuch->query_parser->add_rangeprocessor (notmuch->value_range_processor);
448 notmuch->query_parser->add_rangeprocessor (notmuch->date_range_processor);
449 notmuch->query_parser->add_rangeprocessor (notmuch->last_mod_range_processor);
451 /* Configuration information is needed to set up query parser */
452 status = _notmuch_config_load_from_database (notmuch);
457 status = _notmuch_config_load_from_file (notmuch, key_file);
461 status = _choose_dir (notmuch, profile,
462 NOTMUCH_CONFIG_HOOK_DIR,
470 status = _choose_dir (notmuch, profile,
471 NOTMUCH_CONFIG_BACKUP_DIR,
478 status = _notmuch_config_load_defaults (notmuch);
482 status = _notmuch_database_setup_standard_query_fields (notmuch);
486 status = _notmuch_database_setup_user_query_fields (notmuch);
490 } catch (const Xapian::Error &error) {
491 IGNORE_RESULT (asprintf (&message, "A Xapian exception occurred opening database: %s\n",
492 error.get_msg ().c_str ()));
493 notmuch_database_destroy (notmuch);
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 void *local = talloc_new (NULL);
513 notmuch_database_t *notmuch = NULL;
514 char *message = NULL;
515 GKeyFile *key_file = NULL;
520 notmuch = _alloc_notmuch ();
522 status = NOTMUCH_STATUS_OUT_OF_MEMORY;
526 status = _load_key_file (notmuch, config_path, profile, &key_file);
528 message = strdup ("Error: cannot load config file.\n");
532 if ((status = _choose_database_path (local, profile, key_file,
533 &database_path, &split,
537 status = _db_dir_exists (database_path, &message);
541 _set_database_path (notmuch, database_path);
543 status = _notmuch_choose_xapian_path (notmuch, database_path,
544 ¬much->xapian_path, &message);
548 status = _finish_open (notmuch, profile, mode, key_file, &message);
554 g_key_file_free (key_file);
558 *status_string = message;
566 talloc_free (notmuch);
569 notmuch->open = true;
575 notmuch_database_create (const char *path, notmuch_database_t **database)
577 char *status_string = NULL;
578 notmuch_status_t status;
580 status = notmuch_database_create_verbose (path, database,
584 fputs (status_string, stderr);
585 free (status_string);
592 notmuch_database_create_verbose (const char *path,
593 notmuch_database_t **database,
594 char **status_string)
596 return notmuch_database_create_with_config (path, "", NULL, database, status_string);
600 notmuch_database_create_with_config (const char *database_path,
601 const char *config_path,
603 notmuch_database_t **database,
604 char **status_string)
606 notmuch_status_t status = NOTMUCH_STATUS_SUCCESS;
607 notmuch_database_t *notmuch = NULL;
608 const char *notmuch_path = NULL;
609 char *message = NULL;
610 GKeyFile *key_file = NULL;
611 void *local = talloc_new (NULL);
617 notmuch = _alloc_notmuch ();
619 status = NOTMUCH_STATUS_OUT_OF_MEMORY;
623 status = _load_key_file (notmuch, config_path, profile, &key_file);
625 message = strdup ("Error: cannot load config file.\n");
629 if ((status = _choose_database_path (local, profile, key_file,
630 &database_path, &split, &message)))
633 status = _db_dir_exists (database_path, &message);
637 _set_database_path (notmuch, database_path);
639 if (key_file && ! split) {
640 char *mail_root = notmuch_canonicalize_file_name (
641 g_key_file_get_value (key_file, "database", "mail_root", NULL));
642 char *db_path = notmuch_canonicalize_file_name (database_path);
644 split = (mail_root && (0 != strcmp (mail_root, db_path)));
651 notmuch_path = database_path;
653 if (! (notmuch_path = talloc_asprintf (local, "%s/%s", database_path, ".notmuch"))) {
654 status = NOTMUCH_STATUS_OUT_OF_MEMORY;
658 err = mkdir (notmuch_path, 0755);
660 if (errno == EEXIST) {
661 status = NOTMUCH_STATUS_DATABASE_EXISTS;
662 talloc_free (notmuch);
665 IGNORE_RESULT (asprintf (&message, "Error: Cannot create directory %s: %s.\n",
666 notmuch_path, strerror (errno)));
667 status = NOTMUCH_STATUS_FILE_ERROR;
673 if (! (notmuch->xapian_path = talloc_asprintf (notmuch, "%s/%s", notmuch_path, "xapian"))) {
674 status = NOTMUCH_STATUS_OUT_OF_MEMORY;
678 status = _trial_open (notmuch->xapian_path, &message);
679 if (status == NOTMUCH_STATUS_SUCCESS) {
680 notmuch_database_destroy (notmuch);
682 status = NOTMUCH_STATUS_DATABASE_EXISTS;
689 status = _finish_open (notmuch,
691 NOTMUCH_DATABASE_MODE_READ_WRITE,
697 /* Upgrade doesn't add these feature to existing databases, but
698 * new databases have them. */
699 notmuch->features |= NOTMUCH_FEATURE_FROM_SUBJECT_ID_VALUES;
700 notmuch->features |= NOTMUCH_FEATURE_INDEXED_MIMETYPES;
701 notmuch->features |= NOTMUCH_FEATURE_UNPREFIX_BODY_ONLY;
703 status = notmuch_database_upgrade (notmuch, NULL, NULL);
705 notmuch_database_close (notmuch);
713 g_key_file_free (key_file);
717 *status_string = message;
724 talloc_free (notmuch);
729 notmuch_database_reopen (notmuch_database_t *notmuch,
730 notmuch_database_mode_t new_mode)
732 notmuch_database_mode_t cur_mode = _notmuch_database_mode (notmuch);
734 if (notmuch->xapian_db == NULL) {
735 _notmuch_database_log (notmuch, "Cannot reopen closed or nonexistent database\n");
736 return NOTMUCH_STATUS_ILLEGAL_ARGUMENT;
740 if (cur_mode == new_mode &&
741 new_mode == NOTMUCH_DATABASE_MODE_READ_ONLY) {
742 notmuch->xapian_db->reopen ();
744 notmuch->xapian_db->close ();
746 delete notmuch->xapian_db;
747 notmuch->xapian_db = NULL;
748 /* no need to free the same object twice */
749 notmuch->writable_xapian_db = NULL;
751 if (new_mode == NOTMUCH_DATABASE_MODE_READ_WRITE) {
752 notmuch->writable_xapian_db = new Xapian::WritableDatabase (notmuch->xapian_path,
754 notmuch->xapian_db = notmuch->writable_xapian_db;
756 notmuch->xapian_db = new Xapian::Database (notmuch->xapian_path,
761 _load_database_state (notmuch);
762 } catch (const Xapian::Error &error) {
763 if (! notmuch->exception_reported) {
764 _notmuch_database_log (notmuch, "Error: A Xapian exception reopening database: %s\n",
765 error.get_msg ().c_str ());
766 notmuch->exception_reported = true;
768 return NOTMUCH_STATUS_XAPIAN_EXCEPTION;
772 notmuch->open = true;
773 return NOTMUCH_STATUS_SUCCESS;
777 _maybe_load_config_from_database (notmuch_database_t *notmuch,
779 const char *database_path,
782 char *message; /* ignored */
784 if (_db_dir_exists (database_path, &message))
785 return NOTMUCH_STATUS_NO_DATABASE;
787 _set_database_path (notmuch, database_path);
789 if (_notmuch_choose_xapian_path (notmuch, database_path, ¬much->xapian_path, &message))
790 return NOTMUCH_STATUS_NO_DATABASE;
792 (void) _finish_open (notmuch, profile, NOTMUCH_DATABASE_MODE_READ_ONLY, key_file, &message);
794 return NOTMUCH_STATUS_SUCCESS;
798 notmuch_database_load_config (const char *database_path,
799 const char *config_path,
801 notmuch_database_t **database,
802 char **status_string)
804 notmuch_status_t status = NOTMUCH_STATUS_SUCCESS, warning = NOTMUCH_STATUS_SUCCESS;
805 void *local = talloc_new (NULL);
806 notmuch_database_t *notmuch = NULL;
807 char *message = NULL;
808 GKeyFile *key_file = NULL;
813 notmuch = _alloc_notmuch ();
815 status = NOTMUCH_STATUS_OUT_OF_MEMORY;
819 status = _load_key_file (notmuch, config_path, profile, &key_file);
821 case NOTMUCH_STATUS_SUCCESS:
823 case NOTMUCH_STATUS_NO_CONFIG:
827 message = strdup ("Error: cannot load config file.\n");
831 status = _choose_database_path (local, profile, key_file,
832 &database_path, &split, &message);
834 case NOTMUCH_STATUS_NO_DATABASE:
835 case NOTMUCH_STATUS_SUCCESS:
845 status = _maybe_load_config_from_database (notmuch, key_file, database_path, profile);
847 case NOTMUCH_STATUS_NO_DATABASE:
848 case NOTMUCH_STATUS_SUCCESS:
858 status = _notmuch_config_load_from_file (notmuch, key_file);
862 status = _notmuch_config_load_defaults (notmuch);
870 *status_string = message;