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 */
26 struct _notmuch_query {
27 notmuch_database_t *notmuch;
28 const char *query_string;
30 notmuch_string_list_t *exclude_terms;
31 notmuch_bool_t omit_excluded_messages;
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_doc_id_set {
46 #define DOCIDSET_WORD(bit) ((bit) / sizeof (unsigned int))
47 #define DOCIDSET_BIT(bit) ((bit) % sizeof (unsigned int))
49 struct visible _notmuch_threads {
50 notmuch_query_t *query;
52 /* The ordered list of doc ids matched by the query. */
54 /* Our iterator's current position in doc_ids. */
55 unsigned int doc_id_pos;
56 /* The set of matched docid's that have not been assigned to a
57 * thread. Initially, this contains every docid in doc_ids. */
58 notmuch_doc_id_set_t match_set;
61 /* We need this in the message functions so forward declare. */
63 _notmuch_doc_id_set_init (void *ctx,
64 notmuch_doc_id_set_t *doc_ids,
70 char *env = getenv ("NOTMUCH_DEBUG_QUERY");
71 return (env && strcmp (env, "") != 0);
75 notmuch_query_create (notmuch_database_t *notmuch,
76 const char *query_string)
78 notmuch_query_t *query;
81 fprintf (stderr, "Query string is:\n%s\n", query_string);
83 query = talloc (NULL, notmuch_query_t);
84 if (unlikely (query == NULL))
87 query->notmuch = notmuch;
89 query->query_string = talloc_strdup (query, query_string);
91 query->sort = NOTMUCH_SORT_NEWEST_FIRST;
93 query->exclude_terms = _notmuch_string_list_create (query);
95 query->omit_excluded_messages = FALSE;
101 notmuch_query_get_query_string (notmuch_query_t *query)
103 return query->query_string;
107 notmuch_query_set_omit_excluded_messages (notmuch_query_t *query, notmuch_bool_t omit)
109 query->omit_excluded_messages = omit;
113 notmuch_query_set_sort (notmuch_query_t *query, notmuch_sort_t sort)
119 notmuch_query_get_sort (notmuch_query_t *query)
125 notmuch_query_add_tag_exclude (notmuch_query_t *query, const char *tag)
127 char *term = talloc_asprintf (query, "%s%s", _find_prefix ("tag"), tag);
128 _notmuch_string_list_append (query->exclude_terms, term);
131 /* We end up having to call the destructors explicitly because we had
132 * to use "placement new" in order to initialize C++ objects within a
133 * block that we allocated with talloc. So C++ is making talloc
134 * slightly less simple to use, (we wouldn't need
135 * talloc_set_destructor at all otherwise).
138 _notmuch_messages_destructor (notmuch_mset_messages_t *messages)
140 messages->iterator.~MSetIterator ();
141 messages->iterator_end.~MSetIterator ();
146 /* Return a query that matches messages with the excluded tags
147 * registered with query. Any tags that explicitly appear in xquery
148 * will not be excluded, and will be removed from the list of exclude
149 * tags. The caller of this function has to combine the returned
150 * query appropriately.*/
152 _notmuch_exclude_tags (notmuch_query_t *query, Xapian::Query xquery)
154 Xapian::Query exclude_query = Xapian::Query::MatchNothing;
156 for (notmuch_string_node_t *term = query->exclude_terms->head; term;
158 Xapian::TermIterator it = xquery.get_terms_begin ();
159 Xapian::TermIterator end = xquery.get_terms_end ();
160 for (; it != end; it++) {
161 if ((*it).compare (term->string) == 0)
165 exclude_query = Xapian::Query (Xapian::Query::OP_OR,
166 exclude_query, Xapian::Query (term->string));
168 term->string = talloc_strdup (query, "");
170 return exclude_query;
174 notmuch_query_search_messages (notmuch_query_t *query)
176 notmuch_database_t *notmuch = query->notmuch;
177 const char *query_string = query->query_string;
178 notmuch_mset_messages_t *messages;
180 messages = talloc (query, notmuch_mset_messages_t);
181 if (unlikely (messages == NULL))
186 messages->base.is_of_list_type = FALSE;
187 messages->base.iterator = NULL;
188 messages->notmuch = notmuch;
189 new (&messages->iterator) Xapian::MSetIterator ();
190 new (&messages->iterator_end) Xapian::MSetIterator ();
192 talloc_set_destructor (messages, _notmuch_messages_destructor);
194 Xapian::Enquire enquire (*notmuch->xapian_db);
195 Xapian::Query mail_query (talloc_asprintf (query, "%s%s",
196 _find_prefix ("type"),
198 Xapian::Query string_query, final_query, exclude_query;
200 Xapian::MSetIterator iterator;
201 unsigned int flags = (Xapian::QueryParser::FLAG_BOOLEAN |
202 Xapian::QueryParser::FLAG_PHRASE |
203 Xapian::QueryParser::FLAG_LOVEHATE |
204 Xapian::QueryParser::FLAG_BOOLEAN_ANY_CASE |
205 Xapian::QueryParser::FLAG_WILDCARD |
206 Xapian::QueryParser::FLAG_PURE_NOT);
208 if (strcmp (query_string, "") == 0 ||
209 strcmp (query_string, "*") == 0)
211 final_query = mail_query;
213 string_query = notmuch->query_parser->
214 parse_query (query_string, flags);
215 final_query = Xapian::Query (Xapian::Query::OP_AND,
216 mail_query, string_query);
218 messages->base.excluded_doc_ids = NULL;
220 if (query->exclude_terms) {
221 exclude_query = _notmuch_exclude_tags (query, final_query);
222 exclude_query = Xapian::Query (Xapian::Query::OP_AND,
223 exclude_query, final_query);
225 if (query->omit_excluded_messages)
226 final_query = Xapian::Query (Xapian::Query::OP_AND_NOT,
227 final_query, exclude_query);
229 enquire.set_weighting_scheme (Xapian::BoolWeight());
230 enquire.set_query (exclude_query);
232 mset = enquire.get_mset (0, notmuch->xapian_db->get_doccount ());
234 GArray *excluded_doc_ids = g_array_new (FALSE, FALSE, sizeof (unsigned int));
236 for (iterator = mset.begin (); iterator != mset.end (); iterator++) {
237 unsigned int doc_id = *iterator;
238 g_array_append_val (excluded_doc_ids, doc_id);
240 messages->base.excluded_doc_ids = talloc (messages, _notmuch_doc_id_set);
241 _notmuch_doc_id_set_init (query, messages->base.excluded_doc_ids,
243 g_array_unref (excluded_doc_ids);
248 enquire.set_weighting_scheme (Xapian::BoolWeight());
250 switch (query->sort) {
251 case NOTMUCH_SORT_OLDEST_FIRST:
252 enquire.set_sort_by_value (NOTMUCH_VALUE_TIMESTAMP, FALSE);
254 case NOTMUCH_SORT_NEWEST_FIRST:
255 enquire.set_sort_by_value (NOTMUCH_VALUE_TIMESTAMP, TRUE);
257 case NOTMUCH_SORT_MESSAGE_ID:
258 enquire.set_sort_by_value (NOTMUCH_VALUE_MESSAGE_ID, FALSE);
260 case NOTMUCH_SORT_UNSORTED:
264 if (_debug_query ()) {
265 fprintf (stderr, "Exclude query is:\n%s\n",
266 exclude_query.get_description ().c_str ());
267 fprintf (stderr, "Final query is:\n%s\n",
268 final_query.get_description ().c_str ());
271 enquire.set_query (final_query);
273 mset = enquire.get_mset (0, notmuch->xapian_db->get_doccount ());
275 messages->iterator = mset.begin ();
276 messages->iterator_end = mset.end ();
278 return &messages->base;
280 } catch (const Xapian::Error &error) {
281 fprintf (stderr, "A Xapian exception occurred performing query: %s\n",
282 error.get_msg().c_str());
283 fprintf (stderr, "Query string was: %s\n", query->query_string);
284 notmuch->exception_reported = TRUE;
285 talloc_free (messages);
291 _notmuch_mset_messages_valid (notmuch_messages_t *messages)
293 notmuch_mset_messages_t *mset_messages;
295 mset_messages = (notmuch_mset_messages_t *) messages;
297 return (mset_messages->iterator != mset_messages->iterator_end);
301 _notmuch_mset_messages_get_doc_id (notmuch_messages_t *messages)
303 notmuch_mset_messages_t *mset_messages;
305 mset_messages = (notmuch_mset_messages_t *) messages;
307 if (! _notmuch_mset_messages_valid (&mset_messages->base))
310 return *mset_messages->iterator;
314 _notmuch_mset_messages_get (notmuch_messages_t *messages)
316 notmuch_message_t *message;
317 Xapian::docid doc_id;
318 notmuch_private_status_t status;
319 notmuch_mset_messages_t *mset_messages;
321 mset_messages = (notmuch_mset_messages_t *) messages;
323 if (! _notmuch_mset_messages_valid (&mset_messages->base))
326 doc_id = *mset_messages->iterator;
328 message = _notmuch_message_create (mset_messages,
329 mset_messages->notmuch, doc_id,
332 if (message == NULL &&
333 status == NOTMUCH_PRIVATE_STATUS_NO_DOCUMENT_FOUND)
335 INTERNAL_ERROR ("a messages iterator contains a non-existent document ID.\n");
338 if (messages->excluded_doc_ids &&
339 _notmuch_doc_id_set_contains (messages->excluded_doc_ids, doc_id))
340 notmuch_message_set_flag (message, NOTMUCH_MESSAGE_FLAG_EXCLUDED, TRUE);
346 _notmuch_mset_messages_move_to_next (notmuch_messages_t *messages)
348 notmuch_mset_messages_t *mset_messages;
350 mset_messages = (notmuch_mset_messages_t *) messages;
352 mset_messages->iterator++;
355 static notmuch_bool_t
356 _notmuch_doc_id_set_init (void *ctx,
357 notmuch_doc_id_set_t *doc_ids,
360 unsigned int max = 0;
361 unsigned int *bitmap;
363 for (unsigned int i = 0; i < arr->len; i++)
364 max = MAX(max, g_array_index (arr, unsigned int, i));
365 bitmap = talloc_zero_array (ctx, unsigned int, 1 + max / sizeof (*bitmap));
370 doc_ids->bitmap = bitmap;
371 doc_ids->bound = max + 1;
373 for (unsigned int i = 0; i < arr->len; i++) {
374 unsigned int doc_id = g_array_index (arr, unsigned int, i);
375 bitmap[DOCIDSET_WORD(doc_id)] |= 1 << DOCIDSET_BIT(doc_id);
382 _notmuch_doc_id_set_contains (notmuch_doc_id_set_t *doc_ids,
385 if (doc_id >= doc_ids->bound)
387 return doc_ids->bitmap[DOCIDSET_WORD(doc_id)] & (1 << DOCIDSET_BIT(doc_id));
391 _notmuch_doc_id_set_remove (notmuch_doc_id_set_t *doc_ids,
394 if (doc_id < doc_ids->bound)
395 doc_ids->bitmap[DOCIDSET_WORD(doc_id)] &= ~(1 << DOCIDSET_BIT(doc_id));
398 /* Glib objects force use to use a talloc destructor as well, (but not
399 * nearly as ugly as the for messages due to C++ objects). At
400 * this point, I'd really like to have some talloc-friendly
401 * equivalents for the few pieces of glib that I'm using. */
403 _notmuch_threads_destructor (notmuch_threads_t *threads)
405 if (threads->doc_ids)
406 g_array_unref (threads->doc_ids);
412 notmuch_query_search_threads (notmuch_query_t *query)
414 notmuch_threads_t *threads;
415 notmuch_messages_t *messages;
417 threads = talloc (query, notmuch_threads_t);
420 threads->doc_ids = NULL;
421 talloc_set_destructor (threads, _notmuch_threads_destructor);
423 threads->query = query;
425 messages = notmuch_query_search_messages (query);
426 if (messages == NULL) {
427 talloc_free (threads);
431 threads->doc_ids = g_array_new (FALSE, FALSE, sizeof (unsigned int));
432 while (notmuch_messages_valid (messages)) {
433 unsigned int doc_id = _notmuch_mset_messages_get_doc_id (messages);
434 g_array_append_val (threads->doc_ids, doc_id);
435 notmuch_messages_move_to_next (messages);
437 threads->doc_id_pos = 0;
439 talloc_free (messages);
441 if (! _notmuch_doc_id_set_init (threads, &threads->match_set,
443 talloc_free (threads);
451 notmuch_query_destroy (notmuch_query_t *query)
457 notmuch_threads_valid (notmuch_threads_t *threads)
461 while (threads->doc_id_pos < threads->doc_ids->len) {
462 doc_id = g_array_index (threads->doc_ids, unsigned int,
463 threads->doc_id_pos);
464 if (_notmuch_doc_id_set_contains (&threads->match_set, doc_id))
467 threads->doc_id_pos++;
470 return threads->doc_id_pos < threads->doc_ids->len;
474 notmuch_threads_get (notmuch_threads_t *threads)
478 if (! notmuch_threads_valid (threads))
481 doc_id = g_array_index (threads->doc_ids, unsigned int,
482 threads->doc_id_pos);
483 return _notmuch_thread_create (threads->query,
484 threads->query->notmuch,
487 threads->query->exclude_terms,
488 threads->query->sort);
492 notmuch_threads_move_to_next (notmuch_threads_t *threads)
494 threads->doc_id_pos++;
498 notmuch_threads_destroy (notmuch_threads_t *threads)
500 talloc_free (threads);
504 notmuch_query_count_messages (notmuch_query_t *query)
506 notmuch_database_t *notmuch = query->notmuch;
507 const char *query_string = query->query_string;
508 Xapian::doccount count = 0;
511 Xapian::Enquire enquire (*notmuch->xapian_db);
512 Xapian::Query mail_query (talloc_asprintf (query, "%s%s",
513 _find_prefix ("type"),
515 Xapian::Query string_query, final_query, exclude_query;
517 unsigned int flags = (Xapian::QueryParser::FLAG_BOOLEAN |
518 Xapian::QueryParser::FLAG_PHRASE |
519 Xapian::QueryParser::FLAG_LOVEHATE |
520 Xapian::QueryParser::FLAG_BOOLEAN_ANY_CASE |
521 Xapian::QueryParser::FLAG_WILDCARD |
522 Xapian::QueryParser::FLAG_PURE_NOT);
524 if (strcmp (query_string, "") == 0 ||
525 strcmp (query_string, "*") == 0)
527 final_query = mail_query;
529 string_query = notmuch->query_parser->
530 parse_query (query_string, flags);
531 final_query = Xapian::Query (Xapian::Query::OP_AND,
532 mail_query, string_query);
535 exclude_query = _notmuch_exclude_tags (query, final_query);
537 final_query = Xapian::Query (Xapian::Query::OP_AND_NOT,
538 final_query, exclude_query);
540 enquire.set_weighting_scheme(Xapian::BoolWeight());
541 enquire.set_docid_order(Xapian::Enquire::ASCENDING);
543 if (_debug_query ()) {
544 fprintf (stderr, "Exclude query is:\n%s\n",
545 exclude_query.get_description ().c_str ());
546 fprintf (stderr, "Final query is:\n%s\n",
547 final_query.get_description ().c_str ());
550 enquire.set_query (final_query);
552 mset = enquire.get_mset (0, notmuch->xapian_db->get_doccount ());
554 count = mset.get_matches_estimated();
556 } catch (const Xapian::Error &error) {
557 fprintf (stderr, "A Xapian exception occurred: %s\n",
558 error.get_msg().c_str());
559 fprintf (stderr, "Query string was: %s\n", query->query_string);
566 notmuch_query_count_threads (notmuch_query_t *query)
568 notmuch_messages_t *messages;
574 query->sort = NOTMUCH_SORT_UNSORTED;
575 messages = notmuch_query_search_messages (query);
577 if (messages == NULL)
580 hash = g_hash_table_new_full (g_str_hash, g_str_equal, NULL, NULL);
582 talloc_free (messages);
586 while (notmuch_messages_valid (messages)) {
587 notmuch_message_t *message = notmuch_messages_get (messages);
588 const char *thread_id = notmuch_message_get_thread_id (message);
589 char *thread_id_copy = talloc_strdup (messages, thread_id);
590 if (unlikely (thread_id_copy == NULL)) {
591 notmuch_message_destroy (message);
595 g_hash_table_insert (hash, thread_id_copy, NULL);
596 notmuch_message_destroy (message);
597 notmuch_messages_move_to_next (messages);
600 count = g_hash_table_size (hash);
603 g_hash_table_unref (hash);
604 talloc_free (messages);