git.notmuchmail.org Git - notmuch/blob - lib/thread.cc

   1 /* thread.cc - Results of thread-based searches from a notmuch database
   2  *
   3  * Copyright © 2009 Carl Worth
   4  *
   5  * This program is free software: you can redistribute it and/or modify
   6  * it under the terms of the GNU General Public License as published by
   7  * the Free Software Foundation, either version 3 of the License, or
   8  * (at your option) any later version.
   9  *
  10  * This program is distributed in the hope that it will be useful,
  11  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  12  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  13  * GNU General Public License for more details.
  14  *
  15  * You should have received a copy of the GNU General Public License
  16  * along with this program.  If not, see http://www.gnu.org/licenses/ .
  17  *
  18  * Author: Carl Worth <cworth@cworth.org>
  19  */
  20
  21 #include "notmuch-private.h"
  22 #include "database-private.h"
  23
  24 #include <xapian.h>
  25
  26 #include <gmime/gmime.h>
  27 #include <glib.h> /* GHashTable */
  28
  29 struct _notmuch_thread {
  30     notmuch_database_t *notmuch;
  31     char *thread_id;
  32     char *subject;
  33     GHashTable *authors_hash;
  34     char *authors;
  35     GHashTable *tags;
  36
  37     notmuch_message_list_t *message_list;
  38     GHashTable *message_hash;
  39     int total_messages;
  40     int matched_messages;
  41     time_t oldest;
  42     time_t newest;
  43 };
  44
  45 static int
  46 _notmuch_thread_destructor (notmuch_thread_t *thread)
  47 {
  48     g_hash_table_unref (thread->authors_hash);
  49     g_hash_table_unref (thread->tags);
  50     g_hash_table_unref (thread->message_hash);
  51
  52     return 0;
  53 }
  54
  55 static void
  56 _thread_add_author (notmuch_thread_t *thread,
  57                     const char *author)
  58 {
  59     if (author == NULL)
  60         return;
  61
  62     if (g_hash_table_lookup_extended (thread->authors_hash,
  63                                       author, NULL, NULL))
  64         return;
  65
  66     g_hash_table_insert (thread->authors_hash, xstrdup (author), NULL);
  67
  68     if (thread->authors)
  69         thread->authors = talloc_asprintf (thread, "%s, %s",
  70                                            thread->authors,
  71                                            author);
  72     else
  73         thread->authors = talloc_strdup (thread, author);
  74 }
  75
  76 /* Add 'message' as a message that belongs to 'thread'.
  77  *
  78  * The 'thread' will talloc_steal the 'message' and hold onto a
  79  * reference to it.
  80  */
  81 static void
  82 _thread_add_message (notmuch_thread_t *thread,
  83                      notmuch_message_t *message)
  84 {
  85     notmuch_tags_t *tags;
  86     const char *tag;
  87     InternetAddressList *list;
  88     InternetAddress *address;
  89     const char *from, *author;
  90
  91     _notmuch_message_list_add_message (thread->message_list,
  92                                        talloc_steal (thread, message));
  93     thread->total_messages++;
  94
  95     g_hash_table_insert (thread->message_hash,
  96                          xstrdup (notmuch_message_get_message_id (message)),
  97                          message);
  98
  99     from = notmuch_message_get_header (message, "from");
 100     list = internet_address_list_parse_string (from);
 101     if (list) {
 102         address = internet_address_list_get_address (list, 0);
 103         if (address) {
 104             author = internet_address_get_name (address);
 105             if (author == NULL) {
 106                 InternetAddressMailbox *mailbox;
 107                 mailbox = INTERNET_ADDRESS_MAILBOX (address);
 108                 author = internet_address_mailbox_get_addr (mailbox);
 109             }
 110             _thread_add_author (thread, author);
 111         }
 112         g_object_unref (G_OBJECT (list));
 113     }
 114
 115     if (! thread->subject) {
 116         const char *subject;
 117         subject = notmuch_message_get_header (message, "subject");
 118         thread->subject = talloc_strdup (thread, subject);
 119     }
 120
 121     for (tags = notmuch_message_get_tags (message);
 122          notmuch_tags_valid (tags);
 123          notmuch_tags_move_to_next (tags))
 124     {
 125         tag = notmuch_tags_get (tags);
 126         g_hash_table_insert (thread->tags, xstrdup (tag), NULL);
 127     }
 128 }
 129
 130 static void
 131 _thread_set_subject_from_message (notmuch_thread_t *thread,
 132                                   notmuch_message_t *message)
 133 {
 134     const char *subject;
 135     const char *cleaned_subject;
 136
 137     subject = notmuch_message_get_header (message, "subject");
 138
 139     if ((strncasecmp (subject, "Re: ", 4) == 0) ||
 140         (strncasecmp (subject, "Aw: ", 4) == 0) ||
 141         (strncasecmp (subject, "Vs: ", 4) == 0) ||
 142         (strncasecmp (subject, "Sv: ", 4) == 0)) {
 143
 144         cleaned_subject = talloc_strndup (thread,
 145                                           subject + 4,
 146                                           strlen(subject) - 4);
 147     } else {
 148         cleaned_subject = talloc_strdup (thread, subject);
 149     }
 150
 151     if (thread->subject)
 152         talloc_free (thread->subject);
 153
 154     thread->subject = talloc_strdup (thread, cleaned_subject);
 155 }
 156
 157 static void
 158 _thread_add_matched_message (notmuch_thread_t *thread,
 159                              notmuch_message_t *message,
 160                              notmuch_sort_t sort)
 161 {
 162     time_t date;
 163     notmuch_message_t *hashed_message;
 164
 165     date = notmuch_message_get_date (message);
 166
 167     if (date < thread->oldest || ! thread->matched_messages)
 168         thread->oldest = date;
 169
 170     if (date > thread->newest || ! thread->matched_messages)
 171         thread->newest = date;
 172
 173     thread->matched_messages++;
 174
 175     if (g_hash_table_lookup_extended (thread->message_hash,
 176                             notmuch_message_get_message_id (message), NULL,
 177                             (void **) &hashed_message)) {
 178         notmuch_message_set_flag (hashed_message,
 179                                   NOTMUCH_MESSAGE_FLAG_MATCH, 1);
 180     }
 181
 182     if ((sort == NOTMUCH_SORT_OLDEST_FIRST && date <= thread->newest) ||
 183         (sort != NOTMUCH_SORT_OLDEST_FIRST && date == thread->newest))
 184     {
 185         _thread_set_subject_from_message (thread, message);
 186     }
 187 }
 188
 189 static void
 190 _resolve_thread_relationships (unused (notmuch_thread_t *thread))
 191 {
 192     notmuch_message_node_t **prev, *node;
 193     notmuch_message_t *message, *parent;
 194     const char *in_reply_to;
 195
 196     prev = &thread->message_list->head;
 197     while ((node = *prev)) {
 198         message = node->message;
 199         in_reply_to = _notmuch_message_get_in_reply_to (message);
 200         if (in_reply_to && strlen (in_reply_to) &&
 201             g_hash_table_lookup_extended (thread->message_hash,
 202                                           in_reply_to, NULL,
 203                                           (void **) &parent))
 204         {
 205             *prev = node->next;
 206             if (thread->message_list->tail == &node->next)
 207                 thread->message_list->tail = prev;
 208             node->next = NULL;
 209             _notmuch_message_add_reply (parent, node);
 210         } else {
 211             prev = &((*prev)->next);
 212         }
 213     }
 214
 215     /* XXX: After scanning through the entire list looking for parents
 216      * via "In-Reply-To", we should do a second pass that looks at the
 217      * list of messages IDs in the "References" header instead. (And
 218      * for this the parent would be the "deepest" message of all the
 219      * messages found in the "References" list.)
 220      *
 221      * Doing this will allow messages and sub-threads to be positioned
 222      * correctly in the thread even when an intermediate message is
 223      * missing from the thread.
 224      */
 225 }
 226
 227 /* Create a new notmuch_thread_t object for the given thread ID,
 228  * treating any messages matching 'query_string' as "matched".
 229  *
 230  * Creating the thread will trigger two database searches. The first
 231  * is for all messages belonging to the thread, (to get the first
 232  * subject line, the total count of messages, and all authors). The
 233  * second search is for all messages that are in the thread and that
 234  * also match the given query_string. This is to allow for a separate
 235  * count of matched messages, and to allow a viewer to display these
 236  * messages differently.
 237  *
 238  * Here, 'ctx' is talloc context for the resulting thread object.
 239  *
 240  * This function returns NULL in the case of any error.
 241  */
 242 notmuch_thread_t *
 243 _notmuch_thread_create (void *ctx,
 244                         notmuch_database_t *notmuch,
 245                         const char *thread_id,
 246                         const char *query_string,
 247                         notmuch_sort_t sort)
 248 {
 249     notmuch_thread_t *thread;
 250     const char *thread_id_query_string;
 251     notmuch_query_t *thread_id_query;
 252
 253     notmuch_messages_t *messages;
 254     notmuch_message_t *message;
 255     notmuch_bool_t matched_is_subset_of_thread;
 256
 257     thread_id_query_string = talloc_asprintf (ctx, "thread:%s", thread_id);
 258     if (unlikely (query_string == NULL))
 259         return NULL;
 260
 261     /* Under normal circumstances we need to do two database
 262      * queries. One is for the thread itself (thread_id_query_string)
 263      * and the second is to determine which messages in that thread
 264      * match the original query (matched_query_string).
 265      *
 266      * But under two circumstances, we use only the
 267      * thread_id_query_string:
 268      *
 269      *  1. If the original query_string *is* just the thread
 270      *     specification.
 271      *
 272      *  2. If the original query_string matches all messages ("" or
 273      *     "*").
 274      *
 275      * In either of these cases, we can be more efficient by running
 276      * just the thread_id query (since we know all messages in the
 277      * thread will match the query_string).
 278      *
 279      * Beyond the performance advantage, in the second case, it's
 280      * important to not try to create a concatenated query because our
 281      * parser handles "" and "*" as special cases and will not do the
 282      * right thing with a query string of "* and thread:<foo>".
 283      **/
 284     matched_is_subset_of_thread = 1;
 285     if (strcmp (query_string, thread_id_query_string) == 0 ||
 286         strcmp (query_string, "") == 0 ||
 287         strcmp (query_string, "*") == 0)
 288     {
 289         matched_is_subset_of_thread = 0;
 290     }
 291
 292     thread_id_query = notmuch_query_create (notmuch, thread_id_query_string);
 293     if (unlikely (thread_id_query == NULL))
 294         return NULL;
 295
 296     thread = talloc (ctx, notmuch_thread_t);
 297     if (unlikely (thread == NULL))
 298         return NULL;
 299
 300     talloc_set_destructor (thread, _notmuch_thread_destructor);
 301
 302     thread->notmuch = notmuch;
 303     thread->thread_id = talloc_strdup (thread, thread_id);
 304     thread->subject = NULL;
 305     thread->authors_hash = g_hash_table_new_full (g_str_hash, g_str_equal,
 306                                                   free, NULL);
 307     thread->authors = NULL;
 308     thread->tags = g_hash_table_new_full (g_str_hash, g_str_equal,
 309                                           free, NULL);
 310
 311     thread->message_list = _notmuch_message_list_create (thread);
 312     if (unlikely (thread->message_list == NULL))
 313         return NULL;
 314
 315     thread->message_hash = g_hash_table_new_full (g_str_hash, g_str_equal,
 316                                                   free, NULL);
 317
 318     thread->total_messages = 0;
 319     thread->matched_messages = 0;
 320     thread->oldest = 0;
 321     thread->newest = 0;
 322
 323     notmuch_query_set_sort (thread_id_query, NOTMUCH_SORT_OLDEST_FIRST);
 324
 325     for (messages = notmuch_query_search_messages (thread_id_query);
 326          notmuch_messages_valid (messages);
 327          notmuch_messages_move_to_next (messages))
 328     {
 329         message = notmuch_messages_get (messages);
 330
 331         _thread_add_message (thread, message);
 332
 333         if (! matched_is_subset_of_thread)
 334             _thread_add_matched_message (thread, message, sort);
 335
 336         _notmuch_message_close (message);
 337     }
 338
 339     notmuch_query_destroy (thread_id_query);
 340
 341     if (matched_is_subset_of_thread)
 342     {
 343         const char *matched_query_string;
 344         notmuch_query_t *matched_query;
 345
 346         matched_query_string = talloc_asprintf (ctx, "%s AND (%s)",
 347                                                 thread_id_query_string,
 348                                                 query_string);
 349         if (unlikely (matched_query_string == NULL))
 350             return NULL;
 351
 352         matched_query = notmuch_query_create (notmuch, matched_query_string);
 353         if (unlikely (matched_query == NULL))
 354             return NULL;
 355
 356         for (messages = notmuch_query_search_messages (matched_query);
 357              notmuch_messages_valid (messages);
 358              notmuch_messages_move_to_next (messages))
 359         {
 360             message = notmuch_messages_get (messages);
 361             _thread_add_matched_message (thread, message, sort);
 362             _notmuch_message_close (message);
 363         }
 364
 365         notmuch_query_destroy (matched_query);
 366     }
 367
 368     _resolve_thread_relationships (thread);
 369
 370     return thread;
 371 }
 372
 373 notmuch_messages_t *
 374 notmuch_thread_get_toplevel_messages (notmuch_thread_t *thread)
 375 {
 376     return _notmuch_messages_create (thread->message_list);
 377 }
 378
 379 const char *
 380 notmuch_thread_get_thread_id (notmuch_thread_t *thread)
 381 {
 382     return thread->thread_id;
 383 }
 384
 385 int
 386 notmuch_thread_get_total_messages (notmuch_thread_t *thread)
 387 {
 388     return thread->total_messages;
 389 }
 390
 391 int
 392 notmuch_thread_get_matched_messages (notmuch_thread_t *thread)
 393 {
 394     return thread->matched_messages;
 395 }
 396
 397 const char *
 398 notmuch_thread_get_authors (notmuch_thread_t *thread)
 399 {
 400     return thread->authors;
 401 }
 402
 403 const char *
 404 notmuch_thread_get_subject (notmuch_thread_t *thread)
 405 {
 406     return thread->subject;
 407 }
 408
 409 time_t
 410 notmuch_thread_get_oldest_date (notmuch_thread_t *thread)
 411 {
 412     return thread->oldest;
 413 }
 414
 415 time_t
 416 notmuch_thread_get_newest_date (notmuch_thread_t *thread)
 417 {
 418     return thread->newest;
 419 }
 420
 421 notmuch_tags_t *
 422 notmuch_thread_get_tags (notmuch_thread_t *thread)
 423 {
 424     notmuch_tags_t *tags;
 425     GList *keys, *l;
 426
 427     tags = _notmuch_tags_create (thread);
 428     if (unlikely (tags == NULL))
 429         return NULL;
 430
 431     keys = g_hash_table_get_keys (thread->tags);
 432
 433     for (l = keys; l; l = l->next)
 434         _notmuch_tags_add_tag (tags, (char *) l->data);
 435
 436     g_list_free (keys);
 437
 438     _notmuch_tags_prepare_iterator (tags);
 439
 440     return tags;
 441 }
 442
 443 void
 444 notmuch_thread_destroy (notmuch_thread_t *thread)
 445 {
 446     talloc_free (thread);
 447 }