]> git.notmuchmail.org Git - notmuch/blobdiff - lib/database.cc
Avoid database corruption by not adding partially-constructed mail documents.
[notmuch] / lib / database.cc
index 39cbc68342eccb58d93f7534fe6a30c43bedbc5a..dd1fc6378c48c8b435eab97a0cede52ebc975f0a 100644 (file)
@@ -44,7 +44,8 @@ typedef struct {
 
 /* Here's the current schema for our database (for NOTMUCH_DATABASE_VERSION):
  *
- * We currently have two different types of documents: mail and directory.
+ * We currently have two different types of documents (mail and
+ * directory) and also some metadata.
  *
  * Mail document
  * -------------
@@ -118,6 +119,49 @@ typedef struct {
  *
  * The data portion of a directory document contains the path of the
  * directory (relative to the database path).
+ *
+ * Database metadata
+ * -----------------
+ * Xapian allows us to store arbitrary name-value pairs as
+ * "metadata". We currently use the following metadata names with the
+ * given meanings:
+ *
+ *     version         The database schema version, (which is distinct
+ *                     from both the notmuch package version (see
+ *                     notmuch --version) and the libnotmuch library
+ *                     version. The version is stored as an base-10
+ *                     ASCII integer. The initial database version
+ *                     was 1, (though a schema existed before that
+ *                     were no "version" database value existed at
+ *                     all). Succesive versions are allocated as
+ *                     changes are made to the database (such as by
+ *                     indexing new fields).
+ *
+ *     last_thread_id  The last thread ID generated. This is stored
+ *                     as a 16-byte hexadecimal ASCII representation
+ *                     of a 64-bit unsigned integer. The first ID
+ *                     generated is 1 and the value will be
+ *                     incremented for each thread ID.
+ *
+ *     thread_id_*     A pre-allocated thread ID for a particular
+ *                     message. This is actually an arbitarily large
+ *                     family of metadata name. Any particular name
+ *                     is formed by concatenating "thread_id_" with a
+ *                     message ID. The value stored is a thread ID.
+ *
+ *                     These thread ID metadata values are stored
+ *                     whenever a message references a parent message
+ *                     that does not yet exist in the database. A
+ *                     thread ID will be allocated and stored, and if
+ *                     the message is later added, the stored thread
+ *                     ID will be used (and the metadata value will
+ *                     be cleared).
+ *
+ *                     Even before a message is added, it's
+ *                     pre-allocated thread ID is useful so that all
+ *                     descendant messages that reference this common
+ *                     parent can be recognized as belonging to the
+ *                     same thread.
  */
 
 /* With these prefix values we follow the conventions published here:
@@ -297,13 +341,20 @@ notmuch_database_find_message (notmuch_database_t *notmuch,
     notmuch_private_status_t status;
     unsigned int doc_id;
 
-    status = _notmuch_database_find_unique_doc_id (notmuch, "id",
-                                                  message_id, &doc_id);
+    try {
+       status = _notmuch_database_find_unique_doc_id (notmuch, "id",
+                                                      message_id, &doc_id);
 
-    if (status == NOTMUCH_PRIVATE_STATUS_NO_DOCUMENT_FOUND)
-       return NULL;
+       if (status == NOTMUCH_PRIVATE_STATUS_NO_DOCUMENT_FOUND)
+           return NULL;
 
-    return _notmuch_message_create (notmuch, notmuch, doc_id, NULL);
+       return _notmuch_message_create (notmuch, notmuch, doc_id, NULL);
+    } catch (const Xapian::Error &error) {
+       fprintf (stderr, "A Xapian exception occurred finding message: %s.\n",
+                error.get_msg().c_str());
+       notmuch->exception_reported = TRUE;
+       return NULL;
+    }
 }
 
 /* Advance 'str' past any whitespace or RFC 822 comments. A comment is
@@ -571,6 +622,7 @@ notmuch_database_open (const char *path,
            }
        }
 
+       notmuch->last_doc_id = notmuch->xapian_db->get_lastdocid ();
        last_thread_id = notmuch->xapian_db->get_metadata ("last_thread_id");
        if (last_thread_id.empty ()) {
            notmuch->last_thread_id = 0;
@@ -1108,7 +1160,39 @@ notmuch_database_get_directory (notmuch_database_t *notmuch,
 {
     notmuch_status_t status;
 
-    return _notmuch_directory_create (notmuch, path, &status);
+    try {
+       return _notmuch_directory_create (notmuch, path, &status);
+    } catch (const Xapian::Error &error) {
+       fprintf (stderr, "A Xapian exception occurred getting directory: %s.\n",
+                error.get_msg().c_str());
+       notmuch->exception_reported = TRUE;
+       return NULL;
+    }
+}
+
+/* Allocate a document ID that satisfies the following criteria:
+ *
+ * 1. The ID does not exist for any document in the Xapian database
+ *
+ * 2. The ID was not previously returned from this function
+ *
+ * 3. The ID is the smallest integer satisfying (1) and (2)
+ *
+ * This function will trigger an internal error if these constraints
+ * cannot all be satisfied, (that is, the pool of available document
+ * IDs has been exhausted).
+ */
+unsigned int
+_notmuch_database_generate_doc_id (notmuch_database_t *notmuch)
+{
+    assert (notmuch->last_doc_id >= notmuch->xapian_db->get_lastdocid ());
+
+    notmuch->last_doc_id++;
+
+    if (notmuch->last_doc_id == 0)
+       INTERNAL_ERROR ("Xapian document IDs are exhausted.\n");        
+
+    return notmuch->last_doc_id;
 }
 
 static const char *
@@ -1269,22 +1353,21 @@ _notmuch_database_link_message_to_parents (notmuch_database_t *notmuch,
        const char *parent_thread_id;
 
        parent_message_id = (char *) l->data;
+
+       _notmuch_message_add_term (message, "reference",
+                                  parent_message_id);
+
        parent_thread_id = _resolve_message_id_to_thread_id (notmuch,
                                                             message,
                                                             parent_message_id);
 
-       if (parent_thread_id == NULL) {
-           _notmuch_message_add_term (message, "reference",
-                                      parent_message_id);
-       } else {
-           if (*thread_id == NULL) {
-               *thread_id = talloc_strdup (message, parent_thread_id);
-               _notmuch_message_add_term (message, "thread", *thread_id);
-           } else if (strcmp (*thread_id, parent_thread_id)) {
-               ret = _merge_threads (notmuch, *thread_id, parent_thread_id);
-               if (ret)
-                   goto DONE;
-           }
+       if (*thread_id == NULL) {
+           *thread_id = talloc_strdup (message, parent_thread_id);
+           _notmuch_message_add_term (message, "thread", *thread_id);
+       } else if (strcmp (*thread_id, parent_thread_id)) {
+           ret = _merge_threads (notmuch, *thread_id, parent_thread_id);
+           if (ret)
+               goto DONE;
        }
     }
 
@@ -1548,7 +1631,7 @@ notmuch_database_add_message (notmuch_database_t *notmuch,
        _notmuch_message_sync (message);
     } catch (const Xapian::Error &error) {
        fprintf (stderr, "A Xapian exception occurred adding message: %s.\n",
-                error.get_description().c_str());
+                error.get_msg().c_str());
        notmuch->exception_reported = TRUE;
        ret = NOTMUCH_STATUS_XAPIAN_EXCEPTION;
        goto DONE;
@@ -1573,7 +1656,7 @@ notmuch_database_remove_message (notmuch_database_t *notmuch,
                                 const char *filename)
 {
     Xapian::WritableDatabase *db;
-    void *local = talloc_new (notmuch);
+    void *local;
     const char *prefix = _find_prefix ("file-direntry");
     char *direntry, *term;
     Xapian::PostingIterator i, end;
@@ -1584,37 +1667,47 @@ notmuch_database_remove_message (notmuch_database_t *notmuch,
     if (status)
        return status;
 
+    local = talloc_new (notmuch);
+
     db = static_cast <Xapian::WritableDatabase *> (notmuch->xapian_db);
 
-    status = _notmuch_database_filename_to_direntry (local, notmuch,
-                                                    filename, &direntry);
-    if (status)
-       return status;
+    try {
 
-    term = talloc_asprintf (notmuch, "%s%s", prefix, direntry);
+       status = _notmuch_database_filename_to_direntry (local, notmuch,
+                                                        filename, &direntry);
+       if (status)
+           return status;
 
-    find_doc_ids_for_term (notmuch, term, &i, &end);
+       term = talloc_asprintf (notmuch, "%s%s", prefix, direntry);
 
-    for ( ; i != end; i++) {
-       Xapian::TermIterator j;
+       find_doc_ids_for_term (notmuch, term, &i, &end);
 
-       document = find_document_for_doc_id (notmuch, *i);
+       for ( ; i != end; i++) {
+           Xapian::TermIterator j;
 
-       document.remove_term (term);
+           document = find_document_for_doc_id (notmuch, *i);
 
-       j = document.termlist_begin ();
-       j.skip_to (prefix);
+           document.remove_term (term);
 
-       /* Was this the last file-direntry in the message? */
-       if (j == document.termlist_end () ||
-           strncmp ((*j).c_str (), prefix, strlen (prefix)))
-       {
-           db->delete_document (document.get_docid ());
-           status = NOTMUCH_STATUS_SUCCESS;
-       } else {
-           db->replace_document (document.get_docid (), document);
-           status = NOTMUCH_STATUS_DUPLICATE_MESSAGE_ID;
+           j = document.termlist_begin ();
+           j.skip_to (prefix);
+
+           /* Was this the last file-direntry in the message? */
+           if (j == document.termlist_end () ||
+               strncmp ((*j).c_str (), prefix, strlen (prefix)))
+           {
+               db->delete_document (document.get_docid ());
+               status = NOTMUCH_STATUS_SUCCESS;
+           } else {
+               db->replace_document (document.get_docid (), document);
+               status = NOTMUCH_STATUS_DUPLICATE_MESSAGE_ID;
+           }
        }
+    } catch (const Xapian::Error &error) {
+       fprintf (stderr, "Error: A Xapian exception occurred removing message: %s\n",
+                error.get_msg().c_str());
+       notmuch->exception_reported = TRUE;
+       status = NOTMUCH_STATUS_XAPIAN_EXCEPTION;
     }
 
     talloc_free (local);
@@ -1660,7 +1753,15 @@ notmuch_tags_t *
 notmuch_database_get_all_tags (notmuch_database_t *db)
 {
     Xapian::TermIterator i, end;
-    i = db->xapian_db->allterms_begin();
-    end = db->xapian_db->allterms_end();
-    return _notmuch_convert_tags(db, i, end);
+
+    try {
+       i = db->xapian_db->allterms_begin();
+       end = db->xapian_db->allterms_end();
+       return _notmuch_convert_tags(db, i, end);
+    } catch (const Xapian::Error &error) {
+       fprintf (stderr, "A Xapian exception occurred getting tags: %s.\n",
+                error.get_msg().c_str());
+       db->exception_reported = TRUE;
+       return NULL;
+    }
 }