4 #include "database-private.h"
5 #include "parse-time-vrp.h"
7 #if HAVE_XAPIAN_DB_RETRY_LOCK
8 #define DB_ACTION (Xapian::DB_CREATE_OR_OPEN | Xapian::DB_RETRY_LOCK)
10 #define DB_ACTION Xapian::DB_CREATE_OR_OPEN
14 notmuch_database_open (const char *path,
15 notmuch_database_mode_t mode,
16 notmuch_database_t **database)
18 char *status_string = NULL;
19 notmuch_status_t status;
21 status = notmuch_database_open_verbose (path, mode, database,
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 (const char *path,
120 notmuch_status_t status = NOTMUCH_STATUS_SUCCESS;
121 void *local = talloc_new (NULL);
123 if (path && EMPTY_STRING (path))
127 path = getenv ("NOTMUCH_CONFIG");
130 const char *dir = _xdg_dir (local, "XDG_CONFIG_HOME", ".config", profile);
133 path = talloc_asprintf (local, "%s/config", dir);
134 if (access (path, R_OK) != 0)
140 const char *home = getenv ("HOME");
142 path = talloc_asprintf (local, "%s/.notmuch-config", home);
145 profile = getenv ("NOTMUCH_PROFILE");
148 path = talloc_asprintf (local, "%s.%s", path, profile);
151 *key_file = g_key_file_new ();
152 if (! g_key_file_load_from_file (*key_file, path, G_KEY_FILE_NONE, NULL)) {
153 status = NOTMUCH_STATUS_NO_CONFIG;
161 static notmuch_status_t
162 _db_dir_exists (const char *database_path, char **message)
167 err = stat (database_path, &st);
169 IGNORE_RESULT (asprintf (message, "Error: Cannot open database at %s: %s.\n",
170 database_path, strerror (errno)));
171 return NOTMUCH_STATUS_FILE_ERROR;
174 if (! S_ISDIR (st.st_mode)) {
175 IGNORE_RESULT (asprintf (message, "Error: Cannot open database at %s: "
176 "Not a directory.\n",
178 return NOTMUCH_STATUS_FILE_ERROR;
181 return NOTMUCH_STATUS_SUCCESS;
184 static notmuch_status_t
185 _choose_database_path (void *ctx,
188 const char **database_path,
192 if (! *database_path) {
193 *database_path = getenv ("NOTMUCH_DATABASE");
196 if (! *database_path && key_file) {
197 char *path = g_key_file_get_value (key_file, "database", "path", NULL);
200 *database_path = talloc_strdup (ctx, path);
202 *database_path = talloc_asprintf (ctx, "%s/%s", getenv ("HOME"), path);
206 if (! *database_path) {
207 *database_path = _xdg_dir (ctx, "XDG_DATA_HOME", ".local/share", profile);
211 if (*database_path == NULL) {
212 *message = strdup ("Error: Cannot open a database for a NULL path.\n");
213 return NOTMUCH_STATUS_NULL_POINTER;
216 if (*database_path[0] != '/') {
217 *message = strdup ("Error: Database path must be absolute.\n");
218 return NOTMUCH_STATUS_PATH_ERROR;
220 return NOTMUCH_STATUS_SUCCESS;
226 notmuch_database_t *notmuch;
228 notmuch = talloc_zero (NULL, notmuch_database_t);
232 notmuch->exception_reported = false;
233 notmuch->status_string = NULL;
234 notmuch->writable_xapian_db = NULL;
235 notmuch->atomic_nesting = 0;
240 static notmuch_status_t
241 _trial_open (const char *xapian_path, char **message_ptr)
244 Xapian::Database db (xapian_path);
245 } catch (const Xapian::DatabaseOpeningError &error) {
246 IGNORE_RESULT (asprintf (message_ptr,
247 "Cannot open Xapian database at %s: %s\n",
249 error.get_msg ().c_str ()));
250 return NOTMUCH_STATUS_PATH_ERROR;
251 } catch (const Xapian::Error &error) {
252 IGNORE_RESULT (asprintf (message_ptr,
253 "A Xapian exception occurred opening database: %s\n",
254 error.get_msg ().c_str ()));
255 return NOTMUCH_STATUS_XAPIAN_EXCEPTION;
257 return NOTMUCH_STATUS_SUCCESS;
261 _notmuch_choose_xapian_path (void *ctx, const char *database_path,
262 const char **xapian_path, char **message_ptr)
264 notmuch_status_t status;
265 const char *trial_path, *notmuch_path;
267 status = _db_dir_exists (database_path, message_ptr);
271 trial_path = talloc_asprintf (ctx, "%s/xapian", database_path);
272 status = _trial_open (trial_path, message_ptr);
273 if (status != NOTMUCH_STATUS_PATH_ERROR)
279 notmuch_path = talloc_asprintf (ctx, "%s/.notmuch", database_path);
280 status = _db_dir_exists (notmuch_path, message_ptr);
284 trial_path = talloc_asprintf (ctx, "%s/xapian", notmuch_path);
285 status = _trial_open (trial_path, message_ptr);
288 if (status == NOTMUCH_STATUS_SUCCESS)
289 *xapian_path = trial_path;
294 _set_database_path (notmuch_database_t *notmuch,
295 const char *database_path)
297 char *path = talloc_strdup (notmuch, database_path);
299 strip_trailing (path, '/');
301 _notmuch_config_cache (notmuch, NOTMUCH_CONFIG_DATABASE_PATH, path);
308 static int initialized = 0;
310 /* Initialize the GLib type system and threads */
311 #if ! GLIB_CHECK_VERSION (2, 35, 1)
315 /* Initialize gmime */
322 static notmuch_status_t
323 _finish_open (notmuch_database_t *notmuch,
325 notmuch_database_mode_t mode,
329 notmuch_status_t status = NOTMUCH_STATUS_SUCCESS;
330 char *incompat_features;
331 char *message = NULL;
332 unsigned int version;
333 const char *database_path = notmuch_database_get_path (notmuch);
336 std::string last_thread_id;
337 std::string last_mod;
339 if (mode == NOTMUCH_DATABASE_MODE_READ_WRITE) {
340 notmuch->writable_xapian_db = new Xapian::WritableDatabase (notmuch->xapian_path,
342 notmuch->xapian_db = notmuch->writable_xapian_db;
344 notmuch->xapian_db = new Xapian::Database (notmuch->xapian_path);
347 /* Check version. As of database version 3, we represent
348 * changes in terms of features, so assume a version bump
349 * means a dramatically incompatible change. */
350 version = notmuch_database_get_version (notmuch);
351 if (version > NOTMUCH_DATABASE_VERSION) {
352 IGNORE_RESULT (asprintf (&message,
353 "Error: Notmuch database at %s\n"
354 " has a newer database format version (%u) than supported by this\n"
355 " version of notmuch (%u).\n",
356 database_path, version, NOTMUCH_DATABASE_VERSION));
357 notmuch_database_destroy (notmuch);
359 status = NOTMUCH_STATUS_FILE_ERROR;
363 /* Check features. */
364 incompat_features = NULL;
365 notmuch->features = _notmuch_database_parse_features (
366 notmuch, notmuch->xapian_db->get_metadata ("features").c_str (),
367 version, mode == NOTMUCH_DATABASE_MODE_READ_WRITE ? 'w' : 'r',
369 if (incompat_features) {
370 IGNORE_RESULT (asprintf (&message,
371 "Error: Notmuch database at %s\n"
372 " requires features (%s)\n"
373 " not supported by this version of notmuch.\n",
374 database_path, incompat_features));
375 notmuch_database_destroy (notmuch);
377 status = NOTMUCH_STATUS_FILE_ERROR;
381 notmuch->last_doc_id = notmuch->xapian_db->get_lastdocid ();
382 last_thread_id = notmuch->xapian_db->get_metadata ("last_thread_id");
383 if (last_thread_id.empty ()) {
384 notmuch->last_thread_id = 0;
389 str = last_thread_id.c_str ();
390 notmuch->last_thread_id = strtoull (str, &end, 16);
392 INTERNAL_ERROR ("Malformed database last_thread_id: %s", str);
395 /* Get current highest revision number. */
396 last_mod = notmuch->xapian_db->get_value_upper_bound (
397 NOTMUCH_VALUE_LAST_MOD);
398 if (last_mod.empty ())
399 notmuch->revision = 0;
401 notmuch->revision = Xapian::sortable_unserialise (last_mod);
402 notmuch->uuid = talloc_strdup (
403 notmuch, notmuch->xapian_db->get_uuid ().c_str ());
405 notmuch->query_parser = new Xapian::QueryParser;
406 notmuch->term_gen = new Xapian::TermGenerator;
407 notmuch->term_gen->set_stemmer (Xapian::Stem ("english"));
408 notmuch->value_range_processor = new Xapian::NumberRangeProcessor (NOTMUCH_VALUE_TIMESTAMP);
409 notmuch->date_range_processor = new ParseTimeRangeProcessor (NOTMUCH_VALUE_TIMESTAMP,
411 notmuch->last_mod_range_processor = new Xapian::NumberRangeProcessor (NOTMUCH_VALUE_LAST_MOD,
413 notmuch->query_parser->set_default_op (Xapian::Query::OP_AND);
414 notmuch->query_parser->set_database (*notmuch->xapian_db);
415 notmuch->query_parser->set_stemmer (Xapian::Stem ("english"));
416 notmuch->query_parser->set_stemming_strategy (Xapian::QueryParser::STEM_SOME);
417 notmuch->query_parser->add_rangeprocessor (notmuch->value_range_processor);
418 notmuch->query_parser->add_rangeprocessor (notmuch->date_range_processor);
419 notmuch->query_parser->add_rangeprocessor (notmuch->last_mod_range_processor);
421 /* Configuration information is needed to set up query parser */
422 status = _notmuch_config_load_from_database (notmuch);
427 status = _notmuch_config_load_from_file (notmuch, key_file);
431 status = _choose_dir (notmuch, profile,
432 NOTMUCH_CONFIG_HOOK_DIR,
440 status = _choose_dir (notmuch, profile,
441 NOTMUCH_CONFIG_BACKUP_DIR,
448 status = _notmuch_config_load_defaults (notmuch);
452 status = _notmuch_database_setup_standard_query_fields (notmuch);
456 status = _notmuch_database_setup_user_query_fields (notmuch);
460 } catch (const Xapian::Error &error) {
461 IGNORE_RESULT (asprintf (&message, "A Xapian exception occurred opening database: %s\n",
462 error.get_msg ().c_str ()));
463 notmuch_database_destroy (notmuch);
465 status = NOTMUCH_STATUS_XAPIAN_EXCEPTION;
469 *message_ptr = message;
474 notmuch_database_open_with_config (const char *database_path,
475 notmuch_database_mode_t mode,
476 const char *config_path,
478 notmuch_database_t **database,
479 char **status_string)
481 notmuch_status_t status = NOTMUCH_STATUS_SUCCESS;
482 void *local = talloc_new (NULL);
483 notmuch_database_t *notmuch = NULL;
484 char *message = NULL;
485 GKeyFile *key_file = NULL;
490 notmuch = _alloc_notmuch ();
492 status = NOTMUCH_STATUS_OUT_OF_MEMORY;
496 status = _load_key_file (config_path, profile, &key_file);
498 message = strdup ("Error: cannot load config file.\n");
502 if ((status = _choose_database_path (local, profile, key_file,
503 &database_path, &split,
507 status = _db_dir_exists (database_path, &message);
511 _set_database_path (notmuch, database_path);
513 status = _notmuch_choose_xapian_path (notmuch, database_path,
514 ¬much->xapian_path, &message);
518 status = _finish_open (notmuch, profile, mode, key_file, &message);
524 g_key_file_free (key_file);
528 *status_string = message;
536 talloc_free (notmuch);
539 notmuch->open = true;
545 notmuch_database_create (const char *path, notmuch_database_t **database)
547 char *status_string = NULL;
548 notmuch_status_t status;
550 status = notmuch_database_create_verbose (path, database,
554 fputs (status_string, stderr);
555 free (status_string);
562 notmuch_database_create_verbose (const char *path,
563 notmuch_database_t **database,
564 char **status_string)
566 return notmuch_database_create_with_config (path, "", NULL, database, status_string);
570 notmuch_database_create_with_config (const char *database_path,
571 const char *config_path,
573 notmuch_database_t **database,
574 char **status_string)
576 notmuch_status_t status = NOTMUCH_STATUS_SUCCESS;
577 notmuch_database_t *notmuch = NULL;
578 const char *notmuch_path = NULL;
579 char *message = NULL;
580 GKeyFile *key_file = NULL;
581 void *local = talloc_new (NULL);
587 notmuch = _alloc_notmuch ();
589 status = NOTMUCH_STATUS_OUT_OF_MEMORY;
593 status = _load_key_file (config_path, profile, &key_file);
595 message = strdup ("Error: cannot load config file.\n");
599 if ((status = _choose_database_path (local, profile, key_file,
600 &database_path, &split, &message)))
603 status = _db_dir_exists (database_path, &message);
607 _set_database_path (notmuch, database_path);
609 if (key_file && ! split) {
610 char *mail_root = canonicalize_file_name (
611 g_key_file_get_value (key_file, "database", "mail_root", NULL));
612 char *db_path = canonicalize_file_name (database_path);
614 split = (mail_root && (0 != strcmp (mail_root, db_path)));
621 notmuch_path = database_path;
623 if (! (notmuch_path = talloc_asprintf (local, "%s/%s", database_path, ".notmuch"))) {
624 status = NOTMUCH_STATUS_OUT_OF_MEMORY;
628 err = mkdir (notmuch_path, 0755);
630 if (errno == EEXIST) {
631 status = NOTMUCH_STATUS_DATABASE_EXISTS;
632 talloc_free (notmuch);
635 IGNORE_RESULT (asprintf (&message, "Error: Cannot create directory %s: %s.\n",
636 notmuch_path, strerror (errno)));
637 status = NOTMUCH_STATUS_FILE_ERROR;
643 if (! (notmuch->xapian_path = talloc_asprintf (notmuch, "%s/%s", notmuch_path, "xapian"))) {
644 status = NOTMUCH_STATUS_OUT_OF_MEMORY;
648 status = _trial_open (notmuch->xapian_path, &message);
649 if (status == NOTMUCH_STATUS_SUCCESS) {
650 notmuch_database_destroy (notmuch);
652 status = NOTMUCH_STATUS_DATABASE_EXISTS;
659 status = _finish_open (notmuch,
661 NOTMUCH_DATABASE_MODE_READ_WRITE,
667 /* Upgrade doesn't add these feature to existing databases, but
668 * new databases have them. */
669 notmuch->features |= NOTMUCH_FEATURE_FROM_SUBJECT_ID_VALUES;
670 notmuch->features |= NOTMUCH_FEATURE_INDEXED_MIMETYPES;
671 notmuch->features |= NOTMUCH_FEATURE_UNPREFIX_BODY_ONLY;
673 status = notmuch_database_upgrade (notmuch, NULL, NULL);
675 notmuch_database_close (notmuch);
683 g_key_file_free (key_file);
687 *status_string = message;
694 talloc_free (notmuch);
699 notmuch_database_reopen (notmuch_database_t *notmuch,
700 notmuch_database_mode_t new_mode)
702 notmuch_database_mode_t cur_mode = _notmuch_database_mode (notmuch);
704 if (notmuch->xapian_db == NULL) {
705 _notmuch_database_log (notmuch, "Cannot reopen closed or nonexistent database\n");
706 return NOTMUCH_STATUS_ILLEGAL_ARGUMENT;
710 if (cur_mode == new_mode &&
711 new_mode == NOTMUCH_DATABASE_MODE_READ_ONLY) {
712 notmuch->xapian_db->reopen ();
714 notmuch->xapian_db->close ();
716 delete notmuch->xapian_db;
717 notmuch->xapian_db = NULL;
718 /* no need to free the same object twice */
719 notmuch->writable_xapian_db = NULL;
721 if (new_mode == NOTMUCH_DATABASE_MODE_READ_WRITE) {
722 notmuch->writable_xapian_db = new Xapian::WritableDatabase (notmuch->xapian_path,
724 notmuch->xapian_db = notmuch->writable_xapian_db;
726 notmuch->xapian_db = new Xapian::Database (notmuch->xapian_path,
730 } catch (const Xapian::Error &error) {
731 if (! notmuch->exception_reported) {
732 _notmuch_database_log (notmuch, "Error: A Xapian exception reopening database: %s\n",
733 error.get_msg ().c_str ());
734 notmuch->exception_reported = true;
736 return NOTMUCH_STATUS_XAPIAN_EXCEPTION;
740 notmuch->open = true;
741 return NOTMUCH_STATUS_SUCCESS;
745 _maybe_load_config_from_database (notmuch_database_t *notmuch,
747 const char *database_path,
750 char *message; /* ignored */
752 if (_db_dir_exists (database_path, &message))
753 return NOTMUCH_STATUS_SUCCESS;
755 _set_database_path (notmuch, database_path);
757 if (_notmuch_choose_xapian_path (notmuch, database_path, ¬much->xapian_path, &message))
758 return NOTMUCH_STATUS_SUCCESS;
760 (void) _finish_open (notmuch, profile, NOTMUCH_DATABASE_MODE_READ_ONLY, key_file, &message);
762 return NOTMUCH_STATUS_SUCCESS;
766 notmuch_database_load_config (const char *database_path,
767 const char *config_path,
769 notmuch_database_t **database,
770 char **status_string)
772 notmuch_status_t status = NOTMUCH_STATUS_SUCCESS, warning = NOTMUCH_STATUS_SUCCESS;
773 void *local = talloc_new (NULL);
774 notmuch_database_t *notmuch = NULL;
775 char *message = NULL;
776 GKeyFile *key_file = NULL;
781 notmuch = _alloc_notmuch ();
783 status = NOTMUCH_STATUS_OUT_OF_MEMORY;
787 status = _load_key_file (config_path, profile, &key_file);
789 case NOTMUCH_STATUS_SUCCESS:
790 case NOTMUCH_STATUS_NO_CONFIG:
794 message = strdup ("Error: cannot load config file.\n");
798 status = _choose_database_path (local, profile, key_file,
799 &database_path, &split, &message);
801 /* weirdly NULL_POINTER is what is returned if we fail to find
803 case NOTMUCH_STATUS_NULL_POINTER:
804 case NOTMUCH_STATUS_SUCCESS:
811 status = _maybe_load_config_from_database (notmuch, key_file, database_path, profile);
817 status = _notmuch_config_load_from_file (notmuch, key_file);
821 status = _notmuch_config_load_defaults (notmuch);
829 *status_string = message;