1 ;;; notmuch-address.el --- address completion with notmuch -*- lexical-binding: t -*-
3 ;; Copyright © David Edmondson
5 ;; This file is part of Notmuch.
7 ;; Notmuch is free software: you can redistribute it and/or modify it
8 ;; under the terms of the GNU General Public License as published by
9 ;; the Free Software Foundation, either version 3 of the License, or
10 ;; (at your option) any later version.
12 ;; Notmuch is distributed in the hope that it will be useful, but
13 ;; WITHOUT ANY WARRANTY; without even the implied warranty of
14 ;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
15 ;; General Public License for more details.
17 ;; You should have received a copy of the GNU General Public License
18 ;; along with Notmuch. If not, see <https://www.gnu.org/licenses/>.
20 ;; Authors: David Edmondson <dme@dme.org>
25 (require 'notmuch-parser)
26 (require 'notmuch-lib)
27 (require 'notmuch-company)
29 (declare-function company-manual-begin "company")
33 (defvar notmuch-address-last-harvest 0
34 "Time of last address harvest.")
36 (defvar notmuch-address-completions (make-hash-table :test 'equal)
37 "Hash of email addresses for completion during email composition.
38 This variable is set by calling `notmuch-address-harvest'.")
40 (defvar notmuch-address-full-harvest-finished nil
41 "Whether full completion address harvesting has finished.
42 Use `notmuch-address--harvest-ready' to access as that will load
43 a saved hash if necessary (and available).")
45 (defun notmuch-address--harvest-ready ()
46 "Return t if there is a full address hash available.
48 If the hash is not present it attempts to load a saved hash."
49 (or notmuch-address-full-harvest-finished
50 (notmuch-address--load-address-hash)))
54 (defcustom notmuch-address-command 'internal
55 "Determines how address completion candidates are generated.
57 If this is a string, then that string should be an external
58 program, which must take a single argument (searched string)
59 and output a list of completion candidates, one per line.
61 If this is the symbol `internal', then an implementation is used
62 that relies on the \"notmuch address\" command, but does not use
63 any third-party (i.e. \"external\") programs.
65 If this is the symbol `as-is', then Notmuch does not modify the
66 value of `message-completion-alist'. This option has to be set to
67 this value before `notmuch' is loaded, otherwise the modification
68 to `message-completion-alist' may already have taken place. This
69 setting obviously does not prevent `message-completion-alist'
70 from being modified at all; the user or some third-party package
73 Finally, if this is nil, then address completion is disabled."
75 (const :tag "Use internal address completion" internal)
76 (string :tag "Use external completion command")
77 (const :tag "Disable address completion" nil)
78 (const :tag "Use default or third-party mechanism" as-is))
80 :group 'notmuch-address
81 :group 'notmuch-external)
83 (defcustom notmuch-address-internal-completion '(sent nil)
84 "Determines how internal address completion generates candidates.
86 This should be a list of the form (DIRECTION FILTER), where
87 DIRECTION is either sent or received and specifies whether the
88 candidates are searched in messages sent by the user or received
89 by the user (note received by is much faster), and FILTER is
90 either nil or a filter-string, such as \"date:1y..\" to append to
92 :type '(list :tag "Use internal address completion"
94 :tag "Base completion on messages you have"
96 (const :tag "sent (more accurate)" sent)
97 (const :tag "received (faster)" received))
98 (radio :tag "Filter messages used for completion"
99 (const :tag "Use all messages" nil)
100 (string :tag "Filter query")))
101 ;; We override set so that we can clear the cache when this changes
102 :set (lambda (symbol value)
103 (set-default symbol value)
104 (setq notmuch-address-last-harvest 0)
105 (setq notmuch-address-completions (clrhash notmuch-address-completions))
106 (setq notmuch-address-full-harvest-finished nil))
108 :group 'notmuch-address
109 :group 'notmuch-external)
111 (defcustom notmuch-address-save-filename nil
112 "Filename to save the cached completion addresses.
114 All the addresses notmuch uses for address completion will be
115 cached in this file. This has obvious privacy implications so
116 you should make sure it is not somewhere publicly readable."
117 :type '(choice (const :tag "Off" nil)
118 (file :tag "Filename"))
120 :group 'notmuch-address
121 :group 'notmuch-external)
123 (defcustom notmuch-address-selection-function 'notmuch-address-selection-function
124 "The function to select address from given list.
126 The function is called with PROMPT, COLLECTION, and INITIAL-INPUT
127 as arguments (subset of what `completing-read' can be called
128 with). While executed the value of `completion-ignore-case'
129 is t. See documentation of function
130 `notmuch-address-selection-function' to know how address
131 selection is made by default."
134 :group 'notmuch-address
135 :group 'notmuch-external)
137 (defcustom notmuch-address-post-completion-functions nil
138 "Functions called after completing address.
140 The completed address is passed as an argument to each function.
141 Note that this hook will be invoked for completion in headers
142 matching `notmuch-address-completion-headers-regexp'."
144 :group 'notmuch-address
145 :group 'notmuch-hooks)
147 (defcustom notmuch-address-use-company t
148 "If available, use company mode for address completion."
151 :group 'notmuch-address)
155 (defun notmuch-address-selection-function (prompt collection initial-input)
156 "Call (`completing-read'
157 PROMPT COLLECTION nil nil INITIAL-INPUT 'notmuch-address-history)"
159 prompt collection nil nil initial-input 'notmuch-address-history))
161 (defvar notmuch-address-completion-headers-regexp
162 "^\\(Resent-\\)?\\(To\\|B?Cc\\|Reply-To\\|From\\|Mail-Followup-To\\|Mail-Copies-To\\):")
164 (defvar notmuch-address-history nil)
166 (defun notmuch-address-message-insinuate ()
167 (message "calling notmuch-address-message-insinuate is no longer needed"))
169 (defun notmuch-address-setup ()
170 (unless (eq notmuch-address-command 'as-is)
171 (when (and notmuch-address-use-company
172 (require 'company nil t))
173 (notmuch-company-setup))
174 (cl-pushnew (cons notmuch-address-completion-headers-regexp
175 #'notmuch-address-expand-name)
176 message-completion-alist :test #'equal)))
178 (defun notmuch-address-toggle-internal-completion ()
179 "Toggle use of internal completion for current buffer.
181 This overrides the global setting for address completion and
182 toggles the setting in this buffer."
184 (if (local-variable-p 'notmuch-address-command)
185 (kill-local-variable 'notmuch-address-command)
186 (setq-local notmuch-address-command 'internal))
187 (when (boundp 'company-idle-delay)
188 (if (local-variable-p 'company-idle-delay)
189 (kill-local-variable 'company-idle-delay)
190 (setq-local company-idle-delay nil))))
194 (defun notmuch-address-matching (substring)
195 "Returns a list of completion candidates matching SUBSTRING.
196 The candidates are taken from `notmuch-address-completions'."
198 (re (regexp-quote substring)))
199 (maphash (lambda (key _val)
200 (when (string-match re key)
201 (push key candidates)))
202 notmuch-address-completions)
205 (defun notmuch-address-options (original)
206 "Return a list of completion candidates.
207 Use either elisp-based implementation or older implementation
208 requiring external commands."
210 ((eq notmuch-address-command 'internal)
211 (unless (notmuch-address--harvest-ready)
212 ;; First, run quick synchronous harvest based on what the user
214 (notmuch-address-harvest original t))
215 (prog1 (notmuch-address-matching original)
216 ;; Then start the (potentially long-running) full asynchronous
217 ;; harvest if necessary.
218 (notmuch-address-harvest-trigger)))
220 (notmuch--process-lines notmuch-address-command original))))
222 (defun notmuch-address-expand-name ()
224 ((and (eq notmuch-address-command 'internal)
225 notmuch-address-use-company
226 (bound-and-true-p company-mode))
227 (company-manual-begin))
228 (notmuch-address-command
231 (re-search-backward "\\(\\`\\|[\n:,]\\)[ \t]*")
232 (goto-char (match-end 0))
234 (orig (buffer-substring-no-properties beg end))
235 (completion-ignore-case t)
236 (options (with-temp-message "Looking for completion candidates..."
237 (notmuch-address-options orig)))
238 (num-options (length options))
245 (funcall notmuch-address-selection-function
246 (format "Address (%s matches): " num-options)
251 (push chosen notmuch-address-history)
252 (delete-region beg end)
254 (run-hook-with-args 'notmuch-address-post-completion-functions
256 (message "No matches.")
262 (defun notmuch-address-harvest-addr (result)
263 (puthash (plist-get result :name-addr)
264 t notmuch-address-completions))
266 (defun notmuch-address-harvest-filter (proc string)
267 (when (buffer-live-p (process-buffer proc))
268 (with-current-buffer (process-buffer proc)
270 (goto-char (point-max))
272 (notmuch-sexp-parse-partial-list
273 'notmuch-address-harvest-addr (process-buffer proc)))))
275 (defvar notmuch-address-harvest-procs '(nil . nil)
276 "The currently running harvests.
278 The car is a partial harvest, and the cdr is a full harvest.")
280 (defun notmuch-address-harvest (&optional addr-prefix synchronous callback)
281 "Collect addresses completion candidates.
283 It queries the notmuch database for messages sent/received (as
284 configured with `notmuch-address-command') by the user, collects
285 destination/source addresses from those messages and stores them
286 in `notmuch-address-completions'.
288 If ADDR-PREFIX is not nil, only messages with to/from addresses
289 matching ADDR-PREFIX*' are queried.
291 Address harvesting may take some time so the address collection runs
292 asynchronously unless SYNCHRONOUS is t. In case of asynchronous
293 execution, CALLBACK is called when harvesting finishes."
294 (let* ((sent (eq (car notmuch-address-internal-completion) 'sent))
295 (config-query (cadr notmuch-address-internal-completion))
296 (prefix-query (and addr-prefix
298 (if sent "to" "from")
301 (mapconcat (lambda (x)
302 (concat (if sent "from:" "to:") x))
303 (notmuch-user-emails) " or "))
304 (query (if (or prefix-query config-query)
305 (concat (format "(%s)" from-or-to-me-query)
307 (format " and (%s)" prefix-query))
309 (format " and (%s)" config-query)))
310 from-or-to-me-query))
311 (args `("address" "--format=sexp" "--format-version=5"
312 ,(if sent "--output=recipients" "--output=sender")
313 "--deduplicate=address"
316 (mapc #'notmuch-address-harvest-addr
317 (apply 'notmuch-call-notmuch-sexp args))
319 (let* ((current-proc (if addr-prefix
320 (car notmuch-address-harvest-procs)
321 (cdr notmuch-address-harvest-procs)))
322 (proc-name (format "notmuch-address-%s-harvest"
323 (if addr-prefix "partial" "full")))
324 (proc-buf (concat " *" proc-name "*")))
325 ;; Kill any existing process
327 (kill-buffer (process-buffer current-proc))) ; this also kills the process
329 (apply 'notmuch-start-notmuch proc-name proc-buf
330 callback ; process sentinel
332 (set-process-filter current-proc 'notmuch-address-harvest-filter)
333 (set-process-query-on-exit-flag current-proc nil)
335 (setcar notmuch-address-harvest-procs current-proc)
336 (setcdr notmuch-address-harvest-procs current-proc)))))
340 (defvar notmuch-address--save-hash-version 1
341 "Version format of the save hash.")
343 (defun notmuch-address--get-address-hash ()
344 "Return the saved address hash as a plist.
346 Returns nil if the save file does not exist, or it does not seem
347 to be a saved address hash."
348 (and notmuch-address-save-filename
351 (insert-file-contents notmuch-address-save-filename)
352 (let ((name (read (current-buffer)))
353 (plist (read (current-buffer))))
354 ;; We do two simple sanity checks on the loaded file.
355 ;; We just check a version is specified, not that
356 ;; it is the current version, as we are allowed to
357 ;; over-write and a save-file with an older version.
358 (and (string= name "notmuch-address-hash")
359 (plist-get plist :version)
361 ;; The error case catches any of the reads failing.
364 (defun notmuch-address--load-address-hash ()
365 "Read the saved address hash and set the corresponding variables."
366 (let ((load-plist (notmuch-address--get-address-hash)))
367 (when (and load-plist
368 ;; If the user's setting have changed, or the version
369 ;; has changed, return nil to make sure the new settings
371 (equal (plist-get load-plist :completion-settings)
372 notmuch-address-internal-completion)
373 (equal (plist-get load-plist :version)
374 notmuch-address--save-hash-version))
375 (setq notmuch-address-last-harvest (plist-get load-plist :last-harvest))
376 (setq notmuch-address-completions (plist-get load-plist :completions))
377 (setq notmuch-address-full-harvest-finished t)
378 ;; Return t to say load was successful.
381 (defun notmuch-address--save-address-hash ()
382 (when notmuch-address-save-filename
383 (if (or (not (file-exists-p notmuch-address-save-filename))
384 ;; The file exists, check it is a file we saved.
385 (notmuch-address--get-address-hash))
386 (with-temp-file notmuch-address-save-filename
388 (list :version notmuch-address--save-hash-version
389 :completion-settings notmuch-address-internal-completion
390 :last-harvest notmuch-address-last-harvest
391 :completions notmuch-address-completions)))
392 (print "notmuch-address-hash" (current-buffer))
393 (print save-plist (current-buffer))))
395 Warning: notmuch-address-save-filename %s exists but doesn't
396 appear to be an address savefile. Not overwriting."
397 notmuch-address-save-filename))))
399 (defun notmuch-address-harvest-trigger ()
400 (let ((now (float-time)))
401 (when (> (- now notmuch-address-last-harvest) 86400)
402 (setq notmuch-address-last-harvest now)
403 (notmuch-address-harvest
405 (lambda (_proc event)
406 ;; If harvest fails, we want to try
407 ;; again when the trigger is next called.
408 (if (string= event "finished\n")
410 (notmuch-address--save-address-hash)
411 (setq notmuch-address-full-harvest-finished t))
412 (setq notmuch-address-last-harvest 0)))))))
414 ;;; Standalone completion
416 (defun notmuch-address-from-minibuffer (prompt)
417 (if (not notmuch-address-command)
419 (let ((rmap (copy-keymap minibuffer-local-map))
420 (omap minibuffer-local-map))
421 ;; Configure TAB to start completion when executing read-string.
422 ;; "Original" minibuffer keymap is restored just before calling
423 ;; notmuch-address-expand-name as it may also use minibuffer-local-map
424 ;; (completing-read probably does not but if something else is used there).
425 (define-key rmap (kbd "TAB") (lambda ()
427 (let ((enable-recursive-minibuffers t)
428 (minibuffer-local-map omap))
429 (notmuch-address-expand-name))))
430 (let ((minibuffer-local-map rmap))
431 (read-string prompt)))))
435 (provide 'notmuch-address)
437 ;;; notmuch-address.el ends here