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