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)
135 notmuch_message_t *hashed_message;
137 date = notmuch_message_get_date (message);
139 if (date < thread->oldest || ! thread->matched_messages)
140 thread->oldest = date;
142 if (date > thread->newest || ! thread->matched_messages)
143 thread->newest = date;
145 thread->matched_messages++;
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_MESSAGE_FLAG_MATCH, 1);
156 _resolve_thread_relationships (unused (notmuch_thread_t *thread))
158 notmuch_message_node_t **prev, *node;
159 notmuch_message_t *message, *parent;
160 const char *in_reply_to;
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,
172 if (thread->message_list->tail == &node->next)
173 thread->message_list->tail = prev;
175 _notmuch_message_add_reply (parent, node);
177 prev = &((*prev)->next);
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.)
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.
193 /* Create a new notmuch_thread_t object for the given thread ID,
194 * treating any messages matching 'query_string' as "matched".
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.
204 * Here, 'ctx' is talloc context for the resulting thread object.
206 * This function returns NULL in the case of any error.
209 _notmuch_thread_create (void *ctx,
210 notmuch_database_t *notmuch,
211 const char *thread_id,
212 const char *query_string)
214 notmuch_thread_t *thread;
215 const char *thread_id_query_string;
216 notmuch_query_t *thread_id_query;
218 notmuch_messages_t *messages;
219 notmuch_message_t *message;
220 notmuch_bool_t matched_is_subset_of_thread;
222 thread_id_query_string = talloc_asprintf (ctx, "thread:%s", thread_id);
223 if (unlikely (query_string == NULL))
226 /* Under normal circumstances we need to do two database
227 * queries. One is for the thread itself (thread_id_query_string)
228 * and the second is to determine which messages in that thread
229 * match the original query (matched_query_string).
231 * But under two circumstances, we use only the
232 * thread_id_query_string:
234 * 1. If the original query_string *is* just the thread
237 * 2. If the original query_string matches all messages ("" or
240 * In either of these cases, we can be more efficient by running
241 * just the thread_id query (since we know all messages in the
242 * thread will match the query_string).
244 * Beyond the performance advantage, in the second case, it's
245 * important to not try to create a concatenated query because our
246 * parser handles "" and "*" as special cases and will not do the
247 * right thing with a query string of "* and thread:<foo>".
249 matched_is_subset_of_thread = 1;
250 if (strcmp (query_string, thread_id_query_string) == 0 ||
251 strcmp (query_string, "") == 0 ||
252 strcmp (query_string, "*") == 0)
254 matched_is_subset_of_thread = 0;
257 thread_id_query = notmuch_query_create (notmuch, thread_id_query_string);
258 if (unlikely (thread_id_query == NULL))
261 thread = talloc (ctx, notmuch_thread_t);
262 if (unlikely (thread == NULL))
265 talloc_set_destructor (thread, _notmuch_thread_destructor);
267 thread->notmuch = notmuch;
268 thread->thread_id = talloc_strdup (thread, thread_id);
269 thread->subject = NULL;
270 thread->authors_hash = g_hash_table_new_full (g_str_hash, g_str_equal,
272 thread->authors = NULL;
273 thread->tags = g_hash_table_new_full (g_str_hash, g_str_equal,
276 thread->message_list = _notmuch_message_list_create (thread);
277 if (unlikely (thread->message_list == NULL))
280 thread->message_hash = g_hash_table_new_full (g_str_hash, g_str_equal,
283 thread->total_messages = 0;
284 thread->matched_messages = 0;
288 notmuch_query_set_sort (thread_id_query, NOTMUCH_SORT_OLDEST_FIRST);
290 for (messages = notmuch_query_search_messages (thread_id_query);
291 notmuch_messages_valid (messages);
292 notmuch_messages_move_to_next (messages))
294 message = notmuch_messages_get (messages);
296 _thread_add_message (thread, message);
298 if (! matched_is_subset_of_thread)
299 _thread_add_matched_message (thread, message);
301 _notmuch_message_close (message);
304 notmuch_query_destroy (thread_id_query);
306 if (matched_is_subset_of_thread)
308 const char *matched_query_string;
309 notmuch_query_t *matched_query;
311 matched_query_string = talloc_asprintf (ctx, "%s AND (%s)",
312 thread_id_query_string,
314 if (unlikely (matched_query_string == NULL))
317 matched_query = notmuch_query_create (notmuch, matched_query_string);
318 if (unlikely (matched_query == NULL))
321 for (messages = notmuch_query_search_messages (matched_query);
322 notmuch_messages_valid (messages);
323 notmuch_messages_move_to_next (messages))
325 message = notmuch_messages_get (messages);
326 _thread_add_matched_message (thread, message);
327 _notmuch_message_close (message);
330 notmuch_query_destroy (matched_query);
333 _resolve_thread_relationships (thread);
339 notmuch_thread_get_toplevel_messages (notmuch_thread_t *thread)
341 return _notmuch_messages_create (thread->message_list);
345 notmuch_thread_get_thread_id (notmuch_thread_t *thread)
347 return thread->thread_id;
351 notmuch_thread_get_total_messages (notmuch_thread_t *thread)
353 return thread->total_messages;
357 notmuch_thread_get_matched_messages (notmuch_thread_t *thread)
359 return thread->matched_messages;
363 notmuch_thread_get_authors (notmuch_thread_t *thread)
365 return thread->authors;
369 notmuch_thread_get_subject (notmuch_thread_t *thread)
371 return thread->subject;
375 notmuch_thread_get_oldest_date (notmuch_thread_t *thread)
377 return thread->oldest;
381 notmuch_thread_get_newest_date (notmuch_thread_t *thread)
383 return thread->newest;
387 notmuch_thread_get_tags (notmuch_thread_t *thread)
389 notmuch_tags_t *tags;
392 tags = _notmuch_tags_create (thread);
393 if (unlikely (tags == NULL))
396 keys = g_hash_table_get_keys (thread->tags);
398 for (l = keys; l; l = l->next)
399 _notmuch_tags_add_tag (tags, (char *) l->data);
403 _notmuch_tags_prepare_iterator (tags);
409 notmuch_thread_destroy (notmuch_thread_t *thread)
411 talloc_free (thread);