git.notmuchmail.org Git - notmuch/blob - 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   'keymap 'notmuch-show-part-button-map
 470   'follow-link t
 471   'face 'message-mml
 472   :supertype 'notmuch-button-type)
 473
 474 (defvar notmuch-show-part-button-map
 475   (let ((map (make-sparse-keymap)))
 476     (set-keymap-parent map button-map)
 477     (define-key map "s" 'notmuch-show-part-button-save)
 478     (define-key map "v" 'notmuch-show-part-button-view)
 479     (define-key map "o" 'notmuch-show-part-button-interactively-view)
 480     (define-key map "|" 'notmuch-show-part-button-pipe)
 481     map)
 482   "Submap for button commands")
 483 (fset 'notmuch-show-part-button-map notmuch-show-part-button-map)
 484
 485 (defun notmuch-show-insert-part-header (nth content-type declared-type &optional name comment)
 486   (let ((button)
 487         (base-label (concat (when name (concat name ": "))
 488                             declared-type
 489                             (unless (string-equal declared-type content-type)
 490                               (concat " (as " content-type ")"))
 491                             comment)))
 492
 493     (setq button
 494           (insert-button
 495            (concat "[ " base-label " ]")
 496            :base-label base-label
 497            :type 'notmuch-show-part-button-type
 498            :notmuch-part nth
 499            :notmuch-filename name
 500            :notmuch-content-type content-type))
 501     (insert "\n")
 502     ;; return button
 503     button))
 504
 505 ;; Functions handling particular MIME parts.
 506
 507 (defmacro notmuch-with-temp-part-buffer (message-id nth &rest body)
 508   (declare (indent 2))
 509   (let ((process-crypto (make-symbol "process-crypto")))
 510     `(let ((,process-crypto notmuch-show-process-crypto))
 511        (with-temp-buffer
 512          (setq notmuch-show-process-crypto ,process-crypto)
 513          ;; Always acquires the part via `notmuch part', even if it is
 514          ;; available in the JSON output.
 515          (insert (notmuch-get-bodypart-internal ,message-id ,nth notmuch-show-process-crypto))
 516          ,@body))))
 517
 518 (defun notmuch-show-save-part (message-id nth &optional filename content-type)
 519   (notmuch-with-temp-part-buffer message-id nth
 520     (let ((file (read-file-name
 521                  "Filename to save as: "
 522                  (or mailcap-download-directory "~/")
 523                  nil nil
 524                  filename)))
 525       ;; Don't re-compress .gz & al.  Arguably we should make
 526       ;; `file-name-handler-alist' nil, but that would chop
 527       ;; ange-ftp, which is reasonable to use here.
 528       (mm-write-region (point-min) (point-max) file nil nil nil 'no-conversion t))))
 529
 530 (defun notmuch-show-view-part (message-id nth &optional filename content-type )
 531   (notmuch-with-temp-part-buffer message-id nth
 532     (let* ((disposition (if filename `(attachment (filename . ,filename))))
 533            (handle (mm-make-handle (current-buffer) (list content-type)
 534                                    nil nil disposition))
 535            ;; Set the default save directory to be consistent with
 536            ;; `notmuch-show-save-part'.
 537            (mm-default-directory (or mailcap-download-directory "~/"))
 538            ;; set mm-inlined-types to nil to force an external viewer
 539            (mm-inlined-types nil))
 540       (mm-display-part handle))))
 541
 542 (defun notmuch-show-interactively-view-part (message-id nth &optional filename content-type)
 543   (notmuch-with-temp-part-buffer message-id nth
 544     (let ((handle (mm-make-handle (current-buffer) (list content-type))))
 545       (mm-interactively-view-part handle))))
 546
 547 (defun notmuch-show-pipe-part (message-id nth &optional filename content-type)
 548   (notmuch-with-temp-part-buffer message-id nth
 549     (let ((handle (mm-make-handle (current-buffer) (list content-type))))
 550       (mm-pipe-part handle))))
 551
 552 ;; This is taken from notmuch-wash: maybe it should be unified?
 553 (defun notmuch-show-toggle-part-invisibility (&optional button)
 554   (interactive)
 555   (let* ((button (or button (button-at (point))))
 556          (overlay (button-get button 'overlay)))
 557     (when overlay
 558       (let* ((show (overlay-get overlay 'invisible))
 559              (new-start (button-start button))
 560              (button-label (button-get button :base-label))
 561              (old-point (point))
 562              (properties (text-properties-at (point)))
 563              (inhibit-read-only t))
 564         (overlay-put overlay 'invisible (not show))
 565         (goto-char new-start)
 566         (insert "[ " button-label (if show " ]" " (hidden) ]"))
 567         (set-text-properties new-start (point) properties)
 568         (let ((old-end (button-end button)))
 569           (move-overlay button new-start (point))
 570           (delete-region (point) old-end))
 571         (goto-char (min old-point (1- (button-end button))))))))
 572
 573 (defun notmuch-show-multipart/*-to-list (part)
 574   (mapcar (lambda (inner-part) (plist-get inner-part :content-type))
 575           (plist-get part :content)))
 576
 577 (defun notmuch-show-insert-part-multipart/alternative (msg part content-type nth depth declared-type)
 578   (notmuch-show-insert-part-header nth declared-type content-type nil)
 579   (let ((chosen-type (car (notmuch-multipart/alternative-choose (notmuch-show-multipart/*-to-list part))))
 580         (inner-parts (plist-get part :content))
 581         (start (point)))
 582     ;; This inserts all parts of the chosen type rather than just one,
 583     ;; but it's not clear that this is the wrong thing to do - which
 584     ;; should be chosen if there are more than one that match?
 585     (mapc (lambda (inner-part)
 586             (let* ((inner-type (plist-get inner-part :content-type))
 587                   (hide (not (or notmuch-show-all-multipart/alternative-parts
 588                            (string= chosen-type inner-type)))))
 589               (notmuch-show-insert-bodypart msg inner-part depth hide)))
 590           inner-parts)
 591
 592     (when notmuch-show-indent-multipart
 593       (indent-rigidly start (point) 1)))
 594   t)
 595
 596 (defun notmuch-show-setup-w3m ()
 597   "Instruct w3m how to retrieve content from a \"related\" part of a message."
 598   (interactive)
 599   (if (boundp 'w3m-cid-retrieve-function-alist)
 600     (unless (assq 'notmuch-show-mode w3m-cid-retrieve-function-alist)
 601       (push (cons 'notmuch-show-mode 'notmuch-show-w3m-cid-retrieve)
 602             w3m-cid-retrieve-function-alist)))
 603   (setq mm-inline-text-html-with-images t))
 604
 605 (defvar w3m-current-buffer) ;; From `w3m.el'.
 606 (defvar notmuch-show-w3m-cid-store nil)
 607 (make-variable-buffer-local 'notmuch-show-w3m-cid-store)
 608
 609 (defun notmuch-show-w3m-cid-store-internal (content-id
 610                                             message-id
 611                                             part-number
 612                                             content-type
 613                                             content)
 614   (push (list content-id
 615               message-id
 616               part-number
 617               content-type
 618               content)
 619         notmuch-show-w3m-cid-store))
 620
 621 (defun notmuch-show-w3m-cid-store (msg part)
 622   (let ((content-id (plist-get part :content-id)))
 623     (when content-id
 624       (notmuch-show-w3m-cid-store-internal (concat "cid:" content-id)
 625                                            (plist-get msg :id)
 626                                            (plist-get part :id)
 627                                            (plist-get part :content-type)
 628                                            nil))))
 629
 630 (defun notmuch-show-w3m-cid-retrieve (url &rest args)
 631   (let ((matching-part (with-current-buffer w3m-current-buffer
 632                          (assoc url notmuch-show-w3m-cid-store))))
 633     (if matching-part
 634         (let ((message-id (nth 1 matching-part))
 635               (part-number (nth 2 matching-part))
 636               (content-type (nth 3 matching-part))
 637               (content (nth 4 matching-part)))
 638           ;; If we don't already have the content, get it and cache
 639           ;; it, as some messages reference the same cid: part many
 640           ;; times (hundreds!), which results in many calls to
 641           ;; `notmuch part'.
 642           (unless content
 643             (setq content (notmuch-get-bodypart-internal (notmuch-id-to-query message-id)
 644                                                               part-number notmuch-show-process-crypto))
 645             (with-current-buffer w3m-current-buffer
 646               (notmuch-show-w3m-cid-store-internal url
 647                                                    message-id
 648                                                    part-number
 649                                                    content-type
 650                                                    content)))
 651           (insert content)
 652           content-type)
 653       nil)))
 654
 655 (defun notmuch-show-insert-part-multipart/related (msg part content-type nth depth declared-type)
 656   (notmuch-show-insert-part-header nth declared-type content-type nil)
 657   (let ((inner-parts (plist-get part :content))
 658         (start (point)))
 659
 660     ;; We assume that the first part is text/html and the remainder
 661     ;; things that it references.
 662
 663     ;; Stash the non-primary parts.
 664     (mapc (lambda (part)
 665             (notmuch-show-w3m-cid-store msg part))
 666           (cdr inner-parts))
 667
 668     ;; Render the primary part.
 669     (notmuch-show-insert-bodypart msg (car inner-parts) depth)
 670
 671     (when notmuch-show-indent-multipart
 672       (indent-rigidly start (point) 1)))
 673   t)
 674
 675 (defun notmuch-show-insert-part-multipart/signed (msg part content-type nth depth declared-type)
 676   (let ((button (notmuch-show-insert-part-header nth declared-type content-type nil)))
 677     (button-put button 'face 'notmuch-crypto-part-header)
 678     ;; add signature status button if sigstatus provided
 679     (if (plist-member part :sigstatus)
 680         (let* ((from (notmuch-show-get-header :From msg))
 681                (sigstatus (car (plist-get part :sigstatus))))
 682           (notmuch-crypto-insert-sigstatus-button sigstatus from))
 683       ;; if we're not adding sigstatus, tell the user how they can get it
 684       (button-put button 'help-echo "Set notmuch-crypto-process-mime to process cryptographic MIME parts.")))
 685
 686   (let ((inner-parts (plist-get part :content))
 687         (start (point)))
 688     ;; Show all of the parts.
 689     (mapc (lambda (inner-part)
 690             (notmuch-show-insert-bodypart msg inner-part depth))
 691           inner-parts)
 692
 693     (when notmuch-show-indent-multipart
 694       (indent-rigidly start (point) 1)))
 695   t)
 696
 697 (defun notmuch-show-insert-part-multipart/encrypted (msg part content-type nth depth declared-type)
 698   (let ((button (notmuch-show-insert-part-header nth declared-type content-type nil)))
 699     (button-put button 'face 'notmuch-crypto-part-header)
 700     ;; add encryption status button if encstatus specified
 701     (if (plist-member part :encstatus)
 702         (let ((encstatus (car (plist-get part :encstatus))))
 703           (notmuch-crypto-insert-encstatus-button encstatus)
 704           ;; add signature status button if sigstatus specified
 705           (if (plist-member part :sigstatus)
 706               (let* ((from (notmuch-show-get-header :From msg))
 707                      (sigstatus (car (plist-get part :sigstatus))))
 708                 (notmuch-crypto-insert-sigstatus-button sigstatus from))))
 709       ;; if we're not adding encstatus, tell the user how they can get it
 710       (button-put button 'help-echo "Set notmuch-crypto-process-mime to process cryptographic MIME parts.")))
 711
 712   (let ((inner-parts (plist-get part :content))
 713         (start (point)))
 714     ;; Show all of the parts.
 715     (mapc (lambda (inner-part)
 716             (notmuch-show-insert-bodypart msg inner-part depth))
 717           inner-parts)
 718
 719     (when notmuch-show-indent-multipart
 720       (indent-rigidly start (point) 1)))
 721   t)
 722
 723 (defun notmuch-show-insert-part-multipart/* (msg part content-type nth depth declared-type)
 724   (notmuch-show-insert-part-header nth declared-type content-type nil)
 725   (let ((inner-parts (plist-get part :content))
 726         (start (point)))
 727     ;; Show all of the parts.
 728     (mapc (lambda (inner-part)
 729             (notmuch-show-insert-bodypart msg inner-part depth))
 730           inner-parts)
 731
 732     (when notmuch-show-indent-multipart
 733       (indent-rigidly start (point) 1)))
 734   t)
 735
 736 (defun notmuch-show-insert-part-message/rfc822 (msg part content-type nth depth declared-type)
 737   (notmuch-show-insert-part-header nth declared-type content-type nil)
 738   (let* ((message (car (plist-get part :content)))
 739          (body (car (plist-get message :body)))
 740          (start (point)))
 741
 742     ;; Override `notmuch-message-headers' to force `From' to be
 743     ;; displayed.
 744     (let ((notmuch-message-headers '("From" "Subject" "To" "Cc" "Date")))
 745       (notmuch-show-insert-headers (plist-get message :headers)))
 746
 747     ;; Blank line after headers to be compatible with the normal
 748     ;; message display.
 749     (insert "\n")
 750
 751     ;; Show the body
 752     (notmuch-show-insert-bodypart msg body depth)
 753
 754     (when notmuch-show-indent-multipart
 755       (indent-rigidly start (point) 1)))
 756   t)
 757
 758 (defun notmuch-show-insert-part-text/plain (msg part content-type nth depth declared-type)
 759   (let ((start (point)))
 760     ;; If this text/plain part is not the first part in the message,
 761     ;; insert a header to make this clear.
 762     (if (> nth 1)
 763         (notmuch-show-insert-part-header nth declared-type content-type (plist-get part :filename)))
 764     (insert (notmuch-get-bodypart-content msg part nth notmuch-show-process-crypto))
 765     (save-excursion
 766       (save-restriction
 767         (narrow-to-region start (point-max))
 768         (run-hook-with-args 'notmuch-show-insert-text/plain-hook msg depth))))
 769   t)
 770
 771 (defun notmuch-show-insert-part-text/calendar (msg part content-type nth depth declared-type)
 772   (notmuch-show-insert-part-header nth declared-type content-type (plist-get part :filename))
 773   (insert (with-temp-buffer
 774             (insert (notmuch-get-bodypart-content msg part nth notmuch-show-process-crypto))
 775             ;; notmuch-get-bodypart-content provides "raw", non-converted
 776             ;; data. Replace CRLF with LF before icalendar can use it.
 777             (goto-char (point-min))
 778             (while (re-search-forward "\r\n" nil t)
 779               (replace-match "\n" nil nil))
 780             (let ((file (make-temp-file "notmuch-ical"))
 781                   result)
 782               (unwind-protect
 783                   (progn
 784                     (unless (icalendar-import-buffer file t)
 785                       (error "Icalendar import error. See *icalendar-errors* for more information"))
 786                     (set-buffer (get-file-buffer file))
 787                     (setq result (buffer-substring (point-min) (point-max)))
 788                     (set-buffer-modified-p nil)
 789                     (kill-buffer (current-buffer)))
 790                 (delete-file file))
 791               result)))
 792   t)
 793
 794 ;; For backwards compatibility.
 795 (defun notmuch-show-insert-part-text/x-vcalendar (msg part content-type nth depth declared-type)
 796   (notmuch-show-insert-part-text/calendar msg part content-type nth depth declared-type))
 797
 798 (defun notmuch-show-get-mime-type-of-application/octet-stream (part)
 799   ;; If we can deduce a MIME type from the filename of the attachment,
 800   ;; we return that.
 801   (if (plist-get part :filename)
 802       (let ((extension (file-name-extension (plist-get part :filename)))
 803             mime-type)
 804         (if extension
 805             (progn
 806               (mailcap-parse-mimetypes)
 807               (setq mime-type (mailcap-extension-to-mime extension))
 808               (if (and mime-type
 809                        (not (string-equal mime-type "application/octet-stream")))
 810                   mime-type
 811                 nil))
 812           nil))))
 813
 814 ;; Handler for wash generated inline patch fake parts.
 815 (defun notmuch-show-insert-part-inline-patch-fake-part (msg part content-type nth depth declared-type)
 816   (notmuch-show-insert-part-*/* msg part content-type nth depth declared-type))
 817
 818 (defun notmuch-show-insert-part-text/html (msg part content-type nth depth declared-type)
 819   ;; text/html handler to work around bugs in renderers and our
 820   ;; invisibile parts code. In particular w3m sets up a keymap which
 821   ;; "leaks" outside the invisible region and causes strange effects
 822   ;; in notmuch. We set mm-inline-text-html-with-w3m-keymap to nil to
 823   ;; tell w3m not to set a keymap (so the normal notmuch-show-mode-map
 824   ;; remains).
 825   (let ((mm-inline-text-html-with-w3m-keymap nil))
 826     (notmuch-show-insert-part-*/* msg part content-type nth depth declared-type)))
 827
 828 (defun notmuch-show-insert-part-*/* (msg part content-type nth depth declared-type)
 829   ;; This handler _must_ succeed - it is the handler of last resort.
 830   (notmuch-show-insert-part-header nth content-type declared-type (plist-get part :filename))
 831   (notmuch-mm-display-part-inline msg part nth content-type notmuch-show-process-crypto)
 832   t)
 833
 834 ;; Functions for determining how to handle MIME parts.
 835
 836 (defun notmuch-show-handlers-for (content-type)
 837   "Return a list of content handlers for a part of type CONTENT-TYPE."
 838   (let (result)
 839     (mapc (lambda (func)
 840             (if (functionp func)
 841                 (push func result)))
 842           ;; Reverse order of prefrence.
 843           (list (intern (concat "notmuch-show-insert-part-*/*"))
 844                 (intern (concat
 845                          "notmuch-show-insert-part-"
 846                          (car (notmuch-split-content-type content-type))
 847                          "/*"))
 848                 (intern (concat "notmuch-show-insert-part-" content-type))))
 849     result))
 850
 851 ;; \f
 852
 853 (defun notmuch-show-insert-bodypart-internal (msg part content-type nth depth declared-type)
 854   (let ((handlers (notmuch-show-handlers-for content-type)))
 855     ;; Run the content handlers until one of them returns a non-nil
 856     ;; value.
 857     (while (and handlers
 858                 (not (condition-case err
 859                          (funcall (car handlers) msg part content-type nth depth declared-type)
 860                        (error (progn
 861                                 (insert "!!! Bodypart insert error: ")
 862                                 (insert (error-message-string err))
 863                                 (insert " !!!\n") nil)))))
 864       (setq handlers (cdr handlers))))
 865   t)
 866
 867 (defun notmuch-show-create-part-overlays (msg beg end hide)
 868   "Add an overlay to the part between BEG and END"
 869   (let* ((button (button-at beg))
 870          (part-beg (and button (1+ (button-end button)))))
 871
 872     ;; If the part contains no text we do not make it toggleable. We
 873     ;; also need to check that the button is a genuine part button not
 874     ;; a notmuch-wash button.
 875     (when (and button (/= part-beg end) (button-get button :base-label))
 876       (button-put button 'overlay (make-overlay part-beg end))
 877       ;; We toggle the button for hidden parts as that gets the
 878       ;; button label right.
 879       (save-excursion
 880         (when hide
 881           (notmuch-show-toggle-part-invisibility button))))))
 882
 883 (defun notmuch-show-insert-bodypart (msg part depth &optional hide)
 884   "Insert the body part PART at depth DEPTH in the current thread.
 885
 886 If HIDE is non-nil then initially hide this part."
 887   (let* ((content-type (downcase (plist-get part :content-type)))
 888          (mime-type (or (and (string= content-type "application/octet-stream")
 889                              (notmuch-show-get-mime-type-of-application/octet-stream part))
 890                         (and (string= content-type "inline patch")
 891                              "text/x-diff")
 892                         content-type))
 893          (nth (plist-get part :id))
 894          (beg (point)))
 895
 896     (notmuch-show-insert-bodypart-internal msg part mime-type nth depth content-type)
 897     ;; Some of the body part handlers leave point somewhere up in the
 898     ;; part, so we make sure that we're down at the end.
 899     (goto-char (point-max))
 900     ;; Ensure that the part ends with a carriage return.
 901     (unless (bolp)
 902       (insert "\n"))
 903     (notmuch-show-create-part-overlays msg beg (point) hide)))
 904
 905 (defun notmuch-show-insert-body (msg body depth)
 906   "Insert the body BODY at depth DEPTH in the current thread."
 907   (mapc (lambda (part) (notmuch-show-insert-bodypart msg part depth)) body))
 908
 909 (defun notmuch-show-make-symbol (type)
 910   (make-symbol (concat "notmuch-show-" type)))
 911
 912 (defun notmuch-show-strip-re (string)
 913   (replace-regexp-in-string "^\\([Rr]e: *\\)+" "" string))
 914
 915 (defvar notmuch-show-previous-subject "")
 916 (make-variable-buffer-local 'notmuch-show-previous-subject)
 917
 918 (defun notmuch-show-insert-msg (msg depth)
 919   "Insert the message MSG at depth DEPTH in the current thread."
 920   (let* ((headers (plist-get msg :headers))
 921          ;; Indentation causes the buffer offset of the start/end
 922          ;; points to move, so we must use markers.
 923          message-start message-end
 924          content-start content-end
 925          headers-start headers-end
 926          (bare-subject (notmuch-show-strip-re (plist-get headers :Subject))))
 927
 928     (setq message-start (point-marker))
 929
 930     (notmuch-show-insert-headerline headers
 931                                     (or (if notmuch-show-relative-dates
 932                                             (plist-get msg :date_relative)
 933                                           nil)
 934                                         (plist-get headers :Date))
 935                                     (plist-get msg :tags) depth)
 936
 937     (setq content-start (point-marker))
 938
 939     ;; Set `headers-start' to point after the 'Subject:' header to be
 940     ;; compatible with the existing implementation. This just sets it
 941     ;; to after the first header.
 942     (notmuch-show-insert-headers headers)
 943     (save-excursion
 944       (goto-char content-start)
 945       ;; If the subject of this message is the same as that of the
 946       ;; previous message, don't display it when this message is
 947       ;; collapsed.
 948       (when (not (string= notmuch-show-previous-subject
 949                           bare-subject))
 950         (forward-line 1))
 951       (setq headers-start (point-marker)))
 952     (setq headers-end (point-marker))
 953
 954     (setq notmuch-show-previous-subject bare-subject)
 955
 956     ;; A blank line between the headers and the body.
 957     (insert "\n")
 958     (notmuch-show-insert-body msg (plist-get msg :body)
 959                               (if notmuch-show-indent-content depth 0))
 960     ;; Ensure that the body ends with a newline.
 961     (unless (bolp)
 962       (insert "\n"))
 963     (setq content-end (point-marker))
 964
 965     ;; Indent according to the depth in the thread.
 966     (if notmuch-show-indent-content
 967         (indent-rigidly content-start content-end (* notmuch-show-indent-messages-width depth)))
 968
 969     (setq message-end (point-max-marker))
 970
 971     ;; Save the extents of this message over the whole text of the
 972     ;; message.
 973     (put-text-property message-start message-end :notmuch-message-extent (cons message-start message-end))
 974
 975     ;; Create overlays used to control visibility
 976     (plist-put msg :headers-overlay (make-overlay headers-start headers-end))
 977     (plist-put msg :message-overlay (make-overlay headers-start content-end))
 978
 979     (plist-put msg :depth depth)
 980
 981     ;; Save the properties for this message. Currently this saves the
 982     ;; entire message (augmented it with other stuff), which seems
 983     ;; like overkill. We might save a reduced subset (for example, not
 984     ;; the content).
 985     (notmuch-show-set-message-properties msg)
 986
 987     ;; Set header visibility.
 988     (notmuch-show-headers-visible msg notmuch-message-headers-visible)
 989
 990     ;; Message visibility depends on whether it matched the search
 991     ;; criteria.
 992     (notmuch-show-message-visible msg (and (plist-get msg :match)
 993                                            (not (plist-get msg :excluded))))))
 994
 995 (defun notmuch-show-toggle-process-crypto ()
 996   "Toggle the processing of cryptographic MIME parts."
 997   (interactive)
 998   (setq notmuch-show-process-crypto (not notmuch-show-process-crypto))
 999   (message (if notmuch-show-process-crypto
1000                "Processing cryptographic MIME parts."
1001              "Not processing cryptographic MIME parts."))
1002   (notmuch-show-refresh-view))
1003
1004 (defun notmuch-show-toggle-elide-non-matching ()
1005   "Toggle the display of non-matching messages."
1006   (interactive)
1007   (setq notmuch-show-elide-non-matching-messages (not notmuch-show-elide-non-matching-messages))
1008   (message (if notmuch-show-elide-non-matching-messages
1009                "Showing matching messages only."
1010              "Showing all messages."))
1011   (notmuch-show-refresh-view))
1012
1013 (defun notmuch-show-toggle-thread-indentation ()
1014   "Toggle the indentation of threads."
1015   (interactive)
1016   (setq notmuch-show-indent-content (not notmuch-show-indent-content))
1017   (message (if notmuch-show-indent-content
1018                "Content is indented."
1019              "Content is not indented."))
1020   (notmuch-show-refresh-view))
1021
1022 (defun notmuch-show-insert-tree (tree depth)
1023   "Insert the message tree TREE at depth DEPTH in the current thread."
1024   (let ((msg (car tree))
1025         (replies (cadr tree)))
1026     ;; We test whether there is a message or just some replies.
1027     (when msg
1028       (notmuch-show-insert-msg msg depth))
1029     (notmuch-show-insert-thread replies (1+ depth))))
1030
1031 (defun notmuch-show-insert-thread (thread depth)
1032   "Insert the thread THREAD at depth DEPTH in the current forest."
1033   (mapc (lambda (tree) (notmuch-show-insert-tree tree depth)) thread))
1034
1035 (defun notmuch-show-insert-forest (forest)
1036   "Insert the forest of threads FOREST."
1037   (mapc (lambda (thread) (notmuch-show-insert-thread thread 0)) forest))
1038
1039 (defvar notmuch-id-regexp
1040   (concat
1041    ;; Match the id: prefix only if it begins a word (to disallow, for
1042    ;; example, matching cid:).
1043    "\\<id:\\("
1044    ;; If the term starts with a ", then parse Xapian's quoted boolean
1045    ;; term syntax, which allows for anything as long as embedded
1046    ;; double quotes escaped by doubling them.  We also disallow
1047    ;; newlines (which Xapian allows) to prevent runaway terms.
1048    "\"\\([^\"\n]\\|\"\"\\)*\""
1049    ;; Otherwise, parse Xapian's unquoted syntax, which goes up to the
1050    ;; next space or ).  We disallow [.,;] as the last character
1051    ;; because these are probably part of the surrounding text, and not
1052    ;; part of the id.  This doesn't match single character ids; meh.
1053    "\\|[^\"[:space:])][^[:space:])]*[^])[:space:].,:;?!]"
1054    "\\)")
1055   "The regexp used to match id: links in messages.")
1056
1057 (defvar notmuch-mid-regexp
1058   ;; goto-address-url-regexp matched cid: links, which have the same
1059   ;; grammar as the message ID part of a mid: link.  Construct the
1060   ;; regexp using the same technique as goto-address-url-regexp.
1061   (concat "\\<mid:\\(" thing-at-point-url-path-regexp "\\)")
1062   "The regexp used to match mid: links in messages.
1063
1064 See RFC 2392.")
1065
1066 (defun notmuch-show-buttonise-links (start end)
1067   "Buttonise URLs and mail addresses between START and END.
1068
1069 This also turns id:\"<message id>\"-parts and mid: links into
1070 buttons for a corresponding notmuch search."
1071   (goto-address-fontify-region start end)
1072   (save-excursion
1073     (let (links)
1074       (goto-char start)
1075       (while (re-search-forward notmuch-id-regexp end t)
1076         (push (list (match-beginning 0) (match-end 0)
1077                     (match-string-no-properties 0)) links))
1078       (goto-char start)
1079       (while (re-search-forward notmuch-mid-regexp end t)
1080         (let* ((mid-cid (match-string-no-properties 1))
1081                (mid (save-match-data
1082                       (string-match "^[^/]*" mid-cid)
1083                       (url-unhex-string (match-string 0 mid-cid)))))
1084           (push (list (match-beginning 0) (match-end 0)
1085                       (notmuch-id-to-query mid)) links)))
1086       (dolist (link links)
1087         ;; Remove the overlay created by goto-address-mode
1088         (remove-overlays (first link) (second link) 'goto-address t)
1089         (make-text-button (first link) (second link)
1090                           :type 'notmuch-button-type
1091                           'action `(lambda (arg)
1092                                      (notmuch-show ,(third link)))
1093                           'follow-link t
1094                           'help-echo "Mouse-1, RET: search for this message"
1095                           'face goto-address-mail-face)))))
1096
1097 ;;;###autoload
1098 (defun notmuch-show (thread-id &optional parent-buffer query-context buffer-name)
1099   "Run \"notmuch show\" with the given thread ID and display results.
1100
1101 The optional PARENT-BUFFER is the notmuch-search buffer from
1102 which this notmuch-show command was executed, (so that the
1103 next thread from that buffer can be show when done with this
1104 one).
1105
1106 The optional QUERY-CONTEXT is a notmuch search term. Only
1107 messages from the thread matching this search term are shown if
1108 non-nil.
1109
1110 The optional BUFFER-NAME provides the name of the buffer in
1111 which the message thread is shown. If it is nil (which occurs
1112 when the command is called interactively) the argument to the
1113 function is used."
1114   (interactive "sNotmuch show: ")
1115   (let ((buffer-name (generate-new-buffer-name
1116                       (or buffer-name
1117                           (concat "*notmuch-" thread-id "*")))))
1118     (switch-to-buffer (get-buffer-create buffer-name))
1119     ;; Set the default value for `notmuch-show-process-crypto' in this
1120     ;; buffer.
1121     (setq notmuch-show-process-crypto notmuch-crypto-process-mime)
1122     ;; Set the default value for
1123     ;; `notmuch-show-elide-non-matching-messages' in this buffer. If
1124     ;; there is a prefix argument, invert the default.
1125     (setq notmuch-show-elide-non-matching-messages notmuch-show-only-matching-messages)
1126     (if current-prefix-arg
1127         (setq notmuch-show-elide-non-matching-messages (not notmuch-show-elide-non-matching-messages)))
1128
1129     (setq notmuch-show-thread-id thread-id
1130           notmuch-show-parent-buffer parent-buffer
1131           notmuch-show-query-context query-context)
1132     (notmuch-show-build-buffer)
1133     (notmuch-show-goto-first-wanted-message)
1134     (current-buffer)))
1135
1136 (defun notmuch-show-build-buffer ()
1137   (let ((inhibit-read-only t))
1138
1139     (notmuch-show-mode)
1140     ;; Don't track undo information for this buffer
1141     (set 'buffer-undo-list t)
1142
1143     (erase-buffer)
1144     (goto-char (point-min))
1145     (save-excursion
1146       (let* ((basic-args (list notmuch-show-thread-id))
1147              (args (if notmuch-show-query-context
1148                        (append (list "\'") basic-args
1149                                (list "and (" notmuch-show-query-context ")\'"))
1150                      (append (list "\'") basic-args (list "\'"))))
1151              (cli-args (cons "--exclude=false"
1152                              (when notmuch-show-elide-non-matching-messages
1153                                (list "--entire-thread=false")))))
1154
1155         (notmuch-show-insert-forest (notmuch-query-get-threads (append cli-args args)))
1156         ;; If the query context reduced the results to nothing, run
1157         ;; the basic query.
1158         (when (and (eq (buffer-size) 0)
1159                    notmuch-show-query-context)
1160           (notmuch-show-insert-forest
1161            (notmuch-query-get-threads (append cli-args basic-args)))))
1162
1163       (jit-lock-register #'notmuch-show-buttonise-links)
1164
1165       ;; Set the header line to the subject of the first message.
1166       (setq header-line-format (notmuch-show-strip-re (notmuch-show-get-subject)))
1167
1168       (run-hooks 'notmuch-show-hook))))
1169
1170 (defun notmuch-show-capture-state ()
1171   "Capture the state of the current buffer.
1172
1173 This includes:
1174  - the list of open messages,
1175  - the current message."
1176   (list (notmuch-show-get-message-id) (notmuch-show-get-message-ids-for-open-messages)))
1177
1178 (defun notmuch-show-apply-state (state)
1179   "Apply STATE to the current buffer.
1180
1181 This includes:
1182  - opening the messages previously opened,
1183  - closing all other messages,
1184  - moving to the correct current message."
1185   (let ((current (car state))
1186         (open (cadr state)))
1187
1188     ;; Open those that were open.
1189     (goto-char (point-min))
1190     (loop do (notmuch-show-message-visible (notmuch-show-get-message-properties)
1191                                            (member (notmuch-show-get-message-id) open))
1192           until (not (notmuch-show-goto-message-next)))
1193
1194     ;; Go to the previously open message.
1195     (goto-char (point-min))
1196     (unless (loop if (string= current (notmuch-show-get-message-id))
1197                   return t
1198                   until (not (notmuch-show-goto-message-next)))
1199       (goto-char (point-min))
1200       (message "Previously current message not found."))
1201     (notmuch-show-message-adjust)))
1202
1203 (defun notmuch-show-refresh-view (&optional reset-state)
1204   "Refresh the current view.
1205
1206 Refreshes the current view, observing changes in display
1207 preferences. If invoked with a prefix argument (or RESET-STATE is
1208 non-nil) then the state of the buffer (open/closed messages) is
1209 reset based on the original query."
1210   (interactive "P")
1211   (let ((inhibit-read-only t)
1212         (state (unless reset-state
1213                  (notmuch-show-capture-state))))
1214     ;; erase-buffer does not seem to remove overlays, which can lead
1215     ;; to weird effects such as remaining images, so remove them
1216     ;; manually.
1217     (remove-overlays)
1218     (erase-buffer)
1219     (notmuch-show-build-buffer)
1220     (if state
1221         (notmuch-show-apply-state state)
1222       ;; We're resetting state, so navigate to the first open message
1223       ;; and mark it read, just like opening a new show buffer.
1224       (notmuch-show-goto-first-wanted-message))))
1225
1226 (defvar notmuch-show-stash-map
1227   (let ((map (make-sparse-keymap)))
1228     (define-key map "c" 'notmuch-show-stash-cc)
1229     (define-key map "d" 'notmuch-show-stash-date)
1230     (define-key map "F" 'notmuch-show-stash-filename)
1231     (define-key map "f" 'notmuch-show-stash-from)
1232     (define-key map "i" 'notmuch-show-stash-message-id)
1233     (define-key map "I" 'notmuch-show-stash-message-id-stripped)
1234     (define-key map "s" 'notmuch-show-stash-subject)
1235     (define-key map "T" 'notmuch-show-stash-tags)
1236     (define-key map "t" 'notmuch-show-stash-to)
1237     (define-key map "l" 'notmuch-show-stash-mlarchive-link)
1238     (define-key map "L" 'notmuch-show-stash-mlarchive-link-and-go)
1239     map)
1240   "Submap for stash commands")
1241 (fset 'notmuch-show-stash-map notmuch-show-stash-map)
1242
1243 (defvar notmuch-show-mode-map
1244       (let ((map (make-sparse-keymap)))
1245         (define-key map "?" 'notmuch-help)
1246         (define-key map "q" 'notmuch-kill-this-buffer)
1247         (define-key map (kbd "<C-tab>") 'widget-backward)
1248         (define-key map (kbd "M-TAB") 'notmuch-show-previous-button)
1249         (define-key map (kbd "<backtab>") 'notmuch-show-previous-button)
1250         (define-key map (kbd "TAB") 'notmuch-show-next-button)
1251         (define-key map "s" 'notmuch-search)
1252         (define-key map "m" 'notmuch-mua-new-mail)
1253         (define-key map "f" 'notmuch-show-forward-message)
1254         (define-key map "r" 'notmuch-show-reply-sender)
1255         (define-key map "R" 'notmuch-show-reply)
1256         (define-key map "|" 'notmuch-show-pipe-message)
1257         (define-key map "w" 'notmuch-show-save-attachments)
1258         (define-key map "V" 'notmuch-show-view-raw-message)
1259         (define-key map "v" 'notmuch-show-view-all-mime-parts)
1260         (define-key map "c" 'notmuch-show-stash-map)
1261         (define-key map "=" 'notmuch-show-refresh-view)
1262         (define-key map "h" 'notmuch-show-toggle-visibility-headers)
1263         (define-key map "*" 'notmuch-show-tag-all)
1264         (define-key map "-" 'notmuch-show-remove-tag)
1265         (define-key map "+" 'notmuch-show-add-tag)
1266         (define-key map "X" 'notmuch-show-archive-thread-then-exit)
1267         (define-key map "x" 'notmuch-show-archive-message-then-next-or-exit)
1268         (define-key map "A" 'notmuch-show-archive-thread-then-next)
1269         (define-key map "a" 'notmuch-show-archive-message-then-next-or-next-thread)
1270         (define-key map "N" 'notmuch-show-next-message)
1271         (define-key map "P" 'notmuch-show-previous-message)
1272         (define-key map "n" 'notmuch-show-next-open-message)
1273         (define-key map "p" 'notmuch-show-previous-open-message)
1274         (define-key map (kbd "M-n") 'notmuch-show-next-thread-show)
1275         (define-key map (kbd "M-p") 'notmuch-show-previous-thread-show)
1276         (define-key map (kbd "DEL") 'notmuch-show-rewind)
1277         (define-key map " " 'notmuch-show-advance-and-archive)
1278         (define-key map (kbd "M-RET") 'notmuch-show-open-or-close-all)
1279         (define-key map (kbd "RET") 'notmuch-show-toggle-message)
1280         (define-key map "#" 'notmuch-show-print-message)
1281         (define-key map "!" 'notmuch-show-toggle-elide-non-matching)
1282         (define-key map "$" 'notmuch-show-toggle-process-crypto)
1283         (define-key map "<" 'notmuch-show-toggle-thread-indentation)
1284         (define-key map "t" 'toggle-truncate-lines)
1285         map)
1286       "Keymap for \"notmuch show\" buffers.")
1287 (fset 'notmuch-show-mode-map notmuch-show-mode-map)
1288
1289 (defun notmuch-show-mode ()
1290   "Major mode for viewing a thread with notmuch.
1291
1292 This buffer contains the results of the \"notmuch show\" command
1293 for displaying a single thread of email from your email archives.
1294
1295 By default, various components of email messages, (citations,
1296 signatures, already-read messages), are hidden. You can make
1297 these parts visible by clicking with the mouse button or by
1298 pressing RET after positioning the cursor on a hidden part, (for
1299 which \\[notmuch-show-next-button] and \\[notmuch-show-previous-button] are helpful).
1300
1301 Reading the thread sequentially is well-supported by pressing
1302 \\[notmuch-show-advance-and-archive]. This will scroll the current message (if necessary), advance
1303 to the next message, or advance to the next thread (if already on
1304 the last message of a thread).
1305
1306 Other commands are available to read or manipulate the thread
1307 more selectively, (such as '\\[notmuch-show-next-message]' and '\\[notmuch-show-previous-message]' to advance to messages
1308 without removing any tags, and '\\[notmuch-show-archive-thread]' to archive an entire thread
1309 without scrolling through with \\[notmuch-show-advance-and-archive]).
1310
1311 You can add or remove arbitrary tags from the current message with
1312 '\\[notmuch-show-add-tag]' or '\\[notmuch-show-remove-tag]'.
1313
1314 All currently available key bindings:
1315
1316 \\{notmuch-show-mode-map}"
1317   (interactive)
1318   (kill-all-local-variables)
1319   (use-local-map notmuch-show-mode-map)
1320   (setq major-mode 'notmuch-show-mode
1321         mode-name "notmuch-show")
1322   (setq buffer-read-only t
1323         truncate-lines t))
1324
1325 (defun notmuch-show-move-to-message-top ()
1326   (goto-char (notmuch-show-message-top)))
1327
1328 (defun notmuch-show-move-to-message-bottom ()
1329   (goto-char (notmuch-show-message-bottom)))
1330
1331 (defun notmuch-show-message-adjust ()
1332   (recenter 0))
1333
1334 ;; Movement related functions.
1335
1336 ;; There's some strangeness here where a text property applied to a
1337 ;; region a->b is not found when point is at b. We walk backwards
1338 ;; until finding the property.
1339 (defun notmuch-show-message-extent ()
1340   (let (r)
1341     (save-excursion
1342       (while (not (setq r (get-text-property (point) :notmuch-message-extent)))
1343         (backward-char)))
1344     r))
1345
1346 (defun notmuch-show-message-top ()
1347   (car (notmuch-show-message-extent)))
1348
1349 (defun notmuch-show-message-bottom ()
1350   (cdr (notmuch-show-message-extent)))
1351
1352 (defun notmuch-show-goto-message-next ()
1353   (let ((start (point)))
1354     (notmuch-show-move-to-message-bottom)
1355     (if (not (eobp))
1356         t
1357       (goto-char start)
1358       nil)))
1359
1360 (defun notmuch-show-goto-message-previous ()
1361   (notmuch-show-move-to-message-top)
1362   (if (bobp)
1363       nil
1364     (backward-char)
1365     (notmuch-show-move-to-message-top)
1366     t))
1367
1368 (defun notmuch-show-mapc (function)
1369   "Iterate through all messages in the current thread with
1370 `notmuch-show-goto-message-next' and call FUNCTION for side
1371 effects."
1372   (save-excursion
1373     (goto-char (point-min))
1374     (loop do (funcall function)
1375           while (notmuch-show-goto-message-next))))
1376
1377 ;; Functions relating to the visibility of messages and their
1378 ;; components.
1379
1380 (defun notmuch-show-message-visible (props visible-p)
1381   (overlay-put (plist-get props :message-overlay) 'invisible (not visible-p))
1382   (notmuch-show-set-prop :message-visible visible-p props))
1383
1384 (defun notmuch-show-headers-visible (props visible-p)
1385   (overlay-put (plist-get props :headers-overlay) 'invisible (not visible-p))
1386   (notmuch-show-set-prop :headers-visible visible-p props))
1387
1388 ;; Functions for setting and getting attributes of the current
1389 ;; message.
1390
1391 (defun notmuch-show-set-message-properties (props)
1392   (save-excursion
1393     (notmuch-show-move-to-message-top)
1394     (put-text-property (point) (+ (point) 1) :notmuch-message-properties props)))
1395
1396 (defun notmuch-show-get-message-properties ()
1397   "Return the properties of the current message as a plist.
1398
1399 Some useful entries are:
1400 :headers - Property list containing the headers :Date, :Subject, :From, etc.
1401 :body - Body of the message
1402 :tags - Tags for this message"
1403   (save-excursion
1404     (notmuch-show-move-to-message-top)
1405     (get-text-property (point) :notmuch-message-properties)))
1406
1407 (defun notmuch-show-set-prop (prop val &optional props)
1408   (let ((inhibit-read-only t)
1409         (props (or props
1410                    (notmuch-show-get-message-properties))))
1411     (plist-put props prop val)
1412     (notmuch-show-set-message-properties props)))
1413
1414 (defun notmuch-show-get-prop (prop &optional props)
1415   (let ((props (or props
1416                    (notmuch-show-get-message-properties))))
1417     (plist-get props prop)))
1418
1419 (defun notmuch-show-get-message-id (&optional bare)
1420   "Return an id: query for the Message-Id of the current message.
1421
1422 If optional argument BARE is non-nil, return
1423 the Message-Id without id: prefix and escaping."
1424   (if bare
1425       (notmuch-show-get-prop :id)
1426     (notmuch-id-to-query (notmuch-show-get-prop :id))))
1427
1428 (defun notmuch-show-get-messages-ids ()
1429   "Return all id: queries of messages in the current thread."
1430   (let ((message-ids))
1431     (notmuch-show-mapc
1432      (lambda () (push (notmuch-show-get-message-id) message-ids)))
1433     message-ids))
1434
1435 (defun notmuch-show-get-messages-ids-search ()
1436   "Return a search string for all message ids of messages in the
1437 current thread."
1438   (mapconcat 'identity (notmuch-show-get-messages-ids) " or "))
1439
1440 ;; dme: Would it make sense to use a macro for many of these?
1441
1442 (defun notmuch-show-get-filename ()
1443   "Return the filename of the current message."
1444   (notmuch-show-get-prop :filename))
1445
1446 (defun notmuch-show-get-header (header &optional props)
1447   "Return the named header of the current message, if any."
1448   (plist-get (notmuch-show-get-prop :headers props) header))
1449
1450 (defun notmuch-show-get-cc ()
1451   (notmuch-show-get-header :Cc))
1452
1453 (defun notmuch-show-get-date ()
1454   (notmuch-show-get-header :Date))
1455
1456 (defun notmuch-show-get-from ()
1457   (notmuch-show-get-header :From))
1458
1459 (defun notmuch-show-get-subject ()
1460   (notmuch-show-get-header :Subject))
1461
1462 (defun notmuch-show-get-to ()
1463   (notmuch-show-get-header :To))
1464
1465 (defun notmuch-show-get-depth ()
1466   (notmuch-show-get-prop :depth))
1467
1468 (defun notmuch-show-set-tags (tags)
1469   "Set the tags of the current message."
1470   (notmuch-show-set-prop :tags tags)
1471   (notmuch-show-update-tags tags))
1472
1473 (defun notmuch-show-get-tags ()
1474   "Return the tags of the current message."
1475   (notmuch-show-get-prop :tags))
1476
1477 (defun notmuch-show-message-visible-p ()
1478   "Is the current message visible?"
1479   (notmuch-show-get-prop :message-visible))
1480
1481 (defun notmuch-show-headers-visible-p ()
1482   "Are the headers of the current message visible?"
1483   (notmuch-show-get-prop :headers-visible))
1484
1485 (defun notmuch-show-mark-read (&optional unread)
1486   "Mark the current message as read.
1487
1488 Mark the current message as read by applying the tag changes in
1489 `notmuch-show-mark-read-tags' to it (remove the \"unread\" tag by
1490 default). If a prefix argument is given, the message will be
1491 marked as unread, i.e. the tag changes in
1492 `notmuch-show-mark-read-tags' will be reversed."
1493   (interactive "P")
1494   (when notmuch-show-mark-read-tags
1495     (apply 'notmuch-show-tag-message
1496            (notmuch-tag-change-list notmuch-show-mark-read-tags unread))))
1497
1498 ;; Functions for getting attributes of several messages in the current
1499 ;; thread.
1500
1501 (defun notmuch-show-get-message-ids-for-open-messages ()
1502   "Return a list of all id: queries for open messages in the current thread."
1503   (save-excursion
1504     (let (message-ids done)
1505       (goto-char (point-min))
1506       (while (not done)
1507         (if (notmuch-show-message-visible-p)
1508             (setq message-ids (append message-ids (list (notmuch-show-get-message-id)))))
1509         (setq done (not (notmuch-show-goto-message-next)))
1510         )
1511       message-ids
1512       )))
1513
1514 ;; Commands typically bound to keys.
1515
1516 (defun notmuch-show-advance ()
1517   "Advance through thread.
1518
1519 If the current message in the thread is not yet fully visible,
1520 scroll by a near screenful to read more of the message.
1521
1522 Otherwise, (the end of the current message is already within the
1523 current window), advance to the next open message."
1524   (interactive)
1525   (let* ((end-of-this-message (notmuch-show-message-bottom))
1526          (visible-end-of-this-message (1- end-of-this-message))
1527          (ret nil))
1528     (while (invisible-p visible-end-of-this-message)
1529       (setq visible-end-of-this-message
1530             (max (point-min)
1531                  (1- (previous-single-char-property-change
1532                       visible-end-of-this-message 'invisible)))))
1533     (cond
1534      ;; Ideally we would test `end-of-this-message' against the result
1535      ;; of `window-end', but that doesn't account for the fact that
1536      ;; the end of the message might be hidden.
1537      ((and visible-end-of-this-message
1538            (> visible-end-of-this-message (window-end)))
1539       ;; The bottom of this message is not visible - scroll.
1540       (scroll-up nil))
1541
1542      ((not (= end-of-this-message (point-max)))
1543       ;; This is not the last message - move to the next visible one.
1544       (notmuch-show-next-open-message))
1545
1546      ((not (= (point) (point-max)))
1547       ;; This is the last message, but the cursor is not at the end of
1548       ;; the buffer. Move it there.
1549       (goto-char (point-max)))
1550
1551      (t
1552       ;; This is the last message - change the return value
1553       (setq ret t)))
1554     ret))
1555
1556 (defun notmuch-show-advance-and-archive ()
1557   "Advance through thread and archive.
1558
1559 This command is intended to be one of the simplest ways to
1560 process a thread of email. It works exactly like
1561 notmuch-show-advance, in that it scrolls through messages in a
1562 show buffer, except that when it gets to the end of the buffer it
1563 archives the entire current thread, (remove the \"inbox\" tag
1564 from each message), kills the buffer, and displays the next
1565 thread from the search from which this thread was originally
1566 shown."
1567   (interactive)
1568   (if (notmuch-show-advance)
1569       (notmuch-show-archive-thread-then-next)))
1570
1571 (defun notmuch-show-rewind ()
1572   "Backup through the thread, (reverse scrolling compared to \\[notmuch-show-advance-and-archive]).
1573
1574 Specifically, if the beginning of the previous email is fewer
1575 than `window-height' lines from the current point, move to it
1576 just like `notmuch-show-previous-message'.
1577
1578 Otherwise, just scroll down a screenful of the current message.
1579
1580 This command does not modify any message tags, (it does not undo
1581 any effects from previous calls to
1582 `notmuch-show-advance-and-archive'."
1583   (interactive)
1584   (let ((start-of-message (notmuch-show-message-top))
1585         (start-of-window (window-start)))
1586     (cond
1587       ;; Either this message is properly aligned with the start of the
1588       ;; window or the start of this message is not visible on the
1589       ;; screen - scroll.
1590      ((or (= start-of-message start-of-window)
1591           (< start-of-message start-of-window))
1592       (scroll-down)
1593       ;; If a small number of lines from the previous message are
1594       ;; visible, realign so that the top of the current message is at
1595       ;; the top of the screen.
1596       (when (<= (count-screen-lines (window-start) start-of-message)
1597                 next-screen-context-lines)
1598         (goto-char (notmuch-show-message-top))
1599         (notmuch-show-message-adjust))
1600       ;; Move to the top left of the window.
1601       (goto-char (window-start)))
1602      (t
1603       ;; Move to the previous message.
1604       (notmuch-show-previous-message)))))
1605
1606 (defun notmuch-show-reply (&optional prompt-for-sender)
1607   "Reply to the sender and all recipients of the current message."
1608   (interactive "P")
1609   (notmuch-mua-new-reply (notmuch-show-get-message-id) prompt-for-sender t))
1610
1611 (defun notmuch-show-reply-sender (&optional prompt-for-sender)
1612   "Reply to the sender of the current message."
1613   (interactive "P")
1614   (notmuch-mua-new-reply (notmuch-show-get-message-id) prompt-for-sender nil))
1615
1616 (defun notmuch-show-forward-message (&optional prompt-for-sender)
1617   "Forward the current message."
1618   (interactive "P")
1619   (with-current-notmuch-show-message
1620    (notmuch-mua-new-forward-message prompt-for-sender)))
1621
1622 (defun notmuch-show-next-message (&optional pop-at-end)
1623   "Show the next message.
1624
1625 If a prefix argument is given and this is the last message in the
1626 thread, navigate to the next thread in the parent search buffer."
1627   (interactive "P")
1628   (if (notmuch-show-goto-message-next)
1629       (progn
1630         (notmuch-show-mark-read)
1631         (notmuch-show-message-adjust))
1632     (if pop-at-end
1633         (notmuch-show-next-thread)
1634       (goto-char (point-max)))))
1635
1636 (defun notmuch-show-previous-message ()
1637   "Show the previous message or the start of the current message."
1638   (interactive)
1639   (if (= (point) (notmuch-show-message-top))
1640       (notmuch-show-goto-message-previous)
1641     (notmuch-show-move-to-message-top))
1642   (notmuch-show-mark-read)
1643   (notmuch-show-message-adjust))
1644
1645 (defun notmuch-show-next-open-message (&optional pop-at-end)
1646   "Show the next open message.
1647
1648 If a prefix argument is given and this is the last open message
1649 in the thread, navigate to the next thread in the parent search
1650 buffer. Return t if there was a next open message in the thread
1651 to show, nil otherwise."
1652   (interactive "P")
1653   (let (r)
1654     (while (and (setq r (notmuch-show-goto-message-next))
1655                 (not (notmuch-show-message-visible-p))))
1656     (if r
1657         (progn
1658           (notmuch-show-mark-read)
1659           (notmuch-show-message-adjust))
1660       (if pop-at-end
1661           (notmuch-show-next-thread)
1662         (goto-char (point-max))))
1663     r))
1664
1665 (defun notmuch-show-next-matching-message ()
1666   "Show the next matching message."
1667   (interactive)
1668   (let (r)
1669     (while (and (setq r (notmuch-show-goto-message-next))
1670                 (not (notmuch-show-get-prop :match))))
1671     (if r
1672         (progn
1673           (notmuch-show-mark-read)
1674           (notmuch-show-message-adjust))
1675       (goto-char (point-max)))))
1676
1677 (defun notmuch-show-open-if-matched ()
1678   "Open a message if it is matched (whether or not excluded)."
1679   (let ((props (notmuch-show-get-message-properties)))
1680     (notmuch-show-message-visible props (plist-get props :match))))
1681
1682 (defun notmuch-show-goto-first-wanted-message ()
1683   "Move to the first open message and mark it read"
1684   (goto-char (point-min))
1685   (if (notmuch-show-message-visible-p)
1686       (notmuch-show-mark-read)
1687     (notmuch-show-next-open-message))
1688   (when (eobp)
1689     ;; There are no matched non-excluded messages so open all matched
1690     ;; (necessarily excluded) messages and go to the first.
1691     (notmuch-show-mapc 'notmuch-show-open-if-matched)
1692     (force-window-update)
1693     (goto-char (point-min))
1694     (if (notmuch-show-message-visible-p)
1695         (notmuch-show-mark-read)
1696       (notmuch-show-next-open-message))))
1697
1698 (defun notmuch-show-previous-open-message ()
1699   "Show the previous open message."
1700   (interactive)
1701   (while (and (if (= (point) (notmuch-show-message-top))
1702                   (notmuch-show-goto-message-previous)
1703                 (notmuch-show-move-to-message-top))
1704               (not (notmuch-show-message-visible-p))))
1705   (notmuch-show-mark-read)
1706   (notmuch-show-message-adjust))
1707
1708 (defun notmuch-show-view-raw-message ()
1709   "View the file holding the current message."
1710   (interactive)
1711   (let* ((id (notmuch-show-get-message-id))
1712          (buf (get-buffer-create (concat "*notmuch-raw-" id "*"))))
1713     (call-process notmuch-command nil buf nil "show" "--format=raw" id)
1714     (switch-to-buffer buf)
1715     (goto-char (point-min))
1716     (set-buffer-modified-p nil)
1717     (view-buffer buf 'kill-buffer-if-not-modified)))
1718
1719 (defun notmuch-show-pipe-message (entire-thread command)
1720   "Pipe the contents of the current message (or thread) to the given command.
1721
1722 The given command will be executed with the raw contents of the
1723 current email message as stdin. Anything printed by the command
1724 to stdout or stderr will appear in the *notmuch-pipe* buffer.
1725
1726 When invoked with a prefix argument, the command will receive all
1727 open messages in the current thread (formatted as an mbox) rather
1728 than only the current message."
1729   (interactive "P\nsPipe message to command: ")
1730   (let (shell-command)
1731     (if entire-thread
1732         (setq shell-command
1733               (concat notmuch-command " show --format=mbox --exclude=false "
1734                       (shell-quote-argument
1735                        (mapconcat 'identity (notmuch-show-get-message-ids-for-open-messages) " OR "))
1736                       " | " command))
1737       (setq shell-command
1738             (concat notmuch-command " show --format=raw "
1739                     (shell-quote-argument (notmuch-show-get-message-id)) " | " command)))
1740     (let ((buf (get-buffer-create (concat "*notmuch-pipe*"))))
1741       (with-current-buffer buf
1742         (setq buffer-read-only nil)
1743         (erase-buffer)
1744         (let ((exit-code (call-process-shell-command shell-command nil buf)))
1745           (goto-char (point-max))
1746           (set-buffer-modified-p nil)
1747           (setq buffer-read-only t)
1748           (unless (zerop exit-code)
1749             (switch-to-buffer-other-window buf)
1750             (message (format "Command '%s' exited abnormally with code %d"
1751                              shell-command exit-code))))))))
1752
1753 (defun notmuch-show-tag-message (&rest tag-changes)
1754   "Change tags for the current message.
1755
1756 TAG-CHANGES is a list of tag operations for `notmuch-tag'."
1757   (let* ((current-tags (notmuch-show-get-tags))
1758          (new-tags (notmuch-update-tags current-tags tag-changes)))
1759     (unless (equal current-tags new-tags)
1760       (funcall 'notmuch-tag (notmuch-show-get-message-id) tag-changes)
1761       (notmuch-show-set-tags new-tags))))
1762
1763 (defun notmuch-show-tag (&optional tag-changes)
1764   "Change tags for the current message.
1765
1766 See `notmuch-tag' for information on the format of TAG-CHANGES."
1767   (interactive)
1768   (setq tag-changes (funcall 'notmuch-tag (notmuch-show-get-message-id) tag-changes))
1769   (let* ((current-tags (notmuch-show-get-tags))
1770          (new-tags (notmuch-update-tags current-tags tag-changes)))
1771     (unless (equal current-tags new-tags)
1772       (notmuch-show-set-tags new-tags))))
1773
1774 (defun notmuch-show-tag-all (&optional tag-changes)
1775   "Change tags for all messages in the current show buffer.
1776
1777 See `notmuch-tag' for information on the format of TAG-CHANGES."
1778   (interactive)
1779   (setq tag-changes (funcall 'notmuch-tag (notmuch-show-get-messages-ids-search) tag-changes))
1780   (notmuch-show-mapc
1781    (lambda ()
1782      (let* ((current-tags (notmuch-show-get-tags))
1783             (new-tags (notmuch-update-tags current-tags tag-changes)))
1784        (unless (equal current-tags new-tags)
1785          (notmuch-show-set-tags new-tags))))))
1786
1787 (defun notmuch-show-add-tag ()
1788   "Same as `notmuch-show-tag' but sets initial input to '+'."
1789   (interactive)
1790   (notmuch-show-tag "+"))
1791
1792 (defun notmuch-show-remove-tag ()
1793   "Same as `notmuch-show-tag' but sets initial input to '-'."
1794   (interactive)
1795   (notmuch-show-tag "-"))
1796
1797 (defun notmuch-show-toggle-visibility-headers ()
1798   "Toggle the visibility of the current message headers."
1799   (interactive)
1800   (let ((props (notmuch-show-get-message-properties)))
1801     (notmuch-show-headers-visible
1802      props
1803      (not (plist-get props :headers-visible))))
1804   (force-window-update))
1805
1806 (defun notmuch-show-toggle-message ()
1807   "Toggle the visibility of the current message."
1808   (interactive)
1809   (let ((props (notmuch-show-get-message-properties)))
1810     (notmuch-show-message-visible
1811      props
1812      (not (plist-get props :message-visible))))
1813   (force-window-update))
1814
1815 (defun notmuch-show-open-or-close-all ()
1816   "Set the visibility all of the messages in the current thread.
1817 By default make all of the messages visible. With a prefix
1818 argument, hide all of the messages."
1819   (interactive)
1820   (save-excursion
1821     (goto-char (point-min))
1822     (loop do (notmuch-show-message-visible (notmuch-show-get-message-properties)
1823                                            (not current-prefix-arg))
1824           until (not (notmuch-show-goto-message-next))))
1825   (force-window-update))
1826
1827 (defun notmuch-show-next-button ()
1828   "Advance point to the next button in the buffer."
1829   (interactive)
1830   (forward-button 1))
1831
1832 (defun notmuch-show-previous-button ()
1833   "Move point back to the previous button in the buffer."
1834   (interactive)
1835   (backward-button 1))
1836
1837 (defun notmuch-show-next-thread (&optional show previous)
1838   "Move to the next item in the search results, if any.
1839
1840 If SHOW is non-nil, open the next item in a show
1841 buffer. Otherwise just highlight the next item in the search
1842 buffer. If PREVIOUS is non-nil, move to the previous item in the
1843 search results instead."
1844   (interactive "P")
1845   (let ((parent-buffer notmuch-show-parent-buffer))
1846     (notmuch-kill-this-buffer)
1847     (when (buffer-live-p parent-buffer)
1848       (switch-to-buffer parent-buffer)
1849       (and (if previous
1850                (notmuch-search-previous-thread)
1851              (notmuch-search-next-thread))
1852            show
1853            (notmuch-search-show-thread)))))
1854
1855 (defun notmuch-show-next-thread-show ()
1856   "Show the next thread in the search results, if any."
1857   (interactive)
1858   (notmuch-show-next-thread t))
1859
1860 (defun notmuch-show-previous-thread-show ()
1861   "Show the previous thread in the search results, if any."
1862   (interactive)
1863   (notmuch-show-next-thread t t))
1864
1865 (defun notmuch-show-archive-thread (&optional unarchive)
1866   "Archive each message in thread.
1867
1868 Archive each message currently shown by applying the tag changes
1869 in `notmuch-archive-tags' to each (remove the \"inbox\" tag by
1870 default). If a prefix argument is given, the messages will be
1871 \"unarchived\", i.e. the tag changes in `notmuch-archive-tags'
1872 will be reversed.
1873
1874 Note: This command is safe from any race condition of new messages
1875 being delivered to the same thread. It does not archive the
1876 entire thread, but only the messages shown in the current
1877 buffer."
1878   (interactive "P")
1879   (when notmuch-archive-tags
1880     (notmuch-show-tag-all
1881      (notmuch-tag-change-list notmuch-archive-tags unarchive))))
1882
1883 (defun notmuch-show-archive-thread-then-next ()
1884   "Archive all messages in the current buffer, then show next thread from search."
1885   (interactive)
1886   (notmuch-show-archive-thread)
1887   (notmuch-show-next-thread t))
1888
1889 (defun notmuch-show-archive-thread-then-exit ()
1890   "Archive all messages in the current buffer, then exit back to search results."
1891   (interactive)
1892   (notmuch-show-archive-thread)
1893   (notmuch-show-next-thread))
1894
1895 (defun notmuch-show-archive-message (&optional unarchive)
1896   "Archive the current message.
1897
1898 Archive the current message by applying the tag changes in
1899 `notmuch-archive-tags' to it (remove the \"inbox\" tag by
1900 default). If a prefix argument is given, the message will be
1901 \"unarchived\", i.e. the tag changes in `notmuch-archive-tags'
1902 will be reversed."
1903   (interactive "P")
1904   (when notmuch-archive-tags
1905     (apply 'notmuch-show-tag-message
1906            (notmuch-tag-change-list notmuch-archive-tags unarchive))))
1907
1908 (defun notmuch-show-archive-message-then-next-or-exit ()
1909   "Archive the current message, then show the next open message in the current thread.
1910
1911 If at the last open message in the current thread, then exit back
1912 to search results."
1913   (interactive)
1914   (notmuch-show-archive-message)
1915   (notmuch-show-next-open-message t))
1916
1917 (defun notmuch-show-archive-message-then-next-or-next-thread ()
1918   "Archive the current message, then show the next open message in the current thread.
1919
1920 If at the last open message in the current thread, then show next
1921 thread from search."
1922   (interactive)
1923   (notmuch-show-archive-message)
1924   (unless (notmuch-show-next-open-message)
1925     (notmuch-show-next-thread t)))
1926
1927 (defun notmuch-show-stash-cc ()
1928   "Copy CC field of current message to kill-ring."
1929   (interactive)
1930   (notmuch-common-do-stash (notmuch-show-get-cc)))
1931
1932 (defun notmuch-show-stash-date ()
1933   "Copy date of current message to kill-ring."
1934   (interactive)
1935   (notmuch-common-do-stash (notmuch-show-get-date)))
1936
1937 (defun notmuch-show-stash-filename ()
1938   "Copy filename of current message to kill-ring."
1939   (interactive)
1940   (notmuch-common-do-stash (notmuch-show-get-filename)))
1941
1942 (defun notmuch-show-stash-from ()
1943   "Copy From address of current message to kill-ring."
1944   (interactive)
1945   (notmuch-common-do-stash (notmuch-show-get-from)))
1946
1947 (defun notmuch-show-stash-message-id (&optional stash-thread-id)
1948   "Copy id: query matching the current message to kill-ring.
1949
1950 If invoked with a prefix argument (or STASH-THREAD-ID is
1951 non-nil), copy thread: query matching the current thread to
1952 kill-ring."
1953   (interactive "P")
1954   (if stash-thread-id
1955       (notmuch-common-do-stash notmuch-show-thread-id)
1956     (notmuch-common-do-stash (notmuch-show-get-message-id))))
1957
1958 (defun notmuch-show-stash-message-id-stripped ()
1959   "Copy message ID of current message (sans `id:' prefix) to kill-ring."
1960   (interactive)
1961   (notmuch-common-do-stash (notmuch-show-get-message-id t)))
1962
1963 (defun notmuch-show-stash-subject ()
1964   "Copy Subject field of current message to kill-ring."
1965   (interactive)
1966   (notmuch-common-do-stash (notmuch-show-get-subject)))
1967
1968 (defun notmuch-show-stash-tags ()
1969   "Copy tags of current message to kill-ring as a comma separated list."
1970   (interactive)
1971   (notmuch-common-do-stash (mapconcat 'identity (notmuch-show-get-tags) ",")))
1972
1973 (defun notmuch-show-stash-to ()
1974   "Copy To address of current message to kill-ring."
1975   (interactive)
1976   (notmuch-common-do-stash (notmuch-show-get-to)))
1977
1978 (defun notmuch-show-stash-mlarchive-link (&optional mla)
1979   "Copy an ML Archive URI for the current message to the kill-ring.
1980
1981 This presumes that the message is available at the selected Mailing List Archive.
1982
1983 If optional argument MLA is non-nil, use the provided key instead of prompting
1984 the user (see `notmuch-show-stash-mlarchive-link-alist')."
1985   (interactive)
1986   (notmuch-common-do-stash
1987    (concat (cdr (assoc
1988                  (or mla
1989                      (let ((completion-ignore-case t))
1990                        (completing-read
1991                         "Mailing List Archive: "
1992                         notmuch-show-stash-mlarchive-link-alist
1993                         nil t nil nil notmuch-show-stash-mlarchive-link-default)))
1994                  notmuch-show-stash-mlarchive-link-alist))
1995            (notmuch-show-get-message-id t))))
1996
1997 (defun notmuch-show-stash-mlarchive-link-and-go (&optional mla)
1998   "Copy an ML Archive URI for the current message to the kill-ring and visit it.
1999
2000 This presumes that the message is available at the selected Mailing List Archive.
2001
2002 If optional argument MLA is non-nil, use the provided key instead of prompting
2003 the user (see `notmuch-show-stash-mlarchive-link-alist')."
2004   (interactive)
2005   (notmuch-show-stash-mlarchive-link mla)
2006   (browse-url (current-kill 0 t)))
2007
2008 ;; Commands typically bound to buttons.
2009
2010 (defun notmuch-show-part-button-default (&optional button)
2011   (interactive)
2012   (let ((button (or button (button-at (point)))))
2013     (if (button-get button 'overlay)
2014         (notmuch-show-toggle-part-invisibility button)
2015       (notmuch-show-part-button-internal button notmuch-show-part-button-default-action))))
2016
2017 (defun notmuch-show-part-button-save (&optional button)
2018   (interactive)
2019   (notmuch-show-part-button-internal button #'notmuch-show-save-part))
2020
2021 (defun notmuch-show-part-button-view (&optional button)
2022   (interactive)
2023   (notmuch-show-part-button-internal button #'notmuch-show-view-part))
2024
2025 (defun notmuch-show-part-button-interactively-view (&optional button)
2026   (interactive)
2027   (notmuch-show-part-button-internal button #'notmuch-show-interactively-view-part))
2028
2029 (defun notmuch-show-part-button-pipe (&optional button)
2030   (interactive)
2031   (notmuch-show-part-button-internal button #'notmuch-show-pipe-part))
2032
2033 (defun notmuch-show-part-button-internal (button handler)
2034   (let ((button (or button (button-at (point)))))
2035     (if button
2036         (let ((nth (button-get button :notmuch-part)))
2037           (if nth
2038               (funcall handler (notmuch-show-get-message-id) nth
2039                        (button-get button :notmuch-filename)
2040                        (button-get button :notmuch-content-type)))))))
2041
2042 ;;
2043
2044 (provide 'notmuch-show)