From: Ihor Radchenko <yantar92@posteo.net>
To: Karthik Chikmagalur <karthikchikmagalur@gmail.com>
Cc: emacs-orgmode@gnu.org
Subject: Re: [BUG] Attachments not resolved correctly from symlinked Org files
Date: Tue, 04 Jun 2024 09:33:43 +0000 [thread overview]
Message-ID: <87mso1oxvs.fsf@localhost> (raw)
In-Reply-To: <87seyydnf7.fsf@localhost>
[-- Attachment #1: Type: text/plain, Size: 667 bytes --]
Ihor Radchenko <yantar92@posteo.net> writes:
> What about the approach we already use in
> `org-attach-id-to-path-function-list' - check if an attachment directory
> already exists, generated using any rule, and only if not, create a new?
>
> Similarly, in `org-attach-dir', we can first check local attachment
> directory and return it if it exists. Then, we check attachment
> directory for the symlink source, and return it when it exists.
> If none exists, create attachment locally or relative to the symlink
> source, according to some customization. The default will be creating
> locally, to follow the existing behavior.
See the attached tentative patch.
[-- Warning: decoded text below may be mangled, UTF-8 assumed --]
[-- Attachment #2: 0001-org-attach-dir-from-id-Search-existing-attachments-f.patch --]
[-- Type: text/x-patch, Size: 4855 bytes --]
From add9e512fa80e53bfa396ebc4d0bdf35b3bee089 Mon Sep 17 00:00:00 2001
Message-ID: <add9e512fa80e53bfa396ebc4d0bdf35b3bee089.1717493559.git.yantar92@posteo.net>
From: Ihor Radchenko <yantar92@posteo.net>
Date: Tue, 4 Jun 2024 11:30:44 +0200
Subject: [PATCH] org-attach-dir-from-id: Search existing attachments for
symlinks
* lisp/org-attach.el (org-attach-dir-from-id): When current buffer
displays a symlinked file, search for existing attachments in the
original file dir.
* etc/ORG-NEWS (=org-attach= now considers symlinked files when
searching pre-existing attach dirs): Announce the change.
Reported-by: Karthik Chikmagalur <karthikchikmagalur@gmail.com>
Link: https://orgmode.org/list/87seyydnf7.fsf@localhost
---
etc/ORG-NEWS | 8 ++++++++
lisp/org-attach.el | 39 +++++++++++++++++++++++++++++----------
2 files changed, 37 insertions(+), 10 deletions(-)
diff --git a/etc/ORG-NEWS b/etc/ORG-NEWS
index 4b0b77ca8..4ac88f139 100644
--- a/etc/ORG-NEWS
+++ b/etc/ORG-NEWS
@@ -41,6 +41,14 @@ all the references are resolved in the generated png.
# This also includes changes in function behavior from Elisp perspective.
** Miscellaneous
+*** =org-attach= now considers symlinked files when searching pre-existing attach dirs
+
+When Org buffer is opened from a symlink, Org mode looks into the
+original file directory when searching if an attach directory already exists.
+This way, attachments will remain accessible when opening symlinked Org file.
+
+When no attach dir exists, Org mode will still prefer creating it in
+the "default" directory - where the symlink is located.
* Version 9.7
diff --git a/lisp/org-attach.el b/lisp/org-attach.el
index 16f6e1e29..d4bff03ad 100644
--- a/lisp/org-attach.el
+++ b/lisp/org-attach.el
@@ -433,22 +433,42 @@ (defun org-attach-dir-get-create ()
(make-directory attach-dir t))
attach-dir))
-(defun org-attach-dir-from-id (id &optional existing)
+(defun org-attach-dir-from-id (id &optional existing)
"Return a folder path based on `org-attach-id-dir' and ID.
Try id-to-path functions in `org-attach-id-to-path-function-list'
ignoring nils. If EXISTING is non-nil, then return the first path
-found in the filesystem. Otherwise return the first non-nil value."
+found in the filesystem. Otherwise return the first non-nil value.
+
+The existing paths are searched in
+1. `org-attach-id-dir';
+2. in \"data/\" dir - the default value of `org-attach-id-dir';
+3. if current buffer is a symlink, (1) and (2) searches are repeated
+ in the `default-directory' of symlink target."
(let ((fun-list org-attach-id-to-path-function-list)
(base-dir (expand-file-name org-attach-id-dir))
- (default-base-dir (expand-file-name "data/"))
+ (fallback-dirs (list (expand-file-name "data/")))
preferred first)
+ (when (and (buffer-file-name)
+ (file-symlink-p (buffer-file-name)))
+ (let ((default-directory
+ (file-name-directory
+ (file-truename (buffer-file-name)))))
+ (cl-pushnew (expand-file-name org-attach-id-dir) fallback-dirs)
+ (cl-pushnew (expand-file-name "data/") fallback-dirs)))
+ (setq fallback-dirs (delete base-dir fallback-dirs))
+ (setq fallback-dirs (seq-filter #'file-directory-p fallback-dirs))
(while (and fun-list
(not preferred))
(let* ((name (funcall (car fun-list) id))
(candidate (and name (expand-file-name name base-dir)))
- ;; Try the default value `org-attach-id-dir' as a fallback.
- (candidate2 (and name (not (equal base-dir default-base-dir))
- (expand-file-name name default-base-dir))))
+ ;; Try the default value `org-attach-id-dir', and linked
+ ;; dirs if buffer is a symlink as a fallback.
+ (fallback-candidates
+ (and name (mapcar
+ (lambda (dir) (expand-file-name name dir))
+ fallback-dirs)))
+ (fallback-candidates
+ (seq-filter #'file-directory-p fallback-candidates)))
(setq fun-list (cdr fun-list))
(when candidate
(if (or (not existing) (file-directory-p candidate))
@@ -456,10 +476,9 @@ (defun org-attach-dir-from-id (id &optional existing)
(unless first
(setq first candidate)))
(when (and existing
- candidate2
- (not (file-directory-p candidate))
- (file-directory-p candidate2))
- (setq preferred candidate2)))))
+ fallback-candidates
+ (not (file-directory-p candidate)))
+ (setq preferred (car fallback-candidates))))))
(or preferred first)))
(defun org-attach-check-absolute-path (dir)
--
2.45.1
[-- Attachment #3: Type: text/plain, Size: 225 bytes --]
--
Ihor Radchenko // yantar92,
Org mode contributor,
Learn more about Org mode at <https://orgmode.org/>.
Support Org development at <https://liberapay.com/org-mode>,
or support my work at <https://liberapay.com/yantar92>
next prev parent reply other threads:[~2024-06-04 9:33 UTC|newest]
Thread overview: 6+ messages / expand[flat|nested] mbox.gz Atom feed top
2024-04-28 20:22 [BUG] Attachments not resolved correctly from symlinked Org files Karthik Chikmagalur
2024-04-30 9:09 ` Ihor Radchenko
2024-05-01 15:18 ` Karthik Chikmagalur
2024-05-04 7:52 ` Ihor Radchenko
2024-06-04 9:33 ` Ihor Radchenko [this message]
2024-06-14 11:44 ` Ihor Radchenko
Reply instructions:
You may reply publicly to this message via plain-text email
using any one of the following methods:
* Save the following mbox file, import it into your mail client,
and reply-to-all from there: mbox
Avoid top-posting and favor interleaved quoting:
https://en.wikipedia.org/wiki/Posting_style#Interleaved_style
List information: https://www.orgmode.org/
* Reply using the --to, --cc, and --in-reply-to
switches of git-send-email(1):
git send-email \
--in-reply-to=87mso1oxvs.fsf@localhost \
--to=yantar92@posteo.net \
--cc=emacs-orgmode@gnu.org \
--cc=karthikchikmagalur@gmail.com \
/path/to/YOUR_REPLY
https://kernel.org/pub/software/scm/git/docs/git-send-email.html
* If your mail client supports setting the In-Reply-To header
via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line
before the message body.
Code repositories for project(s) associated with this public inbox
https://git.savannah.gnu.org/cgit/emacs/org-mode.git
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox;
as well as URLs for read-only IMAP folder(s) and NNTP newsgroup(s).