]> git.notmuchmail.org Git - notmuch/blobdiff - lib/database.cc
lib: Rework interface for maildir_flags synchronization
[notmuch] / lib / database.cc
index 6842fafadad86967b4363abd5869a2aeaef345c2..380bbe3daa66e9a878c084b6f1e7fc2b1ace1470 100644 (file)
@@ -24,7 +24,6 @@
 
 #include <sys/time.h>
 #include <signal.h>
-#include <xapian.h>
 
 #include <glib.h> /* g_free, GPtrArray, GHashTable */
 
@@ -57,8 +56,12 @@ typedef struct {
  *
  *     type:   mail
  *
- *     id:     Unique ID of mail, (from Message-ID header or generated
- *             as "notmuch-sha1-<sha1_sum_of_entire_file>.
+ *     id:     Unique ID of mail. This is from the Message-ID header
+ *             if present and not too long (see NOTMUCH_MESSAGE_ID_MAX).
+ *             If it's present and too long, then we use
+ *             "notmuch-sha1-<sha1_sum_of_message_id>".
+ *              If this header is not present, we use
+ *             "notmuch-sha1-<sha1_sum_of_entire_file>".
  *
  *     thread: The ID of the thread to which the mail belongs
  *
@@ -145,9 +148,11 @@ typedef struct {
  *
  *     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.
+ *                     family of metadata name. Any particular name is
+ *                     formed by concatenating "thread_id_" with a message
+ *                     ID (or the SHA1 sum of a message ID if it is very
+ *                     long---see description of 'id' in the mail
+ *                     document). The value stored is a thread ID.
  *
  *                     These thread ID metadata values are stored
  *                     whenever a message references a parent message
@@ -179,7 +184,7 @@ typedef struct {
  * nearly universal to all mail messages).
  */
 
-prefix_t BOOLEAN_PREFIX_INTERNAL[] = {
+static prefix_t BOOLEAN_PREFIX_INTERNAL[] = {
     { "type",                  "T" },
     { "reference",             "XREFERENCE" },
     { "replyto",               "XREPLYTO" },
@@ -188,14 +193,14 @@ prefix_t BOOLEAN_PREFIX_INTERNAL[] = {
     { "directory-direntry",    "XDDIRENTRY" },
 };
 
-prefix_t BOOLEAN_PREFIX_EXTERNAL[] = {
+static prefix_t BOOLEAN_PREFIX_EXTERNAL[] = {
     { "thread",                        "G" },
     { "tag",                   "K" },
     { "is",                    "K" },
     { "id",                    "Q" }
 };
 
-prefix_t PROBABILISTIC_PREFIX[]= {
+static prefix_t PROBABILISTIC_PREFIX[]= {
     { "from",                  "XFROM" },
     { "to",                    "XTO" },
     { "attachment",            "XATTACHMENT" },
@@ -334,6 +339,23 @@ find_document_for_doc_id (notmuch_database_t *notmuch, unsigned doc_id)
     return notmuch->xapian_db->get_document (doc_id);
 }
 
+/* Generate a compressed version of 'message_id' of the form:
+ *
+ *     notmuch-sha1-<sha1_sum_of_message_id>
+ */
+static char *
+_message_id_compressed (void *ctx, const char *message_id)
+{
+    char *sha1, *compressed;
+
+    sha1 = notmuch_sha1_of_string (message_id);
+
+    compressed = talloc_asprintf (ctx, "notmuch-sha1-%s", sha1);
+    free (sha1);
+
+    return compressed;
+}
+
 notmuch_message_t *
 notmuch_database_find_message (notmuch_database_t *notmuch,
                               const char *message_id)
@@ -341,13 +363,23 @@ 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);
+    if (strlen (message_id) > NOTMUCH_MESSAGE_ID_MAX)
+       message_id = _message_id_compressed (notmuch, message_id);
 
-    if (status == NOTMUCH_PRIVATE_STATUS_NO_DOCUMENT_FOUND)
-       return NULL;
+    try {
+       status = _notmuch_database_find_unique_doc_id (notmuch, "id",
+                                                      message_id, &doc_id);
+
+       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
@@ -615,6 +647,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;
@@ -1152,7 +1185,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 *
@@ -1177,7 +1242,11 @@ _notmuch_database_generate_thread_id (notmuch_database_t *notmuch)
 static char *
 _get_metadata_thread_id_key (void *ctx, const char *message_id)
 {
-    return talloc_asprintf (ctx, "thread_id_%s", message_id);
+    if (strlen (message_id) > NOTMUCH_MESSAGE_ID_MAX)
+       message_id = _message_id_compressed (ctx, message_id);
+
+    return talloc_asprintf (ctx, NOTMUCH_METADATA_THREAD_ID_PREFIX "%s",
+                           message_id);
 }
 
 /* Find the thread ID to which the message with 'message_id' belongs.
@@ -1230,7 +1299,7 @@ _resolve_message_id_to_thread_id (notmuch_database_t *notmuch,
 
     talloc_free (metadata_key);
 
-    return thread_id;
+    return talloc_strdup (ctx, thread_id);
 }
 
 static notmuch_status_t
@@ -1530,10 +1599,12 @@ notmuch_database_add_message (notmuch_database_t *notmuch,
            if (message_id == NULL)
                message_id = talloc_strdup (message_file, header);
 
-           /* Reject a Message ID that's too long. */
-           if (message_id && strlen (message_id) + 1 > NOTMUCH_TERM_MAX) {
+           /* 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 = NULL;
+               message_id = compressed;
            }
        }
 
@@ -1571,6 +1642,13 @@ notmuch_database_add_message (notmuch_database_t *notmuch,
 
        _notmuch_message_add_filename (message, filename);
 
+       /* This is a new message or it has a new filename and as such,
+        * its tags in database either do not exists or might be out
+        * of date. We assign the tags later in notmuch new, but until
+        * then we should not synchronize the tags back to the maildir
+        * flags (if notmuch is configured to do so). */
+       notmuch_message_set_flag(message, NOTMUCH_MESSAGE_FLAG_TAGS_INVALID, TRUE);
+
        /* Is this a newly created message object? */
        if (private_status == NOTMUCH_PRIVATE_STATUS_NO_DOCUMENT_FOUND) {
            _notmuch_message_add_term (message, "type", "mail");
@@ -1591,7 +1669,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;
@@ -1599,7 +1677,8 @@ notmuch_database_add_message (notmuch_database_t *notmuch,
 
   DONE:
     if (message) {
-       if (ret == NOTMUCH_STATUS_SUCCESS && message_ret)
+       if ((ret == NOTMUCH_STATUS_SUCCESS ||
+            ret == NOTMUCH_STATUS_DUPLICATE_MESSAGE_ID) && message_ret)
            *message_ret = message;
        else
            notmuch_message_destroy (message);
@@ -1616,7 +1695,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;
@@ -1627,37 +1706,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);
@@ -1703,7 +1792,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;
+    }
 }