[PATCH 9/9] add has: query prefix to search for specific properties
authorDavid Bremner <david@tethera.net>
Sat, 6 Aug 2016 13:52:39 +0000 (22:52 +0900)
committerW. Trevor King <wking@tremily.us>
Sat, 20 Aug 2016 23:22:20 +0000 (16:22 -0700)
21/6fb6ffa3cb7adb94ca1611be550fd4c5a7f4c7 [new file with mode: 0644]

diff --git a/21/6fb6ffa3cb7adb94ca1611be550fd4c5a7f4c7 b/21/6fb6ffa3cb7adb94ca1611be550fd4c5a7f4c7
new file mode 100644 (file)
index 0000000..f0ae4e3
--- /dev/null
@@ -0,0 +1,140 @@
+Return-Path: <bremner@tesseract.cs.unb.ca>\r
+X-Original-To: notmuch@notmuchmail.org\r
+Delivered-To: notmuch@notmuchmail.org\r
+Received: from localhost (localhost [127.0.0.1])\r
+ by arlo.cworth.org (Postfix) with ESMTP id 97D7A6DE0942\r
+ for <notmuch@notmuchmail.org>; Sat,  6 Aug 2016 06:55:29 -0700 (PDT)\r
+X-Virus-Scanned: Debian amavisd-new at cworth.org\r
+X-Spam-Flag: NO\r
+X-Spam-Score: 0.653\r
+X-Spam-Level: \r
+X-Spam-Status: No, score=0.653 tagged_above=-999 required=5 tests=[AWL=-0.661,\r
+  HEADER_FROM_DIFFERENT_DOMAINS=0.001, URI_HEX=1.313] autolearn=disabled\r
+Received: from arlo.cworth.org ([127.0.0.1])\r
+ by localhost (arlo.cworth.org [127.0.0.1]) (amavisd-new, port 10024)\r
+ with ESMTP id WJLNhI21bKl0 for <notmuch@notmuchmail.org>;\r
+ Sat,  6 Aug 2016 06:55:21 -0700 (PDT)\r
+Received: from fethera.tethera.net (fethera.tethera.net [198.245.60.197])\r
+ by arlo.cworth.org (Postfix) with ESMTPS id 197726DE0930\r
+ for <notmuch@notmuchmail.org>; Sat,  6 Aug 2016 06:53:21 -0700 (PDT)\r
+Received: from remotemail by fethera.tethera.net with local (Exim 4.84_2)\r
+ (envelope-from <bremner@tesseract.cs.unb.ca>)\r
+ id 1bW22h-0007Ey-If; Sat, 06 Aug 2016 09:53:35 -0400\r
+Received: (nullmailer pid 4141 invoked by uid 1000);\r
+ Sat, 06 Aug 2016 13:52:44 -0000\r
+From: David Bremner <david@tethera.net>\r
+To: notmuch@notmuchmail.org\r
+Cc: Daniel Kahn Gillmor <dkg@fifthhorseman.net>\r
+Subject: [PATCH 9/9] add has: query prefix to search for specific properties\r
+Date: Sat,  6 Aug 2016 22:52:39 +0900\r
+Message-Id: <1470491559-3946-10-git-send-email-david@tethera.net>\r
+X-Mailer: git-send-email 2.8.1\r
+In-Reply-To: <1470491559-3946-1-git-send-email-david@tethera.net>\r
+References: <1470491559-3946-1-git-send-email-david@tethera.net>\r
+X-BeenThere: notmuch@notmuchmail.org\r
+X-Mailman-Version: 2.1.20\r
+Precedence: list\r
+List-Id: "Use and development of the notmuch mail system."\r
+ <notmuch.notmuchmail.org>\r
+List-Unsubscribe: <https://notmuchmail.org/mailman/options/notmuch>,\r
+ <mailto:notmuch-request@notmuchmail.org?subject=unsubscribe>\r
+List-Archive: <http://notmuchmail.org/pipermail/notmuch/>\r
+List-Post: <mailto:notmuch@notmuchmail.org>\r
+List-Help: <mailto:notmuch-request@notmuchmail.org?subject=help>\r
+List-Subscribe: <https://notmuchmail.org/mailman/listinfo/notmuch>,\r
+ <mailto:notmuch-request@notmuchmail.org?subject=subscribe>\r
+X-List-Received-Date: Sat, 06 Aug 2016 13:55:29 -0000\r
+\r
+From: Daniel Kahn Gillmor <dkg@fifthhorseman.net>\r
+\r
+We want to be able to query the properties directly, like:\r
+\r
+   notmuch count has:foo=bar\r
+\r
+which should return a count of messages where the property with key\r
+"foo" has value equal to "bar".\r
+---\r
+ doc/man7/notmuch-search-terms.rst |  9 ++++++++-\r
+ lib/database.cc                   |  4 ++++\r
+ test/T610-message-property.sh     | 11 +++++++++++\r
+ 3 files changed, 23 insertions(+), 1 deletion(-)\r
+\r
+diff --git a/doc/man7/notmuch-search-terms.rst b/doc/man7/notmuch-search-terms.rst\r
+index 075f88c..86d02ee 100644\r
+--- a/doc/man7/notmuch-search-terms.rst\r
++++ b/doc/man7/notmuch-search-terms.rst\r
+@@ -58,6 +58,8 @@ indicate user-supplied values):\r
\r
+ -  query:<name>\r
\r
++-  has:<key>=<value>\r
++\r
+ The **from:** prefix is used to match the name or address of the sender\r
+ of an email message.\r
\r
+@@ -139,6 +141,11 @@ queries added with **notmuch-config(1)**. Named queries are only\r
+ available if notmuch is built with **Xapian Field Processors** (see\r
+ below).\r
\r
++The **has:** prefix searches for messages with a particular\r
++<key>=<value> property pair. Properties are used internally by notmuch\r
++(and extensions) to add metadata to messages. A given key can be\r
++present on a given message with several different values.\r
++\r
+ Operators\r
+ ---------\r
\r
+@@ -217,7 +224,7 @@ exact matches like "tag:inbox"  or **probabilistic**, supporting a more flexible\r
\r
\r
+ Boolean\r
+-   **tag:**, **id:**, **thread:**, **folder:**, **path:**\r
++   **tag:**, **id:**, **thread:**, **folder:**, **path:**, **has**\r
+ Probabilistic\r
+    **from:**, **to:**, **subject:**, **attachment:**, **mimetype:**\r
\r
+diff --git a/lib/database.cc b/lib/database.cc\r
+index 3a741f0..3bdbd07 100644\r
+--- a/lib/database.cc\r
++++ b/lib/database.cc\r
+@@ -97,6 +97,9 @@ typedef struct {\r
+  *                    STRING is the name of a file within that\r
+  *                    directory for this mail message.\r
+  *\r
++ *      has:       Has a property with key=value\r
++ *                 FIXME: if no = is present, should match on any value\r
++ *\r
+  *    A mail document also has four values:\r
+  *\r
+  *    TIMESTAMP:      The time_t value corresponding to the message's\r
+@@ -260,6 +263,7 @@ static prefix_t BOOLEAN_PREFIX_EXTERNAL[] = {\r
+     { "is",                   "K" },\r
+     { "id",                   "Q" },\r
+     { "path",                 "P" },\r
++    { "has",                  "XPROPERTY" },\r
+     /*\r
+      * Without the ":", since this is a multi-letter prefix, Xapian\r
+      * will add a colon itself if the first letter of the path is\r
+diff --git a/test/T610-message-property.sh b/test/T610-message-property.sh\r
+index c92b99b..ee7910b 100755\r
+--- a/test/T610-message-property.sh\r
++++ b/test/T610-message-property.sh\r
+@@ -237,4 +237,15 @@ notmuch restore < BEFORE2\r
+ notmuch dump | grep '^#=' > OUTPUT\r
+ test_expect_equal_file PROPERTIES OUTPUT\r
\r
++test_begin_subtest "test 'has:' queries: empty"\r
++notmuch search has:testkey1=charles > OUTPUT\r
++test_expect_equal_file /dev/null OUTPUT\r
++\r
++test_begin_subtest "test 'has:' queries: single message"\r
++notmuch search --output=messages has:testkey1=alice > OUTPUT\r
++cat <<EOF >EXPECTED\r
++id:4EFC743A.3060609@april.org\r
++EOF\r
++test_expect_equal_file EXPECTED OUTPUT\r
++\r
+ test_done\r
+-- \r
+2.8.1\r
+\r