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 typedef struct _notmuch_mset_messages {
35 notmuch_messages_t base;
36 notmuch_database_t *notmuch;
37 Xapian::MSetIterator iterator;
38 Xapian::MSetIterator iterator_end;
39 } notmuch_mset_messages_t;
41 struct _notmuch_threads {
42 notmuch_query_t *query;
44 notmuch_messages_t *messages;
46 /* This thread ID is our iterator state. */
47 const char *thread_id;
51 notmuch_query_create (notmuch_database_t *notmuch,
52 const char *query_string)
54 notmuch_query_t *query;
57 fprintf (stderr, "Query string is:\n%s\n", query_string);
60 query = talloc (NULL, notmuch_query_t);
61 if (unlikely (query == NULL))
64 query->notmuch = notmuch;
66 query->query_string = talloc_strdup (query, query_string);
68 query->sort = NOTMUCH_SORT_NEWEST_FIRST;
74 notmuch_query_get_query_string (notmuch_query_t *query)
76 return query->query_string;
80 notmuch_query_set_sort (notmuch_query_t *query, notmuch_sort_t sort)
86 notmuch_query_get_sort (notmuch_query_t *query)
91 /* We end up having to call the destructors explicitly because we had
92 * to use "placement new" in order to initialize C++ objects within a
93 * block that we allocated with talloc. So C++ is making talloc
94 * slightly less simple to use, (we wouldn't need
95 * talloc_set_destructor at all otherwise).
98 _notmuch_messages_destructor (notmuch_mset_messages_t *messages)
100 messages->iterator.~MSetIterator ();
101 messages->iterator_end.~MSetIterator ();
107 notmuch_query_search_messages (notmuch_query_t *query)
109 notmuch_database_t *notmuch = query->notmuch;
110 const char *query_string = query->query_string;
111 notmuch_mset_messages_t *messages;
113 messages = talloc (query, notmuch_mset_messages_t);
114 if (unlikely (messages == NULL))
119 messages->base.is_of_list_type = FALSE;
120 messages->base.iterator = NULL;
121 messages->notmuch = notmuch;
122 new (&messages->iterator) Xapian::MSetIterator ();
123 new (&messages->iterator_end) Xapian::MSetIterator ();
125 talloc_set_destructor (messages, _notmuch_messages_destructor);
127 Xapian::Enquire enquire (*notmuch->xapian_db);
128 Xapian::Query mail_query (talloc_asprintf (query, "%s%s",
129 _find_prefix ("type"),
131 Xapian::Query string_query, final_query;
133 unsigned int flags = (Xapian::QueryParser::FLAG_BOOLEAN |
134 Xapian::QueryParser::FLAG_PHRASE |
135 Xapian::QueryParser::FLAG_LOVEHATE |
136 Xapian::QueryParser::FLAG_BOOLEAN_ANY_CASE |
137 Xapian::QueryParser::FLAG_WILDCARD |
138 Xapian::QueryParser::FLAG_PURE_NOT);
140 if (strcmp (query_string, "") == 0 ||
141 strcmp (query_string, "*") == 0)
143 final_query = mail_query;
145 string_query = notmuch->query_parser->
146 parse_query (query_string, flags);
147 final_query = Xapian::Query (Xapian::Query::OP_AND,
148 mail_query, string_query);
151 enquire.set_weighting_scheme (Xapian::BoolWeight());
153 switch (query->sort) {
154 case NOTMUCH_SORT_OLDEST_FIRST:
155 enquire.set_sort_by_value (NOTMUCH_VALUE_TIMESTAMP, FALSE);
157 case NOTMUCH_SORT_NEWEST_FIRST:
158 enquire.set_sort_by_value (NOTMUCH_VALUE_TIMESTAMP, TRUE);
160 case NOTMUCH_SORT_MESSAGE_ID:
161 enquire.set_sort_by_value (NOTMUCH_VALUE_MESSAGE_ID, FALSE);
163 case NOTMUCH_SORT_UNSORTED:
168 fprintf (stderr, "Final query is:\n%s\n", final_query.get_description().c_str());
171 enquire.set_query (final_query);
173 mset = enquire.get_mset (0, notmuch->xapian_db->get_doccount ());
175 messages->iterator = mset.begin ();
176 messages->iterator_end = mset.end ();
178 return &messages->base;
180 } catch (const Xapian::Error &error) {
181 fprintf (stderr, "A Xapian exception occurred performing query: %s\n",
182 error.get_msg().c_str());
183 fprintf (stderr, "Query string was: %s\n", query->query_string);
184 notmuch->exception_reported = TRUE;
185 talloc_free (messages);
191 _notmuch_mset_messages_valid (notmuch_messages_t *messages)
193 notmuch_mset_messages_t *mset_messages;
195 mset_messages = (notmuch_mset_messages_t *) messages;
197 return (mset_messages->iterator != mset_messages->iterator_end);
201 _notmuch_mset_messages_get (notmuch_messages_t *messages)
203 notmuch_message_t *message;
204 Xapian::docid doc_id;
205 notmuch_private_status_t status;
206 notmuch_mset_messages_t *mset_messages;
208 mset_messages = (notmuch_mset_messages_t *) messages;
210 if (! _notmuch_mset_messages_valid (&mset_messages->base))
213 doc_id = *mset_messages->iterator;
215 message = _notmuch_message_create (mset_messages,
216 mset_messages->notmuch, doc_id,
219 if (message == NULL &&
220 status == NOTMUCH_PRIVATE_STATUS_NO_DOCUMENT_FOUND)
222 INTERNAL_ERROR ("a messages iterator contains a non-existent document ID.\n");
229 _notmuch_mset_messages_move_to_next (notmuch_messages_t *messages)
231 notmuch_mset_messages_t *mset_messages;
233 mset_messages = (notmuch_mset_messages_t *) messages;
235 mset_messages->iterator++;
238 /* Glib objects force use to use a talloc destructor as well, (but not
239 * nearly as ugly as the for messages due to C++ objects). At
240 * this point, I'd really like to have some talloc-friendly
241 * equivalents for the few pieces of glib that I'm using. */
243 _notmuch_threads_destructor (notmuch_threads_t *threads)
245 g_hash_table_unref (threads->threads);
251 notmuch_query_search_threads (notmuch_query_t *query)
253 notmuch_threads_t *threads;
255 threads = talloc (query, notmuch_threads_t);
259 threads->query = query;
260 threads->threads = g_hash_table_new_full (g_str_hash, g_str_equal,
263 threads->messages = notmuch_query_search_messages (query);
264 if (threads->messages == NULL) {
265 talloc_free (threads);
269 threads->thread_id = NULL;
271 talloc_set_destructor (threads, _notmuch_threads_destructor);
277 notmuch_query_destroy (notmuch_query_t *query)
283 notmuch_threads_valid (notmuch_threads_t *threads)
285 notmuch_message_t *message;
287 if (threads->thread_id)
290 while (notmuch_messages_valid (threads->messages))
292 message = notmuch_messages_get (threads->messages);
294 threads->thread_id = notmuch_message_get_thread_id (message);
296 if (! g_hash_table_lookup_extended (threads->threads,
300 g_hash_table_insert (threads->threads,
301 xstrdup (threads->thread_id), NULL);
302 notmuch_messages_move_to_next (threads->messages);
306 notmuch_messages_move_to_next (threads->messages);
309 threads->thread_id = NULL;
314 notmuch_threads_get (notmuch_threads_t *threads)
316 if (! notmuch_threads_valid (threads))
319 return _notmuch_thread_create (threads->query,
320 threads->query->notmuch,
322 threads->query->query_string,
323 threads->query->sort);
327 notmuch_threads_move_to_next (notmuch_threads_t *threads)
329 threads->thread_id = NULL;
333 notmuch_threads_destroy (notmuch_threads_t *threads)
335 talloc_free (threads);
339 notmuch_query_count_messages (notmuch_query_t *query)
341 notmuch_database_t *notmuch = query->notmuch;
342 const char *query_string = query->query_string;
343 Xapian::doccount count = 0;
346 Xapian::Enquire enquire (*notmuch->xapian_db);
347 Xapian::Query mail_query (talloc_asprintf (query, "%s%s",
348 _find_prefix ("type"),
350 Xapian::Query string_query, final_query;
352 unsigned int flags = (Xapian::QueryParser::FLAG_BOOLEAN |
353 Xapian::QueryParser::FLAG_PHRASE |
354 Xapian::QueryParser::FLAG_LOVEHATE |
355 Xapian::QueryParser::FLAG_BOOLEAN_ANY_CASE |
356 Xapian::QueryParser::FLAG_WILDCARD |
357 Xapian::QueryParser::FLAG_PURE_NOT);
359 if (strcmp (query_string, "") == 0 ||
360 strcmp (query_string, "*") == 0)
362 final_query = mail_query;
364 string_query = notmuch->query_parser->
365 parse_query (query_string, flags);
366 final_query = Xapian::Query (Xapian::Query::OP_AND,
367 mail_query, string_query);
370 enquire.set_weighting_scheme(Xapian::BoolWeight());
371 enquire.set_docid_order(Xapian::Enquire::ASCENDING);
374 fprintf (stderr, "Final query is:\n%s\n", final_query.get_description().c_str());
377 enquire.set_query (final_query);
379 mset = enquire.get_mset (0, notmuch->xapian_db->get_doccount ());
381 count = mset.get_matches_estimated();
383 } catch (const Xapian::Error &error) {
384 fprintf (stderr, "A Xapian exception occurred: %s\n",
385 error.get_msg().c_str());
386 fprintf (stderr, "Query string was: %s\n", query->query_string);