From mboxrd@z Thu Jan 1 00:00:00 1970 Return-Path: Received: from mp0 ([2001:41d0:2:bcc0::]) (using TLSv1.3 with cipher TLS_AES_256_GCM_SHA384 (256/256 bits)) by ms0.migadu.com with LMTPS id cF4wOMMp7mD8egAAgWs5BA (envelope-from ) for ; Wed, 14 Jul 2021 02:03:15 +0200 Received: from aspmx1.migadu.com ([2001:41d0:2:bcc0::]) (using TLSv1.3 with cipher TLS_AES_256_GCM_SHA384 (256/256 bits)) by mp0 with LMTPS id SG/sM8Mp7mCNSAAA1q6Kng (envelope-from ) for ; Wed, 14 Jul 2021 00:03:15 +0000 Received: from mail.notmuchmail.org (nmbug.tethera.net [IPv6:2607:5300:201:3100::1657]) (using TLSv1.3 with cipher TLS_AES_256_GCM_SHA384 (256/256 bits) key-exchange X25519 server-signature RSA-PSS (2048 bits) server-digest SHA256) (No client certificate requested) by aspmx1.migadu.com (Postfix) with ESMTPS id 7E226ADBE for ; Wed, 14 Jul 2021 02:03:15 +0200 (CEST) Received: from nmbug.tethera.net (localhost [127.0.0.1]) by mail.notmuchmail.org (Postfix) with ESMTP id B22B5290D9; Tue, 13 Jul 2021 20:03:01 -0400 (EDT) Received: from fethera.tethera.net (fethera.tethera.net [IPv6:2607:5300:60:c5::1]) by mail.notmuchmail.org (Postfix) with ESMTP id 0E7F3290CD for ; Tue, 13 Jul 2021 20:02:46 -0400 (EDT) Received: by fethera.tethera.net (Postfix, from userid 1001) id 086A55FD21; Tue, 13 Jul 2021 20:02:45 -0400 (EDT) Received: (nullmailer pid 804669 invoked by uid 1000); Wed, 14 Jul 2021 00:02:42 -0000 From: David Bremner To: notmuch@notmuchmail.org Cc: David Bremner Subject: [PATCH 10/11] lib/parse-sexp: add keyword arguments for fields Date: Tue, 13 Jul 2021 21:02:38 -0300 Message-Id: <20210714000239.804384-11-david@tethera.net> X-Mailer: git-send-email 2.30.2 In-Reply-To: <20210714000239.804384-1-david@tethera.net> References: <20210714000239.804384-1-david@tethera.net> MIME-Version: 1.0 Message-ID-Hash: S77RMPGVHGQ5K7SBW67C7QJNECIRPLXM X-Message-ID-Hash: S77RMPGVHGQ5K7SBW67C7QJNECIRPLXM X-MailFrom: bremner@tethera.net X-Mailman-Rule-Misses: dmarc-mitigation; no-senders; approved; emergency; loop; banned-address; member-moderation; header-match-notmuch.notmuchmail.org-0; nonmember-moderation; administrivia; implicit-dest; max-recipients; max-size; news-moderation; no-subject; suspicious-header X-Mailman-Version: 3.2.1 Precedence: list List-Id: "Use and development of the notmuch mail system." List-Help: List-Post: List-Subscribe: List-Unsubscribe: Content-Type: text/plain; charset="us-ascii" Content-Transfer-Encoding: 7bit X-Migadu-Flow: FLOW_IN ARC-Message-Signature: i=1; a=rsa-sha256; c=relaxed/relaxed; d=yhetil.org; s=key1; t=1626220995; h=from:from:reply-to:subject:subject:date:date:message-id:message-id: to:to:cc:cc:mime-version:mime-version:content-type:content-type: content-transfer-encoding:content-transfer-encoding: in-reply-to:in-reply-to:references:references:list-id:list-help: list-unsubscribe:list-subscribe:list-post; bh=5pP5YV9H01yoyBbQRhW5aPyjK9M2wWDTnwTYblcjh6Y=; b=MQRxx/SBuurrHaUX06HO8n2qgmkLhAYcMBySJI9EcBLWolDIS+cC4nlh15FJ9qCQH0szHZ eeYt/If1hyH20i5TQ1AYAvv95aPiGvHNWkqvNXG7iKgOZqojkMydz+5rRLXvT0bhKWMrXG K7jb66bchY62Kg2zlq6hdPNmmtOehwn8ydf7n4pC7PxGn3B9N4GjU2qkqvrM7vTCOdfAgh raMBGsnDXPt6xBydk0LUvgDcgImOjG4c1Rb4DzIMuMFf5kbCnIXbHHPrVJGVhle9GbSOgJ 3fw0wqcW/KcFya2VnBWFAhxwyDZGungf2DpTTFxcbjvfU1owGtZ6tdR1KdqXCw== ARC-Seal: i=1; s=key1; d=yhetil.org; t=1626220995; a=rsa-sha256; cv=none; b=teyzMze17AnMYBBKbRUCDvLt/y02xQU5rHub5P7TE+acjejJMsQjEr081fHvc95jVHUUMK L++VJSR8hegjPBQhfy4KnIGgIaR1XYuuoSYCJ9WTkXNLBAo/Zq0m0GLDy3Lde7w0sebgdG 0Jk5g8p5CObTQ5ucME6U5QG6nktXOzqWFONwUJlm8dDQtkIgx/w8Q4/rfNO+mTlxG2Jziu yzK+ZiNyJ2XInlNi2+IDezu24v4ZefZG5WTOzxZpoghNUkG0fefx8A53bGTXvvg5SxUoQG DbRhqgB2+U/20ESOQJRXDZaboa7Sq5hL2kUyu66baf9MqaTC7rG1tN3/VT47TA== ARC-Authentication-Results: i=1; aspmx1.migadu.com; dkim=none; dmarc=none; spf=pass (aspmx1.migadu.com: domain of notmuch-bounces@notmuchmail.org designates 2607:5300:201:3100::1657 as permitted sender) smtp.mailfrom=notmuch-bounces@notmuchmail.org X-Migadu-Spam-Score: -1.08 Authentication-Results: aspmx1.migadu.com; dkim=none; dmarc=none; spf=pass (aspmx1.migadu.com: domain of notmuch-bounces@notmuchmail.org designates 2607:5300:201:3100::1657 as permitted sender) smtp.mailfrom=notmuch-bounces@notmuchmail.org X-Migadu-Queue-Id: 7E226ADBE X-Spam-Score: -1.08 X-Migadu-Scanner: scn0.migadu.com X-TUID: aY3SEXiNCfVn Nothing is done with the flags here, only parsing and validation. --- lib/parse-sexp.cc | 114 +++++++++++++++++++++++++++++++------- test/T081-sexpr-search.sh | 32 +++++++++++ 2 files changed, 126 insertions(+), 20 deletions(-) diff --git a/lib/parse-sexp.cc b/lib/parse-sexp.cc index 4a9e1aeb..bfa566b1 100644 --- a/lib/parse-sexp.cc +++ b/lib/parse-sexp.cc @@ -8,6 +8,34 @@ typedef struct { Xapian::Query initial; } _sexp_op_t; +typedef enum { + SEXP_FLAG_NONE = 0, + SEXP_FLAG_WILDCARD = 1 << 0, +} _sexp_flag_t; + +/* + * define bitwise operators to hide casts */ + +inline _sexp_flag_t +operator| (_sexp_flag_t a, _sexp_flag_t b) +{ + return static_cast<_sexp_flag_t>( + static_cast(a) | static_cast(b)); +} + +inline _sexp_flag_t +operator& (_sexp_flag_t a, _sexp_flag_t b) +{ + return static_cast<_sexp_flag_t>( + static_cast(a) & static_cast(b)); +} + +typedef struct { + const char *name; + Xapian::Query::op xapian_op; + _sexp_flag_t flags_allowed; +} _sexp_field_t; + static _sexp_op_t operations[] = { { "and", Xapian::Query::OP_AND, Xapian::Query::MatchAll }, @@ -16,27 +44,34 @@ static _sexp_op_t operations[] = { } }; -typedef struct { +static _sexp_field_t fields[] = +{ + { "attachment", Xapian::Query::OP_PHRASE, SEXP_FLAG_WILDCARD }, + { "body", Xapian::Query::OP_PHRASE, SEXP_FLAG_WILDCARD }, + { "from", Xapian::Query::OP_PHRASE, SEXP_FLAG_NONE }, + { "folder", Xapian::Query::OP_OR, SEXP_FLAG_NONE }, + { "id", Xapian::Query::OP_OR, SEXP_FLAG_NONE }, + { "is", Xapian::Query::OP_AND, SEXP_FLAG_WILDCARD }, + { "mid", Xapian::Query::OP_OR, SEXP_FLAG_NONE }, + { "mimetype", Xapian::Query::OP_PHRASE, SEXP_FLAG_NONE }, + { "path", Xapian::Query::OP_OR, SEXP_FLAG_NONE }, + { "property", Xapian::Query::OP_AND, SEXP_FLAG_WILDCARD }, + { "subject", Xapian::Query::OP_PHRASE, SEXP_FLAG_NONE }, + { "tag", Xapian::Query::OP_AND, SEXP_FLAG_WILDCARD }, + { "thread", Xapian::Query::OP_OR, SEXP_FLAG_NONE }, + { "to", Xapian::Query::OP_PHRASE, SEXP_FLAG_NONE }, + { } +}; + +typedef struct { const char *name; - Xapian::Query::op xapian_op; -} _sexp_field_t; + _sexp_flag_t flag; +} _sexp_keyword_t; -static _sexp_field_t fields[] = +static _sexp_keyword_t keywords[] = { - { "attachment", Xapian::Query::OP_PHRASE }, - { "body", Xapian::Query::OP_PHRASE }, - { "from", Xapian::Query::OP_PHRASE }, - { "folder", Xapian::Query::OP_OR }, - { "id", Xapian::Query::OP_OR }, - { "is", Xapian::Query::OP_AND }, - { "mid", Xapian::Query::OP_OR }, - { "mimetype", Xapian::Query::OP_PHRASE }, - { "path", Xapian::Query::OP_OR }, - { "property", Xapian::Query::OP_AND }, - { "subject", Xapian::Query::OP_PHRASE }, - { "tag", Xapian::Query::OP_AND }, - { "thread", Xapian::Query::OP_OR }, - { "to", Xapian::Query::OP_PHRASE }, + { "any", SEXP_FLAG_WILDCARD }, + { "*", SEXP_FLAG_WILDCARD }, { } }; @@ -126,6 +161,37 @@ _sexp_combine_field (const char *prefix, return NOTMUCH_STATUS_SUCCESS; } + +static notmuch_status_t +_sexp_parse_keywords (notmuch_database_t *notmuch, const char *prefix, sexp_t *sx, _sexp_flag_t mask, + _sexp_flag_t &flags, sexp_t *&rest) +{ + flags = SEXP_FLAG_NONE; + + for (; sx && sx->ty == SEXP_VALUE && sx->aty == SEXP_BASIC && sx->val[0] == ':'; sx = sx->next) { + _sexp_keyword_t *keyword; + for (keyword = keywords; keyword && keyword->name; keyword++) { + if (strcasecmp (keyword->name, sx->val+1) == 0) { + if ((mask & keyword->flag) == 0) { + _notmuch_database_log_append (notmuch, "unsupported keyword '%s' for prefix '%s'\n", + sx->val, prefix); + return NOTMUCH_STATUS_ILLEGAL_ARGUMENT; + } else { + flags = flags | keyword->flag; + break; + } + } + } + if (! keyword || ! keyword->name) { + _notmuch_database_log (notmuch, "unknown keyword %s\n", sx->val); + return NOTMUCH_STATUS_ILLEGAL_ARGUMENT; + } + } + + rest = sx; + return NOTMUCH_STATUS_SUCCESS; +} + /* 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 */ @@ -149,12 +215,20 @@ _sexp_to_xapian_query (notmuch_database_t *notmuch, sexp_t *sx, Xapian::Query &o if (strcasecmp (op->name, hd_sexp (sx)->val) == 0) { return _sexp_combine_query (notmuch, op->xapian_op, op->initial, sx->list->next, output); } - } for (const _sexp_field_t *field = fields; field && field->name; field++) { if (strcasecmp (field->name, hd_sexp (sx)->val) == 0) { - return _sexp_combine_field (_find_prefix (field->name), field->xapian_op, sx->list->next, + _sexp_flag_t flags; + sexp_t *rest; + + notmuch_status_t status = _sexp_parse_keywords (notmuch, sx->list->val, + sx->list->next, field->flags_allowed, + flags, rest); + if (status) + return status; + + return _sexp_combine_field (_find_prefix (field->name), field->xapian_op, rest, output); } } diff --git a/test/T081-sexpr-search.sh b/test/T081-sexpr-search.sh index b8229ebe..6e8687da 100755 --- a/test/T081-sexpr-search.sh +++ b/test/T081-sexpr-search.sh @@ -189,4 +189,36 @@ notmuch search: Illegal argument for function unimplemented prefix foo EOF test_expect_equal_file EXPECTED OUTPUT + +test_begin_subtest "unknown keyword" +notmuch search --query-syntax=sexp '(subject :foo)' >OUTPUT 2>&1 +cat < EXPECTED +notmuch search: Illegal argument for function +unknown keyword :foo +EOF +test_expect_equal_file EXPECTED OUTPUT + +test_begin_subtest "unsupported keyword for prefix" +notmuch search --query-syntax=sexp '(subject :any)' >OUTPUT 2>&1 +cat < EXPECTED +notmuch search: Illegal argument for function +unsupported keyword ':any' for prefix 'subject' +EOF +test_expect_equal_file EXPECTED OUTPUT + +test_begin_subtest "known keyword :any" +test_expect_success 'notmuch search --query-syntax=sexp "(tag :any)"' + +test_begin_subtest "known keyword :*" +test_expect_success 'notmuch search --query-syntax=sexp "(tag :*)"' + +test_begin_subtest "multiple known keywords" +test_expect_success 'notmuch search --query-syntax=sexp "(tag :any :*)"' + +test_begin_subtest "quoted unknown keyword" +test_expect_success 'notmuch search --query-syntax=sexp "(subject \":foo\")"' + +test_begin_subtest "unknown keyword after non-keyword" +test_expect_success 'notmuch search --query-syntax=sexp "(subject foo :foo)"' + test_done -- 2.30.2