emacs: Remove broken `notmuch-get-bodypart-content' API

`notmuch-get-bodypart-content' could do two very different things,
depending on conditions: for text/* parts other than text/html, it
would return the part content as a multibyte Lisp string *after*
charset conversion, while for other parts (including text/html), it
would return binary part content without charset conversion.

This commit completes the split of `notmuch-get-bodypart-content' into
two different and explicit APIs: `notmuch-get-bodypart-binary' and
`notmuch-get-bodypart-text'.  It updates all callers to use one or the
other depending on what's appropriate.
This commit is contained in:
Austin Clements 2015-01-24 16:16:58 -05:00 committed by David Bremner
parent 021906d6ec
commit 991efcded8
2 changed files with 32 additions and 13 deletions

View file

@ -545,9 +545,25 @@ this does no charset conversion."
(apply #'call-process notmuch-command nil '(t nil) nil args) (apply #'call-process notmuch-command nil '(t nil) nil args)
(buffer-string))))) (buffer-string)))))
(defun notmuch-get-bodypart-content (msg part process-crypto) (defun notmuch-get-bodypart-text (msg part process-crypto)
(or (plist-get part :content) "Return the text content of PART in MSG.
(notmuch-get-bodypart-binary msg part process-crypto)))
This returns the content of the given part as a multibyte Lisp
string after performing content transfer decoding and any
necessary charset decoding. It is an error to use this for
non-text/* parts."
(let ((content (plist-get part :content)))
(when (not content)
;; Use show --format=sexp to fetch decoded content
(let* ((args `("show" "--format=sexp" "--include-html"
,(format "--part=%s" (plist-get part :id))
,@(when process-crypto '("--decrypt"))
,(notmuch-id-to-query (plist-get msg :id))))
(npart (apply #'notmuch-call-notmuch-sexp args)))
(setq content (plist-get npart :content))
(when (not content)
(error "Internal error: No :content from %S" args))))
content))
;; Workaround: The call to `mm-display-part' below triggers a bug in ;; Workaround: The call to `mm-display-part' below triggers a bug in
;; Emacs 24 if it attempts to use the shr renderer to display an HTML ;; Emacs 24 if it attempts to use the shr renderer to display an HTML
@ -568,18 +584,21 @@ this does no charset conversion."
current buffer, if possible." current buffer, if possible."
(let ((display-buffer (current-buffer))) (let ((display-buffer (current-buffer)))
(with-temp-buffer (with-temp-buffer
;; In case there is :content, the content string is already converted ;; In case we already have :content, use it and tell mm-* that
;; into emacs internal format. `gnus-decoded' is a fake charset, ;; it's already been charset-decoded by using the fake
;; which means no further decoding (to be done by mm- functions). ;; `gnus-decoded' charset. Otherwise, we'll fetch the binary
(let* ((charset (if (plist-member part :content) ;; part content and let mm-* decode it.
'gnus-decoded (let* ((have-content (plist-member part :content))
(charset (if have-content 'gnus-decoded
(plist-get part :content-charset))) (plist-get part :content-charset)))
(handle (mm-make-handle (current-buffer) `(,content-type (charset . ,charset))))) (handle (mm-make-handle (current-buffer) `(,content-type (charset . ,charset)))))
;; If the user wants the part inlined, insert the content and ;; If the user wants the part inlined, insert the content and
;; test whether we are able to inline it (which includes both ;; test whether we are able to inline it (which includes both
;; capability and suitability tests). ;; capability and suitability tests).
(when (mm-inlined-p handle) (when (mm-inlined-p handle)
(insert (notmuch-get-bodypart-content msg part process-crypto)) (if have-content
(insert (notmuch-get-bodypart-text msg part process-crypto))
(insert (notmuch-get-bodypart-binary msg part process-crypto)))
(when (mm-inlinable-p handle) (when (mm-inlinable-p handle)
(set-buffer display-buffer) (set-buffer display-buffer)
(mm-display-part handle) (mm-display-part handle)

View file

@ -702,7 +702,7 @@ message at DEPTH in the current thread."
(let ((start (if button (let ((start (if button
(button-start button) (button-start button)
(point)))) (point))))
(insert (notmuch-get-bodypart-content msg part notmuch-show-process-crypto)) (insert (notmuch-get-bodypart-text msg part notmuch-show-process-crypto))
(save-excursion (save-excursion
(save-restriction (save-restriction
(narrow-to-region start (point-max)) (narrow-to-region start (point-max))
@ -711,9 +711,9 @@ message at DEPTH in the current thread."
(defun notmuch-show-insert-part-text/calendar (msg part content-type nth depth button) (defun notmuch-show-insert-part-text/calendar (msg part content-type nth depth button)
(insert (with-temp-buffer (insert (with-temp-buffer
(insert (notmuch-get-bodypart-content msg part notmuch-show-process-crypto)) (insert (notmuch-get-bodypart-text msg part notmuch-show-process-crypto))
;; notmuch-get-bodypart-content provides "raw", non-converted ;; notmuch-get-bodypart-text does no newline conversion.
;; data. Replace CRLF with LF before icalendar can use it. ;; Replace CRLF with LF before icalendar can use it.
(goto-char (point-min)) (goto-char (point-min))
(while (re-search-forward "\r\n" nil t) (while (re-search-forward "\r\n" nil t)
(replace-match "\n" nil nil)) (replace-match "\n" nil nil))