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;
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");
100 list = internet_address_list_parse_string (from);
102 address = internet_address_list_get_address (list, 0);
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);
110 _thread_add_author (thread, author);
112 g_object_unref (G_OBJECT (list));
115 if (! thread->subject) {
117 subject = notmuch_message_get_header (message, "subject");
118 thread->subject = talloc_strdup (thread, subject);
121 for (tags = notmuch_message_get_tags (message);
122 notmuch_tags_valid (tags);
123 notmuch_tags_move_to_next (tags))
125 tag = notmuch_tags_get (tags);
126 g_hash_table_insert (thread->tags, xstrdup (tag), NULL);
131 _thread_add_matched_message (notmuch_thread_t *thread,
132 notmuch_message_t *message,
136 notmuch_message_t *hashed_message;
138 date = notmuch_message_get_date (message);
140 if (date < thread->oldest || ! thread->matched_messages)
141 thread->oldest = date;
143 if (date > thread->newest || ! thread->matched_messages)
144 thread->newest = date;
147 const char *cleaned_subject;
149 subject = notmuch_message_get_header (message, "subject");
151 if ((strncasecmp (subject, "Re: ", 4) == 0) ||
152 (strncasecmp (subject, "Aw: ", 4) == 0) ||
153 (strncasecmp (subject, "Vs: ", 4) == 0) ||
154 (strncasecmp (subject, "Sv: ", 4) == 0)) {
156 cleaned_subject = talloc_strndup (thread,
158 strlen(subject) - 4);
160 cleaned_subject = talloc_strdup (thread, subject);
163 if ((sort == NOTMUCH_SORT_OLDEST_FIRST && date <= thread->newest) ||
164 (sort != NOTMUCH_SORT_OLDEST_FIRST && date == thread->newest)) {
165 thread->subject = talloc_strdup (thread, cleaned_subject);
168 thread->matched_messages++;
170 if (g_hash_table_lookup_extended (thread->message_hash,
171 notmuch_message_get_message_id (message), NULL,
172 (void **) &hashed_message)) {
173 notmuch_message_set_flag (hashed_message,
174 NOTMUCH_MESSAGE_FLAG_MATCH, 1);
179 _resolve_thread_relationships (unused (notmuch_thread_t *thread))
181 notmuch_message_node_t **prev, *node;
182 notmuch_message_t *message, *parent;
183 const char *in_reply_to;
185 prev = &thread->message_list->head;
186 while ((node = *prev)) {
187 message = node->message;
188 in_reply_to = _notmuch_message_get_in_reply_to (message);
189 if (in_reply_to && strlen (in_reply_to) &&
190 g_hash_table_lookup_extended (thread->message_hash,
195 if (thread->message_list->tail == &node->next)
196 thread->message_list->tail = prev;
198 _notmuch_message_add_reply (parent, node);
200 prev = &((*prev)->next);
204 /* XXX: After scanning through the entire list looking for parents
205 * via "In-Reply-To", we should do a second pass that looks at the
206 * list of messages IDs in the "References" header instead. (And
207 * for this the parent would be the "deepest" message of all the
208 * messages found in the "References" list.)
210 * Doing this will allow messages and sub-threads to be positioned
211 * correctly in the thread even when an intermediate message is
212 * missing from the thread.
216 /* Create a new notmuch_thread_t object for the given thread ID,
217 * treating any messages matching 'query_string' as "matched".
219 * Creating the thread will trigger two database searches. The first
220 * is for all messages belonging to the thread, (to get the first
221 * subject line, the total count of messages, and all authors). The
222 * second search is for all messages that are in the thread and that
223 * also match the given query_string. This is to allow for a separate
224 * count of matched messages, and to allow a viewer to display these
225 * messages differently.
227 * Here, 'ctx' is talloc context for the resulting thread object.
229 * This function returns NULL in the case of any error.
232 _notmuch_thread_create (void *ctx,
233 notmuch_database_t *notmuch,
234 const char *thread_id,
235 const char *query_string,
238 notmuch_thread_t *thread;
239 const char *thread_id_query_string;
240 notmuch_query_t *thread_id_query;
242 notmuch_messages_t *messages;
243 notmuch_message_t *message;
244 notmuch_bool_t matched_is_subset_of_thread;
246 thread_id_query_string = talloc_asprintf (ctx, "thread:%s", thread_id);
247 if (unlikely (query_string == NULL))
250 /* Under normal circumstances we need to do two database
251 * queries. One is for the thread itself (thread_id_query_string)
252 * and the second is to determine which messages in that thread
253 * match the original query (matched_query_string).
255 * But under two circumstances, we use only the
256 * thread_id_query_string:
258 * 1. If the original query_string *is* just the thread
261 * 2. If the original query_string matches all messages ("" or
264 * In either of these cases, we can be more efficient by running
265 * just the thread_id query (since we know all messages in the
266 * thread will match the query_string).
268 * Beyond the performance advantage, in the second case, it's
269 * important to not try to create a concatenated query because our
270 * parser handles "" and "*" as special cases and will not do the
271 * right thing with a query string of "* and thread:<foo>".
273 matched_is_subset_of_thread = 1;
274 if (strcmp (query_string, thread_id_query_string) == 0 ||
275 strcmp (query_string, "") == 0 ||
276 strcmp (query_string, "*") == 0)
278 matched_is_subset_of_thread = 0;
281 thread_id_query = notmuch_query_create (notmuch, thread_id_query_string);
282 if (unlikely (thread_id_query == NULL))
285 thread = talloc (ctx, notmuch_thread_t);
286 if (unlikely (thread == NULL))
289 talloc_set_destructor (thread, _notmuch_thread_destructor);
291 thread->notmuch = notmuch;
292 thread->thread_id = talloc_strdup (thread, thread_id);
293 thread->subject = NULL;
294 thread->authors_hash = g_hash_table_new_full (g_str_hash, g_str_equal,
296 thread->authors = NULL;
297 thread->tags = g_hash_table_new_full (g_str_hash, g_str_equal,
300 thread->message_list = _notmuch_message_list_create (thread);
301 if (unlikely (thread->message_list == NULL))
304 thread->message_hash = g_hash_table_new_full (g_str_hash, g_str_equal,
307 thread->total_messages = 0;
308 thread->matched_messages = 0;
312 notmuch_query_set_sort (thread_id_query, NOTMUCH_SORT_OLDEST_FIRST);
314 for (messages = notmuch_query_search_messages (thread_id_query);
315 notmuch_messages_valid (messages);
316 notmuch_messages_move_to_next (messages))
318 message = notmuch_messages_get (messages);
320 _thread_add_message (thread, message);
322 if (! matched_is_subset_of_thread)
323 _thread_add_matched_message (thread, message, sort);
325 _notmuch_message_close (message);
328 notmuch_query_destroy (thread_id_query);
330 if (matched_is_subset_of_thread)
332 const char *matched_query_string;
333 notmuch_query_t *matched_query;
335 matched_query_string = talloc_asprintf (ctx, "%s AND (%s)",
336 thread_id_query_string,
338 if (unlikely (matched_query_string == NULL))
341 matched_query = notmuch_query_create (notmuch, matched_query_string);
342 if (unlikely (matched_query == NULL))
345 for (messages = notmuch_query_search_messages (matched_query);
346 notmuch_messages_valid (messages);
347 notmuch_messages_move_to_next (messages))
349 message = notmuch_messages_get (messages);
350 _thread_add_matched_message (thread, message, sort);
351 _notmuch_message_close (message);
354 notmuch_query_destroy (matched_query);
357 _resolve_thread_relationships (thread);
363 notmuch_thread_get_toplevel_messages (notmuch_thread_t *thread)
365 return _notmuch_messages_create (thread->message_list);
369 notmuch_thread_get_thread_id (notmuch_thread_t *thread)
371 return thread->thread_id;
375 notmuch_thread_get_total_messages (notmuch_thread_t *thread)
377 return thread->total_messages;
381 notmuch_thread_get_matched_messages (notmuch_thread_t *thread)
383 return thread->matched_messages;
387 notmuch_thread_get_authors (notmuch_thread_t *thread)
389 return thread->authors;
393 notmuch_thread_get_subject (notmuch_thread_t *thread)
395 return thread->subject;
399 notmuch_thread_get_oldest_date (notmuch_thread_t *thread)
401 return thread->oldest;
405 notmuch_thread_get_newest_date (notmuch_thread_t *thread)
407 return thread->newest;
411 notmuch_thread_get_tags (notmuch_thread_t *thread)
413 notmuch_tags_t *tags;
416 tags = _notmuch_tags_create (thread);
417 if (unlikely (tags == NULL))
420 keys = g_hash_table_get_keys (thread->tags);
422 for (l = keys; l; l = l->next)
423 _notmuch_tags_add_tag (tags, (char *) l->data);
427 _notmuch_tags_prepare_iterator (tags);
433 notmuch_thread_destroy (notmuch_thread_t *thread)
435 talloc_free (thread);