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     for (tags = notmuch_message_get_tags (message);
 116          notmuch_tags_valid (tags);
 117          notmuch_tags_move_to_next (tags))
 118     {
 119         tag = notmuch_tags_get (tags);
 120         g_hash_table_insert (thread->tags, xstrdup (tag), NULL);
 121     }
 122 }
 123
 124 static void
 125 _thread_add_matched_message (notmuch_thread_t *thread,
 126                              notmuch_message_t *message)
 127 {
 128     time_t date;
 129     notmuch_message_t *hashed_message;
 130
 131     date = notmuch_message_get_date (message);
 132
 133     if (date < thread->oldest || ! thread->matched_messages)
 134         thread->oldest = date;
 135
 136     if (date > thread->newest || ! thread->matched_messages)
 137         thread->newest = date;
 138
 139     if (! thread->subject) {
 140         const char *subject;
 141
 142         subject = notmuch_message_get_header (message, "subject");
 143
 144         if ((strncasecmp (subject, "Re: ", 4) == 0) ||
 145             (strncasecmp (subject, "Aw: ", 4) == 0) ||
 146             (strncasecmp (subject, "Vs: ", 4) == 0) ||
 147             (strncasecmp (subject, "Sv: ", 4) == 0))
 148         {
 149             thread->subject = talloc_strdup (thread, subject + 4);
 150         }
 151         else
 152         {
 153             thread->subject = talloc_strdup (thread, subject);
 154         }
 155     }
 156
 157     thread->matched_messages++;
 158
 159     if (g_hash_table_lookup_extended (thread->message_hash,
 160                             notmuch_message_get_message_id (message), NULL,
 161                             (void **) &hashed_message)) {
 162         notmuch_message_set_flag (hashed_message,
 163                                   NOTMUCH_MESSAGE_FLAG_MATCH, 1);
 164     }
 165 }
 166
 167 static void
 168 _resolve_thread_relationships (unused (notmuch_thread_t *thread))
 169 {
 170     notmuch_message_node_t **prev, *node;
 171     notmuch_message_t *message, *parent;
 172     const char *in_reply_to;
 173
 174     prev = &thread->message_list->head;
 175     while ((node = *prev)) {
 176         message = node->message;
 177         in_reply_to = _notmuch_message_get_in_reply_to (message);
 178         if (in_reply_to && strlen (in_reply_to) &&
 179             g_hash_table_lookup_extended (thread->message_hash,
 180                                           in_reply_to, NULL,
 181                                           (void **) &parent))
 182         {
 183             *prev = node->next;
 184             if (thread->message_list->tail == &node->next)
 185                 thread->message_list->tail = prev;
 186             node->next = NULL;
 187             _notmuch_message_add_reply (parent, node);
 188         } else {
 189             prev = &((*prev)->next);
 190         }
 191     }
 192
 193     /* XXX: After scanning through the entire list looking for parents
 194      * via "In-Reply-To", we should do a second pass that looks at the
 195      * list of messages IDs in the "References" header instead. (And
 196      * for this the parent would be the "deepest" message of all the
 197      * messages found in the "References" list.)
 198      *
 199      * Doing this will allow messages and sub-threads to be positioned
 200      * correctly in the thread even when an intermediate message is
 201      * missing from the thread.
 202      */
 203 }
 204
 205 /* Create a new notmuch_thread_t object for the given thread ID,
 206  * treating any messages matching 'query_string' as "matched".
 207  *
 208  * Creating the thread will trigger two database searches. The first
 209  * is for all messages belonging to the thread, (to get the first
 210  * subject line, the total count of messages, and all authors). The
 211  * second search is for all messages that are in the thread and that
 212  * also match the given query_string. This is to allow for a separate
 213  * count of matched messages, and to allow a viewer to display these
 214  * messages differently.
 215  *
 216  * Here, 'ctx' is talloc context for the resulting thread object.
 217  *
 218  * This function returns NULL in the case of any error.
 219  */
 220 notmuch_thread_t *
 221 _notmuch_thread_create (void *ctx,
 222                         notmuch_database_t *notmuch,
 223                         const char *thread_id,
 224                         const char *query_string,
 225                         notmuch_sort_t sort)
 226 {
 227     notmuch_thread_t *thread;
 228     const char *thread_id_query_string;
 229     notmuch_query_t *thread_id_query;
 230
 231     notmuch_messages_t *messages;
 232     notmuch_message_t *message;
 233     notmuch_bool_t matched_is_subset_of_thread;
 234
 235     thread_id_query_string = talloc_asprintf (ctx, "thread:%s", thread_id);
 236     if (unlikely (query_string == NULL))
 237         return NULL;
 238
 239     /* Under normal circumstances we need to do two database
 240      * queries. One is for the thread itself (thread_id_query_string)
 241      * and the second is to determine which messages in that thread
 242      * match the original query (matched_query_string).
 243      *
 244      * But under two circumstances, we use only the
 245      * thread_id_query_string:
 246      *
 247      *  1. If the original query_string *is* just the thread
 248      *     specification.
 249      *
 250      *  2. If the original query_string matches all messages ("" or
 251      *     "*").
 252      *
 253      * In either of these cases, we can be more efficient by running
 254      * just the thread_id query (since we know all messages in the
 255      * thread will match the query_string).
 256      *
 257      * Beyond the performance advantage, in the second case, it's
 258      * important to not try to create a concatenated query because our
 259      * parser handles "" and "*" as special cases and will not do the
 260      * right thing with a query string of "* and thread:<foo>".
 261      **/
 262     matched_is_subset_of_thread = 1;
 263     if (strcmp (query_string, thread_id_query_string) == 0 ||
 264         strcmp (query_string, "") == 0 ||
 265         strcmp (query_string, "*") == 0)
 266     {
 267         matched_is_subset_of_thread = 0;
 268     }
 269
 270     thread_id_query = notmuch_query_create (notmuch, thread_id_query_string);
 271     if (unlikely (thread_id_query == NULL))
 272         return NULL;
 273
 274     thread = talloc (ctx, notmuch_thread_t);
 275     if (unlikely (thread == NULL))
 276         return NULL;
 277
 278     talloc_set_destructor (thread, _notmuch_thread_destructor);
 279
 280     thread->notmuch = notmuch;
 281     thread->thread_id = talloc_strdup (thread, thread_id);
 282     thread->subject = NULL;
 283     thread->authors_hash = g_hash_table_new_full (g_str_hash, g_str_equal,
 284                                                   free, NULL);
 285     thread->authors = NULL;
 286     thread->tags = g_hash_table_new_full (g_str_hash, g_str_equal,
 287                                           free, NULL);
 288
 289     thread->message_list = _notmuch_message_list_create (thread);
 290     if (unlikely (thread->message_list == NULL))
 291         return NULL;
 292
 293     thread->message_hash = g_hash_table_new_full (g_str_hash, g_str_equal,
 294                                                   free, NULL);
 295
 296     thread->total_messages = 0;
 297     thread->matched_messages = 0;
 298     thread->oldest = 0;
 299     thread->newest = 0;
 300
 301     notmuch_query_set_sort (thread_id_query, sort);
 302
 303     for (messages = notmuch_query_search_messages (thread_id_query);
 304          notmuch_messages_valid (messages);
 305          notmuch_messages_move_to_next (messages))
 306     {
 307         message = notmuch_messages_get (messages);
 308
 309         _thread_add_message (thread, message);
 310
 311         if (! matched_is_subset_of_thread)
 312             _thread_add_matched_message (thread, message);
 313
 314         _notmuch_message_close (message);
 315     }
 316
 317     notmuch_query_destroy (thread_id_query);
 318
 319     if (matched_is_subset_of_thread)
 320     {
 321         const char *matched_query_string;
 322         notmuch_query_t *matched_query;
 323
 324         matched_query_string = talloc_asprintf (ctx, "%s AND (%s)",
 325                                                 thread_id_query_string,
 326                                                 query_string);
 327         if (unlikely (matched_query_string == NULL))
 328             return NULL;
 329
 330         matched_query = notmuch_query_create (notmuch, matched_query_string);
 331         if (unlikely (matched_query == NULL))
 332             return NULL;
 333
 334         notmuch_query_set_sort (matched_query, sort);
 335
 336         for (messages = notmuch_query_search_messages (matched_query);
 337              notmuch_messages_valid (messages);
 338              notmuch_messages_move_to_next (messages))
 339         {
 340             message = notmuch_messages_get (messages);
 341             _thread_add_matched_message (thread, message);
 342             _notmuch_message_close (message);
 343         }
 344
 345         notmuch_query_destroy (matched_query);
 346     }
 347
 348     _resolve_thread_relationships (thread);
 349
 350     return thread;
 351 }
 352
 353 notmuch_messages_t *
 354 notmuch_thread_get_toplevel_messages (notmuch_thread_t *thread)
 355 {
 356     return _notmuch_messages_create (thread->message_list);
 357 }
 358
 359 const char *
 360 notmuch_thread_get_thread_id (notmuch_thread_t *thread)
 361 {
 362     return thread->thread_id;
 363 }
 364
 365 int
 366 notmuch_thread_get_total_messages (notmuch_thread_t *thread)
 367 {
 368     return thread->total_messages;
 369 }
 370
 371 int
 372 notmuch_thread_get_matched_messages (notmuch_thread_t *thread)
 373 {
 374     return thread->matched_messages;
 375 }
 376
 377 const char *
 378 notmuch_thread_get_authors (notmuch_thread_t *thread)
 379 {
 380     return thread->authors;
 381 }
 382
 383 const char *
 384 notmuch_thread_get_subject (notmuch_thread_t *thread)
 385 {
 386     return thread->subject;
 387 }
 388
 389 time_t
 390 notmuch_thread_get_oldest_date (notmuch_thread_t *thread)
 391 {
 392     return thread->oldest;
 393 }
 394
 395 time_t
 396 notmuch_thread_get_newest_date (notmuch_thread_t *thread)
 397 {
 398     return thread->newest;
 399 }
 400
 401 notmuch_tags_t *
 402 notmuch_thread_get_tags (notmuch_thread_t *thread)
 403 {
 404     notmuch_tags_t *tags;
 405     GList *keys, *l;
 406
 407     tags = _notmuch_tags_create (thread);
 408     if (unlikely (tags == NULL))
 409         return NULL;
 410
 411     keys = g_hash_table_get_keys (thread->tags);
 412
 413     for (l = keys; l; l = l->next)
 414         _notmuch_tags_add_tag (tags, (char *) l->data);
 415
 416     g_list_free (keys);
 417
 418     _notmuch_tags_prepare_iterator (tags);
 419
 420     return tags;
 421 }
 422
 423 void
 424 notmuch_thread_destroy (notmuch_thread_t *thread)
 425 {
 426     talloc_free (thread);
 427 }