]> git.notmuchmail.org Git - notmuch/blobdiff - message.cc
notmuch restore: Print names of tags that cannot be applied
[notmuch] / message.cc
index dd73d13c97fe06332850798f24de7d2012bf80cb..ee0e8e1f80502f81aa74c7cfc3994866e852ef41 100644 (file)
@@ -27,6 +27,7 @@ struct _notmuch_message {
     notmuch_database_t *notmuch;
     Xapian::docid doc_id;
     char *message_id;
+    char *filename;
     Xapian::Document doc;
 };
 
@@ -40,6 +41,13 @@ struct _notmuch_thread_ids {
     char *next;
 };
 
+/* "128 bits of thread-id ought to be enough for anybody" */
+#define NOTMUCH_THREAD_ID_BITS  128
+#define NOTMUCH_THREAD_ID_DIGITS (NOTMUCH_THREAD_ID_BITS / 4)
+typedef struct _thread_id {
+    char str[NOTMUCH_THREAD_ID_DIGITS + 1];
+} thread_id_t;
+
 #define ARRAY_SIZE(arr) (sizeof (arr) / sizeof (arr[0]))
 
 /* These prefix values are specifically chosen to be compatible
@@ -107,6 +115,22 @@ _notmuch_message_destructor (notmuch_message_t *message)
     return 0;
 }
 
+/* Create a new notmuch_message_t object for an existing document in
+ * the database.
+ *
+ * Here, 'talloc owner' is an optional talloc context to which the new
+ * message will belong. This allows for the caller to not bother
+ * calling notmuch_message_destroy on the message, and no that all
+ * memory will be reclaimed with 'talloc_owner' is free. The caller
+ * still can call notmuch_message_destroy when finished with the
+ * message if desired.
+ *
+ * The 'talloc_owner' argument can also be NULL, in which case the
+ * caller *is* responsible for calling notmuch_message_destroy.
+ *
+ * If no document exists in the database with document ID of 'doc_id'
+ * then this function returns NULL.
+ */
 notmuch_message_t *
 _notmuch_message_create (const void *talloc_owner,
                         notmuch_database_t *notmuch,
@@ -121,15 +145,65 @@ _notmuch_message_create (const void *talloc_owner,
     message->notmuch = notmuch;
     message->doc_id = doc_id;
     message->message_id = NULL; /* lazily created */
+    message->filename = NULL; /* lazily created */
     new (&message->doc) Xapian::Document;
 
     talloc_set_destructor (message, _notmuch_message_destructor);
 
-    message->doc = notmuch->xapian_db->get_document (doc_id);
+    try {
+       message->doc = notmuch->xapian_db->get_document (doc_id);
+    } catch (const Xapian::DocNotFoundError &error) {
+       talloc_free (message);
+       return NULL;
+    }
 
     return message;
 }
 
+/* Create a new notmuch_message_t object for a specific message ID,
+ * (which may or may not already exist in the databas).
+ *
+ * Here, 'talloc owner' is an optional talloc context to which the new
+ * message will belong. This allows for the caller to not bother
+ * calling notmuch_message_destroy on the message, and no that all
+ * memory will be reclaimed with 'talloc_owner' is free. The caller
+ * still can call notmuch_message_destroy when finished with the
+ * message if desired.
+ *
+ * The 'talloc_owner' argument can also be NULL, in which case the
+ * caller *is* responsible for calling notmuch_message_destroy.
+ *
+ * If there is already a document with message ID 'message_id' in the
+ * database, then the returned message can be used to query/modify the
+ * document. Otherwise, a new document will be inserted into the
+ * database before this function returns;
+ */
+notmuch_message_t *
+_notmuch_message_create_for_message_id (const void *talloc_owner,
+                                       notmuch_database_t *notmuch,
+                                       const char *message_id)
+{
+    notmuch_message_t *message;
+    Xapian::Document doc;
+    unsigned int doc_id;
+    char *term;
+
+    message = notmuch_database_find_message (notmuch, message_id);
+    if (message)
+       return talloc_steal (talloc_owner, message);
+
+    term = talloc_asprintf (NULL, "%s%s",
+                           _find_prefix ("msgid"), message_id);
+    doc.add_term (term);
+    talloc_free (term);
+
+    doc.add_value (NOTMUCH_VALUE_MESSAGE_ID, message_id);
+
+    doc_id = notmuch->xapian_db->add_document (doc);
+
+    return _notmuch_message_create (talloc_owner, notmuch, doc_id);
+}
+
 const char *
 notmuch_message_get_message_id (notmuch_message_t *message)
 {
@@ -141,15 +215,49 @@ notmuch_message_get_message_id (notmuch_message_t *message)
     i = message->doc.termlist_begin ();
     i.skip_to (_find_prefix ("msgid"));
 
-    /* XXX: This should really be an internal error, but we'll need to
-     * fix the add_message side of things first. */
-    if (i == message->doc.termlist_end ())
-       return NULL;
+    if (i == message->doc.termlist_end ()) {
+       fprintf (stderr, "Internal error: Message with document ID of %d has no message ID.\n",
+                message->doc_id);
+       exit (1);
+    }
 
     message->message_id = talloc_strdup (message, (*i).c_str () + 1);
     return message->message_id;
 }
 
+/* Set the filename for 'message' to 'filename'.
+ *
+ * XXX: We should still figure out what we want to do for multiple
+ * files with identical message IDs. We will probably want to store a
+ * list of filenames here, (so that this will be "add_filename"
+ * instead of "set_filename"). Which would make this very similar to
+ * add_thread_ids.
+ *
+ * This change will not be reflected in the database until the next
+ * call to _notmuch_message_set_sync. */
+void
+_notmuch_message_set_filename (notmuch_message_t *message,
+                              const char *filename)
+{
+    if (message->filename)
+       talloc_free (message->filename);
+    message->doc.set_data (filename);
+}
+
+const char *
+notmuch_message_get_filename (notmuch_message_t *message)
+{
+    std::string filename_str;
+
+    if (message->filename)
+       return message->filename;
+
+    filename_str = message->doc.get_data ();
+    message->filename = talloc_strdup (message, filename_str.c_str ());
+
+    return message->filename;
+}
+
 /* We end up having to call the destructors explicitly because we had
  * to use "placement new" in order to initialize C++ objects within a
  * block that we allocated with talloc. So C++ is making talloc
@@ -205,8 +313,86 @@ notmuch_message_get_thread_ids (notmuch_message_t *message)
     return thread_ids;
 }
 
-/* Synchronize changes made to message->doc into the database. */
+void
+_notmuch_message_set_date (notmuch_message_t *message,
+                          const char *date)
+{
+    time_t time_value;
+
+    time_value = notmuch_parse_date (date, NULL);
+
+    message->doc.add_value (NOTMUCH_VALUE_DATE,
+                           Xapian::sortable_serialise (time_value));
+}
+
+void
+_notmuch_message_add_thread_id (notmuch_message_t *message,
+                               const char *thread_id)
+{
+    std::string id_str;
+
+    _notmuch_message_add_term (message, "thread", thread_id);
+
+    id_str = message->doc.get_value (NOTMUCH_VALUE_THREAD);
+
+    if (id_str.empty ()) {
+       message->doc.add_value (NOTMUCH_VALUE_THREAD, thread_id);
+    } else {
+       size_t pos;
+
+       /* Think about using a hash here if there's any performance
+        * problem. */
+       pos = id_str.find (thread_id);
+       if (pos == std::string::npos) {
+           id_str.append (",");
+           id_str.append (thread_id);
+           message->doc.add_value (NOTMUCH_VALUE_THREAD, id_str);
+       }
+    }
+}
+
 static void
+thread_id_generate (thread_id_t *thread_id)
+{
+    static int seeded = 0;
+    FILE *dev_random;
+    uint32_t value;
+    char *s;
+    int i;
+
+    if (! seeded) {
+       dev_random = fopen ("/dev/random", "r");
+       if (dev_random == NULL) {
+           srand (time (NULL));
+       } else {
+           fread ((void *) &value, sizeof (value), 1, dev_random);
+           srand (value);
+           fclose (dev_random);
+       }
+       seeded = 1;
+    }
+
+    s = thread_id->str;
+    for (i = 0; i < NOTMUCH_THREAD_ID_DIGITS; i += 8) {
+       value = rand ();
+       sprintf (s, "%08x", value);
+       s += 8;
+    }
+}
+
+void
+_notmuch_message_ensure_thread_id (notmuch_message_t *message)
+{
+    /* If not part of any existing thread, generate a new thread_id. */
+    thread_id_t thread_id;
+
+    thread_id_generate (&thread_id);
+    _notmuch_message_add_term (message, "thread", thread_id.str);
+    message->doc.add_value (NOTMUCH_VALUE_THREAD, thread_id.str);
+}
+
+/* Synchronize changes made to message->doc out into the database. */
+void
 _notmuch_message_sync (notmuch_message_t *message)
 {
     Xapian::WritableDatabase *db = message->notmuch->xapian_db;
@@ -214,6 +400,13 @@ _notmuch_message_sync (notmuch_message_t *message)
     db->replace_document (message->doc_id, message->doc);
 }
 
+/* Add a name:value term to 'message', (the actual term will be
+ * encoded by prefixing the value with a short prefix). See
+ * NORMAL_PREFIX and BOOLEAN_PREFIX arrays for the mapping of term
+ * names to prefix values.
+ *
+ * This change will not be reflected in the database until the next
+ * call to _notmuch_message_set_sync. */
 notmuch_private_status_t
 _notmuch_message_add_term (notmuch_message_t *message,
                           const char *prefix_name,
@@ -232,13 +425,19 @@ _notmuch_message_add_term (notmuch_message_t *message,
        return NOTMUCH_PRIVATE_STATUS_TERM_TOO_LONG;
 
     message->doc.add_term (term);
-    _notmuch_message_sync (message);
 
     talloc_free (term);
 
     return NOTMUCH_PRIVATE_STATUS_SUCCESS;
 }
 
+/* Remove a name:value term from 'message', (the actual term will be
+ * encoded by prefixing the value with a short prefix). See
+ * NORMAL_PREFIX and BOOLEAN_PREFIX arrays for the mapping of term
+ * names to prefix values.
+ *
+ * This change will not be reflected in the database until the next
+ * call to _notmuch_message_set_sync. */
 notmuch_private_status_t
 _notmuch_message_remove_term (notmuch_message_t *message,
                              const char *prefix_name,
@@ -256,7 +455,6 @@ _notmuch_message_remove_term (notmuch_message_t *message,
        return NOTMUCH_PRIVATE_STATUS_TERM_TOO_LONG;
 
     message->doc.remove_term (term);
-    _notmuch_message_sync (message);
 
     talloc_free (term);
 
@@ -281,6 +479,8 @@ notmuch_message_add_tag (notmuch_message_t *message, const char *tag)
        exit (1);
     }
 
+    _notmuch_message_sync (message);
+
     return NOTMUCH_STATUS_SUCCESS;
 }
 
@@ -302,6 +502,8 @@ notmuch_message_remove_tag (notmuch_message_t *message, const char *tag)
        exit (1);
     }
 
+    _notmuch_message_sync (message);
+
     return NOTMUCH_STATUS_SUCCESS;
 }
 
@@ -320,7 +522,7 @@ notmuch_tags_has_more (notmuch_tags_t *tags)
        return FALSE;
 
     s = *tags->iterator;
-    if (s.size () && s[0] == 'L')
+    if (! s.empty () && s[0] == 'L')
        return TRUE;
     else
        return FALSE;