[PATCH 1/2] lib: Expose query debug output via an environment variable

diff --git a/22/e24a29d332d055e9f8dc0abac5ca27eccbd7b3 b/22/e24a29d332d055e9f8dc0abac5ca27eccbd7b3
new file mode 100644 (file)
index 0000000..b535e5a
--- /dev/null
+++ b/22/e24a29d332d055e9f8dc0abac5ca27eccbd7b3
@@ -0,0 +1,141 @@
+Return-Path: <amthrax@drake.mit.edu>\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 E4700431FD7\r
+       for <notmuch@notmuchmail.org>; Tue, 13 Mar 2012 19:31:36 -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 2th75KH-+UWj for <notmuch@notmuchmail.org>;\r
+       Tue, 13 Mar 2012 19:31:34 -0700 (PDT)\r
+Received: from dmz-mailsec-scanner-3.mit.edu (DMZ-MAILSEC-SCANNER-3.MIT.EDU\r
+       [18.9.25.14])\r
+       by olra.theworths.org (Postfix) with ESMTP id B85A2431FAE\r
+       for <notmuch@notmuchmail.org>; Tue, 13 Mar 2012 19:31:34 -0700 (PDT)\r
+X-AuditID: 1209190e-b7f7c6d0000008c3-92-4f600306a025\r
+Received: from mailhub-auth-1.mit.edu ( [18.9.21.35])\r
+       by dmz-mailsec-scanner-3.mit.edu (Symantec Messaging Gateway) with SMTP\r
+       id 0E.82.02243.603006F4; Tue, 13 Mar 2012 22:31:34 -0400 (EDT)\r
+Received: from outgoing.mit.edu (OUTGOING-AUTH.MIT.EDU [18.7.22.103])\r
+       by mailhub-auth-1.mit.edu (8.13.8/8.9.2) with ESMTP id q2E2VYen007532; \r
+       Tue, 13 Mar 2012 22:31:34 -0400\r
+Received: from drake.mit.edu\r
+       (209-6-116-242.c3-0.arl-ubr1.sbo-arl.ma.cable.rcn.com\r
+       [209.6.116.242]) (authenticated bits=0)\r
+       (User authenticated as amdragon@ATHENA.MIT.EDU)\r
+       by outgoing.mit.edu (8.13.6/8.12.4) with ESMTP id q2E2VWG3023783\r
+       (version=TLSv1/SSLv3 cipher=AES256-SHA bits=256 verify=NOT);\r
+       Tue, 13 Mar 2012 22:31:33 -0400 (EDT)\r
+Received: from amthrax by drake.mit.edu with local (Exim 4.77)\r
+       (envelope-from <amthrax@drake.mit.edu>)\r
+       id 1S7dzw-0007DC-IS; Tue, 13 Mar 2012 22:31:32 -0400\r
+From: Austin Clements <amdragon@MIT.EDU>\r
+To: notmuch@notmuchmail.org\r
+Subject: [PATCH 1/2] lib: Expose query debug output via an environment\r
+ variable\r
+Date: Tue, 13 Mar 2012 22:31:30 -0400\r
+Message-Id: <1331692291-27671-2-git-send-email-amdragon@mit.edu>\r
+X-Mailer: git-send-email 1.7.7.3\r
+In-Reply-To: <1331692291-27671-1-git-send-email-amdragon@mit.edu>\r
+References: <1331692291-27671-1-git-send-email-amdragon@mit.edu>\r
+X-Brightmail-Tracker:\r
+ H4sIAAAAAAAAA+NgFtrIIsWRmVeSWpSXmKPExsUixCmqrMvGnOBv0NcqaXH95kxmB0aPZ6tu\r
+       MQcwRnHZpKTmZJalFunbJXBlNK2fw1QwQaDi84q0BsZO3i5GTg4JAROJ1+/XsULYYhIX7q1n\r
+       62Lk4hAS2McocbT/LDtIQkhgA6PE+on5EIn7TBLHfl9hh3DmM0ocuLeeGaSKTUBDYtv+5Ywg\r
+       toiAtMTOu7OBxnJwMAuoSfzpUgEJCwv4S8w+PhlsKIuAqsTfyUuZQGxeAQeJhU2tjBBXKEic\r
+       W30OrIZTwFHi0v95jBBHOEg0LH/PNoGRfwEjwypG2ZTcKt3cxMyc4tRk3eLkxLy81CJdY73c\r
+       zBK91JTSTYzgkJHk28H49aDSIUYBDkYlHl7h2nh/IdbEsuLK3EOMkhxMSqK8kW+BQnxJ+SmV\r
+       GYnFGfFFpTmpxYcYJTiYlUR4X0wFyvGmJFZWpRblw6SkOViUxHnVtN75CQmkJ5akZqemFqQW\r
+       wWRlODiUJHhVQIYKFqWmp1akZeaUIKSZODhBhvMADS//DjK8uCAxtzgzHSJ/ilFRSpz3zhug\r
+       hABIIqM0D64XFtOvGMWBXhHmXQlSxQNMB3Ddr4AGMwENLvkWBzK4JBEhJdXAyLjgm9k7n09V\r
+       n5V7rmqGu8yU+/HDe+uE7wpNP3pMv/vp3VjDwnmp+gj3xfCGzBDtlpff8lnbJs38tfRYzMKc\r
+       0+1hWblhYt9MpjSc2BVyXtNEcu3UpkONHyd0Vd3dO53JQOj9nuI7l5j3GG+vn3N1j/NcyS/f\r
+       Z0u33CiI8Xte1VFR8Obn1fa7f5VYijMSDbWYi4oTAbBDShTEAgAA\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: Wed, 14 Mar 2012 02:31:37 -0000\r
+\r
+Allow query debugging to be enabled at run-time by setting the\r
+NOTMUCH_DEBUG_QUERY environment variable to a non-empty string.\r
+\r
+Previously, enabling query debugging required recompiling, but parsed\r
+queries are often useful for tracking down bugs in situations where\r
+recompiling is inconvenient.\r
+---\r
+ lib/query.cc |   24 +++++++++++++++---------\r
+ 1 files changed, 15 insertions(+), 9 deletions(-)\r
+\r
+diff --git a/lib/query.cc b/lib/query.cc\r
+index ab18fbc..1e5e99a 100644\r
+--- a/lib/query.cc\r
++++ b/lib/query.cc\r
+@@ -64,15 +64,21 @@ _notmuch_doc_id_set_init (void *ctx,\r
+                         notmuch_doc_id_set_t *doc_ids,\r
+                         GArray *arr);\r
+ \r
++static notmuch_bool_t\r
++_debug_query (void)\r
++{\r
++    char *env = getenv ("NOTMUCH_DEBUG_QUERY");\r
++    return (env && strcmp (env, "") != 0);\r
++}\r
++\r
+ notmuch_query_t *\r
+ notmuch_query_create (notmuch_database_t *notmuch,\r
+                     const char *query_string)\r
+ {\r
+     notmuch_query_t *query;\r
+ \r
+-#ifdef DEBUG_QUERY\r
+-    fprintf (stderr, "Query string is:\n%s\n", query_string);\r
+-#endif\r
++    if (_debug_query ())\r
++      fprintf (stderr, "Query string is:\n%s\n", query_string);\r
+ \r
+     query = talloc (NULL, notmuch_query_t);\r
+     if (unlikely (query == NULL))\r
+@@ -255,9 +261,9 @@ notmuch_query_search_messages (notmuch_query_t *query)\r
+           break;\r
+       }\r
+ \r
+-#if DEBUG_QUERY\r
+-      fprintf (stderr, "Final query is:\n%s\n", final_query.get_description().c_str());\r
+-#endif\r
++      if (_debug_query ())\r
++          fprintf (stderr, "Final query is:\n%s\n",\r
++                   final_query.get_description ().c_str ());\r
+ \r
+       enquire.set_query (final_query);\r
+ \r
+@@ -531,9 +537,9 @@ notmuch_query_count_messages (notmuch_query_t *query)\r
+       enquire.set_weighting_scheme(Xapian::BoolWeight());\r
+       enquire.set_docid_order(Xapian::Enquire::ASCENDING);\r
+ \r
+-#if DEBUG_QUERY\r
+-      fprintf (stderr, "Final query is:\n%s\n", final_query.get_description().c_str());\r
+-#endif\r
++      if (_debug_query ())\r
++          fprintf (stderr, "Final query is:\n%s\n",\r
++                   final_query.get_description ().c_str ());\r
+ \r
+       enquire.set_query (final_query);\r
+ \r
+-- \r
+1.7.7.3\r
+\r