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 notmuch_status_t status;
197 if (! *database_path) {
198 *database_path = getenv ("NOTMUCH_DATABASE");
201 if (! *database_path && key_file) {
202 char *path = g_key_file_get_string (key_file, "database", "path", NULL);
205 *database_path = talloc_strdup (notmuch, path);
207 *database_path = talloc_asprintf (notmuch, "%s/%s", getenv ("HOME"), path);
211 if (! *database_path) {
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 *database_path = talloc_asprintf (notmuch, "%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;
243 status = _db_dir_exists (*database_path, message);
245 IGNORE_RESULT (asprintf (message,
246 "Error: database path '%s' does not exist or is not a directory.\n",
248 return NOTMUCH_STATUS_NO_DATABASE;
251 return NOTMUCH_STATUS_SUCCESS;
254 static notmuch_status_t
255 _mkdir (const char *path, char **message)
257 if (g_mkdir_with_parents (path, 0755)) {
258 IGNORE_RESULT (asprintf (message, "Error: Cannot create directory %s: %s.\n",
259 path, strerror (errno)));
260 return NOTMUCH_STATUS_FILE_ERROR;
262 return NOTMUCH_STATUS_SUCCESS;
266 static notmuch_database_t *
267 _alloc_notmuch (const char *database_path, const char *config_path, const char *profile)
269 notmuch_database_t *notmuch;
271 notmuch = talloc_zero (NULL, notmuch_database_t);
275 notmuch->exception_reported = false;
276 notmuch->status_string = NULL;
277 notmuch->writable_xapian_db = NULL;
278 notmuch->config_path = NULL;
279 notmuch->atomic_nesting = 0;
280 notmuch->transaction_count = 0;
281 notmuch->transaction_threshold = 0;
284 notmuch->params = NOTMUCH_PARAM_NONE;
286 notmuch->params |= NOTMUCH_PARAM_DATABASE;
288 notmuch->params |= NOTMUCH_PARAM_CONFIG;
290 notmuch->params |= NOTMUCH_PARAM_PROFILE;
295 static notmuch_status_t
296 _trial_open (const char *xapian_path, char **message_ptr)
299 Xapian::Database db (xapian_path);
300 } catch (const Xapian::DatabaseOpeningError &error) {
301 IGNORE_RESULT (asprintf (message_ptr,
302 "Cannot open Xapian database at %s: %s\n",
304 error.get_msg ().c_str ()));
305 return NOTMUCH_STATUS_PATH_ERROR;
306 } catch (const Xapian::Error &error) {
307 IGNORE_RESULT (asprintf (message_ptr,
308 "A Xapian exception occurred opening database: %s\n",
309 error.get_msg ().c_str ()));
310 return NOTMUCH_STATUS_XAPIAN_EXCEPTION;
312 return NOTMUCH_STATUS_SUCCESS;
316 _notmuch_choose_xapian_path (void *ctx, const char *database_path,
317 const char **xapian_path, char **message_ptr)
319 notmuch_status_t status;
320 const char *trial_path, *notmuch_path;
322 status = _db_dir_exists (database_path, message_ptr);
326 trial_path = talloc_asprintf (ctx, "%s/xapian", database_path);
327 status = _trial_open (trial_path, message_ptr);
328 if (status != NOTMUCH_STATUS_PATH_ERROR)
334 notmuch_path = talloc_asprintf (ctx, "%s/.notmuch", database_path);
335 status = _db_dir_exists (notmuch_path, message_ptr);
339 trial_path = talloc_asprintf (ctx, "%s/xapian", notmuch_path);
340 status = _trial_open (trial_path, message_ptr);
343 if (status == NOTMUCH_STATUS_SUCCESS)
344 *xapian_path = trial_path;
349 _set_database_path (notmuch_database_t *notmuch,
350 const char *database_path)
352 char *path = talloc_strdup (notmuch, database_path);
354 strip_trailing (path, '/');
356 _notmuch_config_cache (notmuch, NOTMUCH_CONFIG_DATABASE_PATH, path);
360 _load_database_state (notmuch_database_t *notmuch)
362 std::string last_thread_id;
363 std::string last_mod;
365 notmuch->last_doc_id = notmuch->xapian_db->get_lastdocid ();
366 last_thread_id = notmuch->xapian_db->get_metadata ("last_thread_id");
367 if (last_thread_id.empty ()) {
368 notmuch->last_thread_id = 0;
373 str = last_thread_id.c_str ();
374 notmuch->last_thread_id = strtoull (str, &end, 16);
376 INTERNAL_ERROR ("Malformed database last_thread_id: %s", str);
379 /* Get current highest revision number. */
380 last_mod = notmuch->xapian_db->get_value_upper_bound (
381 NOTMUCH_VALUE_LAST_MOD);
382 if (last_mod.empty ())
383 notmuch->revision = 0;
385 notmuch->revision = Xapian::sortable_unserialise (last_mod);
386 notmuch->uuid = talloc_strdup (
387 notmuch, notmuch->xapian_db->get_uuid ().c_str ());
390 static notmuch_status_t
391 _finish_open (notmuch_database_t *notmuch,
393 notmuch_database_mode_t mode,
397 notmuch_status_t status = NOTMUCH_STATUS_SUCCESS;
398 char *incompat_features;
399 char *message = NULL;
400 const char *autocommit_str;
401 char *autocommit_end;
402 unsigned int version;
403 const char *database_path = notmuch_database_get_path (notmuch);
407 if (mode == NOTMUCH_DATABASE_MODE_READ_WRITE) {
408 notmuch->writable_xapian_db = new Xapian::WritableDatabase (notmuch->xapian_path,
410 notmuch->xapian_db = notmuch->writable_xapian_db;
412 notmuch->xapian_db = new Xapian::Database (notmuch->xapian_path);
415 /* Check version. As of database version 3, we represent
416 * changes in terms of features, so assume a version bump
417 * means a dramatically incompatible change. */
418 version = notmuch_database_get_version (notmuch);
419 if (version > NOTMUCH_DATABASE_VERSION) {
420 IGNORE_RESULT (asprintf (&message,
421 "Error: Notmuch database at %s\n"
422 " has a newer database format version (%u) than supported by this\n"
423 " version of notmuch (%u).\n",
424 database_path, version, NOTMUCH_DATABASE_VERSION));
425 status = NOTMUCH_STATUS_FILE_ERROR;
429 /* Check features. */
430 incompat_features = NULL;
431 notmuch->features = _notmuch_database_parse_features (
432 notmuch, notmuch->xapian_db->get_metadata ("features").c_str (),
433 version, mode == NOTMUCH_DATABASE_MODE_READ_WRITE ? 'w' : 'r',
435 if (incompat_features) {
436 IGNORE_RESULT (asprintf (&message,
437 "Error: Notmuch database at %s\n"
438 " requires features (%s)\n"
439 " not supported by this version of notmuch.\n",
440 database_path, incompat_features));
441 status = NOTMUCH_STATUS_FILE_ERROR;
445 _load_database_state (notmuch);
447 notmuch->query_parser = new Xapian::QueryParser;
448 notmuch->term_gen = new Xapian::TermGenerator;
449 notmuch->term_gen->set_stemmer (Xapian::Stem ("english"));
450 notmuch->value_range_processor = new Xapian::NumberRangeProcessor (NOTMUCH_VALUE_TIMESTAMP);
451 notmuch->date_range_processor = new ParseTimeRangeProcessor (NOTMUCH_VALUE_TIMESTAMP,
453 notmuch->last_mod_range_processor = new Xapian::NumberRangeProcessor (NOTMUCH_VALUE_LAST_MOD,
455 notmuch->query_parser->set_default_op (Xapian::Query::OP_AND);
456 notmuch->query_parser->set_database (*notmuch->xapian_db);
457 notmuch->stemmer = new Xapian::Stem ("english");
458 notmuch->query_parser->set_stemmer (*notmuch->stemmer);
459 notmuch->query_parser->set_stemming_strategy (Xapian::QueryParser::STEM_SOME);
460 notmuch->query_parser->add_rangeprocessor (notmuch->value_range_processor);
461 notmuch->query_parser->add_rangeprocessor (notmuch->date_range_processor);
462 notmuch->query_parser->add_rangeprocessor (notmuch->last_mod_range_processor);
464 /* Configuration information is needed to set up query parser */
465 status = _notmuch_config_load_from_database (notmuch);
470 status = _notmuch_config_load_from_file (notmuch, key_file);
474 status = _choose_dir (notmuch, profile,
475 NOTMUCH_CONFIG_HOOK_DIR,
483 status = _choose_dir (notmuch, profile,
484 NOTMUCH_CONFIG_BACKUP_DIR,
491 status = _notmuch_config_load_defaults (notmuch);
495 autocommit_str = notmuch_config_get (notmuch, NOTMUCH_CONFIG_AUTOCOMMIT);
496 if (unlikely (! autocommit_str)) {
497 INTERNAL_ERROR ("missing configuration for autocommit");
499 notmuch->transaction_threshold = strtoul (autocommit_str, &autocommit_end, 10);
500 if (*autocommit_end != '\0')
501 INTERNAL_ERROR ("Malformed database database.autocommit value: %s", autocommit_str);
503 status = _notmuch_database_setup_standard_query_fields (notmuch);
507 status = _notmuch_database_setup_user_query_fields (notmuch);
511 } catch (const Xapian::Error &error) {
512 IGNORE_RESULT (asprintf (&message, "A Xapian exception occurred opening database: %s\n",
513 error.get_msg ().c_str ()));
514 status = NOTMUCH_STATUS_XAPIAN_EXCEPTION;
518 *message_ptr = message;
523 notmuch_database_open_with_config (const char *database_path,
524 notmuch_database_mode_t mode,
525 const char *config_path,
527 notmuch_database_t **database,
528 char **status_string)
530 notmuch_status_t status = NOTMUCH_STATUS_SUCCESS;
531 notmuch_database_t *notmuch = NULL;
532 char *message = NULL;
533 GKeyFile *key_file = NULL;
537 notmuch = _alloc_notmuch (database_path, config_path, profile);
539 status = NOTMUCH_STATUS_OUT_OF_MEMORY;
543 status = _load_key_file (notmuch, config_path, profile, &key_file);
545 message = strdup ("Error: cannot load config file.\n");
549 if ((status = _choose_database_path (notmuch, profile, key_file,
554 status = _db_dir_exists (database_path, &message);
558 _set_database_path (notmuch, database_path);
560 status = _notmuch_choose_xapian_path (notmuch, database_path,
561 ¬much->xapian_path, &message);
565 status = _finish_open (notmuch, profile, mode, key_file, &message);
569 g_key_file_free (key_file);
573 *status_string = message;
578 if (status && notmuch) {
579 notmuch_database_destroy (notmuch);
587 notmuch->open = true;
593 notmuch_database_create (const char *path, notmuch_database_t **database)
595 char *status_string = NULL;
596 notmuch_status_t status;
598 status = notmuch_database_create_verbose (path, database,
602 fputs (status_string, stderr);
603 free (status_string);
610 notmuch_database_create_verbose (const char *path,
611 notmuch_database_t **database,
612 char **status_string)
614 return notmuch_database_create_with_config (path, "", NULL, database, status_string);
618 notmuch_database_create_with_config (const char *database_path,
619 const char *config_path,
621 notmuch_database_t **database,
622 char **status_string)
624 notmuch_status_t status = NOTMUCH_STATUS_SUCCESS;
625 notmuch_database_t *notmuch = NULL;
626 const char *notmuch_path = NULL;
627 char *message = NULL;
628 GKeyFile *key_file = NULL;
632 notmuch = _alloc_notmuch (database_path, config_path, profile);
634 status = NOTMUCH_STATUS_OUT_OF_MEMORY;
638 status = _load_key_file (notmuch, config_path, profile, &key_file);
640 message = strdup ("Error: cannot load config file.\n");
644 if ((status = _choose_database_path (notmuch, profile, key_file,
645 &database_path, &message)))
648 _set_database_path (notmuch, database_path);
650 if (key_file && ! (notmuch->params & NOTMUCH_PARAM_SPLIT)) {
651 char *mail_root = notmuch_canonicalize_file_name (
652 g_key_file_get_string (key_file, "database", "mail_root", NULL));
653 char *db_path = notmuch_canonicalize_file_name (database_path);
655 if (mail_root && (0 != strcmp (mail_root, db_path)))
656 notmuch->params |= NOTMUCH_PARAM_SPLIT;
662 if (notmuch->params & NOTMUCH_PARAM_SPLIT) {
663 notmuch_path = database_path;
665 if (! (notmuch_path = talloc_asprintf (notmuch, "%s/%s", database_path, ".notmuch"))) {
666 status = NOTMUCH_STATUS_OUT_OF_MEMORY;
670 status = _mkdir (notmuch_path, &message);
675 if (! (notmuch->xapian_path = talloc_asprintf (notmuch, "%s/%s", notmuch_path, "xapian"))) {
676 status = NOTMUCH_STATUS_OUT_OF_MEMORY;
680 status = _trial_open (notmuch->xapian_path, &message);
681 if (status == NOTMUCH_STATUS_SUCCESS) {
682 notmuch_database_destroy (notmuch);
684 status = NOTMUCH_STATUS_DATABASE_EXISTS;
691 status = _finish_open (notmuch,
693 NOTMUCH_DATABASE_MODE_READ_WRITE,
699 /* Upgrade doesn't add these feature to existing databases, but
700 * new databases have them. */
701 notmuch->features |= NOTMUCH_FEATURE_FROM_SUBJECT_ID_VALUES;
702 notmuch->features |= NOTMUCH_FEATURE_INDEXED_MIMETYPES;
703 notmuch->features |= NOTMUCH_FEATURE_UNPREFIX_BODY_ONLY;
705 status = notmuch_database_upgrade (notmuch, NULL, NULL);
707 notmuch_database_close (notmuch);
713 g_key_file_free (key_file);
717 *status_string = message;
721 if (status && notmuch) {
722 notmuch_database_destroy (notmuch);
730 notmuch->open = true;
735 notmuch_database_reopen (notmuch_database_t *notmuch,
736 notmuch_database_mode_t new_mode)
738 notmuch_database_mode_t cur_mode = _notmuch_database_mode (notmuch);
740 if (notmuch->xapian_db == NULL) {
741 _notmuch_database_log (notmuch, "Cannot reopen closed or nonexistent database\n");
742 return NOTMUCH_STATUS_ILLEGAL_ARGUMENT;
746 if (cur_mode == new_mode &&
747 new_mode == NOTMUCH_DATABASE_MODE_READ_ONLY) {
748 notmuch->xapian_db->reopen ();
750 notmuch->xapian_db->close ();
752 delete notmuch->xapian_db;
753 notmuch->xapian_db = NULL;
754 /* no need to free the same object twice */
755 notmuch->writable_xapian_db = NULL;
757 if (new_mode == NOTMUCH_DATABASE_MODE_READ_WRITE) {
758 notmuch->writable_xapian_db = new Xapian::WritableDatabase (notmuch->xapian_path,
760 notmuch->xapian_db = notmuch->writable_xapian_db;
762 notmuch->xapian_db = new Xapian::Database (notmuch->xapian_path,
767 _load_database_state (notmuch);
768 } catch (const Xapian::Error &error) {
769 if (! notmuch->exception_reported) {
770 _notmuch_database_log (notmuch, "Error: A Xapian exception reopening database: %s\n",
771 error.get_msg ().c_str ());
772 notmuch->exception_reported = true;
774 return NOTMUCH_STATUS_XAPIAN_EXCEPTION;
778 notmuch->open = true;
779 return NOTMUCH_STATUS_SUCCESS;
782 static notmuch_status_t
783 _maybe_load_config_from_database (notmuch_database_t *notmuch,
785 const char *database_path,
788 char *message; /* ignored */
790 if (_db_dir_exists (database_path, &message))
791 return NOTMUCH_STATUS_NO_DATABASE;
793 _set_database_path (notmuch, database_path);
795 if (_notmuch_choose_xapian_path (notmuch, database_path, ¬much->xapian_path, &message))
796 return NOTMUCH_STATUS_NO_DATABASE;
798 (void) _finish_open (notmuch, profile, NOTMUCH_DATABASE_MODE_READ_ONLY, key_file, &message);
800 return NOTMUCH_STATUS_SUCCESS;
804 notmuch_database_load_config (const char *database_path,
805 const char *config_path,
807 notmuch_database_t **database,
808 char **status_string)
810 notmuch_status_t status = NOTMUCH_STATUS_SUCCESS, warning = NOTMUCH_STATUS_SUCCESS;
811 notmuch_database_t *notmuch = NULL;
812 char *message = NULL;
813 GKeyFile *key_file = NULL;
817 notmuch = _alloc_notmuch (database_path, config_path, profile);
819 status = NOTMUCH_STATUS_OUT_OF_MEMORY;
823 status = _load_key_file (notmuch, config_path, profile, &key_file);
825 case NOTMUCH_STATUS_SUCCESS:
827 case NOTMUCH_STATUS_NO_CONFIG:
831 message = strdup ("Error: cannot load config file.\n");
835 status = _choose_database_path (notmuch, profile, key_file,
836 &database_path, &message);
838 case NOTMUCH_STATUS_NO_DATABASE:
839 case NOTMUCH_STATUS_SUCCESS:
849 status = _maybe_load_config_from_database (notmuch, key_file, database_path, profile);
851 case NOTMUCH_STATUS_NO_DATABASE:
852 case NOTMUCH_STATUS_SUCCESS:
862 status = _notmuch_config_load_from_file (notmuch, key_file);
866 status = _notmuch_config_load_defaults (notmuch);
872 *status_string = message;
875 status != NOTMUCH_STATUS_NO_DATABASE
876 && status != NOTMUCH_STATUS_NO_CONFIG) {
877 notmuch_database_destroy (notmuch);