[PATCH v2 07/11] emacs: Use notmuch tag --batch for large tag queries
authorAustin Clements <amdragon@MIT.EDU>
Thu, 24 Oct 2013 15:19:07 +0000 (11:19 +2000)
committerW. Trevor King <wking@tremily.us>
Fri, 7 Nov 2014 17:57:36 +0000 (09:57 -0800)
fc/46f6ca502c3e74e0b68c104096775306726455 [new file with mode: 0644]

diff --git a/fc/46f6ca502c3e74e0b68c104096775306726455 b/fc/46f6ca502c3e74e0b68c104096775306726455
new file mode 100644 (file)
index 0000000..a9e3d6d
--- /dev/null
@@ -0,0 +1,155 @@
+Return-Path: <amdragon@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 B6133421161\r
+       for <notmuch@notmuchmail.org>; Thu, 24 Oct 2013 08:19:38 -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 tXz8pfWyvPed for <notmuch@notmuchmail.org>;\r
+       Thu, 24 Oct 2013 08:19:33 -0700 (PDT)\r
+Received: from dmz-mailsec-scanner-7.mit.edu (dmz-mailsec-scanner-7.mit.edu\r
+       [18.7.68.36])\r
+       by olra.theworths.org (Postfix) with ESMTP id 07496429E48\r
+       for <notmuch@notmuchmail.org>; Thu, 24 Oct 2013 08:19:22 -0700 (PDT)\r
+X-AuditID: 12074424-b7f528e0000009aa-23-52693a7a95f6\r
+Received: from mailhub-auth-2.mit.edu ( [18.7.62.36])\r
+       by dmz-mailsec-scanner-7.mit.edu (Symantec Messaging Gateway) with SMTP\r
+       id C1.25.02474.A7A39625; Thu, 24 Oct 2013 11:19:22 -0400 (EDT)\r
+Received: from outgoing.mit.edu (outgoing-auth-1.mit.edu [18.9.28.11])\r
+       by mailhub-auth-2.mit.edu (8.13.8/8.9.2) with ESMTP id r9OFJF9H011798; \r
+       Thu, 24 Oct 2013 11:19:15 -0400\r
+Received: from drake.dyndns.org\r
+       (216-15-114-40.c3-0.arl-ubr1.sbo-arl.ma.cable.rcn.com\r
+       [216.15.114.40]) (authenticated bits=0)\r
+       (User authenticated as amdragon@ATHENA.MIT.EDU)\r
+       by outgoing.mit.edu (8.13.8/8.12.4) with ESMTP id r9OFJCqk012919\r
+       (version=TLSv1/SSLv3 cipher=AES256-SHA bits=256 verify=NOT);\r
+       Thu, 24 Oct 2013 11:19:14 -0400\r
+Received: from amthrax by drake.dyndns.org with local (Exim 4.77)\r
+       (envelope-from <amdragon@mit.edu>)\r
+       id 1VZMgq-0006dz-Qd; Thu, 24 Oct 2013 11:19:12 -0400\r
+From: Austin Clements <amdragon@MIT.EDU>\r
+To: notmuch@notmuchmail.org\r
+Subject: [PATCH v2 07/11] emacs: Use notmuch tag --batch for large tag queries\r
+Date: Thu, 24 Oct 2013 11:19:07 -0400\r
+Message-Id: <1382627951-25252-8-git-send-email-amdragon@mit.edu>\r
+X-Mailer: git-send-email 1.8.4.rc3\r
+In-Reply-To: <1382627951-25252-1-git-send-email-amdragon@mit.edu>\r
+References: <1382627951-25252-1-git-send-email-amdragon@mit.edu>\r
+X-Brightmail-Tracker:\r
+ H4sIAAAAAAAAA+NgFjrGIsWRmVeSWpSXmKPExsUixG6noltllRlksPSIkkXTdGeL1XN5LK7f\r
+       nMnswOyxc9Zddo9b91+zezxbdYs5gDmKyyYlNSezLLVI3y6BK+PT+WVsBT9kKs4s6mZtYOyV\r
+       6GLk5JAQMJHYMeEjM4QtJnHh3nq2LkYuDiGBfYwS6x/vhnI2MkrM2nKFHcK5wySxccZcqMxc\r
+       RonDvVsZQfrZBDQktu1fDmaLCEhL7Lw7mxXEZhaIljhyeQYbiC0s4Cfxq2M1O4jNIqAq0XRy\r
+       J1icV8BBYkLbCUaIO5QkFp7aBtbLKeAo8fP1NbC4EFDNr99nWCYw8i9gZFjFKJuSW6Wbm5iZ\r
+       U5yarFucnJiXl1qka66Xm1mil5pSuokRHFwuKjsYmw8pHWIU4GBU4uHV+JAeJMSaWFZcmXuI\r
+       UZKDSUmU955pZpAQX1J+SmVGYnFGfFFpTmrxIUYJDmYlEd5pekA53pTEyqrUonyYlDQHi5I4\r
+       7y0O+yAhgfTEktTs1NSC1CKYrAwHh5IEb6clUKNgUWp6akVaZk4JQpqJgxNkOA/Q8HsgNbzF\r
+       BYm5xZnpEPlTjIpS4rzzQBICIImM0jy4Xlj0v2IUB3pFmHcTSBUPMHHAdb8CGswENHjKkjSQ\r
+       wSWJCCmpBsa6bV/Lyg/510RU1Wkbyq6aKWB07Nb2E2eN7eRvSRT/Yl63ZdE9vv1cPLvsfymx\r
+       eT7uKar9+HjK8ehVKX71EycEfEm9pf0iQ6Npd9zKEw2vbwiwFX3q2P1x1R5upqeqKn3+nJGC\r
+       8zbtbuV/u/lI6XMBNb7A8pTYX83CwidEvtben/Cs5K5D7F0lluKMREMt5qLiRACIqFfS2QIA        AA==\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: Thu, 24 Oct 2013 15:19:39 -0000\r
+\r
+(Unfortunately, it's difficult to first demonstrate this problem with\r
+a known-broken test because modern Linux kernels have argument length\r
+limits in the megabytes, which makes Emacs really slow!)\r
+---\r
+ emacs/notmuch-lib.el |  8 ++++++++\r
+ emacs/notmuch-tag.el | 15 +++++++++++++--\r
+ test/emacs           |  8 ++++++++\r
+ 3 files changed, 29 insertions(+), 2 deletions(-)\r
+\r
+diff --git a/emacs/notmuch-lib.el b/emacs/notmuch-lib.el\r
+index 22156f1..348112b 100644\r
+--- a/emacs/notmuch-lib.el\r
++++ b/emacs/notmuch-lib.el\r
+@@ -261,6 +261,14 @@ user-friendly queries."\r
+   "Return a query that matches the message with id ID."\r
+   (concat "id:" (notmuch-escape-boolean-term id)))\r
\r
++(defun notmuch-hex-encode (str)\r
++  "Hex-encode STR (e.g., as used by batch tagging).\r
++\r
++This replaces spaces, percents, and double quotes in STR with\r
++%NN where NN is the hexadecimal value of the character."\r
++  (replace-regexp-in-string\r
++   "[ %\"]" (lambda (match) (format "%%%02x" (aref match 0))) str))\r
++\r
+ ;;\r
\r
+ (defun notmuch-common-do-stash (text)\r
+diff --git a/emacs/notmuch-tag.el b/emacs/notmuch-tag.el\r
+index 7b21006..cbb935c 100644\r
+--- a/emacs/notmuch-tag.el\r
++++ b/emacs/notmuch-tag.el\r
+@@ -252,6 +252,12 @@ from TAGS if present."\r
+          (error "Changed tag must be of the form `+this_tag' or `-that_tag'")))))\r
+     (sort result-tags 'string<)))\r
\r
++(defconst notmuch-tag-argument-limit 1000\r
++  "Use batch tagging if the tagging query is longer than this.\r
++\r
++This limits the length of arguments passed to the notmuch CLI to\r
++avoid system argument length limits and performance problems.")\r
++\r
+ (defun notmuch-tag (query tag-changes)\r
+   "Add/remove tags in TAG-CHANGES to messages matching QUERY.\r
\r
+@@ -270,8 +276,13 @@ notmuch-after-tag-hook will be run."\r
+       tag-changes)\r
+   (unless (null tag-changes)\r
+     (run-hooks 'notmuch-before-tag-hook)\r
+-    (apply 'notmuch-call-notmuch-process "tag"\r
+-         (append tag-changes (list "--" query)))\r
++    (if (<= (length query) notmuch-tag-argument-limit)\r
++      (apply 'notmuch-call-notmuch-process "tag"\r
++             (append tag-changes (list "--" query)))\r
++      ;; Use batch tag mode to avoid argument length limitations\r
++      (let ((batch-op (concat (mapconcat #'notmuch-hex-encode tag-changes " ")\r
++                            " -- " query)))\r
++      (notmuch-call-notmuch-process :stdin-string batch-op "tag" "--batch")))\r
+     (run-hooks 'notmuch-after-tag-hook)))\r
\r
+ (defun notmuch-tag-change-list (tags &optional reverse)\r
+diff --git a/test/emacs b/test/emacs\r
+index 05295af..5fbee12 100755\r
+--- a/test/emacs\r
++++ b/test/emacs\r
+@@ -122,6 +122,14 @@ test_emacs "(notmuch-search \"$os_x_darwin_thread\")\r
+ output=$(notmuch search $os_x_darwin_thread | notmuch_search_sanitize)\r
+ test_expect_equal "$output" "thread:XXX   2009-11-18 [4/4] Jjgod Jiang, Alexander Botero-Lowry; [notmuch] Mac OS X/Darwin compatibility issues (inbox unread)"\r
\r
++test_begin_subtest "Add tag (large query)"\r
++# We use a long query to force us into batch mode and use a funny tag\r
++# that requires escaping for batch tagging.\r
++test_emacs "(notmuch-tag (concat \"$os_x_darwin_thread\" \" or \" (make-string notmuch-tag-argument-limit ?x)) (list \"+tag-from-%-large-query\"))"\r
++output=$(notmuch search $os_x_darwin_thread | notmuch_search_sanitize)\r
++test_expect_equal "$output" "thread:XXX   2009-11-18 [4/4] Jjgod Jiang, Alexander Botero-Lowry; [notmuch] Mac OS X/Darwin compatibility issues (inbox tag-from-%-large-query unread)"\r
++notmuch tag -tag-from-%-large-query $os_x_darwin_thread\r
++\r
+ test_begin_subtest "notmuch-show: add single tag to single message"\r
+ test_emacs "(notmuch-show \"$os_x_darwin_thread\")\r
+           (execute-kbd-macro \"+tag-from-show-view\")"\r
+-- \r
+1.8.4.rc3\r
+\r