From mboxrd@z Thu Jan 1 00:00:00 1970 Return-Path: Received: from mp12.migadu.com ([2001:41d0:306:2d92::]) (using TLSv1.3 with cipher TLS_AES_256_GCM_SHA384 (256/256 bits)) by ms9.migadu.com with LMTPS id 6K/oGtSHEWVRRAAAauVa8A:P1 (envelope-from ) for ; Mon, 25 Sep 2023 15:15:00 +0200 Received: from aspmx1.migadu.com ([2001:41d0:306:2d92::]) (using TLSv1.3 with cipher TLS_AES_256_GCM_SHA384 (256/256 bits)) by mp12.migadu.com with LMTPS id 6K/oGtSHEWVRRAAAauVa8A (envelope-from ) for ; Mon, 25 Sep 2023 15:15:00 +0200 Received: from lists.gnu.org (lists.gnu.org [209.51.188.17]) (using TLSv1.2 with cipher ECDHE-RSA-AES256-GCM-SHA384 (256/256 bits)) (No client certificate requested) by aspmx1.migadu.com (Postfix) with ESMTPS id 08E6B55C01 for ; Mon, 25 Sep 2023 15:15:00 +0200 (CEST) Authentication-Results: aspmx1.migadu.com; dkim=pass header.d=gmail.com header.s=20230601 header.b=jluxNpRN; spf=pass (aspmx1.migadu.com: domain of "emacs-orgmode-bounces+larch=yhetil.org@gnu.org" designates 209.51.188.17 as permitted sender) smtp.mailfrom="emacs-orgmode-bounces+larch=yhetil.org@gnu.org"; dmarc=pass (policy=none) header.from=gmail.com ARC-Message-Signature: i=1; a=rsa-sha256; c=relaxed/relaxed; d=yhetil.org; s=key1; t=1695647700; h=from:from:sender:sender:reply-to:subject:subject:date:date: message-id:message-id:to:to:cc:cc:mime-version:mime-version: content-type:content-type:in-reply-to:in-reply-to: references:references:list-id:list-help:list-unsubscribe: list-subscribe:list-post:dkim-signature; bh=GLqzUHJuNk9OCojUQcgj8mnsetHBoMAwuTHGKG3S7C0=; b=d6h8u4FKrHHT29ei1mIKL3M3Tf0Sz3LXOAUryAU8HXmKG1IerFLaGwwb5UAGDoJ8OKYpUD xGWlX02Ki82wd8jp2c7OheAwKRMWszHrj7WQ/0Lj+l78vJReq+IA3ZXhSTlIYXQTVLbX6c CiawLMEKfQTVCOxE7SARGHbiJmcGO9ZSkZWdTfOu2kUHZos1YIqqGIWiiNcJKPtozECm/p LXhTDHaKSwmeRh7FvLesndOlYe23ZvMNFm1hBCfHOtwrXKU6SbL+CYymrGE+YTlPbm2GrC wo+OYhOpWySrTflSPQGVGt1rxLkDt4rYFeSYN1RFR0r1FWYgt0LRbqCQ09rqZQ== ARC-Authentication-Results: i=1; aspmx1.migadu.com; dkim=pass header.d=gmail.com header.s=20230601 header.b=jluxNpRN; spf=pass (aspmx1.migadu.com: domain of "emacs-orgmode-bounces+larch=yhetil.org@gnu.org" designates 209.51.188.17 as permitted sender) smtp.mailfrom="emacs-orgmode-bounces+larch=yhetil.org@gnu.org"; dmarc=pass (policy=none) header.from=gmail.com ARC-Seal: i=1; s=key1; d=yhetil.org; t=1695647700; a=rsa-sha256; cv=none; b=IB3R1ShE/+WNFNsyT8nJ6EzEz2g1PYLWI6X4KBegBdZQsCFHFb0A6MyBDxdlF/Sfn/Jq34 HW0DaCyEd3y78qtgQtLt40NCRF2isy90tiHOGZU54XCTts/wM7IgXrkyvczLkszCTPJ7Gk pMR1hvfAmDUxma7P/aLJo1ZWpNiK6X7Orq2+elAYPgNReLNOHSxPMRsIhjo1ZYHrNi9dEt hJsUHMe/vfVOMd4GE9UiDBsx+wfiditqmaSXQIrMjHZ07ybMG8L5QRIneL+sQqOvHUNe5h tK6Ut/K8/Ev3IgZMHJhVmFsdOQPdGxcvSJNRxYEw3Y6VBGpLE2FiJaU1wmjJNg== Received: from localhost ([::1] helo=lists1p.gnu.org) by lists.gnu.org with esmtp (Exim 4.90_1) (envelope-from ) id 1qklPm-0004NX-Dw; Mon, 25 Sep 2023 09:14:18 -0400 Received: from eggs.gnu.org ([2001:470:142:3::10]) by lists.gnu.org with esmtps (TLS1.2:ECDHE_RSA_AES_256_GCM_SHA384:256) (Exim 4.90_1) (envelope-from ) id 1qklPl-0004NJ-3i for emacs-orgmode@gnu.org; Mon, 25 Sep 2023 09:14:17 -0400 Received: from mail-pf1-x442.google.com ([2607:f8b0:4864:20::442]) by eggs.gnu.org with esmtps (TLS1.2:ECDHE_RSA_AES_128_GCM_SHA256:128) (Exim 4.90_1) (envelope-from ) id 1qklPi-0005qH-Kj for emacs-orgmode@gnu.org; Mon, 25 Sep 2023 09:14:16 -0400 Received: by mail-pf1-x442.google.com with SMTP id d2e1a72fcca58-690d2441b95so4725068b3a.1 for ; Mon, 25 Sep 2023 06:14:13 -0700 (PDT) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=gmail.com; s=20230601; t=1695647652; x=1696252452; darn=gnu.org; h=mime-version:user-agent:message-id:date:references:in-reply-to :subject:cc:to:from:from:to:cc:subject:date:message-id:reply-to; bh=GLqzUHJuNk9OCojUQcgj8mnsetHBoMAwuTHGKG3S7C0=; b=jluxNpRNEl8UJHeVuCLY3LOoZ1XvGYi7vJs6vKA7NW1CR0ra5zdWQz9py7oGoTSZzh j7umXgCZNhqQ6zdsWf37FqQkzpQ8mFIhvptRgiB+MoODBWp7Rzb9XGUVIhxxC7cCKvBF 2CKyGOJR6A1YqKognDiacgoh5rq/nKDc/vfMIcxaoj7b1lM0LjoUp6PUL+GiIG9gXxix s3ox75q03ls+V/Px+mxEV0IKlchIM5LGFq0N48dkknG0XpzESt5m79kOuRw0E/ajPy43 e7oOduVYLZ7qQXHBS+e8lmzyKLefYvW1BsC5dN4kHf46Xv1T7zcaKPRrGOCXQpeyPpzj e2tA== X-Google-DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=1e100.net; s=20230601; t=1695647652; x=1696252452; h=mime-version:user-agent:message-id:date:references:in-reply-to :subject:cc:to:from:x-gm-message-state:from:to:cc:subject:date :message-id:reply-to; bh=GLqzUHJuNk9OCojUQcgj8mnsetHBoMAwuTHGKG3S7C0=; b=J+pvAIuitt8O1BDBZdtZO4/7Xesdja3I12tkHIiCB34JPwm770Pqbrxn1tHrGPg90m WGYEesPrWajcUWDkKYg+s0AxT76eUPgJqVdV0v6rruAkHe3zajxnRn5RL0A1HChCt8iR 0PUAxEfT1fqATO8lMDasTR+9hK1c1X8U7sCE8VMykRmT+3uNLvxqiSdLL8IZClwm5cxj b5vfD5fVW50NoBuZwLK7vIvlvqPgu4t7pH37Bdqzn9qiqwnjL0osKAxfGPHupRiW0rSq WbOk9YBH+HLy18VRCVfZYfB3s76AiLAWS8yGP+4iLClQZz5qvQbdPEMfoHL/fVazets4 seJg== X-Gm-Message-State: AOJu0Yz/8gHr6S2tDR9eUQhPPAOLuxYxkbUcA/DvvmIcMK31HhywXCvc 1qO43sFl1gmecGeJTFB+NMOn9DFvLt/k2w== X-Google-Smtp-Source: AGHT+IF0lSk8qSPY5RiugEFRDBPCl3YAT3dFswCoeFYuGNscqpQvhvVFO8JrbN5apjiQBGlsAt5/hw== X-Received: by 2002:a05:6a00:2909:b0:68e:2c2a:aa1d with SMTP id cg9-20020a056a00290900b0068e2c2aaa1dmr15265337pfb.11.1695647651834; Mon, 25 Sep 2023 06:14:11 -0700 (PDT) Received: from localhost ([115.240.90.130]) by smtp.gmail.com with ESMTPSA id f15-20020aa78b0f000000b0068fe7c4148fsm7949253pfd.57.2023.09.25.06.14.10 (version=TLS1_3 cipher=TLS_AES_256_GCM_SHA384 bits=256/256); Mon, 25 Sep 2023 06:14:11 -0700 (PDT) From: Visuwesh To: Ihor Radchenko Cc: emacs-orgmode@gnu.org Subject: Re: [BUG] [PATCH] Add yank-media and DND handler [9.6.7 (9.6.7-g6eb773 @ /home/viz/lib/emacs/straight/build/org/)] In-Reply-To: <87bkdsomm2.fsf@gmail.com> (Visuwesh's message of "Sat, 23 Sep 2023 22:25:33 +0530") References: <87jzsintv0.fsf@gmail.com> <87lecx2nff.fsf@localhost> <87bkdsomm2.fsf@gmail.com> Date: Mon, 25 Sep 2023 18:44:08 +0530 Message-ID: <87a5tamm3j.fsf@gmail.com> User-Agent: Gnus/5.13 (Gnus v5.13) MIME-Version: 1.0 Content-Type: multipart/mixed; boundary="=-=-=" Received-SPF: pass client-ip=2607:f8b0:4864:20::442; envelope-from=visuweshm@gmail.com; helo=mail-pf1-x442.google.com X-Spam_score_int: -20 X-Spam_score: -2.1 X-Spam_bar: -- X-Spam_report: (-2.1 / 5.0 requ) BAYES_00=-1.9, DKIM_SIGNED=0.1, DKIM_VALID=-0.1, DKIM_VALID_AU=-0.1, DKIM_VALID_EF=-0.1, FREEMAIL_FROM=0.001, RCVD_IN_DNSWL_NONE=-0.0001, SPF_HELO_NONE=0.001, SPF_PASS=-0.001 autolearn=ham autolearn_force=no X-Spam_action: no action X-BeenThere: emacs-orgmode@gnu.org X-Mailman-Version: 2.1.29 Precedence: list List-Id: "General discussions about Org-mode." List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , Errors-To: emacs-orgmode-bounces+larch=yhetil.org@gnu.org Sender: emacs-orgmode-bounces+larch=yhetil.org@gnu.org X-Migadu-Flow: FLOW_IN X-Migadu-Country: US X-Migadu-Spam-Score: -5.02 X-Migadu-Scanner: mx2.migadu.com X-Migadu-Queue-Id: 08E6B55C01 X-Spam-Score: -5.02 X-TUID: evOxJc2VwtLJ --=-=-= Content-Type: text/plain; charset=utf-8 Content-Transfer-Encoding: quoted-printable [=E0=AE=9A=E0=AE=A9=E0=AE=BF =E0=AE=9A=E0=AF=86=E0=AE=AA=E0=AF=8D=E0=AE=9F= =E0=AE=AE=E0=AF=8D=E0=AE=AA=E0=AE=B0=E0=AF=8D 23, 2023] Visuwesh wrote: >>> +(defun org--image-yank-media-handler (mimetype data) >>> + "Save image DATA of mime-type MIMETYPE and insert link at point. >>> +It is saved as per `org-media-image-save-type'. The name for the >>> +image is prompted and the extension is automatically added to the >>> +end." >>> + (let* ((ext (symbol-name (mailcap-mime-type-to-extension mimetype))) >>> + (iname (read-string "Insert filename for image: ")) >> >> It would be nice if we auto-generate the file name here by default. It >> is what I would expect from yanking an image at least. > > Hmm, I think I prefer having a descriptive name for the file. It would > aid in searching for the attachment later (in the org document, and > using find & friends). We can add a user option but how should the name > be auto-generated? Timestamp? I have no ideas in this regard. Attached patch considers your review and also another defcustom to tell how to generate the filename which by default autogenerates a filename based on current time. --=-=-= Content-Type: text/x-diff Content-Disposition: attachment; filename=0001-Add-support-for-yank-media-and-DND.patch >From c9f149cde047a60b6c2a256d96616864f5f66352 Mon Sep 17 00:00:00 2001 From: Visuwesh Date: Fri, 22 Sep 2023 20:11:41 +0530 Subject: [PATCH] Add support for yank-media and DND * lisp/org.el (org-mode): Call the setup function for yank-media and DND. (org-setup-yank-dnd-handlers): Register yank-media-handler and DND handler. (org-yank-image-save-type, org-dnd-default-attach-method) (org-yank-image-file-name-function): New defcustoms. (org--image-yank-media-handler, org--copied-files-yank-media-handler) (org--dnd-local-file-handler): Add yank-media and DND handlers. * etc/ORG-NEWS: Advertise the new features. --- etc/ORG-NEWS | 20 ++++++ lisp/org.el | 169 ++++++++++++++++++++++++++++++++++++++++++++++++++- 2 files changed, 188 insertions(+), 1 deletion(-) diff --git a/etc/ORG-NEWS b/etc/ORG-NEWS index 252c5a9f9..c4a58dd4d 100644 --- a/etc/ORG-NEWS +++ b/etc/ORG-NEWS @@ -596,6 +596,26 @@ return a matplotlib Figure object to plot. For output results, the current figure (as returned by =pyplot.gcf()=) is cleared before evaluation, and then plotted afterwards. +*** Images and files in clipboard can be attached + +Org can now attach images in clipboard and files copied/cut to the +clipboard from file managers using the ~yank-media~ command which also +inserts a link to the attached file. This command was added in Emacs 29. + +Images can be saved to a separate directory instead of being attached, +customize ~org-yank-image-save-type~. + +Image filename chosen can be customized by setting +~org-yank-image-file-name-function~ which by default autogenerates a +filename based on the current time. + +*** Files and images can be attached by dropping onto Emacs + +Attachment method other than ~org-attach-method~ for dropped files can +be specified using ~org-dnd-default-attach-method~. + +Images dropped also respect the value of ~org-yank-image-save-type~. + ** New functions and changes in function arguments *** =TYPES= argument in ~org-element-lineage~ can now be a symbol diff --git a/lisp/org.el b/lisp/org.el index d0b2355ea..d69f9ec70 100644 --- a/lisp/org.el +++ b/lisp/org.el @@ -4999,7 +4999,10 @@ The following commands are available: (org--set-faces-extend '(org-block-begin-line org-block-end-line) org-fontify-whole-block-delimiter-line) (org--set-faces-extend org-level-faces org-fontify-whole-heading-line) - (setq-local org-mode-loading nil)) + (setq-local org-mode-loading nil) + + ;; `yank-media' handler and DND support. + (org-setup-yank-dnd-handlers)) ;; Update `customize-package-emacs-version-alist' (add-to-list 'customize-package-emacs-version-alist @@ -20254,6 +20257,170 @@ it has a `diary' type." (org-format-timestamp timestamp fmt t)) (org-format-timestamp timestamp fmt (eq boundary 'end))))))) +;;; Yank media handler and DND +(defun org-setup-yank-dnd-handlers () + "Setup the `yank-media' and DND handlers for buffer." + (setq-local dnd-protocol-alist + (cons '("^file:///" . org--dnd-local-file-handler) + dnd-protocol-alist)) + (when (fboundp 'yank-media-handler) + (yank-media-handler "image/.*" #'org--image-yank-media-handler) + ;; Looks like different DEs go for different handler names, + ;; https://larsee.com/blog/2019/05/clipboard-files/. + (yank-media-handler "x/special-\\(?:gnome\|KDE\|mate\\)-files" + #'org--copied-files-yank-media-handler))) + +(defcustom org-yank-image-save-type 'attach + "Method to save images yanked from clipboard and dropped to Emacs. +It can be the symbol `attach' to add it as an attachment, or a +directory name to copy/cut the image to that directory." + :group 'org + :package-version '(Org . "9.7") + :type '(choice (const :tag "Add it as attachment" attach) + (directory :tag "Save it in directory")) + :safe (lambda (x) (or (stringp x) (eq x 'attach)))) + +(defcustom org-yank-image-file-name-function #'org-yank-image-autogen-filename + "Function to generate filename for image yanked from clipboard. +By default, this autogenerates a filename based on the current +time. +It is called with no arguments and should return a string without +any extension which is used as the filename." + :group 'org + :package-version '(Org . "9.7") + :type '(radio (function-item :doc "Autogenerate filename" + org-yank-image-autogen-filename) + (function-item :doc "Ask for filename" + org-yank-image-read-filename) + function)) + +(defun org-yank-image-autogen-filename () + "Autogenerate filename for image in clipboard." + (format-time-string "clipboard-%Y-%m-%d-%H:%M")) + +(defun org-yank-image-read-filename () + "Read filename for image in clipboard." + (read-string "Filename for image without extension: ")) + +(declare-function org-attach-attach "org-attach" (file &optional visit-dir method)) + +(defun org--image-yank-media-handler (mimetype data) + "Save image DATA of mime-type MIMETYPE and insert link at point. +It is saved as per `org-yank-image-save-type'. The name for the +image is prompted and the extension is automatically added to the +end." + (let* ((ext (symbol-name (mailcap-mime-type-to-extension mimetype))) + (iname (funcall org-yank-image-file-name-function)) + (filename (file-name-with-extension iname ext)) + (absname (expand-file-name + filename + (if (eq org-yank-image-save-type 'attach) + temporary-file-directory + org-yank-image-save-type))) + link) + (when (and (not (eq org-yank-image-save-type 'attach)) + (not (file-directory-p org-yank-image-save-type))) + (make-directory org-yank-image-save-type t)) + (with-temp-file absname + (insert data)) + (if (null (eq org-yank-image-save-type 'attach)) + (setq link (org-link-make-string + (concat "file:" (file-relative-name absname)) + filename)) + (require 'org-attach) + (org-attach-attach absname nil 'mv) + (setq link (org-link-make-string + (concat "attachment:" filename) + filename))) + (insert link))) + +;; I cannot find a spec for this but +;; https://indigo.re/posts/2021-12-21-clipboard-data.html and pcmanfm +;; suggests that this is the format. +(defun org--copied-files-yank-media-handler (_mimetype data) + "Attach copied or cut files from file manager. +If the files were cut from the file manager, then the `mv' attach +method is used; `cp' otherwise. + +DATA is a string where the first line is the operation to +perform: copy or cut. Rest of the lines are file: links to the +concerned files." + (require 'org-attach) + ;; pcmanfm adds a null byte at the end for some reason. + (let* ((data (split-string data "[\0\n\r]" t "^file://")) + (files (cdr data)) + (method (if (equal (car data) "cut") + 'mv + 'cp))) + (dolist (f files) + (setq f (url-unhex-string f)) + (if (file-readable-p f) + (org-attach-attach f nil method) + (message "File `%s' is not readable, skipping" f))))) + +(defcustom org-dnd-default-attach-method nil + "Default attach method to use when DND action is unspecified. +This attach method is used when the DND action is `private'. +This is also used when `org-yank-image-save-type' is nil. +When nil, use `org-attach-method'." + :group 'org + :package-version '(Org . "9.7") + :type '(choice (const :tag "Default attach method" nil) + (const :tag "Copy" cp) + (const :tag "Move" mv) + (const :tag "Hard link" ln) + (const :tag "Symbol link" lns))) + +(declare-function mailcap-file-name-to-mime-type "mailcap" (file-name)) +(defvar org-attach-method) + +(defun org--dnd-local-file-handler (url action) + "Attach filename given by URL using method pertaining to ACTION. +If ACTION is `move', use `mv' attach method. +If `copy', use `cp' attach method. +If `ask', ask the user. +If `private', use the method denoted in `vz/org-dnd-default-attach-action'. +The action `private' is always returned." + (require 'mailcap) + (let* ((filename (dnd-get-local-file-name url)) + (mimetype (mailcap-file-name-to-mime-type filename)) + (separatep (and (string-prefix-p "image/" mimetype) + (not (eq 'attach org-yank-image-save-type)))) + (method (pcase action + ('copy 'cp) + ('move 'mv) + ('ask (caddr (read-multiple-choice + "Attach using method" + '((?c "cp" cp) + (?m "mv" mv) + (?l "ln hard link" ln) + (?s "symbolic link" lns))))) + ('private (or org-dnd-default-attach-method + org-attach-method))))) + (if separatep + (funcall + (pcase method + ('cp #'copy-file) + ('mv #'rename-file) + ('ln #'add-name-to-file) + ('lns #'make-symbolic-link)) + filename + (expand-file-name (file-name-nondirectory filename) + org-yank-image-save-type)) + (org-attach-attach filename nil method)) + (insert + (org-link-make-string + (concat (if separatep + "file:" + "attachment:") + (if separatep + (expand-file-name (file-name-nondirectory filename) + org-yank-image-save-type) + (file-name-nondirectory filename))) + (file-name-nondirectory filename)) + "\n") + 'private)) + ;;; Other stuff (defvar reftex-docstruct-symbol) -- 2.40.1 --=-=-=--