]> git.notmuchmail.org Git - notmuch/blobdiff - lib/thread.cc
lib: Add the exclude flag to notmuch_query_search_threads
[notmuch] / lib / thread.cc
index c29140397feb78e81cbb284e8ae52df75e3df22f..e976d643db3584f7ce057a7e20dc4adca2bcbdb7 100644 (file)
 #include "notmuch-private.h"
 #include "database-private.h"
 
-#include <xapian.h>
-
 #include <gmime/gmime.h>
 #include <glib.h> /* GHashTable */
 
-struct _notmuch_thread {
+struct visible _notmuch_thread {
     notmuch_database_t *notmuch;
     char *thread_id;
     char *subject;
     GHashTable *authors_hash;
     GPtrArray *authors_array;
     GHashTable *matched_authors_hash;
-    int has_non_matched_authors;
+    GPtrArray *matched_authors_array;
     char *authors;
     GHashTable *tags;
 
@@ -58,11 +56,16 @@ _notmuch_thread_destructor (notmuch_thread_t *thread)
        thread->authors_array = NULL;
     }
 
+    if (thread->matched_authors_array) {
+       g_ptr_array_free (thread->matched_authors_array, TRUE);
+       thread->matched_authors_array = NULL;
+    }
+
     return 0;
 }
 
-/* Add each author of the thread to the thread's authors_hash and the
- * thread's authors_array. */
+/* Add each author of the thread to the thread's authors_hash and to
+ * the thread's authors_array. */
 static void
 _thread_add_author (notmuch_thread_t *thread,
                    const char *author)
@@ -84,7 +87,7 @@ _thread_add_author (notmuch_thread_t *thread,
 }
 
 /* Add each matched author of the thread to the thread's
- * matched_authors_hash and to the thread's authors string. */
+ * matched_authors_hash and to the thread's matched_authors_array. */
 static void
 _thread_add_matched_author (notmuch_thread_t *thread,
                            const char *author)
@@ -102,42 +105,54 @@ _thread_add_matched_author (notmuch_thread_t *thread,
 
     g_hash_table_insert (thread->matched_authors_hash, author_copy, NULL);
 
-    if (thread->authors)
-       thread->authors = talloc_asprintf (thread, "%s, %s",
-                                          thread->authors,
-                                          author);
-    else
-       thread->authors = author_copy;
+    g_ptr_array_add (thread->matched_authors_array, author_copy);
 }
 
-/* Copy any authors from the authors array that were not also matched
- * authors onto the end of the thread's authors string.
- * We use a '|' to separate matched and unmatched authors. */
+/* Construct an authors string from matched_authors_array and
+ * authors_array. The string contains matched authors first, then
+ * non-matched authors (with the two groups separated by '|'). Within
+ * each group, authors are listed in date order. */
 static void
-_complete_thread_authors (notmuch_thread_t *thread)
+_resolve_thread_authors_string (notmuch_thread_t *thread)
 {
     unsigned int i;
     char *author;
+    int first_non_matched_author = 1;
+
+    /* First, list all matched authors in date order. */
+    for (i = 0; i < thread->matched_authors_array->len; i++) {
+       author = (char *) g_ptr_array_index (thread->matched_authors_array, i);
+       if (thread->authors)
+           thread->authors = talloc_asprintf (thread, "%s, %s",
+                                              thread->authors,
+                                              author);
+       else
+           thread->authors = author;
+    }
 
+    /* Next, append any non-matched authors that haven't already appeared. */
     for (i = 0; i < thread->authors_array->len; i++) {
        author = (char *) g_ptr_array_index (thread->authors_array, i);
        if (g_hash_table_lookup_extended (thread->matched_authors_hash,
                                          author, NULL, NULL))
            continue;
-       if (thread->has_non_matched_authors) {
-           thread->authors = talloc_asprintf (thread, "%s, %s",
+       if (first_non_matched_author) {
+           thread->authors = talloc_asprintf (thread, "%s| %s",
                                               thread->authors,
                                               author);
        } else {
-           thread->authors = talloc_asprintf (thread, "%s| %s",
+           thread->authors = talloc_asprintf (thread, "%s, %s",
                                               thread->authors,
                                               author);
-           thread->has_non_matched_authors = 1;
        }
+
+       first_non_matched_author = 0;
     }
 
     g_ptr_array_free (thread->authors_array, TRUE);
     thread->authors_array = NULL;
+    g_ptr_array_free (thread->matched_authors_array, TRUE);
+    thread->matched_authors_array = NULL;
 }
 
 /* clean up the ugly "Lastname, Firstname" format that some mail systems
@@ -199,7 +214,8 @@ _thread_cleanup_author (notmuch_thread_t *thread,
  */
 static void
 _thread_add_message (notmuch_thread_t *thread,
-                    notmuch_message_t *message)
+                    notmuch_message_t *message,
+                    notmuch_string_list_t *exclude_terms)
 {
     notmuch_tags_t *tags;
     const char *tag;
@@ -247,6 +263,15 @@ _thread_add_message (notmuch_thread_t *thread,
         notmuch_tags_move_to_next (tags))
     {
        tag = notmuch_tags_get (tags);
+       /* Mark excluded messages. */
+       for (notmuch_string_node_t *term = exclude_terms->head; term;
+            term = term->next) {
+           /* We ignore initial 'K'. */
+           if (strcmp(tag, (term->string + 1)) == 0) {
+               notmuch_message_set_flag (message, NOTMUCH_MESSAGE_FLAG_EXCLUDED, TRUE);
+               break;
+           }
+       }
        g_hash_table_insert (thread->tags, xstrdup (tag), NULL);
     }
 }
@@ -280,6 +305,10 @@ _thread_set_subject_from_message (notmuch_thread_t *thread,
     thread->subject = talloc_strdup (thread, cleaned_subject);
 }
 
+/* Add a message to this thread which is known to match the original
+ * search specification. The 'sort' parameter controls whether the
+ * oldest or newest matching subject is applied to the thread as a
+ * whole. */
 static void
 _thread_add_matched_message (notmuch_thread_t *thread,
                             notmuch_message_t *message,
@@ -290,13 +319,20 @@ _thread_add_matched_message (notmuch_thread_t *thread,
 
     date = notmuch_message_get_date (message);
 
-    if (date < thread->oldest || ! thread->matched_messages)
+    if (date < thread->oldest || ! thread->matched_messages) {
        thread->oldest = date;
+       if (sort == NOTMUCH_SORT_OLDEST_FIRST)
+           _thread_set_subject_from_message (thread, message);
+    }
 
-    if (date > thread->newest || ! thread->matched_messages)
+    if (date > thread->newest || ! thread->matched_messages) {
        thread->newest = date;
+       if (sort != NOTMUCH_SORT_OLDEST_FIRST)
+           _thread_set_subject_from_message (thread, message);
+    }
 
-    thread->matched_messages++;
+    if (!notmuch_message_get_flag (message, NOTMUCH_MESSAGE_FLAG_EXCLUDED))
+       thread->matched_messages++;
 
     if (g_hash_table_lookup_extended (thread->message_hash,
                            notmuch_message_get_message_id (message), NULL,
@@ -306,12 +342,6 @@ _thread_add_matched_message (notmuch_thread_t *thread,
     }
 
     _thread_add_matched_author (thread, notmuch_message_get_author (hashed_message));
-
-    if ((sort == NOTMUCH_SORT_OLDEST_FIRST && date <= thread->newest) ||
-       (sort != NOTMUCH_SORT_OLDEST_FIRST && date == thread->newest))
-    {
-       _thread_set_subject_from_message (thread, message);
-    }
 }
 
 static void
@@ -352,16 +382,17 @@ _resolve_thread_relationships (unused (notmuch_thread_t *thread))
      */
 }
 
-/* Create a new notmuch_thread_t object for the given thread ID,
- * treating any messages matching 'query_string' as "matched".
+/* Create a new notmuch_thread_t object by finding the thread
+ * containing the message with the given doc ID, treating any messages
+ * contained in match_set as "matched".  Remove all messages in the
+ * thread from match_set.
  *
- * Creating the thread will trigger two database searches. The first
- * is for all messages belonging to the thread, (to get the first
- * subject line, the total count of messages, and all authors). The
- * second search is for all messages that are in the thread and that
- * also match the given query_string. This is to allow for a separate
- * count of matched messages, and to allow a viewer to display these
- * messages differently.
+ * Creating the thread will perform a database search to get all
+ * messages belonging to the thread and will get the first subject
+ * line, the total count of messages, and all authors in the thread.
+ * Each message in the thread is checked against match_set to allow
+ * for a separate count of matched messages, and to allow a viewer to
+ * display these messages differently.
  *
  * Here, 'ctx' is talloc context for the resulting thread object.
  *
@@ -370,57 +401,35 @@ _resolve_thread_relationships (unused (notmuch_thread_t *thread))
 notmuch_thread_t *
 _notmuch_thread_create (void *ctx,
                        notmuch_database_t *notmuch,
-                       const char *thread_id,
-                       const char *query_string,
+                       unsigned int seed_doc_id,
+                       notmuch_doc_id_set_t *match_set,
+                       notmuch_string_list_t *exclude_terms,
                        notmuch_sort_t sort)
 {
     notmuch_thread_t *thread;
-    const char *thread_id_query_string;
+    notmuch_message_t *seed_message;
+    const char *thread_id;
+    char *thread_id_query_string;
     notmuch_query_t *thread_id_query;
 
     notmuch_messages_t *messages;
     notmuch_message_t *message;
-    notmuch_bool_t matched_is_subset_of_thread;
 
+    seed_message = _notmuch_message_create (ctx, notmuch, seed_doc_id, NULL);
+    if (! seed_message)
+       INTERNAL_ERROR ("Thread seed message %u does not exist", seed_doc_id);
+
+    thread_id = notmuch_message_get_thread_id (seed_message);
     thread_id_query_string = talloc_asprintf (ctx, "thread:%s", thread_id);
-    if (unlikely (query_string == NULL))
+    if (unlikely (thread_id_query_string == NULL))
        return NULL;
 
-    /* Under normal circumstances we need to do two database
-     * queries. One is for the thread itself (thread_id_query_string)
-     * and the second is to determine which messages in that thread
-     * match the original query (matched_query_string).
-     *
-     * But under two circumstances, we use only the
-     * thread_id_query_string:
-     *
-     * 1. If the original query_string *is* just the thread
-     *    specification.
-     *
-     *  2. If the original query_string matches all messages ("" or
-     *     "*").
-     *
-     * In either of these cases, we can be more efficient by running
-     * just the thread_id query (since we know all messages in the
-     * thread will match the query_string).
-     *
-     * Beyond the performance advantage, in the second case, it's
-     * important to not try to create a concatenated query because our
-     * parser handles "" and "*" as special cases and will not do the
-     * right thing with a query string of "* and thread:<foo>".
-     **/
-    matched_is_subset_of_thread = 1;
-    if (strcmp (query_string, thread_id_query_string) == 0 ||
-       strcmp (query_string, "") == 0 ||
-       strcmp (query_string, "*") == 0)
-    {
-       matched_is_subset_of_thread = 0;
-    }
-
     thread_id_query = notmuch_query_create (notmuch, thread_id_query_string);
     if (unlikely (thread_id_query == NULL))
        return NULL;
 
+    talloc_free (thread_id_query_string);
+
     thread = talloc (ctx, notmuch_thread_t);
     if (unlikely (thread == NULL))
        return NULL;
@@ -436,8 +445,8 @@ _notmuch_thread_create (void *ctx,
     thread->matched_authors_hash = g_hash_table_new_full (g_str_hash,
                                                          g_str_equal,
                                                          NULL, NULL);
+    thread->matched_authors_array = g_ptr_array_new ();
     thread->authors = NULL;
-    thread->has_non_matched_authors = 0;
     thread->tags = g_hash_table_new_full (g_str_hash, g_str_equal,
                                          free, NULL);
 
@@ -453,52 +462,36 @@ _notmuch_thread_create (void *ctx,
     thread->oldest = 0;
     thread->newest = 0;
 
+    /* We use oldest-first order unconditionally here to obtain the
+     * proper author ordering for the thread. The 'sort' parameter
+     * passed to this function is used only to indicate whether the
+     * oldest or newest subject is desired. */
     notmuch_query_set_sort (thread_id_query, NOTMUCH_SORT_OLDEST_FIRST);
 
     for (messages = notmuch_query_search_messages (thread_id_query);
         notmuch_messages_valid (messages);
         notmuch_messages_move_to_next (messages))
     {
+       unsigned int doc_id;
+
        message = notmuch_messages_get (messages);
+       doc_id = _notmuch_message_get_doc_id (message);
+       if (doc_id == seed_doc_id)
+           message = seed_message;
 
-       _thread_add_message (thread, message);
+       _thread_add_message (thread, message, exclude_terms);
 
-       if (! matched_is_subset_of_thread)
+       if ( _notmuch_doc_id_set_contains (match_set, doc_id)) {
+           _notmuch_doc_id_set_remove (match_set, doc_id);
            _thread_add_matched_message (thread, message, sort);
+       }
 
        _notmuch_message_close (message);
     }
 
     notmuch_query_destroy (thread_id_query);
 
-    if (matched_is_subset_of_thread)
-    {
-       const char *matched_query_string;
-       notmuch_query_t *matched_query;
-
-       matched_query_string = talloc_asprintf (ctx, "%s AND (%s)",
-                                               thread_id_query_string,
-                                               query_string);
-       if (unlikely (matched_query_string == NULL))
-           return NULL;
-
-       matched_query = notmuch_query_create (notmuch, matched_query_string);
-       if (unlikely (matched_query == NULL))
-           return NULL;
-
-       for (messages = notmuch_query_search_messages (matched_query);
-            notmuch_messages_valid (messages);
-            notmuch_messages_move_to_next (messages))
-       {
-           message = notmuch_messages_get (messages);
-           _thread_add_matched_message (thread, message, sort);
-           _notmuch_message_close (message);
-       }
-
-       notmuch_query_destroy (matched_query);
-    }
-
-    _complete_thread_authors (thread);
+    _resolve_thread_authors_string (thread);
 
     _resolve_thread_relationships (thread);
 
@@ -556,23 +549,23 @@ notmuch_thread_get_newest_date (notmuch_thread_t *thread)
 notmuch_tags_t *
 notmuch_thread_get_tags (notmuch_thread_t *thread)
 {
-    notmuch_tags_t *tags;
+    notmuch_string_list_t *tags;
     GList *keys, *l;
 
-    tags = _notmuch_tags_create (thread);
+    tags = _notmuch_string_list_create (thread);
     if (unlikely (tags == NULL))
        return NULL;
 
     keys = g_hash_table_get_keys (thread->tags);
 
     for (l = keys; l; l = l->next)
-       _notmuch_tags_add_tag (tags, (char *) l->data);
+       _notmuch_string_list_append (tags, (char *) l->data);
 
     g_list_free (keys);
 
-    _notmuch_tags_prepare_iterator (tags);
+    _notmuch_string_list_sort (tags);
 
-    return tags;
+    return _notmuch_tags_create (thread, tags);
 }
 
 void