1 /* thread.cc - Results of thread-based searches from a notmuch database
3 * Copyright © 2009 Carl Worth
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.
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.
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/ .
18 * Author: Carl Worth <cworth@cworth.org>
21 #include "notmuch-private.h"
22 #include "database-private.h"
26 #include <gmime/gmime.h>
27 #include <glib.h> /* GHashTable */
29 struct _notmuch_thread {
30 notmuch_database_t *notmuch;
33 GHashTable *authors_hash;
37 notmuch_message_list_t *message_list;
38 GHashTable *message_hash;
46 _notmuch_thread_destructor (notmuch_thread_t *thread)
48 g_hash_table_unref (thread->authors_hash);
49 g_hash_table_unref (thread->tags);
50 g_hash_table_unref (thread->message_hash);
56 _thread_add_author (notmuch_thread_t *thread,
62 if (g_hash_table_lookup_extended (thread->authors_hash,
66 g_hash_table_insert (thread->authors_hash, xstrdup (author), NULL);
69 thread->authors = talloc_asprintf (thread, "%s, %s",
73 thread->authors = talloc_strdup (thread, author);
76 /* Add 'message' as a message that belongs to 'thread'.
78 * The 'thread' will talloc_steal the 'message' and hold onto a
82 _thread_add_message (notmuch_thread_t *thread,
83 notmuch_message_t *message)
87 InternetAddressList *list = NULL;
88 InternetAddress *address;
89 const char *from, *author;
91 _notmuch_message_list_add_message (thread->message_list,
92 talloc_steal (thread, message));
93 thread->total_messages++;
95 g_hash_table_insert (thread->message_hash,
96 xstrdup (notmuch_message_get_message_id (message)),
99 from = notmuch_message_get_header (message, "from");
101 list = internet_address_list_parse_string (from);
104 address = internet_address_list_get_address (list, 0);
106 author = internet_address_get_name (address);
107 if (author == NULL) {
108 InternetAddressMailbox *mailbox;
109 mailbox = INTERNET_ADDRESS_MAILBOX (address);
110 author = internet_address_mailbox_get_addr (mailbox);
112 _thread_add_author (thread, author);
114 g_object_unref (G_OBJECT (list));
117 if (! thread->subject) {
119 subject = notmuch_message_get_header (message, "subject");
120 thread->subject = talloc_strdup (thread, subject ? subject : "");
123 for (tags = notmuch_message_get_tags (message);
124 notmuch_tags_valid (tags);
125 notmuch_tags_move_to_next (tags))
127 tag = notmuch_tags_get (tags);
128 g_hash_table_insert (thread->tags, xstrdup (tag), NULL);
133 _thread_set_subject_from_message (notmuch_thread_t *thread,
134 notmuch_message_t *message)
137 const char *cleaned_subject;
139 subject = notmuch_message_get_header (message, "subject");
143 if ((strncasecmp (subject, "Re: ", 4) == 0) ||
144 (strncasecmp (subject, "Aw: ", 4) == 0) ||
145 (strncasecmp (subject, "Vs: ", 4) == 0) ||
146 (strncasecmp (subject, "Sv: ", 4) == 0)) {
148 cleaned_subject = talloc_strndup (thread,
150 strlen(subject) - 4);
152 cleaned_subject = talloc_strdup (thread, subject);
156 talloc_free (thread->subject);
158 thread->subject = talloc_strdup (thread, cleaned_subject);
162 _thread_add_matched_message (notmuch_thread_t *thread,
163 notmuch_message_t *message,
167 notmuch_message_t *hashed_message;
169 date = notmuch_message_get_date (message);
171 if (date < thread->oldest || ! thread->matched_messages)
172 thread->oldest = date;
174 if (date > thread->newest || ! thread->matched_messages)
175 thread->newest = date;
177 thread->matched_messages++;
179 if (g_hash_table_lookup_extended (thread->message_hash,
180 notmuch_message_get_message_id (message), NULL,
181 (void **) &hashed_message)) {
182 notmuch_message_set_flag (hashed_message,
183 NOTMUCH_MESSAGE_FLAG_MATCH, 1);
186 if ((sort == NOTMUCH_SORT_OLDEST_FIRST && date <= thread->newest) ||
187 (sort != NOTMUCH_SORT_OLDEST_FIRST && date == thread->newest))
189 _thread_set_subject_from_message (thread, message);
194 _resolve_thread_relationships (unused (notmuch_thread_t *thread))
196 notmuch_message_node_t **prev, *node;
197 notmuch_message_t *message, *parent;
198 const char *in_reply_to;
200 prev = &thread->message_list->head;
201 while ((node = *prev)) {
202 message = node->message;
203 in_reply_to = _notmuch_message_get_in_reply_to (message);
204 if (in_reply_to && strlen (in_reply_to) &&
205 g_hash_table_lookup_extended (thread->message_hash,
210 if (thread->message_list->tail == &node->next)
211 thread->message_list->tail = prev;
213 _notmuch_message_add_reply (parent, node);
215 prev = &((*prev)->next);
219 /* XXX: After scanning through the entire list looking for parents
220 * via "In-Reply-To", we should do a second pass that looks at the
221 * list of messages IDs in the "References" header instead. (And
222 * for this the parent would be the "deepest" message of all the
223 * messages found in the "References" list.)
225 * Doing this will allow messages and sub-threads to be positioned
226 * correctly in the thread even when an intermediate message is
227 * missing from the thread.
231 /* Create a new notmuch_thread_t object for the given thread ID,
232 * treating any messages matching 'query_string' as "matched".
234 * Creating the thread will trigger two database searches. The first
235 * is for all messages belonging to the thread, (to get the first
236 * subject line, the total count of messages, and all authors). The
237 * second search is for all messages that are in the thread and that
238 * also match the given query_string. This is to allow for a separate
239 * count of matched messages, and to allow a viewer to display these
240 * messages differently.
242 * Here, 'ctx' is talloc context for the resulting thread object.
244 * This function returns NULL in the case of any error.
247 _notmuch_thread_create (void *ctx,
248 notmuch_database_t *notmuch,
249 const char *thread_id,
250 const char *query_string,
253 notmuch_thread_t *thread;
254 const char *thread_id_query_string;
255 notmuch_query_t *thread_id_query;
257 notmuch_messages_t *messages;
258 notmuch_message_t *message;
259 notmuch_bool_t matched_is_subset_of_thread;
261 thread_id_query_string = talloc_asprintf (ctx, "thread:%s", thread_id);
262 if (unlikely (query_string == NULL))
265 /* Under normal circumstances we need to do two database
266 * queries. One is for the thread itself (thread_id_query_string)
267 * and the second is to determine which messages in that thread
268 * match the original query (matched_query_string).
270 * But under two circumstances, we use only the
271 * thread_id_query_string:
273 * 1. If the original query_string *is* just the thread
276 * 2. If the original query_string matches all messages ("" or
279 * In either of these cases, we can be more efficient by running
280 * just the thread_id query (since we know all messages in the
281 * thread will match the query_string).
283 * Beyond the performance advantage, in the second case, it's
284 * important to not try to create a concatenated query because our
285 * parser handles "" and "*" as special cases and will not do the
286 * right thing with a query string of "* and thread:<foo>".
288 matched_is_subset_of_thread = 1;
289 if (strcmp (query_string, thread_id_query_string) == 0 ||
290 strcmp (query_string, "") == 0 ||
291 strcmp (query_string, "*") == 0)
293 matched_is_subset_of_thread = 0;
296 thread_id_query = notmuch_query_create (notmuch, thread_id_query_string);
297 if (unlikely (thread_id_query == NULL))
300 thread = talloc (ctx, notmuch_thread_t);
301 if (unlikely (thread == NULL))
304 talloc_set_destructor (thread, _notmuch_thread_destructor);
306 thread->notmuch = notmuch;
307 thread->thread_id = talloc_strdup (thread, thread_id);
308 thread->subject = NULL;
309 thread->authors_hash = g_hash_table_new_full (g_str_hash, g_str_equal,
311 thread->authors = NULL;
312 thread->tags = g_hash_table_new_full (g_str_hash, g_str_equal,
315 thread->message_list = _notmuch_message_list_create (thread);
316 if (unlikely (thread->message_list == NULL))
319 thread->message_hash = g_hash_table_new_full (g_str_hash, g_str_equal,
322 thread->total_messages = 0;
323 thread->matched_messages = 0;
327 notmuch_query_set_sort (thread_id_query, NOTMUCH_SORT_OLDEST_FIRST);
329 for (messages = notmuch_query_search_messages (thread_id_query);
330 notmuch_messages_valid (messages);
331 notmuch_messages_move_to_next (messages))
333 message = notmuch_messages_get (messages);
335 _thread_add_message (thread, message);
337 if (! matched_is_subset_of_thread)
338 _thread_add_matched_message (thread, message, sort);
340 _notmuch_message_close (message);
343 notmuch_query_destroy (thread_id_query);
345 if (matched_is_subset_of_thread)
347 const char *matched_query_string;
348 notmuch_query_t *matched_query;
350 matched_query_string = talloc_asprintf (ctx, "%s AND (%s)",
351 thread_id_query_string,
353 if (unlikely (matched_query_string == NULL))
356 matched_query = notmuch_query_create (notmuch, matched_query_string);
357 if (unlikely (matched_query == NULL))
360 for (messages = notmuch_query_search_messages (matched_query);
361 notmuch_messages_valid (messages);
362 notmuch_messages_move_to_next (messages))
364 message = notmuch_messages_get (messages);
365 _thread_add_matched_message (thread, message, sort);
366 _notmuch_message_close (message);
369 notmuch_query_destroy (matched_query);
372 _resolve_thread_relationships (thread);
378 notmuch_thread_get_toplevel_messages (notmuch_thread_t *thread)
380 return _notmuch_messages_create (thread->message_list);
384 notmuch_thread_get_thread_id (notmuch_thread_t *thread)
386 return thread->thread_id;
390 notmuch_thread_get_total_messages (notmuch_thread_t *thread)
392 return thread->total_messages;
396 notmuch_thread_get_matched_messages (notmuch_thread_t *thread)
398 return thread->matched_messages;
402 notmuch_thread_get_authors (notmuch_thread_t *thread)
404 return thread->authors;
408 notmuch_thread_get_subject (notmuch_thread_t *thread)
410 return thread->subject;
414 notmuch_thread_get_oldest_date (notmuch_thread_t *thread)
416 return thread->oldest;
420 notmuch_thread_get_newest_date (notmuch_thread_t *thread)
422 return thread->newest;
426 notmuch_thread_get_tags (notmuch_thread_t *thread)
428 notmuch_tags_t *tags;
431 tags = _notmuch_tags_create (thread);
432 if (unlikely (tags == NULL))
435 keys = g_hash_table_get_keys (thread->tags);
437 for (l = keys; l; l = l->next)
438 _notmuch_tags_add_tag (tags, (char *) l->data);
442 _notmuch_tags_prepare_iterator (tags);
448 notmuch_thread_destroy (notmuch_thread_t *thread)
450 talloc_free (thread);