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 _choose_database_path (void *ctx,
157 const char *config_path,
160 const char **database_path,
163 notmuch_status_t status;
165 status = _load_key_file (config_path, profile, key_file);
167 *message = strdup ("Error: cannot load config file.\n");
171 if (! *database_path && *key_file) {
172 char *path = g_key_file_get_value (*key_file, "database", "path", NULL);
174 *database_path = talloc_strdup (ctx, path);
179 if (*database_path == NULL) {
180 *message = strdup ("Error: Cannot open a database for a NULL path.\n");
181 return NOTMUCH_STATUS_NULL_POINTER;
184 if (*database_path[0] != '/') {
185 *message = strdup ("Error: Database path must be absolute.\n");
186 return NOTMUCH_STATUS_PATH_ERROR;
188 return NOTMUCH_STATUS_SUCCESS;
192 notmuch_database_open_with_config (const char *database_path,
193 notmuch_database_mode_t mode,
194 const char *config_path,
196 notmuch_database_t **database,
197 char **status_string)
199 notmuch_status_t status = NOTMUCH_STATUS_SUCCESS;
200 void *local = talloc_new (NULL);
201 notmuch_database_t *notmuch = NULL;
202 char *notmuch_path, *xapian_path, *incompat_features;
203 char *message = NULL;
206 unsigned int version;
207 GKeyFile *key_file = NULL;
208 static int initialized = 0;
210 if ((status = _choose_database_path (local, config_path, profile, &key_file, &database_path,
214 if (! (notmuch_path = talloc_asprintf (local, "%s/%s", database_path, ".notmuch"))) {
215 message = strdup ("Out of memory\n");
216 status = NOTMUCH_STATUS_OUT_OF_MEMORY;
220 err = stat (notmuch_path, &st);
222 IGNORE_RESULT (asprintf (&message, "Error opening database at %s: %s\n",
223 notmuch_path, strerror (errno)));
224 status = NOTMUCH_STATUS_FILE_ERROR;
228 if (! (xapian_path = talloc_asprintf (local, "%s/%s", notmuch_path, "xapian"))) {
229 message = strdup ("Out of memory\n");
230 status = NOTMUCH_STATUS_OUT_OF_MEMORY;
234 /* Initialize the GLib type system and threads */
235 #if ! GLIB_CHECK_VERSION (2, 35, 1)
239 /* Initialize gmime */
245 notmuch = talloc_zero (NULL, notmuch_database_t);
246 notmuch->exception_reported = false;
247 notmuch->status_string = NULL;
248 notmuch->path = talloc_strdup (notmuch, database_path);
250 strip_trailing (notmuch->path, '/');
252 notmuch->writable_xapian_db = NULL;
253 notmuch->atomic_nesting = 0;
256 std::string last_thread_id;
257 std::string last_mod;
259 if (mode == NOTMUCH_DATABASE_MODE_READ_WRITE) {
260 notmuch->writable_xapian_db = new Xapian::WritableDatabase (xapian_path,
262 notmuch->xapian_db = notmuch->writable_xapian_db;
264 notmuch->xapian_db = new Xapian::Database (xapian_path);
267 /* Check version. As of database version 3, we represent
268 * changes in terms of features, so assume a version bump
269 * means a dramatically incompatible change. */
270 version = notmuch_database_get_version (notmuch);
271 if (version > NOTMUCH_DATABASE_VERSION) {
272 IGNORE_RESULT (asprintf (&message,
273 "Error: Notmuch database at %s\n"
274 " has a newer database format version (%u) than supported by this\n"
275 " version of notmuch (%u).\n",
276 notmuch_path, version, NOTMUCH_DATABASE_VERSION));
277 notmuch_database_destroy (notmuch);
279 status = NOTMUCH_STATUS_FILE_ERROR;
283 /* Check features. */
284 incompat_features = NULL;
285 notmuch->features = _notmuch_database_parse_features (
286 local, notmuch->xapian_db->get_metadata ("features").c_str (),
287 version, mode == NOTMUCH_DATABASE_MODE_READ_WRITE ? 'w' : 'r',
289 if (incompat_features) {
290 IGNORE_RESULT (asprintf (&message,
291 "Error: Notmuch database at %s\n"
292 " requires features (%s)\n"
293 " not supported by this version of notmuch.\n",
294 notmuch_path, incompat_features));
295 notmuch_database_destroy (notmuch);
297 status = NOTMUCH_STATUS_FILE_ERROR;
301 notmuch->last_doc_id = notmuch->xapian_db->get_lastdocid ();
302 last_thread_id = notmuch->xapian_db->get_metadata ("last_thread_id");
303 if (last_thread_id.empty ()) {
304 notmuch->last_thread_id = 0;
309 str = last_thread_id.c_str ();
310 notmuch->last_thread_id = strtoull (str, &end, 16);
312 INTERNAL_ERROR ("Malformed database last_thread_id: %s", str);
315 /* Get current highest revision number. */
316 last_mod = notmuch->xapian_db->get_value_upper_bound (
317 NOTMUCH_VALUE_LAST_MOD);
318 if (last_mod.empty ())
319 notmuch->revision = 0;
321 notmuch->revision = Xapian::sortable_unserialise (last_mod);
322 notmuch->uuid = talloc_strdup (
323 notmuch, notmuch->xapian_db->get_uuid ().c_str ());
325 notmuch->query_parser = new Xapian::QueryParser;
326 notmuch->term_gen = new Xapian::TermGenerator;
327 notmuch->term_gen->set_stemmer (Xapian::Stem ("english"));
328 notmuch->value_range_processor = new Xapian::NumberRangeProcessor (NOTMUCH_VALUE_TIMESTAMP);
329 notmuch->date_range_processor = new ParseTimeRangeProcessor (NOTMUCH_VALUE_TIMESTAMP,
331 notmuch->last_mod_range_processor = new Xapian::NumberRangeProcessor (NOTMUCH_VALUE_LAST_MOD,
333 notmuch->query_parser->set_default_op (Xapian::Query::OP_AND);
334 notmuch->query_parser->set_database (*notmuch->xapian_db);
335 notmuch->query_parser->set_stemmer (Xapian::Stem ("english"));
336 notmuch->query_parser->set_stemming_strategy (Xapian::QueryParser::STEM_SOME);
337 notmuch->query_parser->add_rangeprocessor (notmuch->value_range_processor);
338 notmuch->query_parser->add_rangeprocessor (notmuch->date_range_processor);
339 notmuch->query_parser->add_rangeprocessor (notmuch->last_mod_range_processor);
341 /* Configuration information is needed to set up query parser */
342 status = _notmuch_config_load_from_database (notmuch);
347 status = _notmuch_config_load_from_file (notmuch, key_file);
351 status = _choose_hook_dir (notmuch, profile, &message);
355 status = _notmuch_config_load_defaults (notmuch);
359 status = _notmuch_database_setup_standard_query_fields (notmuch);
363 status = _notmuch_database_setup_user_query_fields (notmuch);
367 } catch (const Xapian::Error &error) {
368 IGNORE_RESULT (asprintf (&message, "A Xapian exception occurred opening database: %s\n",
369 error.get_msg ().c_str ()));
370 notmuch_database_destroy (notmuch);
372 status = NOTMUCH_STATUS_XAPIAN_EXCEPTION;
380 *status_string = message;
388 talloc_free (notmuch);
391 notmuch->open = true;
397 notmuch_database_create (const char *path, notmuch_database_t **database)
399 char *status_string = NULL;
400 notmuch_status_t status;
402 status = notmuch_database_create_verbose (path, database,
406 fputs (status_string, stderr);
407 free (status_string);
414 notmuch_database_create_verbose (const char *path,
415 notmuch_database_t **database,
416 char **status_string)
418 return notmuch_database_create_with_config (path, "", NULL, database, status_string);
422 notmuch_database_create_with_config (const char *database_path,
423 const char *config_path,
425 notmuch_database_t **database,
426 char **status_string)
428 notmuch_status_t status = NOTMUCH_STATUS_SUCCESS;
429 notmuch_database_t *notmuch = NULL;
430 char *notmuch_path = NULL;
431 char *message = NULL;
432 GKeyFile *key_file = NULL;
435 void *local = talloc_new (NULL);
437 if ((status = _choose_database_path (local, config_path, profile, &key_file, &database_path,
441 err = stat (database_path, &st);
443 IGNORE_RESULT (asprintf (&message, "Error: Cannot create database at %s: %s.\n",
444 database_path, strerror (errno)));
445 status = NOTMUCH_STATUS_FILE_ERROR;
449 if (! S_ISDIR (st.st_mode)) {
450 IGNORE_RESULT (asprintf (&message, "Error: Cannot create database at %s: "
451 "Not a directory.\n",
453 status = NOTMUCH_STATUS_FILE_ERROR;
457 notmuch_path = talloc_asprintf (local, "%s/%s", database_path, ".notmuch");
459 err = mkdir (notmuch_path, 0755);
461 if (errno == EEXIST) {
462 status = NOTMUCH_STATUS_DATABASE_EXISTS;
464 IGNORE_RESULT (asprintf (&message, "Error: Cannot create directory %s: %s.\n",
465 notmuch_path, strerror (errno)));
466 status = NOTMUCH_STATUS_FILE_ERROR;
471 /* XXX this reads the config file twice, which is a bit wasteful */
472 status = notmuch_database_open_with_config (database_path,
473 NOTMUCH_DATABASE_MODE_READ_WRITE,
480 /* Upgrade doesn't add these feature to existing databases, but
481 * new databases have them. */
482 notmuch->features |= NOTMUCH_FEATURE_FROM_SUBJECT_ID_VALUES;
483 notmuch->features |= NOTMUCH_FEATURE_INDEXED_MIMETYPES;
484 notmuch->features |= NOTMUCH_FEATURE_UNPREFIX_BODY_ONLY;
486 status = notmuch_database_upgrade (notmuch, NULL, NULL);
488 notmuch_database_close (notmuch);
497 *status_string = message;
504 talloc_free (notmuch);