mirror of
https://github.com/doomemacs/doomemacs
synced 2025-09-16 15:56:52 -05:00
99b7b7f740
Adds inline image preview support for http/https links, as well as base64 encode image support with the img protocol. e.g. Examples: [[http://domain.com/some/image.png]] [[https://raw.githubusercontent.com/hlissner/doom-emacs/screenshots/company.png]] [[img:iVBORw0KGgoAAAANSUhEUgAAACUAAAAuCAAAAACKMo8cAA...]]
119 lines
4.5 KiB
EmacsLisp
119 lines
4.5 KiB
EmacsLisp
;;; lang/org/+attach.el -*- lexical-binding: t; -*-
|
|
|
|
(add-hook 'org-load-hook #'+org|init-attach)
|
|
|
|
;; I believe Org's native attachment system is over-complicated and litters
|
|
;; files with metadata I don't want. So I wrote my own, which:
|
|
;;
|
|
;; + Places attachments in a centralized location (`+org-attach-dir' in
|
|
;; `org-directory'), using an attach:* link abbreviation.
|
|
;; + Use `+org-attach/sync' to index all attachments in `org-directory' that use
|
|
;; the attach:* abbreviation and delete orphaned ones that are no longer
|
|
;; referenced.
|
|
;; + Adds drag-and-drop support for images (with inline image preview)
|
|
;; + Adds drag-and-drop support for media files (pdfs, zips, etc) with a
|
|
;; filetype icon and short link.
|
|
|
|
;; Some commands of interest:
|
|
;; + `org-download-screenshot'
|
|
;; + `+org-attach/file'
|
|
;; + `+org-attach/url'
|
|
;; + `+org-attach/sync'
|
|
|
|
(defvar +org-attach-dir ".attach/"
|
|
"Where to store attachments relative to `org-directory'.")
|
|
|
|
|
|
;;
|
|
;; Packages
|
|
|
|
(def-package! org-download
|
|
:commands (org-download-dnd org-download-dnd-base64)
|
|
:init
|
|
;; Add these manually so that org-download is lazy-loaded...
|
|
(add-to-list 'dnd-protocol-alist '("^\\(https?\\|ftp\\|file\\|nfs\\):" . +org-attach-download-dnd))
|
|
(add-to-list 'dnd-protocol-alist '("^data:" . org-download-dnd-base64))
|
|
|
|
(advice-add #'org-download-enable :override #'ignore)
|
|
:config
|
|
|
|
(setq org-download-screenshot-method
|
|
(cond (IS-MAC "screencapture -i %s")
|
|
(IS-LINUX
|
|
(cond ((executable-find "maim") "maim -s %s")
|
|
((executable-find "scrot") "scrot -s %s")))))
|
|
|
|
;; Handle non-image files a little differently. Images should be inserted
|
|
;; as-is, as image previews. Other files, like pdfs or zips, should be linked
|
|
;; to, with an icon indicating the type of file.
|
|
(advice-add #'org-download-insert-link :override #'+org-attach*insert-link)
|
|
|
|
(defun +org-attach*download-subdir ()
|
|
(when (file-in-directory-p buffer-file-name org-directory)
|
|
(file-relative-name buffer-file-name org-directory)))
|
|
|
|
(defun +org-attach*download-fullname (path)
|
|
"Write PATH relative to current file."
|
|
(let ((dir (or (if buffer-file-name (file-name-directory buffer-file-name))
|
|
default-directory)))
|
|
(if (file-in-directory-p dir org-directory)
|
|
(file-relative-name path dir)
|
|
path)))
|
|
(advice-add #'org-download--dir-2 :override #'ignore)
|
|
(advice-add #'org-download--fullname
|
|
:filter-return #'+org-attach*download-fullname))
|
|
|
|
(def-package! org-yt
|
|
:after org
|
|
:config
|
|
(defun +org-inline-data-image (_protocol link _description)
|
|
"Interpret LINK as base64-encoded image data."
|
|
(base64-decode-string link))
|
|
|
|
(defun +org-image-link (protocol link _description)
|
|
"Interpret LINK as base64-encoded image data."
|
|
(when (image-type-from-file-name link)
|
|
(let ((buf (url-retrieve-synchronously (concat protocol ":" link))))
|
|
;; TODO Better error handling
|
|
(cl-assert buf nil "Download of image \"%s\" failed." link)
|
|
(with-current-buffer buf
|
|
(goto-char (point-min))
|
|
(re-search-forward "\r?\n\r?\n")
|
|
(buffer-substring-no-properties (point) (point-max))))))
|
|
|
|
(org-link-set-parameters "http" :image-data-fun #'+org-image-link)
|
|
(org-link-set-parameters "https" :image-data-fun #'+org-image-link)
|
|
(org-link-set-parameters "img" :image-data-fun #'+org-inline-data-image))
|
|
|
|
|
|
;;
|
|
;; Bootstrap
|
|
|
|
(defun +org|init-attach ()
|
|
(setq org-attach-directory (expand-file-name +org-attach-dir org-directory))
|
|
(setq-default org-download-image-dir org-attach-directory
|
|
org-download-heading-lvl nil
|
|
org-download-timestamp "_%Y%m%d_%H%M%S")
|
|
|
|
;; A shorter link to attachments
|
|
(add-to-list 'org-link-abbrev-alist (cons "attach" (abbreviate-file-name org-attach-directory)))
|
|
|
|
(org-link-set-parameters
|
|
"attach"
|
|
:follow (lambda (link) (find-file (expand-file-name link org-attach-directory)))
|
|
:complete (lambda (&optional _arg)
|
|
(+org--relpath (+org-link-read-file "attach" org-attach-directory)
|
|
org-attach-directory))
|
|
:face (lambda (link)
|
|
(if (file-exists-p (expand-file-name link org-attach-directory))
|
|
'org-link
|
|
'error)))
|
|
|
|
(after! projectile
|
|
(add-to-list 'projectile-globally-ignored-directories
|
|
(car (last (split-string +org-attach-dir "/" t)))))
|
|
|
|
(after! recentf
|
|
(add-to-list 'recentf-exclude (format "%s.+$" (regexp-quote org-attach-directory)))))
|
|
|