Re: [PATCH 1/1] Make buttons for attachments allow viewing as well as saving
authorAustin Clements <amdragon@MIT.EDU>
Tue, 17 Jan 2012 23:02:55 +0000 (18:02 +1900)
committerW. Trevor King <wking@tremily.us>
Fri, 7 Nov 2014 17:42:31 +0000 (09:42 -0800)
b8/4f3bcc545295b676cf3cef3f1a5c2ad9728f58 [new file with mode: 0644]

diff --git a/b8/4f3bcc545295b676cf3cef3f1a5c2ad9728f58 b/b8/4f3bcc545295b676cf3cef3f1a5c2ad9728f58
new file mode 100644 (file)
index 0000000..ee1b7f3
--- /dev/null
@@ -0,0 +1,394 @@
+Return-Path: <amdragon@mit.edu>\r
+X-Original-To: notmuch@notmuchmail.org\r
+Delivered-To: notmuch@notmuchmail.org\r
+Received: from localhost (localhost [127.0.0.1])\r
+       by olra.theworths.org (Postfix) with ESMTP id D0B08429E5F\r
+       for <notmuch@notmuchmail.org>; Tue, 17 Jan 2012 15:03:10 -0800 (PST)\r
+X-Virus-Scanned: Debian amavisd-new at olra.theworths.org\r
+X-Spam-Flag: NO\r
+X-Spam-Score: -0.7\r
+X-Spam-Level: \r
+X-Spam-Status: No, score=-0.7 tagged_above=-999 required=5\r
+       tests=[RCVD_IN_DNSWL_LOW=-0.7] autolearn=disabled\r
+Received: from olra.theworths.org ([127.0.0.1])\r
+       by localhost (olra.theworths.org [127.0.0.1]) (amavisd-new, port 10024)\r
+       with ESMTP id e0wzQcsFR-bM for <notmuch@notmuchmail.org>;\r
+       Tue, 17 Jan 2012 15:03:09 -0800 (PST)\r
+Received: from dmz-mailsec-scanner-3.mit.edu (DMZ-MAILSEC-SCANNER-3.MIT.EDU\r
+       [18.9.25.14])\r
+       by olra.theworths.org (Postfix) with ESMTP id 80EFC429E27\r
+       for <notmuch@notmuchmail.org>; Tue, 17 Jan 2012 15:03:09 -0800 (PST)\r
+X-AuditID: 1209190e-b7f7c6d0000008c3-d7-4f15fe2c02a4\r
+Received: from mailhub-auth-4.mit.edu ( [18.7.62.39])\r
+       by dmz-mailsec-scanner-3.mit.edu (Symantec Messaging Gateway) with SMTP\r
+       id 4C.4D.02243.C2EF51F4; Tue, 17 Jan 2012 18:03:09 -0500 (EST)\r
+Received: from outgoing.mit.edu (OUTGOING-AUTH.MIT.EDU [18.7.22.103])\r
+       by mailhub-auth-4.mit.edu (8.13.8/8.9.2) with ESMTP id q0HN38I5025284; \r
+       Tue, 17 Jan 2012 18:03:08 -0500\r
+Received: from awakening.csail.mit.edu (awakening.csail.mit.edu [18.26.4.91])\r
+       (authenticated bits=0)\r
+       (User authenticated as amdragon@ATHENA.MIT.EDU)\r
+       by outgoing.mit.edu (8.13.6/8.12.4) with ESMTP id q0HN37YK008150\r
+       (version=TLSv1/SSLv3 cipher=AES256-SHA bits=256 verify=NOT);\r
+       Tue, 17 Jan 2012 18:03:07 -0500 (EST)\r
+Received: from amthrax by awakening.csail.mit.edu with local (Exim 4.77)\r
+       (envelope-from <amdragon@mit.edu>)\r
+       id 1RnI3L-0008EH-BV; Tue, 17 Jan 2012 18:02:55 -0500\r
+Date: Tue, 17 Jan 2012 18:02:55 -0500\r
+From: Austin Clements <amdragon@MIT.EDU>\r
+To: Mark Walters <markwalters1009@gmail.com>\r
+Subject: Re: [PATCH 1/1] Make buttons for attachments allow viewing as well\r
+       as saving\r
+Message-ID: <20120117230255.GW16740@mit.edu>\r
+References: <1326629796-11436-1-git-send-email-markwalters1009@gmail.com>\r
+       <1326629796-11436-2-git-send-email-markwalters1009@gmail.com>\r
+       <87wr8r5trv.fsf@servo.finestructure.net>\r
+       <87lip7fhkc.fsf@qmul.ac.uk> <20120117022330.GE16740@mit.edu>\r
+       <8739beitq4.fsf@qmul.ac.uk> <20120117202603.GP16740@mit.edu>\r
+       <871uqy3vy4.fsf@qmul.ac.uk> <20120117210158.GS16740@mit.edu>\r
+       <87obu2q80o.fsf@qmul.ac.uk>\r
+MIME-Version: 1.0\r
+Content-Type: text/plain; charset=us-ascii\r
+Content-Disposition: inline\r
+In-Reply-To: <87obu2q80o.fsf@qmul.ac.uk>\r
+User-Agent: Mutt/1.5.21 (2010-09-15)\r
+X-Brightmail-Tracker:\r
+ H4sIAAAAAAAAA+NgFupjleLIzCtJLcpLzFFi42IRYrdT19X9J+pvsDDCYvVcHovrN2cyOzB5\r
+       7Jx1l93j2apbzAFMUVw2Kak5mWWpRfp2CVwZa9fMYimYkl/RvaqftYGxN7KLkZNDQsBEYua8\r
+       98wQtpjEhXvr2boYuTiEBPYxSrScnc0K4WxglLj2/QoThHOSSeLttOfMEM4SRokz13+B9bMI\r
+       qEp0f7oCZrMJaEhs27+cEcQWEdCRuH1oATuIzSwgLfHtdzMTiC0sEC5x5w5EnBeo5sC372C2\r
+       kMBUZomj39Ug4oISJ2c+YYHo1ZK48e8lUC8H2Jzl/zhAwpxAq648eglWIiqgIjHl5Da2CYxC\r
+       s5B0z0LSPQuhewEj8ypG2ZTcKt3cxMyc4tRk3eLkxLy81CJdY73czBK91JTSTYygoOaU5NvB\r
+       +PWg0iFGAQ5GJR5eiQ2i/kKsiWXFlbmHGCU5mJREea1/AYX4kvJTKjMSizPii0pzUosPMUpw\r
+       MCuJ8F66DJTjTUmsrEotyodJSXOwKInzqmm98xMSSE8sSc1OTS1ILYLJynBwKEnwOv4FahQs\r
+       Sk1PrUjLzClBSDNxcIIM5wEavuMPyPDigsTc4sx0iPwpRl2Ok2uvnGMUYsnLz0uVEuddCDJI\r
+       AKQoozQPbg4sGb1iFAd6S5j3K8goHmAig5v0CmgJE9CSnFYhkCUliQgpqQZGo7UKMosbryw8\r
+       ssXah+9v9MKQ289Omm1atDj9x+ay3OojfVLC//xepWlddHr1bdPhd+xGdZHMXsmRaaFHe5NY\r
+       fotIegmlKu7wO1e2lOle4Mrdt70sD3M6L1ubMH9ziZXUkqxtpl+rBBzZM/lesFkuFD3xdU5U\r
+       cmhye4/c9Xfy1uX/Za3XyHkqsRRnJBpqMRcVJwIArjfqVyEDAAA=\r
+Cc: notmuch@notmuchmail.org\r
+X-BeenThere: notmuch@notmuchmail.org\r
+X-Mailman-Version: 2.1.13\r
+Precedence: list\r
+List-Id: "Use and development of the notmuch mail system."\r
+       <notmuch.notmuchmail.org>\r
+List-Unsubscribe: <http://notmuchmail.org/mailman/options/notmuch>,\r
+       <mailto:notmuch-request@notmuchmail.org?subject=unsubscribe>\r
+List-Archive: <http://notmuchmail.org/pipermail/notmuch>\r
+List-Post: <mailto:notmuch@notmuchmail.org>\r
+List-Help: <mailto:notmuch-request@notmuchmail.org?subject=help>\r
+List-Subscribe: <http://notmuchmail.org/mailman/listinfo/notmuch>,\r
+       <mailto:notmuch-request@notmuchmail.org?subject=subscribe>\r
+X-List-Received-Date: Tue, 17 Jan 2012 23:03:11 -0000\r
+\r
+Quoth Mark Walters on Jan 17 at 10:27 pm:\r
+> > (defmacro notmuch-with-temp-part-buffer (message-id nth &rest body)\r
+> >   (declare (indent 2))\r
+> >   (let ((process-crypto (make-symbol "process-crypto")))\r
+> >     `(let ((,process-crypto notmuch-show-process-crypto))\r
+> >        (with-temp-buffer\r
+> >          (setq notmuch-show-process-crypto ,process-crypto)\r
+> >          ;; Always acquires the part via `notmuch part', even if it is\r
+> >          ;; available in the JSON output.\r
+> >          (insert (notmuch-show-get-bodypart-internal message-id nth))\r
+> >          ,@body))))\r
+> \r
+> I have followed the macro approach: since notmuch-show-save-part also\r
+> uses it (which doesn't appear in the diff as it was unchanged). I have\r
+> made all three functions use notmuch-with-temp-part-buffer. However, I\r
+> used the macro exactly as you wrote it (and it seems to work) but I\r
+> moderately understand why but could not justify it to someone! \r
+\r
+Oops, actually there was a bug in that macro.  It should have been\r
+\r
+(defmacro notmuch-with-temp-part-buffer (message-id nth &rest body)\r
+  (declare (indent 2))\r
+  (let ((process-crypto (make-symbol "process-crypto")))\r
+    `(let ((,process-crypto notmuch-show-process-crypto))\r
+       (with-temp-buffer\r
+         (setq notmuch-show-process-crypto ,process-crypto)\r
+         ;; Always acquires the part via `notmuch part', even if it is\r
+         ;; available in the JSON output.\r
+         (insert (notmuch-show-get-bodypart-internal ,message-id ,nth))\r
+         ,@body))))\r
+\r
+The only difference is on the "insert" line.  Sorry about that.\r
+\r
+I don't know how familiar you are with syntactic abstraction, so\r
+here's a top-down explanation.  A macro is like the compile-time\r
+equivalent of a function: rather than the arguments and return being\r
+values that result from evaluation, they are pieces of code, the body\r
+of the macro executes at compile time instead of at run time, and the\r
+compiler replaces the invocation of the macro with the code that the\r
+macro returns.  This is not unlike a C/C++ macro, but the\r
+implementation of the macro is regular Lisp code that runs at compile\r
+time and the code is represented as S-expressions rather than strings\r
+(one beauty of Lisp is that the representation of code and data is the\r
+same).\r
+\r
+The above macro returns the code starting after the "`" (pronounced\r
+quasiquote), so that's what invocations of the macro get replaced\r
+with.  Quasiquote (like quote) inhibits the evaluation of what follows\r
+it and results in the code as data, rather than the result of\r
+evaluating the code.  Unlike quote, quasiquote lets you jump back into\r
+the evaluator using "," and ",@", so it's great for piecing together\r
+code from a template, which is what macros spend most of their time\r
+doing.\r
+\r
+The "declare" is simply a specification to emacs-lisp-mode about how\r
+to indent uses of this macro.  The "make-symbol" is necessary to avoid\r
+conflicting with variable names that may appear in the code that uses\r
+this macro (since the invoking code and the code returned by the macro\r
+will be interleaved, you have to worry about variable conflicts).\r
+\r
+> > (defun notmuch-show-interactively-view-part (message-id nth content-type)\r
+> >   (notmuch-with-temp-part-buffer message-id nth\r
+> >     (let ((handle (mm-make-handle (current-buffer) (list content-type))))\r
+> >       (mm-interactively-view-part handle)))))\r
+> \r
+> Emacs wants to indent the (let line level with message-id in the line\r
+> above which looks odd (and makes the lines too long). Do I overrule\r
+> emacs, or put message-id and nth onto a separate line or is there\r
+> something better?\r
+\r
+If you evaluate the defmacro, it'll pick up on that declare line at\r
+the beginning of it and indent this correctly.\r
+\r
+> Also note that, because of the unification with notmuch-show-save-part\r
+> all three functions have to have the four arguments message-id, nth,\r
+> filename and content-type (even though currently each individual\r
+> function only uses three of them). However see below for another comment\r
+> on this.\r
+\r
+That makes sense.\r
+\r
+> > > +(defcustom notmuch-show-part-button-default-action 'notmuch-show-part-button-save\r
+> > > +  "Default part header button action (on ENTER or mouse click)."\r
+> > > +  :group 'notmuch\r
+> > > +  :type '(choice (const :tag "Save part"\r
+> > > +                        notmuch-show-part-button-save)\r
+> > > +                 (const :tag "View part"\r
+> > > +                        notmuch-show-part-button-view)\r
+> > > +                 (const :tag "View interactively"\r
+> > > +                        notmuch-show-part-button-interactively-view)))\r
+> > \r
+> > You probably want this to be the handler function, rather than the\r
+> > button function, since the interface to the button function is rather\r
+> > awkward.  That is, if someone wanted to plug in their own action, they\r
+> > would want to define it in terms of the high-level handler interface\r
+> > that you use above, rather than the low-level\r
+> > button-with-magic-properties interface that Emacs forces you to use\r
+> > below.\r
+> \r
+> I have done this.\r
+> \r
+> > This duplication is much worse, but also less necessary.\r
+> > \r
+> > (defun notmuch-show-part-button-interactively-view (&optional button)\r
+> >   (interactive)\r
+> >   (notmuch-show-part-button-internal button #'notmuch-show-interactively-view-part))\r
+> > \r
+> > (defun notmuch-show-part-button-internal (button handler)\r
+> >   (let ((button (or button (button-at (point)))))\r
+> >     (if button\r
+> >    (let ((nth (button-get button :notmuch-part)))\r
+> >      (if nth\r
+> >          (funcall handler (notmuch-show-get-message-id) nth\r
+> >                           (button-get button :notmuch-content-type))\r
+> >        (message "Not a valid part (is it a fake part?)."))))))\r
+> \r
+> Yes this is much nicer and I have done this too (modulo the extra\r
+> argument mentioned above).\r
+> \r
+> Finally, I have discovered one bug/misfeature. If you try to "view" an\r
+> attachment then it will offer to save it but will not offer a\r
+> filename. If you try and save it (or use the default action) it will\r
+> offer a filename as now. As far as I can see this is not fixable if I\r
+> use mm-display-part: however, I could include a slight tweaked version,\r
+> notmuch-show-mm-display-part say, which would fix this corner\r
+> case. (Essentially, it would call notmuch-show-save-part if it failed to\r
+> find a handler rather than mailcap-save-binary-file.) However, this is\r
+> about 50 lines of lisp so I am not sure it is worth it.\r
+\r
+Hmm.  This is probably worth fixing, but probably in a separate patch.\r
+Duplicating mm-display-part is probably not the way to go.  It think\r
+it will work to pass t as the no-default argument to mm-display-part\r
+and check the return value, which should be 'inline if it was able to\r
+handle it internally or 'external if it found an external helper.  I'm\r
+pretty sure it will never fall in to mailcap-save-binary-file in that\r
+case.  If that doesn't work, you could flet mailcap-save-binary-file\r
+around the call to mm-display-part.\r
+\r
+> Best wishes\r
+> \r
+> Mark\r
+> \r
+> From bda4bb7637fb7d09c50f95b6b76fd42a377e0dde Mon Sep 17 00:00:00 2001\r
+> From: Mark Walters <markwalters1009@gmail.com>\r
+> Date: Sat, 14 Jan 2012 18:04:22 +0000\r
+> Subject: [PATCH] Make buttons for attachments allow viewing as well as saving\r
+> \r
+> Define a keymap for attachment buttons to allow multiple actions.\r
+> Define 3 possible actions:\r
+>     save attachment: exactly as currently,\r
+>     view attachment: uses mailcap entry,\r
+>     view attachment with user chosen program\r
+> \r
+> Keymap on a button is: s for save, v for view and o for view with\r
+> other program. Default (i.e. enter or mouse button) is save but this\r
+> is configurable in notmuch customize.\r
+> \r
+> One implementation detail: the view attachment function forces all\r
+> attachments to be "displayed" using mailcap even if emacs could\r
+> display them itself. Thus, for example, text/html appears in a browser\r
+> and text/plain asks whether to save (on a standard debian setup)\r
+> ---\r
+>  emacs/notmuch-show.el |  105 +++++++++++++++++++++++++++++++++++++-----------\r
+>  1 files changed, 81 insertions(+), 24 deletions(-)\r
+> \r
+> diff --git a/emacs/notmuch-show.el b/emacs/notmuch-show.el\r
+> index 03c1f6b..2e4fecd 100644\r
+> --- a/emacs/notmuch-show.el\r
+> +++ b/emacs/notmuch-show.el\r
+> @@ -281,10 +281,21 @@ message at DEPTH in the current thread."\r
+>      (run-hooks 'notmuch-show-markup-headers-hook)))))\r
+>  \r
+>  (define-button-type 'notmuch-show-part-button-type\r
+> -  'action 'notmuch-show-part-button-action\r
+> +  'action 'notmuch-show-part-button-default\r
+> +  'keymap 'notmuch-show-part-button-map\r
+>    'follow-link t\r
+>    'face 'message-mml)\r
+>  \r
+> +(defvar notmuch-show-part-button-map\r
+> +  (let ((map (make-sparse-keymap)))\r
+> +       (set-keymap-parent map button-map)\r
+> +       (define-key map "s" 'notmuch-show-part-button-save)\r
+> +       (define-key map "v" 'notmuch-show-part-button-view)\r
+> +       (define-key map "o" 'notmuch-show-part-button-interactively-view)\r
+> +    map)\r
+> +  "Submap for button commands")\r
+> +(fset 'notmuch-show-part-button-map notmuch-show-part-button-map)\r
+> +\r
+>  (defun notmuch-show-insert-part-header (nth content-type declared-type &optional name comment)\r
+>    (let ((button))\r
+>      (setq button\r
+> @@ -299,29 +310,48 @@ message at DEPTH in the current thread."\r
+>                 " ]")\r
+>         :type 'notmuch-show-part-button-type\r
+>         :notmuch-part nth\r
+> -       :notmuch-filename name))\r
+> +       :notmuch-filename name\r
+> +       :notmuch-content-type content-type))\r
+>      (insert "\n")\r
+>      ;; return button\r
+>      button))\r
+>  \r
+>  ;; Functions handling particular MIME parts.\r
+>  \r
+> -(defun notmuch-show-save-part (message-id nth &optional filename)\r
+> -  (let ((process-crypto notmuch-show-process-crypto))\r
+> -    (with-temp-buffer\r
+> -      (setq notmuch-show-process-crypto process-crypto)\r
+> -      ;; Always acquires the part via `notmuch part', even if it is\r
+> -      ;; available in the JSON output.\r
+> -      (insert (notmuch-show-get-bodypart-internal message-id nth))\r
+> -      (let ((file (read-file-name\r
+> -               "Filename to save as: "\r
+> -               (or mailcap-download-directory "~/")\r
+> -               nil nil\r
+> -               filename)))\r
+> -    ;; Don't re-compress .gz & al.  Arguably we should make\r
+> -    ;; `file-name-handler-alist' nil, but that would chop\r
+> -    ;; ange-ftp, which is reasonable to use here.\r
+> -    (mm-write-region (point-min) (point-max) file nil nil nil 'no-conversion t)))))\r
+> +(defmacro notmuch-with-temp-part-buffer (message-id nth &rest body)\r
+> +  (declare (indent 2))\r
+> +  (let ((process-crypto (make-symbol "process-crypto")))\r
+> +    `(let ((,process-crypto notmuch-show-process-crypto))\r
+> +       (with-temp-buffer\r
+> +     (setq notmuch-show-process-crypto ,process-crypto)\r
+> +     ;; Always acquires the part via `notmuch part', even if it is\r
+> +     ;; available in the JSON output.\r
+> +     (insert (notmuch-show-get-bodypart-internal message-id nth))\r
+\r
+Should be ",message-id ,nth" instead of "message-id nth" (my fault).\r
+\r
+> +     ,@body))))\r
+> +\r
+> +(defun notmuch-show-save-part (message-id nth &optional filename content-type)\r
+> +  (notmuch-with-temp-part-buffer message-id nth\r
+> +     (let ((file (read-file-name\r
+> +              "Filename to save as: "\r
+> +              (or mailcap-download-directory "~/")\r
+> +              nil nil\r
+> +              filename)))\r
+> +       ;; Don't re-compress .gz & al.  Arguably we should make\r
+> +       ;; `file-name-handler-alist' nil, but that would chop\r
+> +       ;; ange-ftp, which is reasonable to use here.\r
+> +       (mm-write-region (point-min) (point-max) file nil nil nil 'no-conversion t))))\r
+> +\r
+> +(defun notmuch-show-view-part (message-id nth &optional filename content-type )\r
+> +  (notmuch-with-temp-part-buffer message-id nth\r
+> +   ;; set mm-inlined-types to nil to force an external viewer\r
+> +    (let ((handle (mm-make-handle (current-buffer) (list content-type)))\r
+> +      (mm-inlined-types nil))\r
+> +      (mm-display-part handle t))))\r
+> +\r
+> +(defun notmuch-show-interactively-view-part (message-id nth &optional filename content-type)\r
+> +  (notmuch-with-temp-part-buffer message-id nth\r
+> +   (let ((handle (mm-make-handle (current-buffer) (list content-type))))\r
+> +     (mm-interactively-view-part handle))))\r
+>  \r
+>  (defun notmuch-show-mm-display-part-inline (msg part nth content-type)\r
+>    "Use the mm-decode/mm-view functions to display a part in the\r
+> @@ -1502,13 +1532,40 @@ buffer."\r
+>  \r
+>  ;; Commands typically bound to buttons.\r
+>  \r
+> -(defun notmuch-show-part-button-action (button)\r
+> -  (let ((nth (button-get button :notmuch-part)))\r
+> -    (if nth\r
+> -    (notmuch-show-save-part (notmuch-show-get-message-id) nth\r
+> -                            (button-get button :notmuch-filename))\r
+> -      (message "Not a valid part (is it a fake part?)."))))\r
+> +(defcustom notmuch-show-part-button-default-action 'notmuch-show-save-part\r
+> +  "Default part header button action (on ENTER or mouse click)."\r
+> +  :group 'notmuch\r
+> +  :type '(choice (const :tag "Save part"\r
+> +                    notmuch-show-save-part)\r
+> +             (const :tag "View part"\r
+> +                    notmuch-show-view-part)\r
+> +             (const :tag "View interactively"\r
+> +                    notmuch-show-interactively-view-part)))\r
+> +\r
+> +(defun notmuch-show-part-button-default (&optional button)\r
+> +  (interactive)\r
+> +  (notmuch-show-part-button-internal button notmuch-show-part-button-default-action))\r
+>  \r
+> +(defun notmuch-show-part-button-save (&optional button)\r
+> +  (interactive)\r
+> +  (notmuch-show-part-button-internal button #'notmuch-show-save-part))\r
+> +\r
+> +(defun notmuch-show-part-button-view (&optional button)\r
+> +  (interactive)\r
+> +  (notmuch-show-part-button-internal button #'notmuch-show-view-part))\r
+> +\r
+> +(defun notmuch-show-part-button-interactively-view (&optional button)\r
+> +  (interactive)\r
+> +  (notmuch-show-part-button-internal button #'notmuch-show-interactively-view-part))\r
+\r
+Much better!\r
+\r
+> +\r
+> +(defun notmuch-show-part-button-internal (button handler)\r
+> +  (let ((button (or button (button-at (point)))))\r
+> +    (if button\r
+> +    (let ((nth (button-get button :notmuch-part)))\r
+> +      (if nth\r
+> +          (funcall handler (notmuch-show-get-message-id) nth\r
+> +                   (button-get button :notmuch-filename)\r
+> +                   (button-get button :notmuch-content-type)))))))\r
+>  ;;\r
+>  \r
+>  (provide 'notmuch-show)\r