]> git.notmuchmail.org Git - notmuch/blobdiff - emacs/notmuch-show.el
emacs: Display all body parts using `notmuch part --part=<n>'
[notmuch] / emacs / notmuch-show.el
index 5013222358ae8b813b68bfbb21655de90a699930..556941a507425f978b325e41ee6e20fbd3e6ca53 100644 (file)
 (require 'cl)
 (require 'mm-view)
 (require 'message)
+(require 'mm-decode)
+(require 'mailcap)
 
 (require 'notmuch-lib)
 (require 'notmuch-query)
+(require 'notmuch-wash)
 
 (declare-function notmuch-call-notmuch-process "notmuch" (&rest args))
 (declare-function notmuch-reply "notmuch" (query-string))
 (declare-function notmuch-select-tag-with-completion "notmuch" (prompt &rest search-terms))
 (declare-function notmuch-search-show-thread "notmuch" nil)
 
-(defvar notmuch-show-citation-regexp
-  "\\(?:^[[:space:]]>.*\n\\(?:[[:space:]]*\n[[:space:]]>.*\n\\)?\\)+"
-  "Pattern to match citation lines.")
-
-(defvar notmuch-show-signature-regexp
-  "^\\(-- ?\\|_+\\)$"
-  "Pattern to match a line that separates content from signature.")
-
-(defvar notmuch-show-signature-button-format
-  "[ %d-line signature. Click/Enter to toggle visibility. ]"
-  "String used to construct button text for hidden signatures
-
-Can use up to one integer format parameter, i.e. %d")
-
-(defvar notmuch-show-citation-button-format
-  "[ %d more citation lines. Click/Enter to toggle visibility. ]"
-  "String used to construct button text for hidden citations.
-
-Can use up to one integer format parameter, i.e. %d")
-
-(defvar notmuch-show-signature-lines-max 12
-  "Maximum length of signature that will be hidden by default.")
-
-(defvar notmuch-show-citation-lines-prefix 3
-  "Always show at least this many lines at the start of a citation.
-
-If there is one more line than the sum of
-`notmuch-show-citation-lines-prefix' and
-`notmuch-show-citation-lines-suffix', show that, otherwise
-collapse remaining lines into a button.")
-
-(defvar notmuch-show-citation-lines-suffix 3
-  "Always show at least this many lines at the end of a citation.
-
-If there is one more line than the sum of
-`notmuch-show-citation-lines-prefix' and
-`notmuch-show-citation-lines-suffix', show that, otherwise
-collapse remaining lines into a button.")
-
 (defvar notmuch-show-headers '("Subject" "To" "Cc" "From" "Date")
   "Headers that should be shown in a message, in this order. Note
 that if this order is changed the headers shown when a message is
@@ -86,60 +50,13 @@ collapsed will change.")
   "A list of functions called after populating a
 `notmuch-show' buffer.")
 
+(defvar notmuch-show-insert-text/plain-hook '(notmuch-wash-text/plain-citations)
+  "A list of functions called to clean up text/plain body parts.")
+
 (defun notmuch-show-pretty-hook ()
   (goto-address-mode 1)
   (visual-line-mode))
 
-(defun notmuch-toggle-invisible-action (cite-button)
-  (let ((invis-spec (button-get cite-button 'invisibility-spec)))
-        (if (invisible-p invis-spec)
-            (remove-from-invisibility-spec invis-spec)
-          (add-to-invisibility-spec invis-spec)
-          ))
-  (force-window-update)
-  (redisplay t))
-
-(define-button-type 'notmuch-button-invisibility-toggle-type
-  'action 'notmuch-toggle-invisible-action
-  'follow-link t
-  'face 'font-lock-comment-face)
-(define-button-type 'notmuch-button-citation-toggle-type
-  'help-echo "mouse-1, RET: Show citation"
-  :supertype 'notmuch-button-invisibility-toggle-type)
-(define-button-type 'notmuch-button-signature-toggle-type
-  'help-echo "mouse-1, RET: Show signature"
-  :supertype 'notmuch-button-invisibility-toggle-type)
-(define-button-type 'notmuch-button-headers-toggle-type
-  'help-echo "mouse-1, RET: Show headers"
-  :supertype 'notmuch-button-invisibility-toggle-type)
-
-(defun notmuch-show-region-to-button (beg end type prefix button-text)
-  "Auxilary function to do the actual making of overlays and buttons
-
-BEG and END are buffer locations. TYPE should a string, either
-\"citation\" or \"signature\". PREFIX is some arbitrary text to
-insert before the button, probably for indentation.  BUTTON-TEXT
-is what to put on the button."
-
-;; This uses some slightly tricky conversions between strings and
-;; symbols because of the way the button code works. Note that
-;; replacing intern-soft with make-symbol will cause this to fail,
-;; since the newly created symbol has no plist.
-
-  (let ((overlay (make-overlay beg end))
-       (invis-spec (make-symbol (concat "notmuch-" type "-region")))
-       (button-type (intern-soft (concat "notmuch-button-"
-                                         type "-toggle-type"))))
-    (add-to-invisibility-spec invis-spec)
-    (overlay-put overlay 'invisible invis-spec)
-    (goto-char (1+ end))
-    (save-excursion
-      (goto-char (1- beg))
-      (insert prefix)
-      (insert-button button-text
-                    'invisibility-spec invis-spec
-                    :type button-type))))
-
 (defmacro with-current-notmuch-show-message (&rest body)
   "Evaluate body with current buffer set to the text of current message"
   `(save-excursion
@@ -287,70 +204,71 @@ message at DEPTH in the current thread."
        (narrow-to-region start (point-max))
        (run-hooks 'notmuch-show-markup-headers-hook)))))
 
-(defun notmuch-show-insert-part-header (content-type)
+(defun notmuch-show-insert-part-header (content-type declared-type &optional name)
   (let ((start (point)))
     ;; XXX dme: Make this a more useful button (save the part, display
     ;; external, etc.)
-    (insert "[ Part of type " content-type ". ]\n")
+    (insert "[ "
+           (if name (concat name ": ") "")
+           declared-type
+           (if (not (string-equal declared-type content-type))
+               (concat " (as " content-type ")")
+             "")
+           " ]\n")
     (overlay-put (make-overlay start (point)) 'face 'bold)))
 
 ;; Functions handling particular MIME parts.
 
-(defun notmuch-show-markup-citations ()
-  "Markup citations, and up to one signature in the buffer."
-  (let ((depth 0)
-       (indent "\n"))
-    (goto-char (point-min))
-    (beginning-of-line)
-    (while (and (< (point) (point-max))
-               (re-search-forward notmuch-show-citation-regexp nil t))
-      (let* ((cite-start (match-beginning 0))
-            (cite-end (match-end 0))
-            (cite-lines (count-lines cite-start cite-end)))
-       (when (> cite-lines (1+ notmuch-show-citation-lines-prefix))
-         (goto-char cite-start)
-         (forward-line notmuch-show-citation-lines-prefix)
-         (let ((hidden-start (point-marker)))
-           (goto-char cite-end)
-           (notmuch-show-region-to-button
-            hidden-start (point-marker)
-            "citation" indent
-            (format notmuch-show-citation-button-format
-                    (- cite-lines notmuch-show-citation-lines-prefix)))))))
-    (if (and (not (eobp))
-            (re-search-forward notmuch-show-signature-regexp nil t))
-       (let* ((sig-start (match-beginning 0))
-              (sig-end (match-end 0))
-              (sig-lines (1- (count-lines sig-start (point-max)))))
-         (if (<= sig-lines notmuch-show-signature-lines-max)
-             (let ((sig-start-marker (make-marker))
-                   (sig-end-marker (make-marker)))
-               (set-marker sig-start-marker sig-start)
-               (set-marker sig-end-marker (point-max))
-               (notmuch-show-region-to-button
-                sig-start-marker sig-end-marker
-                "signature" indent
-                (format notmuch-show-signature-button-format sig-lines))))))))
-
-(defun notmuch-show-insert-part-text/plain (part content-type depth)
+(defun notmuch-show-mm-display-part-inline (msg part content-type content)
+  "Use the mm-decode/mm-view functions to display a part in the
+current buffer, if possible."
+  (let ((display-buffer (current-buffer)))
+    (with-temp-buffer
+      (insert content)
+      (let ((handle (mm-make-handle (current-buffer) (list content-type))))
+       (set-buffer display-buffer)
+       (if (and (mm-inlinable-p handle)
+                (mm-inlined-p handle))
+           (progn
+             (mm-display-part handle)
+             t)
+         nil)))))
+
+(defun notmuch-show-insert-part-text/plain (msg part content-type nth depth declared-type)
   (let ((start (point)))
-    (insert (plist-get part :content))
+    ;; If this text/plain part is not the first part in the message,
+    ;; insert a header to make this clear.
+    (if (> nth 1)
+       (notmuch-show-insert-part-header declared-type content-type (plist-get part :filename)))
+    (insert (notmuch-show-get-bodypart-content msg part nth))
     (save-excursion
       (save-restriction
        (narrow-to-region start (point-max))
-       (notmuch-show-markup-citations))))
+       (run-hook-with-args 'notmuch-show-insert-text/plain-hook depth))))
   t)
 
-(defun notmuch-show-insert-part-text/* (part content-type depth)
-  ;; Handle all text types other than text/html.
-  (if (string-equal "text/html" content-type)
-      nil
-    (notmuch-show-insert-part-header content-type)
-    (insert (plist-get part :content))
-    t))
-
-(defun notmuch-show-insert-part-*/* (part content-type depth)
-  (notmuch-show-insert-part-header content-type)
+(defun notmuch-show-insert-part-application/octet-stream (msg part content-type nth depth declared-type)
+  ;; If we can deduce a MIME type from the filename of the attachment,
+  ;; do so and pass it on to the handler for that type.
+  (if (plist-get part :filename)
+      (let ((extension (file-name-extension (plist-get part :filename)))
+           mime-type)
+       (if extension
+           (progn
+             (mailcap-parse-mimetypes)
+             (setq mime-type (mailcap-extension-to-mime extension))
+             (if (and mime-type
+                      (not (string-equal mime-type "application/octet-stream")))
+                 (notmuch-show-insert-bodypart-internal msg part mime-type nth depth content-type)
+               nil))
+         nil))))
+
+(defun notmuch-show-insert-part-*/* (msg part content-type nth depth declared-type)
+  ;; This handler _must_ succeed - it is the handler of last resort.
+  (notmuch-show-insert-part-header content-type declared-type (plist-get part :filename))
+  (let ((content (notmuch-show-get-bodypart-content msg part nth)))
+    (if content
+       (notmuch-show-mm-display-part-inline msg part content-type content)))
   t)
 
 ;; Functions for determining how to handle MIME parts.
@@ -373,25 +291,46 @@ message at DEPTH in the current thread."
                (intern (concat "notmuch-show-insert-part-" content-type))))
     result))
 
+;; Helper for parts which are generally not included in the default
+;; JSON output.
+
+(defun notmuch-show-get-bodypart-internal (message-id part-number)
+  (with-temp-buffer
+    (let ((coding-system-for-read 'no-conversion))
+      (call-process notmuch-command nil t nil
+                   "part" (format "--part=%s" part-number) message-id)
+      (buffer-string))))
+
+(defun notmuch-show-get-bodypart-content (msg part nth)
+  (or (plist-get part :content)
+      (notmuch-show-get-bodypart-internal (concat "id:" (plist-get msg :id)) nth)))
+
 ;; \f
 
-(defun notmuch-show-insert-bodypart (part depth)
-  "Insert the body part PART at depth DEPTH in the current thread."
-  (let* ((content-type (downcase (plist-get part :content-type)))
-        (handlers (notmuch-show-handlers-for content-type)))
+(defun notmuch-show-insert-bodypart-internal (msg part content-type nth depth declared-type)
+  (let ((handlers (notmuch-show-handlers-for content-type)))
     ;; Run the content handlers until one of them returns a non-nil
     ;; value.
     (while (and handlers
-               (not (funcall (car handlers) part content-type depth)))
+               (not (funcall (car handlers) msg part content-type nth depth declared-type)))
       (setq handlers (cdr handlers))))
+  t)
+
+(defun notmuch-show-insert-bodypart (msg part depth)
+  "Insert the body part PART at depth DEPTH in the current thread."
+  (let ((content-type (downcase (plist-get part :content-type)))
+       (nth (plist-get part :id)))
+    (notmuch-show-insert-bodypart-internal msg part content-type nth depth content-type))
+  ;; Some of the body part handlers leave point somewhere up in the
+  ;; part, so we make sure that we're down at the end.
+  (goto-char (point-max))
   ;; Ensure that the part ends with a carriage return.
   (if (not (bolp))
-      (insert "\n"))
-  )
+      (insert "\n")))
 
-(defun notmuch-show-insert-body (body depth)
+(defun notmuch-show-insert-body (msg body depth)
   "Insert the body BODY at depth DEPTH in the current thread."
-  (mapc '(lambda (part) (notmuch-show-insert-bodypart part depth)) body))
+  (mapc '(lambda (part) (notmuch-show-insert-bodypart msg part depth)) body))
 
 (defun notmuch-show-make-symbol (type)
   (make-symbol (concat "notmuch-show-" type)))
@@ -430,7 +369,7 @@ message at DEPTH in the current thread."
     (setq headers-end (point-marker))
 
     (setq body-start (point-marker))
-    (notmuch-show-insert-body (plist-get msg :body) depth)
+    (notmuch-show-insert-body msg (plist-get msg :body) depth)
     ;; Ensure that the body ends with a newline.
     (if (not (bolp))
        (insert "\n"))