Re: [PATCH v5 6/9] lib: add date range query support

diff --git a/18/9e1728ee51c56e9dd1f7eb9e7158f84c9bc2a8 b/18/9e1728ee51c56e9dd1f7eb9e7158f84c9bc2a8
new file mode 100644 (file)
index 0000000..f00245a
--- /dev/null
+++ b/18/9e1728ee51c56e9dd1f7eb9e7158f84c9bc2a8
@@ -0,0 +1,271 @@
+Return-Path: <jani@nikula.org>\r
+X-Original-To: notmuch@notmuchmail.org\r
+Delivered-To: notmuch@notmuchmail.org\r
+Received: from localhost (localhost [127.0.0.1])\r
+       by olra.theworths.org (Postfix) with ESMTP id D1479431FBC\r
+       for <notmuch@notmuchmail.org>; Sun, 28 Oct 2012 15:39:08 -0700 (PDT)\r
+X-Virus-Scanned: Debian amavisd-new at olra.theworths.org\r
+X-Spam-Flag: NO\r
+X-Spam-Score: -0.7\r
+X-Spam-Level: \r
+X-Spam-Status: No, score=-0.7 tagged_above=-999 required=5\r
+       tests=[RCVD_IN_DNSWL_LOW=-0.7] autolearn=disabled\r
+Received: from olra.theworths.org ([127.0.0.1])\r
+       by localhost (olra.theworths.org [127.0.0.1]) (amavisd-new, port 10024)\r
+       with ESMTP id yeHPd1hON8rc for <notmuch@notmuchmail.org>;\r
+       Sun, 28 Oct 2012 15:39:08 -0700 (PDT)\r
+Received: from mail-la0-f53.google.com (mail-la0-f53.google.com\r
+       [209.85.215.53]) (using TLSv1 with cipher RC4-SHA (128/128 bits))\r
+       (No client certificate requested)\r
+       by olra.theworths.org (Postfix) with ESMTPS id A29E0431FAF\r
+       for <notmuch@notmuchmail.org>; Sun, 28 Oct 2012 15:39:07 -0700 (PDT)\r
+Received: by mail-la0-f53.google.com with SMTP id l5so3914390lah.26\r
+       for <notmuch@notmuchmail.org>; Sun, 28 Oct 2012 15:39:06 -0700 (PDT)\r
+X-Google-DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed;\r
+       d=google.com; s=20120113;\r
+       h=from:to:cc:subject:in-reply-to:references:user-agent:date\r
+       :message-id:mime-version:content-type:x-gm-message-state;\r
+       bh=ScbGARoCtCCJH8kzhb6Irqez/Pu58HowWEKT5iQ8kB8=;\r
+       b=PefvjM5xS5Cj9yP6frqaNmN0DH7CX8sTpkgAAg2PyF3YevTS5MxV1ocF55jZ0Q4pMS\r
+       /uamChACfFm6xvX7tCbLzlAsvjq+irioVKbTUBIRU/NkmnSNzKA4Nu66rNLmifhNg6UZ\r
+       M6YbNRDTOz+XpGmh25WT3wrxfNCXq3SXxCF8VxOspqiDYhP/Oj9/XmSliZFtDSZ4jywj\r
+       3Zqa2cm+B2wGUZqULN5MV0k/7v0hANn5jTdBfEnWyjvf+6p1xaVJn0wM3azRT5yPOHJP\r
+       cJWWapUdPusC50Jg7zDffbENn4nCFk/XpR2LA01wgAWrC+FOpUwJXYuifaGKKvOrHxIA\r
+       KaxA==\r
+Received: by 10.112.38.234 with SMTP id j10mr10886774lbk.80.1351463946143;\r
+       Sun, 28 Oct 2012 15:39:06 -0700 (PDT)\r
+Received: from localhost (dsl-hkibrasgw4-fe51df00-27.dhcp.inet.fi.\r
+       [80.223.81.27])\r
+       by mx.google.com with ESMTPS id b8sm2560120lbn.8.2012.10.28.15.39.04\r
+       (version=SSLv3 cipher=OTHER); Sun, 28 Oct 2012 15:39:05 -0700 (PDT)\r
+From: Jani Nikula <jani@nikula.org>\r
+To: Austin Clements <amdragon@MIT.EDU>\r
+Subject: Re: [PATCH v5 6/9] lib: add date range query support\r
+In-Reply-To: <20121023045255.GQ14861@mit.edu>\r
+References: <cover.1350854171.git.jani@nikula.org>\r
+       <f21b8702728457c087478b26700e9448bc16c61d.1350854171.git.jani@nikula.org>\r
+       <20121023045255.GQ14861@mit.edu>\r
+User-Agent: Notmuch/0.14+46~g272a1f1 (http://notmuchmail.org) Emacs/23.4.1\r
+       (i686-pc-linux-gnu)\r
+Date: Mon, 29 Oct 2012 00:39:02 +0200\r
+Message-ID: <87fw4ykyrd.fsf@nikula.org>\r
+MIME-Version: 1.0\r
+Content-Type: text/plain; charset=us-ascii\r
+X-Gm-Message-State:\r
+ ALoCoQnSr8KJpnBqalsJwDBV/FlpKM0eGIIBtz+v9ewruXJx+61/oBqNR14Jtf+rmSugqaFS5lZF\r
+Cc: notmuch@notmuchmail.org\r
+X-BeenThere: notmuch@notmuchmail.org\r
+X-Mailman-Version: 2.1.13\r
+Precedence: list\r
+List-Id: "Use and development of the notmuch mail system."\r
+       <notmuch.notmuchmail.org>\r
+List-Unsubscribe: <http://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: <http://notmuchmail.org/mailman/listinfo/notmuch>,\r
+       <mailto:notmuch-request@notmuchmail.org?subject=subscribe>\r
+X-List-Received-Date: Sun, 28 Oct 2012 22:39:09 -0000\r
+\r
+On Tue, 23 Oct 2012, Austin Clements <amdragon@MIT.EDU> wrote:\r
+> Quoth Jani Nikula on Oct 22 at 12:22 am:\r
+>> Add a custom value range processor to enable date and time searches of\r
+>> the form date:since..until, where "since" and "until" are expressions\r
+>> understood by the previously added date/time parser, to restrict the\r
+>> results to messages within a particular time range (based on the Date:\r
+>> header).\r
+>> \r
+>> If "since" or "until" describes date/time at an accuracy of days or\r
+>> less, the values are rounded according to the accuracy, towards past\r
+>> for "since" and towards future for "until". For example,\r
+>> date:november..yesterday would match from the beginning of November\r
+>> until the end of yesterday. Expressions such as date:today..today\r
+>> means since the beginning of today until the end of today.\r
+>> \r
+>> Open-ended ranges are supported (since Xapian 1.2.1), i.e. you can\r
+>> specify date:..until or date:since.. to not limit the start or end\r
+>> date, respectively.\r
+>> \r
+>> CAVEATS:\r
+>> \r
+>> Xapian does not support spaces in range expressions. You can replace\r
+>> the spaces with '_', or (in most cases) '-', or (in some cases) leave\r
+>> the spaces out altogether.\r
+>> \r
+>> Entering date:expr without ".." (for example date:yesterday) will not\r
+>> work as you might expect. You can achieve the expected result by\r
+>> duplicating the expr both sides of ".." (for example\r
+>> date:yesterday..yesterday).\r
+>> \r
+>> Open-ended ranges won't work with pre-1.2.1 Xapian, but they don't\r
+>> produce an error either.\r
+>> \r
+>> Signed-off-by: Jani Nikula <jani@nikula.org>\r
+>> ---\r
+>>  lib/Makefile.local     |    1 +\r
+>>  lib/database-private.h |    1 +\r
+>>  lib/database.cc        |    5 +++++\r
+>>  lib/parse-time-vrp.cc  |   40 ++++++++++++++++++++++++++++++++++++++++\r
+>>  lib/parse-time-vrp.h   |   19 +++++++++++++++++++\r
+>>  5 files changed, 66 insertions(+)\r
+>>  create mode 100644 lib/parse-time-vrp.cc\r
+>>  create mode 100644 lib/parse-time-vrp.h\r
+>> \r
+>> diff --git a/lib/Makefile.local b/lib/Makefile.local\r
+>> index d1635cf..6c0f42f 100644\r
+>> --- a/lib/Makefile.local\r
+>> +++ b/lib/Makefile.local\r
+>> @@ -58,6 +58,7 @@ libnotmuch_c_srcs =               \\r
+>>  \r
+>>  libnotmuch_cxx_srcs =              \\r
+>>     $(dir)/database.cc      \\r
+>> +   $(dir)/parse-time-vrp.cc        \\r
+>>     $(dir)/directory.cc     \\r
+>>     $(dir)/index.cc         \\r
+>>     $(dir)/message.cc       \\r
+>> diff --git a/lib/database-private.h b/lib/database-private.h\r
+>> index 88532d5..d3e65fd 100644\r
+>> --- a/lib/database-private.h\r
+>> +++ b/lib/database-private.h\r
+>> @@ -52,6 +52,7 @@ struct _notmuch_database {\r
+>>      Xapian::QueryParser *query_parser;\r
+>>      Xapian::TermGenerator *term_gen;\r
+>>      Xapian::ValueRangeProcessor *value_range_processor;\r
+>> +    Xapian::ValueRangeProcessor *date_range_processor;\r
+>>  };\r
+>>  \r
+>>  /* Return the list of terms from the given iterator matching a prefix.\r
+>> diff --git a/lib/database.cc b/lib/database.cc\r
+>> index 761dc1a..4df3217 100644\r
+>> --- a/lib/database.cc\r
+>> +++ b/lib/database.cc\r
+>> @@ -19,6 +19,7 @@\r
+>>   */\r
+>>  \r
+>>  #include "database-private.h"\r
+>> +#include "parse-time-vrp.h"\r
+>>  \r
+>>  #include <iostream>\r
+>>  \r
+>> @@ -710,12 +711,14 @@ notmuch_database_open (const char *path,\r
+>>     notmuch->term_gen = new Xapian::TermGenerator;\r
+>>     notmuch->term_gen->set_stemmer (Xapian::Stem ("english"));\r
+>>     notmuch->value_range_processor = new Xapian::NumberValueRangeProcessor (NOTMUCH_VALUE_TIMESTAMP);\r
+>> +   notmuch->date_range_processor = new ParseTimeValueRangeProcessor (NOTMUCH_VALUE_TIMESTAMP);\r
+>>  \r
+>>     notmuch->query_parser->set_default_op (Xapian::Query::OP_AND);\r
+>>     notmuch->query_parser->set_database (*notmuch->xapian_db);\r
+>>     notmuch->query_parser->set_stemmer (Xapian::Stem ("english"));\r
+>>     notmuch->query_parser->set_stemming_strategy (Xapian::QueryParser::STEM_SOME);\r
+>>     notmuch->query_parser->add_valuerangeprocessor (notmuch->value_range_processor);\r
+>> +   notmuch->query_parser->add_valuerangeprocessor (notmuch->date_range_processor);\r
+>>  \r
+>>     for (i = 0; i < ARRAY_SIZE (BOOLEAN_PREFIX_EXTERNAL); i++) {\r
+>>         prefix_t *prefix = &BOOLEAN_PREFIX_EXTERNAL[i];\r
+>> @@ -778,6 +781,8 @@ notmuch_database_close (notmuch_database_t *notmuch)\r
+>>      notmuch->xapian_db = NULL;\r
+>>      delete notmuch->value_range_processor;\r
+>>      notmuch->value_range_processor = NULL;\r
+>> +    delete notmuch->date_range_processor;\r
+>> +    notmuch->date_range_processor = NULL;\r
+>>  }\r
+>>  \r
+>>  void\r
+>> diff --git a/lib/parse-time-vrp.cc b/lib/parse-time-vrp.cc\r
+>> new file mode 100644\r
+>> index 0000000..7e4eca4\r
+>> --- /dev/null\r
+>> +++ b/lib/parse-time-vrp.cc\r
+>> @@ -0,0 +1,40 @@\r
+>\r
+> Should this file have the usual preamble?\r
+\r
+Probably, yes.\r
+\r
+>> +\r
+>> +#include "database-private.h"\r
+>> +#include "parse-time-vrp.h"\r
+>> +#include "parse-time-string.h"\r
+>> +\r
+>> +#define PREFIX "date:"\r
+>> +\r
+>> +/* See *ValueRangeProcessor in xapian-core/api/valuerangeproc.cc */\r
+>> +Xapian::valueno\r
+>> +ParseTimeValueRangeProcessor::operator() (std::string &begin, std::string &end)\r
+>> +{\r
+>> +    time_t t, now;\r
+>> +\r
+>> +    /* Require date: prefix in start of the range... */\r
+>> +    if (STRNCMP_LITERAL (begin.c_str (), PREFIX))\r
+>\r
+> Could be\r
+>   if (begin.rfind (PREFIX, 0) == string::npos)\r
+> but that may not be clearer.\r
+\r
+Not to me at least; my C++ is rusty.\r
+\r
+>> +   return Xapian::BAD_VALUENO;\r
+>> +\r
+>> +    /* ...and remove it. */\r
+>> +    begin.erase (0, sizeof (PREFIX) - 1);\r
+>> +\r
+>> +    /* Use the same 'now' for begin and end. */\r
+>> +    if (time (&now) == (time_t) -1)\r
+>> +   return Xapian::BAD_VALUENO;\r
+>> +\r
+>> +    if (!begin.empty ()) {\r
+>> +   if (parse_time_string (begin.c_str (), &t, &now, PARSE_TIME_ROUND_DOWN))\r
+>> +       return Xapian::BAD_VALUENO;\r
+>> +\r
+>> +   begin.assign (Xapian::sortable_serialise ((double) t));\r
+>> +    }\r
+>> +\r
+>> +    if (!end.empty ()) {\r
+>> +   if (parse_time_string (end.c_str (), &t, &now, PARSE_TIME_ROUND_UP_INCLUSIVE))\r
+>> +       return Xapian::BAD_VALUENO;\r
+>> +\r
+>> +   end.assign (Xapian::sortable_serialise ((double) t));\r
+>> +    }\r
+>> +\r
+>> +    return valno;\r
+>> +}\r
+>> diff --git a/lib/parse-time-vrp.h b/lib/parse-time-vrp.h\r
+>> new file mode 100644\r
+>> index 0000000..526c217\r
+>> --- /dev/null\r
+>> +++ b/lib/parse-time-vrp.h\r
+>> @@ -0,0 +1,19 @@\r
+>\r
+> Same thing about the preamble.\r
+>\r
+>> +\r
+>> +#ifndef NOTMUCH_PARSE_TIME_VRP_H\r
+>> +#define NOTMUCH_PARSE_TIME_VRP_H\r
+>> +\r
+>> +#include <xapian.h>\r
+>> +\r
+>> +/* see *ValueRangeProcessor in xapian-core/include/xapian/queryparser.h */\r
+>\r
+> Out of curiosity, why the Xapian source reference?\r
+> ValueRangeProcessor is documented along the rest of Xapian.\r
+\r
+To be honest, I couldn't write this with the documentation alone, and\r
+Xapian has quite a bit of source code, so I wrote it down for me. I\r
+figured it does no harm to leave it there.\r
+\r
+BR,\r
+Jani.\r
+\r
+>> +class ParseTimeValueRangeProcessor : public Xapian::ValueRangeProcessor {\r
+>> +protected:\r
+>> +    Xapian::valueno valno;\r
+>> +\r
+>> +public:\r
+>> +    ParseTimeValueRangeProcessor (Xapian::valueno slot_)\r
+>> +   : valno(slot_) { }\r
+>> +\r
+>> +    Xapian::valueno operator() (std::string &begin, std::string &end);\r
+>> +};\r
+>> +\r
+>> +#endif /* NOTMUCH_PARSE_TIME_VRP_H */\r