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 {
 232     notmuch_tags_t *tags;
 233     const char *tag;
 234     InternetAddressList *list = NULL;
 235     InternetAddress *address;
 236     const char *from, *author;
 237     char *clean_author;
 238
 239     _notmuch_message_list_add_message (thread->message_list,
 240                                        talloc_steal (thread, message));
 241     thread->total_messages++;
 242
 243     g_hash_table_insert (thread->message_hash,
 244                          xstrdup (notmuch_message_get_message_id (message)),
 245                          message);
 246
 247     from = notmuch_message_get_header (message, "from");
 248     if (from)
 249         list = internet_address_list_parse_string (from);
 250
 251     if (list) {
 252         address = internet_address_list_get_address (list, 0);
 253         if (address) {
 254             author = internet_address_get_name (address);
 255             if (author == NULL) {
 256                 InternetAddressMailbox *mailbox;
 257                 mailbox = INTERNET_ADDRESS_MAILBOX (address);
 258                 author = internet_address_mailbox_get_addr (mailbox);
 259             }
 260             clean_author = _thread_cleanup_author (thread, author, from);
 261             _thread_add_author (thread, clean_author);
 262             notmuch_message_set_author (message, clean_author);
 263         }
 264         g_object_unref (G_OBJECT (list));
 265     }
 266
 267     if (! thread->subject) {
 268         const char *subject;
 269         subject = notmuch_message_get_header (message, "subject");
 270         thread->subject = talloc_strdup (thread, subject ? subject : "");
 271     }
 272
 273     for (tags = notmuch_message_get_tags (message);
 274          notmuch_tags_valid (tags);
 275          notmuch_tags_move_to_next (tags))
 276     {
 277         tag = notmuch_tags_get (tags);
 278         /* Mark excluded messages. */
 279         for (notmuch_string_node_t *term = exclude_terms->head; term;
 280              term = term->next) {
 281             /* We ignore initial 'K'. */
 282             if (strcmp(tag, (term->string + 1)) == 0) {
 283                 notmuch_message_set_flag (message, NOTMUCH_MESSAGE_FLAG_EXCLUDED, TRUE);
 284                 break;
 285             }
 286         }
 287         g_hash_table_insert (thread->tags, xstrdup (tag), NULL);
 288     }
 289 }
 290
 291 static void
 292 _thread_set_subject_from_message (notmuch_thread_t *thread,
 293                                   notmuch_message_t *message)
 294 {
 295     const char *subject;
 296     const char *cleaned_subject;
 297
 298     subject = notmuch_message_get_header (message, "subject");
 299     if (! subject)
 300         return;
 301
 302     if ((strncasecmp (subject, "Re: ", 4) == 0) ||
 303         (strncasecmp (subject, "Aw: ", 4) == 0) ||
 304         (strncasecmp (subject, "Vs: ", 4) == 0) ||
 305         (strncasecmp (subject, "Sv: ", 4) == 0)) {
 306
 307         cleaned_subject = talloc_strndup (thread,
 308                                           subject + 4,
 309                                           strlen(subject) - 4);
 310     } else {
 311         cleaned_subject = talloc_strdup (thread, subject);
 312     }
 313
 314     if (thread->subject)
 315         talloc_free (thread->subject);
 316
 317     thread->subject = talloc_strdup (thread, cleaned_subject);
 318 }
 319
 320 /* Add a message to this thread which is known to match the original
 321  * search specification. The 'sort' parameter controls whether the
 322  * oldest or newest matching subject is applied to the thread as a
 323  * whole. */
 324 static void
 325 _thread_add_matched_message (notmuch_thread_t *thread,
 326                              notmuch_message_t *message,
 327                              notmuch_sort_t sort)
 328 {
 329     time_t date;
 330     notmuch_message_t *hashed_message;
 331
 332     date = notmuch_message_get_date (message);
 333
 334     if (date < thread->oldest || ! thread->matched_messages) {
 335         thread->oldest = date;
 336         if (sort == NOTMUCH_SORT_OLDEST_FIRST)
 337             _thread_set_subject_from_message (thread, message);
 338     }
 339
 340     if (date > thread->newest || ! thread->matched_messages) {
 341         thread->newest = date;
 342         if (sort != NOTMUCH_SORT_OLDEST_FIRST)
 343             _thread_set_subject_from_message (thread, message);
 344     }
 345
 346     if (!notmuch_message_get_flag (message, NOTMUCH_MESSAGE_FLAG_EXCLUDED))
 347         thread->matched_messages++;
 348
 349     if (g_hash_table_lookup_extended (thread->message_hash,
 350                             notmuch_message_get_message_id (message), NULL,
 351                             (void **) &hashed_message)) {
 352         notmuch_message_set_flag (hashed_message,
 353                                   NOTMUCH_MESSAGE_FLAG_MATCH, 1);
 354     }
 355
 356     _thread_add_matched_author (thread, notmuch_message_get_author (hashed_message));
 357 }
 358
 359 static void
 360 _resolve_thread_relationships (notmuch_thread_t *thread)
 361 {
 362     notmuch_message_node_t *node;
 363     notmuch_message_t *message, *parent;
 364     const char *in_reply_to;
 365
 366     for (node = thread->message_list->head; node; node = node->next) {
 367         message = node->message;
 368         in_reply_to = _notmuch_message_get_in_reply_to (message);
 369         if (in_reply_to && strlen (in_reply_to) &&
 370             g_hash_table_lookup_extended (thread->message_hash,
 371                                           in_reply_to, NULL,
 372                                           (void **) &parent))
 373             _notmuch_message_add_reply (parent, message);
 374         else
 375             _notmuch_message_list_add_message (thread->toplevel_list, message);
 376     }
 377
 378     /* XXX: After scanning through the entire list looking for parents
 379      * via "In-Reply-To", we should do a second pass that looks at the
 380      * list of messages IDs in the "References" header instead. (And
 381      * for this the parent would be the "deepest" message of all the
 382      * messages found in the "References" list.)
 383      *
 384      * Doing this will allow messages and sub-threads to be positioned
 385      * correctly in the thread even when an intermediate message is
 386      * missing from the thread.
 387      */
 388 }
 389
 390 /* Create a new notmuch_thread_t object by finding the thread
 391  * containing the message with the given doc ID, treating any messages
 392  * contained in match_set as "matched".  Remove all messages in the
 393  * thread from match_set.
 394  *
 395  * Creating the thread will perform a database search to get all
 396  * messages belonging to the thread and will get the first subject
 397  * line, the total count of messages, and all authors in the thread.
 398  * Each message in the thread is checked against match_set to allow
 399  * for a separate count of matched messages, and to allow a viewer to
 400  * display these messages differently.
 401  *
 402  * Here, 'ctx' is talloc context for the resulting thread object.
 403  *
 404  * This function returns NULL in the case of any error.
 405  */
 406 notmuch_thread_t *
 407 _notmuch_thread_create (void *ctx,
 408                         notmuch_database_t *notmuch,
 409                         unsigned int seed_doc_id,
 410                         notmuch_doc_id_set_t *match_set,
 411                         notmuch_string_list_t *exclude_terms,
 412                         notmuch_sort_t sort)
 413 {
 414     void *local = talloc_new (ctx);
 415     notmuch_thread_t *thread = NULL;
 416     notmuch_message_t *seed_message;
 417     const char *thread_id;
 418     char *thread_id_query_string;
 419     notmuch_query_t *thread_id_query;
 420
 421     notmuch_messages_t *messages;
 422     notmuch_message_t *message;
 423
 424     seed_message = _notmuch_message_create (local, notmuch, seed_doc_id, NULL);
 425     if (! seed_message)
 426         INTERNAL_ERROR ("Thread seed message %u does not exist", seed_doc_id);
 427
 428     thread_id = notmuch_message_get_thread_id (seed_message);
 429     thread_id_query_string = talloc_asprintf (local, "thread:%s", thread_id);
 430     if (unlikely (thread_id_query_string == NULL))
 431         goto DONE;
 432
 433     thread_id_query = talloc_steal (
 434         local, notmuch_query_create (notmuch, thread_id_query_string));
 435     if (unlikely (thread_id_query == NULL))
 436         goto DONE;
 437
 438     thread = talloc (local, notmuch_thread_t);
 439     if (unlikely (thread == NULL))
 440         goto DONE;
 441
 442     talloc_set_destructor (thread, _notmuch_thread_destructor);
 443
 444     thread->notmuch = notmuch;
 445     thread->thread_id = talloc_strdup (thread, thread_id);
 446     thread->subject = NULL;
 447     thread->authors_hash = g_hash_table_new_full (g_str_hash, g_str_equal,
 448                                                   NULL, NULL);
 449     thread->authors_array = g_ptr_array_new ();
 450     thread->matched_authors_hash = g_hash_table_new_full (g_str_hash,
 451                                                           g_str_equal,
 452                                                           NULL, NULL);
 453     thread->matched_authors_array = g_ptr_array_new ();
 454     thread->authors = NULL;
 455     thread->tags = g_hash_table_new_full (g_str_hash, g_str_equal,
 456                                           free, NULL);
 457
 458     thread->message_list = _notmuch_message_list_create (thread);
 459     thread->toplevel_list = _notmuch_message_list_create (thread);
 460     if (unlikely (thread->message_list == NULL ||
 461                   thread->toplevel_list == NULL)) {
 462         thread = NULL;
 463         goto DONE;
 464     }
 465
 466     thread->message_hash = g_hash_table_new_full (g_str_hash, g_str_equal,
 467                                                   free, NULL);
 468
 469     thread->total_messages = 0;
 470     thread->matched_messages = 0;
 471     thread->oldest = 0;
 472     thread->newest = 0;
 473
 474     /* We use oldest-first order unconditionally here to obtain the
 475      * proper author ordering for the thread. The 'sort' parameter
 476      * passed to this function is used only to indicate whether the
 477      * oldest or newest subject is desired. */
 478     notmuch_query_set_sort (thread_id_query, NOTMUCH_SORT_OLDEST_FIRST);
 479
 480     for (messages = notmuch_query_search_messages (thread_id_query);
 481          notmuch_messages_valid (messages);
 482          notmuch_messages_move_to_next (messages))
 483     {
 484         unsigned int doc_id;
 485
 486         message = notmuch_messages_get (messages);
 487         doc_id = _notmuch_message_get_doc_id (message);
 488         if (doc_id == seed_doc_id)
 489             message = seed_message;
 490
 491         _thread_add_message (thread, message, exclude_terms);
 492
 493         if ( _notmuch_doc_id_set_contains (match_set, doc_id)) {
 494             _notmuch_doc_id_set_remove (match_set, doc_id);
 495             _thread_add_matched_message (thread, message, sort);
 496         }
 497
 498         _notmuch_message_close (message);
 499     }
 500
 501     _resolve_thread_authors_string (thread);
 502
 503     _resolve_thread_relationships (thread);
 504
 505     /* Commit to returning thread. */
 506     talloc_steal (ctx, thread);
 507
 508   DONE:
 509     talloc_free (local);
 510     return thread;
 511 }
 512
 513 notmuch_messages_t *
 514 notmuch_thread_get_toplevel_messages (notmuch_thread_t *thread)
 515 {
 516     return _notmuch_messages_create (thread->toplevel_list);
 517 }
 518
 519 notmuch_messages_t *
 520 notmuch_thread_get_messages (notmuch_thread_t *thread)
 521 {
 522     return _notmuch_messages_create (thread->message_list);
 523 }
 524
 525 const char *
 526 notmuch_thread_get_thread_id (notmuch_thread_t *thread)
 527 {
 528     return thread->thread_id;
 529 }
 530
 531 int
 532 notmuch_thread_get_total_messages (notmuch_thread_t *thread)
 533 {
 534     return thread->total_messages;
 535 }
 536
 537 int
 538 notmuch_thread_get_matched_messages (notmuch_thread_t *thread)
 539 {
 540     return thread->matched_messages;
 541 }
 542
 543 const char *
 544 notmuch_thread_get_authors (notmuch_thread_t *thread)
 545 {
 546     return thread->authors;
 547 }
 548
 549 const char *
 550 notmuch_thread_get_subject (notmuch_thread_t *thread)
 551 {
 552     return thread->subject;
 553 }
 554
 555 time_t
 556 notmuch_thread_get_oldest_date (notmuch_thread_t *thread)
 557 {
 558     return thread->oldest;
 559 }
 560
 561 time_t
 562 notmuch_thread_get_newest_date (notmuch_thread_t *thread)
 563 {
 564     return thread->newest;
 565 }
 566
 567 notmuch_tags_t *
 568 notmuch_thread_get_tags (notmuch_thread_t *thread)
 569 {
 570     notmuch_string_list_t *tags;
 571     GList *keys, *l;
 572
 573     tags = _notmuch_string_list_create (thread);
 574     if (unlikely (tags == NULL))
 575         return NULL;
 576
 577     keys = g_hash_table_get_keys (thread->tags);
 578
 579     for (l = keys; l; l = l->next)
 580         _notmuch_string_list_append (tags, (char *) l->data);
 581
 582     g_list_free (keys);
 583
 584     _notmuch_string_list_sort (tags);
 585
 586     return _notmuch_tags_create (thread, tags);
 587 }
 588
 589 void
 590 notmuch_thread_destroy (notmuch_thread_t *thread)
 591 {
 592     talloc_free (thread);
 593 }