From: Mark Walters Date: Fri, 13 May 2016 15:28:57 +0000 (+0100) Subject: [PATCH v2] emacs: address completion, allow sender/recipient and filters X-Git-Url: http://git.tremily.us/?a=commitdiff_plain;h=568465e117cb42658f8731d68c3e812a45aba44e;p=notmuch-archives.git [PATCH v2] emacs: address completion, allow sender/recipient and filters --- diff --git a/7f/6af000920ec8c82888adc6040637a9052c94df b/7f/6af000920ec8c82888adc6040637a9052c94df new file mode 100644 index 000000000..0dda2dd3e --- /dev/null +++ b/7f/6af000920ec8c82888adc6040637a9052c94df @@ -0,0 +1,272 @@ +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 E32486DE02B0 + for ; Fri, 13 May 2016 08:29:15 -0700 (PDT) +X-Virus-Scanned: Debian amavisd-new at cworth.org +X-Spam-Flag: NO +X-Spam-Score: -0.309 +X-Spam-Level: +X-Spam-Status: No, score=-0.309 tagged_above=-999 required=5 tests=[AWL=0.261, + 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 47IzmQAm77_x for ; + Fri, 13 May 2016 08:29:07 -0700 (PDT) +Received: from mail-wm0-f45.google.com (mail-wm0-f45.google.com + [74.125.82.45]) by arlo.cworth.org (Postfix) with ESMTPS id 21DDC6DE02AF for + ; Fri, 13 May 2016 08:29:07 -0700 (PDT) +Received: by mail-wm0-f45.google.com with SMTP id g17so36146169wme.1 + for ; Fri, 13 May 2016 08:29:07 -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=h/6jiv7ipi+ShuQNmMvVeMMXx/sAp8QZYhKKkDxCkIY=; + b=Mqfa1/q8c3Bhr6NAayPMWhBLBEBf5mh3mgOSDo69ED5Q3MCAhTvtKa4naMOK8YmeiE + qHcE936WVDKKLfYoxaWey2oUWZQjWk7cDxa7ir67nPbgE3mKvgGn3XgU+9BCzlW/PQ2q + ex3IUGXfFRgOF612Z2xVS1vcMkvjjwTfCNAj5nvkkdaPf2o5BGd48q1JUsNXYti23PGq + KyVa2ftn1fQ0d6KXW8TKeJXzy84u/Ajo715oYCUthcUsE7jqMLOqwiTJ34PxcWoxNVJW + 9iibxLSfPFX8n7Uo4lorGK2t5W0V5ISLDge4HwayEgPnXHfltT1oiDTLbKYMO20EqFIJ + UNvg== +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=h/6jiv7ipi+ShuQNmMvVeMMXx/sAp8QZYhKKkDxCkIY=; + b=WCHvI6B/qYz9t/z5ZIlzTEFzIpiiBzcuNVY7pORYMn/VNC8DoCBdwB6+UrIauJkGDb + DoNg8fPheA9f6TqlKF8uMFaQpxnMkUv5U2eVN/D/KWC1TEAkSkDdkauM1KBhqbzMKGp7 + UXgy5k3FwCJON+UnluwpVc5DMuN/2FHukMhGJvOwmX/bFHYHLun/sjF0EPiiyrBgVLUp + dwViYx+GzFeKWnFgYMzXcDNKPRHCqYhDz/rhzQmuSEBgmGWRB/gwMDza5M8bGTN4YV9v + bHIpBlxIkT5MRMuNj7tiWVRxxNcWzm+SdLCJSCLE2TdK6SBPSa4wndiNkSv6AAnGLtMQ + 6u9A== +X-Gm-Message-State: + AOPr4FUHGXnGM2FrnB3ZLylADmqRsl2HmPIyBLy2/FybLavgSVwGX1N+sZT23LC46MGfsQ== +X-Received: by 10.194.166.3 with SMTP id zc3mr16877941wjb.104.1463153345262; + Fri, 13 May 2016 08:29:05 -0700 (PDT) +Received: from localhost (5751dfa2.skybroadband.com. [87.81.223.162]) + by smtp.gmail.com with ESMTPSA id xt9sm19126330wjb.17.2016.05.13.08.29.04 + (version=TLS1_2 cipher=ECDHE-RSA-AES128-GCM-SHA256 bits=128/128); + Fri, 13 May 2016 08:29:04 -0700 (PDT) +From: Mark Walters +To: notmuch@notmuchmail.org +Subject: [PATCH v2] emacs: address completion, + allow sender/recipient and filters +Date: Fri, 13 May 2016 16:28:57 +0100 +Message-Id: <1463153337-11381-1-git-send-email-markwalters1009@gmail.com> +X-Mailer: git-send-email 2.1.4 +In-Reply-To: <874mf2yeq7.fsf@steelpick.2x.cz> +References: <874mf2yeq7.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: Fri, 13 May 2016 15:29:16 -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. +--- + +I have fixed the bug pointed out by Michal in his review. It seems to +work, but there are a lot of possible configurations, + +I also don't like my docstring for the notmuch-address-command +defcustom, so any suggestions gratefully received. + +Also, I am not sure whether this is all to much complexity for this +feature. + +Best wishes + +Mark + + + emacs/notmuch-address.el | 104 +++++++++++++++++++++++++++++++---------------- + emacs/notmuch-company.el | 2 +- + 2 files changed, 71 insertions(+), 35 deletions(-) + +diff --git a/emacs/notmuch-address.el b/emacs/notmuch-address.el +index aafbe5f..8b84a4c 100644 +--- a/emacs/notmuch-address.el ++++ b/emacs/notmuch-address.el +@@ -28,15 +28,50 @@ + ;; + (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) ++ "The command which generates possible addresses. ++ ++It can be a (non-nil) list, in which case internal completion is ++used; in this case the first list item 'sent/'received specifies ++whether you match message sent by the user or received by the ++user (note received by is much faster), and the second list item ++should be nil or a filter-string, such as \"date:1y..\" to append ++to the query. ++ ++If this variable is nil then address completion is disabled. ++ ++If it is a string then that string should be an external program ++which must take a single argument and output a list of possible ++matches, one per line." + :type '(radio +- (const :tag "Use internal address completion" internal) ++ (list :tag "Use internal address completion" ++ (radio ++ :tag "Build list based 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 +86,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 +107,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 +136,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,21 +216,32 @@ external commands." + + The car is a partial harvest, and the cdr is a full harvest") + +-(defun notmuch-address-harvest (&optional filter-query synchronous callback) ++(defun notmuch-address-harvest (&optional filter-string 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)) ++notmuch database for messages sent/received by the user ++optionally with to/from matching FILTER-STRING (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* ((sent (eq (car notmuch-address-command) 'sent)) ++ (user-query (cadr notmuch-address-command)) ++ (filter-query (when filter-string ++ (format "%s:%s*" (if sent "to" "from") filter-string))) ++ (from-or-to-me-query ++ (mapconcat (lambda (x) ++ (concat (if sent "from:" "to:") x)) ++ (notmuch-user-emails) " or ")) ++ (query (if (or filter-query user-query) ++ (concat (format "(%s)" from-or-to-me-query) ++ (when filter-query ++ (format " and (%s)" filter-query)) ++ (when user-query ++ (format " and (%s)" user-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 +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 +