1 /* query.cc - Support for searching 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"
24 #include <glib.h> /* GHashTable, GPtrArray */
28 struct _notmuch_query {
29 notmuch_database_t *notmuch;
30 const char *query_string;
34 struct _notmuch_messages {
35 notmuch_database_t *notmuch;
36 Xapian::MSetIterator iterator;
37 Xapian::MSetIterator iterator_end;
40 struct _notmuch_threads {
41 notmuch_database_t *notmuch;
47 notmuch_query_create (notmuch_database_t *notmuch,
48 const char *query_string)
50 notmuch_query_t *query;
53 fprintf (stderr, "Query string is:\n%s\n", query_string);
56 query = talloc (NULL, notmuch_query_t);
57 if (unlikely (query == NULL))
60 query->notmuch = notmuch;
62 query->query_string = talloc_strdup (query, query_string);
64 query->sort = NOTMUCH_SORT_DATE_OLDEST_FIRST;
70 notmuch_query_set_sort (notmuch_query_t *query, notmuch_sort_t sort)
75 /* We end up having to call the destructors explicitly because we had
76 * to use "placement new" in order to initialize C++ objects within a
77 * block that we allocated with talloc. So C++ is making talloc
78 * slightly less simple to use, (we wouldn't need
79 * talloc_set_destructor at all otherwise).
82 _notmuch_messages_destructor (notmuch_messages_t *messages)
84 messages->iterator.~MSetIterator ();
85 messages->iterator_end.~MSetIterator ();
91 notmuch_query_search_messages (notmuch_query_t *query,
95 notmuch_database_t *notmuch = query->notmuch;
96 const char *query_string = query->query_string;
97 notmuch_messages_t *messages;
99 messages = talloc (query, notmuch_messages_t);
100 if (unlikely (messages == NULL))
104 Xapian::Enquire enquire (*notmuch->xapian_db);
105 Xapian::Query mail_query (talloc_asprintf (query, "%s%s",
106 _find_prefix ("type"),
108 Xapian::Query string_query, final_query;
110 unsigned int flags = (Xapian::QueryParser::FLAG_BOOLEAN |
111 Xapian::QueryParser::FLAG_PHRASE |
112 Xapian::QueryParser::FLAG_LOVEHATE |
113 Xapian::QueryParser::FLAG_BOOLEAN_ANY_CASE |
114 Xapian::QueryParser::FLAG_WILDCARD);
116 if (strcmp (query_string, "") == 0) {
117 final_query = mail_query;
119 string_query = notmuch->query_parser->
120 parse_query (query_string, flags);
121 final_query = Xapian::Query (Xapian::Query::OP_AND,
122 mail_query, string_query);
125 switch (query->sort) {
126 case NOTMUCH_SORT_DATE_OLDEST_FIRST:
127 enquire.set_sort_by_value (NOTMUCH_VALUE_TIMESTAMP, FALSE);
129 case NOTMUCH_SORT_DATE_NEWEST_FIRST:
130 enquire.set_sort_by_value (NOTMUCH_VALUE_TIMESTAMP, TRUE);
132 case NOTMUCH_SORT_MESSAGE_ID:
133 enquire.set_sort_by_value (NOTMUCH_VALUE_MESSAGE_ID, FALSE);
138 fprintf (stderr, "Final query is:\n%s\n", final_query.get_description().c_str());
141 enquire.set_query (final_query);
143 if (max_messages == -1)
144 max_messages = notmuch->xapian_db->get_doccount ();
145 mset = enquire.get_mset (first, max_messages);
147 messages->notmuch = notmuch;
149 new (&messages->iterator) Xapian::MSetIterator ();
150 new (&messages->iterator_end) Xapian::MSetIterator ();
152 talloc_set_destructor (messages, _notmuch_messages_destructor);
154 messages->iterator = mset.begin ();
155 messages->iterator_end = mset.end ();
157 } catch (const Xapian::Error &error) {
158 fprintf (stderr, "A Xapian exception occurred: %s\n",
159 error.get_msg().c_str());
165 /* Glib objects force use to use a talloc destructor as well, (but not
166 * nearly as ugly as the for messages due to C++ objects). At
167 * this point, I'd really like to have some talloc-friendly
168 * equivalents for the few pieces of glib that I'm using. */
170 _notmuch_threads_destructor (notmuch_threads_t *threads)
172 g_ptr_array_free (threads->threads, TRUE);
178 notmuch_query_search_threads (notmuch_query_t *query,
182 notmuch_threads_t *threads;
183 notmuch_thread_t *thread;
184 const char *thread_id;
185 notmuch_messages_t *messages;
186 notmuch_message_t *message;
188 int messages_seen = 0, threads_seen = 0;
190 threads = talloc (query, notmuch_threads_t);
194 threads->notmuch = query->notmuch;
195 threads->threads = g_ptr_array_new ();
198 talloc_set_destructor (threads, _notmuch_threads_destructor);
200 seen = g_hash_table_new_full (g_str_hash, g_str_equal,
203 while (threads_seen < first + max_threads)
205 int messages_seen_previously = messages_seen;
207 for (messages = notmuch_query_search_messages (query,
210 notmuch_messages_has_more (messages);
211 notmuch_messages_advance (messages))
213 message = notmuch_messages_get (messages);
215 thread_id = notmuch_message_get_thread_id (message);
217 if (! g_hash_table_lookup_extended (seen,
221 if (threads_seen > first) {
222 thread = _notmuch_thread_create (query, query->notmuch,
224 g_ptr_array_add (threads->threads, thread);
229 g_hash_table_insert (seen, xstrdup (thread_id), thread);
235 _notmuch_thread_add_message (thread, message);
237 notmuch_message_destroy (message);
242 /* Stop if we're not seeing any more messages. */
243 if (messages_seen == messages_seen_previously)
247 g_hash_table_unref (seen);
253 notmuch_query_destroy (notmuch_query_t *query)
259 notmuch_messages_has_more (notmuch_messages_t *messages)
261 return (messages->iterator != messages->iterator_end);
265 notmuch_messages_get (notmuch_messages_t *messages)
267 notmuch_message_t *message;
268 Xapian::docid doc_id;
269 notmuch_private_status_t status;
271 if (! notmuch_messages_has_more (messages))
274 doc_id = *messages->iterator;
276 message = _notmuch_message_create (messages,
277 messages->notmuch, doc_id,
280 if (message == NULL &&
281 status == NOTMUCH_PRIVATE_STATUS_NO_DOCUMENT_FOUND)
283 INTERNAL_ERROR ("a messages iterator contains a non-existent document ID.\n");
290 notmuch_messages_advance (notmuch_messages_t *messages)
292 messages->iterator++;
296 notmuch_messages_destroy (notmuch_messages_t *messages)
298 talloc_free (messages);
302 notmuch_threads_has_more (notmuch_threads_t *threads)
304 return (threads->index < threads->threads->len);
308 notmuch_threads_get (notmuch_threads_t *threads)
310 if (! notmuch_threads_has_more (threads))
313 return (notmuch_thread_t *) g_ptr_array_index (threads->threads,
318 notmuch_threads_advance (notmuch_threads_t *threads)
324 notmuch_threads_destroy (notmuch_threads_t *threads)
326 talloc_free (threads);