2 #include "database-private.h"
3 #include "parse-time-vrp.h"
5 #if HAVE_XAPIAN_DB_RETRY_LOCK
6 #define DB_ACTION (Xapian::DB_CREATE_OR_OPEN | Xapian::DB_RETRY_LOCK)
8 #define DB_ACTION Xapian::DB_CREATE_OR_OPEN
12 notmuch_database_open (const char *path,
13 notmuch_database_mode_t mode,
14 notmuch_database_t **database)
16 char *status_string = NULL;
17 notmuch_status_t status;
19 status = notmuch_database_open_verbose (path, mode, database,
23 fputs (status_string, stderr);
31 notmuch_database_open_verbose (const char *path,
32 notmuch_database_mode_t mode,
33 notmuch_database_t **database,
36 return notmuch_database_open_with_config (path, mode, "", NULL,
37 database, status_string);
42 const char *xdg_root_variable,
43 const char *xdg_prefix,
44 const char *profile_name)
46 const char *xdg_root = getenv (xdg_root_variable);
49 const char *home = getenv ("HOME");
51 if (! home) return NULL;
53 xdg_root = talloc_asprintf (ctx,
60 profile_name = getenv ("NOTMUCH_PROFILE");
63 profile_name = "default";
65 return talloc_asprintf (ctx,
71 static notmuch_status_t
72 _choose_hook_dir (notmuch_database_t *notmuch,
81 hook_dir = notmuch_config_get (notmuch, NOTMUCH_CONFIG_HOOK_DIR);
84 return NOTMUCH_STATUS_SUCCESS;
86 config = _xdg_dir (notmuch, "XDG_CONFIG_HOME", ".config", profile);
88 return NOTMUCH_STATUS_PATH_ERROR;
90 hook_dir = talloc_asprintf (notmuch, "%s/hooks", config);
92 err = stat (hook_dir, &st);
94 if (errno == ENOENT) {
95 const char *database_path = notmuch_database_get_path (notmuch);
96 hook_dir = talloc_asprintf (notmuch, "%s/.notmuch/hooks", database_path);
98 IGNORE_RESULT (asprintf (message, "Error: Cannot stat %s: %s.\n",
99 hook_dir, strerror (errno)));
100 return NOTMUCH_STATUS_FILE_ERROR;
104 _notmuch_config_cache (notmuch, NOTMUCH_CONFIG_HOOK_DIR, hook_dir);
106 return NOTMUCH_STATUS_SUCCESS;
109 static notmuch_status_t
110 _load_key_file (const char *path,
114 notmuch_status_t status = NOTMUCH_STATUS_SUCCESS;
115 void *local = talloc_new (NULL);
117 if (path && EMPTY_STRING (path))
121 path = getenv ("NOTMUCH_CONFIG");
124 const char *dir = _xdg_dir (local, "XDG_CONFIG_HOME", ".config", profile);
127 path = talloc_asprintf (local, "%s/config", dir);
128 if (access (path, R_OK) != 0)
134 const char *home = getenv ("HOME");
136 path = talloc_asprintf (local, "%s/.notmuch-config", home);
139 profile = getenv ("NOTMUCH_PROFILE");
142 path = talloc_asprintf (local, "%s.%s", path, profile);
145 *key_file = g_key_file_new ();
146 if (! g_key_file_load_from_file (*key_file, path, G_KEY_FILE_NONE, NULL)) {
147 status = NOTMUCH_STATUS_NO_CONFIG;
155 static notmuch_status_t
156 _db_dir_exists (const char *database_path, char **message)
161 err = stat (database_path, &st);
163 IGNORE_RESULT (asprintf (message, "Error: Cannot open database at %s: %s.\n",
164 database_path, strerror (errno)));
165 return NOTMUCH_STATUS_FILE_ERROR;
168 if (! S_ISDIR (st.st_mode)) {
169 IGNORE_RESULT (asprintf (message, "Error: Cannot open database at %s: "
170 "Not a directory.\n",
172 return NOTMUCH_STATUS_FILE_ERROR;
175 return NOTMUCH_STATUS_SUCCESS;
178 static notmuch_status_t
179 _choose_database_path (void *ctx,
180 const char *config_path,
183 const char **database_path,
186 notmuch_status_t status;
188 status = _load_key_file (config_path, profile, key_file);
190 *message = strdup ("Error: cannot load config file.\n");
194 if (! *database_path) {
195 *database_path = getenv ("NOTMUCH_DATABASE");
198 if (! *database_path && *key_file) {
199 char *path = g_key_file_get_value (*key_file, "database", "path", NULL);
201 *database_path = talloc_strdup (ctx, path);
206 if (*database_path == NULL) {
207 *message = strdup ("Error: Cannot open a database for a NULL path.\n");
208 return NOTMUCH_STATUS_NULL_POINTER;
211 if (*database_path[0] != '/') {
212 *message = strdup ("Error: Database path must be absolute.\n");
213 return NOTMUCH_STATUS_PATH_ERROR;
215 return NOTMUCH_STATUS_SUCCESS;
221 notmuch_database_t *notmuch;
223 notmuch = talloc_zero (NULL, notmuch_database_t);
227 notmuch->exception_reported = false;
228 notmuch->status_string = NULL;
229 notmuch->writable_xapian_db = NULL;
230 notmuch->atomic_nesting = 0;
236 _set_database_path (notmuch_database_t *notmuch,
237 const char *database_path)
239 char *path = talloc_strdup (notmuch, database_path);
241 strip_trailing (path, '/');
243 _notmuch_config_cache (notmuch, NOTMUCH_CONFIG_DATABASE_PATH, path);
250 static int initialized = 0;
252 /* Initialize the GLib type system and threads */
253 #if ! GLIB_CHECK_VERSION (2, 35, 1)
257 /* Initialize gmime */
264 static notmuch_status_t
265 _finish_open (notmuch_database_t *notmuch,
267 notmuch_database_mode_t mode,
271 notmuch_status_t status = NOTMUCH_STATUS_SUCCESS;
272 char *incompat_features;
273 char *message = NULL;
274 unsigned int version;
275 const char *database_path = notmuch_database_get_path (notmuch);
278 std::string last_thread_id;
279 std::string last_mod;
281 if (mode == NOTMUCH_DATABASE_MODE_READ_WRITE) {
282 notmuch->writable_xapian_db = new Xapian::WritableDatabase (notmuch->xapian_path,
284 notmuch->xapian_db = notmuch->writable_xapian_db;
286 notmuch->xapian_db = new Xapian::Database (notmuch->xapian_path);
289 /* Check version. As of database version 3, we represent
290 * changes in terms of features, so assume a version bump
291 * means a dramatically incompatible change. */
292 version = notmuch_database_get_version (notmuch);
293 if (version > NOTMUCH_DATABASE_VERSION) {
294 IGNORE_RESULT (asprintf (&message,
295 "Error: Notmuch database at %s\n"
296 " has a newer database format version (%u) than supported by this\n"
297 " version of notmuch (%u).\n",
298 database_path, version, NOTMUCH_DATABASE_VERSION));
299 notmuch_database_destroy (notmuch);
301 status = NOTMUCH_STATUS_FILE_ERROR;
305 /* Check features. */
306 incompat_features = NULL;
307 notmuch->features = _notmuch_database_parse_features (
308 notmuch, notmuch->xapian_db->get_metadata ("features").c_str (),
309 version, mode == NOTMUCH_DATABASE_MODE_READ_WRITE ? 'w' : 'r',
311 if (incompat_features) {
312 IGNORE_RESULT (asprintf (&message,
313 "Error: Notmuch database at %s\n"
314 " requires features (%s)\n"
315 " not supported by this version of notmuch.\n",
316 database_path, incompat_features));
317 notmuch_database_destroy (notmuch);
319 status = NOTMUCH_STATUS_FILE_ERROR;
323 notmuch->last_doc_id = notmuch->xapian_db->get_lastdocid ();
324 last_thread_id = notmuch->xapian_db->get_metadata ("last_thread_id");
325 if (last_thread_id.empty ()) {
326 notmuch->last_thread_id = 0;
331 str = last_thread_id.c_str ();
332 notmuch->last_thread_id = strtoull (str, &end, 16);
334 INTERNAL_ERROR ("Malformed database last_thread_id: %s", str);
337 /* Get current highest revision number. */
338 last_mod = notmuch->xapian_db->get_value_upper_bound (
339 NOTMUCH_VALUE_LAST_MOD);
340 if (last_mod.empty ())
341 notmuch->revision = 0;
343 notmuch->revision = Xapian::sortable_unserialise (last_mod);
344 notmuch->uuid = talloc_strdup (
345 notmuch, notmuch->xapian_db->get_uuid ().c_str ());
347 notmuch->query_parser = new Xapian::QueryParser;
348 notmuch->term_gen = new Xapian::TermGenerator;
349 notmuch->term_gen->set_stemmer (Xapian::Stem ("english"));
350 notmuch->value_range_processor = new Xapian::NumberRangeProcessor (NOTMUCH_VALUE_TIMESTAMP);
351 notmuch->date_range_processor = new ParseTimeRangeProcessor (NOTMUCH_VALUE_TIMESTAMP,
353 notmuch->last_mod_range_processor = new Xapian::NumberRangeProcessor (NOTMUCH_VALUE_LAST_MOD,
355 notmuch->query_parser->set_default_op (Xapian::Query::OP_AND);
356 notmuch->query_parser->set_database (*notmuch->xapian_db);
357 notmuch->query_parser->set_stemmer (Xapian::Stem ("english"));
358 notmuch->query_parser->set_stemming_strategy (Xapian::QueryParser::STEM_SOME);
359 notmuch->query_parser->add_rangeprocessor (notmuch->value_range_processor);
360 notmuch->query_parser->add_rangeprocessor (notmuch->date_range_processor);
361 notmuch->query_parser->add_rangeprocessor (notmuch->last_mod_range_processor);
363 /* Configuration information is needed to set up query parser */
364 status = _notmuch_config_load_from_database (notmuch);
369 status = _notmuch_config_load_from_file (notmuch, key_file);
373 status = _choose_hook_dir (notmuch, profile, &message);
377 status = _notmuch_config_load_defaults (notmuch);
381 status = _notmuch_database_setup_standard_query_fields (notmuch);
385 status = _notmuch_database_setup_user_query_fields (notmuch);
389 } catch (const Xapian::Error &error) {
390 IGNORE_RESULT (asprintf (&message, "A Xapian exception occurred opening database: %s\n",
391 error.get_msg ().c_str ()));
392 notmuch_database_destroy (notmuch);
394 status = NOTMUCH_STATUS_XAPIAN_EXCEPTION;
398 *message_ptr = message;
403 notmuch_database_open_with_config (const char *database_path,
404 notmuch_database_mode_t mode,
405 const char *config_path,
407 notmuch_database_t **database,
408 char **status_string)
410 notmuch_status_t status = NOTMUCH_STATUS_SUCCESS;
411 void *local = talloc_new (NULL);
412 notmuch_database_t *notmuch = NULL;
414 char *message = NULL;
415 GKeyFile *key_file = NULL;
419 notmuch = _alloc_notmuch ();
421 status = NOTMUCH_STATUS_OUT_OF_MEMORY;
425 if ((status = _choose_database_path (local, config_path, profile, &key_file, &database_path,
429 _set_database_path (notmuch, database_path);
431 status = _db_dir_exists (database_path, &message);
435 if (! (notmuch_path = talloc_asprintf (local, "%s/%s", database_path, ".notmuch"))) {
436 message = strdup ("Out of memory\n");
437 status = NOTMUCH_STATUS_OUT_OF_MEMORY;
441 status = _db_dir_exists (notmuch_path, &message);
445 if (! (notmuch->xapian_path = talloc_asprintf (notmuch, "%s/%s", notmuch_path, "xapian"))) {
446 message = strdup ("Out of memory\n");
447 status = NOTMUCH_STATUS_OUT_OF_MEMORY;
451 status = _finish_open (notmuch, profile, mode, key_file, &message);
457 g_key_file_free (key_file);
461 *status_string = message;
469 talloc_free (notmuch);
472 notmuch->open = true;
478 notmuch_database_create (const char *path, notmuch_database_t **database)
480 char *status_string = NULL;
481 notmuch_status_t status;
483 status = notmuch_database_create_verbose (path, database,
487 fputs (status_string, stderr);
488 free (status_string);
495 notmuch_database_create_verbose (const char *path,
496 notmuch_database_t **database,
497 char **status_string)
499 return notmuch_database_create_with_config (path, "", NULL, database, status_string);
503 notmuch_database_create_with_config (const char *database_path,
504 const char *config_path,
506 notmuch_database_t **database,
507 char **status_string)
509 notmuch_status_t status = NOTMUCH_STATUS_SUCCESS;
510 notmuch_database_t *notmuch = NULL;
511 char *notmuch_path = NULL;
512 char *message = NULL;
513 GKeyFile *key_file = NULL;
514 void *local = talloc_new (NULL);
519 notmuch = _alloc_notmuch ();
521 status = NOTMUCH_STATUS_OUT_OF_MEMORY;
527 if ((status = _choose_database_path (local, config_path, profile,
528 &key_file, &database_path, &message)))
531 status = _db_dir_exists (database_path, &message);
535 _set_database_path (notmuch, database_path);
537 notmuch_path = talloc_asprintf (local, "%s/%s", database_path, ".notmuch");
539 err = mkdir (notmuch_path, 0755);
541 if (errno == EEXIST) {
542 status = NOTMUCH_STATUS_DATABASE_EXISTS;
543 talloc_free (notmuch);
546 IGNORE_RESULT (asprintf (&message, "Error: Cannot create directory %s: %s.\n",
547 notmuch_path, strerror (errno)));
548 status = NOTMUCH_STATUS_FILE_ERROR;
553 if (! (notmuch->xapian_path = talloc_asprintf (notmuch, "%s/%s", notmuch_path, "xapian"))) {
554 status = NOTMUCH_STATUS_OUT_OF_MEMORY;
558 status = _finish_open (notmuch,
560 NOTMUCH_DATABASE_MODE_READ_WRITE,
566 /* Upgrade doesn't add these feature to existing databases, but
567 * new databases have them. */
568 notmuch->features |= NOTMUCH_FEATURE_FROM_SUBJECT_ID_VALUES;
569 notmuch->features |= NOTMUCH_FEATURE_INDEXED_MIMETYPES;
570 notmuch->features |= NOTMUCH_FEATURE_UNPREFIX_BODY_ONLY;
572 status = notmuch_database_upgrade (notmuch, NULL, NULL);
574 notmuch_database_close (notmuch);
582 g_key_file_free (key_file);
586 *status_string = message;
593 talloc_free (notmuch);
598 notmuch_database_reopen (notmuch_database_t *notmuch,
599 notmuch_database_mode_t new_mode)
601 notmuch_database_mode_t cur_mode = _notmuch_database_mode (notmuch);
603 if (notmuch->xapian_db == NULL) {
604 _notmuch_database_log (notmuch, "Cannot reopen closed or nonexistent database\n");
605 return NOTMUCH_STATUS_ILLEGAL_ARGUMENT;
609 if (cur_mode == new_mode &&
610 new_mode == NOTMUCH_DATABASE_MODE_READ_ONLY) {
611 notmuch->xapian_db->reopen ();
613 notmuch->xapian_db->close ();
615 delete notmuch->xapian_db;
616 notmuch->xapian_db = NULL;
617 /* no need to free the same object twice */
618 notmuch->writable_xapian_db = NULL;
620 if (new_mode == NOTMUCH_DATABASE_MODE_READ_WRITE) {
621 notmuch->writable_xapian_db = new Xapian::WritableDatabase (notmuch->xapian_path,
623 notmuch->xapian_db = notmuch->writable_xapian_db;
625 notmuch->xapian_db = new Xapian::Database (notmuch->xapian_path,
629 } catch (const Xapian::Error &error) {
630 if (! notmuch->exception_reported) {
631 _notmuch_database_log (notmuch, "Error: A Xapian exception reopening database: %s\n",
632 error.get_msg ().c_str ());
633 notmuch->exception_reported = true;
635 return NOTMUCH_STATUS_XAPIAN_EXCEPTION;
639 notmuch->open = true;
640 return NOTMUCH_STATUS_SUCCESS;