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_has_more (tags);
123 notmuch_tags_advance (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 date = notmuch_message_get_date (message);
138 if (date < thread->oldest || ! thread->matched_messages)
139 thread->oldest = date;
141 if (date > thread->newest || ! thread->matched_messages)
142 thread->newest = date;
144 thread->matched_messages++;
148 _resolve_thread_relationships (unused (notmuch_thread_t *thread))
150 notmuch_message_node_t **prev, *node;
151 notmuch_message_t *message, *parent;
152 const char *in_reply_to;
154 prev = &thread->message_list->head;
155 while ((node = *prev)) {
156 message = node->message;
157 in_reply_to = _notmuch_message_get_in_reply_to (message);
158 if (in_reply_to && strlen (in_reply_to) &&
159 g_hash_table_lookup_extended (thread->message_hash,
164 if (thread->message_list->tail == &node->next)
165 thread->message_list->tail = prev;
167 _notmuch_message_add_reply (parent, node);
169 prev = &((*prev)->next);
173 /* XXX: After scanning through the entire list looking for parents
174 * via "In-Reply-To", we should do a second pass that looks at the
175 * list of messages IDs in the "References" header instead. (And
176 * for this the parent would be the "deepest" message of all the
177 * messages found in the "References" list.)
179 * Doing this will allow messages and sub-threads to be positioned
180 * correctly in the thread even when an intermediate message is
181 * missing from the thread.
185 /* Create a new notmuch_thread_t object for the given thread ID,
186 * treating any messages matching 'query_string' as "matched".
188 * Creating the thread will trigger two database searches. The first
189 * is for all messages belonging to the thread, (to get the first
190 * subject line, the total count of messages, and all authors). The
191 * second search is for all messages that are in the thread and that
192 * also match the given query_string. This is to allow for a separate
193 * count of matched messages, and to allow a viewer to diplay these
194 * messages differently.
196 * Here, 'ctx' is talloc context for the resulting thread object.
198 * This function returns NULL in the case of any error.
201 _notmuch_thread_create (void *ctx,
202 notmuch_database_t *notmuch,
203 const char *thread_id,
204 const char *query_string)
206 notmuch_thread_t *thread;
207 const char *thread_id_query_string, *matched_query_string;
208 notmuch_query_t *thread_id_query, *matched_query;
209 notmuch_messages_t *messages;
210 notmuch_message_t *message;
212 thread_id_query_string = talloc_asprintf (ctx, "thread:%s", thread_id);
213 if (unlikely (query_string == NULL))
216 /* XXX: We could be a bit more efficient here if
217 * thread_id_query_string is identical to query_string, (then we
218 * could get by with just one database search instead of two). */
220 matched_query_string = talloc_asprintf (ctx, "%s AND (%s)",
221 thread_id_query_string,
223 if (unlikely (matched_query_string == NULL))
226 thread_id_query = notmuch_query_create (notmuch, thread_id_query_string);
227 if (unlikely (thread_id_query == NULL))
230 matched_query = notmuch_query_create (notmuch, matched_query_string);
231 if (unlikely (thread_id_query == NULL))
234 thread = talloc (ctx, notmuch_thread_t);
235 if (unlikely (thread == NULL))
238 talloc_set_destructor (thread, _notmuch_thread_destructor);
240 thread->notmuch = notmuch;
241 thread->thread_id = talloc_strdup (thread, thread_id);
242 thread->subject = NULL;
243 thread->authors_hash = g_hash_table_new_full (g_str_hash, g_str_equal,
245 thread->authors = NULL;
246 thread->tags = g_hash_table_new_full (g_str_hash, g_str_equal,
249 thread->message_list = _notmuch_message_list_create (thread);
250 if (unlikely (thread->message_list == NULL))
253 thread->message_hash = g_hash_table_new_full (g_str_hash, g_str_equal,
256 thread->total_messages = 0;
257 thread->matched_messages = 0;
261 notmuch_query_set_sort (thread_id_query, NOTMUCH_SORT_DATE);
263 for (messages = notmuch_query_search_messages (thread_id_query, 0, -1);
264 notmuch_messages_has_more (messages);
265 notmuch_messages_advance (messages))
267 message = notmuch_messages_get (messages);
268 _thread_add_message (thread, message);
269 _notmuch_message_close (message);
272 notmuch_query_destroy (thread_id_query);
274 for (messages = notmuch_query_search_messages (matched_query, 0, -1);
275 notmuch_messages_has_more (messages);
276 notmuch_messages_advance (messages))
278 message = notmuch_messages_get (messages);
279 _thread_add_matched_message (thread, message);
280 _notmuch_message_close (message);
283 notmuch_query_destroy (matched_query);
285 _resolve_thread_relationships (thread);
291 notmuch_thread_get_toplevel_messages (notmuch_thread_t *thread)
293 return _notmuch_messages_create (thread->message_list);
297 notmuch_thread_get_thread_id (notmuch_thread_t *thread)
299 return thread->thread_id;
303 notmuch_thread_get_total_messages (notmuch_thread_t *thread)
305 return thread->total_messages;
309 notmuch_thread_get_matched_messages (notmuch_thread_t *thread)
311 return thread->matched_messages;
315 notmuch_thread_get_authors (notmuch_thread_t *thread)
317 return thread->authors;
321 notmuch_thread_get_subject (notmuch_thread_t *thread)
323 return thread->subject;
327 notmuch_thread_get_oldest_date (notmuch_thread_t *thread)
329 return thread->oldest;
333 notmuch_thread_get_newest_date (notmuch_thread_t *thread)
335 return thread->newest;
339 notmuch_thread_get_tags (notmuch_thread_t *thread)
341 notmuch_tags_t *tags;
344 tags = _notmuch_tags_create (thread);
345 if (unlikely (tags == NULL))
348 keys = g_hash_table_get_keys (thread->tags);
350 for (l = keys; l; l = l->next)
351 _notmuch_tags_add_tag (tags, (char *) l->data);
355 _notmuch_tags_prepare_iterator (tags);
361 notmuch_thread_destroy (notmuch_thread_t *thread)
363 talloc_free (thread);