]> git.notmuchmail.org Git - notmuch/blobdiff - lib/parse-sexp.cc
lib/parse-sexp: handle lastmod queries.
[notmuch] / lib / parse-sexp.cc
index 8f7c26c2fe9b99473cfb6f3af6c20f7123957125..06825dc477377d3b4570a760abffce8d626cfe0c 100644 (file)
@@ -7,9 +7,18 @@
 /* _sexp is used for file scope symbols to avoid clashing with
  * definitions from sexp.h */
 
-typedef struct {
+/* sexp_binding structs attach name to a sexp and a defining
+ * context. The latter allows lazy evaluation of parameters whose
+ * definition contains other parameters.  Lazy evaluation is needed
+ * because a primary goal of macros is to change the parent field for
+ * a sexp.
+ */
+
+typedef struct sexp_binding {
     const char *name;
     const sexp_t *sx;
+    const struct sexp_binding *context;
+    const struct sexp_binding *next;
 } _sexp_binding_t;
 
 typedef enum {
@@ -23,6 +32,7 @@ typedef enum {
     SEXP_FLAG_EXPAND   = 1 << 6,
     SEXP_FLAG_DO_EXPAND = 1 << 7,
     SEXP_FLAG_ORPHAN   = 1 << 8,
+    SEXP_FLAG_RANGE    = 1 << 9,
 } _sexp_flag_t;
 
 /*
@@ -57,6 +67,8 @@ static _sexp_prefix_t prefixes[] =
       SEXP_FLAG_FIELD | SEXP_FLAG_WILDCARD | SEXP_FLAG_EXPAND },
     { "body",           Xapian::Query::OP_AND,          Xapian::Query::MatchAll,
       SEXP_FLAG_FIELD },
+    { "date",           Xapian::Query::OP_INVALID,      Xapian::Query::MatchAll,
+      SEXP_FLAG_RANGE },
     { "from",           Xapian::Query::OP_AND,          Xapian::Query::MatchAll,
       SEXP_FLAG_FIELD | SEXP_FLAG_WILDCARD | SEXP_FLAG_REGEX | SEXP_FLAG_EXPAND },
     { "folder",         Xapian::Query::OP_OR,           Xapian::Query::MatchNothing,
@@ -67,6 +79,8 @@ static _sexp_prefix_t prefixes[] =
       SEXP_FLAG_SINGLE | SEXP_FLAG_ORPHAN },
     { "is",             Xapian::Query::OP_AND,          Xapian::Query::MatchAll,
       SEXP_FLAG_FIELD | SEXP_FLAG_BOOLEAN | SEXP_FLAG_WILDCARD | SEXP_FLAG_REGEX | SEXP_FLAG_EXPAND },
+    { "lastmod",           Xapian::Query::OP_INVALID,      Xapian::Query::MatchAll,
+      SEXP_FLAG_RANGE },
     { "matching",       Xapian::Query::OP_AND,          Xapian::Query::MatchAll,
       SEXP_FLAG_DO_EXPAND },
     { "mid",            Xapian::Query::OP_OR,           Xapian::Query::MatchNothing,
@@ -302,6 +316,81 @@ _sexp_parse_header (notmuch_database_t *notmuch, const _sexp_prefix_t *parent,
                                sx->list->next, output);
 }
 
+static _sexp_binding_t *
+_sexp_bind (void *ctx, const _sexp_binding_t *env, const char *name, const sexp_t *sx, const
+           _sexp_binding_t *context)
+{
+    _sexp_binding_t *binding = talloc (ctx, _sexp_binding_t);
+
+    binding->name = talloc_strdup (ctx, name);
+    binding->sx = sx;
+    binding->context = context;
+    binding->next = env;
+    return binding;
+}
+
+static notmuch_status_t
+maybe_apply_macro (notmuch_database_t *notmuch, const _sexp_prefix_t *parent,
+                  const _sexp_binding_t *env, const sexp_t *sx, const sexp_t *args,
+                  Xapian::Query &output)
+{
+    const sexp_t *params, *param, *arg, *body;
+    void *local = talloc_new (notmuch);
+    _sexp_binding_t *new_env = NULL;
+    notmuch_status_t status = NOTMUCH_STATUS_SUCCESS;
+
+    if (sx->list->ty != SEXP_VALUE || strcmp (sx->list->val, "macro") != 0) {
+       status = NOTMUCH_STATUS_IGNORED;
+       goto DONE;
+    }
+
+    params = sx->list->next;
+
+    if (! params || (params->ty != SEXP_LIST)) {
+       _notmuch_database_log (notmuch, "missing (possibly empty) list of arguments to macro\n");
+       return NOTMUCH_STATUS_BAD_QUERY_SYNTAX;
+    }
+
+    body = params->next;
+
+    if (! body) {
+       _notmuch_database_log (notmuch, "missing body of macro\n");
+       status = NOTMUCH_STATUS_BAD_QUERY_SYNTAX;
+       goto DONE;
+    }
+
+    for (param = params->list, arg = args;
+        param && arg;
+        param = param->next, arg = arg->next) {
+       if (param->ty != SEXP_VALUE || param->aty != SEXP_BASIC) {
+           _notmuch_database_log (notmuch, "macro parameters must be unquoted atoms\n");
+           status = NOTMUCH_STATUS_BAD_QUERY_SYNTAX;
+           goto DONE;
+       }
+       new_env = _sexp_bind (local, new_env, param->val, arg, env);
+    }
+
+    if (param && ! arg) {
+       _notmuch_database_log (notmuch, "too few arguments to macro\n");
+       status = NOTMUCH_STATUS_BAD_QUERY_SYNTAX;
+       goto DONE;
+    }
+
+    if (! param && arg) {
+       _notmuch_database_log (notmuch, "too many arguments to macro\n");
+       status = NOTMUCH_STATUS_BAD_QUERY_SYNTAX;
+       goto DONE;
+    }
+
+    status = _sexp_to_xapian_query (notmuch, parent, new_env, body, output);
+
+  DONE:
+    if (local)
+       talloc_free (local);
+
+    return status;
+}
+
 static notmuch_status_t
 maybe_saved_squery (notmuch_database_t *notmuch, const _sexp_prefix_t *parent,
                    const _sexp_binding_t *env, const sexp_t *sx, Xapian::Query &output)
@@ -336,7 +425,9 @@ maybe_saved_squery (notmuch_database_t *notmuch, const _sexp_prefix_t *parent,
        goto DONE;
     }
 
-    status =  _sexp_to_xapian_query (notmuch, parent, env, saved_sexp, output);
+    status = maybe_apply_macro (notmuch, parent, env, saved_sexp, sx->list->next, output);
+    if (status == NOTMUCH_STATUS_IGNORED)
+       status =  _sexp_to_xapian_query (notmuch, parent, env, saved_sexp, output);
 
   DONE:
     if (local)
@@ -345,6 +436,94 @@ maybe_saved_squery (notmuch_database_t *notmuch, const _sexp_prefix_t *parent,
     return status;
 }
 
+static notmuch_status_t
+_sexp_expand_param (notmuch_database_t *notmuch, const _sexp_prefix_t *parent,
+                   const _sexp_binding_t *env, const char *name,
+                   Xapian::Query &output)
+{
+    for (; env; env = env->next) {
+       if (strcmp (name, env->name) == 0) {
+           return _sexp_to_xapian_query (notmuch, parent, env->context, env->sx,
+                                         output);
+       }
+    }
+    _notmuch_database_log (notmuch, "undefined parameter %s\n", name);
+    return NOTMUCH_STATUS_BAD_QUERY_SYNTAX;
+}
+
+static notmuch_status_t
+_sexp_parse_range (notmuch_database_t *notmuch,  const _sexp_prefix_t *prefix,
+                  const sexp_t *sx, Xapian::Query &output)
+{
+    const char *from, *to;
+    std::string msg;
+
+    /* empty range matches everything */
+    if (! sx) {
+       output = Xapian::Query::MatchAll;
+       return NOTMUCH_STATUS_SUCCESS;
+    }
+
+    if (sx->ty == SEXP_LIST) {
+       _notmuch_database_log (notmuch, "expected atom as first argument of '%s'\n", prefix->name);
+       return NOTMUCH_STATUS_BAD_QUERY_SYNTAX;
+    }
+
+    from = sx->val;
+    to = from;
+
+    if (sx->next) {
+       if (sx->next->ty == SEXP_LIST) {
+           _notmuch_database_log (notmuch, "expected atom as second argument of '%s'\n",
+                                  prefix->name);
+           return NOTMUCH_STATUS_BAD_QUERY_SYNTAX;
+       }
+
+       if (sx->next->next) {
+           _notmuch_database_log (notmuch, "'%s' expects maximum of two arguments\n", prefix->name);
+           return NOTMUCH_STATUS_BAD_QUERY_SYNTAX;
+       }
+
+       to = sx->next->val;
+    }
+
+    if (strcmp (prefix->name, "date") == 0) {
+       notmuch_status_t status;
+       status = _notmuch_date_strings_to_query (NOTMUCH_VALUE_TIMESTAMP, from, to, output, msg);
+       if (status) {
+           if (! msg.empty ())
+               _notmuch_database_log (notmuch, "%s\n", msg.c_str ());
+       }
+       return status;
+    }
+
+    if (strcmp (prefix->name, "lastmod") == 0) {
+       long from_idx, to_idx;
+
+       try {
+           from_idx = std::stol (from);
+       } catch (std::logic_error &e) {
+           _notmuch_database_log (notmuch, "bad 'from' revision: '%s'\n", from);
+           return NOTMUCH_STATUS_BAD_QUERY_SYNTAX;
+       }
+
+       try {
+           to_idx = std::stol (to);
+       } catch (std::logic_error &e) {
+           _notmuch_database_log (notmuch, "bad 'to' revision: '%s'\n", to);
+           return NOTMUCH_STATUS_BAD_QUERY_SYNTAX;
+       }
+
+       output = Xapian::Query (Xapian::Query::OP_VALUE_RANGE, NOTMUCH_VALUE_LAST_MOD,
+                               Xapian::sortable_serialise (from_idx),
+                               Xapian::sortable_serialise (to_idx));
+       return NOTMUCH_STATUS_SUCCESS;
+    }
+
+    _notmuch_database_log (notmuch, "unimplimented range prefix: '%s'\n", prefix->name);
+    return NOTMUCH_STATUS_BAD_QUERY_SYNTAX;
+}
+
 /* Here we expect the s-expression to be a proper list, with first
  * element defining and operation, or as a special case the empty
  * list */
@@ -355,6 +534,10 @@ _sexp_to_xapian_query (notmuch_database_t *notmuch, const _sexp_prefix_t *parent
 {
     notmuch_status_t status;
 
+    if (sx->ty == SEXP_VALUE && sx->aty == SEXP_BASIC && sx->val[0] == ',') {
+       return _sexp_expand_param (notmuch, parent, env, sx->val + 1, output);
+    }
+
     if (sx->ty == SEXP_VALUE) {
        std::string term_prefix = parent ? _notmuch_database_prefix (notmuch, parent->name) : "";
 
@@ -407,9 +590,14 @@ _sexp_to_xapian_query (notmuch_database_t *notmuch, const _sexp_prefix_t *parent
        return _sexp_parse_header (notmuch, parent, env, sx, output);
     }
 
+    if (strcmp (sx->list->val, "macro") == 0) {
+       _notmuch_database_log (notmuch, "macro definition not permitted here\n");
+       return NOTMUCH_STATUS_BAD_QUERY_SYNTAX;
+    }
+
     for (_sexp_prefix_t *prefix = prefixes; prefix && prefix->name; prefix++) {
        if (strcmp (prefix->name, sx->list->val) == 0) {
-           if (prefix->flags & SEXP_FLAG_FIELD) {
+           if (prefix->flags & (SEXP_FLAG_FIELD | SEXP_FLAG_RANGE)) {
                if (parent) {
                    _notmuch_database_log (notmuch, "nested field: '%s' inside '%s'\n",
                                           prefix->name, parent->name);
@@ -431,6 +619,9 @@ _sexp_to_xapian_query (notmuch_database_t *notmuch, const _sexp_prefix_t *parent
                return NOTMUCH_STATUS_BAD_QUERY_SYNTAX;
            }
 
+           if (prefix->flags & SEXP_FLAG_RANGE)
+               return _sexp_parse_range (notmuch, prefix, sx->list->next, output);
+
            if (strcmp (prefix->name, "infix") == 0) {
                return _sexp_parse_infix (notmuch, sx->list->next, output);
            }