From mboxrd@z Thu Jan 1 00:00:00 1970 Return-Path: Received: from mp12.migadu.com ([2001:41d0:403:4789::]) (using TLSv1.3 with cipher TLS_AES_256_GCM_SHA384 (256/256 bits)) by ms9.migadu.com with LMTPS id OGWxAWZlIWXP/wAAauVa8A:P1 (envelope-from ) for ; Sat, 07 Oct 2023 16:04:22 +0200 Received: from aspmx1.migadu.com ([2001:41d0:403:4789::]) (using TLSv1.3 with cipher TLS_AES_256_GCM_SHA384 (256/256 bits)) by mp12.migadu.com with LMTPS id OGWxAWZlIWXP/wAAauVa8A (envelope-from ) for ; Sat, 07 Oct 2023 16:04:22 +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 716EB4E379 for ; Sat, 7 Oct 2023 16:04:21 +0200 (CEST) Authentication-Results: aspmx1.migadu.com; dkim=pass header.d=gmail.com header.s=20230601 header.b=GFDe0zSj; dmarc=pass (policy=none) header.from=gmail.com; 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" ARC-Message-Signature: i=1; a=rsa-sha256; c=relaxed/relaxed; d=yhetil.org; s=key1; t=1696687461; 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=8M/U8XR90np8Xcb6hSLe9xmx5XOtT8hvjFB8HwfjLpo=; b=t2ZSS7RuPPBPlSSYGFtWcyMw/5c4kUiOfa6GNOs1K4O8TZ+6NyVeC7GkKBCbuJd+i41G1Q oZ83ENkEWp/qkqk+bsYBcLo1g4nELrRi7HPAVMbBpKOte8eoSdk2Z9mKg2K3Pjz3U3OQp7 z5/XAJDEhHZLVGmzd3iN2AH4UsxXMIhys/lE9HVLsgPWWn3u/HmpUCHwbkNlybhXKWYr7L vq6ZUe/R7OJEPpmyiP65aPj+yAf7ooEXxWNv0t5MfJ2f0BhuKZPxwrD46ivh0Lt9sZIHBC vjZlKPmY8K7cAW68rimK9c0oSLyKwouDUz2P7QDFvFT/eBzzMZbt0sLVmsOyiQ== ARC-Authentication-Results: i=1; aspmx1.migadu.com; dkim=pass header.d=gmail.com header.s=20230601 header.b=GFDe0zSj; dmarc=pass (policy=none) header.from=gmail.com; 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" ARC-Seal: i=1; s=key1; d=yhetil.org; t=1696687461; a=rsa-sha256; cv=none; b=olihP3ineMW0pjcwsuSYDuSXq+EsG/kQ8l5XvzHrGQ1A/0s61vqrcJfRj+bCPVY037+AT0 bT+UVu+aVzfkZ9Uz0jb2Dv5KVIiAMkMwX3DqieZJNniVPdhn9ubg4H5EUO8E6so8rBwcHf ZHfyqaJcaSAUQtwaYc549X8fH1ot/v38jwaqM94kEeSFNWbX8dKu+2XAFXgpS3rwy0PjEa QgyRxbF21wQuiB6p3cksPjRnTJShAdoDldQGUVYFDiOp+7QAp+OHvNN8niT52E5JTzb80V 1D8Tv6cbXYidT0LPaQm3F8r2YC6OL8DveQCv4vUi2ReiqPJyq1eyV1QNKyJHgw== Received: from localhost ([::1] helo=lists1p.gnu.org) by lists.gnu.org with esmtp (Exim 4.90_1) (envelope-from ) id 1qp7u3-00021R-2q; Sat, 07 Oct 2023 10:03:35 -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 1qp7u1-000210-Q3 for emacs-orgmode@gnu.org; Sat, 07 Oct 2023 10:03:33 -0400 Received: from mail-pl1-x641.google.com ([2607:f8b0:4864:20::641]) by eggs.gnu.org with esmtps (TLS1.2:ECDHE_RSA_AES_128_GCM_SHA256:128) (Exim 4.90_1) (envelope-from ) id 1qp7tz-00064E-CD for emacs-orgmode@gnu.org; Sat, 07 Oct 2023 10:03:33 -0400 Received: by mail-pl1-x641.google.com with SMTP id d9443c01a7336-1c5bf7871dcso24432295ad.1 for ; Sat, 07 Oct 2023 07:03:31 -0700 (PDT) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=gmail.com; s=20230601; t=1696687410; x=1697292210; 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=8M/U8XR90np8Xcb6hSLe9xmx5XOtT8hvjFB8HwfjLpo=; b=GFDe0zSjkbZExxTukdRw0uk93peH8/rE3KEUH+rlCogl6Jdn65a4vlDcZoSSQ1DToJ YpCLtcTIKoLK+7f9q7WW+u6cZR5I/1Mp6bSUHcUknSiqhsR2wQ4DJ3BJBUWSClrBNJ29 bD08nIb/ZuOW/ZcGm7UcaLq5BV7Po62IJ7BBuggJ2ii2JFx5GkIW+/FRqjplUXCdvMtg 34THhHyoOnhzZWuVfev6Bc4BnnQVCEMQgiqkFGboq5Ywq1F12gnsrcCgVgvtH+QRryYO wBrZ99t6bz4JC6LiSobhHWlWBZXe/4WDKRX2UNRhNUr9re2kpCkx8yRqcJg7lrM9vOIX f6EQ== X-Google-DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=1e100.net; s=20230601; t=1696687410; x=1697292210; 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=8M/U8XR90np8Xcb6hSLe9xmx5XOtT8hvjFB8HwfjLpo=; b=ILr0vgjYAL2bvqK57V7d7EXV+aaulypJJlzVArDEUXrzmZZ7v0gO6hOwhJCbbkuWuE RgpiFaApFl3RNN5/u3fMGcIDRUhfQBsXzwneMkDdfUn1g2IQ22f8JiutEoyI5S9v21BX zEoID/M6BWwiFm/6eeJ+ZXniG60C2r23ijGM5jN7LcI9yN8pBUBkeOqgNRU2Cdayc9hF z8HfdZKb5JnnnAYTMDR27cDX0Rqc301cqh2I3auMFqBJLCzXm4QgkGOhjs3Idc//o4YO /hKXLujhB+LR8DciuRtHJj1zjpQDM5kQqL7AfYqoTUm6k662KgVeGwFDYlHe0eIm30a6 8kdw== X-Gm-Message-State: AOJu0YyfgTl/ck8+rOb3VyM2dOyisrPP7/a5VH0Rg6Z8J5D6FVjmR+bT 2jaumzUepenOaJetE1Crk1w= X-Google-Smtp-Source: AGHT+IFGF3opxJ/qCoA/qqs+ly5FN6P812aSQNX/v8J2gowu1KOOSalnzL/ZMs0aSo6LsfgnRLkT6Q== X-Received: by 2002:a17:903:110f:b0:1c6:25c2:e784 with SMTP id n15-20020a170903110f00b001c625c2e784mr12338882plh.35.1696687409811; Sat, 07 Oct 2023 07:03:29 -0700 (PDT) Received: from localhost ([118.185.152.162]) by smtp.gmail.com with ESMTPSA id g8-20020a1709029f8800b001c5fc291ef9sm5869769plq.209.2023.10.07.07.03.28 (version=TLS1_3 cipher=TLS_AES_256_GCM_SHA384 bits=256/256); Sat, 07 Oct 2023 07:03:29 -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: <87a5sur51r.fsf@gmail.com> (Visuwesh's message of "Sat, 07 Oct 2023 17:57:28 +0530") References: <87jzsintv0.fsf@gmail.com> <87lecx2nff.fsf@localhost> <87bkdsomm2.fsf@gmail.com> <87a5tamm3j.fsf@gmail.com> <877cnyzlda.fsf@localhost> <87a5sur51r.fsf@gmail.com> Date: Sat, 07 Oct 2023 19:33:25 +0530 Message-ID: <875y3ir0lu.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::641; envelope-from=visuweshm@gmail.com; helo=mail-pl1-x641.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-Country: US X-Migadu-Flow: FLOW_IN X-Migadu-Queue-Id: 716EB4E379 X-Spam-Score: -6.56 X-Migadu-Spam-Score: -6.56 X-Migadu-Scanner: mx1.migadu.com X-TUID: pQsz4YtYZqqM --=-=-= Content-Type: text/plain; charset=utf-8 Content-Transfer-Encoding: quoted-printable [=E0=AE=9A=E0=AE=A9=E0=AE=BF =E0=AE=85=E0=AE=95=E0=AF=8D=E0=AE=9F=E0=AF=8B= =E0=AE=AA=E0=AE=B0=E0=AF=8D 07, 2023] Visuwesh wrote: > [=E0=AE=9A=E0=AE=A9=E0=AE=BF =E0=AE=85=E0=AE=95=E0=AF=8D=E0=AE=9F=E0=AF= =8B=E0=AE=AA=E0=AE=B0=E0=AF=8D 07, 2023] Ihor Radchenko wrote: > >> Visuwesh writes: >> >>> 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. >> >> Thanks! >> I still disagree about :safe, but I can change it myself to something >> more restrictive like :safe (lambda (x) (eq x 'attach))) > > OK, I will change it on my end then. I can always override the :safe > function on my end. > >> Also, it looks like we also need to define `x-dnd-direct-save-function', >> as Po Lu pointed in https://list.orgmode.org/orgmode/87bkdccihf.fsf@yaho= o.com/=20 > > I will get to it, hopefully by Sunday. This was far easier than I initially thought. Patch attached. --=-=-= Content-Type: text/x-diff Content-Disposition: attachment; filename=0001-Add-support-for-yank-media-and-DND.patch >From 7bdd892c0cdb248341e3284e9aeee341f073d38d 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-yank-image-file-name-function) (org-dnd-default-attach-method, org-dnd-method): New defcustoms. (org--image-yank-media-handler, org--copied-files-yank-media-handler) (org--dnd-attach-file, org--dnd-local-file-handler, org--dnd-xds-method) (org--dnd-xds-function): Add yank-media and DND handlers. * etc/ORG-NEWS: Advertise the new features. --- etc/ORG-NEWS | 20 +++++ lisp/org.el | 234 ++++++++++++++++++++++++++++++++++++++++++++++++++- 2 files changed, 253 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..cfb314e23 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,235 @@ 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)) + (when (boundp 'x-dnd-direct-save-function) + (setq-local x-dnd-direct-save-function #'org--dnd-xds-function))) + +(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) (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 "Basename for image file 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-method 'ask + "Action to perform on the dropped file. +When the value is the symbol, + . `attach' -- attach the dropped file + . `open' -- visit/open the dropped file in Emacs + . `file-link' -- insert file: link to the dropped file + . `ask' -- ask what to do out of the above." + :group 'org + :package-version '(Org . "9.7") + :type '(choice (const :tag "Attach" attach) + (const :tag "Open/Visit file" open) + (const :tag "Insert file: link" file-link) + (const :tag "Ask what to do" ask))) + +(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 "Symbolic 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) + (let ((method (if (eq org-dnd-method 'ask) + (caddr (read-multiple-choice + "What to do with dropped file?" + '((?a "attach" attach) + (?o "open" open) + (?f "insert file: link" file-link)))) + org-dnd-method))) + (pcase method + (`attach (org--dnd-attach-file url action)) + (`open (dnd-open-local-file url action)) + (`file-link + (let ((filename (dnd-get-local-file-name url))) + (insert (org-make-link-string (concat "file:" filename) + (file-name-nondirectory filename)))))))) + +(defun org--dnd-attach-file (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 `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 "copy" cp) + (?m "move" mv) + (?l "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)) + +(defvar-local org--dnd-xds-method nil + "The method to use for dropped file.") +(defun org--dnd-xds-function (need-name filename) + "Handle file with FILENAME dropped via XDS protocol. +When NEED-NAME is t, FILNAME is the base name of the file to be +saved. +When NEED-NAME is nil, the drop is complete." + (message "%S %S" need-name filename) + (if need-name + (let ((method (if (eq org-dnd-method 'ask) + (caddr (read-multiple-choice + "What to do with dropped file?" + '((?a "attach" attach) + (?o "open" open) + (?f "insert file: link" file-link)))) + org-dnd-method))) + (setq-local org--dnd-xds-method method) + (pcase method + (`attach (expand-file-name filename (org-attach-dir 'create))) + (`open (expand-file-name (make-temp-name "emacs.") temporary-file-directory)) + (`file-link (read-file-name "Write file to: " nil nil nil filename)))) + (pcase org--dnd-xds-method + (`attach (let ((base (file-name-nondirectory filename))) + (insert (org-make-link-string + (concat "attachment:" base) + base) + "\n"))) + (`file-link (insert (org-make-link-string (concat "file:" filename) + (file-name-nondirectory filename)) + "\n")) + (`open (find-file filename))) + (setq-local org--dnd-xds-method nil))) + ;;; Other stuff (defvar reftex-docstruct-symbol) -- 2.40.1 --=-=-=--