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_set_sort (notmuch_query_t *query, notmuch_sort_t sort)
79 /* We end up having to call the destructors explicitly because we had
80 * to use "placement new" in order to initialize C++ objects within a
81 * block that we allocated with talloc. So C++ is making talloc
82 * slightly less simple to use, (we wouldn't need
83 * talloc_set_destructor at all otherwise).
86 _notmuch_messages_destructor (notmuch_mset_messages_t *messages)
88 messages->iterator.~MSetIterator ();
89 messages->iterator_end.~MSetIterator ();
95 notmuch_query_search_messages (notmuch_query_t *query)
97 notmuch_database_t *notmuch = query->notmuch;
98 const char *query_string = query->query_string;
99 notmuch_mset_messages_t *messages;
101 messages = talloc (query, notmuch_mset_messages_t);
102 if (unlikely (messages == NULL))
107 messages->base.is_of_list_type = FALSE;
108 messages->base.iterator = NULL;
109 messages->notmuch = notmuch;
110 new (&messages->iterator) Xapian::MSetIterator ();
111 new (&messages->iterator_end) Xapian::MSetIterator ();
113 talloc_set_destructor (messages, _notmuch_messages_destructor);
115 Xapian::Enquire enquire (*notmuch->xapian_db);
116 Xapian::Query mail_query (talloc_asprintf (query, "%s%s",
117 _find_prefix ("type"),
119 Xapian::Query string_query, final_query;
121 unsigned int flags = (Xapian::QueryParser::FLAG_BOOLEAN |
122 Xapian::QueryParser::FLAG_PHRASE |
123 Xapian::QueryParser::FLAG_LOVEHATE |
124 Xapian::QueryParser::FLAG_BOOLEAN_ANY_CASE |
125 Xapian::QueryParser::FLAG_WILDCARD |
126 Xapian::QueryParser::FLAG_PURE_NOT);
128 if (strcmp (query_string, "") == 0 ||
129 strcmp (query_string, "*") == 0)
131 final_query = mail_query;
133 string_query = notmuch->query_parser->
134 parse_query (query_string, flags);
135 final_query = Xapian::Query (Xapian::Query::OP_AND,
136 mail_query, string_query);
139 enquire.set_weighting_scheme (Xapian::BoolWeight());
141 switch (query->sort) {
142 case NOTMUCH_SORT_OLDEST_FIRST:
143 enquire.set_sort_by_value (NOTMUCH_VALUE_TIMESTAMP, FALSE);
145 case NOTMUCH_SORT_NEWEST_FIRST:
146 enquire.set_sort_by_value (NOTMUCH_VALUE_TIMESTAMP, TRUE);
148 case NOTMUCH_SORT_MESSAGE_ID:
149 enquire.set_sort_by_value (NOTMUCH_VALUE_MESSAGE_ID, FALSE);
154 fprintf (stderr, "Final query is:\n%s\n", final_query.get_description().c_str());
157 enquire.set_query (final_query);
159 mset = enquire.get_mset (0, notmuch->xapian_db->get_doccount ());
161 messages->iterator = mset.begin ();
162 messages->iterator_end = mset.end ();
164 } catch (const Xapian::Error &error) {
165 fprintf (stderr, "A Xapian exception occurred performing query: %s\n",
166 error.get_msg().c_str());
167 fprintf (stderr, "Query string was: %s\n", query->query_string);
168 notmuch->exception_reported = TRUE;
171 return &messages->base;
175 _notmuch_mset_messages_valid (notmuch_messages_t *messages)
177 notmuch_mset_messages_t *mset_messages;
179 mset_messages = (notmuch_mset_messages_t *) messages;
181 return (mset_messages->iterator != mset_messages->iterator_end);
185 _notmuch_mset_messages_get (notmuch_messages_t *messages)
187 notmuch_message_t *message;
188 Xapian::docid doc_id;
189 notmuch_private_status_t status;
190 notmuch_mset_messages_t *mset_messages;
192 mset_messages = (notmuch_mset_messages_t *) messages;
194 if (! _notmuch_mset_messages_valid (&mset_messages->base))
197 doc_id = *mset_messages->iterator;
199 message = _notmuch_message_create (mset_messages,
200 mset_messages->notmuch, doc_id,
203 if (message == NULL &&
204 status == NOTMUCH_PRIVATE_STATUS_NO_DOCUMENT_FOUND)
206 INTERNAL_ERROR ("a messages iterator contains a non-existent document ID.\n");
213 _notmuch_mset_messages_move_to_next (notmuch_messages_t *messages)
215 notmuch_mset_messages_t *mset_messages;
217 mset_messages = (notmuch_mset_messages_t *) messages;
219 mset_messages->iterator++;
222 /* Glib objects force use to use a talloc destructor as well, (but not
223 * nearly as ugly as the for messages due to C++ objects). At
224 * this point, I'd really like to have some talloc-friendly
225 * equivalents for the few pieces of glib that I'm using. */
227 _notmuch_threads_destructor (notmuch_threads_t *threads)
229 g_hash_table_unref (threads->threads);
235 notmuch_query_search_threads (notmuch_query_t *query)
237 notmuch_threads_t *threads;
239 threads = talloc (query, notmuch_threads_t);
243 threads->query = query;
244 threads->threads = g_hash_table_new_full (g_str_hash, g_str_equal,
247 threads->messages = notmuch_query_search_messages (query);
249 threads->thread_id = NULL;
251 talloc_set_destructor (threads, _notmuch_threads_destructor);
257 notmuch_query_destroy (notmuch_query_t *query)
263 notmuch_threads_valid (notmuch_threads_t *threads)
265 notmuch_message_t *message;
267 if (threads->thread_id)
270 while (notmuch_messages_valid (threads->messages))
272 message = notmuch_messages_get (threads->messages);
274 threads->thread_id = notmuch_message_get_thread_id (message);
276 if (! g_hash_table_lookup_extended (threads->threads,
280 g_hash_table_insert (threads->threads,
281 xstrdup (threads->thread_id), NULL);
282 notmuch_messages_move_to_next (threads->messages);
286 notmuch_messages_move_to_next (threads->messages);
289 threads->thread_id = NULL;
294 notmuch_threads_get (notmuch_threads_t *threads)
296 if (! notmuch_threads_valid (threads))
299 return _notmuch_thread_create (threads->query,
300 threads->query->notmuch,
302 threads->query->query_string);
306 notmuch_threads_move_to_next (notmuch_threads_t *threads)
308 threads->thread_id = NULL;
312 notmuch_threads_destroy (notmuch_threads_t *threads)
314 talloc_free (threads);
318 notmuch_query_count_messages (notmuch_query_t *query)
320 notmuch_database_t *notmuch = query->notmuch;
321 const char *query_string = query->query_string;
322 Xapian::doccount count = 0;
325 Xapian::Enquire enquire (*notmuch->xapian_db);
326 Xapian::Query mail_query (talloc_asprintf (query, "%s%s",
327 _find_prefix ("type"),
329 Xapian::Query string_query, final_query;
331 unsigned int flags = (Xapian::QueryParser::FLAG_BOOLEAN |
332 Xapian::QueryParser::FLAG_PHRASE |
333 Xapian::QueryParser::FLAG_LOVEHATE |
334 Xapian::QueryParser::FLAG_BOOLEAN_ANY_CASE |
335 Xapian::QueryParser::FLAG_WILDCARD |
336 Xapian::QueryParser::FLAG_PURE_NOT);
338 if (strcmp (query_string, "") == 0 ||
339 strcmp (query_string, "*") == 0)
341 final_query = mail_query;
343 string_query = notmuch->query_parser->
344 parse_query (query_string, flags);
345 final_query = Xapian::Query (Xapian::Query::OP_AND,
346 mail_query, string_query);
349 enquire.set_weighting_scheme(Xapian::BoolWeight());
350 enquire.set_docid_order(Xapian::Enquire::ASCENDING);
353 fprintf (stderr, "Final query is:\n%s\n", final_query.get_description().c_str());
356 enquire.set_query (final_query);
358 mset = enquire.get_mset (0, notmuch->xapian_db->get_doccount ());
360 count = mset.get_matches_estimated();
362 } catch (const Xapian::Error &error) {
363 fprintf (stderr, "A Xapian exception occurred: %s\n",
364 error.get_msg().c_str());
365 fprintf (stderr, "Query string was: %s\n", query->query_string);