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* ((from (notmuch-show-get-header :From msg))
 464                (sigstatus (car (plist-get part :sigstatus))))
 465           (notmuch-crypto-insert-sigstatus-button sigstatus from))
 466       ;; if we're not adding sigstatus, tell the user how they can get it
 467       (button-put button 'help-echo "Set notmuch-crypto-process-mime to process cryptographic mime parts.")))
 468
 469   (let ((inner-parts (plist-get part :content))
 470         (start (point)))
 471     ;; Show all of the parts.
 472     (mapc (lambda (inner-part)
 473             (notmuch-show-insert-bodypart msg inner-part depth))
 474           inner-parts)
 475
 476     (when notmuch-show-indent-multipart
 477       (indent-rigidly start (point) 1)))
 478   t)
 479
 480 (defun notmuch-show-insert-part-multipart/encrypted (msg part content-type nth depth declared-type)
 481   (let ((button (notmuch-show-insert-part-header nth declared-type content-type nil)))
 482     (button-put button 'face '(:foreground "blue"))
 483     ;; add encryption status button if encstatus specified
 484     (if (plist-member part :encstatus)
 485         (let ((encstatus (car (plist-get part :encstatus))))
 486           (notmuch-crypto-insert-encstatus-button encstatus)
 487           ;; add signature status button if sigstatus specified
 488           (if (plist-member part :sigstatus)
 489               (let* ((from (notmuch-show-get-header :From msg))
 490                      (sigstatus (car (plist-get part :sigstatus))))
 491                 (notmuch-crypto-insert-sigstatus-button sigstatus from))))
 492       ;; if we're not adding encstatus, tell the user how they can get it
 493       (button-put button 'help-echo "Set notmuch-crypto-process-mime to process cryptographic mime parts.")))
 494
 495   (let ((inner-parts (plist-get part :content))
 496         (start (point)))
 497     ;; Show all of the parts.
 498     (mapc (lambda (inner-part)
 499             (notmuch-show-insert-bodypart msg inner-part depth))
 500           inner-parts)
 501
 502     (when notmuch-show-indent-multipart
 503       (indent-rigidly start (point) 1)))
 504   t)
 505
 506 (defun notmuch-show-insert-part-multipart/* (msg part content-type nth depth declared-type)
 507   (notmuch-show-insert-part-header nth declared-type content-type nil)
 508   (let ((inner-parts (plist-get part :content))
 509         (start (point)))
 510     ;; Show all of the parts.
 511     (mapc (lambda (inner-part)
 512             (notmuch-show-insert-bodypart msg inner-part depth))
 513           inner-parts)
 514
 515     (when notmuch-show-indent-multipart
 516       (indent-rigidly start (point) 1)))
 517   t)
 518
 519 (defun notmuch-show-insert-part-message/rfc822 (msg part content-type nth depth declared-type)
 520   (notmuch-show-insert-part-header nth declared-type content-type nil)
 521   (let* ((message (car (plist-get part :content)))
 522          (headers (plist-get message :headers))
 523          (body (car (plist-get message :body)))
 524          (start (point)))
 525
 526     ;; Override `notmuch-message-headers' to force `From' to be
 527     ;; displayed.
 528     (let ((notmuch-message-headers '("From" "Subject" "To" "Cc" "Date")))
 529       (notmuch-show-insert-headers (plist-get message :headers)))
 530
 531     ;; Blank line after headers to be compatible with the normal
 532     ;; message display.
 533     (insert "\n")
 534
 535     ;; Show the body
 536     (notmuch-show-insert-bodypart msg body depth)
 537
 538     (when notmuch-show-indent-multipart
 539       (indent-rigidly start (point) 1)))
 540   t)
 541
 542 (defun notmuch-show-insert-part-text/plain (msg part content-type nth depth declared-type)
 543   (let ((start (point)))
 544     ;; If this text/plain part is not the first part in the message,
 545     ;; insert a header to make this clear.
 546     (if (> nth 1)
 547         (notmuch-show-insert-part-header nth declared-type content-type (plist-get part :filename)))
 548     (insert (notmuch-show-get-bodypart-content msg part nth))
 549     (save-excursion
 550       (save-restriction
 551         (narrow-to-region start (point-max))
 552         (run-hook-with-args 'notmuch-show-insert-text/plain-hook msg depth))))
 553   t)
 554
 555 (defun notmuch-show-insert-part-text/x-vcalendar (msg part content-type nth depth declared-type)
 556   (notmuch-show-insert-part-header nth declared-type content-type (plist-get part :filename))
 557   (insert (with-temp-buffer
 558             (insert (notmuch-show-get-bodypart-content msg part nth))
 559             (goto-char (point-min))
 560             (let ((file (make-temp-file "notmuch-ical"))
 561                   result)
 562               (icalendar--convert-ical-to-diary
 563                (icalendar--read-element nil nil)
 564                file t)
 565               (set-buffer (get-file-buffer file))
 566               (setq result (buffer-substring (point-min) (point-max)))
 567               (set-buffer-modified-p nil)
 568               (kill-buffer (current-buffer))
 569               (delete-file file)
 570               result)))
 571   t)
 572
 573 (defun notmuch-show-insert-part-application/octet-stream (msg part content-type nth depth declared-type)
 574   ;; If we can deduce a MIME type from the filename of the attachment,
 575   ;; do so and pass it on to the handler for that type.
 576   (if (plist-get part :filename)
 577       (let ((extension (file-name-extension (plist-get part :filename)))
 578             mime-type)
 579         (if extension
 580             (progn
 581               (mailcap-parse-mimetypes)
 582               (setq mime-type (mailcap-extension-to-mime extension))
 583               (if (and mime-type
 584                        (not (string-equal mime-type "application/octet-stream")))
 585                   (notmuch-show-insert-bodypart-internal msg part mime-type nth depth content-type)
 586                 nil))
 587           nil))))
 588
 589 (defun notmuch-show-insert-part-application/* (msg part content-type nth depth declared-type
 590 )
 591   ;; do not render random "application" parts
 592   (notmuch-show-insert-part-header nth content-type declared-type (plist-get part :filename)))
 593
 594 (defun notmuch-show-insert-part-*/* (msg part content-type nth depth declared-type)
 595   ;; This handler _must_ succeed - it is the handler of last resort.
 596   (notmuch-show-insert-part-header nth content-type declared-type (plist-get part :filename))
 597   (let ((content (notmuch-show-get-bodypart-content msg part nth)))
 598     (if content
 599         (notmuch-show-mm-display-part-inline msg part content-type content)))
 600   t)
 601
 602 ;; Functions for determining how to handle MIME parts.
 603
 604 (defun notmuch-show-split-content-type (content-type)
 605   (split-string content-type "/"))
 606
 607 (defun notmuch-show-handlers-for (content-type)
 608   "Return a list of content handlers for a part of type CONTENT-TYPE."
 609   (let (result)
 610     (mapc (lambda (func)
 611             (if (functionp func)
 612                 (push func result)))
 613           ;; Reverse order of prefrence.
 614           (list (intern (concat "notmuch-show-insert-part-*/*"))
 615                 (intern (concat
 616                          "notmuch-show-insert-part-"
 617                          (car (notmuch-show-split-content-type content-type))
 618                          "/*"))
 619                 (intern (concat "notmuch-show-insert-part-" content-type))))
 620     result))
 621
 622 ;; Helper for parts which are generally not included in the default
 623 ;; JSON output.
 624 ;; Uses the buffer-local variable notmuch-show-process-crypto to
 625 ;; determine if parts should be decrypted first.
 626 (defun notmuch-show-get-bodypart-internal (message-id part-number)
 627   (let ((args '("show" "--format=raw"))
 628         (part-arg (format "--part=%s" part-number)))
 629     (setq args (append args (list part-arg)))
 630     (if notmuch-show-process-crypto
 631         (setq args (append args '("--decrypt"))))
 632     (setq args (append args (list message-id)))
 633     (with-temp-buffer
 634       (let ((coding-system-for-read 'no-conversion))
 635         (progn
 636           (apply 'call-process (append (list notmuch-command nil (list t nil) nil) args))
 637           (buffer-string))))))
 638
 639 (defun notmuch-show-get-bodypart-content (msg part nth)
 640   (or (plist-get part :content)
 641       (notmuch-show-get-bodypart-internal (concat "id:" (plist-get msg :id)) nth)))
 642
 643 ;; \f
 644
 645 (defun notmuch-show-insert-bodypart-internal (msg part content-type nth depth declared-type)
 646   (let ((handlers (notmuch-show-handlers-for content-type)))
 647     ;; Run the content handlers until one of them returns a non-nil
 648     ;; value.
 649     (while (and handlers
 650                 (not (funcall (car handlers) msg part content-type nth depth declared-type)))
 651       (setq handlers (cdr handlers))))
 652   t)
 653
 654 (defun notmuch-show-insert-bodypart (msg part depth)
 655   "Insert the body part PART at depth DEPTH in the current thread."
 656   (let ((content-type (downcase (plist-get part :content-type)))
 657         (nth (plist-get part :id)))
 658     (notmuch-show-insert-bodypart-internal msg part content-type nth depth content-type))
 659   ;; Some of the body part handlers leave point somewhere up in the
 660   ;; part, so we make sure that we're down at the end.
 661   (goto-char (point-max))
 662   ;; Ensure that the part ends with a carriage return.
 663   (if (not (bolp))
 664       (insert "\n")))
 665
 666 (defun notmuch-show-insert-body (msg body depth)
 667   "Insert the body BODY at depth DEPTH in the current thread."
 668   (mapc '(lambda (part) (notmuch-show-insert-bodypart msg part depth)) body))
 669
 670 (defun notmuch-show-make-symbol (type)
 671   (make-symbol (concat "notmuch-show-" type)))
 672
 673 (defun notmuch-show-strip-re (string)
 674   (replace-regexp-in-string "\\([Rr]e: *\\)+" "" string))
 675
 676 (defvar notmuch-show-previous-subject "")
 677 (make-variable-buffer-local 'notmuch-show-previous-subject)
 678
 679 (defun notmuch-show-insert-msg (msg depth)
 680   "Insert the message MSG at depth DEPTH in the current thread."
 681   (let* ((headers (plist-get msg :headers))
 682          ;; Indentation causes the buffer offset of the start/end
 683          ;; points to move, so we must use markers.
 684          message-start message-end
 685          content-start content-end
 686          headers-start headers-end
 687          body-start body-end
 688          (headers-invis-spec (notmuch-show-make-symbol "header"))
 689          (message-invis-spec (notmuch-show-make-symbol "message"))
 690          (bare-subject (notmuch-show-strip-re (plist-get headers :Subject))))
 691
 692     ;; Set `buffer-invisibility-spec' to `nil' (a list), otherwise
 693     ;; removing items from `buffer-invisibility-spec' (which is what
 694     ;; `notmuch-show-headers-visible' and
 695     ;; `notmuch-show-message-visible' do) is a no-op and has no
 696     ;; effect. This caused threads with only matching messages to have
 697     ;; those messages hidden initially because
 698     ;; `buffer-invisibility-spec' stayed `t'.
 699     ;;
 700     ;; This needs to be set here (rather than just above the call to
 701     ;; `notmuch-show-headers-visible') because some of the part
 702     ;; rendering or body washing functions
 703     ;; (e.g. `notmuch-wash-text/plain-citations') manipulate
 704     ;; `buffer-invisibility-spec').
 705     (when (eq buffer-invisibility-spec t)
 706       (setq buffer-invisibility-spec nil))
 707
 708     (setq message-start (point-marker))
 709
 710     (notmuch-show-insert-headerline headers
 711                                     (or (if notmuch-show-relative-dates
 712                                             (plist-get msg :date_relative)
 713                                           nil)
 714                                         (plist-get headers :Date))
 715                                     (plist-get msg :tags) depth)
 716
 717     (setq content-start (point-marker))
 718
 719     (plist-put msg :headers-invis-spec headers-invis-spec)
 720     (plist-put msg :message-invis-spec message-invis-spec)
 721
 722     ;; Set `headers-start' to point after the 'Subject:' header to be
 723     ;; compatible with the existing implementation. This just sets it
 724     ;; to after the first header.
 725     (notmuch-show-insert-headers headers)
 726     ;; Headers should include a blank line (backwards compatibility).
 727     (insert "\n")
 728     (save-excursion
 729       (goto-char content-start)
 730       ;; If the subject of this message is the same as that of the
 731       ;; previous message, don't display it when this message is
 732       ;; collapsed.
 733       (when (not (string= notmuch-show-previous-subject
 734                           bare-subject))
 735         (forward-line 1))
 736       (setq headers-start (point-marker)))
 737     (setq headers-end (point-marker))
 738
 739     (setq notmuch-show-previous-subject bare-subject)
 740
 741     (setq body-start (point-marker))
 742     (notmuch-show-insert-body msg (plist-get msg :body) depth)
 743     ;; Ensure that the body ends with a newline.
 744     (if (not (bolp))
 745         (insert "\n"))
 746     (setq body-end (point-marker))
 747     (setq content-end (point-marker))
 748
 749     ;; Indent according to the depth in the thread.
 750     (indent-rigidly content-start content-end (* notmuch-indent-messages-width depth))
 751
 752     (setq message-end (point-max-marker))
 753
 754     ;; Save the extents of this message over the whole text of the
 755     ;; message.
 756     (put-text-property message-start message-end :notmuch-message-extent (cons message-start message-end))
 757
 758     (let ((headers-overlay (make-overlay headers-start headers-end))
 759           (invis-specs (list headers-invis-spec message-invis-spec)))
 760       (overlay-put headers-overlay 'invisible invis-specs)
 761       (overlay-put headers-overlay 'priority 10))
 762     (overlay-put (make-overlay body-start body-end) 'invisible message-invis-spec)
 763
 764     ;; Save the properties for this message. Currently this saves the
 765     ;; entire message (augmented it with other stuff), which seems
 766     ;; like overkill. We might save a reduced subset (for example, not
 767     ;; the content).
 768     (notmuch-show-set-message-properties msg)
 769
 770     ;; Set header visibility.
 771     (notmuch-show-headers-visible msg notmuch-message-headers-visible)
 772
 773     ;; Message visibility depends on whether it matched the search
 774     ;; criteria.
 775     (notmuch-show-message-visible msg (plist-get msg :match))))
 776
 777 (defun notmuch-show-insert-tree (tree depth)
 778   "Insert the message tree TREE at depth DEPTH in the current thread."
 779   (let ((msg (car tree))
 780         (replies (cadr tree)))
 781     (notmuch-show-insert-msg msg depth)
 782     (notmuch-show-insert-thread replies (1+ depth))))
 783
 784 (defun notmuch-show-insert-thread (thread depth)
 785   "Insert the thread THREAD at depth DEPTH in the current forest."
 786   (mapc '(lambda (tree) (notmuch-show-insert-tree tree depth)) thread))
 787
 788 (defun notmuch-show-insert-forest (forest)
 789   "Insert the forest of threads FOREST."
 790   (mapc '(lambda (thread) (notmuch-show-insert-thread thread 0)) forest))
 791
 792 (defvar notmuch-show-thread-id nil)
 793 (make-variable-buffer-local 'notmuch-show-thread-id)
 794 (defvar notmuch-show-parent-buffer nil)
 795 (make-variable-buffer-local 'notmuch-show-parent-buffer)
 796 (defvar notmuch-show-query-context nil)
 797 (make-variable-buffer-local 'notmuch-show-query-context)
 798 (defvar notmuch-show-buffer-name nil)
 799 (make-variable-buffer-local 'notmuch-show-buffer-name)
 800
 801 (defun notmuch-show-buttonise-links (start end)
 802   "Buttonise URLs and mail addresses between START and END.
 803
 804 This also turns id:\"<message id>\"-parts into buttons for
 805 a corresponding notmuch search."
 806   (goto-address-fontify-region start end)
 807   (save-excursion
 808     (goto-char start)
 809     (while (re-search-forward "id:\\(\"?\\)[^[:space:]\"]+\\1" end t)
 810       ;; remove the overlay created by goto-address-mode
 811       (remove-overlays (match-beginning 0) (match-end 0) 'goto-address t)
 812       (make-text-button (match-beginning 0) (match-end 0)
 813                         'action `(lambda (arg)
 814                                    (notmuch-search ,(match-string-no-properties 0)))
 815                         'follow-link t
 816                         'help-echo "Mouse-1, RET: search for this message"
 817                         'face goto-address-mail-face))))
 818
 819 ;;;###autoload
 820 (defun notmuch-show (thread-id &optional parent-buffer query-context buffer-name crypto-switch)
 821   "Run \"notmuch show\" with the given thread ID and display results.
 822
 823 The optional PARENT-BUFFER is the notmuch-search buffer from
 824 which this notmuch-show command was executed, (so that the
 825 next thread from that buffer can be show when done with this
 826 one).
 827
 828 The optional QUERY-CONTEXT is a notmuch search term. Only
 829 messages from the thread matching this search term are shown if
 830 non-nil.
 831
 832 The optional BUFFER-NAME provides the name of the buffer in
 833 which the message thread is shown. If it is nil (which occurs
 834 when the command is called interactively) the argument to the
 835 function is used.
 836
 837 The optional CRYPTO-SWITCH toggles the value of the
 838 notmuch-crypto-process-mime customization variable for this show
 839 buffer."
 840   (interactive "sNotmuch show: ")
 841   (let* ((process-crypto (if crypto-switch
 842                              (not notmuch-crypto-process-mime)
 843                            notmuch-crypto-process-mime)))
 844     (notmuch-show-worker thread-id parent-buffer query-context buffer-name process-crypto)))
 845
 846 (defun notmuch-show-worker (thread-id parent-buffer query-context buffer-name process-crypto)
 847   (let* ((buffer-name (generate-new-buffer-name
 848                        (or buffer-name
 849                            (concat "*notmuch-" thread-id "*"))))
 850          (buffer (get-buffer-create buffer-name))
 851          (inhibit-read-only t))
 852     (switch-to-buffer buffer)
 853     (notmuch-show-mode)
 854     ;; Don't track undo information for this buffer
 855     (set 'buffer-undo-list t)
 856
 857     (setq notmuch-show-thread-id thread-id)
 858     (setq notmuch-show-parent-buffer parent-buffer)
 859     (setq notmuch-show-query-context query-context)
 860     (setq notmuch-show-buffer-name buffer-name)
 861     (setq notmuch-show-process-crypto process-crypto)
 862
 863     (erase-buffer)
 864     (goto-char (point-min))
 865     (save-excursion
 866       (let* ((basic-args (list thread-id))
 867              (args (if query-context
 868                        (append (list "\'") basic-args (list "and (" query-context ")\'"))
 869                      (append (list "\'") basic-args (list "\'")))))
 870         (notmuch-show-insert-forest (notmuch-query-get-threads args))
 871         ;; If the query context reduced the results to nothing, run
 872         ;; the basic query.
 873         (when (and (eq (buffer-size) 0)
 874                    query-context)
 875           (notmuch-show-insert-forest
 876            (notmuch-query-get-threads basic-args))))
 877
 878       (jit-lock-register #'notmuch-show-buttonise-links)
 879
 880       ;; Act on visual lines rather than logical lines.
 881       (visual-line-mode t)
 882
 883       (run-hooks 'notmuch-show-hook))
 884
 885     ;; Move straight to the first open message
 886     (if (not (notmuch-show-message-visible-p))
 887         (notmuch-show-next-open-message))
 888
 889     ;; Set the header line to the subject of the first open message.
 890     (setq header-line-format (notmuch-show-strip-re (notmuch-show-get-subject)))
 891
 892     (notmuch-show-mark-read)))
 893
 894 (defun notmuch-show-refresh-view (&optional crypto-switch)
 895   "Refresh the current view (with crypto switch if prefix given).
 896
 897 Kills the current buffer and reruns notmuch show with the same
 898 thread id.  If a prefix is given, crypto processing is toggled."
 899   (interactive "P")
 900   (let ((thread-id notmuch-show-thread-id)
 901         (parent-buffer notmuch-show-parent-buffer)
 902         (query-context notmuch-show-query-context)
 903         (buffer-name notmuch-show-buffer-name)
 904         (process-crypto (if crypto-switch
 905                             (not notmuch-show-process-crypto)
 906                           notmuch-show-process-crypto)))
 907     (notmuch-kill-this-buffer)
 908     (notmuch-show-worker thread-id parent-buffer query-context buffer-name process-crypto)))
 909
 910 (defvar notmuch-show-stash-map
 911   (let ((map (make-sparse-keymap)))
 912     (define-key map "c" 'notmuch-show-stash-cc)
 913     (define-key map "d" 'notmuch-show-stash-date)
 914     (define-key map "F" 'notmuch-show-stash-filename)
 915     (define-key map "f" 'notmuch-show-stash-from)
 916     (define-key map "i" 'notmuch-show-stash-message-id)
 917     (define-key map "I" 'notmuch-show-stash-message-id-stripped)
 918     (define-key map "s" 'notmuch-show-stash-subject)
 919     (define-key map "T" 'notmuch-show-stash-tags)
 920     (define-key map "t" 'notmuch-show-stash-to)
 921     map)
 922   "Submap for stash commands")
 923 (fset 'notmuch-show-stash-map notmuch-show-stash-map)
 924
 925 (defvar notmuch-show-mode-map
 926       (let ((map (make-sparse-keymap)))
 927         (define-key map "?" 'notmuch-help)
 928         (define-key map "q" 'notmuch-kill-this-buffer)
 929         (define-key map (kbd "<C-tab>") 'widget-backward)
 930         (define-key map (kbd "M-TAB") 'notmuch-show-previous-button)
 931         (define-key map (kbd "<backtab>") 'notmuch-show-previous-button)
 932         (define-key map (kbd "TAB") 'notmuch-show-next-button)
 933         (define-key map "s" 'notmuch-search)
 934         (define-key map "m" 'notmuch-mua-new-mail)
 935         (define-key map "f" 'notmuch-show-forward-message)
 936         (define-key map "r" 'notmuch-show-reply)
 937         (define-key map "|" 'notmuch-show-pipe-message)
 938         (define-key map "w" 'notmuch-show-save-attachments)
 939         (define-key map "V" 'notmuch-show-view-raw-message)
 940         (define-key map "v" 'notmuch-show-view-all-mime-parts)
 941         (define-key map "c" 'notmuch-show-stash-map)
 942         (define-key map "=" 'notmuch-show-refresh-view)
 943         (define-key map "h" 'notmuch-show-toggle-headers)
 944         (define-key map "-" 'notmuch-show-remove-tag)
 945         (define-key map "+" 'notmuch-show-add-tag)
 946         (define-key map "x" 'notmuch-show-archive-thread-then-exit)
 947         (define-key map "a" 'notmuch-show-archive-thread)
 948         (define-key map "N" 'notmuch-show-next-message)
 949         (define-key map "P" 'notmuch-show-previous-message)
 950         (define-key map "n" 'notmuch-show-next-open-message)
 951         (define-key map "p" 'notmuch-show-previous-open-message)
 952         (define-key map (kbd "DEL") 'notmuch-show-rewind)
 953         (define-key map " " 'notmuch-show-advance-and-archive)
 954         (define-key map (kbd "M-RET") 'notmuch-show-open-or-close-all)
 955         (define-key map (kbd "RET") 'notmuch-show-toggle-message)
 956         map)
 957       "Keymap for \"notmuch show\" buffers.")
 958 (fset 'notmuch-show-mode-map notmuch-show-mode-map)
 959
 960 (defun notmuch-show-mode ()
 961   "Major mode for viewing a thread with notmuch.
 962
 963 This buffer contains the results of the \"notmuch show\" command
 964 for displaying a single thread of email from your email archives.
 965
 966 By default, various components of email messages, (citations,
 967 signatures, already-read messages), are hidden. You can make
 968 these parts visible by clicking with the mouse button or by
 969 pressing RET after positioning the cursor on a hidden part, (for
 970 which \\[notmuch-show-next-button] and \\[notmuch-show-previous-button] are helpful).
 971
 972 Reading the thread sequentially is well-supported by pressing
 973 \\[notmuch-show-advance-and-archive]. This will scroll the current message (if necessary), advance
 974 to the next message, or advance to the next thread (if already on
 975 the last message of a thread).
 976
 977 Other commands are available to read or manipulate the thread
 978 more selectively, (such as '\\[notmuch-show-next-message]' and '\\[notmuch-show-previous-message]' to advance to messages
 979 without removing any tags, and '\\[notmuch-show-archive-thread]' to archive an entire thread
 980 without scrolling through with \\[notmuch-show-advance-and-archive]).
 981
 982 You can add or remove arbitrary tags from the current message with
 983 '\\[notmuch-show-add-tag]' or '\\[notmuch-show-remove-tag]'.
 984
 985 All currently available key bindings:
 986
 987 \\{notmuch-show-mode-map}"
 988   (interactive)
 989   (kill-all-local-variables)
 990   (use-local-map notmuch-show-mode-map)
 991   (setq major-mode 'notmuch-show-mode
 992         mode-name "notmuch-show")
 993   (setq buffer-read-only t))
 994
 995 (defun notmuch-show-move-to-message-top ()
 996   (goto-char (notmuch-show-message-top)))
 997
 998 (defun notmuch-show-move-to-message-bottom ()
 999   (goto-char (notmuch-show-message-bottom)))
1000
1001 (defun notmuch-show-message-adjust ()
1002   (recenter 0))
1003
1004 ;; Movement related functions.
1005
1006 ;; There's some strangeness here where a text property applied to a
1007 ;; region a->b is not found when point is at b. We walk backwards
1008 ;; until finding the property.
1009 (defun notmuch-show-message-extent ()
1010   (let (r)
1011     (save-excursion
1012       (while (not (setq r (get-text-property (point) :notmuch-message-extent)))
1013         (backward-char)))
1014     r))
1015
1016 (defun notmuch-show-message-top ()
1017   (car (notmuch-show-message-extent)))
1018
1019 (defun notmuch-show-message-bottom ()
1020   (cdr (notmuch-show-message-extent)))
1021
1022 (defun notmuch-show-goto-message-next ()
1023   (let ((start (point)))
1024     (notmuch-show-move-to-message-bottom)
1025     (if (not (eobp))
1026         t
1027       (goto-char start)
1028       nil)))
1029
1030 (defun notmuch-show-goto-message-previous ()
1031   (notmuch-show-move-to-message-top)
1032   (if (bobp)
1033       nil
1034     (backward-char)
1035     (notmuch-show-move-to-message-top)
1036     t))
1037
1038 ;; Functions relating to the visibility of messages and their
1039 ;; components.
1040
1041 (defun notmuch-show-element-visible (props visible-p spec-property)
1042   (let ((spec (plist-get props spec-property)))
1043     (if visible-p
1044         (remove-from-invisibility-spec spec)
1045       (add-to-invisibility-spec spec))))
1046
1047 (defun notmuch-show-message-visible (props visible-p)
1048   (notmuch-show-element-visible props visible-p :message-invis-spec)
1049   (notmuch-show-set-prop :message-visible visible-p props))
1050
1051 (defun notmuch-show-headers-visible (props visible-p)
1052   (notmuch-show-element-visible props visible-p :headers-invis-spec)
1053   (notmuch-show-set-prop :headers-visible visible-p props))
1054
1055 ;; Functions for setting and getting attributes of the current
1056 ;; message.
1057
1058 (defun notmuch-show-set-message-properties (props)
1059   (save-excursion
1060     (notmuch-show-move-to-message-top)
1061     (put-text-property (point) (+ (point) 1) :notmuch-message-properties props)))
1062
1063 (defun notmuch-show-get-message-properties ()
1064   (save-excursion
1065     (notmuch-show-move-to-message-top)
1066     (get-text-property (point) :notmuch-message-properties)))
1067
1068 (defun notmuch-show-set-prop (prop val &optional props)
1069   (let ((inhibit-read-only t)
1070         (props (or props
1071                    (notmuch-show-get-message-properties))))
1072     (plist-put props prop val)
1073     (notmuch-show-set-message-properties props)))
1074
1075 (defun notmuch-show-get-prop (prop &optional props)
1076   (let ((props (or props
1077                    (notmuch-show-get-message-properties))))
1078     (plist-get props prop)))
1079
1080 (defun notmuch-show-get-message-id ()
1081   "Return the message id of the current message."
1082   (concat "id:\"" (notmuch-show-get-prop :id) "\""))
1083
1084 ;; dme: Would it make sense to use a macro for many of these?
1085
1086 (defun notmuch-show-get-filename ()
1087   "Return the filename of the current message."
1088   (notmuch-show-get-prop :filename))
1089
1090 (defun notmuch-show-get-header (header &optional props)
1091   "Return the named header of the current message, if any."
1092   (plist-get (notmuch-show-get-prop :headers props) header))
1093
1094 (defun notmuch-show-get-cc ()
1095   (notmuch-show-get-header :Cc))
1096
1097 (defun notmuch-show-get-date ()
1098   (notmuch-show-get-header :Date))
1099
1100 (defun notmuch-show-get-from ()
1101   (notmuch-show-get-header :From))
1102
1103 (defun notmuch-show-get-subject ()
1104   (notmuch-show-get-header :Subject))
1105
1106 (defun notmuch-show-get-to ()
1107   (notmuch-show-get-header :To))
1108
1109 (defun notmuch-show-set-tags (tags)
1110   "Set the tags of the current message."
1111   (notmuch-show-set-prop :tags tags)
1112   (notmuch-show-update-tags tags))
1113
1114 (defun notmuch-show-get-tags ()
1115   "Return the tags of the current message."
1116   (notmuch-show-get-prop :tags))
1117
1118 (defun notmuch-show-message-visible-p ()
1119   "Is the current message visible?"
1120   (notmuch-show-get-prop :message-visible))
1121
1122 (defun notmuch-show-headers-visible-p ()
1123   "Are the headers of the current message visible?"
1124   (notmuch-show-get-prop :headers-visible))
1125
1126 (defun notmuch-show-mark-read ()
1127   "Mark the current message as read."
1128   (notmuch-show-remove-tag "unread"))
1129
1130 ;; Functions for getting attributes of several messages in the current
1131 ;; thread.
1132
1133 (defun notmuch-show-get-message-ids-for-open-messages ()
1134   "Return a list of all message IDs for open messages in the current thread."
1135   (save-excursion
1136     (let (message-ids done)
1137       (goto-char (point-min))
1138       (while (not done)
1139         (if (notmuch-show-message-visible-p)
1140             (setq message-ids (append message-ids (list (notmuch-show-get-message-id)))))
1141         (setq done (not (notmuch-show-goto-message-next)))
1142         )
1143       message-ids
1144       )))
1145
1146 ;; Commands typically bound to keys.
1147
1148 (defun notmuch-show-advance ()
1149   "Advance through thread.
1150
1151 If the current message in the thread is not yet fully visible,
1152 scroll by a near screenful to read more of the message.
1153
1154 Otherwise, (the end of the current message is already within the
1155 current window), advance to the next open message."
1156   (interactive)
1157   (let* ((end-of-this-message (notmuch-show-message-bottom))
1158          (visible-end-of-this-message (1- end-of-this-message))
1159          (ret nil))
1160     (while (invisible-p visible-end-of-this-message)
1161       (setq visible-end-of-this-message
1162             (previous-single-char-property-change visible-end-of-this-message
1163                                                   'invisible)))
1164     (cond
1165      ;; Ideally we would test `end-of-this-message' against the result
1166      ;; of `window-end', but that doesn't account for the fact that
1167      ;; the end of the message might be hidden.
1168      ((and visible-end-of-this-message
1169            (> visible-end-of-this-message (window-end)))
1170       ;; The bottom of this message is not visible - scroll.
1171       (scroll-up nil))
1172
1173      ((not (= end-of-this-message (point-max)))
1174       ;; This is not the last message - move to the next visible one.
1175       (notmuch-show-next-open-message))
1176
1177      (t
1178       ;; This is the last message - change the return value
1179       (setq ret t)))
1180     ret))
1181
1182 (defun notmuch-show-advance-and-archive ()
1183   "Advance through thread and archive.
1184
1185 This command is intended to be one of the simplest ways to
1186 process a thread of email. It works exactly like
1187 notmuch-show-advance, in that it scrolls through messages in a
1188 show buffer, except that when it gets to the end of the buffer it
1189 archives the entire current thread, (remove the \"inbox\" tag
1190 from each message), kills the buffer, and displays the next
1191 thread from the search from which this thread was originally
1192 shown."
1193   (interactive)
1194   (if (notmuch-show-advance)
1195       (notmuch-show-archive-thread)))
1196
1197 (defun notmuch-show-rewind ()
1198   "Backup through the thread, (reverse scrolling compared to \\[notmuch-show-advance-and-archive]).
1199
1200 Specifically, if the beginning of the previous email is fewer
1201 than `window-height' lines from the current point, move to it
1202 just like `notmuch-show-previous-message'.
1203
1204 Otherwise, just scroll down a screenful of the current message.
1205
1206 This command does not modify any message tags, (it does not undo
1207 any effects from previous calls to
1208 `notmuch-show-advance-and-archive'."
1209   (interactive)
1210   (let ((start-of-message (notmuch-show-message-top))
1211         (start-of-window (window-start)))
1212     (cond
1213       ;; Either this message is properly aligned with the start of the
1214       ;; window or the start of this message is not visible on the
1215       ;; screen - scroll.
1216      ((or (= start-of-message start-of-window)
1217           (< start-of-message start-of-window))
1218       (scroll-down)
1219       ;; If a small number of lines from the previous message are
1220       ;; visible, realign so that the top of the current message is at
1221       ;; the top of the screen.
1222       (if (<= (count-screen-lines (window-start) start-of-message)
1223               next-screen-context-lines)
1224           (progn
1225             (goto-char (notmuch-show-message-top))
1226             (notmuch-show-message-adjust)))
1227       ;; Move to the top left of the window.
1228       (goto-char (window-start)))
1229      (t
1230       ;; Move to the previous message.
1231       (notmuch-show-previous-message)))))
1232
1233 (defun notmuch-show-reply (&optional prompt-for-sender)
1234   "Reply to the current message."
1235   (interactive "P")
1236   (notmuch-mua-new-reply (notmuch-show-get-message-id) prompt-for-sender))
1237
1238 (defun notmuch-show-forward-message (&optional prompt-for-sender)
1239   "Forward the current message."
1240   (interactive "P")
1241   (with-current-notmuch-show-message
1242    (notmuch-mua-new-forward-message prompt-for-sender)))
1243
1244 (defun notmuch-show-next-message ()
1245   "Show the next message."
1246   (interactive)
1247   (if (notmuch-show-goto-message-next)
1248       (progn
1249         (notmuch-show-mark-read)
1250         (notmuch-show-message-adjust))
1251     (goto-char (point-max))))
1252
1253 (defun notmuch-show-previous-message ()
1254   "Show the previous message."
1255   (interactive)
1256   (notmuch-show-goto-message-previous)
1257   (notmuch-show-mark-read)
1258   (notmuch-show-message-adjust))
1259
1260 (defun notmuch-show-next-open-message ()
1261   "Show the next message."
1262   (interactive)
1263   (let (r)
1264     (while (and (setq r (notmuch-show-goto-message-next))
1265                 (not (notmuch-show-message-visible-p))))
1266     (if r
1267         (progn
1268           (notmuch-show-mark-read)
1269           (notmuch-show-message-adjust))
1270       (goto-char (point-max)))))
1271
1272 (defun notmuch-show-previous-open-message ()
1273   "Show the previous message."
1274   (interactive)
1275   (while (and (notmuch-show-goto-message-previous)
1276               (not (notmuch-show-message-visible-p))))
1277   (notmuch-show-mark-read)
1278   (notmuch-show-message-adjust))
1279
1280 (defun notmuch-show-view-raw-message ()
1281   "View the file holding the current message."
1282   (interactive)
1283   (let* ((id (notmuch-show-get-message-id))
1284          (buf (get-buffer-create (concat "*notmuch-raw-" id "*"))))
1285     (call-process notmuch-command nil buf nil "show" "--format=raw" id)
1286     (switch-to-buffer buf)
1287     (goto-char (point-min))
1288     (set-buffer-modified-p nil)
1289     (view-buffer buf 'kill-buffer-if-not-modified)))
1290
1291 (defun notmuch-show-pipe-message (entire-thread command)
1292   "Pipe the contents of the current message (or thread) to the given command.
1293
1294 The given command will be executed with the raw contents of the
1295 current email message as stdin. Anything printed by the command
1296 to stdout or stderr will appear in the *notmuch-pipe* buffer.
1297
1298 When invoked with a prefix argument, the command will receive all
1299 open messages in the current thread (formatted as an mbox) rather
1300 than only the current message."
1301   (interactive "P\nsPipe message to command: ")
1302   (let (shell-command)
1303     (if entire-thread
1304         (setq shell-command
1305               (concat notmuch-command " show --format=mbox "
1306                       (shell-quote-argument
1307                        (mapconcat 'identity (notmuch-show-get-message-ids-for-open-messages) " OR "))
1308                       " | " command))
1309       (setq shell-command
1310             (concat notmuch-command " show --format=raw "
1311                     (shell-quote-argument (notmuch-show-get-message-id)) " | " command)))
1312     (let ((buf (get-buffer-create (concat "*notmuch-pipe*"))))
1313       (with-current-buffer buf
1314         (setq buffer-read-only nil)
1315         (erase-buffer)
1316         (let ((exit-code (call-process-shell-command shell-command nil buf)))
1317           (goto-char (point-max))
1318           (set-buffer-modified-p nil)
1319           (setq buffer-read-only t)
1320           (unless (zerop exit-code)
1321             (switch-to-buffer-other-window buf)
1322             (message (format "Command '%s' exited abnormally with code %d"
1323                              shell-command exit-code))))))))
1324
1325 (defun notmuch-show-add-tags-worker (current-tags add-tags)
1326   "Add to `current-tags' with any tags from `add-tags' not
1327 currently present and return the result."
1328   (let ((result-tags (copy-sequence current-tags)))
1329     (mapc (lambda (add-tag)
1330             (unless (member add-tag current-tags)
1331               (setq result-tags (push add-tag result-tags))))
1332             add-tags)
1333     (sort result-tags 'string<)))
1334
1335 (defun notmuch-show-del-tags-worker (current-tags del-tags)
1336   "Remove any tags in `del-tags' from `current-tags' and return
1337 the result."
1338   (let ((result-tags (copy-sequence current-tags)))
1339     (mapc (lambda (del-tag)
1340             (setq result-tags (delete del-tag result-tags)))
1341           del-tags)
1342     result-tags))
1343
1344 (defun notmuch-show-add-tag (&rest toadd)
1345   "Add a tag to the current message."
1346   (interactive
1347    (list (notmuch-select-tag-with-completion "Tag to add: ")))
1348
1349   (let* ((current-tags (notmuch-show-get-tags))
1350          (new-tags (notmuch-show-add-tags-worker current-tags toadd)))
1351
1352     (unless (equal current-tags new-tags)
1353       (apply 'notmuch-tag (notmuch-show-get-message-id)
1354              (mapcar (lambda (s) (concat "+" s)) toadd))
1355       (notmuch-show-set-tags new-tags))))
1356
1357 (defun notmuch-show-remove-tag (&rest toremove)
1358   "Remove a tag from the current message."
1359   (interactive
1360    (list (notmuch-select-tag-with-completion
1361           "Tag to remove: " (notmuch-show-get-message-id))))
1362
1363   (let* ((current-tags (notmuch-show-get-tags))
1364          (new-tags (notmuch-show-del-tags-worker current-tags toremove)))
1365
1366     (unless (equal current-tags new-tags)
1367       (apply 'notmuch-tag (notmuch-show-get-message-id)
1368              (mapcar (lambda (s) (concat "-" s)) toremove))
1369       (notmuch-show-set-tags new-tags))))
1370
1371 (defun notmuch-show-toggle-headers ()
1372   "Toggle the visibility of the current message headers."
1373   (interactive)
1374   (let ((props (notmuch-show-get-message-properties)))
1375     (notmuch-show-headers-visible
1376      props
1377      (not (plist-get props :headers-visible))))
1378   (force-window-update))
1379
1380 (defun notmuch-show-toggle-message ()
1381   "Toggle the visibility of the current message."
1382   (interactive)
1383   (let ((props (notmuch-show-get-message-properties)))
1384     (notmuch-show-message-visible
1385      props
1386      (not (plist-get props :message-visible))))
1387   (force-window-update))
1388
1389 (defun notmuch-show-open-or-close-all ()
1390   "Set the visibility all of the messages in the current thread.
1391 By default make all of the messages visible. With a prefix
1392 argument, hide all of the messages."
1393   (interactive)
1394   (save-excursion
1395     (goto-char (point-min))
1396     (loop do (notmuch-show-message-visible (notmuch-show-get-message-properties)
1397                                            (not current-prefix-arg))
1398           until (not (notmuch-show-goto-message-next))))
1399   (force-window-update))
1400
1401 (defun notmuch-show-next-button ()
1402   "Advance point to the next button in the buffer."
1403   (interactive)
1404   (forward-button 1))
1405
1406 (defun notmuch-show-previous-button ()
1407   "Move point back to the previous button in the buffer."
1408   (interactive)
1409   (backward-button 1))
1410
1411 (defun notmuch-show-archive-thread-internal (show-next)
1412   ;; Remove the tag from the current set of messages.
1413   (goto-char (point-min))
1414   (loop do (notmuch-show-remove-tag "inbox")
1415         until (not (notmuch-show-goto-message-next)))
1416   ;; Move to the next item in the search results, if any.
1417   (let ((parent-buffer notmuch-show-parent-buffer))
1418     (notmuch-kill-this-buffer)
1419     (if parent-buffer
1420         (progn
1421           (switch-to-buffer parent-buffer)
1422           (forward-line)
1423           (if show-next
1424               (notmuch-search-show-thread))))))
1425
1426 (defun notmuch-show-archive-thread ()
1427   "Archive each message in thread, then show next thread from search.
1428
1429 Archive each message currently shown by removing the \"inbox\"
1430 tag from each. Then kill this buffer and show the next thread
1431 from the search from which this thread was originally shown.
1432
1433 Note: This command is safe from any race condition of new messages
1434 being delivered to the same thread. It does not archive the
1435 entire thread, but only the messages shown in the current
1436 buffer."
1437   (interactive)
1438   (notmuch-show-archive-thread-internal t))
1439
1440 (defun notmuch-show-archive-thread-then-exit ()
1441   "Archive each message in thread, then exit back to search results."
1442   (interactive)
1443   (notmuch-show-archive-thread-internal nil))
1444
1445 (defun notmuch-show-stash-cc ()
1446   "Copy CC field of current message to kill-ring."
1447   (interactive)
1448   (notmuch-common-do-stash (notmuch-show-get-cc)))
1449
1450 (defun notmuch-show-stash-date ()
1451   "Copy date of current message to kill-ring."
1452   (interactive)
1453   (notmuch-common-do-stash (notmuch-show-get-date)))
1454
1455 (defun notmuch-show-stash-filename ()
1456   "Copy filename of current message to kill-ring."
1457   (interactive)
1458   (notmuch-common-do-stash (notmuch-show-get-filename)))
1459
1460 (defun notmuch-show-stash-from ()
1461   "Copy From address of current message to kill-ring."
1462   (interactive)
1463   (notmuch-common-do-stash (notmuch-show-get-from)))
1464
1465 (defun notmuch-show-stash-message-id ()
1466   "Copy message ID of current message to kill-ring."
1467   (interactive)
1468   (notmuch-common-do-stash (notmuch-show-get-message-id)))
1469
1470 (defun notmuch-show-stash-message-id-stripped ()
1471   "Copy message ID of current message (sans `id:' prefix) to kill-ring."
1472   (interactive)
1473   (notmuch-common-do-stash (substring (notmuch-show-get-message-id) 4 -1)))
1474
1475 (defun notmuch-show-stash-subject ()
1476   "Copy Subject field of current message to kill-ring."
1477   (interactive)
1478   (notmuch-common-do-stash (notmuch-show-get-subject)))
1479
1480 (defun notmuch-show-stash-tags ()
1481   "Copy tags of current message to kill-ring as a comma separated list."
1482   (interactive)
1483   (notmuch-common-do-stash (mapconcat 'identity (notmuch-show-get-tags) ",")))
1484
1485 (defun notmuch-show-stash-to ()
1486   "Copy To address of current message to kill-ring."
1487   (interactive)
1488   (notmuch-common-do-stash (notmuch-show-get-to)))
1489
1490 ;; Commands typically bound to buttons.
1491
1492 (defun notmuch-show-part-button-action (button)
1493   (let ((nth (button-get button :notmuch-part)))
1494     (if nth
1495         (notmuch-show-save-part (notmuch-show-get-message-id) nth
1496                                 (button-get button :notmuch-filename))
1497       (message "Not a valid part (is it a fake part?)."))))
1498
1499 ;;
1500
1501 (provide 'notmuch-show)