return "Unbalanced number of calls to notmuch_database_begin_atomic/end_atomic";
case NOTMUCH_STATUS_UNSUPPORTED_OPERATION:
return "Unsupported operation";
+ case NOTMUCH_STATUS_UPGRADE_REQUIRED:
+ return "Operation requires a database upgrade";
default:
case NOTMUCH_STATUS_LAST_STATUS:
return "Unknown error status value";
*
* notmuch-sha1-<sha1_sum_of_message_id>
*/
-static char *
-_message_id_compressed (void *ctx, const char *message_id)
+char *
+_notmuch_message_id_compressed (void *ctx, const char *message_id)
{
char *sha1, *compressed;
return NOTMUCH_STATUS_NULL_POINTER;
if (strlen (message_id) > NOTMUCH_MESSAGE_ID_MAX)
- message_id = _message_id_compressed (notmuch, message_id);
+ message_id = _notmuch_message_id_compressed (notmuch, message_id);
try {
status = _notmuch_database_find_unique_doc_id (notmuch, "id",
{
notmuch_status_t status = NOTMUCH_STATUS_SUCCESS;
- try {
- if (notmuch->xapian_db != NULL &&
- notmuch->mode == NOTMUCH_DATABASE_MODE_READ_WRITE)
- (static_cast <Xapian::WritableDatabase *> (notmuch->xapian_db))->flush ();
- } catch (const Xapian::Error &error) {
- status = NOTMUCH_STATUS_XAPIAN_EXCEPTION;
- if (! notmuch->exception_reported) {
- fprintf (stderr, "Error: A Xapian exception occurred flushing database: %s\n",
- error.get_msg().c_str());
- }
- }
-
/* Many Xapian objects (and thus notmuch objects) hold references to
* the database, so merely deleting the database may not suffice to
* close it. Thus, we explicitly close it here. */
if (notmuch->xapian_db != NULL) {
try {
+ /* If there's an outstanding transaction, it's unclear if
+ * closing the Xapian database commits everything up to
+ * that transaction, or may discard committed (but
+ * unflushed) transactions. To be certain, explicitly
+ * cancel any outstanding transaction before closing. */
+ if (notmuch->mode == NOTMUCH_DATABASE_MODE_READ_WRITE &&
+ notmuch->atomic_nesting)
+ (static_cast <Xapian::WritableDatabase *> (notmuch->xapian_db))
+ ->cancel_transaction ();
+
+ /* Close the database. This implicitly flushes
+ * outstanding changes. */
notmuch->xapian_db->close();
} catch (const Xapian::Error &error) {
- /* don't clobber previous error status */
- if (status == NOTMUCH_STATUS_SUCCESS)
- status = NOTMUCH_STATUS_XAPIAN_EXCEPTION;
+ status = NOTMUCH_STATUS_XAPIAN_EXCEPTION;
+ if (! notmuch->exception_reported) {
+ fprintf (stderr, "Error: A Xapian exception occurred closing database: %s\n",
+ error.get_msg().c_str());
+ }
}
}
void *closure)
{
void *local = talloc_new (NULL);
+ Xapian::TermIterator t, t_end;
Xapian::WritableDatabase *db;
struct sigaction action;
struct itimerval timerval;
notmuch_bool_t timer_is_active = FALSE;
- unsigned int version;
+ enum _notmuch_features target_features, new_features;
notmuch_status_t status;
unsigned int count = 0, total = 0;
db = static_cast <Xapian::WritableDatabase *> (notmuch->xapian_db);
- version = notmuch_database_get_version (notmuch);
+ target_features = notmuch->features | NOTMUCH_FEATURES_CURRENT;
+ new_features = NOTMUCH_FEATURES_CURRENT & ~notmuch->features;
- if (version >= NOTMUCH_DATABASE_VERSION)
+ if (! notmuch_database_needs_upgrade (notmuch))
return NOTMUCH_STATUS_SUCCESS;
if (progress_notify) {
timer_is_active = TRUE;
}
+ /* Figure out how much total work we need to do. */
+ if (new_features &
+ (NOTMUCH_FEATURE_FILE_TERMS | NOTMUCH_FEATURE_BOOL_FOLDER)) {
+ notmuch_query_t *query = notmuch_query_create (notmuch, "");
+ total += notmuch_query_count_messages (query);
+ notmuch_query_destroy (query);
+ }
+ if (new_features & NOTMUCH_FEATURE_DIRECTORY_DOCS) {
+ t_end = db->allterms_end ("XTIMESTAMP");
+ for (t = db->allterms_begin ("XTIMESTAMP"); t != t_end; t++)
+ ++total;
+ }
+
+ /* Perform the upgrade in a transaction. */
+ db->begin_transaction (true);
+
/* Set the target features so we write out changes in the desired
* format. */
- notmuch->features |= NOTMUCH_FEATURES_CURRENT;
+ notmuch->features = target_features;
- /* Before version 1, each message document had its filename in the
- * data field. Copy that into the new format by calling
- * notmuch_message_add_filename.
- */
- if (version < 1) {
+ /* Perform per-message upgrades. */
+ if (new_features &
+ (NOTMUCH_FEATURE_FILE_TERMS | NOTMUCH_FEATURE_BOOL_FOLDER)) {
notmuch_query_t *query = notmuch_query_create (notmuch, "");
notmuch_messages_t *messages;
notmuch_message_t *message;
char *filename;
- Xapian::TermIterator t, t_end;
-
- total = notmuch_query_count_messages (query);
for (messages = notmuch_query_search_messages (query);
notmuch_messages_valid (messages);
message = notmuch_messages_get (messages);
- filename = _notmuch_message_talloc_copy_data (message);
- if (filename && *filename != '\0') {
- _notmuch_message_add_filename (message, filename);
- _notmuch_message_sync (message);
+ /* Before version 1, each message document had its
+ * filename in the data field. Copy that into the new
+ * format by calling notmuch_message_add_filename.
+ */
+ if (new_features & NOTMUCH_FEATURE_FILE_TERMS) {
+ filename = _notmuch_message_talloc_copy_data (message);
+ if (filename && *filename != '\0') {
+ _notmuch_message_add_filename (message, filename);
+ _notmuch_message_clear_data (message);
+ }
+ talloc_free (filename);
}
- talloc_free (filename);
+
+ /* Prior to version 2, the "folder:" prefix was
+ * probabilistic and stemmed. Change it to the current
+ * boolean prefix. Add "path:" prefixes while at it.
+ */
+ if (new_features & NOTMUCH_FEATURE_BOOL_FOLDER)
+ _notmuch_message_upgrade_folder (message);
+
+ _notmuch_message_sync (message);
notmuch_message_destroy (message);
}
notmuch_query_destroy (query);
+ }
- /* Also, before version 1 we stored directory timestamps in
- * XTIMESTAMP documents instead of the current XDIRECTORY
- * documents. So copy those as well. */
+ /* Perform per-directory upgrades. */
+ /* Before version 1 we stored directory timestamps in
+ * XTIMESTAMP documents instead of the current XDIRECTORY
+ * documents. So copy those as well. */
+ if (new_features & NOTMUCH_FEATURE_DIRECTORY_DOCS) {
t_end = notmuch->xapian_db->allterms_end ("XTIMESTAMP");
for (t = notmuch->xapian_db->allterms_begin ("XTIMESTAMP");
NOTMUCH_FIND_CREATE, &status);
notmuch_directory_set_mtime (directory, mtime);
notmuch_directory_destroy (directory);
- }
- }
- }
- /*
- * Prior to version 2, the "folder:" prefix was probabilistic and
- * stemmed. Change it to the current boolean prefix. Add "path:"
- * prefixes while at it.
- */
- if (version < 2) {
- notmuch_query_t *query = notmuch_query_create (notmuch, "");
- notmuch_messages_t *messages;
- notmuch_message_t *message;
-
- count = 0;
- total = notmuch_query_count_messages (query);
-
- for (messages = notmuch_query_search_messages (query);
- notmuch_messages_valid (messages);
- notmuch_messages_move_to_next (messages)) {
- if (do_progress_notify) {
- progress_notify (closure, (double) count / total);
- do_progress_notify = 0;
+ db->delete_document (*p);
}
- message = notmuch_messages_get (messages);
-
- _notmuch_message_upgrade_folder (message);
- _notmuch_message_sync (message);
-
- notmuch_message_destroy (message);
-
- count++;
+ ++count;
}
-
- notmuch_query_destroy (query);
}
db->set_metadata ("features", _print_features (local, notmuch->features));
db->set_metadata ("version", STRINGIFY (NOTMUCH_DATABASE_VERSION));
- db->flush ();
- /* Now that the upgrade is complete we can remove the old data
- * and documents that are no longer needed. */
- if (version < 1) {
- notmuch_query_t *query = notmuch_query_create (notmuch, "");
- notmuch_messages_t *messages;
- notmuch_message_t *message;
- char *filename;
-
- for (messages = notmuch_query_search_messages (query);
- notmuch_messages_valid (messages);
- notmuch_messages_move_to_next (messages))
- {
- if (do_progress_notify) {
- progress_notify (closure, (double) count / total);
- do_progress_notify = 0;
- }
-
- message = notmuch_messages_get (messages);
-
- filename = _notmuch_message_talloc_copy_data (message);
- if (filename && *filename != '\0') {
- _notmuch_message_clear_data (message);
- _notmuch_message_sync (message);
- }
- talloc_free (filename);
-
- notmuch_message_destroy (message);
- }
-
- notmuch_query_destroy (query);
- }
-
- if (version < 1) {
- Xapian::TermIterator t, t_end;
-
- t_end = notmuch->xapian_db->allterms_end ("XTIMESTAMP");
-
- for (t = notmuch->xapian_db->allterms_begin ("XTIMESTAMP");
- t != t_end;
- t++)
- {
- Xapian::PostingIterator p, p_end;
- std::string term = *t;
-
- p_end = notmuch->xapian_db->postlist_end (term);
-
- for (p = notmuch->xapian_db->postlist_begin (term);
- p != p_end;
- p++)
- {
- if (do_progress_notify) {
- progress_notify (closure, (double) count / total);
- do_progress_notify = 0;
- }
-
- db->delete_document (*p);
- }
- }
- }
+ db->commit_transaction ();
if (timer_is_active) {
/* Now stop the timer. */
_get_metadata_thread_id_key (void *ctx, const char *message_id)
{
if (strlen (message_id) > NOTMUCH_MESSAGE_ID_MAX)
- message_id = _message_id_compressed (ctx, message_id);
+ message_id = _notmuch_message_id_compressed (ctx, message_id);
return talloc_asprintf (ctx, NOTMUCH_METADATA_THREAD_ID_PREFIX "%s",
message_id);
return ret;
}
+/* Fetch and clear the stored thread_id for message, or NULL if none. */
+static char *
+_consume_metadata_thread_id (void *ctx, notmuch_database_t *notmuch,
+ notmuch_message_t *message)
+{
+ const char *message_id;
+ string stored_id;
+ char *metadata_key;
+
+ message_id = notmuch_message_get_message_id (message);
+ metadata_key = _get_metadata_thread_id_key (ctx, message_id);
+
+ /* Check if we have already seen related messages to this one.
+ * If we have then use the thread_id that we stored at that time.
+ */
+ stored_id = notmuch->xapian_db->get_metadata (metadata_key);
+ if (stored_id.empty ()) {
+ return NULL;
+ } else {
+ Xapian::WritableDatabase *db;
+
+ db = static_cast <Xapian::WritableDatabase *> (notmuch->xapian_db);
+
+ /* Clear the metadata for this message ID. We don't need it
+ * anymore. */
+ db->set_metadata (metadata_key, "");
+
+ return talloc_strdup (ctx, stored_id.c_str ());
+ }
+}
+
/* Given a (mostly empty) 'message' and its corresponding
* 'message_file' link it to existing threads in the database.
*
notmuch_message_t *message,
notmuch_message_file_t *message_file)
{
+ void *local = talloc_new (NULL);
notmuch_status_t status;
- const char *message_id, *thread_id = NULL;
- char *metadata_key;
- string stored_id;
-
- message_id = notmuch_message_get_message_id (message);
- metadata_key = _get_metadata_thread_id_key (message, message_id);
-
- /* Check if we have already seen related messages to this one.
- * If we have then use the thread_id that we stored at that time.
- */
- stored_id = notmuch->xapian_db->get_metadata (metadata_key);
- if (! stored_id.empty()) {
- Xapian::WritableDatabase *db;
-
- db = static_cast <Xapian::WritableDatabase *> (notmuch->xapian_db);
-
- /* Clear the metadata for this message ID. We don't need it
- * anymore. */
- db->set_metadata (metadata_key, "");
- thread_id = stored_id.c_str();
+ const char *thread_id;
- _notmuch_message_add_term (message, "thread", thread_id);
- }
- talloc_free (metadata_key);
+ /* Check if the message already had a thread ID */
+ thread_id = _consume_metadata_thread_id (local, notmuch, message);
+ if (thread_id)
+ _notmuch_message_add_term (message, "thread", thread_id);
status = _notmuch_database_link_message_to_parents (notmuch, message,
message_file,
&thread_id);
if (status)
- return status;
+ goto DONE;
status = _notmuch_database_link_message_to_children (notmuch, message,
&thread_id);
if (status)
- return status;
+ goto DONE;
/* If not part of any existing thread, generate a new thread ID. */
if (thread_id == NULL) {
_notmuch_message_add_term (message, "thread", thread_id);
}
- return NOTMUCH_STATUS_SUCCESS;
+ DONE:
+ talloc_free (local);
+
+ return status;
}
notmuch_status_t
* better than no message-id at all. */
if (message_id == NULL)
message_id = talloc_strdup (message_file, header);
-
- /* If a message ID is too long, substitute its sha1 instead. */
- if (message_id && strlen (message_id) > NOTMUCH_MESSAGE_ID_MAX) {
- char *compressed = _message_id_compressed (message_file,
- message_id);
- talloc_free (message_id);
- message_id = compressed;
- }
}
if (message_id == NULL ) {
if (message_ret == NULL)
return NOTMUCH_STATUS_NULL_POINTER;
+ if (! (notmuch->features & NOTMUCH_FEATURE_FILE_TERMS))
+ return NOTMUCH_STATUS_UPGRADE_REQUIRED;
+
/* return NULL on any failure */
*message_ret = NULL;