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 *database_path = _xdg_dir (ctx, "XDG_DATA_HOME", ".local/share", profile);
216 if (*database_path == NULL) {
217 *message = strdup ("Error: could not locate database.\n");
218 return NOTMUCH_STATUS_NO_DATABASE;
221 if (*database_path[0] != '/') {
222 *message = strdup ("Error: Database path must be absolute.\n");
223 return NOTMUCH_STATUS_PATH_ERROR;
225 return NOTMUCH_STATUS_SUCCESS;
231 notmuch_database_t *notmuch;
233 notmuch = talloc_zero (NULL, notmuch_database_t);
237 notmuch->exception_reported = false;
238 notmuch->status_string = NULL;
239 notmuch->writable_xapian_db = NULL;
240 notmuch->config_path = NULL;
241 notmuch->atomic_nesting = 0;
246 static notmuch_status_t
247 _trial_open (const char *xapian_path, char **message_ptr)
250 Xapian::Database db (xapian_path);
251 } catch (const Xapian::DatabaseOpeningError &error) {
252 IGNORE_RESULT (asprintf (message_ptr,
253 "Cannot open Xapian database at %s: %s\n",
255 error.get_msg ().c_str ()));
256 return NOTMUCH_STATUS_PATH_ERROR;
257 } catch (const Xapian::Error &error) {
258 IGNORE_RESULT (asprintf (message_ptr,
259 "A Xapian exception occurred opening database: %s\n",
260 error.get_msg ().c_str ()));
261 return NOTMUCH_STATUS_XAPIAN_EXCEPTION;
263 return NOTMUCH_STATUS_SUCCESS;
267 _notmuch_choose_xapian_path (void *ctx, const char *database_path,
268 const char **xapian_path, char **message_ptr)
270 notmuch_status_t status;
271 const char *trial_path, *notmuch_path;
273 status = _db_dir_exists (database_path, message_ptr);
277 trial_path = talloc_asprintf (ctx, "%s/xapian", database_path);
278 status = _trial_open (trial_path, message_ptr);
279 if (status != NOTMUCH_STATUS_PATH_ERROR)
285 notmuch_path = talloc_asprintf (ctx, "%s/.notmuch", database_path);
286 status = _db_dir_exists (notmuch_path, message_ptr);
290 trial_path = talloc_asprintf (ctx, "%s/xapian", notmuch_path);
291 status = _trial_open (trial_path, message_ptr);
294 if (status == NOTMUCH_STATUS_SUCCESS)
295 *xapian_path = trial_path;
300 _set_database_path (notmuch_database_t *notmuch,
301 const char *database_path)
303 char *path = talloc_strdup (notmuch, database_path);
305 strip_trailing (path, '/');
307 _notmuch_config_cache (notmuch, NOTMUCH_CONFIG_DATABASE_PATH, path);
311 _load_database_state (notmuch_database_t *notmuch)
313 std::string last_thread_id;
314 std::string last_mod;
316 notmuch->last_doc_id = notmuch->xapian_db->get_lastdocid ();
317 last_thread_id = notmuch->xapian_db->get_metadata ("last_thread_id");
318 if (last_thread_id.empty ()) {
319 notmuch->last_thread_id = 0;
324 str = last_thread_id.c_str ();
325 notmuch->last_thread_id = strtoull (str, &end, 16);
327 INTERNAL_ERROR ("Malformed database last_thread_id: %s", str);
330 /* Get current highest revision number. */
331 last_mod = notmuch->xapian_db->get_value_upper_bound (
332 NOTMUCH_VALUE_LAST_MOD);
333 if (last_mod.empty ())
334 notmuch->revision = 0;
336 notmuch->revision = Xapian::sortable_unserialise (last_mod);
337 notmuch->uuid = talloc_strdup (
338 notmuch, notmuch->xapian_db->get_uuid ().c_str ());
341 static notmuch_status_t
342 _finish_open (notmuch_database_t *notmuch,
344 notmuch_database_mode_t mode,
348 notmuch_status_t status = NOTMUCH_STATUS_SUCCESS;
349 char *incompat_features;
350 char *message = NULL;
351 unsigned int version;
352 const char *database_path = notmuch_database_get_path (notmuch);
356 if (mode == NOTMUCH_DATABASE_MODE_READ_WRITE) {
357 notmuch->writable_xapian_db = new Xapian::WritableDatabase (notmuch->xapian_path,
359 notmuch->xapian_db = notmuch->writable_xapian_db;
361 notmuch->xapian_db = new Xapian::Database (notmuch->xapian_path);
364 /* Check version. As of database version 3, we represent
365 * changes in terms of features, so assume a version bump
366 * means a dramatically incompatible change. */
367 version = notmuch_database_get_version (notmuch);
368 if (version > NOTMUCH_DATABASE_VERSION) {
369 IGNORE_RESULT (asprintf (&message,
370 "Error: Notmuch database at %s\n"
371 " has a newer database format version (%u) than supported by this\n"
372 " version of notmuch (%u).\n",
373 database_path, version, NOTMUCH_DATABASE_VERSION));
374 notmuch_database_destroy (notmuch);
376 status = NOTMUCH_STATUS_FILE_ERROR;
380 /* Check features. */
381 incompat_features = NULL;
382 notmuch->features = _notmuch_database_parse_features (
383 notmuch, notmuch->xapian_db->get_metadata ("features").c_str (),
384 version, mode == NOTMUCH_DATABASE_MODE_READ_WRITE ? 'w' : 'r',
386 if (incompat_features) {
387 IGNORE_RESULT (asprintf (&message,
388 "Error: Notmuch database at %s\n"
389 " requires features (%s)\n"
390 " not supported by this version of notmuch.\n",
391 database_path, incompat_features));
392 notmuch_database_destroy (notmuch);
394 status = NOTMUCH_STATUS_FILE_ERROR;
398 _load_database_state (notmuch);
400 notmuch->query_parser = new Xapian::QueryParser;
401 notmuch->term_gen = new Xapian::TermGenerator;
402 notmuch->term_gen->set_stemmer (Xapian::Stem ("english"));
403 notmuch->value_range_processor = new Xapian::NumberRangeProcessor (NOTMUCH_VALUE_TIMESTAMP);
404 notmuch->date_range_processor = new ParseTimeRangeProcessor (NOTMUCH_VALUE_TIMESTAMP,
406 notmuch->last_mod_range_processor = new Xapian::NumberRangeProcessor (NOTMUCH_VALUE_LAST_MOD,
408 notmuch->query_parser->set_default_op (Xapian::Query::OP_AND);
409 notmuch->query_parser->set_database (*notmuch->xapian_db);
410 notmuch->query_parser->set_stemmer (Xapian::Stem ("english"));
411 notmuch->query_parser->set_stemming_strategy (Xapian::QueryParser::STEM_SOME);
412 notmuch->query_parser->add_rangeprocessor (notmuch->value_range_processor);
413 notmuch->query_parser->add_rangeprocessor (notmuch->date_range_processor);
414 notmuch->query_parser->add_rangeprocessor (notmuch->last_mod_range_processor);
416 /* Configuration information is needed to set up query parser */
417 status = _notmuch_config_load_from_database (notmuch);
422 status = _notmuch_config_load_from_file (notmuch, key_file);
426 status = _choose_dir (notmuch, profile,
427 NOTMUCH_CONFIG_HOOK_DIR,
435 status = _choose_dir (notmuch, profile,
436 NOTMUCH_CONFIG_BACKUP_DIR,
443 status = _notmuch_config_load_defaults (notmuch);
447 status = _notmuch_database_setup_standard_query_fields (notmuch);
451 status = _notmuch_database_setup_user_query_fields (notmuch);
455 } catch (const Xapian::Error &error) {
456 IGNORE_RESULT (asprintf (&message, "A Xapian exception occurred opening database: %s\n",
457 error.get_msg ().c_str ()));
458 notmuch_database_destroy (notmuch);
460 status = NOTMUCH_STATUS_XAPIAN_EXCEPTION;
464 *message_ptr = message;
469 notmuch_database_open_with_config (const char *database_path,
470 notmuch_database_mode_t mode,
471 const char *config_path,
473 notmuch_database_t **database,
474 char **status_string)
476 notmuch_status_t status = NOTMUCH_STATUS_SUCCESS;
477 void *local = talloc_new (NULL);
478 notmuch_database_t *notmuch = NULL;
479 char *message = NULL;
480 GKeyFile *key_file = NULL;
485 notmuch = _alloc_notmuch ();
487 status = NOTMUCH_STATUS_OUT_OF_MEMORY;
491 status = _load_key_file (notmuch, config_path, profile, &key_file);
493 message = strdup ("Error: cannot load config file.\n");
497 if ((status = _choose_database_path (local, profile, key_file,
498 &database_path, &split,
502 status = _db_dir_exists (database_path, &message);
506 _set_database_path (notmuch, database_path);
508 status = _notmuch_choose_xapian_path (notmuch, database_path,
509 ¬much->xapian_path, &message);
513 status = _finish_open (notmuch, profile, mode, key_file, &message);
519 g_key_file_free (key_file);
523 *status_string = message;
531 talloc_free (notmuch);
534 notmuch->open = true;
540 notmuch_database_create (const char *path, notmuch_database_t **database)
542 char *status_string = NULL;
543 notmuch_status_t status;
545 status = notmuch_database_create_verbose (path, database,
549 fputs (status_string, stderr);
550 free (status_string);
557 notmuch_database_create_verbose (const char *path,
558 notmuch_database_t **database,
559 char **status_string)
561 return notmuch_database_create_with_config (path, "", NULL, database, status_string);
565 notmuch_database_create_with_config (const char *database_path,
566 const char *config_path,
568 notmuch_database_t **database,
569 char **status_string)
571 notmuch_status_t status = NOTMUCH_STATUS_SUCCESS;
572 notmuch_database_t *notmuch = NULL;
573 const char *notmuch_path = NULL;
574 char *message = NULL;
575 GKeyFile *key_file = NULL;
576 void *local = talloc_new (NULL);
582 notmuch = _alloc_notmuch ();
584 status = NOTMUCH_STATUS_OUT_OF_MEMORY;
588 status = _load_key_file (notmuch, config_path, profile, &key_file);
590 message = strdup ("Error: cannot load config file.\n");
594 if ((status = _choose_database_path (local, profile, key_file,
595 &database_path, &split, &message)))
598 status = _db_dir_exists (database_path, &message);
602 _set_database_path (notmuch, database_path);
604 if (key_file && ! split) {
605 char *mail_root = notmuch_canonicalize_file_name (
606 g_key_file_get_value (key_file, "database", "mail_root", NULL));
607 char *db_path = notmuch_canonicalize_file_name (database_path);
609 split = (mail_root && (0 != strcmp (mail_root, db_path)));
616 notmuch_path = database_path;
618 if (! (notmuch_path = talloc_asprintf (local, "%s/%s", database_path, ".notmuch"))) {
619 status = NOTMUCH_STATUS_OUT_OF_MEMORY;
623 err = mkdir (notmuch_path, 0755);
625 if (errno == EEXIST) {
626 status = NOTMUCH_STATUS_DATABASE_EXISTS;
627 talloc_free (notmuch);
630 IGNORE_RESULT (asprintf (&message, "Error: Cannot create directory %s: %s.\n",
631 notmuch_path, strerror (errno)));
632 status = NOTMUCH_STATUS_FILE_ERROR;
638 if (! (notmuch->xapian_path = talloc_asprintf (notmuch, "%s/%s", notmuch_path, "xapian"))) {
639 status = NOTMUCH_STATUS_OUT_OF_MEMORY;
643 status = _trial_open (notmuch->xapian_path, &message);
644 if (status == NOTMUCH_STATUS_SUCCESS) {
645 notmuch_database_destroy (notmuch);
647 status = NOTMUCH_STATUS_DATABASE_EXISTS;
654 status = _finish_open (notmuch,
656 NOTMUCH_DATABASE_MODE_READ_WRITE,
662 /* Upgrade doesn't add these feature to existing databases, but
663 * new databases have them. */
664 notmuch->features |= NOTMUCH_FEATURE_FROM_SUBJECT_ID_VALUES;
665 notmuch->features |= NOTMUCH_FEATURE_INDEXED_MIMETYPES;
666 notmuch->features |= NOTMUCH_FEATURE_UNPREFIX_BODY_ONLY;
668 status = notmuch_database_upgrade (notmuch, NULL, NULL);
670 notmuch_database_close (notmuch);
678 g_key_file_free (key_file);
682 *status_string = message;
689 talloc_free (notmuch);
694 notmuch_database_reopen (notmuch_database_t *notmuch,
695 notmuch_database_mode_t new_mode)
697 notmuch_database_mode_t cur_mode = _notmuch_database_mode (notmuch);
699 if (notmuch->xapian_db == NULL) {
700 _notmuch_database_log (notmuch, "Cannot reopen closed or nonexistent database\n");
701 return NOTMUCH_STATUS_ILLEGAL_ARGUMENT;
705 if (cur_mode == new_mode &&
706 new_mode == NOTMUCH_DATABASE_MODE_READ_ONLY) {
707 notmuch->xapian_db->reopen ();
709 notmuch->xapian_db->close ();
711 delete notmuch->xapian_db;
712 notmuch->xapian_db = NULL;
713 /* no need to free the same object twice */
714 notmuch->writable_xapian_db = NULL;
716 if (new_mode == NOTMUCH_DATABASE_MODE_READ_WRITE) {
717 notmuch->writable_xapian_db = new Xapian::WritableDatabase (notmuch->xapian_path,
719 notmuch->xapian_db = notmuch->writable_xapian_db;
721 notmuch->xapian_db = new Xapian::Database (notmuch->xapian_path,
726 _load_database_state (notmuch);
727 } catch (const Xapian::Error &error) {
728 if (! notmuch->exception_reported) {
729 _notmuch_database_log (notmuch, "Error: A Xapian exception reopening database: %s\n",
730 error.get_msg ().c_str ());
731 notmuch->exception_reported = true;
733 return NOTMUCH_STATUS_XAPIAN_EXCEPTION;
737 notmuch->open = true;
738 return NOTMUCH_STATUS_SUCCESS;
742 _maybe_load_config_from_database (notmuch_database_t *notmuch,
744 const char *database_path,
747 char *message; /* ignored */
749 if (_db_dir_exists (database_path, &message))
750 return NOTMUCH_STATUS_NO_DATABASE;
752 _set_database_path (notmuch, database_path);
754 if (_notmuch_choose_xapian_path (notmuch, database_path, ¬much->xapian_path, &message))
755 return NOTMUCH_STATUS_NO_DATABASE;
757 (void) _finish_open (notmuch, profile, NOTMUCH_DATABASE_MODE_READ_ONLY, key_file, &message);
759 return NOTMUCH_STATUS_SUCCESS;
763 notmuch_database_load_config (const char *database_path,
764 const char *config_path,
766 notmuch_database_t **database,
767 char **status_string)
769 notmuch_status_t status = NOTMUCH_STATUS_SUCCESS, warning = NOTMUCH_STATUS_SUCCESS;
770 void *local = talloc_new (NULL);
771 notmuch_database_t *notmuch = NULL;
772 char *message = NULL;
773 GKeyFile *key_file = NULL;
778 notmuch = _alloc_notmuch ();
780 status = NOTMUCH_STATUS_OUT_OF_MEMORY;
784 status = _load_key_file (notmuch, config_path, profile, &key_file);
786 case NOTMUCH_STATUS_SUCCESS:
788 case NOTMUCH_STATUS_NO_CONFIG:
792 message = strdup ("Error: cannot load config file.\n");
796 status = _choose_database_path (local, profile, key_file,
797 &database_path, &split, &message);
799 case NOTMUCH_STATUS_NO_DATABASE:
800 case NOTMUCH_STATUS_SUCCESS:
810 status = _maybe_load_config_from_database (notmuch, key_file, database_path, profile);
812 case NOTMUCH_STATUS_NO_DATABASE:
813 case NOTMUCH_STATUS_SUCCESS:
823 status = _notmuch_config_load_from_file (notmuch, key_file);
827 status = _notmuch_config_load_defaults (notmuch);
835 *status_string = message;