]> git.notmuchmail.org Git - notmuch/blobdiff - notmuch-index-message.cc
Avoid complaints about empty address lists.
[notmuch] / notmuch-index-message.cc
index 913306582e74fc8cd29f778318d2c03e39b3a8cb..efc7eb14cda4f2f6c386365443909857110149a2 100644 (file)
  * Author: Carl Worth <cworth@cworth.org>
  */
 
+/* This indexer creates a Xapian mail index that is remarkably similar
+ * to that created by sup. The big difference, (and the thing that
+ * will keep a notmuch index from being used by sup directly), is that
+ * sup expects a serialized ruby data structure in the document's data
+ * field, but notmuch just puts the mail's filename there (trusting
+ * that the email client can get the data in needs from the filename).
+ *
+ * Note: One bug here is that sup actually merges together fields such
+ * as To, CC, Bcc etc. when finding multiple emails with the same
+ * message ID. To support something similar, notmuch should list
+ * multiple files in the data field.
+ *
+ * Other differences between sup and notmuch-index identified so far:
+ *
+ *   o sup supports encrypted mime parts by prompting for a passphrase
+ *     to decrypt the message. So far, notmuch doesn't support this,
+ *     both because I'm lazy to code it, and I also think doing so
+ *     would present a security leak.
+ *
+ *   o sup and notmuch have different heuristics for identifying (and
+ *     thus ignoring) signatures. For example, sup considers a line
+ *     consisting of two hypens as a signature separator, while
+ *     notmuch expects those two hyphens to be followed by a space
+ *     character.
+ *
+ *   o sup as been seen to split some numbers before indexing
+ *     them. For example, the number 1754 in an email message was
+ *     indexed by sup as separate terms 17 and 54. I couldn't find any
+ *     explanation for this behavior and did not try to replicate it
+ *     in notmuch.
+ */
+
 #include <stdio.h>
 #include <stdlib.h>
 #include <string.h>
@@ -172,6 +204,9 @@ gen_terms_address_names (Xapian::TermGenerator term_gen,
     int i;
     InternetAddress *address;
 
+    if (addresses == NULL)
+       return;
+
     for (i = 0; i < internet_address_list_length (addresses); i++) {
        address = internet_address_list_get_address (addresses, i);
        gen_terms_address_name (term_gen, address, address_type);
@@ -202,6 +237,9 @@ add_terms_address_addrs (Xapian::Document doc,
     int i;
     InternetAddress *address;
 
+    if (addresses == NULL)
+       return;
+
     for (i = 0; i < internet_address_list_length (addresses); i++) {
        address = internet_address_list_get_address (addresses, i);
        add_term_address_addr (doc, address, address_type);
@@ -269,26 +307,44 @@ static void
 insert_thread_id (GHashTable *thread_ids, Xapian::Document doc)
 {
     string value_string;
-    const char *value;
+    const char *value, *id, *comma;
 
     value_string = doc.get_value (NOTMUCH_VALUE_THREAD);
     value = value_string.c_str();
-    if (strlen (value))
-       g_hash_table_insert (thread_ids, strdup (value), NULL);
+    if (strlen (value)) {
+       id = value;
+       while (*id) {
+           comma = strchr (id, ',');
+           if (comma == NULL)
+               comma = id + strlen (id);
+           g_hash_table_insert (thread_ids,
+                                strndup (id, comma - id), NULL);
+           id = comma;
+           if (*id)
+               id++;
+       }
+    }
 }
 
-static char *
-find_thread_id (Xapian::Database db,
-               GPtrArray *parents,
-               const char *message_id)
+/* Return one or more thread_ids, (as a GPtrArray of strings), for the
+ * given message based on looking into the database for any messages
+ * referenced in parents, and also for any messages in the database
+ * referencing message_id.
+ *
+ * Caller should free all strings in the array and the array itself,
+ * (g_ptr_array_free) when done. */
+static GPtrArray *
+find_thread_ids (Xapian::Database db,
+                GPtrArray *parents,
+                const char *message_id)
 {
     Xapian::PostingIterator child, children_end;
     Xapian::Document doc;
     GHashTable *thread_ids;
     GList *keys, *l;
-    GString *result = NULL;
     unsigned int i;
     const char *parent_message_id;
+    GPtrArray *result;
 
     thread_ids = g_hash_table_new (g_str_hash, g_str_equal);
 
@@ -304,21 +360,15 @@ find_thread_id (Xapian::Database db,
        insert_thread_id (thread_ids, doc);
     }
 
+    result = g_ptr_array_new ();
+
     keys = g_hash_table_get_keys (thread_ids);
     for (l = keys; l; l = l->next) {
        char *id = (char *) l->data;
-       if (result == NULL) {
-           result = g_string_new (id);
-       } else {
-           g_string_append_printf (result, ",%s", id);
-       }
-       free (id);
+       g_ptr_array_add (result, id);
     }
 
-    if (result)
-       return g_string_free (result, FALSE);
-    else
-       return NULL;
+    return result;
 }
 
 /* Add a term for each message-id in the References header of the
@@ -367,8 +417,8 @@ gen_terms_body_str (Xapian::TermGenerator term_gen,
        }
        line_end = next_line - 1;
 
-       /* Trim whitespace. */
-       while (*next_line && isspace (*next_line))
+       /* Get to the next non-blank line. */
+       while (*next_line == '\n')
            next_line++;
 
        /* Skip lines that are quotes. */
@@ -376,9 +426,6 @@ gen_terms_body_str (Xapian::TermGenerator term_gen,
            continue;
 
        /* Also skip lines introducing a quote on the next line. */
-       while (line_end > line && isspace (*line_end))
-           line_end--;
-
        if (*line_end == ':' && *next_line == '>')
            continue;
 
@@ -397,22 +444,60 @@ gen_terms_body_str (Xapian::TermGenerator term_gen,
 
 /* Callback to generate terms for each mime part of a message. */
 static void
-gen_terms_part (GMimeObject *parent,
-               GMimeObject *part,
-               gpointer user_data)
+gen_terms_part (Xapian::TermGenerator term_gen,
+               GMimeObject *part)
 {
-    Xapian::TermGenerator *term_gen = (Xapian::TermGenerator *) user_data;
     GMimeStream *stream;
     GMimeDataWrapper *wrapper;
     GByteArray *byte_array;
+    GMimeContentDisposition *disposition;
     char *body;
 
+    if (GMIME_IS_MULTIPART (part)) {
+       GMimeMultipart *multipart = GMIME_MULTIPART (part);
+       int i;
+
+       for (i = 0; i < g_mime_multipart_get_count (multipart); i++) {
+           if (GMIME_IS_MULTIPART_SIGNED (multipart)) {
+               /* Don't index the signature. */
+               if (i == 1)
+                   continue;
+               if (i > 1)
+                   fprintf (stderr, "Warning: Unexpected extra parts of mutlipart/signed. Indexing anyway.\n");
+           }
+           gen_terms_part (term_gen,
+                           g_mime_multipart_get_part (multipart, i));
+       }
+       return;
+    }
+
     if (! GMIME_IS_PART (part)) {
        fprintf (stderr, "Warning: Not indexing unknown mime part: %s.\n",
                 g_type_name (G_OBJECT_TYPE (part)));
        return;
     }
 
+    disposition = g_mime_object_get_content_disposition (part);
+    if (disposition &&
+       strcmp (disposition->disposition, GMIME_DISPOSITION_ATTACHMENT) == 0)
+    {
+       const char *filename = g_mime_part_get_filename (GMIME_PART (part));
+       const char *extension;
+
+       add_term (term_gen.get_document (), "label", "attachment");
+       gen_terms (term_gen, "attachment", filename);
+
+       if (filename) {
+           extension = strchr (filename, '.');
+           if (extension) {
+               add_term (term_gen.get_document (), "attachment_extension",
+                         extension + 1);
+           }
+       }
+
+       return;
+    }
+
     byte_array = g_byte_array_new ();
 
     stream = g_mime_stream_mem_new_with_byte_array (byte_array);
@@ -422,9 +507,10 @@ gen_terms_part (GMimeObject *parent,
 
     g_object_unref (stream);
 
+    g_byte_array_append (byte_array, (guint8 *) "\0", 1);
     body = (char *) g_byte_array_free (byte_array, FALSE);
 
-    gen_terms_body_str (*term_gen, body);
+    gen_terms_body_str (term_gen, body);
 
     free (body);
 }
@@ -440,12 +526,12 @@ index_file (Xapian::WritableDatabase db,
     GMimeParser *parser;
     GMimeMessage *message;
     InternetAddressList *addresses;
-    GPtrArray *parents;
+    GPtrArray *parents, *thread_ids;
 
     FILE *file;
 
     const char *subject, *refs, *in_reply_to, *from;
-    const char *message_id, *thread_id;
+    const char *message_id;
 
     time_t time;
     struct tm gm_time_tm;
@@ -485,7 +571,7 @@ index_file (Xapian::WritableDatabase db,
     gen_terms (term_gen, "subject", subject);
     gen_terms (term_gen, "body", subject);
 
-    g_mime_message_foreach (message, gen_terms_part, &term_gen);
+    gen_terms_part (term_gen, g_mime_message_get_mime_part (message));
 
     parents = g_ptr_array_new ();
 
@@ -501,7 +587,7 @@ index_file (Xapian::WritableDatabase db,
 
     message_id = g_mime_message_get_message_id (message);
 
-    thread_id = find_thread_id (db, parents, message_id);
+    thread_ids = find_thread_ids (db, parents, message_id);
 
     for (i = 0; i < parents->len; i++)
        g_free (g_ptr_array_index (parents, i));
@@ -536,10 +622,28 @@ index_file (Xapian::WritableDatabase db,
     add_term (doc, "msgid", message_id);
     doc.add_value (NOTMUCH_VALUE_MESSAGE_ID, message_id);
 
-    if (thread_id) {
-       add_term (doc, "thread", thread_id);
-       doc.add_value (NOTMUCH_VALUE_THREAD, thread_id);
-       free ((void *) thread_id);
+    if (thread_ids->len) {
+       unsigned int i;
+       GString *thread_id;
+       char *id;
+
+       for (i = 0; i < thread_ids->len; i++) {
+           id = (char *) thread_ids->pdata[i];
+
+           add_term (doc, "thread", id);
+
+           if (i == 0)
+               thread_id = g_string_new (id);
+           else
+               g_string_append_printf (thread_id, ",%s", id);
+
+           free (id);
+       }
+       g_ptr_array_free (thread_ids, TRUE);
+
+       doc.add_value (NOTMUCH_VALUE_THREAD, thread_id->str);
+
+       g_string_free (thread_id, TRUE);
     } else {
        /* If not referenced thread, use the message ID */
        add_term (doc, "thread", message_id);