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,
130 notmuch_message_t *hashed_message;
132 date = notmuch_message_get_date (message);
134 if (date < thread->oldest || ! thread->matched_messages)
135 thread->oldest = date;
137 if (date > thread->newest || ! thread->matched_messages)
138 thread->newest = date;
140 if (! thread->subject) {
143 subject = notmuch_message_get_header (message, "subject");
145 if ((strncasecmp (subject, "Re: ", 4) == 0) ||
146 (strncasecmp (subject, "Aw: ", 4) == 0) ||
147 (strncasecmp (subject, "Vs: ", 4) == 0) ||
148 (strncasecmp (subject, "Sv: ", 4) == 0))
150 thread->subject = talloc_strdup (thread, subject + 4);
154 thread->subject = talloc_strdup (thread, subject);
158 thread->matched_messages++;
160 if (g_hash_table_lookup_extended (thread->message_hash,
161 notmuch_message_get_message_id (message), NULL,
162 (void **) &hashed_message)) {
163 notmuch_message_set_flag (hashed_message,
164 NOTMUCH_MESSAGE_FLAG_MATCH, 1);
169 _resolve_thread_relationships (unused (notmuch_thread_t *thread))
171 notmuch_message_node_t **prev, *node;
172 notmuch_message_t *message, *parent;
173 const char *in_reply_to;
175 prev = &thread->message_list->head;
176 while ((node = *prev)) {
177 message = node->message;
178 in_reply_to = _notmuch_message_get_in_reply_to (message);
179 if (in_reply_to && strlen (in_reply_to) &&
180 g_hash_table_lookup_extended (thread->message_hash,
185 if (thread->message_list->tail == &node->next)
186 thread->message_list->tail = prev;
188 _notmuch_message_add_reply (parent, node);
190 prev = &((*prev)->next);
194 /* XXX: After scanning through the entire list looking for parents
195 * via "In-Reply-To", we should do a second pass that looks at the
196 * list of messages IDs in the "References" header instead. (And
197 * for this the parent would be the "deepest" message of all the
198 * messages found in the "References" list.)
200 * Doing this will allow messages and sub-threads to be positioned
201 * correctly in the thread even when an intermediate message is
202 * missing from the thread.
206 /* Create a new notmuch_thread_t object for the given thread ID,
207 * treating any messages matching 'query_string' as "matched".
209 * Creating the thread will trigger two database searches. The first
210 * is for all messages belonging to the thread, (to get the first
211 * subject line, the total count of messages, and all authors). The
212 * second search is for all messages that are in the thread and that
213 * also match the given query_string. This is to allow for a separate
214 * count of matched messages, and to allow a viewer to display these
215 * messages differently.
217 * Here, 'ctx' is talloc context for the resulting thread object.
219 * This function returns NULL in the case of any error.
222 _notmuch_thread_create (void *ctx,
223 notmuch_database_t *notmuch,
224 const char *thread_id,
225 const char *query_string,
228 notmuch_thread_t *thread;
229 const char *thread_id_query_string;
230 notmuch_query_t *thread_id_query;
232 notmuch_messages_t *messages;
233 notmuch_message_t *message;
234 notmuch_bool_t matched_is_subset_of_thread;
236 thread_id_query_string = talloc_asprintf (ctx, "thread:%s", thread_id);
237 if (unlikely (query_string == NULL))
240 /* Under normal circumstances we need to do two database
241 * queries. One is for the thread itself (thread_id_query_string)
242 * and the second is to determine which messages in that thread
243 * match the original query (matched_query_string).
245 * But under two circumstances, we use only the
246 * thread_id_query_string:
248 * 1. If the original query_string *is* just the thread
251 * 2. If the original query_string matches all messages ("" or
254 * In either of these cases, we can be more efficient by running
255 * just the thread_id query (since we know all messages in the
256 * thread will match the query_string).
258 * Beyond the performance advantage, in the second case, it's
259 * important to not try to create a concatenated query because our
260 * parser handles "" and "*" as special cases and will not do the
261 * right thing with a query string of "* and thread:<foo>".
263 matched_is_subset_of_thread = 1;
264 if (strcmp (query_string, thread_id_query_string) == 0 ||
265 strcmp (query_string, "") == 0 ||
266 strcmp (query_string, "*") == 0)
268 matched_is_subset_of_thread = 0;
271 thread_id_query = notmuch_query_create (notmuch, thread_id_query_string);
272 if (unlikely (thread_id_query == NULL))
275 thread = talloc (ctx, notmuch_thread_t);
276 if (unlikely (thread == NULL))
279 talloc_set_destructor (thread, _notmuch_thread_destructor);
281 thread->notmuch = notmuch;
282 thread->thread_id = talloc_strdup (thread, thread_id);
283 thread->subject = NULL;
284 thread->authors_hash = g_hash_table_new_full (g_str_hash, g_str_equal,
286 thread->authors = NULL;
287 thread->tags = g_hash_table_new_full (g_str_hash, g_str_equal,
290 thread->message_list = _notmuch_message_list_create (thread);
291 if (unlikely (thread->message_list == NULL))
294 thread->message_hash = g_hash_table_new_full (g_str_hash, g_str_equal,
297 thread->total_messages = 0;
298 thread->matched_messages = 0;
302 notmuch_query_set_sort (thread_id_query, sort);
304 for (messages = notmuch_query_search_messages (thread_id_query);
305 notmuch_messages_valid (messages);
306 notmuch_messages_move_to_next (messages))
308 message = notmuch_messages_get (messages);
310 _thread_add_message (thread, message);
312 if (! matched_is_subset_of_thread)
313 _thread_add_matched_message (thread, message, sort);
315 _notmuch_message_close (message);
318 notmuch_query_destroy (thread_id_query);
320 if (matched_is_subset_of_thread)
322 const char *matched_query_string;
323 notmuch_query_t *matched_query;
325 matched_query_string = talloc_asprintf (ctx, "%s AND (%s)",
326 thread_id_query_string,
328 if (unlikely (matched_query_string == NULL))
331 matched_query = notmuch_query_create (notmuch, matched_query_string);
332 if (unlikely (matched_query == NULL))
335 notmuch_query_set_sort (matched_query, sort);
337 for (messages = notmuch_query_search_messages (matched_query);
338 notmuch_messages_valid (messages);
339 notmuch_messages_move_to_next (messages))
341 message = notmuch_messages_get (messages);
342 _thread_add_matched_message (thread, message, sort);
343 _notmuch_message_close (message);
346 notmuch_query_destroy (matched_query);
349 _resolve_thread_relationships (thread);
355 notmuch_thread_get_toplevel_messages (notmuch_thread_t *thread)
357 return _notmuch_messages_create (thread->message_list);
361 notmuch_thread_get_thread_id (notmuch_thread_t *thread)
363 return thread->thread_id;
367 notmuch_thread_get_total_messages (notmuch_thread_t *thread)
369 return thread->total_messages;
373 notmuch_thread_get_matched_messages (notmuch_thread_t *thread)
375 return thread->matched_messages;
379 notmuch_thread_get_authors (notmuch_thread_t *thread)
381 return thread->authors;
385 notmuch_thread_get_subject (notmuch_thread_t *thread)
387 return thread->subject;
391 notmuch_thread_get_oldest_date (notmuch_thread_t *thread)
393 return thread->oldest;
397 notmuch_thread_get_newest_date (notmuch_thread_t *thread)
399 return thread->newest;
403 notmuch_thread_get_tags (notmuch_thread_t *thread)
405 notmuch_tags_t *tags;
408 tags = _notmuch_tags_create (thread);
409 if (unlikely (tags == NULL))
412 keys = g_hash_table_get_keys (thread->tags);
414 for (l = keys; l; l = l->next)
415 _notmuch_tags_add_tag (tags, (char *) l->data);
419 _notmuch_tags_prepare_iterator (tags);
425 notmuch_thread_destroy (notmuch_thread_t *thread)
427 talloc_free (thread);