awesome-emacs/org-roam
1
0
Fork 0
mirror of https://github.com/org-roam/org-roam synced 2025-08-01 12:17:21 -05:00
Code Issues Packages Projects Releases Wiki Activity

fix: write unlinked references regex to a temp file

Browse Source 
Node titles with special characters (single quotes, dollar signs, etc.)
break the ripgrep command because the regex pattern is passed through
the shell. This causes silent failures that show up as unlinked
references not being present for a given node.

This change writes the regex pattern to a temp file and uses ripgrep's
--file option instead of shell command line. `shell-quote-argument` is
replaced with `regexp-quote` since we're no longer passing through
shell. Wrapped in unwind-protect for cleanup.

Fix: #2407
Close: #2408
This commit is contained in:
Taro Sato
2024-01-24 12:40:38 -08:00
committed by Dustin Farris
parent df4e903208
commit 0786f73669
2 changed files with 28 additions and 13 deletions
Download Patch File Download Diff File Expand all files Collapse all files

35
org-roam-mode.el
View File

@ -658,17 +658,26 @@ This is the ROW within FILE."
(end-of-line) (end-of-line)
(point))))) (point)))))
(defun org-roam-unlinked-references--rg-command (titles) (defun org-roam-unlinked-references--rg-command (titles temp-file)
"Return the ripgrep command searching for TITLES." "Return the ripgrep command searching for TITLES using TEMP-FILE for pattern.
This avoids shell escaping issues by writing the pattern to a file instead
of passing it directly through the shell command line."
;; Write pattern to temp file to avoid shell escaping issues with quotes,
;; spaces, and other special characters in titles
(with-temp-file temp-file
(insert "\\[([^[]]++|(?R))*\\]"
(mapconcat (lambda (title)
;; Use regexp-quote instead of shell-quote-argument
;; since we're writing a regex pattern, not a shell argument
(format "|(\\b%s\\b)" (regexp-quote title)))
titles "")))
(concat "rg --follow --only-matching --vimgrep --pcre2 --ignore-case " (concat "rg --follow --only-matching --vimgrep --pcre2 --ignore-case "
(mapconcat (lambda (glob) (concat "--glob " glob)) (mapconcat (lambda (glob) (concat "--glob " glob))
(org-roam--list-files-search-globs org-roam-file-extensions) (org-roam--list-files-search-globs org-roam-file-extensions)
" ") " ")
(format " '\\[([^[]]++|(?R))*\\]%s' " " --file " (shell-quote-argument temp-file) " "
(mapconcat (lambda (title) (shell-quote-argument (expand-file-name org-roam-directory))))
(format "|(\\b%s\\b)" (shell-quote-argument title)))
titles ""))
(shell-quote-argument org-roam-directory)))
(defun org-roam-unlinked-references-section (node) (defun org-roam-unlinked-references-section (node)
"The unlinked references section for NODE. "The unlinked references section for NODE.
@ -679,8 +688,12 @@ References from FILE are excluded."
(shell-command-to-string "rg --pcre2-version")))) (shell-command-to-string "rg --pcre2-version"))))
(let* ((titles (cons (org-roam-node-title node) (let* ((titles (cons (org-roam-node-title node)
(org-roam-node-aliases node))) (org-roam-node-aliases node)))
(rg-command (org-roam-unlinked-references--rg-command titles)) ;; Create temp file for the regex pattern
(results (split-string (shell-command-to-string rg-command) "\n")) (temp-file (make-temp-file "org-roam-rg-pattern-"))
(rg-command (org-roam-unlinked-references--rg-command titles temp-file)))
;; Use unwind-protect to ensure temp file cleanup even if errors occur
(unwind-protect
(let* ((results (split-string (shell-command-to-string rg-command) "\n"))
f row col match) f row col match)
(magit-insert-section (unlinked-references) (magit-insert-section (unlinked-references)
(magit-insert-heading "Unlinked References:") (magit-insert-heading "Unlinked References:")
@ -705,7 +718,9 @@ References from FILE are excluded."
(org-roam-fontify-like-in-org-mode (org-roam-fontify-like-in-org-mode
(org-roam-unlinked-references-preview-line f row)) (org-roam-unlinked-references-preview-line f row))
"\n")))))) "\n"))))))
(insert ?\n))))) (insert ?\n)))
;; Clean up temp file - this runs even if an error occurs above
(delete-file temp-file)))))
(provide 'org-roam-mode) (provide 'org-roam-mode)
;;; org-roam-mode.el ends here ;;; org-roam-mode.el ends here

4
tests/test-org-roam-mode.el
View File

@ -30,9 +30,9 @@
(setq org-roam-directory "/tmp/org roam")) (setq org-roam-directory "/tmp/org roam"))
(it "returns the correct rg command for unlinked references" (it "returns the correct rg command for unlinked references"
(expect (org-roam-unlinked-references--rg-command '("foo" "bar")) (expect (org-roam-unlinked-references--rg-command '("foo" "bar") "/tmp/regex")
:to-equal :to-equal
"rg --follow --only-matching --vimgrep --pcre2 --ignore-case --glob \"*.org\" --glob \"*.org.gpg\" --glob \"*.org.age\" '\\[([^[]]++|(?R))*\\]|(\\bfoo\\b)|(\\bbar\\b)' /tmp/org\\ roam"))) "rg --follow --only-matching --vimgrep --pcre2 --ignore-case --glob \"*.org\" --glob \"*.org.gpg\" --glob \"*.org.age\" --file /tmp/regex /tmp/org\\ roam")))
(provide 'test-org-roam-mode) (provide 'test-org-roam-mode)