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 for (tags = notmuch_message_get_tags (message);
116 notmuch_tags_valid (tags);
117 notmuch_tags_move_to_next (tags))
119 tag = notmuch_tags_get (tags);
120 g_hash_table_insert (thread->tags, xstrdup (tag), NULL);
125 _thread_add_matched_message (notmuch_thread_t *thread,
126 notmuch_message_t *message)
129 notmuch_message_t *hashed_message;
131 date = notmuch_message_get_date (message);
133 if (date < thread->oldest || ! thread->matched_messages)
134 thread->oldest = date;
136 if (date > thread->newest || ! thread->matched_messages)
137 thread->newest = date;
139 if (! thread->subject) {
142 subject = notmuch_message_get_header (message, "subject");
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))
149 thread->subject = talloc_strdup (thread, subject + 4);
153 thread->subject = talloc_strdup (thread, subject);
157 thread->matched_messages++;
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);
168 _resolve_thread_relationships (unused (notmuch_thread_t *thread))
170 notmuch_message_node_t **prev, *node;
171 notmuch_message_t *message, *parent;
172 const char *in_reply_to;
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,
184 if (thread->message_list->tail == &node->next)
185 thread->message_list->tail = prev;
187 _notmuch_message_add_reply (parent, node);
189 prev = &((*prev)->next);
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.)
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.
205 /* Create a new notmuch_thread_t object for the given thread ID,
206 * treating any messages matching 'query_string' as "matched".
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.
216 * Here, 'ctx' is talloc context for the resulting thread object.
218 * This function returns NULL in the case of any error.
221 _notmuch_thread_create (void *ctx,
222 notmuch_database_t *notmuch,
223 const char *thread_id,
224 const char *query_string,
227 notmuch_thread_t *thread;
228 const char *thread_id_query_string;
229 notmuch_query_t *thread_id_query;
231 notmuch_messages_t *messages;
232 notmuch_message_t *message;
233 notmuch_bool_t matched_is_subset_of_thread;
235 thread_id_query_string = talloc_asprintf (ctx, "thread:%s", thread_id);
236 if (unlikely (query_string == NULL))
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).
244 * But under two circumstances, we use only the
245 * thread_id_query_string:
247 * 1. If the original query_string *is* just the thread
250 * 2. If the original query_string matches all messages ("" or
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).
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>".
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)
267 matched_is_subset_of_thread = 0;
270 thread_id_query = notmuch_query_create (notmuch, thread_id_query_string);
271 if (unlikely (thread_id_query == NULL))
274 thread = talloc (ctx, notmuch_thread_t);
275 if (unlikely (thread == NULL))
278 talloc_set_destructor (thread, _notmuch_thread_destructor);
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,
285 thread->authors = NULL;
286 thread->tags = g_hash_table_new_full (g_str_hash, g_str_equal,
289 thread->message_list = _notmuch_message_list_create (thread);
290 if (unlikely (thread->message_list == NULL))
293 thread->message_hash = g_hash_table_new_full (g_str_hash, g_str_equal,
296 thread->total_messages = 0;
297 thread->matched_messages = 0;
301 notmuch_query_set_sort (thread_id_query, sort);
303 for (messages = notmuch_query_search_messages (thread_id_query);
304 notmuch_messages_valid (messages);
305 notmuch_messages_move_to_next (messages))
307 message = notmuch_messages_get (messages);
309 _thread_add_message (thread, message);
311 if (! matched_is_subset_of_thread)
312 _thread_add_matched_message (thread, message);
314 _notmuch_message_close (message);
317 notmuch_query_destroy (thread_id_query);
319 if (matched_is_subset_of_thread)
321 const char *matched_query_string;
322 notmuch_query_t *matched_query;
324 matched_query_string = talloc_asprintf (ctx, "%s AND (%s)",
325 thread_id_query_string,
327 if (unlikely (matched_query_string == NULL))
330 matched_query = notmuch_query_create (notmuch, matched_query_string);
331 if (unlikely (matched_query == NULL))
334 notmuch_query_set_sort (matched_query, sort);
336 for (messages = notmuch_query_search_messages (matched_query);
337 notmuch_messages_valid (messages);
338 notmuch_messages_move_to_next (messages))
340 message = notmuch_messages_get (messages);
341 _thread_add_matched_message (thread, message);
342 _notmuch_message_close (message);
345 notmuch_query_destroy (matched_query);
348 _resolve_thread_relationships (thread);
354 notmuch_thread_get_toplevel_messages (notmuch_thread_t *thread)
356 return _notmuch_messages_create (thread->message_list);
360 notmuch_thread_get_thread_id (notmuch_thread_t *thread)
362 return thread->thread_id;
366 notmuch_thread_get_total_messages (notmuch_thread_t *thread)
368 return thread->total_messages;
372 notmuch_thread_get_matched_messages (notmuch_thread_t *thread)
374 return thread->matched_messages;
378 notmuch_thread_get_authors (notmuch_thread_t *thread)
380 return thread->authors;
384 notmuch_thread_get_subject (notmuch_thread_t *thread)
386 return thread->subject;
390 notmuch_thread_get_oldest_date (notmuch_thread_t *thread)
392 return thread->oldest;
396 notmuch_thread_get_newest_date (notmuch_thread_t *thread)
398 return thread->newest;
402 notmuch_thread_get_tags (notmuch_thread_t *thread)
404 notmuch_tags_t *tags;
407 tags = _notmuch_tags_create (thread);
408 if (unlikely (tags == NULL))
411 keys = g_hash_table_get_keys (thread->tags);
413 for (l = keys; l; l = l->next)
414 _notmuch_tags_add_tag (tags, (char *) l->data);
418 _notmuch_tags_prepare_iterator (tags);
424 notmuch_thread_destroy (notmuch_thread_t *thread)
426 talloc_free (thread);