From: Mark Walters Date: Mon, 16 May 2016 07:36:51 +0000 (+0100) Subject: [PATCH v3] emacs: address completion, allow sender/recipient and filters X-Git-Url: http://git.tremily.us/?a=commitdiff_plain;h=e373b205106b73846b1403bc2a14de5a4f39a01d;p=notmuch-archives.git [PATCH v3] emacs: address completion, allow sender/recipient and filters --- diff --git a/be/0cf3276271bfb8a06353ff98524416338ff65b b/be/0cf3276271bfb8a06353ff98524416338ff65b new file mode 100644 index 000000000..0635295a4 --- /dev/null +++ b/be/0cf3276271bfb8a06353ff98524416338ff65b @@ -0,0 +1,309 @@ +Return-Path: +X-Original-To: notmuch@notmuchmail.org +Delivered-To: notmuch@notmuchmail.org +Received: from localhost (localhost [127.0.0.1]) + by arlo.cworth.org (Postfix) with ESMTP id DB45A6DE0222 + for ; Mon, 16 May 2016 00:37:07 -0700 (PDT) +X-Virus-Scanned: Debian amavisd-new at cworth.org +X-Spam-Flag: NO +X-Spam-Score: -0.311 +X-Spam-Level: +X-Spam-Status: No, score=-0.311 tagged_above=-999 required=5 tests=[AWL=0.259, + DKIM_SIGNED=0.1, DKIM_VALID=-0.1, DKIM_VALID_AU=-0.1, + FREEMAIL_ENVFROM_END_DIGIT=0.25, FREEMAIL_FROM=0.001, RCVD_IN_DNSWL_LOW=-0.7, + RCVD_IN_MSPIKE_H3=-0.01, RCVD_IN_MSPIKE_WL=-0.01, SPF_PASS=-0.001] + autolearn=disabled +Received: from arlo.cworth.org ([127.0.0.1]) + by localhost (arlo.cworth.org [127.0.0.1]) (amavisd-new, port 10024) + with ESMTP id 6xuXdlzBDpkn for ; + Mon, 16 May 2016 00:36:59 -0700 (PDT) +Received: from mail-wm0-f51.google.com (mail-wm0-f51.google.com + [74.125.82.51]) by arlo.cworth.org (Postfix) with ESMTPS id D6FCD6DE01D0 for + ; Mon, 16 May 2016 00:36:58 -0700 (PDT) +Received: by mail-wm0-f51.google.com with SMTP id a17so121637055wme.0 + for ; Mon, 16 May 2016 00:36:58 -0700 (PDT) +DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=gmail.com; s=20120113; + h=from:to:cc:subject:date:message-id:in-reply-to:references; + bh=MNzWU9q5T3VkW1ct7Ma7Q8aO356CL3GdW2ogBNbJDBk=; + b=tBJq3yTyddqToL45vgK5HIesf4KZta8L9CmGJ5DNqKv/5+qW5PR+vAOtmdcJG37Dbd + ydFHnDFJJxT/AD4RtReA2AB7Mtac5H8z9d4S4yG0cViuQqE3Le+p2zMghtO/Tk9lxqe2 + BHosKGRjQSdoDCHIl/Q/CIkEWfGjcaepaknbPj0XkuF1xiL0A7Qwm6qPvmROHeoKX98d + /bnQeBE4jK9A1oTT4sJGokO+lwrwd0MWTGcoHjPUGY1rC+l52unL58haSz8e6bzFUnCD + uUY4I6uI6V/Ehu6EwQub/tb/XC7uT464z60sxTc6mBVFt+u8ynM3/T8Eiz7wB3mz3oNJ + HnZg== +X-Google-DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; + d=1e100.net; s=20130820; + h=x-gm-message-state:from:to:cc:subject:date:message-id:in-reply-to + :references; + bh=MNzWU9q5T3VkW1ct7Ma7Q8aO356CL3GdW2ogBNbJDBk=; + b=JCmSxgM6qvH3mAlqKdKLGpbqsim+CK72w6LnlQsmoWA0o9IoLvHCt+vDuB4fujlgjG + uMzaGpS+lLGFOkU0Cp9Wv28+o7Vcq+zxrIKUpXFL6hojhLa7VoxVz3qdsogTX6UimhZv + W8yYDwURAa4f3cFsyIaDOvtIwciLayCzklvJ1BjPA46cBcDAg7UYaCWXs94qd/N0T0So + nJH1tg/JQl27mGY4WpCyYsqnfXi5rpN6QcDdiaNPhyQFdEedrxQB5td4usJvKs7QLRnj + tNWv1xKRBFWW6dM4Rmzz0st6L6q2SgBxhMk5w3pnLP6Vi48VzKm3+h1ZyVlfZhdKlWLI + Mp/Q== +X-Gm-Message-State: + AOPr4FU9jVHxio2+3Cacu5FQoL4SOmfdxX8BD4TfSpun/95mg7rmwVrK1Ppxy3MG0zftKA== +X-Received: by 10.194.14.6 with SMTP id l6mr31907904wjc.48.1463384216658; + Mon, 16 May 2016 00:36:56 -0700 (PDT) +Received: from localhost (5751dfa2.skybroadband.com. [87.81.223.162]) + by smtp.gmail.com with ESMTPSA id c85sm16379952wmd.0.2016.05.16.00.36.55 + (version=TLS1_2 cipher=ECDHE-RSA-AES128-GCM-SHA256 bits=128/128); + Mon, 16 May 2016 00:36:56 -0700 (PDT) +From: Mark Walters +To: notmuch@notmuchmail.org +Subject: [PATCH v3] emacs: address completion, + allow sender/recipient and filters +Date: Mon, 16 May 2016 08:36:51 +0100 +Message-Id: <1463384211-13086-1-git-send-email-markwalters1009@gmail.com> +X-Mailer: git-send-email 2.1.4 +In-Reply-To: <87h9e11vq1.fsf@steelpick.2x.cz> +References: <87h9e11vq1.fsf@steelpick.2x.cz> +X-BeenThere: notmuch@notmuchmail.org +X-Mailman-Version: 2.1.20 +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: Mon, 16 May 2016 07:37:07 -0000 + +This commit lets the user customize the address completion. + +The first change controls whether to build the address completion list +based on messages you have sent or you have received (the latter is +much faster). + +The second change add a possible filter query to limit the messages +used -- for example, setting this to date:1y.. would limit the +address completions to addresses used in the last year. This speeds up +the address harvest and may also make the search less cluttered as old +addresses may well no longer be valid. +--- + +This version uses the docstrings suggested my Michal (which are much +better than mine), and renames some variables, as he suggested, to +make the code clearer. + +I wondered about allowing the user to specify completion based on +message "sent or received", rather than either sent, or received, but +think that is adding too much mess. We could also allow completion +based on any messages in the database, which would the include +completion based on messages received via mailing lists or +distribution lists. + +I also note that if the user enters a bad query into the filter query +box (eg 6M.. rather than date:6M..) they may get an obscure error as +notmuch/xapian fails. I don't see a goo way round that so have left +that as a "don't do that" case. + +Best wishes + +Mark + + + emacs/notmuch-address.el | 119 ++++++++++++++++++++++++++++++++--------------- + emacs/notmuch-company.el | 2 +- + 2 files changed, 82 insertions(+), 39 deletions(-) + +diff --git a/emacs/notmuch-address.el b/emacs/notmuch-address.el +index aafbe5f..3dc5da9 100644 +--- a/emacs/notmuch-address.el ++++ b/emacs/notmuch-address.el +@@ -28,15 +28,51 @@ + ;; + (declare-function company-manual-begin "company") + +-(defcustom notmuch-address-command 'internal +- "The command which generates possible addresses. It must take a +-single argument and output a list of possible matches, one per +-line. The default value of `internal' uses built-in address +-completion." ++(defvar notmuch-address-last-harvest 0 ++ "Time of last address harvest") ++ ++(defvar notmuch-address-completions (make-hash-table :test 'equal) ++ "Hash of email addresses for completion during email composition. ++ This variable is set by calling `notmuch-address-harvest'.") ++ ++(defvar notmuch-address-full-harvest-finished nil ++ "t indicates that full completion address harvesting has been ++finished") ++ ++(defcustom notmuch-address-command '(sent nil) ++ "Determines how to generate address completion candidates. ++ ++If it is a string then that string should be an external program ++which must take a single argument (searched string) and output a ++list of completion candidates, one per line. ++ ++Alternatively, it can be a (non-nil) list, in which case internal ++completion is used; in this case the list should have form ++'(DIRECTION FILTER), where DIRECTION is either sent or received ++and specifies whether the candidates are searched in messages ++sent by the user or received by the user (note received by is ++much faster), and FILTER is either nil or a filter-string, such ++as \"date:1y..\" to append to the query. ++ ++If this variable is nil then address completion is disabled." + :type '(radio +- (const :tag "Use internal address completion" internal) ++ (list :tag "Use internal address completion" ++ (radio ++ :tag "Base completion on messages you have" ++ :value sent ++ (const :tag "sent" sent) ++ (const :tag "received" received)) ++ (radio :tag "Filter messages used for completion" ++ (const :tag "Use all messages" nil) ++ (string :tag "Filter query"))) + (const :tag "Disable address completion" nil) +- (string :tag "Use external completion command" "notmuch-addresses")) ++ (string :tag "Use external completion command")) ++ ;; We override set so that we can clear the cache when this changes ++ :set (lambda (symbol value) ++ (set-default symbol value) ++ (setq notmuch-address-last-harvest 0) ++ (setq notmuch-address-completions (clrhash notmuch-address-completions)) ++ (setq notmuch-address-full-harvest-finished nil)) + :group 'notmuch-send + :group 'notmuch-external) + +@@ -51,17 +87,6 @@ to know how address selection is made by default." + :group 'notmuch-send + :group 'notmuch-external) + +-(defvar notmuch-address-last-harvest 0 +- "Time of last address harvest") +- +-(defvar notmuch-address-completions (make-hash-table :test 'equal) +- "Hash of email addresses for completion during email composition. +- This variable is set by calling `notmuch-address-harvest'.") +- +-(defvar notmuch-address-full-harvest-finished nil +- "t indicates that full completion address harvesting has been +-finished") +- + (defun notmuch-address-selection-function (prompt collection initial-input) + "Call (`completing-read' + PROMPT COLLECTION nil nil INITIAL-INPUT 'notmuch-address-history)" +@@ -83,7 +108,8 @@ finished") + + (defun notmuch-address-setup () + (let* ((use-company (and notmuch-address-use-company +- (eq notmuch-address-command 'internal) ++ notmuch-address-command ++ (listp notmuch-address-command) + (require 'company nil t))) + (pair (cons notmuch-address-completion-headers-regexp + (if use-company +@@ -111,11 +137,11 @@ The candidates are taken from `notmuch-address-completions'." + elisp-based implementation or older implementation requiring + external commands." + (cond +- ((eq notmuch-address-command 'internal) ++ ((and notmuch-address-command (listp notmuch-address-command)) + (when (not notmuch-address-full-harvest-finished) + ;; First, run quick synchronous harvest based on what the user + ;; entered so far +- (notmuch-address-harvest (format "to:%s*" original) t)) ++ (notmuch-address-harvest original t)) + (prog1 (notmuch-address-matching original) + ;; Then start the (potentially long-running) full asynchronous harvest if necessary + (notmuch-address-harvest-trigger))) +@@ -191,32 +217,49 @@ external commands." + + The car is a partial harvest, and the cdr is a full harvest") + +-(defun notmuch-address-harvest (&optional filter-query synchronous callback) +- "Collect addresses completion candidates. It queries the +-notmuch database for all messages sent by the user optionally +-matching FILTER-QUERY (if not nil). It collects the destination +-addresses from those messages and stores them in +-`notmuch-address-completions'. Address harvesting may take some +-time so the address collection runs asynchronously unless +-SYNCHRONOUS is t. In case of asynchronous execution, CALLBACK is +-called when harvesting finishes." +- (let* ((from-me-query (mapconcat (lambda (x) (concat "from:" x)) (notmuch-user-emails) " or ")) +- (query (if filter-query +- (format "(%s) and (%s)" from-me-query filter-query) +- from-me-query)) ++(defun notmuch-address-harvest (&optional addr-prefix synchronous callback) ++ "Collect addresses completion candidates. ++ ++It queries the notmuch database for messages sent/received (as ++configured with `notmuch-address-command`) by the user, collects ++destination/source addresses from those messages and stores them ++in `notmuch-address-completions'. ++ ++If ADDR-PREFIX is not nil, only messages with to/from addresses ++matching ADDR-PREFIX*' are queried. ++ ++Address harvesting may take some time so the address collection runs ++asynchronously unless SYNCHRONOUS is t. In case of asynchronous ++execution, CALLBACK is called when harvesting finishes." ++ ++ (let* ((sent (eq (car notmuch-address-command) 'sent)) ++ (config-query (cadr notmuch-address-command)) ++ (prefix-query (when addr-prefix ++ (format "%s:%s*" (if sent "to" "from") addr-prefix))) ++ (from-or-to-me-query ++ (mapconcat (lambda (x) ++ (concat (if sent "from:" "to:") x)) ++ (notmuch-user-emails) " or ")) ++ (query (if (or prefix-query config-query) ++ (concat (format "(%s)" from-or-to-me-query) ++ (when prefix-query ++ (format " and (%s)" prefix-query)) ++ (when config-query ++ (format " and (%s)" config-query))) ++ from-or-to-me-query)) + (args `("address" "--format=sexp" "--format-version=2" +- "--output=recipients" ++ ,(if sent "--output=recipients" "--output=sender") + "--deduplicate=address" + ,query))) + (if synchronous + (mapc #'notmuch-address-harvest-addr + (apply 'notmuch-call-notmuch-sexp args)) + ;; Asynchronous +- (let* ((current-proc (if filter-query ++ (let* ((current-proc (if addr-prefix + (car notmuch-address-harvest-procs) + (cdr notmuch-address-harvest-procs))) + (proc-name (format "notmuch-address-%s-harvest" +- (if filter-query "partial" "full"))) ++ (if addr-prefix "partial" "full"))) + (proc-buf (concat " *" proc-name "*"))) + ;; Kill any existing process + (when current-proc +@@ -228,7 +271,7 @@ called when harvesting finishes." + args)) + (set-process-filter current-proc 'notmuch-address-harvest-filter) + (set-process-query-on-exit-flag current-proc nil) +- (if filter-query ++ (if addr-prefix + (setcar notmuch-address-harvest-procs current-proc) + (setcdr notmuch-address-harvest-procs current-proc))))) + ;; return value +diff --git a/emacs/notmuch-company.el b/emacs/notmuch-company.el +index b881d6d..dcb59cd 100644 +--- a/emacs/notmuch-company.el ++++ b/emacs/notmuch-company.el +@@ -72,7 +72,7 @@ + (lambda (callback) + ;; First run quick asynchronous harvest based on what the user entered so far + (notmuch-address-harvest +- (format "to:%s*" arg) nil ++ arg nil + (lambda (_proc _event) + (funcall callback (notmuch-address-matching arg)) + ;; Then start the (potentially long-running) full asynchronous harvest if necessary +-- +2.1.4 +