]> git.cworth.org Git - notmuch/blobdiff - emacs/notmuch-crypto.el
emacs: Asynchronous retrieval of GPG keys
[notmuch] / emacs / notmuch-crypto.el
index 0af727ef4dc68258b039691e0e85d58e95f48a72..0ab85f4bde8da9d962392e963a901508fff63efa 100644 (file)
@@ -24,7 +24,7 @@
 (require 'epg)
 (require 'notmuch-lib)
 
-(defcustom notmuch-crypto-process-mime nil
+(defcustom notmuch-crypto-process-mime t
   "Should cryptographic MIME parts be processed?
 
 If this variable is non-nil signatures in multipart/signed
@@ -39,6 +39,12 @@ The effect of setting this variable can be seen temporarily by
 providing a prefix when viewing a signed or encrypted message, or
 by providing a prefix when reloading the message in notmuch-show
 mode."
+  :type 'boolean
+  :package-version '(notmuch . "0.25")
+  :group 'notmuch-crypto)
+
+(defcustom notmuch-crypto-get-keys-asynchronously t
+  "Retrieve gpg keys asynchronously."
   :type 'boolean
   :group 'notmuch-crypto)
 
@@ -92,7 +98,8 @@ mode."
 (defun notmuch-crypto-insert-sigstatus-button (sigstatus from)
   (let* ((status (plist-get sigstatus :status))
         (help-msg nil)
-        (label "Signature not processed")
+        (show-button t)
+        (label nil)
         (face 'notmuch-crypto-signature-unknown)
         (button-action (lambda (button) (message (button-get button 'help-echo)))))
     (cond
@@ -112,24 +119,26 @@ mode."
       (let ((keyid (concat "0x" (plist-get sigstatus :keyid))))
        (setq label (concat "Unknown key ID " keyid " or unsupported algorithm"))
        (setq button-action 'notmuch-crypto-sigstatus-error-callback)
-       (setq help-msg (concat "Click to retrieve key ID " keyid " from keyserver and redisplay."))))
+       (setq help-msg (concat "Click to retrieve key ID " keyid " from keyserver."))))
      ((string= status "bad")
       (let ((keyid (concat "0x" (plist-get sigstatus :keyid))))
        (setq label (concat "Bad signature (claimed key ID " keyid ")"))
        (setq face 'notmuch-crypto-signature-bad)))
+     (status
+      (setq label (concat "Unknown signature status: " status)))
      (t
-      (setq label (concat "Unknown signature status"
-                         (if status (concat ": " status))))))
-    (insert-button
-     (concat "[ " label " ]")
-     :type 'notmuch-crypto-status-button-type
-     'help-echo help-msg
-     'face face
-     'mouse-face face
-     'action button-action
-     :notmuch-sigstatus sigstatus
-     :notmuch-from from)
-    (insert "\n")))
+      (setq show-button nil)))
+    (when show-button
+      (insert-button
+       (concat "[ " label " ]")
+       :type 'notmuch-crypto-status-button-type
+       'help-echo help-msg
+       'face face
+       'mouse-face face
+       'action button-action
+       :notmuch-sigstatus sigstatus
+       :notmuch-from from)
+      (insert "\n"))))
 
 (declare-function notmuch-show-refresh-view "notmuch-show" (&optional reset-state))
 
@@ -141,22 +150,80 @@ mode."
     (with-selected-window window
       (with-current-buffer buffer
        (goto-char (point-max))
-       (call-process epg-gpg-program nil t t "--list-keys" fingerprint))
+       (call-process epg-gpg-program nil t t "--batch" "--no-tty" "--list-keys" fingerprint))
       (recenter -1))))
 
+(defun notmuch-crypto--async-key-sentinel (process event)
+  "When the user asks for a GPG key to be retrieved
+asynchronously, handle completion of that task.
+
+If the retrieval is successful, the thread where the retrieval
+was initiated is still displayed and the cursor has not moved,
+redisplay the thread."
+  (let ((status (process-status process))
+       (exit-status (process-exit-status process))
+       (keyid (process-get process :gpg-key-id)))
+    (when (memq status '(exit signal))
+      (message "Getting the GPG key %s asynchronously...%s."
+              keyid
+              (if (= exit-status 0)
+                  "completed"
+                "failed"))
+      ;; If the original buffer is still alive and point didn't move
+      ;; (i.e. the user didn't move on or away), refresh the buffer to
+      ;; show the updated signature status.
+      (let ((show-buffer (process-get process :notmuch-show-buffer))
+           (show-point (process-get process :notmuch-show-point)))
+       (when (and (bufferp show-buffer)
+                  (buffer-live-p show-buffer)
+                  (= show-point
+                     (with-current-buffer show-buffer
+                       (point))))
+         (with-current-buffer show-buffer
+           (notmuch-show-refresh-view)))))))
+
+(defun notmuch-crypto--set-button-label (button label)
+  "Set the text displayed in BUTTON to LABEL."
+  (save-excursion
+    (let ((inhibit-read-only t))
+      ;; This knows rather too much about how we typically format
+      ;; buttons.
+      (goto-char (button-start button))
+      (forward-char 2)
+      (delete-region (point) (- (button-end button) 2))
+      (insert label))))
+
 (defun notmuch-crypto-sigstatus-error-callback (button)
   (let* ((sigstatus (button-get button :notmuch-sigstatus))
         (keyid (concat "0x" (plist-get sigstatus :keyid)))
-        (buffer (get-buffer-create "*notmuch-crypto-gpg-out*"))
-        (window (display-buffer buffer t nil)))
-    (with-selected-window window
-      (with-current-buffer buffer
-       (goto-char (point-max))
-       (call-process epg-gpg-program nil t t "--recv-keys" keyid)
-       (insert "\n")
-       (call-process epg-gpg-program nil t t "--list-keys" keyid))
-      (recenter -1))
-    (notmuch-show-refresh-view)))
+        (buffer (get-buffer-create "*notmuch-crypto-gpg-out*")))
+    (if notmuch-crypto-get-keys-asynchronously
+       (progn
+         (notmuch-crypto--set-button-label
+          button (format "Retrieving key %s asynchronously..." keyid))
+         (let ((p (make-process :name "notmuch GPG key retrieval"
+                                :buffer buffer
+                                :command (list epg-gpg-program "--recv-keys" keyid)
+                                :connection-type 'pipe
+                                :sentinel #'notmuch-crypto--async-key-sentinel
+                                ;; Create the process stopped so that
+                                ;; we have time to store the key id,
+                                ;; etc. on it.
+                                :stop t)))
+           (process-put p :gpg-key-id keyid)
+           (process-put p :notmuch-show-buffer (current-buffer))
+           (process-put p :notmuch-show-point (point))
+           (message "Getting the GPG key %s asynchronously..." keyid)
+           (continue-process p)))
+      (let ((window (display-buffer buffer t nil)))
+       (with-selected-window window
+         (with-current-buffer buffer
+           (goto-char (point-max))
+           (call-process epg-gpg-program nil t t "--recv-keys" keyid)
+           (insert "\n")
+           (call-process epg-gpg-program nil t t "--list-keys" keyid))
+         (recenter -1))
+       (notmuch-show-refresh-view)))))
 
 (defun notmuch-crypto-insert-encstatus-button (encstatus)
   (let* ((status (plist-get encstatus :status))