have _notmuch_thread_create mark which messages matched the query
[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     if (! thread->subject) {
116         const char *subject;
117         subject = notmuch_message_get_header (message, "subject");
118         thread->subject = talloc_strdup (thread, subject);
119     }
120
121     for (tags = notmuch_message_get_tags (message);
122          notmuch_tags_has_more (tags);
123          notmuch_tags_advance (tags))
124     {
125         tag = notmuch_tags_get (tags);
126         g_hash_table_insert (thread->tags, xstrdup (tag), NULL);
127     }
128 }
129
130 static void
131 _thread_add_matched_message (notmuch_thread_t *thread,
132                              notmuch_message_t *message)
133 {
134     time_t date;
135     notmuch_message_t *hashed_message;
136
137     date = notmuch_message_get_date (message);
138
139     if (date < thread->oldest || ! thread->matched_messages)
140         thread->oldest = date;
141
142     if (date > thread->newest || ! thread->matched_messages)
143         thread->newest = date;
144
145     thread->matched_messages++;
146
147     if (g_hash_table_lookup_extended (thread->message_hash,
148                             notmuch_message_get_message_id (message), NULL,
149                             (void **) &hashed_message)) {
150         notmuch_message_set_flag (hashed_message,
151                         NOTMUCH_MSG_FLAG_MATCHING_SEARCH, 1);
152     }
153 }
154
155 static void
156 _resolve_thread_relationships (unused (notmuch_thread_t *thread))
157 {
158     notmuch_message_node_t **prev, *node;
159     notmuch_message_t *message, *parent;
160     const char *in_reply_to;
161
162     prev = &thread->message_list->head;
163     while ((node = *prev)) {
164         message = node->message;
165         in_reply_to = _notmuch_message_get_in_reply_to (message);
166         if (in_reply_to && strlen (in_reply_to) &&
167             g_hash_table_lookup_extended (thread->message_hash,
168                                           in_reply_to, NULL,
169                                           (void **) &parent))
170         {
171             *prev = node->next;
172             if (thread->message_list->tail == &node->next)
173                 thread->message_list->tail = prev;
174             node->next = NULL;
175             _notmuch_message_add_reply (parent, node);
176         } else {
177             prev = &((*prev)->next);
178         }
179     }
180
181     /* XXX: After scanning through the entire list looking for parents
182      * via "In-Reply-To", we should do a second pass that looks at the
183      * list of messages IDs in the "References" header instead. (And
184      * for this the parent would be the "deepest" message of all the
185      * messages found in the "References" list.)
186      *
187      * Doing this will allow messages and sub-threads to be positioned
188      * correctly in the thread even when an intermediate message is
189      * missing from the thread.
190      */
191 }
192
193 /* Create a new notmuch_thread_t object for the given thread ID,
194  * treating any messages matching 'query_string' as "matched".
195  *
196  * Creating the thread will trigger two database searches. The first
197  * is for all messages belonging to the thread, (to get the first
198  * subject line, the total count of messages, and all authors). The
199  * second search is for all messages that are in the thread and that
200  * also match the given query_string. This is to allow for a separate
201  * count of matched messages, and to allow a viewer to display these
202  * messages differently.
203  *
204  * Here, 'ctx' is talloc context for the resulting thread object.
205  *
206  * This function returns NULL in the case of any error.
207  */
208 notmuch_thread_t *
209 _notmuch_thread_create (void *ctx,
210                         notmuch_database_t *notmuch,
211                         const char *thread_id,
212                         const char *query_string)
213 {
214     notmuch_thread_t *thread;
215     const char *thread_id_query_string, *matched_query_string;
216     notmuch_query_t *thread_id_query, *matched_query;
217     notmuch_messages_t *messages;
218     notmuch_message_t *message;
219
220     thread_id_query_string = talloc_asprintf (ctx, "thread:%s", thread_id);
221     if (unlikely (query_string == NULL))
222         return NULL;
223
224     /* XXX: We could be a bit more efficient here if
225      * thread_id_query_string is identical to query_string, (then we
226      * could get by with just one database search instead of two). */
227
228     matched_query_string = talloc_asprintf (ctx, "%s AND (%s)",
229                                             thread_id_query_string,
230                                             query_string);
231     if (unlikely (matched_query_string == NULL))
232         return NULL;
233
234     thread_id_query = notmuch_query_create (notmuch, thread_id_query_string);
235     if (unlikely (thread_id_query == NULL))
236         return NULL;
237
238     matched_query = notmuch_query_create (notmuch, matched_query_string);
239     if (unlikely (thread_id_query == NULL))
240         return NULL;
241
242     thread = talloc (ctx, notmuch_thread_t);
243     if (unlikely (thread == NULL))
244         return NULL;
245
246     talloc_set_destructor (thread, _notmuch_thread_destructor);
247
248     thread->notmuch = notmuch;
249     thread->thread_id = talloc_strdup (thread, thread_id);
250     thread->subject = NULL;
251     thread->authors_hash = g_hash_table_new_full (g_str_hash, g_str_equal,
252                                                   free, NULL);
253     thread->authors = NULL;
254     thread->tags = g_hash_table_new_full (g_str_hash, g_str_equal,
255                                           free, NULL);
256
257     thread->message_list = _notmuch_message_list_create (thread);
258     if (unlikely (thread->message_list == NULL))
259         return NULL;
260
261     thread->message_hash = g_hash_table_new_full (g_str_hash, g_str_equal,
262                                                   free, NULL);
263
264     thread->total_messages = 0;
265     thread->matched_messages = 0;
266     thread->oldest = 0;
267     thread->newest = 0;
268
269     notmuch_query_set_sort (thread_id_query, NOTMUCH_SORT_OLDEST_FIRST);
270
271     for (messages = notmuch_query_search_messages (thread_id_query);
272          notmuch_messages_has_more (messages);
273          notmuch_messages_advance (messages))
274     {
275         message = notmuch_messages_get (messages);
276         _thread_add_message (thread, message);
277         _notmuch_message_close (message);
278     }
279
280     notmuch_query_destroy (thread_id_query);
281
282     for (messages = notmuch_query_search_messages (matched_query);
283          notmuch_messages_has_more (messages);
284          notmuch_messages_advance (messages))
285     {
286         message = notmuch_messages_get (messages);
287         _thread_add_matched_message (thread, message);
288         _notmuch_message_close (message);
289     }
290
291     notmuch_query_destroy (matched_query);
292
293     _resolve_thread_relationships (thread);
294
295     return thread;
296 }
297
298 notmuch_messages_t *
299 notmuch_thread_get_toplevel_messages (notmuch_thread_t *thread)
300 {
301     return _notmuch_messages_create (thread->message_list);
302 }
303
304 const char *
305 notmuch_thread_get_thread_id (notmuch_thread_t *thread)
306 {
307     return thread->thread_id;
308 }
309
310 int
311 notmuch_thread_get_total_messages (notmuch_thread_t *thread)
312 {
313     return thread->total_messages;
314 }
315
316 int
317 notmuch_thread_get_matched_messages (notmuch_thread_t *thread)
318 {
319     return thread->matched_messages;
320 }
321
322 const char *
323 notmuch_thread_get_authors (notmuch_thread_t *thread)
324 {
325     return thread->authors;
326 }
327
328 const char *
329 notmuch_thread_get_subject (notmuch_thread_t *thread)
330 {
331     return thread->subject;
332 }
333
334 time_t
335 notmuch_thread_get_oldest_date (notmuch_thread_t *thread)
336 {
337     return thread->oldest;
338 }
339
340 time_t
341 notmuch_thread_get_newest_date (notmuch_thread_t *thread)
342 {
343     return thread->newest;
344 }
345
346 notmuch_tags_t *
347 notmuch_thread_get_tags (notmuch_thread_t *thread)
348 {
349     notmuch_tags_t *tags;
350     GList *keys, *l;
351
352     tags = _notmuch_tags_create (thread);
353     if (unlikely (tags == NULL))
354         return NULL;
355
356     keys = g_hash_table_get_keys (thread->tags);
357
358     for (l = keys; l; l = l->next)
359         _notmuch_tags_add_tag (tags, (char *) l->data);
360
361     g_list_free (keys);
362
363     _notmuch_tags_prepare_iterator (tags);
364
365     return tags;
366 }
367
368 void
369 notmuch_thread_destroy (notmuch_thread_t *thread)
370 {
371     talloc_free (thread);
372 }