]> git.cworth.org Git - obsolete/notmuch-old/blob - emacs/notmuch-show.el
emacs: show: move the insertion of the header button to the top level
[obsolete/notmuch-old] / emacs / notmuch-show.el
1 ;; notmuch-show.el --- displaying notmuch forests.
2 ;;
3 ;; Copyright © Carl Worth
4 ;; Copyright © David Edmondson
5 ;;
6 ;; This file is part of Notmuch.
7 ;;
8 ;; Notmuch is free software: you can redistribute it and/or modify it
9 ;; under the terms of the GNU General Public License as published by
10 ;; the Free Software Foundation, either version 3 of the License, or
11 ;; (at your option) any later version.
12 ;;
13 ;; Notmuch is distributed in the hope that it will be useful, but
14 ;; WITHOUT ANY WARRANTY; without even the implied warranty of
15 ;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
16 ;; General Public License for more details.
17 ;;
18 ;; You should have received a copy of the GNU General Public License
19 ;; along with Notmuch.  If not, see <http://www.gnu.org/licenses/>.
20 ;;
21 ;; Authors: Carl Worth <cworth@cworth.org>
22 ;;          David Edmondson <dme@dme.org>
23
24 (eval-when-compile (require 'cl))
25 (require 'mm-view)
26 (require 'message)
27 (require 'mm-decode)
28 (require 'mailcap)
29 (require 'icalendar)
30 (require 'goto-addr)
31
32 (require 'notmuch-lib)
33 (require 'notmuch-tag)
34 (require 'notmuch-query)
35 (require 'notmuch-wash)
36 (require 'notmuch-mua)
37 (require 'notmuch-crypto)
38 (require 'notmuch-print)
39
40 (declare-function notmuch-call-notmuch-process "notmuch" (&rest args))
41 (declare-function notmuch-search-next-thread "notmuch" nil)
42 (declare-function notmuch-search-previous-thread "notmuch" nil)
43 (declare-function notmuch-search-show-thread "notmuch" nil)
44
45 (defcustom notmuch-message-headers '("Subject" "To" "Cc" "Date")
46   "Headers that should be shown in a message, in this order.
47
48 For an open message, all of these headers will be made visible
49 according to `notmuch-message-headers-visible' or can be toggled
50 with `notmuch-show-toggle-visibility-headers'. For a closed message,
51 only the first header in the list will be visible."
52   :type '(repeat string)
53   :group 'notmuch-show)
54
55 (defcustom notmuch-message-headers-visible t
56   "Should the headers be visible by default?
57
58 If this value is non-nil, then all of the headers defined in
59 `notmuch-message-headers' will be visible by default in the display
60 of each message. Otherwise, these headers will be hidden and
61 `notmuch-show-toggle-visibility-headers' can be used to make them
62 visible for any given message."
63   :type 'boolean
64   :group 'notmuch-show)
65
66 (defcustom notmuch-show-relative-dates t
67   "Display relative dates in the message summary line."
68   :type 'boolean
69   :group 'notmuch-show)
70
71 (defvar notmuch-show-markup-headers-hook '(notmuch-show-colour-headers)
72   "A list of functions called to decorate the headers listed in
73 `notmuch-message-headers'.")
74
75 (defcustom notmuch-show-hook '(notmuch-show-turn-on-visual-line-mode)
76   "Functions called after populating a `notmuch-show' buffer."
77   :type 'hook
78   :options '(notmuch-show-turn-on-visual-line-mode)
79   :group 'notmuch-show
80   :group 'notmuch-hooks)
81
82 (defcustom notmuch-show-insert-text/plain-hook '(notmuch-wash-wrap-long-lines
83                                                  notmuch-wash-tidy-citations
84                                                  notmuch-wash-elide-blank-lines
85                                                  notmuch-wash-excerpt-citations)
86   "Functions used to improve the display of text/plain parts."
87   :type 'hook
88   :options '(notmuch-wash-convert-inline-patch-to-part
89              notmuch-wash-wrap-long-lines
90              notmuch-wash-tidy-citations
91              notmuch-wash-elide-blank-lines
92              notmuch-wash-excerpt-citations)
93   :group 'notmuch-show
94   :group 'notmuch-hooks)
95
96 ;; Mostly useful for debugging.
97 (defcustom notmuch-show-all-multipart/alternative-parts nil
98   "Should all parts of multipart/alternative parts be shown?"
99   :type 'boolean
100   :group 'notmuch-show)
101
102 (defcustom notmuch-show-indent-messages-width 1
103   "Width of message indentation in threads.
104
105 Messages are shown indented according to their depth in a thread.
106 This variable determines the width of this indentation measured
107 in number of blanks.  Defaults to `1', choose `0' to disable
108 indentation."
109   :type 'integer
110   :group 'notmuch-show)
111
112 (defcustom notmuch-show-indent-multipart nil
113   "Should the sub-parts of a multipart/* part be indented?"
114   ;; dme: Not sure which is a good default.
115   :type 'boolean
116   :group 'notmuch-show)
117
118 (defcustom notmuch-show-part-button-default-action 'notmuch-show-save-part
119   "Default part header button action (on ENTER or mouse click)."
120   :group 'notmuch-show
121   :type '(choice (const :tag "Save part"
122                         notmuch-show-save-part)
123                  (const :tag "View part"
124                         notmuch-show-view-part)
125                  (const :tag "View interactively"
126                         notmuch-show-interactively-view-part)))
127
128 (defcustom notmuch-show-only-matching-messages nil
129   "Only matching messages are shown by default."
130   :type 'boolean
131   :group 'notmuch-show)
132
133 (defvar notmuch-show-thread-id nil)
134 (make-variable-buffer-local 'notmuch-show-thread-id)
135 (put 'notmuch-show-thread-id 'permanent-local t)
136
137 (defvar notmuch-show-parent-buffer nil)
138 (make-variable-buffer-local 'notmuch-show-parent-buffer)
139 (put 'notmuch-show-parent-buffer 'permanent-local t)
140
141 (defvar notmuch-show-query-context nil)
142 (make-variable-buffer-local 'notmuch-show-query-context)
143 (put 'notmuch-show-query-context 'permanent-local t)
144
145 (defvar notmuch-show-process-crypto nil)
146 (make-variable-buffer-local 'notmuch-show-process-crypto)
147 (put 'notmuch-show-process-crypto 'permanent-local t)
148
149 (defvar notmuch-show-elide-non-matching-messages nil)
150 (make-variable-buffer-local 'notmuch-show-elide-non-matching-messages)
151 (put 'notmuch-show-elide-non-matching-messages 'permanent-local t)
152
153 (defvar notmuch-show-indent-content t)
154 (make-variable-buffer-local 'notmuch-show-indent-content)
155 (put 'notmuch-show-indent-content 'permanent-local t)
156
157 (defcustom notmuch-show-stash-mlarchive-link-alist
158   '(("Gmane" . "http://mid.gmane.org/")
159     ("MARC" . "http://marc.info/?i=")
160     ("Mail Archive, The" . "http://mail-archive.com/search?l=mid&q=")
161     ("LKML" . "http://lkml.kernel.org/r/")
162     ;; FIXME: can these services be searched by `Message-Id' ?
163     ;; ("MarkMail" . "http://markmail.org/")
164     ;; ("Nabble" . "http://nabble.com/")
165     ;; ("opensubscriber" . "http://opensubscriber.com/")
166     )
167   "List of Mailing List Archives to use when stashing links.
168
169 These URIs are concatenated with the current message's
170 Message-Id in `notmuch-show-stash-mlarchive-link'."
171   :type '(alist :key-type (string :tag "Name")
172                 :value-type (string :tag "URL"))
173   :group 'notmuch-show)
174
175 (defcustom notmuch-show-stash-mlarchive-link-default "Gmane"
176   "Default Mailing List Archive to use when stashing links.
177
178 This is used when `notmuch-show-stash-mlarchive-link' isn't
179 provided with an MLA argument nor `completing-read' input."
180   :type `(choice
181           ,@(mapcar
182              (lambda (mla)
183                (list 'const :tag (car mla) :value (car mla)))
184              notmuch-show-stash-mlarchive-link-alist))
185   :group 'notmuch-show)
186
187 (defcustom notmuch-show-mark-read-tags '("-unread")
188   "List of tag changes to apply to a message when it is marked as read.
189
190 Tags starting with \"+\" (or not starting with either \"+\" or
191 \"-\") in the list will be added, and tags starting with \"-\"
192 will be removed from the message being marked as read.
193
194 For example, if you wanted to remove an \"unread\" tag and add a
195 \"read\" tag (which would make little sense), you would set:
196     (\"-unread\" \"+read\")"
197   :type '(repeat string)
198   :group 'notmuch-show)
199
200
201 (defmacro with-current-notmuch-show-message (&rest body)
202   "Evaluate body with current buffer set to the text of current message"
203   `(save-excursion
204      (let ((id (notmuch-show-get-message-id)))
205        (let ((buf (generate-new-buffer (concat "*notmuch-msg-" id "*"))))
206          (with-current-buffer buf
207            (let ((coding-system-for-read 'no-conversion))
208              (call-process notmuch-command nil t nil "show" "--format=raw" id)
209              ,@body)
210            (kill-buffer buf))))))
211
212 (defun notmuch-show-turn-on-visual-line-mode ()
213   "Enable Visual Line mode."
214   (visual-line-mode t))
215
216 (defun notmuch-show-view-all-mime-parts ()
217   "Use external viewers to view all attachments from the current message."
218   (interactive)
219   (with-current-notmuch-show-message
220    ;; We override the mm-inline-media-tests to indicate which message
221    ;; parts are already sufficiently handled by the original
222    ;; presentation of the message in notmuch-show mode. These parts
223    ;; will be inserted directly into the temporary buffer of
224    ;; with-current-notmuch-show-message and silently discarded.
225    ;;
226    ;; Any MIME part not explicitly mentioned here will be handled by an
227    ;; external viewer as configured in the various mailcap files.
228    (let ((mm-inline-media-tests '(
229                                   ("text/.*" ignore identity)
230                                   ("application/pgp-signature" ignore identity)
231                                   ("multipart/alternative" ignore identity)
232                                   ("multipart/mixed" ignore identity)
233                                   ("multipart/related" ignore identity)
234                                  )))
235      (mm-display-parts (mm-dissect-buffer)))))
236
237 (defun notmuch-foreach-mime-part (function mm-handle)
238   (cond ((stringp (car mm-handle))
239          (dolist (part (cdr mm-handle))
240            (notmuch-foreach-mime-part function part)))
241         ((bufferp (car mm-handle))
242          (funcall function mm-handle))
243         (t (dolist (part mm-handle)
244              (notmuch-foreach-mime-part function part)))))
245
246 (defun notmuch-count-attachments (mm-handle)
247   (let ((count 0))
248     (notmuch-foreach-mime-part
249      (lambda (p)
250        (let ((disposition (mm-handle-disposition p)))
251          (and (listp disposition)
252               (or (equal (car disposition) "attachment")
253                   (and (equal (car disposition) "inline")
254                        (assq 'filename disposition)))
255               (incf count))))
256      mm-handle)
257     count))
258
259 (defun notmuch-save-attachments (mm-handle &optional queryp)
260   (notmuch-foreach-mime-part
261    (lambda (p)
262      (let ((disposition (mm-handle-disposition p)))
263        (and (listp disposition)
264             (or (equal (car disposition) "attachment")
265                 (and (equal (car disposition) "inline")
266                      (assq 'filename disposition)))
267             (or (not queryp)
268                 (y-or-n-p
269                  (concat "Save '" (cdr (assq 'filename disposition)) "' ")))
270             (mm-save-part p))))
271    mm-handle))
272
273 (defun notmuch-show-save-attachments ()
274   "Save all attachments from the current message."
275   (interactive)
276   (with-current-notmuch-show-message
277    (let ((mm-handle (mm-dissect-buffer)))
278      (notmuch-save-attachments
279       mm-handle (> (notmuch-count-attachments mm-handle) 1))))
280   (message "Done"))
281
282 (defun notmuch-show-with-message-as-text (fn)
283   "Apply FN to a text representation of the current message.
284
285 FN is called with one argument, the message properties. It should
286 operation on the contents of the current buffer."
287
288   ;; Remake the header to ensure that all information is available.
289   (let* ((to (notmuch-show-get-to))
290          (cc (notmuch-show-get-cc))
291          (from (notmuch-show-get-from))
292          (subject (notmuch-show-get-subject))
293          (date (notmuch-show-get-date))
294          (tags (notmuch-show-get-tags))
295          (depth (notmuch-show-get-depth))
296
297          (header (concat
298                   "Subject: " subject "\n"
299                   "To: " to "\n"
300                   (if (not (string= cc ""))
301                       (concat "Cc: " cc "\n")
302                     "")
303                   "From: " from "\n"
304                   "Date: " date "\n"
305                   (if tags
306                       (concat "Tags: "
307                               (mapconcat #'identity tags ", ") "\n")
308                     "")))
309          (all (buffer-substring (notmuch-show-message-top)
310                                 (notmuch-show-message-bottom)))
311
312          (props (notmuch-show-get-message-properties))
313          (indenting notmuch-show-indent-content))
314     (with-temp-buffer
315       (insert all)
316       (if indenting
317           (indent-rigidly (point-min) (point-max) (- depth)))
318       ;; Remove the original header.
319       (goto-char (point-min))
320       (re-search-forward "^$" (point-max) nil)
321       (delete-region (point-min) (point))
322       (insert header)
323       (funcall fn props))))
324
325 (defun notmuch-show-print-message ()
326   "Print the current message."
327   (interactive)
328   (notmuch-show-with-message-as-text 'notmuch-print-message))
329
330 (defun notmuch-show-fontify-header ()
331   (let ((face (cond
332                ((looking-at "[Tt]o:")
333                 'message-header-to)
334                ((looking-at "[Bb]?[Cc][Cc]:")
335                 'message-header-cc)
336                ((looking-at "[Ss]ubject:")
337                 'message-header-subject)
338                ((looking-at "[Ff]rom:")
339                 'message-header-from)
340                (t
341                 'message-header-other))))
342
343     (overlay-put (make-overlay (point) (re-search-forward ":"))
344                  'face 'message-header-name)
345     (overlay-put (make-overlay (point) (re-search-forward ".*$"))
346                  'face face)))
347
348 (defun notmuch-show-colour-headers ()
349   "Apply some colouring to the current headers."
350   (goto-char (point-min))
351   (while (looking-at "^[A-Za-z][-A-Za-z0-9]*:")
352     (notmuch-show-fontify-header)
353     (forward-line)))
354
355 (defun notmuch-show-spaces-n (n)
356   "Return a string comprised of `n' spaces."
357   (make-string n ? ))
358
359 (defun notmuch-show-update-tags (tags)
360   "Update the displayed tags of the current message."
361   (save-excursion
362     (goto-char (notmuch-show-message-top))
363     (if (re-search-forward "(\\([^()]*\\))$" (line-end-position) t)
364         (let ((inhibit-read-only t))
365           (replace-match (concat "("
366                                  (notmuch-tag-format-tags tags)
367                                  ")"))))))
368
369 (defun notmuch-clean-address (address)
370   "Try to clean a single email ADDRESS for display. Return a cons
371 cell of (AUTHOR_EMAIL AUTHOR_NAME). Return (ADDRESS nil) if
372 parsing fails."
373   (condition-case nil
374     (let (p-name p-address)
375       ;; It would be convenient to use `mail-header-parse-address',
376       ;; but that expects un-decoded mailbox parts, whereas our
377       ;; mailbox parts are already decoded (and hence may contain
378       ;; UTF-8). Given that notmuch should handle most of the awkward
379       ;; cases, some simple string deconstruction should be sufficient
380       ;; here.
381       (cond
382        ;; "User <user@dom.ain>" style.
383        ((string-match "\\(.*\\) <\\(.*\\)>" address)
384         (setq p-name (match-string 1 address)
385               p-address (match-string 2 address)))
386
387        ;; "<user@dom.ain>" style.
388        ((string-match "<\\(.*\\)>" address)
389         (setq p-address (match-string 1 address)))
390
391        ;; Everything else.
392        (t
393         (setq p-address address)))
394
395       (when p-name
396         ;; Remove elements of the mailbox part that are not relevant for
397         ;; display, even if they are required during transport:
398         ;;
399         ;; Backslashes.
400         (setq p-name (replace-regexp-in-string "\\\\" "" p-name))
401
402         ;; Outer single and double quotes, which might be nested.
403         (loop
404          with start-of-loop
405          do (setq start-of-loop p-name)
406
407          when (string-match "^\"\\(.*\\)\"$" p-name)
408          do (setq p-name (match-string 1 p-name))
409
410          when (string-match "^'\\(.*\\)'$" p-name)
411          do (setq p-name (match-string 1 p-name))
412
413          until (string= start-of-loop p-name)))
414
415       ;; If the address is 'foo@bar.com <foo@bar.com>' then show just
416       ;; 'foo@bar.com'.
417       (when (string= p-name p-address)
418         (setq p-name nil))
419
420       (cons p-address p-name))
421     (error (cons address nil))))
422
423 (defun notmuch-show-clean-address (address)
424   "Try to clean a single email ADDRESS for display.  Return
425 unchanged ADDRESS if parsing fails."
426   (let* ((clean-address (notmuch-clean-address address))
427          (p-address (car clean-address))
428          (p-name (cdr clean-address)))
429     ;; If no name, return just the address.
430     (if (not p-name)
431         p-address
432       ;; Otherwise format the name and address together.
433       (concat p-name " <" p-address ">"))))
434
435 (defun notmuch-show-insert-headerline (headers date tags depth)
436   "Insert a notmuch style headerline based on HEADERS for a
437 message at DEPTH in the current thread."
438   (let ((start (point)))
439     (insert (notmuch-show-spaces-n (* notmuch-show-indent-messages-width depth))
440             (notmuch-show-clean-address (plist-get headers :From))
441             " ("
442             date
443             ") ("
444             (notmuch-tag-format-tags tags)
445             ")\n")
446     (overlay-put (make-overlay start (point)) 'face 'notmuch-message-summary-face)))
447
448 (defun notmuch-show-insert-header (header header-value)
449   "Insert a single header."
450   (insert header ": " header-value "\n"))
451
452 (defun notmuch-show-insert-headers (headers)
453   "Insert the headers of the current message."
454   (let ((start (point)))
455     (mapc (lambda (header)
456             (let* ((header-symbol (intern (concat ":" header)))
457                    (header-value (plist-get headers header-symbol)))
458               (if (and header-value
459                        (not (string-equal "" header-value)))
460                   (notmuch-show-insert-header header header-value))))
461           notmuch-message-headers)
462     (save-excursion
463       (save-restriction
464         (narrow-to-region start (point-max))
465         (run-hooks 'notmuch-show-markup-headers-hook)))))
466
467 (define-button-type 'notmuch-show-part-button-type
468   'action 'notmuch-show-part-button-default
469   'follow-link t
470   'face 'message-mml
471   :supertype 'notmuch-button-type)
472
473 (defun notmuch-show-insert-part-header (nth content-type declared-type &optional name comment)
474   (let ((button)
475         (base-label (concat (when name (concat name ": "))
476                             declared-type
477                             (unless (string-equal declared-type content-type)
478                               (concat " (as " content-type ")"))
479                             comment)))
480
481     (setq button
482           (insert-button
483            (concat "[ " base-label " ]")
484            :base-label base-label
485            :type 'notmuch-show-part-button-type))
486     (insert "\n")
487     ;; return button
488     button))
489
490 ;; This is taken from notmuch-wash: maybe it should be unified?
491 (defun notmuch-show-toggle-part-invisibility (&optional button)
492   (interactive)
493   (let* ((button (or button (button-at (point))))
494          (overlay (button-get button 'overlay)))
495     (when overlay
496       (let* ((show (overlay-get overlay 'invisible))
497              (new-start (button-start button))
498              (button-label (button-get button :base-label))
499              (old-point (point))
500              (properties (text-properties-at (point)))
501              (inhibit-read-only t))
502         (overlay-put overlay 'invisible (not show))
503         (goto-char new-start)
504         (insert "[ " button-label (if show " ]" " (hidden) ]"))
505         (set-text-properties new-start (point) properties)
506         (let ((old-end (button-end button)))
507           (move-overlay button new-start (point))
508           (delete-region (point) old-end))
509         (goto-char (min old-point (1- (button-end button))))))))
510
511 ;; MIME part renderers
512
513 (defun notmuch-show-multipart/*-to-list (part)
514   (mapcar (lambda (inner-part) (plist-get inner-part :content-type))
515           (plist-get part :content)))
516
517 (defun notmuch-show-insert-part-multipart/alternative (msg part content-type nth depth button)
518   (let ((chosen-type (car (notmuch-multipart/alternative-choose (notmuch-show-multipart/*-to-list part))))
519         (inner-parts (plist-get part :content))
520         (start (point)))
521     ;; This inserts all parts of the chosen type rather than just one,
522     ;; but it's not clear that this is the wrong thing to do - which
523     ;; should be chosen if there are more than one that match?
524     (mapc (lambda (inner-part)
525             (let* ((inner-type (plist-get inner-part :content-type))
526                   (hide (not (or notmuch-show-all-multipart/alternative-parts
527                            (string= chosen-type inner-type)))))
528               (notmuch-show-insert-bodypart msg inner-part depth hide)))
529           inner-parts)
530
531     (when notmuch-show-indent-multipart
532       (indent-rigidly start (point) 1)))
533   t)
534
535 (defun notmuch-show-setup-w3m ()
536   "Instruct w3m how to retrieve content from a \"related\" part of a message."
537   (interactive)
538   (if (boundp 'w3m-cid-retrieve-function-alist)
539     (unless (assq 'notmuch-show-mode w3m-cid-retrieve-function-alist)
540       (push (cons 'notmuch-show-mode 'notmuch-show-w3m-cid-retrieve)
541             w3m-cid-retrieve-function-alist)))
542   (setq mm-inline-text-html-with-images t))
543
544 (defvar w3m-current-buffer) ;; From `w3m.el'.
545 (defvar notmuch-show-w3m-cid-store nil)
546 (make-variable-buffer-local 'notmuch-show-w3m-cid-store)
547
548 (defun notmuch-show-w3m-cid-store-internal (content-id
549                                             message-id
550                                             part-number
551                                             content-type
552                                             content)
553   (push (list content-id
554               message-id
555               part-number
556               content-type
557               content)
558         notmuch-show-w3m-cid-store))
559
560 (defun notmuch-show-w3m-cid-store (msg part)
561   (let ((content-id (plist-get part :content-id)))
562     (when content-id
563       (notmuch-show-w3m-cid-store-internal (concat "cid:" content-id)
564                                            (plist-get msg :id)
565                                            (plist-get part :id)
566                                            (plist-get part :content-type)
567                                            nil))))
568
569 (defun notmuch-show-w3m-cid-retrieve (url &rest args)
570   (let ((matching-part (with-current-buffer w3m-current-buffer
571                          (assoc url notmuch-show-w3m-cid-store))))
572     (if matching-part
573         (let ((message-id (nth 1 matching-part))
574               (part-number (nth 2 matching-part))
575               (content-type (nth 3 matching-part))
576               (content (nth 4 matching-part)))
577           ;; If we don't already have the content, get it and cache
578           ;; it, as some messages reference the same cid: part many
579           ;; times (hundreds!), which results in many calls to
580           ;; `notmuch part'.
581           (unless content
582             (setq content (notmuch-get-bodypart-internal (notmuch-id-to-query message-id)
583                                                               part-number notmuch-show-process-crypto))
584             (with-current-buffer w3m-current-buffer
585               (notmuch-show-w3m-cid-store-internal url
586                                                    message-id
587                                                    part-number
588                                                    content-type
589                                                    content)))
590           (insert content)
591           content-type)
592       nil)))
593
594 (defun notmuch-show-insert-part-multipart/related (msg part content-type nth depth button)
595   (let ((inner-parts (plist-get part :content))
596         (start (point)))
597
598     ;; We assume that the first part is text/html and the remainder
599     ;; things that it references.
600
601     ;; Stash the non-primary parts.
602     (mapc (lambda (part)
603             (notmuch-show-w3m-cid-store msg part))
604           (cdr inner-parts))
605
606     ;; Render the primary part.
607     (notmuch-show-insert-bodypart msg (car inner-parts) depth)
608
609     (when notmuch-show-indent-multipart
610       (indent-rigidly start (point) 1)))
611   t)
612
613 (defun notmuch-show-insert-part-multipart/signed (msg part content-type nth depth button)
614   (button-put button 'face 'notmuch-crypto-part-header)
615   ;; add signature status button if sigstatus provided
616   (if (plist-member part :sigstatus)
617       (let* ((from (notmuch-show-get-header :From msg))
618              (sigstatus (car (plist-get part :sigstatus))))
619         (notmuch-crypto-insert-sigstatus-button sigstatus from))
620     ;; if we're not adding sigstatus, tell the user how they can get it
621     (button-put button 'help-echo "Set notmuch-crypto-process-mime to process cryptographic MIME parts."))
622
623   (let ((inner-parts (plist-get part :content))
624         (start (point)))
625     ;; Show all of the parts.
626     (mapc (lambda (inner-part)
627             (notmuch-show-insert-bodypart msg inner-part depth))
628           inner-parts)
629
630     (when notmuch-show-indent-multipart
631       (indent-rigidly start (point) 1)))
632   t)
633
634 (defun notmuch-show-insert-part-multipart/encrypted (msg part content-type nth depth button)
635   (button-put button 'face 'notmuch-crypto-part-header)
636   ;; add encryption status button if encstatus specified
637   (if (plist-member part :encstatus)
638       (let ((encstatus (car (plist-get part :encstatus))))
639         (notmuch-crypto-insert-encstatus-button encstatus)
640         ;; add signature status button if sigstatus specified
641         (if (plist-member part :sigstatus)
642             (let* ((from (notmuch-show-get-header :From msg))
643                    (sigstatus (car (plist-get part :sigstatus))))
644               (notmuch-crypto-insert-sigstatus-button sigstatus from))))
645     ;; if we're not adding encstatus, tell the user how they can get it
646     (button-put button 'help-echo "Set notmuch-crypto-process-mime to process cryptographic MIME parts."))
647
648   (let ((inner-parts (plist-get part :content))
649         (start (point)))
650     ;; Show all of the parts.
651     (mapc (lambda (inner-part)
652             (notmuch-show-insert-bodypart msg inner-part depth))
653           inner-parts)
654
655     (when notmuch-show-indent-multipart
656       (indent-rigidly start (point) 1)))
657   t)
658
659 (defun notmuch-show-insert-part-multipart/* (msg part content-type nth depth button)
660   (let ((inner-parts (plist-get part :content))
661         (start (point)))
662     ;; Show all of the parts.
663     (mapc (lambda (inner-part)
664             (notmuch-show-insert-bodypart msg inner-part depth))
665           inner-parts)
666
667     (when notmuch-show-indent-multipart
668       (indent-rigidly start (point) 1)))
669   t)
670
671 (defun notmuch-show-insert-part-message/rfc822 (msg part content-type nth depth button)
672   (let* ((message (car (plist-get part :content)))
673          (body (car (plist-get message :body)))
674          (start (point)))
675
676     ;; Override `notmuch-message-headers' to force `From' to be
677     ;; displayed.
678     (let ((notmuch-message-headers '("From" "Subject" "To" "Cc" "Date")))
679       (notmuch-show-insert-headers (plist-get message :headers)))
680
681     ;; Blank line after headers to be compatible with the normal
682     ;; message display.
683     (insert "\n")
684
685     ;; Show the body
686     (notmuch-show-insert-bodypart msg body depth)
687
688     (when notmuch-show-indent-multipart
689       (indent-rigidly start (point) 1)))
690   t)
691
692 (defun notmuch-show-insert-part-text/plain (msg part content-type nth depth button)
693   ;; For backward compatibility we want to apply the text/plain hook
694   ;; to the whole of the part including the part button if there is
695   ;; one.
696   (let ((start (if button
697                    (button-start button)
698                  (point))))
699     (insert (notmuch-get-bodypart-content msg part nth notmuch-show-process-crypto))
700     (save-excursion
701       (save-restriction
702         (narrow-to-region start (point-max))
703         (run-hook-with-args 'notmuch-show-insert-text/plain-hook msg depth))))
704   t)
705
706 (defun notmuch-show-insert-part-text/calendar (msg part content-type nth depth button)
707   (insert (with-temp-buffer
708             (insert (notmuch-get-bodypart-content msg part nth notmuch-show-process-crypto))
709             ;; notmuch-get-bodypart-content provides "raw", non-converted
710             ;; data. Replace CRLF with LF before icalendar can use it.
711             (goto-char (point-min))
712             (while (re-search-forward "\r\n" nil t)
713               (replace-match "\n" nil nil))
714             (let ((file (make-temp-file "notmuch-ical"))
715                   result)
716               (unwind-protect
717                   (progn
718                     (unless (icalendar-import-buffer file t)
719                       (error "Icalendar import error. See *icalendar-errors* for more information"))
720                     (set-buffer (get-file-buffer file))
721                     (setq result (buffer-substring (point-min) (point-max)))
722                     (set-buffer-modified-p nil)
723                     (kill-buffer (current-buffer)))
724                 (delete-file file))
725               result)))
726   t)
727
728 ;; For backwards compatibility.
729 (defun notmuch-show-insert-part-text/x-vcalendar (msg part content-type nth depth button)
730   (notmuch-show-insert-part-text/calendar msg part content-type nth depth button))
731
732 (defun notmuch-show-get-mime-type-of-application/octet-stream (part)
733   ;; If we can deduce a MIME type from the filename of the attachment,
734   ;; we return that.
735   (if (plist-get part :filename)
736       (let ((extension (file-name-extension (plist-get part :filename)))
737             mime-type)
738         (if extension
739             (progn
740               (mailcap-parse-mimetypes)
741               (setq mime-type (mailcap-extension-to-mime extension))
742               (if (and mime-type
743                        (not (string-equal mime-type "application/octet-stream")))
744                   mime-type
745                 nil))
746           nil))))
747
748 (defun notmuch-show-insert-part-text/html (msg part content-type nth depth button)
749   ;; text/html handler to work around bugs in renderers and our
750   ;; invisibile parts code. In particular w3m sets up a keymap which
751   ;; "leaks" outside the invisible region and causes strange effects
752   ;; in notmuch. We set mm-inline-text-html-with-w3m-keymap to nil to
753   ;; tell w3m not to set a keymap (so the normal notmuch-show-mode-map
754   ;; remains).
755   (let ((mm-inline-text-html-with-w3m-keymap nil))
756     (notmuch-show-insert-part-*/* msg part content-type nth depth button)))
757
758 (defun notmuch-show-insert-part-*/* (msg part content-type nth depth button)
759   ;; This handler _must_ succeed - it is the handler of last resort.
760   (notmuch-mm-display-part-inline msg part nth content-type notmuch-show-process-crypto)
761   t)
762
763 ;; Functions for determining how to handle MIME parts.
764
765 (defun notmuch-show-handlers-for (content-type)
766   "Return a list of content handlers for a part of type CONTENT-TYPE."
767   (let (result)
768     (mapc (lambda (func)
769             (if (functionp func)
770                 (push func result)))
771           ;; Reverse order of prefrence.
772           (list (intern (concat "notmuch-show-insert-part-*/*"))
773                 (intern (concat
774                          "notmuch-show-insert-part-"
775                          (car (notmuch-split-content-type content-type))
776                          "/*"))
777                 (intern (concat "notmuch-show-insert-part-" content-type))))
778     result))
779
780 ;; \f
781
782 (defun notmuch-show-insert-bodypart-internal (msg part content-type nth depth button)
783   (let ((handlers (notmuch-show-handlers-for content-type)))
784     ;; Run the content handlers until one of them returns a non-nil
785     ;; value.
786     (while (and handlers
787                 (not (condition-case err
788                          (funcall (car handlers) msg part content-type nth depth button)
789                        (error (progn
790                                 (insert "!!! Bodypart insert error: ")
791                                 (insert (error-message-string err))
792                                 (insert " !!!\n") nil)))))
793       (setq handlers (cdr handlers))))
794   t)
795
796 (defun notmuch-show-create-part-overlays (msg beg end hide)
797   "Add an overlay to the part between BEG and END"
798   (let* ((button (button-at beg))
799          (part-beg (and button (1+ (button-end button)))))
800
801     ;; If the part contains no text we do not make it toggleable. We
802     ;; also need to check that the button is a genuine part button not
803     ;; a notmuch-wash button.
804     (when (and button (/= part-beg end) (button-get button :base-label))
805       (button-put button 'overlay (make-overlay part-beg end))
806       ;; We toggle the button for hidden parts as that gets the
807       ;; button label right.
808       (save-excursion
809         (when hide
810           (notmuch-show-toggle-part-invisibility button))))))
811
812 (defun notmuch-show-insert-bodypart (msg part depth &optional hide)
813   "Insert the body part PART at depth DEPTH in the current thread.
814
815 If HIDE is non-nil then initially hide this part."
816
817   (let* ((content-type (downcase (plist-get part :content-type)))
818          (mime-type (or (and (string= content-type "application/octet-stream")
819                              (notmuch-show-get-mime-type-of-application/octet-stream part))
820                         (and (string= content-type "inline patch")
821                              "text/x-diff")
822                         content-type))
823          (nth (plist-get part :id))
824          (beg (point))
825          ;; We omit the part button for the first (or only) part if this is text/plain.
826          (button (unless (and (string= mime-type "text/plain") (<= nth 1))
827                    (notmuch-show-insert-part-header nth mime-type content-type (plist-get part :filename)))))
828
829     (notmuch-show-insert-bodypart-internal msg part mime-type nth depth button)
830     ;; Some of the body part handlers leave point somewhere up in the
831     ;; part, so we make sure that we're down at the end.
832     (goto-char (point-max))
833     ;; Ensure that the part ends with a carriage return.
834     (unless (bolp)
835       (insert "\n"))
836     (notmuch-show-create-part-overlays msg beg (point) hide)
837     ;; Record part information.  Since we already inserted subparts,
838     ;; don't override existing :notmuch-part properties.
839     (notmuch-map-text-property beg (point) :notmuch-part
840                                (lambda (v) (or v part)))
841     ;; Make :notmuch-part front sticky and rear non-sticky so it stays
842     ;; applied to the beginning of each line when we indent the
843     ;; message.  Since we're operating on arbitrary renderer output,
844     ;; watch out for sticky specs of t, which means all properties are
845     ;; front-sticky/rear-nonsticky.
846     (notmuch-map-text-property beg (point) 'front-sticky
847                                (lambda (v) (if (listp v)
848                                                (pushnew :notmuch-part v)
849                                              v)))
850     (notmuch-map-text-property beg (point) 'rear-nonsticky
851                                (lambda (v) (if (listp v)
852                                                (pushnew :notmuch-part v)
853                                              v)))))
854
855 (defun notmuch-show-insert-body (msg body depth)
856   "Insert the body BODY at depth DEPTH in the current thread."
857   (mapc (lambda (part) (notmuch-show-insert-bodypart msg part depth)) body))
858
859 (defun notmuch-show-make-symbol (type)
860   (make-symbol (concat "notmuch-show-" type)))
861
862 (defun notmuch-show-strip-re (string)
863   (replace-regexp-in-string "^\\([Rr]e: *\\)+" "" string))
864
865 (defvar notmuch-show-previous-subject "")
866 (make-variable-buffer-local 'notmuch-show-previous-subject)
867
868 (defun notmuch-show-insert-msg (msg depth)
869   "Insert the message MSG at depth DEPTH in the current thread."
870   (let* ((headers (plist-get msg :headers))
871          ;; Indentation causes the buffer offset of the start/end
872          ;; points to move, so we must use markers.
873          message-start message-end
874          content-start content-end
875          headers-start headers-end
876          (bare-subject (notmuch-show-strip-re (plist-get headers :Subject))))
877
878     (setq message-start (point-marker))
879
880     (notmuch-show-insert-headerline headers
881                                     (or (if notmuch-show-relative-dates
882                                             (plist-get msg :date_relative)
883                                           nil)
884                                         (plist-get headers :Date))
885                                     (plist-get msg :tags) depth)
886
887     (setq content-start (point-marker))
888
889     ;; Set `headers-start' to point after the 'Subject:' header to be
890     ;; compatible with the existing implementation. This just sets it
891     ;; to after the first header.
892     (notmuch-show-insert-headers headers)
893     (save-excursion
894       (goto-char content-start)
895       ;; If the subject of this message is the same as that of the
896       ;; previous message, don't display it when this message is
897       ;; collapsed.
898       (when (not (string= notmuch-show-previous-subject
899                           bare-subject))
900         (forward-line 1))
901       (setq headers-start (point-marker)))
902     (setq headers-end (point-marker))
903
904     (setq notmuch-show-previous-subject bare-subject)
905
906     ;; A blank line between the headers and the body.
907     (insert "\n")
908     (notmuch-show-insert-body msg (plist-get msg :body)
909                               (if notmuch-show-indent-content depth 0))
910     ;; Ensure that the body ends with a newline.
911     (unless (bolp)
912       (insert "\n"))
913     (setq content-end (point-marker))
914
915     ;; Indent according to the depth in the thread.
916     (if notmuch-show-indent-content
917         (indent-rigidly content-start content-end (* notmuch-show-indent-messages-width depth)))
918
919     (setq message-end (point-max-marker))
920
921     ;; Save the extents of this message over the whole text of the
922     ;; message.
923     (put-text-property message-start message-end :notmuch-message-extent (cons message-start message-end))
924
925     ;; Create overlays used to control visibility
926     (plist-put msg :headers-overlay (make-overlay headers-start headers-end))
927     (plist-put msg :message-overlay (make-overlay headers-start content-end))
928
929     (plist-put msg :depth depth)
930
931     ;; Save the properties for this message. Currently this saves the
932     ;; entire message (augmented it with other stuff), which seems
933     ;; like overkill. We might save a reduced subset (for example, not
934     ;; the content).
935     (notmuch-show-set-message-properties msg)
936
937     ;; Set header visibility.
938     (notmuch-show-headers-visible msg notmuch-message-headers-visible)
939
940     ;; Message visibility depends on whether it matched the search
941     ;; criteria.
942     (notmuch-show-message-visible msg (and (plist-get msg :match)
943                                            (not (plist-get msg :excluded))))))
944
945 (defun notmuch-show-toggle-process-crypto ()
946   "Toggle the processing of cryptographic MIME parts."
947   (interactive)
948   (setq notmuch-show-process-crypto (not notmuch-show-process-crypto))
949   (message (if notmuch-show-process-crypto
950                "Processing cryptographic MIME parts."
951              "Not processing cryptographic MIME parts."))
952   (notmuch-show-refresh-view))
953
954 (defun notmuch-show-toggle-elide-non-matching ()
955   "Toggle the display of non-matching messages."
956   (interactive)
957   (setq notmuch-show-elide-non-matching-messages (not notmuch-show-elide-non-matching-messages))
958   (message (if notmuch-show-elide-non-matching-messages
959                "Showing matching messages only."
960              "Showing all messages."))
961   (notmuch-show-refresh-view))
962
963 (defun notmuch-show-toggle-thread-indentation ()
964   "Toggle the indentation of threads."
965   (interactive)
966   (setq notmuch-show-indent-content (not notmuch-show-indent-content))
967   (message (if notmuch-show-indent-content
968                "Content is indented."
969              "Content is not indented."))
970   (notmuch-show-refresh-view))
971
972 (defun notmuch-show-insert-tree (tree depth)
973   "Insert the message tree TREE at depth DEPTH in the current thread."
974   (let ((msg (car tree))
975         (replies (cadr tree)))
976     ;; We test whether there is a message or just some replies.
977     (when msg
978       (notmuch-show-insert-msg msg depth))
979     (notmuch-show-insert-thread replies (1+ depth))))
980
981 (defun notmuch-show-insert-thread (thread depth)
982   "Insert the thread THREAD at depth DEPTH in the current forest."
983   (mapc (lambda (tree) (notmuch-show-insert-tree tree depth)) thread))
984
985 (defun notmuch-show-insert-forest (forest)
986   "Insert the forest of threads FOREST."
987   (mapc (lambda (thread) (notmuch-show-insert-thread thread 0)) forest))
988
989 (defvar notmuch-id-regexp
990   (concat
991    ;; Match the id: prefix only if it begins a word (to disallow, for
992    ;; example, matching cid:).
993    "\\<id:\\("
994    ;; If the term starts with a ", then parse Xapian's quoted boolean
995    ;; term syntax, which allows for anything as long as embedded
996    ;; double quotes escaped by doubling them.  We also disallow
997    ;; newlines (which Xapian allows) to prevent runaway terms.
998    "\"\\([^\"\n]\\|\"\"\\)*\""
999    ;; Otherwise, parse Xapian's unquoted syntax, which goes up to the
1000    ;; next space or ).  We disallow [.,;] as the last character
1001    ;; because these are probably part of the surrounding text, and not
1002    ;; part of the id.  This doesn't match single character ids; meh.
1003    "\\|[^\"[:space:])][^[:space:])]*[^])[:space:].,:;?!]"
1004    "\\)")
1005   "The regexp used to match id: links in messages.")
1006
1007 (defvar notmuch-mid-regexp
1008   ;; goto-address-url-regexp matched cid: links, which have the same
1009   ;; grammar as the message ID part of a mid: link.  Construct the
1010   ;; regexp using the same technique as goto-address-url-regexp.
1011   (concat "\\<mid:\\(" thing-at-point-url-path-regexp "\\)")
1012   "The regexp used to match mid: links in messages.
1013
1014 See RFC 2392.")
1015
1016 (defun notmuch-show-buttonise-links (start end)
1017   "Buttonise URLs and mail addresses between START and END.
1018
1019 This also turns id:\"<message id>\"-parts and mid: links into
1020 buttons for a corresponding notmuch search."
1021   (goto-address-fontify-region start end)
1022   (save-excursion
1023     (let (links)
1024       (goto-char start)
1025       (while (re-search-forward notmuch-id-regexp end t)
1026         (push (list (match-beginning 0) (match-end 0)
1027                     (match-string-no-properties 0)) links))
1028       (goto-char start)
1029       (while (re-search-forward notmuch-mid-regexp end t)
1030         (let* ((mid-cid (match-string-no-properties 1))
1031                (mid (save-match-data
1032                       (string-match "^[^/]*" mid-cid)
1033                       (url-unhex-string (match-string 0 mid-cid)))))
1034           (push (list (match-beginning 0) (match-end 0)
1035                       (notmuch-id-to-query mid)) links)))
1036       (dolist (link links)
1037         ;; Remove the overlay created by goto-address-mode
1038         (remove-overlays (first link) (second link) 'goto-address t)
1039         (make-text-button (first link) (second link)
1040                           :type 'notmuch-button-type
1041                           'action `(lambda (arg)
1042                                      (notmuch-show ,(third link)))
1043                           'follow-link t
1044                           'help-echo "Mouse-1, RET: search for this message"
1045                           'face goto-address-mail-face)))))
1046
1047 ;;;###autoload
1048 (defun notmuch-show (thread-id &optional parent-buffer query-context buffer-name)
1049   "Run \"notmuch show\" with the given thread ID and display results.
1050
1051 The optional PARENT-BUFFER is the notmuch-search buffer from
1052 which this notmuch-show command was executed, (so that the
1053 next thread from that buffer can be show when done with this
1054 one).
1055
1056 The optional QUERY-CONTEXT is a notmuch search term. Only
1057 messages from the thread matching this search term are shown if
1058 non-nil.
1059
1060 The optional BUFFER-NAME provides the name of the buffer in
1061 which the message thread is shown. If it is nil (which occurs
1062 when the command is called interactively) the argument to the
1063 function is used."
1064   (interactive "sNotmuch show: ")
1065   (let ((buffer-name (generate-new-buffer-name
1066                       (or buffer-name
1067                           (concat "*notmuch-" thread-id "*")))))
1068     (switch-to-buffer (get-buffer-create buffer-name))
1069     ;; Set the default value for `notmuch-show-process-crypto' in this
1070     ;; buffer.
1071     (setq notmuch-show-process-crypto notmuch-crypto-process-mime)
1072     ;; Set the default value for
1073     ;; `notmuch-show-elide-non-matching-messages' in this buffer. If
1074     ;; there is a prefix argument, invert the default.
1075     (setq notmuch-show-elide-non-matching-messages notmuch-show-only-matching-messages)
1076     (if current-prefix-arg
1077         (setq notmuch-show-elide-non-matching-messages (not notmuch-show-elide-non-matching-messages)))
1078
1079     (setq notmuch-show-thread-id thread-id
1080           notmuch-show-parent-buffer parent-buffer
1081           notmuch-show-query-context query-context)
1082     (notmuch-show-build-buffer)
1083     (notmuch-show-goto-first-wanted-message)
1084     (current-buffer)))
1085
1086 (defun notmuch-show-build-buffer ()
1087   (let ((inhibit-read-only t))
1088
1089     (notmuch-show-mode)
1090     ;; Don't track undo information for this buffer
1091     (set 'buffer-undo-list t)
1092
1093     (erase-buffer)
1094     (goto-char (point-min))
1095     (save-excursion
1096       (let* ((basic-args (list notmuch-show-thread-id))
1097              (args (if notmuch-show-query-context
1098                        (append (list "\'") basic-args
1099                                (list "and (" notmuch-show-query-context ")\'"))
1100                      (append (list "\'") basic-args (list "\'"))))
1101              (cli-args (cons "--exclude=false"
1102                              (when notmuch-show-elide-non-matching-messages
1103                                (list "--entire-thread=false")))))
1104
1105         (notmuch-show-insert-forest (notmuch-query-get-threads (append cli-args args)))
1106         ;; If the query context reduced the results to nothing, run
1107         ;; the basic query.
1108         (when (and (eq (buffer-size) 0)
1109                    notmuch-show-query-context)
1110           (notmuch-show-insert-forest
1111            (notmuch-query-get-threads (append cli-args basic-args)))))
1112
1113       (jit-lock-register #'notmuch-show-buttonise-links)
1114
1115       ;; Set the header line to the subject of the first message.
1116       (setq header-line-format (notmuch-show-strip-re (notmuch-show-get-subject)))
1117
1118       (run-hooks 'notmuch-show-hook))))
1119
1120 (defun notmuch-show-capture-state ()
1121   "Capture the state of the current buffer.
1122
1123 This includes:
1124  - the list of open messages,
1125  - the current message."
1126   (list (notmuch-show-get-message-id) (notmuch-show-get-message-ids-for-open-messages)))
1127
1128 (defun notmuch-show-apply-state (state)
1129   "Apply STATE to the current buffer.
1130
1131 This includes:
1132  - opening the messages previously opened,
1133  - closing all other messages,
1134  - moving to the correct current message."
1135   (let ((current (car state))
1136         (open (cadr state)))
1137
1138     ;; Open those that were open.
1139     (goto-char (point-min))
1140     (loop do (notmuch-show-message-visible (notmuch-show-get-message-properties)
1141                                            (member (notmuch-show-get-message-id) open))
1142           until (not (notmuch-show-goto-message-next)))
1143
1144     ;; Go to the previously open message.
1145     (goto-char (point-min))
1146     (unless (loop if (string= current (notmuch-show-get-message-id))
1147                   return t
1148                   until (not (notmuch-show-goto-message-next)))
1149       (goto-char (point-min))
1150       (message "Previously current message not found."))
1151     (notmuch-show-message-adjust)))
1152
1153 (defun notmuch-show-refresh-view (&optional reset-state)
1154   "Refresh the current view.
1155
1156 Refreshes the current view, observing changes in display
1157 preferences. If invoked with a prefix argument (or RESET-STATE is
1158 non-nil) then the state of the buffer (open/closed messages) is
1159 reset based on the original query."
1160   (interactive "P")
1161   (let ((inhibit-read-only t)
1162         (state (unless reset-state
1163                  (notmuch-show-capture-state))))
1164     ;; erase-buffer does not seem to remove overlays, which can lead
1165     ;; to weird effects such as remaining images, so remove them
1166     ;; manually.
1167     (remove-overlays)
1168     (erase-buffer)
1169     (notmuch-show-build-buffer)
1170     (if state
1171         (notmuch-show-apply-state state)
1172       ;; We're resetting state, so navigate to the first open message
1173       ;; and mark it read, just like opening a new show buffer.
1174       (notmuch-show-goto-first-wanted-message))))
1175
1176 (defvar notmuch-show-stash-map
1177   (let ((map (make-sparse-keymap)))
1178     (define-key map "c" 'notmuch-show-stash-cc)
1179     (define-key map "d" 'notmuch-show-stash-date)
1180     (define-key map "F" 'notmuch-show-stash-filename)
1181     (define-key map "f" 'notmuch-show-stash-from)
1182     (define-key map "i" 'notmuch-show-stash-message-id)
1183     (define-key map "I" 'notmuch-show-stash-message-id-stripped)
1184     (define-key map "s" 'notmuch-show-stash-subject)
1185     (define-key map "T" 'notmuch-show-stash-tags)
1186     (define-key map "t" 'notmuch-show-stash-to)
1187     (define-key map "l" 'notmuch-show-stash-mlarchive-link)
1188     (define-key map "L" 'notmuch-show-stash-mlarchive-link-and-go)
1189     map)
1190   "Submap for stash commands")
1191 (fset 'notmuch-show-stash-map notmuch-show-stash-map)
1192
1193 (defvar notmuch-show-part-map
1194   (let ((map (make-sparse-keymap)))
1195     (define-key map "s" 'notmuch-show-save-part)
1196     (define-key map "v" 'notmuch-show-view-part)
1197     (define-key map "o" 'notmuch-show-interactively-view-part)
1198     (define-key map "|" 'notmuch-show-pipe-part)
1199     map)
1200   "Submap for part commands")
1201 (fset 'notmuch-show-part-map notmuch-show-part-map)
1202
1203 (defvar notmuch-show-mode-map
1204       (let ((map (make-sparse-keymap)))
1205         (define-key map "?" 'notmuch-help)
1206         (define-key map "q" 'notmuch-kill-this-buffer)
1207         (define-key map (kbd "<C-tab>") 'widget-backward)
1208         (define-key map (kbd "M-TAB") 'notmuch-show-previous-button)
1209         (define-key map (kbd "<backtab>") 'notmuch-show-previous-button)
1210         (define-key map (kbd "TAB") 'notmuch-show-next-button)
1211         (define-key map "s" 'notmuch-search)
1212         (define-key map "m" 'notmuch-mua-new-mail)
1213         (define-key map "f" 'notmuch-show-forward-message)
1214         (define-key map "r" 'notmuch-show-reply-sender)
1215         (define-key map "R" 'notmuch-show-reply)
1216         (define-key map "|" 'notmuch-show-pipe-message)
1217         (define-key map "w" 'notmuch-show-save-attachments)
1218         (define-key map "V" 'notmuch-show-view-raw-message)
1219         (define-key map "v" 'notmuch-show-view-all-mime-parts)
1220         (define-key map "c" 'notmuch-show-stash-map)
1221         (define-key map "=" 'notmuch-show-refresh-view)
1222         (define-key map "h" 'notmuch-show-toggle-visibility-headers)
1223         (define-key map "*" 'notmuch-show-tag-all)
1224         (define-key map "-" 'notmuch-show-remove-tag)
1225         (define-key map "+" 'notmuch-show-add-tag)
1226         (define-key map "X" 'notmuch-show-archive-thread-then-exit)
1227         (define-key map "x" 'notmuch-show-archive-message-then-next-or-exit)
1228         (define-key map "A" 'notmuch-show-archive-thread-then-next)
1229         (define-key map "a" 'notmuch-show-archive-message-then-next-or-next-thread)
1230         (define-key map "N" 'notmuch-show-next-message)
1231         (define-key map "P" 'notmuch-show-previous-message)
1232         (define-key map "n" 'notmuch-show-next-open-message)
1233         (define-key map "p" 'notmuch-show-previous-open-message)
1234         (define-key map (kbd "M-n") 'notmuch-show-next-thread-show)
1235         (define-key map (kbd "M-p") 'notmuch-show-previous-thread-show)
1236         (define-key map (kbd "DEL") 'notmuch-show-rewind)
1237         (define-key map " " 'notmuch-show-advance-and-archive)
1238         (define-key map (kbd "M-RET") 'notmuch-show-open-or-close-all)
1239         (define-key map (kbd "RET") 'notmuch-show-toggle-message)
1240         (define-key map "#" 'notmuch-show-print-message)
1241         (define-key map "!" 'notmuch-show-toggle-elide-non-matching)
1242         (define-key map "$" 'notmuch-show-toggle-process-crypto)
1243         (define-key map "<" 'notmuch-show-toggle-thread-indentation)
1244         (define-key map "t" 'toggle-truncate-lines)
1245         (define-key map "." 'notmuch-show-part-map)
1246         map)
1247       "Keymap for \"notmuch show\" buffers.")
1248 (fset 'notmuch-show-mode-map notmuch-show-mode-map)
1249
1250 (defun notmuch-show-mode ()
1251   "Major mode for viewing a thread with notmuch.
1252
1253 This buffer contains the results of the \"notmuch show\" command
1254 for displaying a single thread of email from your email archives.
1255
1256 By default, various components of email messages, (citations,
1257 signatures, already-read messages), are hidden. You can make
1258 these parts visible by clicking with the mouse button or by
1259 pressing RET after positioning the cursor on a hidden part, (for
1260 which \\[notmuch-show-next-button] and \\[notmuch-show-previous-button] are helpful).
1261
1262 Reading the thread sequentially is well-supported by pressing
1263 \\[notmuch-show-advance-and-archive]. This will scroll the current message (if necessary), advance
1264 to the next message, or advance to the next thread (if already on
1265 the last message of a thread).
1266
1267 Other commands are available to read or manipulate the thread
1268 more selectively, (such as '\\[notmuch-show-next-message]' and '\\[notmuch-show-previous-message]' to advance to messages
1269 without removing any tags, and '\\[notmuch-show-archive-thread]' to archive an entire thread
1270 without scrolling through with \\[notmuch-show-advance-and-archive]).
1271
1272 You can add or remove arbitrary tags from the current message with
1273 '\\[notmuch-show-add-tag]' or '\\[notmuch-show-remove-tag]'.
1274
1275 All currently available key bindings:
1276
1277 \\{notmuch-show-mode-map}"
1278   (interactive)
1279   (kill-all-local-variables)
1280   (use-local-map notmuch-show-mode-map)
1281   (setq major-mode 'notmuch-show-mode
1282         mode-name "notmuch-show")
1283   (setq buffer-read-only t
1284         truncate-lines t))
1285
1286 (defun notmuch-show-move-to-message-top ()
1287   (goto-char (notmuch-show-message-top)))
1288
1289 (defun notmuch-show-move-to-message-bottom ()
1290   (goto-char (notmuch-show-message-bottom)))
1291
1292 (defun notmuch-show-message-adjust ()
1293   (recenter 0))
1294
1295 ;; Movement related functions.
1296
1297 ;; There's some strangeness here where a text property applied to a
1298 ;; region a->b is not found when point is at b. We walk backwards
1299 ;; until finding the property.
1300 (defun notmuch-show-message-extent ()
1301   (let (r)
1302     (save-excursion
1303       (while (not (setq r (get-text-property (point) :notmuch-message-extent)))
1304         (backward-char)))
1305     r))
1306
1307 (defun notmuch-show-message-top ()
1308   (car (notmuch-show-message-extent)))
1309
1310 (defun notmuch-show-message-bottom ()
1311   (cdr (notmuch-show-message-extent)))
1312
1313 (defun notmuch-show-goto-message-next ()
1314   (let ((start (point)))
1315     (notmuch-show-move-to-message-bottom)
1316     (if (not (eobp))
1317         t
1318       (goto-char start)
1319       nil)))
1320
1321 (defun notmuch-show-goto-message-previous ()
1322   (notmuch-show-move-to-message-top)
1323   (if (bobp)
1324       nil
1325     (backward-char)
1326     (notmuch-show-move-to-message-top)
1327     t))
1328
1329 (defun notmuch-show-mapc (function)
1330   "Iterate through all messages in the current thread with
1331 `notmuch-show-goto-message-next' and call FUNCTION for side
1332 effects."
1333   (save-excursion
1334     (goto-char (point-min))
1335     (loop do (funcall function)
1336           while (notmuch-show-goto-message-next))))
1337
1338 ;; Functions relating to the visibility of messages and their
1339 ;; components.
1340
1341 (defun notmuch-show-message-visible (props visible-p)
1342   (overlay-put (plist-get props :message-overlay) 'invisible (not visible-p))
1343   (notmuch-show-set-prop :message-visible visible-p props))
1344
1345 (defun notmuch-show-headers-visible (props visible-p)
1346   (overlay-put (plist-get props :headers-overlay) 'invisible (not visible-p))
1347   (notmuch-show-set-prop :headers-visible visible-p props))
1348
1349 ;; Functions for setting and getting attributes of the current
1350 ;; message.
1351
1352 (defun notmuch-show-set-message-properties (props)
1353   (save-excursion
1354     (notmuch-show-move-to-message-top)
1355     (put-text-property (point) (+ (point) 1) :notmuch-message-properties props)))
1356
1357 (defun notmuch-show-get-message-properties ()
1358   "Return the properties of the current message as a plist.
1359
1360 Some useful entries are:
1361 :headers - Property list containing the headers :Date, :Subject, :From, etc.
1362 :body - Body of the message
1363 :tags - Tags for this message"
1364   (save-excursion
1365     (notmuch-show-move-to-message-top)
1366     (get-text-property (point) :notmuch-message-properties)))
1367
1368 (defun notmuch-show-get-part-properties ()
1369   "Return the properties of the innermost part containing point.
1370
1371 This is the part property list retrieved from the CLI.  Signals
1372 an error if there is no part containing point."
1373   (or (get-text-property (point) :notmuch-part)
1374       (error "No message part here")))
1375
1376 (defun notmuch-show-set-prop (prop val &optional props)
1377   (let ((inhibit-read-only t)
1378         (props (or props
1379                    (notmuch-show-get-message-properties))))
1380     (plist-put props prop val)
1381     (notmuch-show-set-message-properties props)))
1382
1383 (defun notmuch-show-get-prop (prop &optional props)
1384   (let ((props (or props
1385                    (notmuch-show-get-message-properties))))
1386     (plist-get props prop)))
1387
1388 (defun notmuch-show-get-message-id (&optional bare)
1389   "Return an id: query for the Message-Id of the current message.
1390
1391 If optional argument BARE is non-nil, return
1392 the Message-Id without id: prefix and escaping."
1393   (if bare
1394       (notmuch-show-get-prop :id)
1395     (notmuch-id-to-query (notmuch-show-get-prop :id))))
1396
1397 (defun notmuch-show-get-messages-ids ()
1398   "Return all id: queries of messages in the current thread."
1399   (let ((message-ids))
1400     (notmuch-show-mapc
1401      (lambda () (push (notmuch-show-get-message-id) message-ids)))
1402     message-ids))
1403
1404 (defun notmuch-show-get-messages-ids-search ()
1405   "Return a search string for all message ids of messages in the
1406 current thread."
1407   (mapconcat 'identity (notmuch-show-get-messages-ids) " or "))
1408
1409 ;; dme: Would it make sense to use a macro for many of these?
1410
1411 (defun notmuch-show-get-filename ()
1412   "Return the filename of the current message."
1413   (notmuch-show-get-prop :filename))
1414
1415 (defun notmuch-show-get-header (header &optional props)
1416   "Return the named header of the current message, if any."
1417   (plist-get (notmuch-show-get-prop :headers props) header))
1418
1419 (defun notmuch-show-get-cc ()
1420   (notmuch-show-get-header :Cc))
1421
1422 (defun notmuch-show-get-date ()
1423   (notmuch-show-get-header :Date))
1424
1425 (defun notmuch-show-get-from ()
1426   (notmuch-show-get-header :From))
1427
1428 (defun notmuch-show-get-subject ()
1429   (notmuch-show-get-header :Subject))
1430
1431 (defun notmuch-show-get-to ()
1432   (notmuch-show-get-header :To))
1433
1434 (defun notmuch-show-get-depth ()
1435   (notmuch-show-get-prop :depth))
1436
1437 (defun notmuch-show-set-tags (tags)
1438   "Set the tags of the current message."
1439   (notmuch-show-set-prop :tags tags)
1440   (notmuch-show-update-tags tags))
1441
1442 (defun notmuch-show-get-tags ()
1443   "Return the tags of the current message."
1444   (notmuch-show-get-prop :tags))
1445
1446 (defun notmuch-show-message-visible-p ()
1447   "Is the current message visible?"
1448   (notmuch-show-get-prop :message-visible))
1449
1450 (defun notmuch-show-headers-visible-p ()
1451   "Are the headers of the current message visible?"
1452   (notmuch-show-get-prop :headers-visible))
1453
1454 (defun notmuch-show-mark-read (&optional unread)
1455   "Mark the current message as read.
1456
1457 Mark the current message as read by applying the tag changes in
1458 `notmuch-show-mark-read-tags' to it (remove the \"unread\" tag by
1459 default). If a prefix argument is given, the message will be
1460 marked as unread, i.e. the tag changes in
1461 `notmuch-show-mark-read-tags' will be reversed."
1462   (interactive "P")
1463   (when notmuch-show-mark-read-tags
1464     (apply 'notmuch-show-tag-message
1465            (notmuch-tag-change-list notmuch-show-mark-read-tags unread))))
1466
1467 ;; Functions for getting attributes of several messages in the current
1468 ;; thread.
1469
1470 (defun notmuch-show-get-message-ids-for-open-messages ()
1471   "Return a list of all id: queries for open messages in the current thread."
1472   (save-excursion
1473     (let (message-ids done)
1474       (goto-char (point-min))
1475       (while (not done)
1476         (if (notmuch-show-message-visible-p)
1477             (setq message-ids (append message-ids (list (notmuch-show-get-message-id)))))
1478         (setq done (not (notmuch-show-goto-message-next)))
1479         )
1480       message-ids
1481       )))
1482
1483 ;; Commands typically bound to keys.
1484
1485 (defun notmuch-show-advance ()
1486   "Advance through thread.
1487
1488 If the current message in the thread is not yet fully visible,
1489 scroll by a near screenful to read more of the message.
1490
1491 Otherwise, (the end of the current message is already within the
1492 current window), advance to the next open message."
1493   (interactive)
1494   (let* ((end-of-this-message (notmuch-show-message-bottom))
1495          (visible-end-of-this-message (1- end-of-this-message))
1496          (ret nil))
1497     (while (invisible-p visible-end-of-this-message)
1498       (setq visible-end-of-this-message
1499             (max (point-min)
1500                  (1- (previous-single-char-property-change
1501                       visible-end-of-this-message 'invisible)))))
1502     (cond
1503      ;; Ideally we would test `end-of-this-message' against the result
1504      ;; of `window-end', but that doesn't account for the fact that
1505      ;; the end of the message might be hidden.
1506      ((and visible-end-of-this-message
1507            (> visible-end-of-this-message (window-end)))
1508       ;; The bottom of this message is not visible - scroll.
1509       (scroll-up nil))
1510
1511      ((not (= end-of-this-message (point-max)))
1512       ;; This is not the last message - move to the next visible one.
1513       (notmuch-show-next-open-message))
1514
1515      ((not (= (point) (point-max)))
1516       ;; This is the last message, but the cursor is not at the end of
1517       ;; the buffer. Move it there.
1518       (goto-char (point-max)))
1519
1520      (t
1521       ;; This is the last message - change the return value
1522       (setq ret t)))
1523     ret))
1524
1525 (defun notmuch-show-advance-and-archive ()
1526   "Advance through thread and archive.
1527
1528 This command is intended to be one of the simplest ways to
1529 process a thread of email. It works exactly like
1530 notmuch-show-advance, in that it scrolls through messages in a
1531 show buffer, except that when it gets to the end of the buffer it
1532 archives the entire current thread, (apply changes in
1533 `notmuch-archive-tags'), kills the buffer, and displays the next
1534 thread from the search from which this thread was originally
1535 shown."
1536   (interactive)
1537   (if (notmuch-show-advance)
1538       (notmuch-show-archive-thread-then-next)))
1539
1540 (defun notmuch-show-rewind ()
1541   "Backup through the thread, (reverse scrolling compared to \\[notmuch-show-advance-and-archive]).
1542
1543 Specifically, if the beginning of the previous email is fewer
1544 than `window-height' lines from the current point, move to it
1545 just like `notmuch-show-previous-message'.
1546
1547 Otherwise, just scroll down a screenful of the current message.
1548
1549 This command does not modify any message tags, (it does not undo
1550 any effects from previous calls to
1551 `notmuch-show-advance-and-archive'."
1552   (interactive)
1553   (let ((start-of-message (notmuch-show-message-top))
1554         (start-of-window (window-start)))
1555     (cond
1556       ;; Either this message is properly aligned with the start of the
1557       ;; window or the start of this message is not visible on the
1558       ;; screen - scroll.
1559      ((or (= start-of-message start-of-window)
1560           (< start-of-message start-of-window))
1561       (scroll-down)
1562       ;; If a small number of lines from the previous message are
1563       ;; visible, realign so that the top of the current message is at
1564       ;; the top of the screen.
1565       (when (<= (count-screen-lines (window-start) start-of-message)
1566                 next-screen-context-lines)
1567         (goto-char (notmuch-show-message-top))
1568         (notmuch-show-message-adjust))
1569       ;; Move to the top left of the window.
1570       (goto-char (window-start)))
1571      (t
1572       ;; Move to the previous message.
1573       (notmuch-show-previous-message)))))
1574
1575 (defun notmuch-show-reply (&optional prompt-for-sender)
1576   "Reply to the sender and all recipients of the current message."
1577   (interactive "P")
1578   (notmuch-mua-new-reply (notmuch-show-get-message-id) prompt-for-sender t))
1579
1580 (defun notmuch-show-reply-sender (&optional prompt-for-sender)
1581   "Reply to the sender of the current message."
1582   (interactive "P")
1583   (notmuch-mua-new-reply (notmuch-show-get-message-id) prompt-for-sender nil))
1584
1585 (defun notmuch-show-forward-message (&optional prompt-for-sender)
1586   "Forward the current message."
1587   (interactive "P")
1588   (with-current-notmuch-show-message
1589    (notmuch-mua-new-forward-message prompt-for-sender)))
1590
1591 (defun notmuch-show-next-message (&optional pop-at-end)
1592   "Show the next message.
1593
1594 If a prefix argument is given and this is the last message in the
1595 thread, navigate to the next thread in the parent search buffer."
1596   (interactive "P")
1597   (if (notmuch-show-goto-message-next)
1598       (progn
1599         (notmuch-show-mark-read)
1600         (notmuch-show-message-adjust))
1601     (if pop-at-end
1602         (notmuch-show-next-thread)
1603       (goto-char (point-max)))))
1604
1605 (defun notmuch-show-previous-message ()
1606   "Show the previous message or the start of the current message."
1607   (interactive)
1608   (if (= (point) (notmuch-show-message-top))
1609       (notmuch-show-goto-message-previous)
1610     (notmuch-show-move-to-message-top))
1611   (notmuch-show-mark-read)
1612   (notmuch-show-message-adjust))
1613
1614 (defun notmuch-show-next-open-message (&optional pop-at-end)
1615   "Show the next open message.
1616
1617 If a prefix argument is given and this is the last open message
1618 in the thread, navigate to the next thread in the parent search
1619 buffer. Return t if there was a next open message in the thread
1620 to show, nil otherwise."
1621   (interactive "P")
1622   (let (r)
1623     (while (and (setq r (notmuch-show-goto-message-next))
1624                 (not (notmuch-show-message-visible-p))))
1625     (if r
1626         (progn
1627           (notmuch-show-mark-read)
1628           (notmuch-show-message-adjust))
1629       (if pop-at-end
1630           (notmuch-show-next-thread)
1631         (goto-char (point-max))))
1632     r))
1633
1634 (defun notmuch-show-next-matching-message ()
1635   "Show the next matching message."
1636   (interactive)
1637   (let (r)
1638     (while (and (setq r (notmuch-show-goto-message-next))
1639                 (not (notmuch-show-get-prop :match))))
1640     (if r
1641         (progn
1642           (notmuch-show-mark-read)
1643           (notmuch-show-message-adjust))
1644       (goto-char (point-max)))))
1645
1646 (defun notmuch-show-open-if-matched ()
1647   "Open a message if it is matched (whether or not excluded)."
1648   (let ((props (notmuch-show-get-message-properties)))
1649     (notmuch-show-message-visible props (plist-get props :match))))
1650
1651 (defun notmuch-show-goto-first-wanted-message ()
1652   "Move to the first open message and mark it read"
1653   (goto-char (point-min))
1654   (if (notmuch-show-message-visible-p)
1655       (notmuch-show-mark-read)
1656     (notmuch-show-next-open-message))
1657   (when (eobp)
1658     ;; There are no matched non-excluded messages so open all matched
1659     ;; (necessarily excluded) messages and go to the first.
1660     (notmuch-show-mapc 'notmuch-show-open-if-matched)
1661     (force-window-update)
1662     (goto-char (point-min))
1663     (if (notmuch-show-message-visible-p)
1664         (notmuch-show-mark-read)
1665       (notmuch-show-next-open-message))))
1666
1667 (defun notmuch-show-previous-open-message ()
1668   "Show the previous open message."
1669   (interactive)
1670   (while (and (if (= (point) (notmuch-show-message-top))
1671                   (notmuch-show-goto-message-previous)
1672                 (notmuch-show-move-to-message-top))
1673               (not (notmuch-show-message-visible-p))))
1674   (notmuch-show-mark-read)
1675   (notmuch-show-message-adjust))
1676
1677 (defun notmuch-show-view-raw-message ()
1678   "View the file holding the current message."
1679   (interactive)
1680   (let* ((id (notmuch-show-get-message-id))
1681          (buf (get-buffer-create (concat "*notmuch-raw-" id "*"))))
1682     (call-process notmuch-command nil buf nil "show" "--format=raw" id)
1683     (switch-to-buffer buf)
1684     (goto-char (point-min))
1685     (set-buffer-modified-p nil)
1686     (view-buffer buf 'kill-buffer-if-not-modified)))
1687
1688 (defun notmuch-show-pipe-message (entire-thread command)
1689   "Pipe the contents of the current message (or thread) to the given command.
1690
1691 The given command will be executed with the raw contents of the
1692 current email message as stdin. Anything printed by the command
1693 to stdout or stderr will appear in the *notmuch-pipe* buffer.
1694
1695 When invoked with a prefix argument, the command will receive all
1696 open messages in the current thread (formatted as an mbox) rather
1697 than only the current message."
1698   (interactive "P\nsPipe message to command: ")
1699   (let (shell-command)
1700     (if entire-thread
1701         (setq shell-command
1702               (concat notmuch-command " show --format=mbox --exclude=false "
1703                       (shell-quote-argument
1704                        (mapconcat 'identity (notmuch-show-get-message-ids-for-open-messages) " OR "))
1705                       " | " command))
1706       (setq shell-command
1707             (concat notmuch-command " show --format=raw "
1708                     (shell-quote-argument (notmuch-show-get-message-id)) " | " command)))
1709     (let ((buf (get-buffer-create (concat "*notmuch-pipe*"))))
1710       (with-current-buffer buf
1711         (setq buffer-read-only nil)
1712         (erase-buffer)
1713         (let ((exit-code (call-process-shell-command shell-command nil buf)))
1714           (goto-char (point-max))
1715           (set-buffer-modified-p nil)
1716           (setq buffer-read-only t)
1717           (unless (zerop exit-code)
1718             (switch-to-buffer-other-window buf)
1719             (message (format "Command '%s' exited abnormally with code %d"
1720                              shell-command exit-code))))))))
1721
1722 (defun notmuch-show-tag-message (&rest tag-changes)
1723   "Change tags for the current message.
1724
1725 TAG-CHANGES is a list of tag operations for `notmuch-tag'."
1726   (let* ((current-tags (notmuch-show-get-tags))
1727          (new-tags (notmuch-update-tags current-tags tag-changes)))
1728     (unless (equal current-tags new-tags)
1729       (notmuch-tag (notmuch-show-get-message-id) tag-changes)
1730       (notmuch-show-set-tags new-tags))))
1731
1732 (defun notmuch-show-tag (&optional tag-changes)
1733   "Change tags for the current message.
1734
1735 See `notmuch-tag' for information on the format of TAG-CHANGES."
1736   (interactive)
1737   (let* ((tag-changes (notmuch-tag (notmuch-show-get-message-id) tag-changes))
1738          (current-tags (notmuch-show-get-tags))
1739          (new-tags (notmuch-update-tags current-tags tag-changes)))
1740     (unless (equal current-tags new-tags)
1741       (notmuch-show-set-tags new-tags))))
1742
1743 (defun notmuch-show-tag-all (&optional tag-changes)
1744   "Change tags for all messages in the current show buffer.
1745
1746 See `notmuch-tag' for information on the format of TAG-CHANGES."
1747   (interactive)
1748   (setq tag-changes (notmuch-tag (notmuch-show-get-messages-ids-search) tag-changes))
1749   (notmuch-show-mapc
1750    (lambda ()
1751      (let* ((current-tags (notmuch-show-get-tags))
1752             (new-tags (notmuch-update-tags current-tags tag-changes)))
1753        (unless (equal current-tags new-tags)
1754          (notmuch-show-set-tags new-tags))))))
1755
1756 (defun notmuch-show-add-tag ()
1757   "Same as `notmuch-show-tag' but sets initial input to '+'."
1758   (interactive)
1759   (notmuch-show-tag "+"))
1760
1761 (defun notmuch-show-remove-tag ()
1762   "Same as `notmuch-show-tag' but sets initial input to '-'."
1763   (interactive)
1764   (notmuch-show-tag "-"))
1765
1766 (defun notmuch-show-toggle-visibility-headers ()
1767   "Toggle the visibility of the current message headers."
1768   (interactive)
1769   (let ((props (notmuch-show-get-message-properties)))
1770     (notmuch-show-headers-visible
1771      props
1772      (not (plist-get props :headers-visible))))
1773   (force-window-update))
1774
1775 (defun notmuch-show-toggle-message ()
1776   "Toggle the visibility of the current message."
1777   (interactive)
1778   (let ((props (notmuch-show-get-message-properties)))
1779     (notmuch-show-message-visible
1780      props
1781      (not (plist-get props :message-visible))))
1782   (force-window-update))
1783
1784 (defun notmuch-show-open-or-close-all ()
1785   "Set the visibility all of the messages in the current thread.
1786 By default make all of the messages visible. With a prefix
1787 argument, hide all of the messages."
1788   (interactive)
1789   (save-excursion
1790     (goto-char (point-min))
1791     (loop do (notmuch-show-message-visible (notmuch-show-get-message-properties)
1792                                            (not current-prefix-arg))
1793           until (not (notmuch-show-goto-message-next))))
1794   (force-window-update))
1795
1796 (defun notmuch-show-next-button ()
1797   "Advance point to the next button in the buffer."
1798   (interactive)
1799   (forward-button 1))
1800
1801 (defun notmuch-show-previous-button ()
1802   "Move point back to the previous button in the buffer."
1803   (interactive)
1804   (backward-button 1))
1805
1806 (defun notmuch-show-next-thread (&optional show previous)
1807   "Move to the next item in the search results, if any.
1808
1809 If SHOW is non-nil, open the next item in a show
1810 buffer. Otherwise just highlight the next item in the search
1811 buffer. If PREVIOUS is non-nil, move to the previous item in the
1812 search results instead."
1813   (interactive "P")
1814   (let ((parent-buffer notmuch-show-parent-buffer))
1815     (notmuch-kill-this-buffer)
1816     (when (buffer-live-p parent-buffer)
1817       (switch-to-buffer parent-buffer)
1818       (and (if previous
1819                (notmuch-search-previous-thread)
1820              (notmuch-search-next-thread))
1821            show
1822            (notmuch-search-show-thread)))))
1823
1824 (defun notmuch-show-next-thread-show ()
1825   "Show the next thread in the search results, if any."
1826   (interactive)
1827   (notmuch-show-next-thread t))
1828
1829 (defun notmuch-show-previous-thread-show ()
1830   "Show the previous thread in the search results, if any."
1831   (interactive)
1832   (notmuch-show-next-thread t t))
1833
1834 (defun notmuch-show-archive-thread (&optional unarchive)
1835   "Archive each message in thread.
1836
1837 Archive each message currently shown by applying the tag changes
1838 in `notmuch-archive-tags' to each. If a prefix argument is given,
1839 the messages will be \"unarchived\", i.e. the tag changes in
1840 `notmuch-archive-tags' will be reversed.
1841
1842 Note: This command is safe from any race condition of new messages
1843 being delivered to the same thread. It does not archive the
1844 entire thread, but only the messages shown in the current
1845 buffer."
1846   (interactive "P")
1847   (when notmuch-archive-tags
1848     (notmuch-show-tag-all
1849      (notmuch-tag-change-list notmuch-archive-tags unarchive))))
1850
1851 (defun notmuch-show-archive-thread-then-next ()
1852   "Archive all messages in the current buffer, then show next thread from search."
1853   (interactive)
1854   (notmuch-show-archive-thread)
1855   (notmuch-show-next-thread t))
1856
1857 (defun notmuch-show-archive-thread-then-exit ()
1858   "Archive all messages in the current buffer, then exit back to search results."
1859   (interactive)
1860   (notmuch-show-archive-thread)
1861   (notmuch-show-next-thread))
1862
1863 (defun notmuch-show-archive-message (&optional unarchive)
1864   "Archive the current message.
1865
1866 Archive the current message by applying the tag changes in
1867 `notmuch-archive-tags' to it. If a prefix argument is given, the
1868 message will be \"unarchived\", i.e. the tag changes in
1869 `notmuch-archive-tags' will be reversed."
1870   (interactive "P")
1871   (when notmuch-archive-tags
1872     (apply 'notmuch-show-tag-message
1873            (notmuch-tag-change-list notmuch-archive-tags unarchive))))
1874
1875 (defun notmuch-show-archive-message-then-next-or-exit ()
1876   "Archive the current message, then show the next open message in the current thread.
1877
1878 If at the last open message in the current thread, then exit back
1879 to search results."
1880   (interactive)
1881   (notmuch-show-archive-message)
1882   (notmuch-show-next-open-message t))
1883
1884 (defun notmuch-show-archive-message-then-next-or-next-thread ()
1885   "Archive the current message, then show the next open message in the current thread.
1886
1887 If at the last open message in the current thread, then show next
1888 thread from search."
1889   (interactive)
1890   (notmuch-show-archive-message)
1891   (unless (notmuch-show-next-open-message)
1892     (notmuch-show-next-thread t)))
1893
1894 (defun notmuch-show-stash-cc ()
1895   "Copy CC field of current message to kill-ring."
1896   (interactive)
1897   (notmuch-common-do-stash (notmuch-show-get-cc)))
1898
1899 (defun notmuch-show-stash-date ()
1900   "Copy date of current message to kill-ring."
1901   (interactive)
1902   (notmuch-common-do-stash (notmuch-show-get-date)))
1903
1904 (defun notmuch-show-stash-filename ()
1905   "Copy filename of current message to kill-ring."
1906   (interactive)
1907   (notmuch-common-do-stash (notmuch-show-get-filename)))
1908
1909 (defun notmuch-show-stash-from ()
1910   "Copy From address of current message to kill-ring."
1911   (interactive)
1912   (notmuch-common-do-stash (notmuch-show-get-from)))
1913
1914 (defun notmuch-show-stash-message-id (&optional stash-thread-id)
1915   "Copy id: query matching the current message to kill-ring.
1916
1917 If invoked with a prefix argument (or STASH-THREAD-ID is
1918 non-nil), copy thread: query matching the current thread to
1919 kill-ring."
1920   (interactive "P")
1921   (if stash-thread-id
1922       (notmuch-common-do-stash notmuch-show-thread-id)
1923     (notmuch-common-do-stash (notmuch-show-get-message-id))))
1924
1925 (defun notmuch-show-stash-message-id-stripped ()
1926   "Copy message ID of current message (sans `id:' prefix) to kill-ring."
1927   (interactive)
1928   (notmuch-common-do-stash (notmuch-show-get-message-id t)))
1929
1930 (defun notmuch-show-stash-subject ()
1931   "Copy Subject field of current message to kill-ring."
1932   (interactive)
1933   (notmuch-common-do-stash (notmuch-show-get-subject)))
1934
1935 (defun notmuch-show-stash-tags ()
1936   "Copy tags of current message to kill-ring as a comma separated list."
1937   (interactive)
1938   (notmuch-common-do-stash (mapconcat 'identity (notmuch-show-get-tags) ",")))
1939
1940 (defun notmuch-show-stash-to ()
1941   "Copy To address of current message to kill-ring."
1942   (interactive)
1943   (notmuch-common-do-stash (notmuch-show-get-to)))
1944
1945 (defun notmuch-show-stash-mlarchive-link (&optional mla)
1946   "Copy an ML Archive URI for the current message to the kill-ring.
1947
1948 This presumes that the message is available at the selected Mailing List Archive.
1949
1950 If optional argument MLA is non-nil, use the provided key instead of prompting
1951 the user (see `notmuch-show-stash-mlarchive-link-alist')."
1952   (interactive)
1953   (notmuch-common-do-stash
1954    (concat (cdr (assoc
1955                  (or mla
1956                      (let ((completion-ignore-case t))
1957                        (completing-read
1958                         "Mailing List Archive: "
1959                         notmuch-show-stash-mlarchive-link-alist
1960                         nil t nil nil notmuch-show-stash-mlarchive-link-default)))
1961                  notmuch-show-stash-mlarchive-link-alist))
1962            (notmuch-show-get-message-id t))))
1963
1964 (defun notmuch-show-stash-mlarchive-link-and-go (&optional mla)
1965   "Copy an ML Archive URI for the current message to the kill-ring and visit it.
1966
1967 This presumes that the message is available at the selected Mailing List Archive.
1968
1969 If optional argument MLA is non-nil, use the provided key instead of prompting
1970 the user (see `notmuch-show-stash-mlarchive-link-alist')."
1971   (interactive)
1972   (notmuch-show-stash-mlarchive-link mla)
1973   (browse-url (current-kill 0 t)))
1974
1975 ;; Interactive part functions and their helpers
1976
1977 (defun notmuch-show-generate-part-buffer (message-id nth)
1978   "Return a temporary buffer containing the specified part's content."
1979   (let ((buf (generate-new-buffer " *notmuch-part*"))
1980         (process-crypto notmuch-show-process-crypto))
1981     (with-current-buffer buf
1982       (setq notmuch-show-process-crypto process-crypto)
1983       ;; Always acquires the part via `notmuch part', even if it is
1984       ;; available in the JSON output.
1985       (insert (notmuch-get-bodypart-internal message-id nth notmuch-show-process-crypto)))
1986     buf))
1987
1988 (defun notmuch-show-current-part-handle ()
1989   "Return an mm-handle for the part containing point.
1990
1991 This creates a temporary buffer for the part's content; the
1992 caller is responsible for killing this buffer as appropriate."
1993   (let* ((part (notmuch-show-get-part-properties))
1994          (message-id (notmuch-show-get-message-id))
1995          (nth (plist-get part :id))
1996          (buf (notmuch-show-generate-part-buffer message-id nth))
1997          (content-type (plist-get part :content-type))
1998          (filename (plist-get part :filename))
1999          (disposition (if filename `(attachment (filename . ,filename)))))
2000     (mm-make-handle buf (list content-type) nil nil disposition)))
2001
2002 (defun notmuch-show-apply-to-current-part-handle (fn)
2003   "Apply FN to an mm-handle for the part containing point.
2004
2005 This ensures that the temporary buffer created for the mm-handle
2006 is destroyed when FN returns."
2007   (let ((handle (notmuch-show-current-part-handle)))
2008     (unwind-protect
2009         (funcall fn handle)
2010       (kill-buffer (mm-handle-buffer handle)))))
2011
2012 (defun notmuch-show-part-button-default (&optional button)
2013   (interactive)
2014   (let ((button (or button (button-at (point)))))
2015     (if (button-get button 'overlay)
2016         (notmuch-show-toggle-part-invisibility button)
2017       (call-interactively notmuch-show-part-button-default-action))))
2018
2019 (defun notmuch-show-save-part ()
2020   "Save the MIME part containing point to a file."
2021   (interactive)
2022   (notmuch-show-apply-to-current-part-handle #'mm-save-part))
2023
2024 (defun notmuch-show-view-part ()
2025   "View the MIME part containing point in an external viewer."
2026   (interactive)
2027   ;; Set mm-inlined-types to nil to force an external viewer
2028   (let ((mm-inlined-types nil))
2029     (notmuch-show-apply-to-current-part-handle #'mm-display-part)))
2030
2031 (defun notmuch-show-interactively-view-part ()
2032   "View the MIME part containing point, prompting for a viewer."
2033   (interactive)
2034   (notmuch-show-apply-to-current-part-handle #'mm-interactively-view-part))
2035
2036 (defun notmuch-show-pipe-part ()
2037   "Pipe the MIME part containing point to an external command."
2038   (interactive)
2039   (notmuch-show-apply-to-current-part-handle #'mm-pipe-part))
2040
2041
2042 (provide 'notmuch-show)