;; Authors: David Edmondson <dme@dme.org>
(require 'message)
+(require 'notmuch-query)
+(require 'notmuch-parser)
;;
-(defcustom notmuch-address-command "notmuch-addresses"
- "The command which generates possible addresses. It must take a
-single argument and output a list of possible matches, one per
-line."
- :type 'string
+(defcustom notmuch-address-command nil
+ "The command which generates possible addresses for completion.
+It must take a single argument and output a list of possible
+matches, one per line. If set to nil, addresses are generated by
+a built-in completion mechanism."
+ :type '(radio (const :tag "No command: Use built-in completion" nil)
+ (string :tag "Custom command" :value "notmuch-addresses"))
:group 'notmuch-send
:group 'notmuch-external)
+(defcustom notmuch-address-selection-function 'notmuch-address-selection-function
+ "The function to select address from given list. The function is
+called with PROMPT, COLLECTION, and INITIAL-INPUT as arguments
+(subset of what `completing-read' can be called with).
+While executed the value of `completion-ignore-case' is t.
+See documentation of function `notmuch-address-selection-function'
+to know how address selection is made by default."
+ :type 'function
+ :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)"
+ (completing-read
+ prompt collection nil nil initial-input 'notmuch-address-history))
+
(defvar notmuch-address-message-alist-member
'("^\\(Resent-\\)?\\(To\\|B?Cc\\|Reply-To\\|From\\|Mail-Followup-To\\|Mail-Copies-To\\):"
. notmuch-address-expand-name))
(defvar notmuch-address-history nil)
(defun notmuch-address-message-insinuate ()
- (if (not (memq notmuch-address-message-alist-member message-completion-alist))
- (setq message-completion-alist
- (push notmuch-address-message-alist-member message-completion-alist))))
+ (unless (memq notmuch-address-message-alist-member message-completion-alist)
+ (setq message-completion-alist
+ (push notmuch-address-message-alist-member message-completion-alist))))
+
+(defun notmuch-address-matching (substring)
+ "Returns a list of completion candidates matching SUBSTRING.
+The candidates are taked form `notmuch-address-completions'."
+ (let ((candidates)
+ (re (regexp-quote substring)))
+ (maphash (lambda (key val)
+ (when (string-match re key)
+ (push key candidates)))
+ notmuch-address-completions)
+ candidates))
(defun notmuch-address-options (original)
- (process-lines notmuch-address-command original))
+ "Returns a list of completion candidates. Uses either
+elisp-based implementation or older implementation requiring
+external commands."
+ (cond
+ ((null 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))
+ (prog1 (notmuch-address-matching original)
+ ;; Then (re)start potentially long-running full asynchronous harvesting
+ (notmuch-address-harvest-trigger)))
+ (t
+ (process-lines notmuch-address-command original))))
(defun notmuch-address-expand-name ()
(let* ((end (point))
(point)))
(orig (buffer-substring-no-properties beg end))
(completion-ignore-case t)
- (options (notmuch-address-options orig))
+ (options (with-temp-message "Looking for completion candidates..."
+ (notmuch-address-options orig)))
(num-options (length options))
(chosen (cond
((eq num-options 0)
((eq num-options 1)
(car options))
(t
- (completing-read (format "Address (%s matches): " num-options)
- (cdr options) nil nil (car options)
- 'notmuch-address-history)))))
+ (funcall notmuch-address-selection-function
+ (format "Address (%s matches): " num-options)
+ (cdr options) (car options))))))
(if chosen
(progn
(push chosen notmuch-address-history)
(not (file-directory-p bin))))
(throw 'found-command bin))))))))
+(defun notmuch-address-harvest-msg (msg)
+ (let* ((headers (plist-get msg :headers))
+ (to (ignore-errors (mail-extract-address-components (plist-get headers :To) t)))
+ (cc (ignore-errors (mail-extract-address-components (plist-get headers :Cc) t)))
+ (bcc (ignore-errors (mail-extract-address-components (plist-get headers :Bcc) t))))
+ (mapc (lambda (parts)
+ (let* ((name (car parts))
+ (email (cadr parts))
+ (entry (if name (format "%s <%s>" name email) email)))
+ (puthash entry t notmuch-address-completions)))
+ (append to cc bcc))
+ nil))
+
+(defun notmuch-address-harvest-handle-result (obj)
+ (notmuch-query-map-threads 'notmuch-address-harvest-msg (list obj)))
+
+(defun notmuch-address-harvest-filter (proc string)
+ (when (buffer-live-p (process-buffer proc))
+ (with-current-buffer (process-buffer proc)
+ (save-excursion
+ (goto-char (point-max))
+ (insert string))
+ (notmuch-sexp-parse-partial-list
+ 'notmuch-address-harvest-handle-result (process-buffer proc)))))
+
+(defvar notmuch-address-harvest-proc nil) ; the process of a harvest underway
+
+(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))
+ (args `("show" "--format=sexp" "--format-version=2"
+ "--body=false" "--entire-thread=false" ,query)))
+ (if synchronous
+ (notmuch-query-map-threads 'notmuch-address-harvest-msg
+ (apply 'notmuch-call-notmuch-sexp args))
+ ;; Asynchronous
+ (when notmuch-address-harvest-proc
+ (kill-buffer (process-buffer notmuch-address-harvest-proc))) ; this also kills the process
+ (setq notmuch-address-harvest-proc
+ (apply 'notmuch-start-notmuch
+ "notmuch-address-harvest" ; process name
+ " *notmuch-address-harvest*" ; process buffer
+ callback ; process sentinel
+ args))
+ (set-process-filter notmuch-address-harvest-proc 'notmuch-address-harvest-filter)
+ (set-process-query-on-exit-flag notmuch-address-harvest-proc nil)))
+ ;; return value
+ nil)
+
;; If we can find the program specified by `notmuch-address-command',
-;; insinuate ourselves into `message-mode'.
-(when (notmuch-address-locate-command notmuch-address-command)
+;; or if it is nil, insinuate ourselves into `message-mode'.
+(when (or (null notmuch-address-command)
+ (notmuch-address-locate-command notmuch-address-command))
(notmuch-address-message-insinuate))
+(defun notmuch-address-harvest-trigger ()
+ (let ((now (float-time)))
+ (when (> (- now notmuch-address-last-harvest) 86400)
+ (setq notmuch-address-last-harvest now)
+ (notmuch-address-harvest nil nil
+ (lambda (proc event)
+ (setq notmuch-address-full-harvest-finished t))))))
+
;;
(provide 'notmuch-address)