From c9768ace9d3611dc669a48e445c7b8487268aae7 Mon Sep 17 00:00:00 2001 From: Austin Clements Date: Tue, 31 Jan 2012 23:43:52 +1900 Subject: [PATCH] Re: [PATCH 3/7] lib: Make notmuch_query_search_messages set the exclude flag --- 97/634ef7a4b02d89d761a183bc157ef3bc22fc88 | 265 ++++++++++++++++++++++ 1 file changed, 265 insertions(+) create mode 100644 97/634ef7a4b02d89d761a183bc157ef3bc22fc88 diff --git a/97/634ef7a4b02d89d761a183bc157ef3bc22fc88 b/97/634ef7a4b02d89d761a183bc157ef3bc22fc88 new file mode 100644 index 000000000..9e7f1fe45 --- /dev/null +++ b/97/634ef7a4b02d89d761a183bc157ef3bc22fc88 @@ -0,0 +1,265 @@ +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 BA3E1431E64 + for ; Mon, 30 Jan 2012 20:44:48 -0800 (PST) +X-Virus-Scanned: Debian amavisd-new at olra.theworths.org +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 Mru7AIKc-mMB for ; + Mon, 30 Jan 2012 20:44:46 -0800 (PST) +Received: from dmz-mailsec-scanner-8.mit.edu (DMZ-MAILSEC-SCANNER-8.MIT.EDU + [18.7.68.37]) + by olra.theworths.org (Postfix) with ESMTP id 1EA8C431FBC + for ; Mon, 30 Jan 2012 20:44:46 -0800 (PST) +X-AuditID: 12074425-b7f4a6d0000008e0-97-4f2771bd419f +Received: from mailhub-auth-4.mit.edu ( [18.7.62.39]) + by dmz-mailsec-scanner-8.mit.edu (Symantec Messaging Gateway) with SMTP + id 08.F4.02272.DB1772F4; Mon, 30 Jan 2012 23:44:45 -0500 (EST) +Received: from outgoing.mit.edu (OUTGOING-AUTH.MIT.EDU [18.7.22.103]) + by mailhub-auth-4.mit.edu (8.13.8/8.9.2) with ESMTP id q0V4ij1l032194; + Mon, 30 Jan 2012 23:44:45 -0500 +Received: from awakening.csail.mit.edu (awakening.csail.mit.edu [18.26.4.91]) + (authenticated bits=0) + (User authenticated as amdragon@ATHENA.MIT.EDU) + by outgoing.mit.edu (8.13.6/8.12.4) with ESMTP id q0V4ii2W029861 + (version=TLSv1/SSLv3 cipher=AES256-SHA bits=256 verify=NOT); + Mon, 30 Jan 2012 23:44:45 -0500 (EST) +Received: from amthrax by awakening.csail.mit.edu with local (Exim 4.77) + (envelope-from ) + id 1Rs5ZQ-0002m6-TW; Mon, 30 Jan 2012 23:43:52 -0500 +Date: Mon, 30 Jan 2012 23:43:52 -0500 +From: Austin Clements +To: Mark Walters +Subject: Re: [PATCH 3/7] lib: Make notmuch_query_search_messages set the + exclude flag +Message-ID: <20120131044352.GZ17991@mit.edu> +References: <8762fu4aqt.fsf@qmul.ac.uk> + <1327862394-14334-3-git-send-email-markwalters1009@gmail.com> +MIME-Version: 1.0 +Content-Type: text/plain; charset=us-ascii +Content-Disposition: inline +In-Reply-To: <1327862394-14334-3-git-send-email-markwalters1009@gmail.com> +User-Agent: Mutt/1.5.21 (2010-09-15) +X-Brightmail-Tracker: + H4sIAAAAAAAAA+NgFuplleLIzCtJLcpLzFFi42IRYrdT191bqO5vsOiNpsXquTwW12/OZHZg + 8tg56y67x7NVt5gDmKK4bFJSczLLUov07RK4MhbdXsZacMO4Yue3HywNjDM1uxg5OCQETCQ+ + tct3MXICmWISF+6tZwOxhQT2MUq8bIvoYuQCsjcwSny5+pUdwjnJJHFlwycWCGcJo8TxxnOs + IC0sAqoS+/6/YASx2QQ0JLbtXw5miwjoSNw+tIAdxGYWkJb49ruZCcQWFgiXWPTnOwuIzQtU + c+rSS2aI1ekS3dcOsUHEBSVOznzCAtGrJXHj30smkKtB5iz/xwES5hTwkpi/7S/YKlEBFYkp + J7exTWAUmoWkexaS7lkI3QsYmVcxyqbkVunmJmbmFKcm6xYnJ+blpRbpWujlZpbopaaUbmIE + h7SL6g7GCYeUDjEKcDAq8fAKfFLzF2JNLCuuzD3EKMnBpCTKO6dA3V+ILyk/pTIjsTgjvqg0 + J7X4EKMEB7OSCO+b1UDlvCmJlVWpRfkwKWkOFiVxXk2td35A/yaWpGanphakFsFkZTg4lCR4 + w4CxKyRYlJqeWpGWmVOCkGbi4AQZzgM0XBSkhre4IDG3ODMdIn+KUZej/e3u84xCLHn5ealS + 4ryMIEUCIEUZpXlwc2Cp6BWjONBbwrz6IFU8wDQGN+kV0BImoCXPGVRBlpQkIqSkGhiFq/Yf + aLrDeb2hdkv9KX3pz7EWF5I3eyhonfb1PPT3dCLLkekuruZ9R1VLpn7vt4wKFVw/V1TvhW/9 + 4bOO5j+Td0hcu+iTdDXtHM8BM9M7S1qz5vw65b3CPKD7ikxfmJTM46abh2Ujfke98jMuEl9T + fIJ1epP5ec9IzQO6NznDdQK/HVQTPKrEUpyRaKjFXFScCABshsHfIAMAAA== +Cc: notmuch@notmuchmail.org +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, 31 Jan 2012 04:44:48 -0000 + +Quoth Mark Walters on Jan 29 at 6:39 pm: +> Add a flag NOTMUCH_MESSAGE_FLAG_EXCLUDED which is set by +> notmuch_query_search_messages for excluded messages. Also add an +> option omit_excluded_messages to the search that we do not want the +> excludes at all. +> +> This exclude flag will be added to notmuch_query_search threads in the +> next patch. +> --- +> lib/notmuch-private.h | 1 + +> lib/notmuch.h | 8 ++++++- +> lib/query.cc | 52 +++++++++++++++++++++++++++++++++++++++++++++--- +> 3 files changed, 56 insertions(+), 5 deletions(-) +> +> diff --git a/lib/notmuch-private.h b/lib/notmuch-private.h +> index 7bf153e..e791bb0 100644 +> --- a/lib/notmuch-private.h +> +++ b/lib/notmuch-private.h +> @@ -401,6 +401,7 @@ typedef struct _notmuch_message_list { +> */ +> struct visible _notmuch_messages { +> notmuch_bool_t is_of_list_type; +> + notmuch_doc_id_set_t *excluded_doc_ids; + +I might be following the diff wrong, but shouldn't this be a field of +notmuch_mset_messages_t? (Then it also doesn't have to be a pointer, +which is really how notmuch_doc_id_set_t was designed to be used.) + +> notmuch_message_node_t *iterator; +> }; +> +> diff --git a/lib/notmuch.h b/lib/notmuch.h +> index 7929fe7..740d005 100644 +> --- a/lib/notmuch.h +> +++ b/lib/notmuch.h +> @@ -449,6 +449,11 @@ typedef enum { +> const char * +> notmuch_query_get_query_string (notmuch_query_t *query); +> +> +/* specify whether to results should omit the excluded results rather +> + * than just marking them excluded */ +> +void +> +notmuch_query_set_omit_excluded_messages (notmuch_query_t *query, notmuch_bool_t omit); +> + + +I don't think we should add this API. The library behavior will not +change for library users that don't use excludes and library users +that do use excludes should by aware of the excluded flag and do the +appropriate thing. + +I can see why this is handy in some cases, but I don't think it +provides enough utility to warrant becoming part of the permanent and +minimal library interface. + +> /* Specify the sorting desired for this query. */ +> void +> notmuch_query_set_sort (notmuch_query_t *query, notmuch_sort_t sort); +> @@ -895,7 +900,8 @@ notmuch_message_get_filenames (notmuch_message_t *message); +> +> /* Message flags */ +> typedef enum _notmuch_message_flag { +> - NOTMUCH_MESSAGE_FLAG_MATCH +> + NOTMUCH_MESSAGE_FLAG_MATCH, +> + NOTMUCH_MESSAGE_FLAG_EXCLUDED +> } notmuch_message_flag_t; +> +> /* Get a value of a flag for the email corresponding to 'message'. */ +> diff --git a/lib/query.cc b/lib/query.cc +> index c25b301..7d165d2 100644 +> --- a/lib/query.cc +> +++ b/lib/query.cc +> @@ -28,6 +28,7 @@ struct _notmuch_query { +> const char *query_string; +> notmuch_sort_t sort; +> notmuch_string_list_t *exclude_terms; +> + notmuch_bool_t omit_excluded_messages; +> }; +> +> typedef struct _notmuch_mset_messages { +> @@ -57,6 +58,12 @@ struct visible _notmuch_threads { +> notmuch_doc_id_set_t match_set; +> }; +> +> +/* we need this in the message functions so forward declare */ + +Comments should start with a capital letter and end with a period. +(The code isn't completely consistent about this, but it is something +we're codifying in the upcoming style guide.) + +> +static notmuch_bool_t +> +_notmuch_doc_id_set_init (void *ctx, +> + notmuch_doc_id_set_t *doc_ids, +> + GArray *arr); +> + +> notmuch_query_t * +> notmuch_query_create (notmuch_database_t *notmuch, +> const char *query_string) +> @@ -79,6 +86,8 @@ notmuch_query_create (notmuch_database_t *notmuch, +> +> query->exclude_terms = _notmuch_string_list_create (query); +> +> + query->omit_excluded_messages = FALSE; +> + +> return query; +> } +> +> @@ -89,6 +98,12 @@ notmuch_query_get_query_string (notmuch_query_t *query) +> } +> +> void +> +notmuch_query_set_omit_excluded_messages (notmuch_query_t *query, notmuch_bool_t omit) +> +{ +> + query->omit_excluded_messages = omit; +> +} +> + +> +void +> notmuch_query_set_sort (notmuch_query_t *query, notmuch_sort_t sort) +> { +> query->sort = sort; +> @@ -173,6 +188,7 @@ notmuch_query_search_messages (notmuch_query_t *query) +> "mail")); +> Xapian::Query string_query, final_query, exclude_query; +> Xapian::MSet mset; +> + Xapian::MSetIterator iterator; +> unsigned int flags = (Xapian::QueryParser::FLAG_BOOLEAN | +> Xapian::QueryParser::FLAG_PHRASE | +> Xapian::QueryParser::FLAG_LOVEHATE | +> @@ -190,11 +206,35 @@ notmuch_query_search_messages (notmuch_query_t *query) +> final_query = Xapian::Query (Xapian::Query::OP_AND, +> mail_query, string_query); +> } +> + messages->base.excluded_doc_ids = NULL; +> + +> + if (query->exclude_terms) { +> + exclude_query = _notmuch_exclude_tags (query, final_query); +> + exclude_query = Xapian::Query (Xapian::Query::OP_AND, +> + exclude_query, final_query); +> + +> + if (query->omit_excluded_messages) +> + final_query = Xapian::Query (Xapian::Query::OP_AND_NOT, +> + final_query, exclude_query); +> + else { +> + enquire.set_weighting_scheme (Xapian::BoolWeight()); +> + enquire.set_query (exclude_query); +> + +> + mset = enquire.get_mset (0, notmuch->xapian_db->get_doccount ()); +> + +> + GArray *excluded_doc_ids = g_array_new (FALSE, FALSE, sizeof (unsigned int)); +> + +> + for (iterator = mset.begin (); iterator != mset.end (); iterator++) +> + { + +No newline before the brace. + +> + unsigned int doc_id = *iterator; +> + g_array_append_val (excluded_doc_ids, doc_id); +> + } +> + messages->base.excluded_doc_ids = talloc (query, _notmuch_doc_id_set); +> + _notmuch_doc_id_set_init (query, messages->base.excluded_doc_ids, +> + excluded_doc_ids); + +Don't forget to g_array_unref excluded_doc_ids. + +> + } +> + } +> +> - exclude_query = _notmuch_exclude_tags (query, final_query); +> - +> - final_query = Xapian::Query (Xapian::Query::OP_AND_NOT, +> - final_query, exclude_query); +> +> enquire.set_weighting_scheme (Xapian::BoolWeight()); +> +> @@ -283,6 +323,10 @@ _notmuch_mset_messages_get (notmuch_messages_t *messages) +> INTERNAL_ERROR ("a messages iterator contains a non-existent document ID.\n"); +> } +> +> + if ((messages->excluded_doc_ids) && +> + (_notmuch_doc_id_set_contains (messages->excluded_doc_ids, doc_id))) + +No need for so many parens (just a nit). + +> + notmuch_message_set_flag (message, NOTMUCH_MESSAGE_FLAG_EXCLUDED, TRUE); +> + +> return message; +> } +> -- 2.26.2