]> git.notmuchmail.org Git - notmuch/blobdiff - lib/query.cc
emacs: Add new option notmuch-search-hide-excluded
[notmuch] / lib / query.cc
index d633fa3d908ae08c1e1493b6caa29b8d3570c409..1c60c122c8e9eedd22b2e5481e8e189719551994 100644 (file)
@@ -20,6 +20,7 @@
 
 #include "notmuch-private.h"
 #include "database-private.h"
+#include "xapian-extra.h"
 
 #include <glib.h> /* GHashTable, GPtrArray */
 
@@ -30,6 +31,7 @@ struct _notmuch_query {
     notmuch_string_list_t *exclude_terms;
     notmuch_exclude_t omit_excluded;
     bool parsed;
+    notmuch_query_syntax_t syntax;
     Xapian::Query xapian_query;
     std::set<std::string> terms;
 };
@@ -71,20 +73,22 @@ static bool
 _debug_query (void)
 {
     char *env = getenv ("NOTMUCH_DEBUG_QUERY");
+
     return (env && strcmp (env, "") != 0);
 }
 
 /* Explicit destructor call for placement new */
 static int
-_notmuch_query_destructor (notmuch_query_t *query) {
+_notmuch_query_destructor (notmuch_query_t *query)
+{
     query->xapian_query.~Query();
     query->terms.~set<std::string>();
     return 0;
 }
 
-notmuch_query_t *
-notmuch_query_create (notmuch_database_t *notmuch,
-                     const char *query_string)
+static notmuch_query_t *
+_notmuch_query_constructor (notmuch_database_t *notmuch,
+                           const char *query_string)
 {
     notmuch_query_t *query;
 
@@ -103,7 +107,10 @@ notmuch_query_create (notmuch_database_t *notmuch,
 
     query->notmuch = notmuch;
 
-    query->query_string = talloc_strdup (query, query_string);
+    if (query_string)
+       query->query_string = talloc_strdup (query, query_string);
+    else
+       query->query_string = NULL;
 
     query->sort = NOTMUCH_SORT_NEWEST_FIRST;
 
@@ -114,44 +121,146 @@ notmuch_query_create (notmuch_database_t *notmuch,
     return query;
 }
 
-static notmuch_status_t
-_notmuch_query_ensure_parsed (notmuch_query_t *query)
+notmuch_query_t *
+notmuch_query_create (notmuch_database_t *notmuch,
+                     const char *query_string)
 {
-    if (query->parsed)
-       return NOTMUCH_STATUS_SUCCESS;
 
-    try {
-       query->xapian_query =
-           query->notmuch->query_parser->
-               parse_query (query->query_string, NOTMUCH_QUERY_PARSER_FLAGS);
+    notmuch_query_t *query;
+    notmuch_status_t status;
+
+    status = notmuch_query_create_with_syntax (notmuch, query_string,
+                                              NOTMUCH_QUERY_SYNTAX_XAPIAN,
+                                              &query);
+    if (status)
+       return NULL;
+
+    return query;
+}
+
+notmuch_status_t
+notmuch_query_create_with_syntax (notmuch_database_t *notmuch,
+                                 const char *query_string,
+                                 notmuch_query_syntax_t syntax,
+                                 notmuch_query_t **output)
+{
+
+    notmuch_query_t *query;
+
+    if (! output)
+       return NOTMUCH_STATUS_NULL_POINTER;
+
+    query = _notmuch_query_constructor (notmuch, query_string);
+    if (! query)
+       return NOTMUCH_STATUS_OUT_OF_MEMORY;
+
+    if (syntax == NOTMUCH_QUERY_SYNTAX_SEXP && ! HAVE_SFSEXP) {
+       _notmuch_database_log (notmuch, "sexp query parser not available");
+       return NOTMUCH_STATUS_ILLEGAL_ARGUMENT;
+    }
+
+    query->syntax = syntax;
 
-       /* Xapian doesn't support skip_to on terms from a query since
-       *  they are unordered, so cache a copy of all terms in
-       *  something searchable.
-       */
+    *output = query;
+
+    return NOTMUCH_STATUS_SUCCESS;
+}
 
-       for (Xapian::TermIterator t = query->xapian_query.get_terms_begin ();
-            t != query->xapian_query.get_terms_end (); ++t)
-           query->terms.insert (*t);
+static void
+_notmuch_query_cache_terms (notmuch_query_t *query)
+{
+    /* Xapian doesn't support skip_to on terms from a query since
+     *  they are unordered, so cache a copy of all terms in
+     *  something searchable.
+     */
 
-       query->parsed = true;
+    for (Xapian::TermIterator t = query->xapian_query.get_terms_begin ();
+        t != query->xapian_query.get_terms_end (); ++t)
+       query->terms.insert (*t);
+}
 
+notmuch_status_t
+_notmuch_query_string_to_xapian_query (notmuch_database_t *notmuch,
+                                      std::string query_string,
+                                      Xapian::Query &output,
+                                      std::string &msg)
+{
+    try {
+       if (query_string == "" || query_string == "*") {
+           output = xapian_query_match_all ();
+       } else {
+           output =
+               notmuch->query_parser->
+               parse_query (query_string, NOTMUCH_QUERY_PARSER_FLAGS);
+       }
     } catch (const Xapian::Error &error) {
-       if (!query->notmuch->exception_reported) {
-           _notmuch_database_log (query->notmuch,
+       if (! notmuch->exception_reported) {
+           _notmuch_database_log (notmuch,
                                   "A Xapian exception occurred parsing query: %s\n",
                                   error.get_msg ().c_str ());
-           _notmuch_database_log_append (query->notmuch,
+           _notmuch_database_log_append (notmuch,
                                          "Query string was: %s\n",
-                                         query->query_string);
-           query->notmuch->exception_reported = true;
+                                         query_string.c_str ());
+           notmuch->exception_reported = true;
        }
 
+       msg = error.get_msg ();
        return NOTMUCH_STATUS_XAPIAN_EXCEPTION;
     }
     return NOTMUCH_STATUS_SUCCESS;
 }
 
+static notmuch_status_t
+_notmuch_query_ensure_parsed_xapian (notmuch_query_t *query)
+{
+    notmuch_status_t status;
+    std::string msg; /* ignored */
+
+    status =  _notmuch_query_string_to_xapian_query (query->notmuch, query->query_string,
+                                                    query->xapian_query, msg);
+    if (status)
+       return status;
+
+    query->parsed = true;
+
+    _notmuch_query_cache_terms (query);
+
+    return NOTMUCH_STATUS_SUCCESS;
+}
+
+#if HAVE_SFSEXP
+static notmuch_status_t
+_notmuch_query_ensure_parsed_sexpr (notmuch_query_t *query)
+{
+    notmuch_status_t status;
+
+    if (query->parsed)
+       return NOTMUCH_STATUS_SUCCESS;
+
+    status = _notmuch_sexp_string_to_xapian_query (query->notmuch, query->query_string,
+                                                  query->xapian_query);
+    if (status)
+       return status;
+
+    _notmuch_query_cache_terms (query);
+    return NOTMUCH_STATUS_SUCCESS;
+}
+#endif
+
+static notmuch_status_t
+_notmuch_query_ensure_parsed (notmuch_query_t *query)
+{
+    if (query->parsed)
+       return NOTMUCH_STATUS_SUCCESS;
+
+#if HAVE_SFSEXP
+    if (query->syntax == NOTMUCH_QUERY_SYNTAX_SEXP)
+       return _notmuch_query_ensure_parsed_sexpr (query);
+#endif
+
+    return _notmuch_query_ensure_parsed_xapian (query);
+}
+
 const char *
 notmuch_query_get_query_string (const notmuch_query_t *query)
 {
@@ -188,7 +297,7 @@ notmuch_query_add_tag_exclude (notmuch_query_t *query, const char *tag)
        return status;
 
     term = talloc_asprintf (query, "%s%s", _find_prefix ("tag"), tag);
-    if (query->terms.count(term) != 0)
+    if (query->terms.count (term) != 0)
        return NOTMUCH_STATUS_IGNORED;
 
     _notmuch_string_list_append (query->exclude_terms, term);
@@ -236,7 +345,7 @@ notmuch_query_search_messages_st (notmuch_query_t *query,
 
 notmuch_status_t
 notmuch_query_search_messages (notmuch_query_t *query,
-                                 notmuch_messages_t **out)
+                              notmuch_messages_t **out)
 {
     return _notmuch_query_search_documents (query, "mail", out);
 }
@@ -247,7 +356,6 @@ _notmuch_query_search_documents (notmuch_query_t *query,
                                 notmuch_messages_t **out)
 {
     notmuch_database_t *notmuch = query->notmuch;
-    const char *query_string = query->query_string;
     notmuch_mset_messages_t *messages;
     notmuch_status_t status;
 
@@ -277,29 +385,23 @@ _notmuch_query_search_documents (notmuch_query_t *query,
        Xapian::MSet mset;
        Xapian::MSetIterator iterator;
 
-       if (strcmp (query_string, "") == 0 ||
-           strcmp (query_string, "*") == 0)
-       {
-           final_query = mail_query;
-       } else {
-           final_query = Xapian::Query (Xapian::Query::OP_AND,
-                                        mail_query, query->xapian_query);
-       }
+       final_query = Xapian::Query (Xapian::Query::OP_AND,
+                                    mail_query, query->xapian_query);
+
        messages->base.excluded_doc_ids = NULL;
 
        if ((query->omit_excluded != NOTMUCH_EXCLUDE_FALSE) && (query->exclude_terms)) {
            exclude_query = _notmuch_exclude_tags (query);
 
            if (query->omit_excluded == NOTMUCH_EXCLUDE_TRUE ||
-               query->omit_excluded == NOTMUCH_EXCLUDE_ALL)
-           {
+               query->omit_excluded == NOTMUCH_EXCLUDE_ALL) {
                final_query = Xapian::Query (Xapian::Query::OP_AND_NOT,
                                             final_query, exclude_query);
            } else { /* NOTMUCH_EXCLUDE_FLAG */
                exclude_query = Xapian::Query (Xapian::Query::OP_AND,
-                                          exclude_query, final_query);
+                                              exclude_query, final_query);
 
-               enquire.set_weighting_scheme (Xapian::BoolWeight());
+               enquire.set_weighting_scheme (Xapian::BoolWeight ());
                enquire.set_query (exclude_query);
 
                mset = enquire.get_mset (0, notmuch->xapian_db->get_doccount ());
@@ -318,7 +420,7 @@ _notmuch_query_search_documents (notmuch_query_t *query,
        }
 
 
-       enquire.set_weighting_scheme (Xapian::BoolWeight());
+       enquire.set_weighting_scheme (Xapian::BoolWeight ());
 
        switch (query->sort) {
        case NOTMUCH_SORT_OLDEST_FIRST:
@@ -354,10 +456,10 @@ _notmuch_query_search_documents (notmuch_query_t *query,
     } catch (const Xapian::Error &error) {
        _notmuch_database_log (notmuch,
                               "A Xapian exception occurred performing query: %s\n",
-                              error.get_msg().c_str());
+                              error.get_msg ().c_str ());
        _notmuch_database_log_append (notmuch,
-                              "Query string was: %s\n",
-                              query->query_string);
+                                     "Query string was: %s\n",
+                                     query->query_string);
 
        notmuch->exception_reported = true;
        talloc_free (messages);
@@ -408,8 +510,7 @@ _notmuch_mset_messages_get (notmuch_messages_t *messages)
                                       &status);
 
     if (message == NULL &&
-       status == NOTMUCH_PRIVATE_STATUS_NO_DOCUMENT_FOUND)
-    {
+       status == NOTMUCH_PRIVATE_STATUS_NO_DOCUMENT_FOUND) {
        INTERNAL_ERROR ("a messages iterator contains a non-existent document ID.\n");
     }
 
@@ -439,8 +540,8 @@ _notmuch_doc_id_set_init (void *ctx,
     unsigned char *bitmap;
 
     for (unsigned int i = 0; i < arr->len; i++)
-       max = MAX(max, g_array_index (arr, unsigned int, i));
-    bitmap = talloc_zero_array (ctx, unsigned char, DOCIDSET_WORD(max) + 1);
+       max = MAX (max, g_array_index (arr, unsigned int, i));
+    bitmap = talloc_zero_array (ctx, unsigned char, DOCIDSET_WORD (max) + 1);
 
     if (bitmap == NULL)
        return false;
@@ -450,7 +551,7 @@ _notmuch_doc_id_set_init (void *ctx,
 
     for (unsigned int i = 0; i < arr->len; i++) {
        unsigned int doc_id = g_array_index (arr, unsigned int, i);
-       bitmap[DOCIDSET_WORD(doc_id)] |= 1 << DOCIDSET_BIT(doc_id);
+       bitmap[DOCIDSET_WORD (doc_id)] |= 1 << DOCIDSET_BIT (doc_id);
     }
 
     return true;
@@ -462,7 +563,7 @@ _notmuch_doc_id_set_contains (notmuch_doc_id_set_t *doc_ids,
 {
     if (doc_id >= doc_ids->bound)
        return false;
-    return doc_ids->bitmap[DOCIDSET_WORD(doc_id)] & (1 << DOCIDSET_BIT(doc_id));
+    return doc_ids->bitmap[DOCIDSET_WORD (doc_id)] & (1 << DOCIDSET_BIT (doc_id));
 }
 
 void
@@ -470,7 +571,7 @@ _notmuch_doc_id_set_remove (notmuch_doc_id_set_t *doc_ids,
                            unsigned int doc_id)
 {
     if (doc_id < doc_ids->bound)
-       doc_ids->bitmap[DOCIDSET_WORD(doc_id)] &= ~(1 << DOCIDSET_BIT(doc_id));
+       doc_ids->bitmap[DOCIDSET_WORD (doc_id)] &= ~(1 << DOCIDSET_BIT (doc_id));
 }
 
 /* Glib objects force use to use a talloc destructor as well, (but not
@@ -489,7 +590,7 @@ _notmuch_threads_destructor (notmuch_threads_t *threads)
 notmuch_status_t
 notmuch_query_search_threads_st (notmuch_query_t *query, notmuch_threads_t **out)
 {
-    return notmuch_query_search_threads(query, out);
+    return notmuch_query_search_threads (query, out);
 }
 
 notmuch_status_t
@@ -607,7 +708,6 @@ notmuch_status_t
 _notmuch_query_count_documents (notmuch_query_t *query, const char *type, unsigned *count_out)
 {
     notmuch_database_t *notmuch = query->notmuch;
-    const char *query_string = query->query_string;
     Xapian::doccount count = 0;
     notmuch_status_t status;
 
@@ -623,22 +723,16 @@ _notmuch_query_count_documents (notmuch_query_t *query, const char *type, unsign
        Xapian::Query final_query, exclude_query;
        Xapian::MSet mset;
 
-       if (strcmp (query_string, "") == 0 ||
-           strcmp (query_string, "*") == 0)
-       {
-           final_query = mail_query;
-       } else {
-           final_query = Xapian::Query (Xapian::Query::OP_AND,
-                                        mail_query, query->xapian_query);
-       }
+       final_query = Xapian::Query (Xapian::Query::OP_AND,
+                                    mail_query, query->xapian_query);
 
        exclude_query = _notmuch_exclude_tags (query);
 
        final_query = Xapian::Query (Xapian::Query::OP_AND_NOT,
-                                        final_query, exclude_query);
+                                    final_query, exclude_query);
 
-       enquire.set_weighting_scheme(Xapian::BoolWeight());
-       enquire.set_docid_order(Xapian::Enquire::ASCENDING);
+       enquire.set_weighting_scheme (Xapian::BoolWeight ());
+       enquire.set_docid_order (Xapian::Enquire::ASCENDING);
 
        if (_debug_query ()) {
            fprintf (stderr, "Exclude query is:\n%s\n",
@@ -652,17 +746,17 @@ _notmuch_query_count_documents (notmuch_query_t *query, const char *type, unsign
        /*
         * Set the checkatleast parameter to the number of documents
         * in the database to make get_matches_estimated() exact.
-        * Set the max parameter to 0 to avoid fetching documents we will discard.
+        * Set the max parameter to 1 to avoid fetching documents we will discard.
         */
-       mset = enquire.get_mset (0, 0,
+       mset = enquire.get_mset (0, 1,
                                 notmuch->xapian_db->get_doccount ());
 
-       count = mset.get_matches_estimated();
+       count = mset.get_matches_estimated ();
 
     } catch (const Xapian::Error &error) {
        _notmuch_database_log (notmuch,
                               "A Xapian exception occurred performing query: %s\n",
-                              error.get_msg().c_str());
+                              error.get_msg ().c_str ());
        _notmuch_database_log_append (notmuch,
                                      "Query string was: %s\n",
                                      query->query_string);
@@ -730,3 +824,51 @@ notmuch_query_get_database (const notmuch_query_t *query)
 {
     return query->notmuch;
 }
+
+notmuch_status_t
+_notmuch_query_expand (notmuch_database_t *notmuch, const char *field, Xapian::Query subquery,
+                      Xapian::Query &output, std::string &msg)
+{
+    std::set<std::string> terms;
+    const std::string term_prefix =  _find_prefix (field);
+
+    if (_debug_query ()) {
+       fprintf (stderr, "Expanding subquery:\n%s\n",
+                subquery.get_description ().c_str ());
+    }
+
+    try {
+       Xapian::Enquire enquire (*notmuch->xapian_db);
+       Xapian::MSet mset;
+
+       enquire.set_weighting_scheme (Xapian::BoolWeight ());
+       enquire.set_query (subquery);
+
+       mset = enquire.get_mset (0, notmuch->xapian_db->get_doccount ());
+
+       for (Xapian::MSetIterator iterator = mset.begin (); iterator != mset.end (); iterator++) {
+           Xapian::docid doc_id = *iterator;
+           Xapian::Document doc = notmuch->xapian_db->get_document (doc_id);
+           Xapian::TermIterator i = doc.termlist_begin ();
+
+           for (i.skip_to (term_prefix);
+                i != doc.termlist_end () && ((*i).rfind (term_prefix, 0) == 0); i++) {
+               terms.insert (*i);
+           }
+       }
+       output = Xapian::Query (Xapian::Query::OP_OR, terms.begin (), terms.end ());
+       if (_debug_query ()) {
+           fprintf (stderr, "Expanded query:\n%s\n",
+                    subquery.get_description ().c_str ());
+       }
+
+    } catch (const Xapian::Error &error) {
+       _notmuch_database_log (notmuch,
+                              "A Xapian exception occurred expanding query: %s\n",
+                              error.get_msg ().c_str ());
+       msg = error.get_msg ();
+       return NOTMUCH_STATUS_XAPIAN_EXCEPTION;
+    }
+
+    return NOTMUCH_STATUS_SUCCESS;
+}