lib: centralize query parsing, store results.
authorDavid Bremner <david@tethera.net>
Sat, 25 Feb 2017 16:09:11 +0000 (12:09 -0400)
committerDavid Bremner <david@tethera.net>
Sun, 5 Mar 2017 00:47:25 +0000 (20:47 -0400)
The main goal is to prepare the way for non-destructive (or at least
less destructive) exclude tag handling. It does this by having a
pre-parsed query available for further processing. This also allows us
to provide slightly more precise error messages.

lib/query.cc
test/T650-regexp-query.sh

index 4ccd81046128052f3461622e8a58c5c63af782f0..ba06bfebbcd450d756ab06f1fa631d467ff48733 100644 (file)
@@ -29,6 +29,8 @@ struct _notmuch_query {
     notmuch_sort_t sort;
     notmuch_string_list_t *exclude_terms;
     notmuch_exclude_t omit_excluded;
     notmuch_sort_t sort;
     notmuch_string_list_t *exclude_terms;
     notmuch_exclude_t omit_excluded;
+    notmuch_bool_t parsed;
+    Xapian::Query xapian_query;
 };
 
 typedef struct _notmuch_mset_messages {
 };
 
 typedef struct _notmuch_mset_messages {
@@ -71,6 +73,13 @@ _debug_query (void)
     return (env && strcmp (env, "") != 0);
 }
 
     return (env && strcmp (env, "") != 0);
 }
 
+/* Explicit destructor call for placement new */
+static int
+_notmuch_query_destructor (notmuch_query_t *query) {
+    query->xapian_query.~Query();
+    return 0;
+}
+
 notmuch_query_t *
 notmuch_query_create (notmuch_database_t *notmuch,
                      const char *query_string)
 notmuch_query_t *
 notmuch_query_create (notmuch_database_t *notmuch,
                      const char *query_string)
@@ -84,6 +93,11 @@ notmuch_query_create (notmuch_database_t *notmuch,
     if (unlikely (query == NULL))
        return NULL;
 
     if (unlikely (query == NULL))
        return NULL;
 
+    new (&query->xapian_query) Xapian::Query ();
+    query->parsed = FALSE;
+
+    talloc_set_destructor (query, _notmuch_query_destructor);
+
     query->notmuch = notmuch;
 
     query->query_string = talloc_strdup (query, query_string);
     query->notmuch = notmuch;
 
     query->query_string = talloc_strdup (query, query_string);
@@ -97,6 +111,35 @@ notmuch_query_create (notmuch_database_t *notmuch,
     return query;
 }
 
     return query;
 }
 
+static notmuch_status_t
+_notmuch_query_ensure_parsed (notmuch_query_t *query)
+{
+    if (query->parsed)
+       return NOTMUCH_STATUS_SUCCESS;
+
+    try {
+       query->xapian_query =
+           query->notmuch->query_parser->
+               parse_query (query->query_string, NOTMUCH_QUERY_PARSER_FLAGS);
+
+       query->parsed = TRUE;
+
+    } catch (const Xapian::Error &error) {
+       if (!query->notmuch->exception_reported) {
+           _notmuch_database_log (query->notmuch,
+                                  "A Xapian exception occurred parsing query: %s\n",
+                                  error.get_msg ().c_str ());
+           _notmuch_database_log_append (query->notmuch,
+                                         "Query string was: %s\n",
+                                         query->query_string);
+           query->notmuch->exception_reported = TRUE;
+       }
+
+       return NOTMUCH_STATUS_XAPIAN_EXCEPTION;
+    }
+    return NOTMUCH_STATUS_SUCCESS;
+}
+
 const char *
 notmuch_query_get_query_string (const notmuch_query_t *query)
 {
 const char *
 notmuch_query_get_query_string (const notmuch_query_t *query)
 {
@@ -198,6 +241,11 @@ _notmuch_query_search_documents (notmuch_query_t *query,
     notmuch_database_t *notmuch = query->notmuch;
     const char *query_string = query->query_string;
     notmuch_mset_messages_t *messages;
     notmuch_database_t *notmuch = query->notmuch;
     const char *query_string = query->query_string;
     notmuch_mset_messages_t *messages;
+    notmuch_status_t status;
+
+    status = _notmuch_query_ensure_parsed (query);
+    if (status)
+       return status;
 
     messages = talloc (query, notmuch_mset_messages_t);
     if (unlikely (messages == NULL))
 
     messages = talloc (query, notmuch_mset_messages_t);
     if (unlikely (messages == NULL))
@@ -217,7 +265,7 @@ _notmuch_query_search_documents (notmuch_query_t *query,
        Xapian::Query mail_query (talloc_asprintf (query, "%s%s",
                                                   _find_prefix ("type"),
                                                   type));
        Xapian::Query mail_query (talloc_asprintf (query, "%s%s",
                                                   _find_prefix ("type"),
                                                   type));
-       Xapian::Query string_query, final_query, exclude_query;
+       Xapian::Query final_query, exclude_query;
        Xapian::MSet mset;
        Xapian::MSetIterator iterator;
 
        Xapian::MSet mset;
        Xapian::MSetIterator iterator;
 
@@ -226,10 +274,8 @@ _notmuch_query_search_documents (notmuch_query_t *query,
        {
            final_query = mail_query;
        } else {
        {
            final_query = mail_query;
        } else {
-           string_query = notmuch->query_parser->
-               parse_query (query_string, NOTMUCH_QUERY_PARSER_FLAGS);
            final_query = Xapian::Query (Xapian::Query::OP_AND,
            final_query = Xapian::Query (Xapian::Query::OP_AND,
-                                        mail_query, string_query);
+                                        mail_query, query->xapian_query);
        }
        messages->base.excluded_doc_ids = NULL;
 
        }
        messages->base.excluded_doc_ids = NULL;
 
@@ -566,13 +612,18 @@ _notmuch_query_count_documents (notmuch_query_t *query, const char *type, unsign
     notmuch_database_t *notmuch = query->notmuch;
     const char *query_string = query->query_string;
     Xapian::doccount count = 0;
     notmuch_database_t *notmuch = query->notmuch;
     const char *query_string = query->query_string;
     Xapian::doccount count = 0;
+    notmuch_status_t status;
+
+    status = _notmuch_query_ensure_parsed (query);
+    if (status)
+       return status;
 
     try {
        Xapian::Enquire enquire (*notmuch->xapian_db);
        Xapian::Query mail_query (talloc_asprintf (query, "%s%s",
                                                   _find_prefix ("type"),
                                                   type));
 
     try {
        Xapian::Enquire enquire (*notmuch->xapian_db);
        Xapian::Query mail_query (talloc_asprintf (query, "%s%s",
                                                   _find_prefix ("type"),
                                                   type));
-       Xapian::Query string_query, final_query, exclude_query;
+       Xapian::Query final_query, exclude_query;
        Xapian::MSet mset;
 
        if (strcmp (query_string, "") == 0 ||
        Xapian::MSet mset;
 
        if (strcmp (query_string, "") == 0 ||
@@ -580,10 +631,8 @@ _notmuch_query_count_documents (notmuch_query_t *query, const char *type, unsign
        {
            final_query = mail_query;
        } else {
        {
            final_query = mail_query;
        } else {
-           string_query = notmuch->query_parser->
-               parse_query (query_string, NOTMUCH_QUERY_PARSER_FLAGS);
            final_query = Xapian::Query (Xapian::Query::OP_AND,
            final_query = Xapian::Query (Xapian::Query::OP_AND,
-                                        mail_query, string_query);
+                                        mail_query, query->xapian_query);
        }
 
        exclude_query = _notmuch_exclude_tags (query, final_query);
        }
 
        exclude_query = _notmuch_exclude_tags (query, final_query);
index a803961014007f1baad5810ad7e75eb82345e998..df48ab82511cb7a2af0243fa1c6591557c8cf5c3 100755 (executable)
@@ -74,7 +74,7 @@ test_begin_subtest "regexp error reporting"
 notmuch search 'from:/unbalanced[/' 1>OUTPUT 2>&1
 cat <<EOF > EXPECTED
 notmuch search: A Xapian exception occurred
 notmuch search 'from:/unbalanced[/' 1>OUTPUT 2>&1
 cat <<EOF > EXPECTED
 notmuch search: A Xapian exception occurred
-A Xapian exception occurred performing query: Invalid regular expression
+A Xapian exception occurred parsing query: Invalid regular expression
 Query string was: from:/unbalanced[/
 EOF
 test_expect_equal_file EXPECTED OUTPUT
 Query string was: from:/unbalanced[/
 EOF
 test_expect_equal_file EXPECTED OUTPUT