From: Jani Nikula Date: Tue, 30 Oct 2012 20:32:37 +0000 (+0200) Subject: [PATCH v6 6/9] lib: add date range query support X-Git-Url: http://git.tremily.us/gitweb.cgi?a=commitdiff_plain;h=d6593e38846b3d60ae0f3f526d204c15fa0e0c9c;p=notmuch-archives.git [PATCH v6 6/9] lib: add date range query support --- diff --git a/31/16320400060e375d07428edc2ac0f85f3edfa8 b/31/16320400060e375d07428edc2ac0f85f3edfa8 new file mode 100644 index 000000000..1e8a76ca5 --- /dev/null +++ b/31/16320400060e375d07428edc2ac0f85f3edfa8 @@ -0,0 +1,290 @@ +Return-Path: +X-Original-To: notmuch@notmuchmail.org +Delivered-To: notmuch@notmuchmail.org +Received: from localhost (localhost [127.0.0.1]) + by olra.theworths.org (Postfix) with ESMTP id 57028431FC0 + for ; Tue, 30 Oct 2012 13:33:21 -0700 (PDT) +X-Virus-Scanned: Debian amavisd-new at olra.theworths.org +X-Amavis-Alert: BAD HEADER SECTION, Duplicate header field: "References" +X-Spam-Flag: NO +X-Spam-Score: -0.7 +X-Spam-Level: +X-Spam-Status: No, score=-0.7 tagged_above=-999 required=5 + tests=[RCVD_IN_DNSWL_LOW=-0.7] autolearn=disabled +Received: from olra.theworths.org ([127.0.0.1]) + by localhost (olra.theworths.org [127.0.0.1]) (amavisd-new, port 10024) + with ESMTP id GaDjFCp5wK7d for ; + Tue, 30 Oct 2012 13:33:18 -0700 (PDT) +Received: from mail-lb0-f181.google.com (mail-lb0-f181.google.com + [209.85.217.181]) (using TLSv1 with cipher RC4-SHA (128/128 bits)) + (No client certificate requested) + by olra.theworths.org (Postfix) with ESMTPS id 5CDD6429E2F + for ; Tue, 30 Oct 2012 13:33:05 -0700 (PDT) +Received: by mail-lb0-f181.google.com with SMTP id gg6so567600lbb.26 + for ; Tue, 30 Oct 2012 13:33:04 -0700 (PDT) +X-Google-DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; + d=google.com; s=20120113; + h=from:to:cc:subject:date:message-id:x-mailer:in-reply-to:references + :in-reply-to:references:mime-version:content-type + :content-transfer-encoding:x-gm-message-state; + bh=B8qZH475TewuIO7Z7jhYuIVn+EFJdUqvgsbthY4Ja8c=; + b=LICiHX5UJRSFGkNW9SPeAjoAKEbuvs2mTQdp37dOnnZ9/U6YL3ZVPB7kc44r3M+iDY + jDsbAdVgNID7qj/dBoaAIHr/btMZYt+UvL+xHxY2IX82RO+lzxd8qmpg8fuHODyLXWbT + d+CH5yoEoTHkJdNTsikUamezQ8wW8+KxaQZari90TlPufAp4D1iHAb41p2Xh/h4Q/5S+ + K5VB2R8d/l5ty2iH01fYiTzkfYJBVmssLNfOtiFi4nDyXM++tAIIwC/mFwgekyykXUtO + GiIcwPY0gem2OAd1h+TzXhpGqlba42QKHKhAbkQfCW4uQcfH3SR6+r31cSuYkmTcgh3F + DIFQ== +Received: by 10.112.102.196 with SMTP id fq4mr13550839lbb.125.1351629184822; + Tue, 30 Oct 2012 13:33:04 -0700 (PDT) +Received: from localhost (dsl-hkibrasgw4-fe51df00-27.dhcp.inet.fi. + [80.223.81.27]) + by mx.google.com with ESMTPS id ew2sm764587lbb.2.2012.10.30.13.33.02 + (version=SSLv3 cipher=OTHER); Tue, 30 Oct 2012 13:33:03 -0700 (PDT) +From: Jani Nikula +To: notmuch@notmuchmail.org +Subject: [PATCH v6 6/9] lib: add date range query support +Date: Tue, 30 Oct 2012 22:32:37 +0200 +Message-Id: + <51cbf8eb0e7e1b0e7cedfa8b0443deabe99d0b2b.1351626272.git.jani@nikula.org> +X-Mailer: git-send-email 1.7.10.4 +In-Reply-To: +References: +In-Reply-To: +References: +MIME-Version: 1.0 +Content-Type: text/plain; charset=UTF-8 +Content-Transfer-Encoding: 8bit +X-Gm-Message-State: + ALoCoQnhldJ4QscuOPLBuZUc6zJBDH1AkRws3XpvQxvH2syi71ydXXX6UtWZkMA9x3XtVvEIMbS8 +X-BeenThere: notmuch@notmuchmail.org +X-Mailman-Version: 2.1.13 +Precedence: list +List-Id: "Use and development of the notmuch mail system." + +List-Unsubscribe: , + +List-Archive: +List-Post: +List-Help: +List-Subscribe: , + +X-List-Received-Date: Tue, 30 Oct 2012 20:33:21 -0000 + +Add a custom value range processor to enable date and time searches of +the form date:since..until, where "since" and "until" are expressions +understood by the previously added date/time parser, to restrict the +results to messages within a particular time range (based on the Date: +header). + +If "since" or "until" describes date/time at an accuracy of days or +less, the values are rounded according to the accuracy, towards past +for "since" and towards future for "until". For example, +date:november..yesterday would match from the beginning of November +until the end of yesterday. Expressions such as date:today..today +means since the beginning of today until the end of today. + +Open-ended ranges are supported (since Xapian 1.2.1), i.e. you can +specify date:..until or date:since.. to not limit the start or end +date, respectively. + +CAVEATS: + +Xapian does not support spaces in range expressions. You can replace +the spaces with '_', or (in most cases) '-', or (in some cases) leave +the spaces out altogether. + +Entering date:expr without ".." (for example date:yesterday) will not +work as you might expect. You can achieve the expected result by +duplicating the expr both sides of ".." (for example +date:yesterday..yesterday). + +Open-ended ranges won't work with pre-1.2.1 Xapian, but they don't +produce an error either. + +Signed-off-by: Jani Nikula +--- + lib/Makefile.local | 1 + + lib/database-private.h | 1 + + lib/database.cc | 5 ++++ + lib/parse-time-vrp.cc | 61 ++++++++++++++++++++++++++++++++++++++++++++++++ + lib/parse-time-vrp.h | 40 +++++++++++++++++++++++++++++++ + 5 files changed, 108 insertions(+) + create mode 100644 lib/parse-time-vrp.cc + create mode 100644 lib/parse-time-vrp.h + +diff --git a/lib/Makefile.local b/lib/Makefile.local +index 62d76b2..7785944 100644 +--- a/lib/Makefile.local ++++ b/lib/Makefile.local +@@ -61,6 +61,7 @@ libnotmuch_c_srcs = \ + + libnotmuch_cxx_srcs = \ + $(dir)/database.cc \ ++ $(dir)/parse-time-vrp.cc \ + $(dir)/directory.cc \ + $(dir)/index.cc \ + $(dir)/message.cc \ +diff --git a/lib/database-private.h b/lib/database-private.h +index 88532d5..d3e65fd 100644 +--- a/lib/database-private.h ++++ b/lib/database-private.h +@@ -52,6 +52,7 @@ struct _notmuch_database { + Xapian::QueryParser *query_parser; + Xapian::TermGenerator *term_gen; + Xapian::ValueRangeProcessor *value_range_processor; ++ Xapian::ValueRangeProcessor *date_range_processor; + }; + + /* Return the list of terms from the given iterator matching a prefix. +diff --git a/lib/database.cc b/lib/database.cc +index 761dc1a..4df3217 100644 +--- a/lib/database.cc ++++ b/lib/database.cc +@@ -19,6 +19,7 @@ + */ + + #include "database-private.h" ++#include "parse-time-vrp.h" + + #include + +@@ -710,12 +711,14 @@ notmuch_database_open (const char *path, + notmuch->term_gen = new Xapian::TermGenerator; + notmuch->term_gen->set_stemmer (Xapian::Stem ("english")); + notmuch->value_range_processor = new Xapian::NumberValueRangeProcessor (NOTMUCH_VALUE_TIMESTAMP); ++ notmuch->date_range_processor = new ParseTimeValueRangeProcessor (NOTMUCH_VALUE_TIMESTAMP); + + notmuch->query_parser->set_default_op (Xapian::Query::OP_AND); + notmuch->query_parser->set_database (*notmuch->xapian_db); + notmuch->query_parser->set_stemmer (Xapian::Stem ("english")); + notmuch->query_parser->set_stemming_strategy (Xapian::QueryParser::STEM_SOME); + notmuch->query_parser->add_valuerangeprocessor (notmuch->value_range_processor); ++ notmuch->query_parser->add_valuerangeprocessor (notmuch->date_range_processor); + + for (i = 0; i < ARRAY_SIZE (BOOLEAN_PREFIX_EXTERNAL); i++) { + prefix_t *prefix = &BOOLEAN_PREFIX_EXTERNAL[i]; +@@ -778,6 +781,8 @@ notmuch_database_close (notmuch_database_t *notmuch) + notmuch->xapian_db = NULL; + delete notmuch->value_range_processor; + notmuch->value_range_processor = NULL; ++ delete notmuch->date_range_processor; ++ notmuch->date_range_processor = NULL; + } + + void +diff --git a/lib/parse-time-vrp.cc b/lib/parse-time-vrp.cc +new file mode 100644 +index 0000000..33f07db +--- /dev/null ++++ b/lib/parse-time-vrp.cc +@@ -0,0 +1,61 @@ ++/* parse-time-vrp.cc - date range query glue ++ * ++ * This file is part of notmuch. ++ * ++ * Copyright © 2012 Jani Nikula ++ * ++ * This program is free software: you can redistribute it and/or modify ++ * it under the terms of the GNU General Public License as published by ++ * the Free Software Foundation, either version 3 of the License, or ++ * (at your option) any later version. ++ * ++ * This program is distributed in the hope that it will be useful, ++ * but WITHOUT ANY WARRANTY; without even the implied warranty of ++ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the ++ * GNU General Public License for more details. ++ * ++ * You should have received a copy of the GNU General Public License ++ * along with this program. If not, see http://www.gnu.org/licenses/ . ++ * ++ * Author: Jani Nikula ++ */ ++ ++#include "database-private.h" ++#include "parse-time-vrp.h" ++#include "parse-time-string.h" ++ ++#define PREFIX "date:" ++ ++/* See *ValueRangeProcessor in xapian-core/api/valuerangeproc.cc */ ++Xapian::valueno ++ParseTimeValueRangeProcessor::operator() (std::string &begin, std::string &end) ++{ ++ time_t t, now; ++ ++ /* Require date: prefix in start of the range... */ ++ if (STRNCMP_LITERAL (begin.c_str (), PREFIX)) ++ return Xapian::BAD_VALUENO; ++ ++ /* ...and remove it. */ ++ begin.erase (0, sizeof (PREFIX) - 1); ++ ++ /* Use the same 'now' for begin and end. */ ++ if (time (&now) == (time_t) -1) ++ return Xapian::BAD_VALUENO; ++ ++ if (!begin.empty ()) { ++ if (parse_time_string (begin.c_str (), &t, &now, PARSE_TIME_ROUND_DOWN)) ++ return Xapian::BAD_VALUENO; ++ ++ begin.assign (Xapian::sortable_serialise ((double) t)); ++ } ++ ++ if (!end.empty ()) { ++ if (parse_time_string (end.c_str (), &t, &now, PARSE_TIME_ROUND_UP_INCLUSIVE)) ++ return Xapian::BAD_VALUENO; ++ ++ end.assign (Xapian::sortable_serialise ((double) t)); ++ } ++ ++ return valno; ++} +diff --git a/lib/parse-time-vrp.h b/lib/parse-time-vrp.h +new file mode 100644 +index 0000000..094c4f8 +--- /dev/null ++++ b/lib/parse-time-vrp.h +@@ -0,0 +1,40 @@ ++/* parse-time-vrp.h - date range query glue ++ * ++ * This file is part of notmuch. ++ * ++ * Copyright © 2012 Jani Nikula ++ * ++ * This program is free software: you can redistribute it and/or modify ++ * it under the terms of the GNU General Public License as published by ++ * the Free Software Foundation, either version 3 of the License, or ++ * (at your option) any later version. ++ * ++ * This program is distributed in the hope that it will be useful, ++ * but WITHOUT ANY WARRANTY; without even the implied warranty of ++ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the ++ * GNU General Public License for more details. ++ * ++ * You should have received a copy of the GNU General Public License ++ * along with this program. If not, see http://www.gnu.org/licenses/ . ++ * ++ * Author: Jani Nikula ++ */ ++ ++#ifndef NOTMUCH_PARSE_TIME_VRP_H ++#define NOTMUCH_PARSE_TIME_VRP_H ++ ++#include ++ ++/* see *ValueRangeProcessor in xapian-core/include/xapian/queryparser.h */ ++class ParseTimeValueRangeProcessor : public Xapian::ValueRangeProcessor { ++protected: ++ Xapian::valueno valno; ++ ++public: ++ ParseTimeValueRangeProcessor (Xapian::valueno slot_) ++ : valno(slot_) { } ++ ++ Xapian::valueno operator() (std::string &begin, std::string &end); ++}; ++ ++#endif /* NOTMUCH_PARSE_TIME_VRP_H */ +-- +1.7.10.4 +