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 <gmime/gmime.h>
  25 #include <glib.h> /* GHashTable */
  26
  27 struct visible _notmuch_thread {
  28     notmuch_database_t *notmuch;
  29     char *thread_id;
  30     char *subject;
  31     GHashTable *authors_hash;
  32     GPtrArray *authors_array;
  33     GHashTable *matched_authors_hash;
  34     GPtrArray *matched_authors_array;
  35     char *authors;
  36     GHashTable *tags;
  37
  38     /* All messages, oldest first. */
  39     notmuch_message_list_t *message_list;
  40     /* Top-level messages, oldest first. */
  41     notmuch_message_list_t *toplevel_list;
  42
  43     GHashTable *message_hash;
  44     int total_messages;
  45     int matched_messages;
  46     time_t oldest;
  47     time_t newest;
  48 };
  49
  50 static int
  51 _notmuch_thread_destructor (notmuch_thread_t *thread)
  52 {
  53     g_hash_table_unref (thread->authors_hash);
  54     g_hash_table_unref (thread->matched_authors_hash);
  55     g_hash_table_unref (thread->tags);
  56     g_hash_table_unref (thread->message_hash);
  57
  58     if (thread->authors_array) {
  59         g_ptr_array_free (thread->authors_array, TRUE);
  60         thread->authors_array = NULL;
  61     }
  62
  63     if (thread->matched_authors_array) {
  64         g_ptr_array_free (thread->matched_authors_array, TRUE);
  65         thread->matched_authors_array = NULL;
  66     }
  67
  68     return 0;
  69 }
  70
  71 /* Add each author of the thread to the thread's authors_hash and to
  72  * the thread's authors_array. */
  73 static void
  74 _thread_add_author (notmuch_thread_t *thread,
  75                     const char *author)
  76 {
  77     char *author_copy;
  78
  79     if (author == NULL)
  80         return;
  81
  82     if (g_hash_table_lookup_extended (thread->authors_hash,
  83                                       author, NULL, NULL))
  84         return;
  85
  86     author_copy = talloc_strdup (thread, author);
  87
  88     g_hash_table_insert (thread->authors_hash, author_copy, NULL);
  89
  90     g_ptr_array_add (thread->authors_array, author_copy);
  91 }
  92
  93 /* Add each matched author of the thread to the thread's
  94  * matched_authors_hash and to the thread's matched_authors_array. */
  95 static void
  96 _thread_add_matched_author (notmuch_thread_t *thread,
  97                             const char *author)
  98 {
  99     char *author_copy;
 100
 101     if (author == NULL)
 102         return;
 103
 104     if (g_hash_table_lookup_extended (thread->matched_authors_hash,
 105                                       author, NULL, NULL))
 106         return;
 107
 108     author_copy = talloc_strdup (thread, author);
 109
 110     g_hash_table_insert (thread->matched_authors_hash, author_copy, NULL);
 111
 112     g_ptr_array_add (thread->matched_authors_array, author_copy);
 113 }
 114
 115 /* Construct an authors string from matched_authors_array and
 116  * authors_array. The string contains matched authors first, then
 117  * non-matched authors (with the two groups separated by '|'). Within
 118  * each group, authors are listed in date order. */
 119 static void
 120 _resolve_thread_authors_string (notmuch_thread_t *thread)
 121 {
 122     unsigned int i;
 123     char *author;
 124     int first_non_matched_author = 1;
 125
 126     /* First, list all matched authors in date order. */
 127     for (i = 0; i < thread->matched_authors_array->len; i++) {
 128         author = (char *) g_ptr_array_index (thread->matched_authors_array, i);
 129         if (thread->authors)
 130             thread->authors = talloc_asprintf (thread, "%s, %s",
 131                                                thread->authors,
 132                                                author);
 133         else
 134             thread->authors = author;
 135     }
 136
 137     /* Next, append any non-matched authors that haven't already appeared. */
 138     for (i = 0; i < thread->authors_array->len; i++) {
 139         author = (char *) g_ptr_array_index (thread->authors_array, i);
 140         if (g_hash_table_lookup_extended (thread->matched_authors_hash,
 141                                           author, NULL, NULL))
 142             continue;
 143         if (first_non_matched_author) {
 144             thread->authors = talloc_asprintf (thread, "%s| %s",
 145                                                thread->authors,
 146                                                author);
 147         } else {
 148             thread->authors = talloc_asprintf (thread, "%s, %s",
 149                                                thread->authors,
 150                                                author);
 151         }
 152
 153         first_non_matched_author = 0;
 154     }
 155
 156     g_ptr_array_free (thread->authors_array, TRUE);
 157     thread->authors_array = NULL;
 158     g_ptr_array_free (thread->matched_authors_array, TRUE);
 159     thread->matched_authors_array = NULL;
 160 }
 161
 162 /* clean up the ugly "Lastname, Firstname" format that some mail systems
 163  * (most notably, Exchange) are creating to be "Firstname Lastname"
 164  * To make sure that we don't change other potential situations where a
 165  * comma is in the name, we check that we match one of these patterns
 166  * "Last, First" <first.last@company.com>
 167  * "Last, First MI" <first.mi.last@company.com>
 168  */
 169 static char *
 170 _thread_cleanup_author (notmuch_thread_t *thread,
 171                         const char *author, const char *from)
 172 {
 173     char *clean_author,*test_author;
 174     const char *comma;
 175     char *blank;
 176     int fname,lname;
 177
 178     if (author == NULL)
 179         return NULL;
 180     clean_author = talloc_strdup(thread, author);
 181     if (clean_author == NULL)
 182         return NULL;
 183     /* check if there's a comma in the name and that there's a
 184      * component of the name behind it (so the name doesn't end with
 185      * the comma - in which case the string that strchr finds is just
 186      * one character long ",\0").
 187      * Otherwise just return the copy of the original author name that
 188      * we just made*/
 189     comma = strchr(author,',');
 190     if (comma && strlen(comma) > 1) {
 191         /* let's assemble what we think is the correct name */
 192         lname = comma - author;
 193
 194         /* Skip all the spaces after the comma */
 195         fname = strlen(author) - lname - 1;
 196         comma += 1;
 197         while (*comma == ' ') {
 198             fname -= 1;
 199             comma += 1;
 200         }
 201         strncpy(clean_author, comma, fname);
 202
 203         *(clean_author+fname) = ' ';
 204         strncpy(clean_author + fname + 1, author, lname);
 205         *(clean_author+fname+1+lname) = '\0';
 206         /* make a temporary copy and see if it matches the email */
 207         test_author = talloc_strdup(thread,clean_author);
 208
 209         blank=strchr(test_author,' ');
 210         while (blank != NULL) {
 211             *blank = '.';
 212             blank=strchr(test_author,' ');
 213         }
 214         if (strcasestr(from, test_author) == NULL)
 215             /* we didn't identify this as part of the email address
 216             * so let's punt and return the original author */
 217             strcpy (clean_author, author);
 218     }
 219     return clean_author;
 220 }
 221
 222 /* Add 'message' as a message that belongs to 'thread'.
 223  *
 224  * The 'thread' will talloc_steal the 'message' and hold onto a
 225  * reference to it.
 226  */
 227 static void
 228 _thread_add_message (notmuch_thread_t *thread,
 229                      notmuch_message_t *message,
 230                      notmuch_string_list_t *exclude_terms,
 231                      notmuch_exclude_t omit_exclude)
 232 {
 233     notmuch_tags_t *tags;
 234     const char *tag;
 235     InternetAddressList *list = NULL;
 236     InternetAddress *address;
 237     const char *from, *author;
 238     char *clean_author;
 239     notmuch_bool_t message_excluded = FALSE;
 240
 241     for (tags = notmuch_message_get_tags (message);
 242          notmuch_tags_valid (tags);
 243          notmuch_tags_move_to_next (tags))
 244     {
 245         tag = notmuch_tags_get (tags);
 246         /* Is message excluded? */
 247         for (notmuch_string_node_t *term = exclude_terms->head;
 248              term != NULL;
 249              term = term->next)
 250         {
 251             /* We ignore initial 'K'. */
 252             if (strcmp(tag, (term->string + 1)) == 0) {
 253                 message_excluded = TRUE;
 254                 break;
 255             }
 256         }
 257     }
 258
 259     if (message_excluded && omit_exclude == NOTMUCH_EXCLUDE_ALL)
 260         return;
 261
 262     _notmuch_message_list_add_message (thread->message_list,
 263                                        talloc_steal (thread, message));
 264     thread->total_messages++;
 265
 266     g_hash_table_insert (thread->message_hash,
 267                          xstrdup (notmuch_message_get_message_id (message)),
 268                          message);
 269
 270     from = notmuch_message_get_header (message, "from");
 271     if (from)
 272         list = internet_address_list_parse_string (from);
 273
 274     if (list) {
 275         address = internet_address_list_get_address (list, 0);
 276         if (address) {
 277             author = internet_address_get_name (address);
 278             if (author == NULL) {
 279                 InternetAddressMailbox *mailbox;
 280                 mailbox = INTERNET_ADDRESS_MAILBOX (address);
 281                 author = internet_address_mailbox_get_addr (mailbox);
 282             }
 283             clean_author = _thread_cleanup_author (thread, author, from);
 284             _thread_add_author (thread, clean_author);
 285             notmuch_message_set_author (message, clean_author);
 286         }
 287         g_object_unref (G_OBJECT (list));
 288     }
 289
 290     if (! thread->subject) {
 291         const char *subject;
 292         subject = notmuch_message_get_header (message, "subject");
 293         thread->subject = talloc_strdup (thread, subject ? subject : "");
 294     }
 295
 296     for (tags = notmuch_message_get_tags (message);
 297          notmuch_tags_valid (tags);
 298          notmuch_tags_move_to_next (tags))
 299     {
 300         tag = notmuch_tags_get (tags);
 301         g_hash_table_insert (thread->tags, xstrdup (tag), NULL);
 302     }
 303
 304     /* Mark excluded messages. */
 305     if (message_excluded)
 306         notmuch_message_set_flag (message, NOTMUCH_MESSAGE_FLAG_EXCLUDED, TRUE);
 307 }
 308
 309 static void
 310 _thread_set_subject_from_message (notmuch_thread_t *thread,
 311                                   notmuch_message_t *message)
 312 {
 313     const char *subject;
 314     const char *cleaned_subject;
 315
 316     subject = notmuch_message_get_header (message, "subject");
 317     if (! subject)
 318         return;
 319
 320     if ((strncasecmp (subject, "Re: ", 4) == 0) ||
 321         (strncasecmp (subject, "Aw: ", 4) == 0) ||
 322         (strncasecmp (subject, "Vs: ", 4) == 0) ||
 323         (strncasecmp (subject, "Sv: ", 4) == 0)) {
 324
 325         cleaned_subject = talloc_strndup (thread,
 326                                           subject + 4,
 327                                           strlen(subject) - 4);
 328     } else {
 329         cleaned_subject = talloc_strdup (thread, subject);
 330     }
 331
 332     if (thread->subject)
 333         talloc_free (thread->subject);
 334
 335     thread->subject = talloc_strdup (thread, cleaned_subject);
 336 }
 337
 338 /* Add a message to this thread which is known to match the original
 339  * search specification. The 'sort' parameter controls whether the
 340  * oldest or newest matching subject is applied to the thread as a
 341  * whole. */
 342 static void
 343 _thread_add_matched_message (notmuch_thread_t *thread,
 344                              notmuch_message_t *message,
 345                              notmuch_sort_t sort)
 346 {
 347     time_t date;
 348     notmuch_message_t *hashed_message;
 349
 350     date = notmuch_message_get_date (message);
 351
 352     if (date < thread->oldest || ! thread->matched_messages) {
 353         thread->oldest = date;
 354         if (sort == NOTMUCH_SORT_OLDEST_FIRST)
 355             _thread_set_subject_from_message (thread, message);
 356     }
 357
 358     if (date > thread->newest || ! thread->matched_messages) {
 359         thread->newest = date;
 360         if (sort != NOTMUCH_SORT_OLDEST_FIRST)
 361             _thread_set_subject_from_message (thread, message);
 362     }
 363
 364     if (!notmuch_message_get_flag (message, NOTMUCH_MESSAGE_FLAG_EXCLUDED))
 365         thread->matched_messages++;
 366
 367     if (g_hash_table_lookup_extended (thread->message_hash,
 368                             notmuch_message_get_message_id (message), NULL,
 369                             (void **) &hashed_message)) {
 370         notmuch_message_set_flag (hashed_message,
 371                                   NOTMUCH_MESSAGE_FLAG_MATCH, 1);
 372     }
 373
 374     _thread_add_matched_author (thread, notmuch_message_get_author (hashed_message));
 375 }
 376
 377 static void
 378 _resolve_thread_relationships (notmuch_thread_t *thread)
 379 {
 380     notmuch_message_node_t *node;
 381     notmuch_message_t *message, *parent;
 382     const char *in_reply_to;
 383
 384     for (node = thread->message_list->head; node; node = node->next) {
 385         message = node->message;
 386         in_reply_to = _notmuch_message_get_in_reply_to (message);
 387         if (in_reply_to && strlen (in_reply_to) &&
 388             g_hash_table_lookup_extended (thread->message_hash,
 389                                           in_reply_to, NULL,
 390                                           (void **) &parent))
 391             _notmuch_message_add_reply (parent, message);
 392         else
 393             _notmuch_message_list_add_message (thread->toplevel_list, message);
 394     }
 395
 396     /* XXX: After scanning through the entire list looking for parents
 397      * via "In-Reply-To", we should do a second pass that looks at the
 398      * list of messages IDs in the "References" header instead. (And
 399      * for this the parent would be the "deepest" message of all the
 400      * messages found in the "References" list.)
 401      *
 402      * Doing this will allow messages and sub-threads to be positioned
 403      * correctly in the thread even when an intermediate message is
 404      * missing from the thread.
 405      */
 406 }
 407
 408 /* Create a new notmuch_thread_t object by finding the thread
 409  * containing the message with the given doc ID, treating any messages
 410  * contained in match_set as "matched".  Remove all messages in the
 411  * thread from match_set.
 412  *
 413  * Creating the thread will perform a database search to get all
 414  * messages belonging to the thread and will get the first subject
 415  * line, the total count of messages, and all authors in the thread.
 416  * Each message in the thread is checked against match_set to allow
 417  * for a separate count of matched messages, and to allow a viewer to
 418  * display these messages differently.
 419  *
 420  * Here, 'ctx' is talloc context for the resulting thread object.
 421  *
 422  * This function returns NULL in the case of any error.
 423  */
 424 notmuch_thread_t *
 425 _notmuch_thread_create (void *ctx,
 426                         notmuch_database_t *notmuch,
 427                         unsigned int seed_doc_id,
 428                         notmuch_doc_id_set_t *match_set,
 429                         notmuch_string_list_t *exclude_terms,
 430                         notmuch_exclude_t omit_excluded,
 431                         notmuch_sort_t sort)
 432 {
 433     void *local = talloc_new (ctx);
 434     notmuch_thread_t *thread = NULL;
 435     notmuch_message_t *seed_message;
 436     const char *thread_id;
 437     char *thread_id_query_string;
 438     notmuch_query_t *thread_id_query;
 439
 440     notmuch_messages_t *messages;
 441     notmuch_message_t *message;
 442
 443     seed_message = _notmuch_message_create (local, notmuch, seed_doc_id, NULL);
 444     if (! seed_message)
 445         INTERNAL_ERROR ("Thread seed message %u does not exist", seed_doc_id);
 446
 447     thread_id = notmuch_message_get_thread_id (seed_message);
 448     thread_id_query_string = talloc_asprintf (local, "thread:%s", thread_id);
 449     if (unlikely (thread_id_query_string == NULL))
 450         goto DONE;
 451
 452     thread_id_query = talloc_steal (
 453         local, notmuch_query_create (notmuch, thread_id_query_string));
 454     if (unlikely (thread_id_query == NULL))
 455         goto DONE;
 456
 457     thread = talloc (local, notmuch_thread_t);
 458     if (unlikely (thread == NULL))
 459         goto DONE;
 460
 461     talloc_set_destructor (thread, _notmuch_thread_destructor);
 462
 463     thread->notmuch = notmuch;
 464     thread->thread_id = talloc_strdup (thread, thread_id);
 465     thread->subject = NULL;
 466     thread->authors_hash = g_hash_table_new_full (g_str_hash, g_str_equal,
 467                                                   NULL, NULL);
 468     thread->authors_array = g_ptr_array_new ();
 469     thread->matched_authors_hash = g_hash_table_new_full (g_str_hash,
 470                                                           g_str_equal,
 471                                                           NULL, NULL);
 472     thread->matched_authors_array = g_ptr_array_new ();
 473     thread->authors = NULL;
 474     thread->tags = g_hash_table_new_full (g_str_hash, g_str_equal,
 475                                           free, NULL);
 476
 477     thread->message_list = _notmuch_message_list_create (thread);
 478     thread->toplevel_list = _notmuch_message_list_create (thread);
 479     if (unlikely (thread->message_list == NULL ||
 480                   thread->toplevel_list == NULL)) {
 481         thread = NULL;
 482         goto DONE;
 483     }
 484
 485     thread->message_hash = g_hash_table_new_full (g_str_hash, g_str_equal,
 486                                                   free, NULL);
 487
 488     thread->total_messages = 0;
 489     thread->matched_messages = 0;
 490     thread->oldest = 0;
 491     thread->newest = 0;
 492
 493     /* We use oldest-first order unconditionally here to obtain the
 494      * proper author ordering for the thread. The 'sort' parameter
 495      * passed to this function is used only to indicate whether the
 496      * oldest or newest subject is desired. */
 497     notmuch_query_set_sort (thread_id_query, NOTMUCH_SORT_OLDEST_FIRST);
 498
 499     for (messages = notmuch_query_search_messages (thread_id_query);
 500          notmuch_messages_valid (messages);
 501          notmuch_messages_move_to_next (messages))
 502     {
 503         unsigned int doc_id;
 504
 505         message = notmuch_messages_get (messages);
 506         doc_id = _notmuch_message_get_doc_id (message);
 507         if (doc_id == seed_doc_id)
 508             message = seed_message;
 509
 510         _thread_add_message (thread, message, exclude_terms, omit_excluded);
 511
 512         if ( _notmuch_doc_id_set_contains (match_set, doc_id)) {
 513             _notmuch_doc_id_set_remove (match_set, doc_id);
 514             _thread_add_matched_message (thread, message, sort);
 515         }
 516
 517         _notmuch_message_close (message);
 518     }
 519
 520     _resolve_thread_authors_string (thread);
 521
 522     _resolve_thread_relationships (thread);
 523
 524     /* Commit to returning thread. */
 525     talloc_steal (ctx, thread);
 526
 527   DONE:
 528     talloc_free (local);
 529     return thread;
 530 }
 531
 532 notmuch_messages_t *
 533 notmuch_thread_get_toplevel_messages (notmuch_thread_t *thread)
 534 {
 535     return _notmuch_messages_create (thread->toplevel_list);
 536 }
 537
 538 notmuch_messages_t *
 539 notmuch_thread_get_messages (notmuch_thread_t *thread)
 540 {
 541     return _notmuch_messages_create (thread->message_list);
 542 }
 543
 544 const char *
 545 notmuch_thread_get_thread_id (notmuch_thread_t *thread)
 546 {
 547     return thread->thread_id;
 548 }
 549
 550 int
 551 notmuch_thread_get_total_messages (notmuch_thread_t *thread)
 552 {
 553     return thread->total_messages;
 554 }
 555
 556 int
 557 notmuch_thread_get_matched_messages (notmuch_thread_t *thread)
 558 {
 559     return thread->matched_messages;
 560 }
 561
 562 const char *
 563 notmuch_thread_get_authors (notmuch_thread_t *thread)
 564 {
 565     return thread->authors;
 566 }
 567
 568 const char *
 569 notmuch_thread_get_subject (notmuch_thread_t *thread)
 570 {
 571     return thread->subject;
 572 }
 573
 574 time_t
 575 notmuch_thread_get_oldest_date (notmuch_thread_t *thread)
 576 {
 577     return thread->oldest;
 578 }
 579
 580 time_t
 581 notmuch_thread_get_newest_date (notmuch_thread_t *thread)
 582 {
 583     return thread->newest;
 584 }
 585
 586 notmuch_tags_t *
 587 notmuch_thread_get_tags (notmuch_thread_t *thread)
 588 {
 589     notmuch_string_list_t *tags;
 590     GList *keys, *l;
 591
 592     tags = _notmuch_string_list_create (thread);
 593     if (unlikely (tags == NULL))
 594         return NULL;
 595
 596     keys = g_hash_table_get_keys (thread->tags);
 597
 598     for (l = keys; l; l = l->next)
 599         _notmuch_string_list_append (tags, (char *) l->data);
 600
 601     g_list_free (keys);
 602
 603     _notmuch_string_list_sort (tags);
 604
 605     return _notmuch_tags_create (thread, tags);
 606 }
 607
 608 void
 609 notmuch_thread_destroy (notmuch_thread_t *thread)
 610 {
 611     talloc_free (thread);
 612 }