]> git.notmuchmail.org Git - notmuch/blobdiff - lib/thread.cc
build: visibility=default for library structs is no longer needed
[notmuch] / lib / thread.cc
index 31c655b6fe475d7077caab5357d37e39deb1907c..1a1ecfa5507ee8cf35e243eb4b44ddfdcd0526eb 100644 (file)
@@ -13,7 +13,7 @@
  * GNU General Public License for more details.
  *
  * You should have received a copy of the GNU General Public License
- * along with this program.  If not, see http://www.gnu.org/licenses/ .
+ * along with this program.  If not, see https://www.gnu.org/licenses/ .
  *
  * Author: Carl Worth <cworth@cworth.org>
  */
@@ -24,6 +24,8 @@
 #include <gmime/gmime.h>
 #include <glib.h> /* GHashTable */
 
+#define EMPTY_STRING(s) ((s)[0] == '\0')
+
 struct _notmuch_thread {
     notmuch_database_t *notmuch;
     char *thread_id;
@@ -35,7 +37,11 @@ struct _notmuch_thread {
     char *authors;
     GHashTable *tags;
 
+    /* All messages, oldest first. */
     notmuch_message_list_t *message_list;
+    /* Top-level messages, oldest first. */
+    notmuch_message_list_t *toplevel_list;
+
     GHashTable *message_hash;
     int total_messages;
     int matched_messages;
@@ -186,8 +192,16 @@ _thread_cleanup_author (notmuch_thread_t *thread,
     if (comma && strlen(comma) > 1) {
        /* let's assemble what we think is the correct name */
        lname = comma - author;
-       fname = strlen(author) - lname - 2;
-       strncpy(clean_author, comma + 2, fname);
+
+       /* Skip all the spaces after the comma */
+       fname = strlen(author) - lname - 1;
+       comma += 1;
+       while (*comma == ' ') {
+           fname -= 1;
+           comma += 1;
+       }
+       strncpy(clean_author, comma, fname);
+
        *(clean_author+fname) = ' ';
        strncpy(clean_author + fname + 1, author, lname);
        *(clean_author+fname+1+lname) = '\0';
@@ -214,7 +228,9 @@ _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_exclude_t omit_exclude)
 {
     notmuch_tags_t *tags;
     const char *tag;
@@ -222,6 +238,30 @@ _thread_add_message (notmuch_thread_t *thread,
     InternetAddress *address;
     const char *from, *author;
     char *clean_author;
+    notmuch_bool_t message_excluded = FALSE;
+
+    if (omit_exclude != NOTMUCH_EXCLUDE_FALSE) {
+       for (tags = notmuch_message_get_tags (message);
+            notmuch_tags_valid (tags);
+            notmuch_tags_move_to_next (tags))
+       {
+           tag = notmuch_tags_get (tags);
+           /* Is message excluded? */
+           for (notmuch_string_node_t *term = exclude_terms->head;
+                term != NULL;
+                term = term->next)
+           {
+               /* Check for an empty string, and then ignore initial 'K'. */
+               if (*(term->string) && strcmp(tag, (term->string + 1)) == 0) {
+                   message_excluded = TRUE;
+                   break;
+               }
+           }
+       }
+    }
+
+    if (message_excluded && omit_exclude == NOTMUCH_EXCLUDE_ALL)
+       return;
 
     _notmuch_message_list_add_message (thread->message_list,
                                       talloc_steal (thread, message));
@@ -239,14 +279,15 @@ _thread_add_message (notmuch_thread_t *thread,
        address = internet_address_list_get_address (list, 0);
        if (address) {
            author = internet_address_get_name (address);
-           if (author == NULL) {
+           /* We treat quoted empty names as if they were empty. */
+           if (author == NULL || author[0] == '\0') {
                InternetAddressMailbox *mailbox;
                mailbox = INTERNET_ADDRESS_MAILBOX (address);
                author = internet_address_mailbox_get_addr (mailbox);
            }
            clean_author = _thread_cleanup_author (thread, author, from);
            _thread_add_author (thread, clean_author);
-           notmuch_message_set_author (message, clean_author);
+           _notmuch_message_set_author (message, clean_author);
        }
        g_object_unref (G_OBJECT (list));
     }
@@ -264,6 +305,10 @@ _thread_add_message (notmuch_thread_t *thread,
        tag = notmuch_tags_get (tags);
        g_hash_table_insert (thread->tags, xstrdup (tag), NULL);
     }
+
+    /* Mark excluded messages. */
+    if (message_excluded)
+       notmuch_message_set_flag (message, NOTMUCH_MESSAGE_FLAG_EXCLUDED, TRUE);
 }
 
 static void
@@ -289,10 +334,12 @@ _thread_set_subject_from_message (notmuch_thread_t *thread,
        cleaned_subject = talloc_strdup (thread, subject);
     }
 
-    if (thread->subject)
-       talloc_free (thread->subject);
+    if (! EMPTY_STRING(cleaned_subject)) {
+       if (thread->subject)
+           talloc_free (thread->subject);
 
-    thread->subject = talloc_strdup (thread, cleaned_subject);
+       thread->subject = talloc_strdup (thread, cleaned_subject);
+    }
 }
 
 /* Add a message to this thread which is known to match the original
@@ -317,11 +364,13 @@ _thread_add_matched_message (notmuch_thread_t *thread,
 
     if (date > thread->newest || ! thread->matched_messages) {
        thread->newest = date;
-       if (sort != NOTMUCH_SORT_OLDEST_FIRST)
+       const char *cur_subject = notmuch_thread_get_subject(thread);
+       if (sort != NOTMUCH_SORT_OLDEST_FIRST || EMPTY_STRING(cur_subject))
            _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,
@@ -330,33 +379,26 @@ _thread_add_matched_message (notmuch_thread_t *thread,
                                  NOTMUCH_MESSAGE_FLAG_MATCH, 1);
     }
 
-    _thread_add_matched_author (thread, notmuch_message_get_author (hashed_message));
+    _thread_add_matched_author (thread, _notmuch_message_get_author (hashed_message));
 }
 
 static void
-_resolve_thread_relationships (unused (notmuch_thread_t *thread))
+_resolve_thread_relationships (notmuch_thread_t *thread)
 {
-    notmuch_message_node_t **prev, *node;
+    notmuch_message_node_t *node;
     notmuch_message_t *message, *parent;
     const char *in_reply_to;
 
-    prev = &thread->message_list->head;
-    while ((node = *prev)) {
+    for (node = thread->message_list->head; node; node = node->next) {
        message = node->message;
        in_reply_to = _notmuch_message_get_in_reply_to (message);
        if (in_reply_to && strlen (in_reply_to) &&
            g_hash_table_lookup_extended (thread->message_hash,
                                          in_reply_to, NULL,
                                          (void **) &parent))
-       {
-           *prev = node->next;
-           if (thread->message_list->tail == &node->next)
-               thread->message_list->tail = prev;
-           node->next = NULL;
-           _notmuch_message_add_reply (parent, node);
-       } else {
-           prev = &((*prev)->next);
-       }
+           _notmuch_message_add_reply (parent, message);
+       else
+           _notmuch_message_list_add_message (thread->toplevel_list, message);
     }
 
     /* XXX: After scanning through the entire list looking for parents
@@ -371,16 +413,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.
  *
@@ -389,60 +432,40 @@ _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_exclude_t omit_excluded,
                        notmuch_sort_t sort)
 {
-    notmuch_thread_t *thread;
-    const char *thread_id_query_string;
+    void *local = talloc_new (ctx);
+    notmuch_thread_t *thread = NULL;
+    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;
+    notmuch_status_t status;
 
-    thread_id_query_string = talloc_asprintf (ctx, "thread:%s", thread_id);
-    if (unlikely (query_string == NULL))
-       return NULL;
+    seed_message = _notmuch_message_create (local, notmuch, seed_doc_id, NULL);
+    if (! seed_message)
+       INTERNAL_ERROR ("Thread seed message %u does not exist", seed_doc_id);
 
-    /* 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 = notmuch_message_get_thread_id (seed_message);
+    thread_id_query_string = talloc_asprintf (local, "thread:%s", thread_id);
+    if (unlikely (thread_id_query_string == NULL))
+       goto DONE;
 
-    thread_id_query = notmuch_query_create (notmuch, thread_id_query_string);
+    thread_id_query = talloc_steal (
+       local, notmuch_query_create (notmuch, thread_id_query_string));
     if (unlikely (thread_id_query == NULL))
-       return NULL;
+       goto DONE;
 
-    thread = talloc (ctx, notmuch_thread_t);
+    thread = talloc (local, notmuch_thread_t);
     if (unlikely (thread == NULL))
-       return NULL;
+       goto DONE;
 
     talloc_set_destructor (thread, _notmuch_thread_destructor);
 
@@ -461,8 +484,12 @@ _notmuch_thread_create (void *ctx,
                                          free, NULL);
 
     thread->message_list = _notmuch_message_list_create (thread);
-    if (unlikely (thread->message_list == NULL))
-       return NULL;
+    thread->toplevel_list = _notmuch_message_list_create (thread);
+    if (unlikely (thread->message_list == NULL ||
+                 thread->toplevel_list == NULL)) {
+       thread = NULL;
+       goto DONE;
+    }
 
     thread->message_hash = g_hash_table_new_full (g_str_hash, g_str_equal,
                                                  free, NULL);
@@ -478,61 +505,51 @@ _notmuch_thread_create (void *ctx,
      * 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);
+    status = notmuch_query_search_messages (thread_id_query, &messages);
+    if (status)
+       goto DONE;
+
+    for (;
         notmuch_messages_valid (messages);
         notmuch_messages_move_to_next (messages))
     {
-       message = notmuch_messages_get (messages);
-
-       _thread_add_message (thread, message);
-
-       if (! matched_is_subset_of_thread)
-           _thread_add_matched_message (thread, message, sort);
-
-       _notmuch_message_close (message);
-    }
-
-    notmuch_query_destroy (thread_id_query);
+       unsigned int doc_id;
 
-    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;
+       message = notmuch_messages_get (messages);
+       doc_id = _notmuch_message_get_doc_id (message);
+       if (doc_id == seed_doc_id)
+           message = seed_message;
 
-       /* As above, we use oldest-first order unconditionally here. */
-       notmuch_query_set_sort (matched_query, NOTMUCH_SORT_OLDEST_FIRST);
+       _thread_add_message (thread, message, exclude_terms, omit_excluded);
 
-       for (messages = notmuch_query_search_messages (matched_query);
-            notmuch_messages_valid (messages);
-            notmuch_messages_move_to_next (messages))
-       {
-           message = notmuch_messages_get (messages);
+       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 (matched_query);
+       _notmuch_message_close (message);
     }
 
     _resolve_thread_authors_string (thread);
 
     _resolve_thread_relationships (thread);
 
+    /* Commit to returning thread. */
+    (void) talloc_steal (ctx, thread);
+
+  DONE:
+    talloc_free (local);
     return thread;
 }
 
 notmuch_messages_t *
 notmuch_thread_get_toplevel_messages (notmuch_thread_t *thread)
+{
+    return _notmuch_messages_create (thread->toplevel_list);
+}
+
+notmuch_messages_t *
+notmuch_thread_get_messages (notmuch_thread_t *thread)
 {
     return _notmuch_messages_create (thread->message_list);
 }
@@ -582,23 +599,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