X-Git-Url: https://git.notmuchmail.org/git?p=notmuch;a=blobdiff_plain;f=message.cc;h=2a9001493721dc5493d643659c36afde4f74028b;hp=65e5ad78a269b6da86ef5a3b7c289871d8096712;hb=c771eaf362edb021888d114989d38d8fb2b4cfb3;hpb=ce5d78296251b529838df0dbd4dc3b9a90030924

diff --git a/message.cc b/message.cc
index 65e5ad78..2a900149 100644
--- a/message.cc
+++ b/message.cc
@@ -26,21 +26,14 @@
 struct _notmuch_message {
     notmuch_database_t *notmuch;
     Xapian::docid doc_id;
+    int frozen;
     char *message_id;
+    char *thread_id;
     char *filename;
+    notmuch_message_file_t *message_file;
     Xapian::Document doc;
 };
 
-struct _notmuch_tags {
-    Xapian::TermIterator iterator;
-    Xapian::TermIterator iterator_end;
-};
-
-struct _notmuch_thread_ids {
-    char *current;
-    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)
@@ -48,59 +41,6 @@ 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
- * with sup, (http://sup.rubyforge.org), written by
- * William Morgan <wmorgan-sup@masanjin.net>, and released
- * under the GNU GPL v2.
- */
-
-typedef struct {
-    const char *name;
-    const char *prefix;
-} prefix_t;
-
-prefix_t NORMAL_PREFIX[] = {
-    { "subject", "S" },
-    { "body", "B" },
-    { "from_name", "FN" },
-    { "to_name", "TN" },
-    { "name", "N" },
-    { "attachment", "A" }
-};
-
-prefix_t BOOLEAN_PREFIX[] = {
-    { "type", "K" },
-    { "from_email", "FE" },
-    { "to_email", "TE" },
-    { "email", "E" },
-    { "date", "D" },
-    { "label", "L" },
-    { "tag", "L" },
-    { "source_id", "I" },
-    { "attachment_extension", "O" },
-    { "msgid", "Q" },
-    { "thread", "H" },
-    { "ref", "R" }
-};
-
-const char *
-_find_prefix (const char *name)
-{
-    unsigned int i;
-
-    for (i = 0; i < ARRAY_SIZE (NORMAL_PREFIX); i++)
-	if (strcmp (name, NORMAL_PREFIX[i].name) == 0)
-	    return NORMAL_PREFIX[i].prefix;
-
-    for (i = 0; i < ARRAY_SIZE (BOOLEAN_PREFIX); i++)
-	if (strcmp (name, BOOLEAN_PREFIX[i].name) == 0)
-	    return BOOLEAN_PREFIX[i].prefix;
-
-    return "";
-}
-
 /* We end up having to call the destructor 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
@@ -129,23 +69,51 @@ _notmuch_message_destructor (notmuch_message_t *message)
  * 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.
+ * then this function returns NULL and optionally sets *status to
+ * NOTMUCH_PRIVATE_STATUS_NO_DOCUMENT_FOUND.
+ *
+ * This function can also fail to due lack of available memory,
+ * returning NULL and optionally setting *status to
+ * NOTMUCH_PRIVATE_STATUS_OUT_OF_MEMORY.
+ *
+ * The caller can pass NULL for status if uninterested in
+ * distinguishing these two cases.
  */
 notmuch_message_t *
 _notmuch_message_create (const void *talloc_owner,
 			 notmuch_database_t *notmuch,
-			 unsigned int doc_id)
+			 unsigned int doc_id,
+			 notmuch_private_status_t *status)
 {
     notmuch_message_t *message;
 
+    if (status)
+	*status = NOTMUCH_PRIVATE_STATUS_SUCCESS;
+
     message = talloc (talloc_owner, notmuch_message_t);
-    if (unlikely (message == NULL))
+    if (unlikely (message == NULL)) {
+	if (status)
+	    *status = NOTMUCH_PRIVATE_STATUS_OUT_OF_MEMORY;
 	return NULL;
+    }
 
     message->notmuch = notmuch;
     message->doc_id = doc_id;
-    message->message_id = NULL; /* lazily created */
-    message->filename = NULL; /* lazily created */
+
+    message->frozen = 0;
+
+    /* Each of these will be lazily created as needed. */
+    message->message_id = NULL;
+    message->thread_id = NULL;
+    message->filename = NULL;
+    message->message_file = NULL;
+
+    /* This is C++'s creepy "placement new", which is really just an
+     * ugly way to call a constructor for a pre-allocated object. So
+     * it's really not an error to not be checking for OUT_OF_MEMORY
+     * here, since this "new" isn't actually allocating memory. This
+     * is language-design comedy of the wrong kind. */
+
     new (&message->doc) Xapian::Document;
 
     talloc_set_destructor (message, _notmuch_message_destructor);
@@ -154,6 +122,8 @@ _notmuch_message_create (const void *talloc_owner,
 	message->doc = notmuch->xapian_db->get_document (doc_id);
     } catch (const Xapian::DocNotFoundError &error) {
 	talloc_free (message);
+	if (status)
+	    *status = NOTMUCH_PRIVATE_STATUS_NO_DOCUMENT_FOUND;
 	return NULL;
     }
 
@@ -176,32 +146,58 @@ _notmuch_message_create (const void *talloc_owner,
  * 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;
+ * database before this function returns, (and *status will be set
+ * to NOTMUCH_PRIVATE_STATUS_NO_DOCUMENT_FOUND).
+ *
+ * If an error occurs, this function will return NULL and *status
+ * will be set as appropriate. (The status pointer argument must
+ * not be NULL.)
  */
 notmuch_message_t *
 _notmuch_message_create_for_message_id (const void *talloc_owner,
 					notmuch_database_t *notmuch,
-					const char *message_id)
+					const char *message_id,
+					notmuch_private_status_t *status_ret)
 {
     notmuch_message_t *message;
     Xapian::Document doc;
     unsigned int doc_id;
     char *term;
 
+    *status_ret = NOTMUCH_PRIVATE_STATUS_SUCCESS;
+
     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);
+			    _find_prefix ("id"), message_id);
+    if (term == NULL) {
+	*status_ret = NOTMUCH_PRIVATE_STATUS_OUT_OF_MEMORY;
+	return NULL;
+    }
 
-    doc.add_value (NOTMUCH_VALUE_MESSAGE_ID, message_id);
+    try {
+	doc.add_term (term);
+	talloc_free (term);
 
-    doc_id = notmuch->xapian_db->add_document (doc);
+	doc.add_value (NOTMUCH_VALUE_MESSAGE_ID, message_id);
 
-    return _notmuch_message_create (talloc_owner, notmuch, doc_id);
+	doc_id = notmuch->xapian_db->add_document (doc);
+    } catch (const Xapian::Error &error) {
+	*status_ret = NOTMUCH_PRIVATE_STATUS_XAPIAN_EXCEPTION;
+	return NULL;
+    }
+
+    message = _notmuch_message_create (talloc_owner, notmuch,
+				       doc_id, status_ret);
+
+    /* We want to inform the caller that we had to create a new
+     * document. */
+    if (*status_ret == NOTMUCH_PRIVATE_STATUS_SUCCESS)
+	*status_ret = NOTMUCH_PRIVATE_STATUS_NO_DOCUMENT_FOUND;
+
+    return message;
 }
 
 const char *
@@ -213,25 +209,113 @@ notmuch_message_get_message_id (notmuch_message_t *message)
 	return message->message_id;
 
     i = message->doc.termlist_begin ();
-    i.skip_to (_find_prefix ("msgid"));
+    i.skip_to (_find_prefix ("id"));
 
-    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);
-    }
+    if (i == message->doc.termlist_end ())
+	INTERNAL_ERROR ("Message with document ID of %d has no message ID.\n",
+			message->doc_id);
 
     message->message_id = talloc_strdup (message, (*i).c_str () + 1);
+
+#if DEBUG_DATABASE_SANITY
+    i++;
+
+    if (i != message->doc.termlist_end () &&
+	strncmp ((*i).c_str (), _find_prefix ("id"),
+		 strlen (_find_prefix ("id"))) == 0)
+    {
+	INTERNAL_ERROR ("Mail (doc_id: %d) has duplicate message IDs",
+			message->doc_id);
+    }
+#endif
+
     return message->message_id;
 }
 
+static void
+_notmuch_message_ensure_message_file (notmuch_message_t *message)
+{
+    const char *filename;
+
+    if (message->message_file)
+	return;
+
+    filename = notmuch_message_get_filename (message);
+    if (unlikely (filename == NULL))
+	return;
+
+    message->message_file = _notmuch_message_file_open_ctx (message, filename);
+}
+
+const char *
+notmuch_message_get_header (notmuch_message_t *message, const char *header)
+{
+    _notmuch_message_ensure_message_file (message);
+    if (message->message_file == NULL)
+	return NULL;
+
+    return notmuch_message_file_get_header (message->message_file, header);
+}
+
+const char *
+notmuch_message_get_all_headers (notmuch_message_t *message)
+{
+    _notmuch_message_ensure_message_file (message);
+    if (message->message_file == NULL)
+	return NULL;
+
+    return notmuch_message_file_get_all_headers (message->message_file);
+}
+
+size_t
+notmuch_message_get_header_size (notmuch_message_t *message)
+{
+    _notmuch_message_ensure_message_file (message);
+    if (message->message_file == NULL)
+	return 0;
+
+    return notmuch_message_file_get_header_size (message->message_file);
+
+}
+
+const char *
+notmuch_message_get_thread_id (notmuch_message_t *message)
+{
+    Xapian::TermIterator i;
+
+    if (message->thread_id)
+	return message->thread_id;
+
+    i = message->doc.termlist_begin ();
+    i.skip_to (_find_prefix ("thread"));
+
+    if (i == message->doc.termlist_end ())
+	INTERNAL_ERROR ("Message with document ID of %d has no thread ID.\n",
+			message->doc_id);
+
+    message->thread_id = talloc_strdup (message, (*i).c_str () + 1);
+
+#if DEBUG_DATABASE_SANITY
+    i++;
+
+    if (i != message->doc.termlist_end () &&
+	strncmp ((*i).c_str (), _find_prefix ("thread"),
+		 strlen (_find_prefix ("thread"))) == 0)
+    {
+	INTERNAL_ERROR ("Message %s has duplicate thread IDs: %s and %s\n",
+			notmuch_message_get_message_id (message),
+			message->thread_id,
+			(*i).c_str () + 1);
+    }
+#endif
+
+    return message->thread_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.
+ * XXX: We should still figure out if we think it's important to store
+ * multiple filenames for email messages with identical message IDs.
  *
  * This change will not be reflected in the database until the next
  * call to _notmuch_message_set_sync. */
@@ -239,78 +323,103 @@ void
 _notmuch_message_set_filename (notmuch_message_t *message,
 			       const char *filename)
 {
-    if (message->filename)
+    const char *s;
+    const char *db_path;
+    unsigned int db_path_len;
+
+    if (message->filename) {
 	talloc_free (message->filename);
-    message->doc.set_data (filename);
+	message->filename = NULL;
+    }
+
+    if (filename == NULL)
+	INTERNAL_ERROR ("Message filename cannot be NULL.");
+
+    s = filename;
+
+    db_path = notmuch_database_get_path (message->notmuch);
+    db_path_len = strlen (db_path);
+
+    if (*s == '/' && strncmp (s, db_path, db_path_len) == 0
+	&& strlen (s) > db_path_len)
+    {
+	s += db_path_len + 1;
+    }
+
+    message->doc.set_data (s);
 }
 
 const char *
 notmuch_message_get_filename (notmuch_message_t *message)
 {
     std::string filename_str;
+    const char *db_path;
 
     if (message->filename)
 	return message->filename;
 
     filename_str = message->doc.get_data ();
-    message->filename = talloc_strdup (message, filename_str.c_str ());
+    db_path = notmuch_database_get_path (message->notmuch);
+
+    if (filename_str[0] != '/')
+	message->filename = talloc_asprintf (message, "%s/%s", db_path,
+					     filename_str.c_str ());
+    else
+	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
- * slightly less simple to use, (we wouldn't need
- * talloc_set_destructor at all otherwise).
- */
-static int
-_notmuch_tags_destructor (notmuch_tags_t *tags)
+time_t
+notmuch_message_get_date (notmuch_message_t *message)
 {
-    tags->iterator.~TermIterator ();
-    tags->iterator_end.~TermIterator ();
+    std::string value;
 
-    return 0;
+    try {
+	value = message->doc.get_value (NOTMUCH_VALUE_TIMESTAMP);
+    } catch (Xapian::Error &error) {
+	INTERNAL_ERROR ("Failed to read timestamp value from document.");
+	return 0;
+    }
+
+    return Xapian::sortable_unserialise (value);
 }
 
 notmuch_tags_t *
 notmuch_message_get_tags (notmuch_message_t *message)
 {
+    const char *prefix = _find_prefix ("tag");
+    Xapian::TermIterator i, end;
     notmuch_tags_t *tags;
+    std::string tag;
+
+    /* Currently this iteration is written with the assumption that
+     * "tag" has a single-character prefix. */
+    assert (strlen (prefix) == 1);
 
-    tags = talloc (message, notmuch_tags_t);
+    tags = _notmuch_tags_create (message);
     if (unlikely (tags == NULL))
 	return NULL;
 
-    new (&tags->iterator) Xapian::TermIterator;
-    new (&tags->iterator_end) Xapian::TermIterator;
-
-    talloc_set_destructor (tags, _notmuch_tags_destructor);
+    i = message->doc.termlist_begin ();
+    end = message->doc.termlist_end ();
 
-    tags->iterator = message->doc.termlist_begin ();
-    tags->iterator.skip_to (_find_prefix ("tag"));
-    tags->iterator_end = message->doc.termlist_end ();
+    i.skip_to (prefix);
 
-    return tags;
-}
+    while (1) {
+	tag = *i;
 
-notmuch_thread_ids_t *
-notmuch_message_get_thread_ids (notmuch_message_t *message)
-{
-    notmuch_thread_ids_t *thread_ids;
-    std::string id_str;
+	if (tag.empty () || tag[0] != *prefix)
+	    break;
 
-    thread_ids = talloc (message, notmuch_thread_ids_t);
-    if (unlikely (thread_ids == NULL))
-	return NULL;
+	_notmuch_tags_add_tag (tags, tag.c_str () + 1);
 
-    id_str = message->doc.get_value (NOTMUCH_VALUE_THREAD);
-    thread_ids->next = talloc_strdup (message, id_str.c_str ());
+	i++;
+    }
 
-    /* Initialize thread_ids->current and terminate first ID. */
-    notmuch_thread_ids_advance (thread_ids);
+    _notmuch_tags_prepare_iterator (tags);
 
-    return thread_ids;
+    return tags;
 }
 
 void
@@ -321,36 +430,10 @@ _notmuch_message_set_date (notmuch_message_t *message,
 
     time_value = notmuch_parse_date (date, NULL);
 
-    message->doc.add_value (NOTMUCH_VALUE_DATE,
+    message->doc.add_value (NOTMUCH_VALUE_TIMESTAMP,
 			    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)
 {
@@ -388,7 +471,6 @@ _notmuch_message_ensure_thread_id (notmuch_message_t *message)
 
     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. */
@@ -431,6 +513,32 @@ _notmuch_message_add_term (notmuch_message_t *message,
     return NOTMUCH_PRIVATE_STATUS_SUCCESS;
 }
 
+/* Parse 'text' and add a term to 'message' for each parsed word. Each
+ * term will be added both prefixed (if prefix_name is not NULL) and
+ * also unprefixed). */
+notmuch_private_status_t
+_notmuch_message_gen_terms (notmuch_message_t *message,
+			    const char *prefix_name,
+			    const char *text)
+{
+    Xapian::TermGenerator *term_gen = message->notmuch->term_gen;
+
+    if (text == NULL)
+	return NOTMUCH_PRIVATE_STATUS_NULL_POINTER;
+
+    term_gen->set_document (message->doc);
+
+    if (prefix_name) {
+	const char *prefix = _find_prefix (prefix_name);
+
+	term_gen->index_text (text, 1, prefix);
+    }
+
+    term_gen->index_text (text);
+
+    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
@@ -454,7 +562,14 @@ _notmuch_message_remove_term (notmuch_message_t *message,
     if (strlen (term) > NOTMUCH_TERM_MAX)
 	return NOTMUCH_PRIVATE_STATUS_TERM_TOO_LONG;
 
-    message->doc.remove_term (term);
+    try {
+	message->doc.remove_term (term);
+    } catch (const Xapian::InvalidArgumentError) {
+	/* We'll let the philosopher's try to wrestle with the
+	 * question of whether failing to remove that which was not
+	 * there in the first place is failure. For us, we'll silently
+	 * consider it all good. */
+    }
 
     talloc_free (term);
 
@@ -474,12 +589,12 @@ notmuch_message_add_tag (notmuch_message_t *message, const char *tag)
 
     status = _notmuch_message_add_term (message, "tag", tag);
     if (status) {
-	fprintf (stderr, "Internal error: _notmuch_message_add_term return unexpected value: %d\n",
-		 status);
-	exit (1);
+	INTERNAL_ERROR ("_notmuch_message_add_term return unexpected value: %d\n",
+			status);
     }
 
-    _notmuch_message_sync (message);
+    if (! message->frozen)
+	_notmuch_message_sync (message);
 
     return NOTMUCH_STATUS_SUCCESS;
 }
@@ -497,78 +612,61 @@ notmuch_message_remove_tag (notmuch_message_t *message, const char *tag)
 
     status = _notmuch_message_remove_term (message, "tag", tag);
     if (status) {
-	fprintf (stderr, "Internal error: _notmuch_message_remove_term return unexpected value: %d\n",
-		 status);
-	exit (1);
+	INTERNAL_ERROR ("_notmuch_message_remove_term return unexpected value: %d\n",
+			status);
     }
 
-    _notmuch_message_sync (message);
+    if (! message->frozen)
+	_notmuch_message_sync (message);
 
     return NOTMUCH_STATUS_SUCCESS;
 }
 
 void
-notmuch_message_destroy (notmuch_message_t *message)
-{
-    talloc_free (message);
-}
-
-notmuch_bool_t
-notmuch_tags_has_more (notmuch_tags_t *tags)
-{
-    std::string s;
-
-    if (tags->iterator == tags->iterator_end)
-	return FALSE;
-
-    s = *tags->iterator;
-    if (s.size () && s[0] == 'L')
-	return TRUE;
-    else
-	return FALSE;
-}
-
-const char *
-notmuch_tags_get (notmuch_tags_t *tags)
+notmuch_message_remove_all_tags (notmuch_message_t *message)
 {
-    return talloc_strdup (tags, (*tags->iterator).c_str () + 1);
-}
+    notmuch_private_status_t status;
+    notmuch_tags_t *tags;
+    const char *tag;
+
+    for (tags = notmuch_message_get_tags (message);
+	 notmuch_tags_has_more (tags);
+	 notmuch_tags_advance (tags))
+    {
+	tag = notmuch_tags_get (tags);
+
+	status = _notmuch_message_remove_term (message, "tag", tag);
+	if (status) {
+	    INTERNAL_ERROR ("_notmuch_message_remove_term return unexpected value: %d\n",
+			    status);
+	}
+    }
 
-void
-notmuch_tags_advance (notmuch_tags_t *tags)
-{
-    tags->iterator++;
+    if (! message->frozen)
+	_notmuch_message_sync (message);
 }
 
 void
-notmuch_tags_destroy (notmuch_tags_t *tags)
+notmuch_message_freeze (notmuch_message_t *message)
 {
-    talloc_free (tags);
-}
-
-notmuch_bool_t
-notmuch_thread_ids_has_more (notmuch_thread_ids_t *thread_ids)
-{
-    if (thread_ids->current == NULL || *thread_ids->current == '\0')
-	return FALSE;
-    else
-	return TRUE;
+    message->frozen++;
 }
 
-const char *
-notmuch_thread_ids_get (notmuch_thread_ids_t *thread_ids)
-{
-    return thread_ids->current;
-}
-
-void
-notmuch_thread_ids_advance (notmuch_thread_ids_t *thread_ids)
+notmuch_status_t
+notmuch_message_thaw (notmuch_message_t *message)
 {
-    thread_ids->current = strsep (&thread_ids->next, ",");
+    if (message->frozen > 0) {
+	message->frozen--;
+	if (message->frozen == 0)
+	    _notmuch_message_sync (message);
+	return NOTMUCH_STATUS_SUCCESS;
+    } else {
+	return NOTMUCH_STATUS_UNBALANCED_FREEZE_THAW;
+    }
 }
 
 void
-notmuch_thread_ids_destroy (notmuch_thread_ids_t *thread_ids)
+notmuch_message_destroy (notmuch_message_t *message)
 {
-    talloc_free (thread_ids);
+    talloc_free (message);
 }