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-query)
  34 (require 'notmuch-wash)
  35 (require 'notmuch-mua)
  36 (require 'notmuch-crypto)
  37
  38 (declare-function notmuch-call-notmuch-process "notmuch" (&rest args))
  39 (declare-function notmuch-fontify-headers "notmuch" nil)
  40 (declare-function notmuch-select-tag-with-completion "notmuch" (prompt &rest search-terms))
  41 (declare-function notmuch-search-show-thread "notmuch" nil)
  42
  43 (defcustom notmuch-message-headers '("Subject" "To" "Cc" "Date")
  44   "Headers that should be shown in a message, in this order.
  45
  46 For an open message, all of these headers will be made visible
  47 according to `notmuch-message-headers-visible' or can be toggled
  48 with `notmuch-show-toggle-headers'. For a closed message, only
  49 the first header in the list will be visible."
  50   :group 'notmuch
  51   :type '(repeat string))
  52
  53 (defcustom notmuch-message-headers-visible t
  54   "Should the headers be visible by default?
  55
  56 If this value is non-nil, then all of the headers defined in
  57 `notmuch-message-headers' will be visible by default in the display
  58 of each message. Otherwise, these headers will be hidden and
  59 `notmuch-show-toggle-headers' can be used to make the visible for
  60 any given message."
  61   :group 'notmuch
  62   :type 'boolean)
  63
  64 (defcustom notmuch-show-relative-dates t
  65   "Display relative dates in the message summary line."
  66   :group 'notmuch
  67   :type 'boolean)
  68
  69 (defvar notmuch-show-markup-headers-hook '(notmuch-show-colour-headers)
  70   "A list of functions called to decorate the headers listed in
  71 `notmuch-message-headers'.")
  72
  73 (defcustom notmuch-show-hook nil
  74   "Functions called after populating a `notmuch-show' buffer."
  75   :group 'notmuch
  76   :type 'hook)
  77
  78 (defcustom notmuch-show-insert-text/plain-hook '(notmuch-wash-excerpt-citations)
  79   "Functions used to improve the display of text/plain parts."
  80   :group 'notmuch
  81   :type 'hook
  82   :options '(notmuch-wash-convert-inline-patch-to-part
  83              notmuch-wash-wrap-long-lines
  84              notmuch-wash-tidy-citations
  85              notmuch-wash-elide-blank-lines
  86              notmuch-wash-excerpt-citations))
  87
  88 ;; Mostly useful for debugging.
  89 (defcustom notmuch-show-all-multipart/alternative-parts t
  90   "Should all parts of multipart/alternative parts be shown?"
  91   :group 'notmuch
  92   :type 'boolean)
  93
  94 (defcustom notmuch-indent-messages-width 1
  95   "Width of message indentation in threads.
  96
  97 Messages are shown indented according to their depth in a thread.
  98 This variable determines the width of this indentation measured
  99 in number of blanks.  Defaults to `1', choose `0' to disable
 100 indentation."
 101   :group 'notmuch
 102   :type 'integer)
 103
 104 (defcustom notmuch-show-indent-multipart nil
 105   "Should the sub-parts of a multipart/* part be indented?"
 106   ;; dme: Not sure which is a good default.
 107   :group 'notmuch
 108   :type 'boolean)
 109
 110 (defmacro with-current-notmuch-show-message (&rest body)
 111   "Evaluate body with current buffer set to the text of current message"
 112   `(save-excursion
 113      (let ((id (notmuch-show-get-message-id)))
 114        (let ((buf (generate-new-buffer (concat "*notmuch-msg-" id "*"))))
 115          (with-current-buffer buf
 116             (call-process notmuch-command nil t nil "show" "--format=raw" id)
 117            ,@body)
 118          (kill-buffer buf)))))
 119
 120 (defun notmuch-show-view-all-mime-parts ()
 121   "Use external viewers to view all attachments from the current message."
 122   (interactive)
 123   (with-current-notmuch-show-message
 124    ; We override the mm-inline-media-tests to indicate which message
 125    ; parts are already sufficiently handled by the original
 126    ; presentation of the message in notmuch-show mode. These parts
 127    ; will be inserted directly into the temporary buffer of
 128    ; with-current-notmuch-show-message and silently discarded.
 129    ;
 130    ; Any MIME part not explicitly mentioned here will be handled by an
 131    ; external viewer as configured in the various mailcap files.
 132    (let ((mm-inline-media-tests '(
 133                                   ("text/.*" ignore identity)
 134                                   ("application/pgp-signature" ignore identity)
 135                                   ("multipart/alternative" ignore identity)
 136                                   ("multipart/mixed" ignore identity)
 137                                   ("multipart/related" ignore identity)
 138                                  )))
 139      (mm-display-parts (mm-dissect-buffer)))))
 140
 141 (defun notmuch-foreach-mime-part (function mm-handle)
 142   (cond ((stringp (car mm-handle))
 143          (dolist (part (cdr mm-handle))
 144            (notmuch-foreach-mime-part function part)))
 145         ((bufferp (car mm-handle))
 146          (funcall function mm-handle))
 147         (t (dolist (part mm-handle)
 148              (notmuch-foreach-mime-part function part)))))
 149
 150 (defun notmuch-count-attachments (mm-handle)
 151   (let ((count 0))
 152     (notmuch-foreach-mime-part
 153      (lambda (p)
 154        (let ((disposition (mm-handle-disposition p)))
 155          (and (listp disposition)
 156               (or (equal (car disposition) "attachment")
 157                   (and (equal (car disposition) "inline")
 158                        (assq 'filename disposition)))
 159               (incf count))))
 160      mm-handle)
 161     count))
 162
 163 (defun notmuch-save-attachments (mm-handle &optional queryp)
 164   (notmuch-foreach-mime-part
 165    (lambda (p)
 166      (let ((disposition (mm-handle-disposition p)))
 167        (and (listp disposition)
 168             (or (equal (car disposition) "attachment")
 169                 (and (equal (car disposition) "inline")
 170                      (assq 'filename disposition)))
 171             (or (not queryp)
 172                 (y-or-n-p
 173                  (concat "Save '" (cdr (assq 'filename disposition)) "' ")))
 174             (mm-save-part p))))
 175    mm-handle))
 176
 177 (defun notmuch-show-save-attachments ()
 178   "Save all attachments from the current message."
 179   (interactive)
 180   (with-current-notmuch-show-message
 181    (let ((mm-handle (mm-dissect-buffer)))
 182      (notmuch-save-attachments
 183       mm-handle (> (notmuch-count-attachments mm-handle) 1))))
 184   (message "Done"))
 185
 186 (defun notmuch-show-fontify-header ()
 187   (let ((face (cond
 188                ((looking-at "[Tt]o:")
 189                 'message-header-to)
 190                ((looking-at "[Bb]?[Cc][Cc]:")
 191                 'message-header-cc)
 192                ((looking-at "[Ss]ubject:")
 193                 'message-header-subject)
 194                ((looking-at "[Ff]rom:")
 195                 'message-header-from)
 196                (t
 197                 'message-header-other))))
 198
 199     (overlay-put (make-overlay (point) (re-search-forward ":"))
 200                  'face 'message-header-name)
 201     (overlay-put (make-overlay (point) (re-search-forward ".*$"))
 202                  'face face)))
 203
 204 (defun notmuch-show-colour-headers ()
 205   "Apply some colouring to the current headers."
 206   (goto-char (point-min))
 207   (while (looking-at "^[A-Za-z][-A-Za-z0-9]*:")
 208     (notmuch-show-fontify-header)
 209     (forward-line)))
 210
 211 (defun notmuch-show-spaces-n (n)
 212   "Return a string comprised of `n' spaces."
 213   (make-string n ? ))
 214
 215 (defun notmuch-show-update-tags (tags)
 216   "Update the displayed tags of the current message."
 217   (save-excursion
 218     (goto-char (notmuch-show-message-top))
 219     (if (re-search-forward "(\\([^()]*\\))$" (line-end-position) t)
 220         (let ((inhibit-read-only t))
 221           (replace-match (concat "("
 222                                  (propertize (mapconcat 'identity tags " ")
 223                                              'face 'notmuch-tag-face)
 224                                  ")"))))))
 225
 226 (defun notmuch-show-clean-address (address)
 227   "Try to clean a single email ADDRESS for display.  Return
 228 unchanged ADDRESS if parsing fails."
 229   (condition-case nil
 230     (let* ((parsed (mail-header-parse-address address))
 231            (address (car parsed))
 232            (name (cdr parsed)))
 233       ;; Remove double quotes. They might be required during transport,
 234       ;; but we don't need to see them.
 235       (when name
 236         (setq name (replace-regexp-in-string "\"" "" name)))
 237       ;; If the address is 'foo@bar.com <foo@bar.com>' then show just
 238       ;; 'foo@bar.com'.
 239       (when (string= name address)
 240         (setq name nil))
 241
 242       (if (not name)
 243         address
 244         (concat name " <" address ">")))
 245     (error address)))
 246
 247 (defun notmuch-show-insert-headerline (headers date tags depth)
 248   "Insert a notmuch style headerline based on HEADERS for a
 249 message at DEPTH in the current thread."
 250   (let ((start (point)))
 251     (insert (notmuch-show-spaces-n (* notmuch-indent-messages-width depth))
 252             (notmuch-show-clean-address (plist-get headers :From))
 253             " ("
 254             date
 255             ") ("
 256             (propertize (mapconcat 'identity tags " ")
 257                         'face 'notmuch-tag-face)
 258             ")\n")
 259     (overlay-put (make-overlay start (point)) 'face 'notmuch-message-summary-face)))
 260
 261 (defun notmuch-show-insert-header (header header-value)
 262   "Insert a single header."
 263   (insert header ": " header-value "\n"))
 264
 265 (defun notmuch-show-insert-headers (headers)
 266   "Insert the headers of the current message."
 267   (let ((start (point)))
 268     (mapc '(lambda (header)
 269              (let* ((header-symbol (intern (concat ":" header)))
 270                     (header-value (plist-get headers header-symbol)))
 271                (if (and header-value
 272                         (not (string-equal "" header-value)))
 273                    (notmuch-show-insert-header header header-value))))
 274           notmuch-message-headers)
 275     (save-excursion
 276       (save-restriction
 277         (narrow-to-region start (point-max))
 278         (run-hooks 'notmuch-show-markup-headers-hook)))))
 279
 280 (define-button-type 'notmuch-show-part-button-type
 281   'action 'notmuch-show-part-button-action
 282   'follow-link t
 283   'face 'message-mml)
 284
 285 (defun notmuch-show-insert-part-header (nth content-type declared-type &optional name comment)
 286   (let ((button))
 287     (setq button
 288           (insert-button
 289            (concat "[ "
 290                    (if name (concat name ": ") "")
 291                    declared-type
 292                    (if (not (string-equal declared-type content-type))
 293                        (concat " (as " content-type ")")
 294                      "")
 295                    (or comment "")
 296                    " ]")
 297            :type 'notmuch-show-part-button-type
 298            :notmuch-part nth
 299            :notmuch-filename name))
 300     (insert "\n")
 301     ;; return button
 302     button))
 303
 304 ;; Functions handling particular MIME parts.
 305
 306 (defun notmuch-show-save-part (message-id nth &optional filename)
 307   (let ((process-crypto notmuch-show-process-crypto))
 308     (with-temp-buffer
 309       (setq notmuch-show-process-crypto process-crypto)
 310       ;; Always acquires the part via `notmuch part', even if it is
 311       ;; available in the JSON output.
 312       (insert (notmuch-show-get-bodypart-internal message-id nth))
 313       (let ((file (read-file-name
 314                    "Filename to save as: "
 315                    (or mailcap-download-directory "~/")
 316                    nil nil
 317                    filename)))
 318         ;; Don't re-compress .gz & al.  Arguably we should make
 319         ;; `file-name-handler-alist' nil, but that would chop
 320         ;; ange-ftp, which is reasonable to use here.
 321         (mm-write-region (point-min) (point-max) file nil nil nil 'no-conversion t)))))
 322
 323 (defun notmuch-show-mm-display-part-inline (msg part content-type content)
 324   "Use the mm-decode/mm-view functions to display a part in the
 325 current buffer, if possible."
 326   (let ((display-buffer (current-buffer)))
 327     (with-temp-buffer
 328       (insert content)
 329       (let ((handle (mm-make-handle (current-buffer) (list content-type))))
 330         (set-buffer display-buffer)
 331         (if (and (mm-inlinable-p handle)
 332                  (mm-inlined-p handle))
 333             (progn
 334               (mm-display-part handle)
 335               t)
 336           nil)))))
 337
 338 (defvar notmuch-show-multipart/alternative-discouraged
 339   '(
 340     ;; Avoid HTML parts.
 341     "text/html"
 342     ;; multipart/related usually contain a text/html part and some associated graphics.
 343     "multipart/related"
 344     ))
 345
 346 (defun notmuch-show-multipart/*-to-list (part)
 347   (mapcar '(lambda (inner-part) (plist-get inner-part :content-type))
 348           (plist-get part :content)))
 349
 350 (defun notmuch-show-multipart/alternative-choose (types)
 351   ;; Based on `mm-preferred-alternative-precedence'.
 352   (let ((seq types))
 353     (dolist (pref (reverse notmuch-show-multipart/alternative-discouraged))
 354       (dolist (elem (copy-sequence seq))
 355         (when (string-match pref elem)
 356           (setq seq (nconc (delete elem seq) (list elem))))))
 357     seq))
 358
 359 (defun notmuch-show-insert-part-multipart/alternative (msg part content-type nth depth declared-type)
 360   (notmuch-show-insert-part-header nth declared-type content-type nil)
 361   (let ((chosen-type (car (notmuch-show-multipart/alternative-choose (notmuch-show-multipart/*-to-list part))))
 362         (inner-parts (plist-get part :content))
 363         (start (point)))
 364     ;; This inserts all parts of the chosen type rather than just one,
 365     ;; but it's not clear that this is the wrong thing to do - which
 366     ;; should be chosen if there are more than one that match?
 367     (mapc (lambda (inner-part)
 368             (let ((inner-type (plist-get inner-part :content-type)))
 369               (if (or notmuch-show-all-multipart/alternative-parts
 370                       (string= chosen-type inner-type))
 371                   (notmuch-show-insert-bodypart msg inner-part depth)
 372                 (notmuch-show-insert-part-header (plist-get inner-part :id) inner-type inner-type nil " (not shown)"))))
 373           inner-parts)
 374
 375     (when notmuch-show-indent-multipart
 376       (indent-rigidly start (point) 1)))
 377   t)
 378
 379 (defun notmuch-show-setup-w3m ()
 380   "Instruct w3m how to retrieve content from a \"related\" part of a message."
 381   (interactive)
 382   (if (boundp 'w3m-cid-retrieve-function-alist)
 383     (unless (assq 'notmuch-show-mode w3m-cid-retrieve-function-alist)
 384       (push (cons 'notmuch-show-mode 'notmuch-show-w3m-cid-retrieve)
 385             w3m-cid-retrieve-function-alist)))
 386   (setq mm-inline-text-html-with-images t))
 387
 388 (defvar w3m-current-buffer) ;; From `w3m.el'.
 389 (defvar notmuch-show-w3m-cid-store nil)
 390 (make-variable-buffer-local 'notmuch-show-w3m-cid-store)
 391
 392 (defun notmuch-show-w3m-cid-store-internal (content-id
 393                                             message-id
 394                                             part-number
 395                                             content-type
 396                                             content)
 397   (push (list content-id
 398               message-id
 399               part-number
 400               content-type
 401               content)
 402         notmuch-show-w3m-cid-store))
 403
 404 (defun notmuch-show-w3m-cid-store (msg part)
 405   (let ((content-id (plist-get part :content-id)))
 406     (when content-id
 407       (notmuch-show-w3m-cid-store-internal (concat "cid:" content-id)
 408                                            (plist-get msg :id)
 409                                            (plist-get part :id)
 410                                            (plist-get part :content-type)
 411                                            nil))))
 412
 413 (defun notmuch-show-w3m-cid-retrieve (url &rest args)
 414   (let ((matching-part (with-current-buffer w3m-current-buffer
 415                          (assoc url notmuch-show-w3m-cid-store))))
 416     (if matching-part
 417         (let ((message-id (nth 1 matching-part))
 418               (part-number (nth 2 matching-part))
 419               (content-type (nth 3 matching-part))
 420               (content (nth 4 matching-part)))
 421           ;; If we don't already have the content, get it and cache
 422           ;; it, as some messages reference the same cid: part many
 423           ;; times (hundreds!), which results in many calls to
 424           ;; `notmuch part'.
 425           (unless content
 426             (setq content (notmuch-show-get-bodypart-internal (concat "id:" message-id)
 427                                                               part-number))
 428             (with-current-buffer w3m-current-buffer
 429               (notmuch-show-w3m-cid-store-internal url
 430                                                    message-id
 431                                                    part-number
 432                                                    content-type
 433                                                    content)))
 434           (insert content)
 435           content-type)
 436       nil)))
 437
 438 (defun notmuch-show-insert-part-multipart/related (msg part content-type nth depth declared-type)
 439   (notmuch-show-insert-part-header nth declared-type content-type nil)
 440   (let ((inner-parts (plist-get part :content))
 441         (start (point)))
 442
 443     ;; We assume that the first part is text/html and the remainder
 444     ;; things that it references.
 445
 446     ;; Stash the non-primary parts.
 447     (mapc (lambda (part)
 448             (notmuch-show-w3m-cid-store msg part))
 449           (cdr inner-parts))
 450
 451     ;; Render the primary part.
 452     (notmuch-show-insert-bodypart msg (car inner-parts) depth)
 453
 454     (when notmuch-show-indent-multipart
 455       (indent-rigidly start (point) 1)))
 456   t)
 457
 458 (defun notmuch-show-insert-part-multipart/signed (msg part content-type nth depth declared-type)
 459   (let ((button (notmuch-show-insert-part-header nth declared-type content-type nil)))
 460     (button-put button 'face '(:foreground "blue"))
 461     ;; add signature status button if sigstatus provided
 462     (if (plist-member part :sigstatus)
 463         (let* ((headers (plist-get msg :headers))
 464                (from (plist-get headers :From))
 465                (sigstatus (car (plist-get part :sigstatus))))
 466           (notmuch-crypto-insert-sigstatus-button sigstatus from))
 467       ;; if we're not adding sigstatus, tell the user how they can get it
 468       (button-put button 'help-echo "Set notmuch-crypto-process-mime to process cryptographic mime parts.")))
 469
 470   (let ((inner-parts (plist-get part :content))
 471         (start (point)))
 472     ;; Show all of the parts.
 473     (mapc (lambda (inner-part)
 474             (notmuch-show-insert-bodypart msg inner-part depth))
 475           inner-parts)
 476
 477     (when notmuch-show-indent-multipart
 478       (indent-rigidly start (point) 1)))
 479   t)
 480
 481 (defun notmuch-show-insert-part-multipart/encrypted (msg part content-type nth depth declared-type)
 482   (let ((button (notmuch-show-insert-part-header nth declared-type content-type nil)))
 483     (button-put button 'face '(:foreground "blue"))
 484     ;; add encryption status button if encstatus specified
 485     (if (plist-member part :encstatus)
 486         (let ((encstatus (car (plist-get part :encstatus))))
 487           (notmuch-crypto-insert-encstatus-button encstatus)
 488           ;; add signature status button if sigstatus specified
 489           (if (plist-member part :sigstatus)
 490               (let* ((headers (plist-get msg :headers))
 491                      (from (plist-get headers :From))
 492                      (sigstatus (car (plist-get part :sigstatus))))
 493                 (notmuch-crypto-insert-sigstatus-button sigstatus from))))
 494       ;; if we're not adding encstatus, tell the user how they can get it
 495       (button-put button 'help-echo "Set notmuch-crypto-process-mime to process cryptographic mime parts.")))
 496
 497   (let ((inner-parts (plist-get part :content))
 498         (start (point)))
 499     ;; Show all of the parts.
 500     (mapc (lambda (inner-part)
 501             (notmuch-show-insert-bodypart msg inner-part depth))
 502           inner-parts)
 503
 504     (when notmuch-show-indent-multipart
 505       (indent-rigidly start (point) 1)))
 506   t)
 507
 508 (defun notmuch-show-insert-part-multipart/* (msg part content-type nth depth declared-type)
 509   (notmuch-show-insert-part-header nth declared-type content-type nil)
 510   (let ((inner-parts (plist-get part :content))
 511         (start (point)))
 512     ;; Show all of the parts.
 513     (mapc (lambda (inner-part)
 514             (notmuch-show-insert-bodypart msg inner-part depth))
 515           inner-parts)
 516
 517     (when notmuch-show-indent-multipart
 518       (indent-rigidly start (point) 1)))
 519   t)
 520
 521 (defun notmuch-show-insert-part-message/rfc822 (msg part content-type nth depth declared-type)
 522   (notmuch-show-insert-part-header nth declared-type content-type nil)
 523   (let* ((message (car (plist-get part :content)))
 524          (headers (plist-get message :headers))
 525          (body (car (plist-get message :body)))
 526          (start (point)))
 527
 528     ;; Override `notmuch-message-headers' to force `From' to be
 529     ;; displayed.
 530     (let ((notmuch-message-headers '("From" "Subject" "To" "Cc" "Date")))
 531       (notmuch-show-insert-headers (plist-get message :headers)))
 532
 533     ;; Blank line after headers to be compatible with the normal
 534     ;; message display.
 535     (insert "\n")
 536
 537     ;; Show the body
 538     (notmuch-show-insert-bodypart msg body depth)
 539
 540     (when notmuch-show-indent-multipart
 541       (indent-rigidly start (point) 1)))
 542   t)
 543
 544 (defun notmuch-show-insert-part-text/plain (msg part content-type nth depth declared-type)
 545   (let ((start (point)))
 546     ;; If this text/plain part is not the first part in the message,
 547     ;; insert a header to make this clear.
 548     (if (> nth 1)
 549         (notmuch-show-insert-part-header nth declared-type content-type (plist-get part :filename)))
 550     (insert (notmuch-show-get-bodypart-content msg part nth))
 551     (save-excursion
 552       (save-restriction
 553         (narrow-to-region start (point-max))
 554         (run-hook-with-args 'notmuch-show-insert-text/plain-hook msg depth))))
 555   t)
 556
 557 (defun notmuch-show-insert-part-text/x-vcalendar (msg part content-type nth depth declared-type)
 558   (notmuch-show-insert-part-header nth declared-type content-type (plist-get part :filename))
 559   (insert (with-temp-buffer
 560             (insert (notmuch-show-get-bodypart-content msg part nth))
 561             (goto-char (point-min))
 562             (let ((file (make-temp-file "notmuch-ical"))
 563                   result)
 564               (icalendar--convert-ical-to-diary
 565                (icalendar--read-element nil nil)
 566                file t)
 567               (set-buffer (get-file-buffer file))
 568               (setq result (buffer-substring (point-min) (point-max)))
 569               (set-buffer-modified-p nil)
 570               (kill-buffer (current-buffer))
 571               (delete-file file)
 572               result)))
 573   t)
 574
 575 (defun notmuch-show-insert-part-application/octet-stream (msg part content-type nth depth declared-type)
 576   ;; If we can deduce a MIME type from the filename of the attachment,
 577   ;; do so and pass it on to the handler for that type.
 578   (if (plist-get part :filename)
 579       (let ((extension (file-name-extension (plist-get part :filename)))
 580             mime-type)
 581         (if extension
 582             (progn
 583               (mailcap-parse-mimetypes)
 584               (setq mime-type (mailcap-extension-to-mime extension))
 585               (if (and mime-type
 586                        (not (string-equal mime-type "application/octet-stream")))
 587                   (notmuch-show-insert-bodypart-internal msg part mime-type nth depth content-type)
 588                 nil))
 589           nil))))
 590
 591 (defun notmuch-show-insert-part-application/* (msg part content-type nth depth declared-type
 592 )
 593   ;; do not render random "application" parts
 594   (notmuch-show-insert-part-header nth content-type declared-type (plist-get part :filename)))
 595
 596 (defun notmuch-show-insert-part-*/* (msg part content-type nth depth declared-type)
 597   ;; This handler _must_ succeed - it is the handler of last resort.
 598   (notmuch-show-insert-part-header nth content-type declared-type (plist-get part :filename))
 599   (let ((content (notmuch-show-get-bodypart-content msg part nth)))
 600     (if content
 601         (notmuch-show-mm-display-part-inline msg part content-type content)))
 602   t)
 603
 604 ;; Functions for determining how to handle MIME parts.
 605
 606 (defun notmuch-show-split-content-type (content-type)
 607   (split-string content-type "/"))
 608
 609 (defun notmuch-show-handlers-for (content-type)
 610   "Return a list of content handlers for a part of type CONTENT-TYPE."
 611   (let (result)
 612     (mapc (lambda (func)
 613             (if (functionp func)
 614                 (push func result)))
 615           ;; Reverse order of prefrence.
 616           (list (intern (concat "notmuch-show-insert-part-*/*"))
 617                 (intern (concat
 618                          "notmuch-show-insert-part-"
 619                          (car (notmuch-show-split-content-type content-type))
 620                          "/*"))
 621                 (intern (concat "notmuch-show-insert-part-" content-type))))
 622     result))
 623
 624 ;; Helper for parts which are generally not included in the default
 625 ;; JSON output.
 626 ;; Uses the buffer-local variable notmuch-show-process-crypto to
 627 ;; determine if parts should be decrypted first.
 628 (defun notmuch-show-get-bodypart-internal (message-id part-number)
 629   (let ((args '("show" "--format=raw"))
 630         (part-arg (format "--part=%s" part-number)))
 631     (setq args (append args (list part-arg)))
 632     (if notmuch-show-process-crypto
 633         (setq args (append args '("--decrypt"))))
 634     (setq args (append args (list message-id)))
 635     (with-temp-buffer
 636       (let ((coding-system-for-read 'no-conversion))
 637         (progn
 638           (apply 'call-process (append (list notmuch-command nil (list t nil) nil) args))
 639           (buffer-string))))))
 640
 641 (defun notmuch-show-get-bodypart-content (msg part nth)
 642   (or (plist-get part :content)
 643       (notmuch-show-get-bodypart-internal (concat "id:" (plist-get msg :id)) nth)))
 644
 645 ;; \f
 646
 647 (defun notmuch-show-insert-bodypart-internal (msg part content-type nth depth declared-type)
 648   (let ((handlers (notmuch-show-handlers-for content-type)))
 649     ;; Run the content handlers until one of them returns a non-nil
 650     ;; value.
 651     (while (and handlers
 652                 (not (funcall (car handlers) msg part content-type nth depth declared-type)))
 653       (setq handlers (cdr handlers))))
 654   t)
 655
 656 (defun notmuch-show-insert-bodypart (msg part depth)
 657   "Insert the body part PART at depth DEPTH in the current thread."
 658   (let ((content-type (downcase (plist-get part :content-type)))
 659         (nth (plist-get part :id)))
 660     (notmuch-show-insert-bodypart-internal msg part content-type nth depth content-type))
 661   ;; Some of the body part handlers leave point somewhere up in the
 662   ;; part, so we make sure that we're down at the end.
 663   (goto-char (point-max))
 664   ;; Ensure that the part ends with a carriage return.
 665   (if (not (bolp))
 666       (insert "\n")))
 667
 668 (defun notmuch-show-insert-body (msg body depth)
 669   "Insert the body BODY at depth DEPTH in the current thread."
 670   (mapc '(lambda (part) (notmuch-show-insert-bodypart msg part depth)) body))
 671
 672 (defun notmuch-show-make-symbol (type)
 673   (make-symbol (concat "notmuch-show-" type)))
 674
 675 (defun notmuch-show-strip-re (string)
 676   (replace-regexp-in-string "\\([Rr]e: *\\)+" "" string))
 677
 678 (defvar notmuch-show-previous-subject "")
 679 (make-variable-buffer-local 'notmuch-show-previous-subject)
 680
 681 (defun notmuch-show-insert-msg (msg depth)
 682   "Insert the message MSG at depth DEPTH in the current thread."
 683   (let* ((headers (plist-get msg :headers))
 684          ;; Indentation causes the buffer offset of the start/end
 685          ;; points to move, so we must use markers.
 686          message-start message-end
 687          content-start content-end
 688          headers-start headers-end
 689          body-start body-end
 690          (headers-invis-spec (notmuch-show-make-symbol "header"))
 691          (message-invis-spec (notmuch-show-make-symbol "message"))
 692          (bare-subject (notmuch-show-strip-re (plist-get headers :Subject))))
 693
 694     ;; Set `buffer-invisibility-spec' to `nil' (a list), otherwise
 695     ;; removing items from `buffer-invisibility-spec' (which is what
 696     ;; `notmuch-show-headers-visible' and
 697     ;; `notmuch-show-message-visible' do) is a no-op and has no
 698     ;; effect. This caused threads with only matching messages to have
 699     ;; those messages hidden initially because
 700     ;; `buffer-invisibility-spec' stayed `t'.
 701     ;;
 702     ;; This needs to be set here (rather than just above the call to
 703     ;; `notmuch-show-headers-visible') because some of the part
 704     ;; rendering or body washing functions
 705     ;; (e.g. `notmuch-wash-text/plain-citations') manipulate
 706     ;; `buffer-invisibility-spec').
 707     (when (eq buffer-invisibility-spec t)
 708       (setq buffer-invisibility-spec nil))
 709
 710     (setq message-start (point-marker))
 711
 712     (notmuch-show-insert-headerline headers
 713                                     (or (if notmuch-show-relative-dates
 714                                             (plist-get msg :date_relative)
 715                                           nil)
 716                                         (plist-get headers :Date))
 717                                     (plist-get msg :tags) depth)
 718
 719     (setq content-start (point-marker))
 720
 721     (plist-put msg :headers-invis-spec headers-invis-spec)
 722     (plist-put msg :message-invis-spec message-invis-spec)
 723
 724     ;; Set `headers-start' to point after the 'Subject:' header to be
 725     ;; compatible with the existing implementation. This just sets it
 726     ;; to after the first header.
 727     (notmuch-show-insert-headers headers)
 728     ;; Headers should include a blank line (backwards compatibility).
 729     (insert "\n")
 730     (save-excursion
 731       (goto-char content-start)
 732       ;; If the subject of this message is the same as that of the
 733       ;; previous message, don't display it when this message is
 734       ;; collapsed.
 735       (when (not (string= notmuch-show-previous-subject
 736                           bare-subject))
 737         (forward-line 1))
 738       (setq headers-start (point-marker)))
 739     (setq headers-end (point-marker))
 740
 741     (setq notmuch-show-previous-subject bare-subject)
 742
 743     (setq body-start (point-marker))
 744     (notmuch-show-insert-body msg (plist-get msg :body) depth)
 745     ;; Ensure that the body ends with a newline.
 746     (if (not (bolp))
 747         (insert "\n"))
 748     (setq body-end (point-marker))
 749     (setq content-end (point-marker))
 750
 751     ;; Indent according to the depth in the thread.
 752     (indent-rigidly content-start content-end (* notmuch-indent-messages-width depth))
 753
 754     (setq message-end (point-max-marker))
 755
 756     ;; Save the extents of this message over the whole text of the
 757     ;; message.
 758     (put-text-property message-start message-end :notmuch-message-extent (cons message-start message-end))
 759
 760     (let ((headers-overlay (make-overlay headers-start headers-end))
 761           (invis-specs (list headers-invis-spec message-invis-spec)))
 762       (overlay-put headers-overlay 'invisible invis-specs)
 763       (overlay-put headers-overlay 'priority 10))
 764     (overlay-put (make-overlay body-start body-end) 'invisible message-invis-spec)
 765
 766     ;; Save the properties for this message. Currently this saves the
 767     ;; entire message (augmented it with other stuff), which seems
 768     ;; like overkill. We might save a reduced subset (for example, not
 769     ;; the content).
 770     (notmuch-show-set-message-properties msg)
 771
 772     ;; Set header visibility.
 773     (notmuch-show-headers-visible msg notmuch-message-headers-visible)
 774
 775     ;; Message visibility depends on whether it matched the search
 776     ;; criteria.
 777     (notmuch-show-message-visible msg (plist-get msg :match))))
 778
 779 (defun notmuch-show-insert-tree (tree depth)
 780   "Insert the message tree TREE at depth DEPTH in the current thread."
 781   (let ((msg (car tree))
 782         (replies (cadr tree)))
 783     (notmuch-show-insert-msg msg depth)
 784     (notmuch-show-insert-thread replies (1+ depth))))
 785
 786 (defun notmuch-show-insert-thread (thread depth)
 787   "Insert the thread THREAD at depth DEPTH in the current forest."
 788   (mapc '(lambda (tree) (notmuch-show-insert-tree tree depth)) thread))
 789
 790 (defun notmuch-show-insert-forest (forest)
 791   "Insert the forest of threads FOREST."
 792   (mapc '(lambda (thread) (notmuch-show-insert-thread thread 0)) forest))
 793
 794 (defvar notmuch-show-thread-id nil)
 795 (make-variable-buffer-local 'notmuch-show-thread-id)
 796 (defvar notmuch-show-parent-buffer nil)
 797 (make-variable-buffer-local 'notmuch-show-parent-buffer)
 798 (defvar notmuch-show-query-context nil)
 799 (make-variable-buffer-local 'notmuch-show-query-context)
 800 (defvar notmuch-show-buffer-name nil)
 801 (make-variable-buffer-local 'notmuch-show-buffer-name)
 802
 803 (defun notmuch-show-buttonise-links (start end)
 804   "Buttonise URLs and mail addresses between START and END.
 805
 806 This also turns id:\"<message id>\"-parts into buttons for
 807 a corresponding notmuch search."
 808   (goto-address-fontify-region start end)
 809   (save-excursion
 810     (goto-char start)
 811     (while (re-search-forward "id:\\(\"?\\)[^[:space:]\"]+\\1" end t)
 812       ;; remove the overlay created by goto-address-mode
 813       (remove-overlays (match-beginning 0) (match-end 0) 'goto-address t)
 814       (make-text-button (match-beginning 0) (match-end 0)
 815                         'action `(lambda (arg)
 816                                    (notmuch-search ,(match-string-no-properties 0)))
 817                         'follow-link t
 818                         'help-echo "Mouse-1, RET: search for this message"
 819                         'face goto-address-mail-face))))
 820
 821 ;;;###autoload
 822 (defun notmuch-show (thread-id &optional parent-buffer query-context buffer-name crypto-switch)
 823   "Run \"notmuch show\" with the given thread ID and display results.
 824
 825 The optional PARENT-BUFFER is the notmuch-search buffer from
 826 which this notmuch-show command was executed, (so that the
 827 next thread from that buffer can be show when done with this
 828 one).
 829
 830 The optional QUERY-CONTEXT is a notmuch search term. Only
 831 messages from the thread matching this search term are shown if
 832 non-nil.
 833
 834 The optional BUFFER-NAME provides the name of the buffer in
 835 which the message thread is shown. If it is nil (which occurs
 836 when the command is called interactively) the argument to the
 837 function is used.
 838
 839 The optional CRYPTO-SWITCH toggles the value of the
 840 notmuch-crypto-process-mime customization variable for this show
 841 buffer."
 842   (interactive "sNotmuch show: ")
 843   (let* ((process-crypto (if crypto-switch
 844                              (not notmuch-crypto-process-mime)
 845                            notmuch-crypto-process-mime)))
 846     (notmuch-show-worker thread-id parent-buffer query-context buffer-name process-crypto)))
 847
 848 (defun notmuch-show-worker (thread-id parent-buffer query-context buffer-name process-crypto)
 849   (let* ((buffer-name (generate-new-buffer-name
 850                        (or buffer-name
 851                            (concat "*notmuch-" thread-id "*"))))
 852          (buffer (get-buffer-create buffer-name))
 853          (inhibit-read-only t))
 854     (switch-to-buffer buffer)
 855     (notmuch-show-mode)
 856     ;; Don't track undo information for this buffer
 857     (set 'buffer-undo-list t)
 858
 859     (setq notmuch-show-thread-id thread-id)
 860     (setq notmuch-show-parent-buffer parent-buffer)
 861     (setq notmuch-show-query-context query-context)
 862     (setq notmuch-show-buffer-name buffer-name)
 863     (setq notmuch-show-process-crypto process-crypto)
 864
 865     (erase-buffer)
 866     (goto-char (point-min))
 867     (save-excursion
 868       (let* ((basic-args (list thread-id))
 869              (args (if query-context
 870                        (append (list "\'") basic-args (list "and (" query-context ")\'"))
 871                      (append (list "\'") basic-args (list "\'")))))
 872         (notmuch-show-insert-forest (notmuch-query-get-threads args))
 873         ;; If the query context reduced the results to nothing, run
 874         ;; the basic query.
 875         (when (and (eq (buffer-size) 0)
 876                    query-context)
 877           (notmuch-show-insert-forest
 878            (notmuch-query-get-threads basic-args))))
 879
 880       (jit-lock-register #'notmuch-show-buttonise-links)
 881
 882       ;; Act on visual lines rather than logical lines.
 883       (visual-line-mode t)
 884
 885       (run-hooks 'notmuch-show-hook))
 886
 887     ;; Move straight to the first open message
 888     (if (not (notmuch-show-message-visible-p))
 889         (notmuch-show-next-open-message))
 890
 891     ;; Set the header line to the subject of the first open message.
 892     (setq header-line-format (notmuch-show-strip-re (notmuch-show-get-subject)))
 893
 894     (notmuch-show-mark-read)))
 895
 896 (defun notmuch-show-refresh-view (&optional crypto-switch)
 897   "Refresh the current view (with crypto switch if prefix given).
 898
 899 Kills the current buffer and reruns notmuch show with the same
 900 thread id.  If a prefix is given, crypto processing is toggled."
 901   (interactive "P")
 902   (let ((thread-id notmuch-show-thread-id)
 903         (parent-buffer notmuch-show-parent-buffer)
 904         (query-context notmuch-show-query-context)
 905         (buffer-name notmuch-show-buffer-name)
 906         (process-crypto (if crypto-switch
 907                             (not notmuch-show-process-crypto)
 908                           notmuch-show-process-crypto)))
 909     (notmuch-kill-this-buffer)
 910     (notmuch-show-worker thread-id parent-buffer query-context buffer-name process-crypto)))
 911
 912 (defvar notmuch-show-stash-map
 913   (let ((map (make-sparse-keymap)))
 914     (define-key map "c" 'notmuch-show-stash-cc)
 915     (define-key map "d" 'notmuch-show-stash-date)
 916     (define-key map "F" 'notmuch-show-stash-filename)
 917     (define-key map "f" 'notmuch-show-stash-from)
 918     (define-key map "i" 'notmuch-show-stash-message-id)
 919     (define-key map "I" 'notmuch-show-stash-message-id-stripped)
 920     (define-key map "s" 'notmuch-show-stash-subject)
 921     (define-key map "T" 'notmuch-show-stash-tags)
 922     (define-key map "t" 'notmuch-show-stash-to)
 923     map)
 924   "Submap for stash commands")
 925 (fset 'notmuch-show-stash-map notmuch-show-stash-map)
 926
 927 (defvar notmuch-show-mode-map
 928       (let ((map (make-sparse-keymap)))
 929         (define-key map "?" 'notmuch-help)
 930         (define-key map "q" 'notmuch-kill-this-buffer)
 931         (define-key map (kbd "<C-tab>") 'widget-backward)
 932         (define-key map (kbd "M-TAB") 'notmuch-show-previous-button)
 933         (define-key map (kbd "<backtab>") 'notmuch-show-previous-button)
 934         (define-key map (kbd "TAB") 'notmuch-show-next-button)
 935         (define-key map "s" 'notmuch-search)
 936         (define-key map "m" 'notmuch-mua-new-mail)
 937         (define-key map "f" 'notmuch-show-forward-message)
 938         (define-key map "r" 'notmuch-show-reply)
 939         (define-key map "|" 'notmuch-show-pipe-message)
 940         (define-key map "w" 'notmuch-show-save-attachments)
 941         (define-key map "V" 'notmuch-show-view-raw-message)
 942         (define-key map "v" 'notmuch-show-view-all-mime-parts)
 943         (define-key map "c" 'notmuch-show-stash-map)
 944         (define-key map "=" 'notmuch-show-refresh-view)
 945         (define-key map "h" 'notmuch-show-toggle-headers)
 946         (define-key map "-" 'notmuch-show-remove-tag)
 947         (define-key map "+" 'notmuch-show-add-tag)
 948         (define-key map "x" 'notmuch-show-archive-thread-then-exit)
 949         (define-key map "a" 'notmuch-show-archive-thread)
 950         (define-key map "N" 'notmuch-show-next-message)
 951         (define-key map "P" 'notmuch-show-previous-message)
 952         (define-key map "n" 'notmuch-show-next-open-message)
 953         (define-key map "p" 'notmuch-show-previous-open-message)
 954         (define-key map (kbd "DEL") 'notmuch-show-rewind)
 955         (define-key map " " 'notmuch-show-advance-and-archive)
 956         (define-key map (kbd "M-RET") 'notmuch-show-open-or-close-all)
 957         (define-key map (kbd "RET") 'notmuch-show-toggle-message)
 958         map)
 959       "Keymap for \"notmuch show\" buffers.")
 960 (fset 'notmuch-show-mode-map notmuch-show-mode-map)
 961
 962 (defun notmuch-show-mode ()
 963   "Major mode for viewing a thread with notmuch.
 964
 965 This buffer contains the results of the \"notmuch show\" command
 966 for displaying a single thread of email from your email archives.
 967
 968 By default, various components of email messages, (citations,
 969 signatures, already-read messages), are hidden. You can make
 970 these parts visible by clicking with the mouse button or by
 971 pressing RET after positioning the cursor on a hidden part, (for
 972 which \\[notmuch-show-next-button] and \\[notmuch-show-previous-button] are helpful).
 973
 974 Reading the thread sequentially is well-supported by pressing
 975 \\[notmuch-show-advance-and-archive]. This will scroll the current message (if necessary), advance
 976 to the next message, or advance to the next thread (if already on
 977 the last message of a thread).
 978
 979 Other commands are available to read or manipulate the thread
 980 more selectively, (such as '\\[notmuch-show-next-message]' and '\\[notmuch-show-previous-message]' to advance to messages
 981 without removing any tags, and '\\[notmuch-show-archive-thread]' to archive an entire thread
 982 without scrolling through with \\[notmuch-show-advance-and-archive]).
 983
 984 You can add or remove arbitrary tags from the current message with
 985 '\\[notmuch-show-add-tag]' or '\\[notmuch-show-remove-tag]'.
 986
 987 All currently available key bindings:
 988
 989 \\{notmuch-show-mode-map}"
 990   (interactive)
 991   (kill-all-local-variables)
 992   (use-local-map notmuch-show-mode-map)
 993   (setq major-mode 'notmuch-show-mode
 994         mode-name "notmuch-show")
 995   (setq buffer-read-only t))
 996
 997 (defun notmuch-show-move-to-message-top ()
 998   (goto-char (notmuch-show-message-top)))
 999
1000 (defun notmuch-show-move-to-message-bottom ()
1001   (goto-char (notmuch-show-message-bottom)))
1002
1003 (defun notmuch-show-message-adjust ()
1004   (recenter 0))
1005
1006 ;; Movement related functions.
1007
1008 ;; There's some strangeness here where a text property applied to a
1009 ;; region a->b is not found when point is at b. We walk backwards
1010 ;; until finding the property.
1011 (defun notmuch-show-message-extent ()
1012   (let (r)
1013     (save-excursion
1014       (while (not (setq r (get-text-property (point) :notmuch-message-extent)))
1015         (backward-char)))
1016     r))
1017
1018 (defun notmuch-show-message-top ()
1019   (car (notmuch-show-message-extent)))
1020
1021 (defun notmuch-show-message-bottom ()
1022   (cdr (notmuch-show-message-extent)))
1023
1024 (defun notmuch-show-goto-message-next ()
1025   (let ((start (point)))
1026     (notmuch-show-move-to-message-bottom)
1027     (if (not (eobp))
1028         t
1029       (goto-char start)
1030       nil)))
1031
1032 (defun notmuch-show-goto-message-previous ()
1033   (notmuch-show-move-to-message-top)
1034   (if (bobp)
1035       nil
1036     (backward-char)
1037     (notmuch-show-move-to-message-top)
1038     t))
1039
1040 ;; Functions relating to the visibility of messages and their
1041 ;; components.
1042
1043 (defun notmuch-show-element-visible (props visible-p spec-property)
1044   (let ((spec (plist-get props spec-property)))
1045     (if visible-p
1046         (remove-from-invisibility-spec spec)
1047       (add-to-invisibility-spec spec))))
1048
1049 (defun notmuch-show-message-visible (props visible-p)
1050   (notmuch-show-element-visible props visible-p :message-invis-spec)
1051   (notmuch-show-set-prop :message-visible visible-p props))
1052
1053 (defun notmuch-show-headers-visible (props visible-p)
1054   (notmuch-show-element-visible props visible-p :headers-invis-spec)
1055   (notmuch-show-set-prop :headers-visible visible-p props))
1056
1057 ;; Functions for setting and getting attributes of the current
1058 ;; message.
1059
1060 (defun notmuch-show-set-message-properties (props)
1061   (save-excursion
1062     (notmuch-show-move-to-message-top)
1063     (put-text-property (point) (+ (point) 1) :notmuch-message-properties props)))
1064
1065 (defun notmuch-show-get-message-properties ()
1066   (save-excursion
1067     (notmuch-show-move-to-message-top)
1068     (get-text-property (point) :notmuch-message-properties)))
1069
1070 (defun notmuch-show-set-prop (prop val &optional props)
1071   (let ((inhibit-read-only t)
1072         (props (or props
1073                    (notmuch-show-get-message-properties))))
1074     (plist-put props prop val)
1075     (notmuch-show-set-message-properties props)))
1076
1077 (defun notmuch-show-get-prop (prop &optional props)
1078   (let ((props (or props
1079                    (notmuch-show-get-message-properties))))
1080     (plist-get props prop)))
1081
1082 (defun notmuch-show-get-message-id ()
1083   "Return the message id of the current message."
1084   (concat "id:\"" (notmuch-show-get-prop :id) "\""))
1085
1086 ;; dme: Would it make sense to use a macro for many of these?
1087
1088 (defun notmuch-show-get-filename ()
1089   "Return the filename of the current message."
1090   (notmuch-show-get-prop :filename))
1091
1092 (defun notmuch-show-get-header (header)
1093   "Return the named header of the current message, if any."
1094   (plist-get (notmuch-show-get-prop :headers) header))
1095
1096 (defun notmuch-show-get-cc ()
1097   (notmuch-show-get-header :Cc))
1098
1099 (defun notmuch-show-get-date ()
1100   (notmuch-show-get-header :Date))
1101
1102 (defun notmuch-show-get-from ()
1103   (notmuch-show-get-header :From))
1104
1105 (defun notmuch-show-get-subject ()
1106   (notmuch-show-get-header :Subject))
1107
1108 (defun notmuch-show-get-to ()
1109   (notmuch-show-get-header :To))
1110
1111 (defun notmuch-show-set-tags (tags)
1112   "Set the tags of the current message."
1113   (notmuch-show-set-prop :tags tags)
1114   (notmuch-show-update-tags tags))
1115
1116 (defun notmuch-show-get-tags ()
1117   "Return the tags of the current message."
1118   (notmuch-show-get-prop :tags))
1119
1120 (defun notmuch-show-message-visible-p ()
1121   "Is the current message visible?"
1122   (notmuch-show-get-prop :message-visible))
1123
1124 (defun notmuch-show-headers-visible-p ()
1125   "Are the headers of the current message visible?"
1126   (notmuch-show-get-prop :headers-visible))
1127
1128 (defun notmuch-show-mark-read ()
1129   "Mark the current message as read."
1130   (notmuch-show-remove-tag "unread"))
1131
1132 ;; Functions for getting attributes of several messages in the current
1133 ;; thread.
1134
1135 (defun notmuch-show-get-message-ids-for-open-messages ()
1136   "Return a list of all message IDs for open messages in the current thread."
1137   (save-excursion
1138     (let (message-ids done)
1139       (goto-char (point-min))
1140       (while (not done)
1141         (if (notmuch-show-message-visible-p)
1142             (setq message-ids (append message-ids (list (notmuch-show-get-message-id)))))
1143         (setq done (not (notmuch-show-goto-message-next)))
1144         )
1145       message-ids
1146       )))
1147
1148 ;; Commands typically bound to keys.
1149
1150 (defun notmuch-show-advance ()
1151   "Advance through thread.
1152
1153 If the current message in the thread is not yet fully visible,
1154 scroll by a near screenful to read more of the message.
1155
1156 Otherwise, (the end of the current message is already within the
1157 current window), advance to the next open message."
1158   (interactive)
1159   (let* ((end-of-this-message (notmuch-show-message-bottom))
1160          (visible-end-of-this-message (1- end-of-this-message))
1161          (ret nil))
1162     (while (invisible-p visible-end-of-this-message)
1163       (setq visible-end-of-this-message
1164             (previous-single-char-property-change visible-end-of-this-message
1165                                                   'invisible)))
1166     (cond
1167      ;; Ideally we would test `end-of-this-message' against the result
1168      ;; of `window-end', but that doesn't account for the fact that
1169      ;; the end of the message might be hidden.
1170      ((and visible-end-of-this-message
1171            (> visible-end-of-this-message (window-end)))
1172       ;; The bottom of this message is not visible - scroll.
1173       (scroll-up nil))
1174
1175      ((not (= end-of-this-message (point-max)))
1176       ;; This is not the last message - move to the next visible one.
1177       (notmuch-show-next-open-message))
1178
1179      (t
1180       ;; This is the last message - change the return value
1181       (setq ret t)))
1182     ret))
1183
1184 (defun notmuch-show-advance-and-archive ()
1185   "Advance through thread and archive.
1186
1187 This command is intended to be one of the simplest ways to
1188 process a thread of email. It works exactly like
1189 notmuch-show-advance, in that it scrolls through messages in a
1190 show buffer, except that when it gets to the end of the buffer it
1191 archives the entire current thread, (remove the \"inbox\" tag
1192 from each message), kills the buffer, and displays the next
1193 thread from the search from which this thread was originally
1194 shown."
1195   (interactive)
1196   (if (notmuch-show-advance)
1197       (notmuch-show-archive-thread)))
1198
1199 (defun notmuch-show-rewind ()
1200   "Backup through the thread, (reverse scrolling compared to \\[notmuch-show-advance-and-archive]).
1201
1202 Specifically, if the beginning of the previous email is fewer
1203 than `window-height' lines from the current point, move to it
1204 just like `notmuch-show-previous-message'.
1205
1206 Otherwise, just scroll down a screenful of the current message.
1207
1208 This command does not modify any message tags, (it does not undo
1209 any effects from previous calls to
1210 `notmuch-show-advance-and-archive'."
1211   (interactive)
1212   (let ((start-of-message (notmuch-show-message-top))
1213         (start-of-window (window-start)))
1214     (cond
1215       ;; Either this message is properly aligned with the start of the
1216       ;; window or the start of this message is not visible on the
1217       ;; screen - scroll.
1218      ((or (= start-of-message start-of-window)
1219           (< start-of-message start-of-window))
1220       (scroll-down)
1221       ;; If a small number of lines from the previous message are
1222       ;; visible, realign so that the top of the current message is at
1223       ;; the top of the screen.
1224       (if (<= (count-screen-lines (window-start) start-of-message)
1225               next-screen-context-lines)
1226           (progn
1227             (goto-char (notmuch-show-message-top))
1228             (notmuch-show-message-adjust)))
1229       ;; Move to the top left of the window.
1230       (goto-char (window-start)))
1231      (t
1232       ;; Move to the previous message.
1233       (notmuch-show-previous-message)))))
1234
1235 (defun notmuch-show-reply (&optional prompt-for-sender)
1236   "Reply to the current message."
1237   (interactive "P")
1238   (notmuch-mua-new-reply (notmuch-show-get-message-id) prompt-for-sender))
1239
1240 (defun notmuch-show-forward-message (&optional prompt-for-sender)
1241   "Forward the current message."
1242   (interactive "P")
1243   (with-current-notmuch-show-message
1244    (notmuch-mua-new-forward-message prompt-for-sender)))
1245
1246 (defun notmuch-show-next-message ()
1247   "Show the next message."
1248   (interactive)
1249   (if (notmuch-show-goto-message-next)
1250       (progn
1251         (notmuch-show-mark-read)
1252         (notmuch-show-message-adjust))
1253     (goto-char (point-max))))
1254
1255 (defun notmuch-show-previous-message ()
1256   "Show the previous message."
1257   (interactive)
1258   (notmuch-show-goto-message-previous)
1259   (notmuch-show-mark-read)
1260   (notmuch-show-message-adjust))
1261
1262 (defun notmuch-show-next-open-message ()
1263   "Show the next message."
1264   (interactive)
1265   (let (r)
1266     (while (and (setq r (notmuch-show-goto-message-next))
1267                 (not (notmuch-show-message-visible-p))))
1268     (if r
1269         (progn
1270           (notmuch-show-mark-read)
1271           (notmuch-show-message-adjust))
1272       (goto-char (point-max)))))
1273
1274 (defun notmuch-show-previous-open-message ()
1275   "Show the previous message."
1276   (interactive)
1277   (while (and (notmuch-show-goto-message-previous)
1278               (not (notmuch-show-message-visible-p))))
1279   (notmuch-show-mark-read)
1280   (notmuch-show-message-adjust))
1281
1282 (defun notmuch-show-view-raw-message ()
1283   "View the file holding the current message."
1284   (interactive)
1285   (let* ((id (notmuch-show-get-message-id))
1286          (buf (get-buffer-create (concat "*notmuch-raw-" id "*"))))
1287     (call-process notmuch-command nil buf nil "show" "--format=raw" id)
1288     (switch-to-buffer buf)
1289     (goto-char (point-min))
1290     (set-buffer-modified-p nil)
1291     (view-buffer buf 'kill-buffer-if-not-modified)))
1292
1293 (defun notmuch-show-pipe-message (entire-thread command)
1294   "Pipe the contents of the current message (or thread) to the given command.
1295
1296 The given command will be executed with the raw contents of the
1297 current email message as stdin. Anything printed by the command
1298 to stdout or stderr will appear in the *notmuch-pipe* buffer.
1299
1300 When invoked with a prefix argument, the command will receive all
1301 open messages in the current thread (formatted as an mbox) rather
1302 than only the current message."
1303   (interactive "P\nsPipe message to command: ")
1304   (let (shell-command)
1305     (if entire-thread
1306         (setq shell-command
1307               (concat notmuch-command " show --format=mbox "
1308                       (shell-quote-argument
1309                        (mapconcat 'identity (notmuch-show-get-message-ids-for-open-messages) " OR "))
1310                       " | " command))
1311       (setq shell-command
1312             (concat notmuch-command " show --format=raw "
1313                     (shell-quote-argument (notmuch-show-get-message-id)) " | " command)))
1314     (let ((buf (get-buffer-create (concat "*notmuch-pipe*"))))
1315       (with-current-buffer buf
1316         (setq buffer-read-only nil)
1317         (erase-buffer)
1318         (let ((exit-code (call-process-shell-command shell-command nil buf)))
1319           (goto-char (point-max))
1320           (set-buffer-modified-p nil)
1321           (setq buffer-read-only t)
1322           (unless (zerop exit-code)
1323             (switch-to-buffer-other-window buf)
1324             (message (format "Command '%s' exited abnormally with code %d"
1325                              shell-command exit-code))))))))
1326
1327 (defun notmuch-show-add-tags-worker (current-tags add-tags)
1328   "Add to `current-tags' with any tags from `add-tags' not
1329 currently present and return the result."
1330   (let ((result-tags (copy-sequence current-tags)))
1331     (mapc (lambda (add-tag)
1332             (unless (member add-tag current-tags)
1333               (setq result-tags (push add-tag result-tags))))
1334             add-tags)
1335     (sort result-tags 'string<)))
1336
1337 (defun notmuch-show-del-tags-worker (current-tags del-tags)
1338   "Remove any tags in `del-tags' from `current-tags' and return
1339 the result."
1340   (let ((result-tags (copy-sequence current-tags)))
1341     (mapc (lambda (del-tag)
1342             (setq result-tags (delete del-tag result-tags)))
1343           del-tags)
1344     result-tags))
1345
1346 (defun notmuch-show-add-tag (&rest toadd)
1347   "Add a tag to the current message."
1348   (interactive
1349    (list (notmuch-select-tag-with-completion "Tag to add: ")))
1350
1351   (let* ((current-tags (notmuch-show-get-tags))
1352          (new-tags (notmuch-show-add-tags-worker current-tags toadd)))
1353
1354     (unless (equal current-tags new-tags)
1355       (apply 'notmuch-tag (notmuch-show-get-message-id)
1356              (mapcar (lambda (s) (concat "+" s)) toadd))
1357       (notmuch-show-set-tags new-tags))))
1358
1359 (defun notmuch-show-remove-tag (&rest toremove)
1360   "Remove a tag from the current message."
1361   (interactive
1362    (list (notmuch-select-tag-with-completion
1363           "Tag to remove: " (notmuch-show-get-message-id))))
1364
1365   (let* ((current-tags (notmuch-show-get-tags))
1366          (new-tags (notmuch-show-del-tags-worker current-tags toremove)))
1367
1368     (unless (equal current-tags new-tags)
1369       (apply 'notmuch-tag (notmuch-show-get-message-id)
1370              (mapcar (lambda (s) (concat "-" s)) toremove))
1371       (notmuch-show-set-tags new-tags))))
1372
1373 (defun notmuch-show-toggle-headers ()
1374   "Toggle the visibility of the current message headers."
1375   (interactive)
1376   (let ((props (notmuch-show-get-message-properties)))
1377     (notmuch-show-headers-visible
1378      props
1379      (not (plist-get props :headers-visible))))
1380   (force-window-update))
1381
1382 (defun notmuch-show-toggle-message ()
1383   "Toggle the visibility of the current message."
1384   (interactive)
1385   (let ((props (notmuch-show-get-message-properties)))
1386     (notmuch-show-message-visible
1387      props
1388      (not (plist-get props :message-visible))))
1389   (force-window-update))
1390
1391 (defun notmuch-show-open-or-close-all ()
1392   "Set the visibility all of the messages in the current thread.
1393 By default make all of the messages visible. With a prefix
1394 argument, hide all of the messages."
1395   (interactive)
1396   (save-excursion
1397     (goto-char (point-min))
1398     (loop do (notmuch-show-message-visible (notmuch-show-get-message-properties)
1399                                            (not current-prefix-arg))
1400           until (not (notmuch-show-goto-message-next))))
1401   (force-window-update))
1402
1403 (defun notmuch-show-next-button ()
1404   "Advance point to the next button in the buffer."
1405   (interactive)
1406   (forward-button 1))
1407
1408 (defun notmuch-show-previous-button ()
1409   "Move point back to the previous button in the buffer."
1410   (interactive)
1411   (backward-button 1))
1412
1413 (defun notmuch-show-archive-thread-internal (show-next)
1414   ;; Remove the tag from the current set of messages.
1415   (goto-char (point-min))
1416   (loop do (notmuch-show-remove-tag "inbox")
1417         until (not (notmuch-show-goto-message-next)))
1418   ;; Move to the next item in the search results, if any.
1419   (let ((parent-buffer notmuch-show-parent-buffer))
1420     (notmuch-kill-this-buffer)
1421     (if parent-buffer
1422         (progn
1423           (switch-to-buffer parent-buffer)
1424           (forward-line)
1425           (if show-next
1426               (notmuch-search-show-thread))))))
1427
1428 (defun notmuch-show-archive-thread ()
1429   "Archive each message in thread, then show next thread from search.
1430
1431 Archive each message currently shown by removing the \"inbox\"
1432 tag from each. Then kill this buffer and show the next thread
1433 from the search from which this thread was originally shown.
1434
1435 Note: This command is safe from any race condition of new messages
1436 being delivered to the same thread. It does not archive the
1437 entire thread, but only the messages shown in the current
1438 buffer."
1439   (interactive)
1440   (notmuch-show-archive-thread-internal t))
1441
1442 (defun notmuch-show-archive-thread-then-exit ()
1443   "Archive each message in thread, then exit back to search results."
1444   (interactive)
1445   (notmuch-show-archive-thread-internal nil))
1446
1447 (defun notmuch-show-stash-cc ()
1448   "Copy CC field of current message to kill-ring."
1449   (interactive)
1450   (notmuch-common-do-stash (notmuch-show-get-cc)))
1451
1452 (defun notmuch-show-stash-date ()
1453   "Copy date of current message to kill-ring."
1454   (interactive)
1455   (notmuch-common-do-stash (notmuch-show-get-date)))
1456
1457 (defun notmuch-show-stash-filename ()
1458   "Copy filename of current message to kill-ring."
1459   (interactive)
1460   (notmuch-common-do-stash (notmuch-show-get-filename)))
1461
1462 (defun notmuch-show-stash-from ()
1463   "Copy From address of current message to kill-ring."
1464   (interactive)
1465   (notmuch-common-do-stash (notmuch-show-get-from)))
1466
1467 (defun notmuch-show-stash-message-id ()
1468   "Copy message ID of current message to kill-ring."
1469   (interactive)
1470   (notmuch-common-do-stash (notmuch-show-get-message-id)))
1471
1472 (defun notmuch-show-stash-message-id-stripped ()
1473   "Copy message ID of current message (sans `id:' prefix) to kill-ring."
1474   (interactive)
1475   (notmuch-common-do-stash (substring (notmuch-show-get-message-id) 4 -1)))
1476
1477 (defun notmuch-show-stash-subject ()
1478   "Copy Subject field of current message to kill-ring."
1479   (interactive)
1480   (notmuch-common-do-stash (notmuch-show-get-subject)))
1481
1482 (defun notmuch-show-stash-tags ()
1483   "Copy tags of current message to kill-ring as a comma separated list."
1484   (interactive)
1485   (notmuch-common-do-stash (mapconcat 'identity (notmuch-show-get-tags) ",")))
1486
1487 (defun notmuch-show-stash-to ()
1488   "Copy To address of current message to kill-ring."
1489   (interactive)
1490   (notmuch-common-do-stash (notmuch-show-get-to)))
1491
1492 ;; Commands typically bound to buttons.
1493
1494 (defun notmuch-show-part-button-action (button)
1495   (let ((nth (button-get button :notmuch-part)))
1496     (if nth
1497         (notmuch-show-save-part (notmuch-show-get-message-id) nth
1498                                 (button-get button :notmuch-filename))
1499       (message "Not a valid part (is it a fake part?)."))))
1500
1501 ;;
1502
1503 (provide 'notmuch-show)