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 (void *ctx,
192 const char **database_path,
196 if (! *database_path) {
197 *database_path = getenv ("NOTMUCH_DATABASE");
200 if (! *database_path && key_file) {
201 char *path = g_key_file_get_value (key_file, "database", "path", NULL);
204 *database_path = talloc_strdup (ctx, path);
206 *database_path = talloc_asprintf (ctx, "%s/%s", getenv ("HOME"), path);
210 if (! *database_path) {
211 notmuch_status_t status;
213 *database_path = _xdg_dir (ctx, "XDG_DATA_HOME", ".local/share", profile);
214 status = _db_dir_exists (*database_path, message);
216 *database_path = NULL;
222 if (! *database_path) {
223 *database_path = getenv ("MAILDIR");
226 if (! *database_path) {
227 notmuch_status_t status;
229 *database_path = talloc_asprintf (ctx, "%s/mail", getenv ("HOME"));
230 status = _db_dir_exists (*database_path, message);
232 *database_path = NULL;
236 if (*database_path == NULL) {
237 *message = strdup ("Error: could not locate database.\n");
238 return NOTMUCH_STATUS_NO_DATABASE;
241 if (*database_path[0] != '/') {
242 *message = strdup ("Error: Database path must be absolute.\n");
243 return NOTMUCH_STATUS_PATH_ERROR;
245 return NOTMUCH_STATUS_SUCCESS;
248 static notmuch_database_t *
251 notmuch_database_t *notmuch;
253 notmuch = talloc_zero (NULL, notmuch_database_t);
257 notmuch->exception_reported = false;
258 notmuch->status_string = NULL;
259 notmuch->writable_xapian_db = NULL;
260 notmuch->config_path = NULL;
261 notmuch->atomic_nesting = 0;
262 notmuch->transaction_count = 0;
263 notmuch->transaction_threshold = 0;
268 static notmuch_status_t
269 _trial_open (const char *xapian_path, char **message_ptr)
272 Xapian::Database db (xapian_path);
273 } catch (const Xapian::DatabaseOpeningError &error) {
274 IGNORE_RESULT (asprintf (message_ptr,
275 "Cannot open Xapian database at %s: %s\n",
277 error.get_msg ().c_str ()));
278 return NOTMUCH_STATUS_PATH_ERROR;
279 } catch (const Xapian::Error &error) {
280 IGNORE_RESULT (asprintf (message_ptr,
281 "A Xapian exception occurred opening database: %s\n",
282 error.get_msg ().c_str ()));
283 return NOTMUCH_STATUS_XAPIAN_EXCEPTION;
285 return NOTMUCH_STATUS_SUCCESS;
289 _notmuch_choose_xapian_path (void *ctx, const char *database_path,
290 const char **xapian_path, char **message_ptr)
292 notmuch_status_t status;
293 const char *trial_path, *notmuch_path;
295 status = _db_dir_exists (database_path, message_ptr);
299 trial_path = talloc_asprintf (ctx, "%s/xapian", database_path);
300 status = _trial_open (trial_path, message_ptr);
301 if (status != NOTMUCH_STATUS_PATH_ERROR)
307 notmuch_path = talloc_asprintf (ctx, "%s/.notmuch", database_path);
308 status = _db_dir_exists (notmuch_path, message_ptr);
312 trial_path = talloc_asprintf (ctx, "%s/xapian", notmuch_path);
313 status = _trial_open (trial_path, message_ptr);
316 if (status == NOTMUCH_STATUS_SUCCESS)
317 *xapian_path = trial_path;
322 _set_database_path (notmuch_database_t *notmuch,
323 const char *database_path)
325 char *path = talloc_strdup (notmuch, database_path);
327 strip_trailing (path, '/');
329 _notmuch_config_cache (notmuch, NOTMUCH_CONFIG_DATABASE_PATH, path);
333 _load_database_state (notmuch_database_t *notmuch)
335 std::string last_thread_id;
336 std::string last_mod;
338 notmuch->last_doc_id = notmuch->xapian_db->get_lastdocid ();
339 last_thread_id = notmuch->xapian_db->get_metadata ("last_thread_id");
340 if (last_thread_id.empty ()) {
341 notmuch->last_thread_id = 0;
346 str = last_thread_id.c_str ();
347 notmuch->last_thread_id = strtoull (str, &end, 16);
349 INTERNAL_ERROR ("Malformed database last_thread_id: %s", str);
352 /* Get current highest revision number. */
353 last_mod = notmuch->xapian_db->get_value_upper_bound (
354 NOTMUCH_VALUE_LAST_MOD);
355 if (last_mod.empty ())
356 notmuch->revision = 0;
358 notmuch->revision = Xapian::sortable_unserialise (last_mod);
359 notmuch->uuid = talloc_strdup (
360 notmuch, notmuch->xapian_db->get_uuid ().c_str ());
363 static notmuch_status_t
364 _finish_open (notmuch_database_t *notmuch,
366 notmuch_database_mode_t mode,
370 notmuch_status_t status = NOTMUCH_STATUS_SUCCESS;
371 char *incompat_features;
372 char *message = NULL;
373 const char *autocommit_str;
374 char *autocommit_end;
375 unsigned int version;
376 const char *database_path = notmuch_database_get_path (notmuch);
380 if (mode == NOTMUCH_DATABASE_MODE_READ_WRITE) {
381 notmuch->writable_xapian_db = new Xapian::WritableDatabase (notmuch->xapian_path,
383 notmuch->xapian_db = notmuch->writable_xapian_db;
385 notmuch->xapian_db = new Xapian::Database (notmuch->xapian_path);
388 /* Check version. As of database version 3, we represent
389 * changes in terms of features, so assume a version bump
390 * means a dramatically incompatible change. */
391 version = notmuch_database_get_version (notmuch);
392 if (version > NOTMUCH_DATABASE_VERSION) {
393 IGNORE_RESULT (asprintf (&message,
394 "Error: Notmuch database at %s\n"
395 " has a newer database format version (%u) than supported by this\n"
396 " version of notmuch (%u).\n",
397 database_path, version, NOTMUCH_DATABASE_VERSION));
398 status = NOTMUCH_STATUS_FILE_ERROR;
402 /* Check features. */
403 incompat_features = NULL;
404 notmuch->features = _notmuch_database_parse_features (
405 notmuch, notmuch->xapian_db->get_metadata ("features").c_str (),
406 version, mode == NOTMUCH_DATABASE_MODE_READ_WRITE ? 'w' : 'r',
408 if (incompat_features) {
409 IGNORE_RESULT (asprintf (&message,
410 "Error: Notmuch database at %s\n"
411 " requires features (%s)\n"
412 " not supported by this version of notmuch.\n",
413 database_path, incompat_features));
414 status = NOTMUCH_STATUS_FILE_ERROR;
418 _load_database_state (notmuch);
420 notmuch->query_parser = new Xapian::QueryParser;
421 notmuch->term_gen = new Xapian::TermGenerator;
422 notmuch->term_gen->set_stemmer (Xapian::Stem ("english"));
423 notmuch->value_range_processor = new Xapian::NumberRangeProcessor (NOTMUCH_VALUE_TIMESTAMP);
424 notmuch->date_range_processor = new ParseTimeRangeProcessor (NOTMUCH_VALUE_TIMESTAMP,
426 notmuch->last_mod_range_processor = new Xapian::NumberRangeProcessor (NOTMUCH_VALUE_LAST_MOD,
428 notmuch->query_parser->set_default_op (Xapian::Query::OP_AND);
429 notmuch->query_parser->set_database (*notmuch->xapian_db);
430 notmuch->stemmer = new Xapian::Stem ("english");
431 notmuch->query_parser->set_stemmer (*notmuch->stemmer);
432 notmuch->query_parser->set_stemming_strategy (Xapian::QueryParser::STEM_SOME);
433 notmuch->query_parser->add_rangeprocessor (notmuch->value_range_processor);
434 notmuch->query_parser->add_rangeprocessor (notmuch->date_range_processor);
435 notmuch->query_parser->add_rangeprocessor (notmuch->last_mod_range_processor);
437 /* Configuration information is needed to set up query parser */
438 status = _notmuch_config_load_from_database (notmuch);
443 status = _notmuch_config_load_from_file (notmuch, key_file);
447 status = _choose_dir (notmuch, profile,
448 NOTMUCH_CONFIG_HOOK_DIR,
456 status = _choose_dir (notmuch, profile,
457 NOTMUCH_CONFIG_BACKUP_DIR,
464 status = _notmuch_config_load_defaults (notmuch);
468 autocommit_str = notmuch_config_get (notmuch, NOTMUCH_CONFIG_AUTOCOMMIT);
469 if (unlikely (! autocommit_str)) {
470 INTERNAL_ERROR ("missing configuration for autocommit");
472 notmuch->transaction_threshold = strtoul (autocommit_str, &autocommit_end, 10);
473 if (*autocommit_end != '\0')
474 INTERNAL_ERROR ("Malformed database database.autocommit value: %s", autocommit_str);
476 status = _notmuch_database_setup_standard_query_fields (notmuch);
480 status = _notmuch_database_setup_user_query_fields (notmuch);
484 } catch (const Xapian::Error &error) {
485 IGNORE_RESULT (asprintf (&message, "A Xapian exception occurred opening database: %s\n",
486 error.get_msg ().c_str ()));
487 status = NOTMUCH_STATUS_XAPIAN_EXCEPTION;
491 *message_ptr = message;
496 notmuch_database_open_with_config (const char *database_path,
497 notmuch_database_mode_t mode,
498 const char *config_path,
500 notmuch_database_t **database,
501 char **status_string)
503 notmuch_status_t status = NOTMUCH_STATUS_SUCCESS;
504 void *local = talloc_new (NULL);
505 notmuch_database_t *notmuch = NULL;
506 char *message = NULL;
507 GKeyFile *key_file = NULL;
512 notmuch = _alloc_notmuch ();
514 status = NOTMUCH_STATUS_OUT_OF_MEMORY;
518 status = _load_key_file (notmuch, config_path, profile, &key_file);
520 message = strdup ("Error: cannot load config file.\n");
524 if ((status = _choose_database_path (local, profile, key_file,
525 &database_path, &split,
529 status = _db_dir_exists (database_path, &message);
533 _set_database_path (notmuch, database_path);
535 status = _notmuch_choose_xapian_path (notmuch, database_path,
536 ¬much->xapian_path, &message);
540 status = _finish_open (notmuch, profile, mode, key_file, &message);
546 g_key_file_free (key_file);
550 *status_string = message;
555 if (status && notmuch) {
556 notmuch_database_destroy (notmuch);
564 notmuch->open = true;
570 notmuch_database_create (const char *path, notmuch_database_t **database)
572 char *status_string = NULL;
573 notmuch_status_t status;
575 status = notmuch_database_create_verbose (path, database,
579 fputs (status_string, stderr);
580 free (status_string);
587 notmuch_database_create_verbose (const char *path,
588 notmuch_database_t **database,
589 char **status_string)
591 return notmuch_database_create_with_config (path, "", NULL, database, status_string);
595 notmuch_database_create_with_config (const char *database_path,
596 const char *config_path,
598 notmuch_database_t **database,
599 char **status_string)
601 notmuch_status_t status = NOTMUCH_STATUS_SUCCESS;
602 notmuch_database_t *notmuch = NULL;
603 const char *notmuch_path = NULL;
604 char *message = NULL;
605 GKeyFile *key_file = NULL;
606 void *local = talloc_new (NULL);
612 notmuch = _alloc_notmuch ();
614 status = NOTMUCH_STATUS_OUT_OF_MEMORY;
618 status = _load_key_file (notmuch, config_path, profile, &key_file);
620 message = strdup ("Error: cannot load config file.\n");
624 if ((status = _choose_database_path (local, profile, key_file,
625 &database_path, &split, &message)))
628 status = _db_dir_exists (database_path, &message);
632 _set_database_path (notmuch, database_path);
634 if (key_file && ! split) {
635 char *mail_root = notmuch_canonicalize_file_name (
636 g_key_file_get_value (key_file, "database", "mail_root", NULL));
637 char *db_path = notmuch_canonicalize_file_name (database_path);
639 split = (mail_root && (0 != strcmp (mail_root, db_path)));
646 notmuch_path = database_path;
648 if (! (notmuch_path = talloc_asprintf (local, "%s/%s", database_path, ".notmuch"))) {
649 status = NOTMUCH_STATUS_OUT_OF_MEMORY;
653 err = mkdir (notmuch_path, 0755);
655 if (errno == EEXIST) {
656 status = NOTMUCH_STATUS_DATABASE_EXISTS;
657 talloc_free (notmuch);
660 IGNORE_RESULT (asprintf (&message, "Error: Cannot create directory %s: %s.\n",
661 notmuch_path, strerror (errno)));
662 status = NOTMUCH_STATUS_FILE_ERROR;
668 if (! (notmuch->xapian_path = talloc_asprintf (notmuch, "%s/%s", notmuch_path, "xapian"))) {
669 status = NOTMUCH_STATUS_OUT_OF_MEMORY;
673 status = _trial_open (notmuch->xapian_path, &message);
674 if (status == NOTMUCH_STATUS_SUCCESS) {
675 notmuch_database_destroy (notmuch);
677 status = NOTMUCH_STATUS_DATABASE_EXISTS;
684 status = _finish_open (notmuch,
686 NOTMUCH_DATABASE_MODE_READ_WRITE,
692 /* Upgrade doesn't add these feature to existing databases, but
693 * new databases have them. */
694 notmuch->features |= NOTMUCH_FEATURE_FROM_SUBJECT_ID_VALUES;
695 notmuch->features |= NOTMUCH_FEATURE_INDEXED_MIMETYPES;
696 notmuch->features |= NOTMUCH_FEATURE_UNPREFIX_BODY_ONLY;
698 status = notmuch_database_upgrade (notmuch, NULL, NULL);
700 notmuch_database_close (notmuch);
708 g_key_file_free (key_file);
712 *status_string = message;
716 if (status && notmuch) {
717 notmuch_database_destroy (notmuch);
725 notmuch->open = true;
730 notmuch_database_reopen (notmuch_database_t *notmuch,
731 notmuch_database_mode_t new_mode)
733 notmuch_database_mode_t cur_mode = _notmuch_database_mode (notmuch);
735 if (notmuch->xapian_db == NULL) {
736 _notmuch_database_log (notmuch, "Cannot reopen closed or nonexistent database\n");
737 return NOTMUCH_STATUS_ILLEGAL_ARGUMENT;
741 if (cur_mode == new_mode &&
742 new_mode == NOTMUCH_DATABASE_MODE_READ_ONLY) {
743 notmuch->xapian_db->reopen ();
745 notmuch->xapian_db->close ();
747 delete notmuch->xapian_db;
748 notmuch->xapian_db = NULL;
749 /* no need to free the same object twice */
750 notmuch->writable_xapian_db = NULL;
752 if (new_mode == NOTMUCH_DATABASE_MODE_READ_WRITE) {
753 notmuch->writable_xapian_db = new Xapian::WritableDatabase (notmuch->xapian_path,
755 notmuch->xapian_db = notmuch->writable_xapian_db;
757 notmuch->xapian_db = new Xapian::Database (notmuch->xapian_path,
762 _load_database_state (notmuch);
763 } catch (const Xapian::Error &error) {
764 if (! notmuch->exception_reported) {
765 _notmuch_database_log (notmuch, "Error: A Xapian exception reopening database: %s\n",
766 error.get_msg ().c_str ());
767 notmuch->exception_reported = true;
769 return NOTMUCH_STATUS_XAPIAN_EXCEPTION;
773 notmuch->open = true;
774 return NOTMUCH_STATUS_SUCCESS;
777 static notmuch_status_t
778 _maybe_load_config_from_database (notmuch_database_t *notmuch,
780 const char *database_path,
783 char *message; /* ignored */
785 if (_db_dir_exists (database_path, &message))
786 return NOTMUCH_STATUS_NO_DATABASE;
788 _set_database_path (notmuch, database_path);
790 if (_notmuch_choose_xapian_path (notmuch, database_path, ¬much->xapian_path, &message))
791 return NOTMUCH_STATUS_NO_DATABASE;
793 (void) _finish_open (notmuch, profile, NOTMUCH_DATABASE_MODE_READ_ONLY, key_file, &message);
795 return NOTMUCH_STATUS_SUCCESS;
799 notmuch_database_load_config (const char *database_path,
800 const char *config_path,
802 notmuch_database_t **database,
803 char **status_string)
805 notmuch_status_t status = NOTMUCH_STATUS_SUCCESS, warning = NOTMUCH_STATUS_SUCCESS;
806 void *local = talloc_new (NULL);
807 notmuch_database_t *notmuch = NULL;
808 char *message = NULL;
809 GKeyFile *key_file = NULL;
814 notmuch = _alloc_notmuch ();
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 (local, profile, key_file,
833 &database_path, &split, &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);
871 *status_string = message;
874 status != NOTMUCH_STATUS_NO_DATABASE
875 && status != NOTMUCH_STATUS_NO_CONFIG) {
876 notmuch_database_destroy (notmuch);