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     char *nonmatched_authors;
  36     GHashTable *tags;
  37
  38     notmuch_message_list_t *message_list;
  39     GHashTable *message_hash;
  40     int total_messages;
  41     int matched_messages;
  42     time_t oldest;
  43     time_t newest;
  44 };
  45
  46 static int
  47 _notmuch_thread_destructor (notmuch_thread_t *thread)
  48 {
  49     g_hash_table_unref (thread->authors_hash);
  50     g_hash_table_unref (thread->tags);
  51     g_hash_table_unref (thread->message_hash);
  52
  53     return 0;
  54 }
  55
  56 static void
  57 _thread_add_author (notmuch_thread_t *thread,
  58                     const char *author)
  59 {
  60     if (author == NULL)
  61         return;
  62
  63     if (g_hash_table_lookup_extended (thread->authors_hash,
  64                                       author, NULL, NULL))
  65         return;
  66
  67     g_hash_table_insert (thread->authors_hash, xstrdup (author), NULL);
  68
  69     if (thread->authors)
  70         thread->authors = talloc_asprintf (thread, "%s, %s",
  71                                            thread->authors,
  72                                            author);
  73     else
  74         thread->authors = talloc_strdup (thread, author);
  75 }
  76
  77 /*
  78  * move authors of matched messages in the thread to
  79  * the front of the authors list, but keep them in
  80  * existing order within their group
  81  */
  82 static void
  83 _thread_move_matched_author (notmuch_thread_t *thread,
  84                              const char *author)
  85 {
  86     char *authors_copy;
  87     char *current_author;
  88     char *last_pipe,*next_pipe;
  89     int idx,nm_start,author_len,authors_len;
  90
  91     if (thread->authors == NULL || author == NULL)
  92         return;
  93     if (thread->nonmatched_authors == NULL)
  94         thread->nonmatched_authors = thread->authors;
  95     author_len = strlen(author);
  96     authors_len = strlen(thread->authors);
  97     if (author_len == authors_len) {
  98         /* just one author */
  99         thread->nonmatched_authors += author_len;
 100         return;
 101     }
 102     current_author = strcasestr(thread->authors, author);
 103     if (current_author == NULL)
 104         return;
 105     /* how far inside the nonmatched authors is our author? */
 106     idx = current_author - thread->nonmatched_authors;
 107     if (idx < 0) {
 108         /* already among matched authors */
 109         return;
 110     }
 111     /* are there any authors in the list after our author? */
 112     if (thread->nonmatched_authors + author_len < thread->authors + authors_len) {
 113         /* we have to make changes, so let's get a temp copy */
 114         authors_copy = talloc_strdup(thread,thread->authors);
 115         /* nm_start is the offset into where the non-matched authors start */
 116         nm_start = thread->nonmatched_authors - thread->authors;
 117         /* copy this author and add the "| " - the if clause above tells us there's more */
 118         strncpy(thread->nonmatched_authors,author,author_len);
 119         strncpy(thread->nonmatched_authors+author_len,"| ",2);
 120         thread->nonmatched_authors += author_len+2;
 121         if (idx > 0) {
 122           /* we are actually moving authors around, not just changing the separator
 123            * first copy the authors that came BEFORE our author */
 124           strncpy(thread->nonmatched_authors, authors_copy+nm_start, idx-2);
 125           /* finally, if there are authors AFTER our author, copy those */
 126           if(author_len+nm_start+idx < authors_len) {
 127             strncpy(thread->nonmatched_authors + idx - 2,", ",2);
 128             strncpy(thread->nonmatched_authors + idx, authors_copy+nm_start + idx + author_len + 2,
 129                     authors_len - (nm_start + idx + author_len + 2));
 130           }
 131         }
 132         /* finally let's make sure there's just one '|' in the authors string */
 133         last_pipe = strchr(thread->authors,'|');
 134         while (last_pipe) {
 135             next_pipe = strchr(last_pipe+1,'|');
 136             if (next_pipe)
 137                 *last_pipe = ',';
 138             last_pipe = next_pipe;
 139         }
 140     } else {
 141         thread->nonmatched_authors += author_len;
 142         /* so now all authors are matched - let's remove the '|' */
 143         last_pipe = strchr(thread->authors,'|');
 144         if (last_pipe)
 145             *last_pipe = ',';
 146     }
 147     return;
 148 }
 149
 150 /* Add 'message' as a message that belongs to 'thread'.
 151  *
 152  * The 'thread' will talloc_steal the 'message' and hold onto a
 153  * reference to it.
 154  */
 155 static void
 156 _thread_add_message (notmuch_thread_t *thread,
 157                      notmuch_message_t *message)
 158 {
 159     notmuch_tags_t *tags;
 160     const char *tag;
 161     InternetAddressList *list = NULL;
 162     InternetAddress *address;
 163     const char *from, *author;
 164
 165     _notmuch_message_list_add_message (thread->message_list,
 166                                        talloc_steal (thread, message));
 167     thread->total_messages++;
 168
 169     g_hash_table_insert (thread->message_hash,
 170                          xstrdup (notmuch_message_get_message_id (message)),
 171                          message);
 172
 173     from = notmuch_message_get_header (message, "from");
 174     if (from)
 175         list = internet_address_list_parse_string (from);
 176
 177     if (list) {
 178         address = internet_address_list_get_address (list, 0);
 179         if (address) {
 180             author = internet_address_get_name (address);
 181             if (author == NULL) {
 182                 InternetAddressMailbox *mailbox;
 183                 mailbox = INTERNET_ADDRESS_MAILBOX (address);
 184                 author = internet_address_mailbox_get_addr (mailbox);
 185             }
 186             _thread_add_author (thread, author);
 187             notmuch_message_set_author (message, author);
 188         }
 189         g_object_unref (G_OBJECT (list));
 190     }
 191
 192     if (! thread->subject) {
 193         const char *subject;
 194         subject = notmuch_message_get_header (message, "subject");
 195         thread->subject = talloc_strdup (thread, subject ? subject : "");
 196     }
 197
 198     for (tags = notmuch_message_get_tags (message);
 199          notmuch_tags_valid (tags);
 200          notmuch_tags_move_to_next (tags))
 201     {
 202         tag = notmuch_tags_get (tags);
 203         g_hash_table_insert (thread->tags, xstrdup (tag), NULL);
 204     }
 205 }
 206
 207 static void
 208 _thread_set_subject_from_message (notmuch_thread_t *thread,
 209                                   notmuch_message_t *message)
 210 {
 211     const char *subject;
 212     const char *cleaned_subject;
 213
 214     subject = notmuch_message_get_header (message, "subject");
 215     if (! subject)
 216         return;
 217
 218     if ((strncasecmp (subject, "Re: ", 4) == 0) ||
 219         (strncasecmp (subject, "Aw: ", 4) == 0) ||
 220         (strncasecmp (subject, "Vs: ", 4) == 0) ||
 221         (strncasecmp (subject, "Sv: ", 4) == 0)) {
 222
 223         cleaned_subject = talloc_strndup (thread,
 224                                           subject + 4,
 225                                           strlen(subject) - 4);
 226     } else {
 227         cleaned_subject = talloc_strdup (thread, subject);
 228     }
 229
 230     if (thread->subject)
 231         talloc_free (thread->subject);
 232
 233     thread->subject = talloc_strdup (thread, cleaned_subject);
 234 }
 235
 236 static void
 237 _thread_add_matched_message (notmuch_thread_t *thread,
 238                              notmuch_message_t *message,
 239                              notmuch_sort_t sort)
 240 {
 241     time_t date;
 242     notmuch_message_t *hashed_message;
 243
 244     date = notmuch_message_get_date (message);
 245
 246     if (date < thread->oldest || ! thread->matched_messages)
 247         thread->oldest = date;
 248
 249     if (date > thread->newest || ! thread->matched_messages)
 250         thread->newest = date;
 251
 252     thread->matched_messages++;
 253
 254     if (g_hash_table_lookup_extended (thread->message_hash,
 255                             notmuch_message_get_message_id (message), NULL,
 256                             (void **) &hashed_message)) {
 257         notmuch_message_set_flag (hashed_message,
 258                                   NOTMUCH_MESSAGE_FLAG_MATCH, 1);
 259     }
 260     _thread_move_matched_author (thread,notmuch_message_get_author(hashed_message));
 261
 262     if ((sort == NOTMUCH_SORT_OLDEST_FIRST && date <= thread->newest) ||
 263         (sort != NOTMUCH_SORT_OLDEST_FIRST && date == thread->newest))
 264     {
 265         _thread_set_subject_from_message (thread, message);
 266     }
 267 }
 268
 269 static void
 270 _resolve_thread_relationships (unused (notmuch_thread_t *thread))
 271 {
 272     notmuch_message_node_t **prev, *node;
 273     notmuch_message_t *message, *parent;
 274     const char *in_reply_to;
 275
 276     prev = &thread->message_list->head;
 277     while ((node = *prev)) {
 278         message = node->message;
 279         in_reply_to = _notmuch_message_get_in_reply_to (message);
 280         if (in_reply_to && strlen (in_reply_to) &&
 281             g_hash_table_lookup_extended (thread->message_hash,
 282                                           in_reply_to, NULL,
 283                                           (void **) &parent))
 284         {
 285             *prev = node->next;
 286             if (thread->message_list->tail == &node->next)
 287                 thread->message_list->tail = prev;
 288             node->next = NULL;
 289             _notmuch_message_add_reply (parent, node);
 290         } else {
 291             prev = &((*prev)->next);
 292         }
 293     }
 294
 295     /* XXX: After scanning through the entire list looking for parents
 296      * via "In-Reply-To", we should do a second pass that looks at the
 297      * list of messages IDs in the "References" header instead. (And
 298      * for this the parent would be the "deepest" message of all the
 299      * messages found in the "References" list.)
 300      *
 301      * Doing this will allow messages and sub-threads to be positioned
 302      * correctly in the thread even when an intermediate message is
 303      * missing from the thread.
 304      */
 305 }
 306
 307 /* Create a new notmuch_thread_t object for the given thread ID,
 308  * treating any messages matching 'query_string' as "matched".
 309  *
 310  * Creating the thread will trigger two database searches. The first
 311  * is for all messages belonging to the thread, (to get the first
 312  * subject line, the total count of messages, and all authors). The
 313  * second search is for all messages that are in the thread and that
 314  * also match the given query_string. This is to allow for a separate
 315  * count of matched messages, and to allow a viewer to display these
 316  * messages differently.
 317  *
 318  * Here, 'ctx' is talloc context for the resulting thread object.
 319  *
 320  * This function returns NULL in the case of any error.
 321  */
 322 notmuch_thread_t *
 323 _notmuch_thread_create (void *ctx,
 324                         notmuch_database_t *notmuch,
 325                         const char *thread_id,
 326                         const char *query_string,
 327                         notmuch_sort_t sort)
 328 {
 329     notmuch_thread_t *thread;
 330     const char *thread_id_query_string;
 331     notmuch_query_t *thread_id_query;
 332
 333     notmuch_messages_t *messages;
 334     notmuch_message_t *message;
 335     notmuch_bool_t matched_is_subset_of_thread;
 336
 337     thread_id_query_string = talloc_asprintf (ctx, "thread:%s", thread_id);
 338     if (unlikely (query_string == NULL))
 339         return NULL;
 340
 341     /* Under normal circumstances we need to do two database
 342      * queries. One is for the thread itself (thread_id_query_string)
 343      * and the second is to determine which messages in that thread
 344      * match the original query (matched_query_string).
 345      *
 346      * But under two circumstances, we use only the
 347      * thread_id_query_string:
 348      *
 349      *  1. If the original query_string *is* just the thread
 350      *     specification.
 351      *
 352      *  2. If the original query_string matches all messages ("" or
 353      *     "*").
 354      *
 355      * In either of these cases, we can be more efficient by running
 356      * just the thread_id query (since we know all messages in the
 357      * thread will match the query_string).
 358      *
 359      * Beyond the performance advantage, in the second case, it's
 360      * important to not try to create a concatenated query because our
 361      * parser handles "" and "*" as special cases and will not do the
 362      * right thing with a query string of "* and thread:<foo>".
 363      **/
 364     matched_is_subset_of_thread = 1;
 365     if (strcmp (query_string, thread_id_query_string) == 0 ||
 366         strcmp (query_string, "") == 0 ||
 367         strcmp (query_string, "*") == 0)
 368     {
 369         matched_is_subset_of_thread = 0;
 370     }
 371
 372     thread_id_query = notmuch_query_create (notmuch, thread_id_query_string);
 373     if (unlikely (thread_id_query == NULL))
 374         return NULL;
 375
 376     thread = talloc (ctx, notmuch_thread_t);
 377     if (unlikely (thread == NULL))
 378         return NULL;
 379
 380     talloc_set_destructor (thread, _notmuch_thread_destructor);
 381
 382     thread->notmuch = notmuch;
 383     thread->thread_id = talloc_strdup (thread, thread_id);
 384     thread->subject = NULL;
 385     thread->authors_hash = g_hash_table_new_full (g_str_hash, g_str_equal,
 386                                                   free, NULL);
 387     thread->authors = NULL;
 388     thread->nonmatched_authors = NULL;
 389     thread->tags = g_hash_table_new_full (g_str_hash, g_str_equal,
 390                                           free, NULL);
 391
 392     thread->message_list = _notmuch_message_list_create (thread);
 393     if (unlikely (thread->message_list == NULL))
 394         return NULL;
 395
 396     thread->message_hash = g_hash_table_new_full (g_str_hash, g_str_equal,
 397                                                   free, NULL);
 398
 399     thread->total_messages = 0;
 400     thread->matched_messages = 0;
 401     thread->oldest = 0;
 402     thread->newest = 0;
 403
 404     notmuch_query_set_sort (thread_id_query, NOTMUCH_SORT_OLDEST_FIRST);
 405
 406     for (messages = notmuch_query_search_messages (thread_id_query);
 407          notmuch_messages_valid (messages);
 408          notmuch_messages_move_to_next (messages))
 409     {
 410         message = notmuch_messages_get (messages);
 411
 412         _thread_add_message (thread, message);
 413
 414         if (! matched_is_subset_of_thread)
 415             _thread_add_matched_message (thread, message, sort);
 416
 417         _notmuch_message_close (message);
 418     }
 419
 420     notmuch_query_destroy (thread_id_query);
 421
 422     if (matched_is_subset_of_thread)
 423     {
 424         const char *matched_query_string;
 425         notmuch_query_t *matched_query;
 426
 427         matched_query_string = talloc_asprintf (ctx, "%s AND (%s)",
 428                                                 thread_id_query_string,
 429                                                 query_string);
 430         if (unlikely (matched_query_string == NULL))
 431             return NULL;
 432
 433         matched_query = notmuch_query_create (notmuch, matched_query_string);
 434         if (unlikely (matched_query == NULL))
 435             return NULL;
 436
 437         for (messages = notmuch_query_search_messages (matched_query);
 438              notmuch_messages_valid (messages);
 439              notmuch_messages_move_to_next (messages))
 440         {
 441             message = notmuch_messages_get (messages);
 442             _thread_add_matched_message (thread, message, sort);
 443             _notmuch_message_close (message);
 444         }
 445
 446         notmuch_query_destroy (matched_query);
 447     }
 448
 449     _resolve_thread_relationships (thread);
 450
 451     return thread;
 452 }
 453
 454 notmuch_messages_t *
 455 notmuch_thread_get_toplevel_messages (notmuch_thread_t *thread)
 456 {
 457     return _notmuch_messages_create (thread->message_list);
 458 }
 459
 460 const char *
 461 notmuch_thread_get_thread_id (notmuch_thread_t *thread)
 462 {
 463     return thread->thread_id;
 464 }
 465
 466 int
 467 notmuch_thread_get_total_messages (notmuch_thread_t *thread)
 468 {
 469     return thread->total_messages;
 470 }
 471
 472 int
 473 notmuch_thread_get_matched_messages (notmuch_thread_t *thread)
 474 {
 475     return thread->matched_messages;
 476 }
 477
 478 const char *
 479 notmuch_thread_get_authors (notmuch_thread_t *thread)
 480 {
 481     return thread->authors;
 482 }
 483
 484 const char *
 485 notmuch_thread_get_subject (notmuch_thread_t *thread)
 486 {
 487     return thread->subject;
 488 }
 489
 490 time_t
 491 notmuch_thread_get_oldest_date (notmuch_thread_t *thread)
 492 {
 493     return thread->oldest;
 494 }
 495
 496 time_t
 497 notmuch_thread_get_newest_date (notmuch_thread_t *thread)
 498 {
 499     return thread->newest;
 500 }
 501
 502 notmuch_tags_t *
 503 notmuch_thread_get_tags (notmuch_thread_t *thread)
 504 {
 505     notmuch_tags_t *tags;
 506     GList *keys, *l;
 507
 508     tags = _notmuch_tags_create (thread);
 509     if (unlikely (tags == NULL))
 510         return NULL;
 511
 512     keys = g_hash_table_get_keys (thread->tags);
 513
 514     for (l = keys; l; l = l->next)
 515         _notmuch_tags_add_tag (tags, (char *) l->data);
 516
 517     g_list_free (keys);
 518
 519     _notmuch_tags_prepare_iterator (tags);
 520
 521     return tags;
 522 }
 523
 524 void
 525 notmuch_thread_destroy (notmuch_thread_t *thread)
 526 {
 527     talloc_free (thread);
 528 }