org-attach.el 29 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708709710711712713714715716717718719720721722723724725726727728729730731732733734735736737738739740741742743744745746747748749750751752753754755756757758759760761762763764765766767768769
  1. ;;; org-attach.el --- Manage file attachments to Org outlines -*- lexical-binding: t; -*-
  2. ;; Copyright (C) 2008-2019 Free Software Foundation, Inc.
  3. ;; Author: John Wiegley <johnw@newartisans.com>
  4. ;; Keywords: org data attachment
  5. ;; This file is part of GNU Emacs.
  6. ;;
  7. ;; GNU Emacs is free software: you can redistribute it and/or modify
  8. ;; it under the terms of the GNU General Public License as published by
  9. ;; the Free Software Foundation, either version 3 of the License, or
  10. ;; (at your option) any later version.
  11. ;; GNU Emacs is distributed in the hope that it will be useful,
  12. ;; but WITHOUT ANY WARRANTY; without even the implied warranty of
  13. ;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
  14. ;; GNU General Public License for more details.
  15. ;; You should have received a copy of the GNU General Public License
  16. ;; along with GNU Emacs. If not, see <https://www.gnu.org/licenses/>.
  17. ;;; Commentary:
  18. ;; See the Org manual for information on how to use it.
  19. ;;
  20. ;; Attachments are managed either by using a custom property DIR or by
  21. ;; using property ID from org-id. When DIR is defined, a location in
  22. ;; the filesystem is directly attached to the outline node. When
  23. ;; org-id is used, attachments are stored in a folder named after the
  24. ;; ID, in a location defined by `org-attach-id-dir'. DIR has
  25. ;; precedence over ID when both parameters are defined for the current
  26. ;; outline node (also when inherited parameters are taken into
  27. ;; account).
  28. ;;; Code:
  29. (require 'cl-lib)
  30. (require 'org)
  31. (require 'ol)
  32. (require 'org-id)
  33. (declare-function dired-dwim-target-directory "dired-aux")
  34. (defgroup org-attach nil
  35. "Options concerning attachments in Org mode."
  36. :tag "Org Attach"
  37. :group 'org)
  38. (defcustom org-attach-id-dir "data/"
  39. "The directory where attachments are stored.
  40. If this is a relative path, it will be interpreted relative to the directory
  41. where the Org file lives."
  42. :group 'org-attach
  43. :type 'directory
  44. :safe #'stringp)
  45. (defcustom org-attach-dir-relative nil
  46. "Non-nil means directories in DIR property are added as relative links.
  47. Defaults to absolute location."
  48. :group 'org-attach
  49. :type 'boolean
  50. :package-version '(Org . "9.3")
  51. :safe #'booleanp)
  52. (defcustom org-attach-auto-tag "ATTACH"
  53. "Tag that will be triggered automatically when an entry has an attachment."
  54. :group 'org-attach
  55. :type '(choice
  56. (const :tag "None" nil)
  57. (string :tag "Tag")))
  58. (defcustom org-attach-preferred-new-method 'id
  59. "Preferred way to attach to nodes without existing ID and DIR property.
  60. This choice is used when adding attachments to nodes without ID
  61. and DIR properties.
  62. Allowed values are:
  63. id Create and use an ID parameter
  64. dir Create and use a DIR parameter
  65. ask Ask the user for input of which method to choose
  66. nil Prefer to not create a new parameter
  67. nil means that ID or DIR has to be created explicitly
  68. before attaching files."
  69. :group 'org-attach
  70. :package-version '(org . "9.3")
  71. :type '(choice
  72. (const :tag "ID parameter" id)
  73. (const :tag "DIR parameter" dir)
  74. (const :tag "Ask user" ask)
  75. (const :tag "Don't create" nil)))
  76. (defcustom org-attach-method 'cp
  77. "The preferred method to attach a file.
  78. Allowed values are:
  79. mv rename the file to move it into the attachment directory
  80. cp copy the file
  81. ln create a hard link. Note that this is not supported
  82. on all systems, and then the result is not defined.
  83. lns create a symbol link. Note that this is not supported
  84. on all systems, and then the result is not defined."
  85. :group 'org-attach
  86. :type '(choice
  87. (const :tag "Copy" cp)
  88. (const :tag "Move/Rename" mv)
  89. (const :tag "Hard Link" ln)
  90. (const :tag "Symbol Link" lns)))
  91. (defcustom org-attach-expert nil
  92. "Non-nil means do not show the splash buffer with the attach dispatcher."
  93. :group 'org-attach
  94. :type 'boolean)
  95. (defcustom org-attach-use-inheritance 'selective
  96. "Attachment inheritance for the outline.
  97. Enabling inheritance for org-attach implies two things. First,
  98. that attachment links will look through all parent headings until
  99. it finds the linked attachment. Second, that running org-attach
  100. inside a node without attachments will make org-attach operate on
  101. the first parent heading it finds with an attachment.
  102. Selective means to respect the inheritance setting in
  103. `org-use-property-inheritance'."
  104. :group 'org-attach
  105. :type '(choice
  106. (const :tag "Don't use inheritance" nil)
  107. (const :tag "Inherit parent node attachments" t)
  108. (const :tag "Respect org-use-property-inheritance" selective))
  109. :type 'boolean)
  110. (defcustom org-attach-store-link-p nil
  111. "Non-nil means store a link to a file when attaching it."
  112. :group 'org-attach
  113. :version "24.1"
  114. :type '(choice
  115. (const :tag "Don't store link" nil)
  116. (const :tag "Link to origin location" t)
  117. (const :tag "Link to the attach-dir location" attached)))
  118. (defcustom org-attach-archive-delete nil
  119. "Non-nil means attachments are deleted upon archiving a subtree.
  120. When set to `query', ask the user instead."
  121. :group 'org-attach
  122. :version "26.1"
  123. :package-version '(Org . "8.3")
  124. :type '(choice
  125. (const :tag "Never delete attachments" nil)
  126. (const :tag "Always delete attachments" t)
  127. (const :tag "Query the user" query)))
  128. (defun org-attach-id-uuid-folder-format (id)
  129. "Translate an UUID ID into a folder-path.
  130. Default format for how Org translates ID properties to a path for
  131. attachments. Useful if ID is generated with UUID."
  132. (format "%s/%s"
  133. (substring id 0 2)
  134. (substring id 2)))
  135. (defun org-attach-id-ts-folder-format (id)
  136. "Translate an ID based on a timestamp to a folder-path.
  137. Useful way of translation if ID is generated based on ISO8601
  138. timestamp. Splits the attachment folder hierarchy into
  139. year-month, the rest."
  140. (format "%s/%s"
  141. (substring id 0 6)
  142. (substring id 6)))
  143. (defcustom org-attach-id-to-path-function-list '(org-attach-id-uuid-folder-format
  144. org-attach-id-ts-folder-format)
  145. "List of functions parsing an ID string into a folder-path.
  146. The first function in this list defines the preferred function
  147. which will be used when creating new attachment folders. All
  148. functions of this list will be tried when looking for existing
  149. attachment folders based on ID."
  150. :group 'org-attach
  151. :package-version '(Org . "9.3")
  152. :type '(repeat (function :tag "Function with ID as input")))
  153. (defvar org-attach-after-change-hook nil
  154. "Hook to be called when files have been added or removed to the attachment folder.")
  155. (defvar org-attach-open-hook nil
  156. "Hook that is invoked by `org-attach-open'.
  157. Created mostly to be compatible with org-attach-git after removing
  158. git-funtionality from this file.")
  159. (defcustom org-attach-commands
  160. '(((?a ?\C-a) org-attach-attach
  161. "Select a file and attach it to the task, using `org-attach-method'.")
  162. ((?c ?\C-c) org-attach-attach-cp
  163. "Attach a file using copy method.")
  164. ((?m ?\C-m) org-attach-attach-mv
  165. "Attach a file using move method.")
  166. ((?l ?\C-l) org-attach-attach-ln
  167. "Attach a file using link method.")
  168. ((?y ?\C-y) org-attach-attach-lns
  169. "Attach a file using symbolic-link method.")
  170. ((?u ?\C-u) org-attach-url
  171. "Attach a file from URL (downloading it).")
  172. ((?b) org-attach-buffer
  173. "Select a buffer and attach its contents to the task.")
  174. ((?n ?\C-n) org-attach-new
  175. "Create a new attachment, as an Emacs buffer.")
  176. ((?z ?\C-z) org-attach-sync
  177. "Synchronize the current node with its attachment\n directory, in case \
  178. you added attachments yourself.\n")
  179. ((?o ?\C-o) org-attach-open
  180. "Open current node's attachments.")
  181. ((?O) org-attach-open-in-emacs
  182. "Like \"o\", but force opening in Emacs.")
  183. ((?f ?\C-f) org-attach-reveal
  184. "Open current node's attachment directory. Create if missing.")
  185. ((?F) org-attach-reveal-in-emacs
  186. "Like \"f\", but force using Dired in Emacs.\n")
  187. ((?d ?\C-d) org-attach-delete-one
  188. "Delete one attachment, you will be prompted for a file name.")
  189. ((?D) org-attach-delete-all
  190. "Delete all of a node's attachments. A safer way is\n to open the \
  191. directory in dired and delete from there.\n")
  192. ((?s ?\C-s) org-attach-set-directory
  193. "Set a specific attachment directory for this entry. Sets DIR property.")
  194. ((?S ?\C-S) org-attach-unset-directory
  195. "Unset the attachment directory for this entry. Removes DIR property.")
  196. ((?q) (lambda () (interactive) (message "Abort")) "Abort."))
  197. "The list of commands for the attachment dispatcher.
  198. Each entry in this list is a list of three elements:
  199. - A list of keys (characters) to select the command (the fist
  200. character in the list is shown in the attachment dispatcher's
  201. splash buffer and minubuffer prompt).
  202. - A command that is called interactively when one of these keys
  203. is pressed.
  204. - A docstring for this command in the attachment dispatcher's
  205. splash buffer."
  206. :group 'org-attach
  207. :package-version '(Org . "9.3")
  208. :type '(repeat (list (repeat :tag "Keys" character)
  209. (function :tag "Command")
  210. (string :tag "Docstring"))))
  211. ;;;###autoload
  212. (defun org-attach ()
  213. "The dispatcher for attachment commands.
  214. Shows a list of commands and prompts for another key to execute a command."
  215. (interactive)
  216. (let ((dir (org-attach-dir nil 'no-fs-check))
  217. c marker)
  218. (when (eq major-mode 'org-agenda-mode)
  219. (setq marker (or (get-text-property (point) 'org-hd-marker)
  220. (get-text-property (point) 'org-marker)))
  221. (unless marker
  222. (error "No item in current line")))
  223. (save-excursion
  224. (when marker
  225. (set-buffer (marker-buffer marker))
  226. (goto-char marker))
  227. (org-back-to-heading t)
  228. (save-excursion
  229. (save-window-excursion
  230. (unless org-attach-expert
  231. (with-output-to-temp-buffer "*Org Attach*"
  232. (princ
  233. (concat "Attachment folder:\n"
  234. (or dir
  235. "Can't find an existing attachment-folder")
  236. (unless (and dir (file-directory-p dir))
  237. "\n(Not yet created)")
  238. "\n\n"
  239. (format "Select an Attachment Command:\n\n%s"
  240. (mapconcat
  241. (lambda (entry)
  242. (pcase entry
  243. (`((,key . ,_) ,_ ,docstring)
  244. (format "%c %s"
  245. key
  246. (replace-regexp-in-string "\n\\([\t ]*\\)"
  247. " "
  248. docstring
  249. nil nil 1)))
  250. (_
  251. (user-error
  252. "Invalid `org-attach-commands' item: %S"
  253. entry))))
  254. org-attach-commands
  255. "\n"))))))
  256. (org-fit-window-to-buffer (get-buffer-window "*Org Attach*"))
  257. (message "Select command: [%s]"
  258. (concat (mapcar #'caar org-attach-commands)))
  259. (setq c (read-char-exclusive))
  260. (and (get-buffer "*Org Attach*") (kill-buffer "*Org Attach*"))))
  261. (let ((command (cl-some (lambda (entry)
  262. (and (memq c (nth 0 entry)) (nth 1 entry)))
  263. org-attach-commands)))
  264. (if (commandp command t)
  265. (call-interactively command)
  266. (error "No such attachment command: %c" c))))))
  267. (defun org-attach-dir (&optional create-if-not-exists-p no-fs-check)
  268. "Return the directory associated with the current outline node.
  269. First check for DIR property, then ID property.
  270. `org-attach-use-inheritance' determines whether inherited
  271. properties also will be considered.
  272. If an ID property is found the default mechanism using that ID
  273. will be invoked to access the directory for the current entry.
  274. Note that this method returns the directory as declared by ID or
  275. DIR even if the directory doesn't exist in the filesystem.
  276. If CREATE-IF-NOT-EXIST-P is non-nil, `org-attach-dir-get-create'
  277. is run. If NO-FS-CHECK is non-nil, the function returns the path
  278. to the attachment even if it has not yet been initialized in the
  279. filesystem.
  280. If no attachment directory can be derived, return nil."
  281. (let (attach-dir id)
  282. (cond
  283. (create-if-not-exists-p
  284. (setq attach-dir (org-attach-dir-get-create)))
  285. ((setq attach-dir (org-entry-get nil "DIR" org-attach-use-inheritance))
  286. (org-attach-check-absolute-path attach-dir))
  287. ;; Deprecated and removed from documentation, but still
  288. ;; works. FIXME: Remove after major nr change.
  289. ((setq attach-dir (org-entry-get nil "ATTACH_DIR" org-attach-use-inheritance))
  290. (org-attach-check-absolute-path attach-dir))
  291. ((setq id (org-entry-get nil "ID" org-attach-use-inheritance))
  292. (org-attach-check-absolute-path nil)
  293. (setq attach-dir (org-attach-dir-from-id id 'try-all))))
  294. (if no-fs-check
  295. attach-dir
  296. (when (and attach-dir (file-directory-p attach-dir))
  297. attach-dir))))
  298. (defun org-attach-dir-get-create ()
  299. "Return existing or new directory associated with the current outline node.
  300. `org-attach-preferred-new-method' decides how to attach new
  301. directory if neither ID nor DIR property exist.
  302. If the attachment by some reason cannot be created an error will be raised."
  303. (interactive)
  304. (let ((attach-dir (org-attach-dir nil 'no-fs-check)))
  305. (unless attach-dir
  306. (let (answer)
  307. (when (eq org-attach-preferred-new-method 'ask)
  308. (message "Create new ID [1] property or DIR [2] property for attachments?")
  309. (setq answer (read-char-exclusive)))
  310. (cond
  311. ((or (eq org-attach-preferred-new-method 'id) (eq answer ?1))
  312. (setq attach-dir (org-attach-dir-from-id (org-id-get nil t))))
  313. ((or (eq org-attach-preferred-new-method 'dir) (eq answer ?2))
  314. (setq attach-dir (org-attach-set-directory)))
  315. ((eq org-attach-preferred-new-method 'nil)
  316. (error "No existing directory. DIR or ID property has to be explicitly created")))))
  317. (unless attach-dir
  318. (error "No attachment directory is associated with the current node"))
  319. (unless (file-directory-p attach-dir)
  320. (make-directory attach-dir t))
  321. attach-dir))
  322. (defun org-attach-dir-from-id (id &optional try-all)
  323. "Returns a folder path based on `org-attach-id-dir' and ID.
  324. If TRY-ALL is non-nil, try all id-to-path functions in
  325. `org-attach-id-to-path-function-list' and return the first path
  326. that exist in the filesystem, or the first one if none exist.
  327. Otherwise only use the first function in that list."
  328. (let ((attach-dir-preferred (expand-file-name
  329. (funcall (car org-attach-id-to-path-function-list) id)
  330. (expand-file-name org-attach-id-dir))))
  331. (if try-all
  332. (let ((attach-dir attach-dir-preferred)
  333. (fun-list (cdr org-attach-id-to-path-function-list)))
  334. (while (and fun-list (not (file-directory-p attach-dir)))
  335. (setq attach-dir (expand-file-name
  336. (funcall (car fun-list) id)
  337. (expand-file-name org-attach-id-dir)))
  338. (setq fun-list (cdr fun-list)))
  339. (if (file-directory-p attach-dir)
  340. attach-dir
  341. attach-dir-preferred))
  342. attach-dir-preferred)))
  343. (defun org-attach-check-absolute-path (dir)
  344. "Check if we have enough information to root the attachment directory.
  345. When DIR is given, check also if it is already absolute. Otherwise,
  346. assume that it will be relative, and check if `org-attach-id-dir' is
  347. absolute, or if at least the current buffer has a file name.
  348. Throw an error if we cannot root the directory."
  349. (or (and dir (file-name-absolute-p dir))
  350. (file-name-absolute-p org-attach-id-dir)
  351. (buffer-file-name (buffer-base-buffer))
  352. (error "Need absolute `org-attach-id-dir' to attach in buffers without filename")))
  353. (defun org-attach-set-directory ()
  354. "Set the DIR node property and ask to move files there.
  355. The property defines the directory that is used for attachments
  356. of the entry. Creates relative links if `org-attach-dir-relative'
  357. is non-nil.
  358. Return the directory."
  359. (interactive)
  360. (let ((old (org-attach-dir))
  361. (new
  362. (let* ((attach-dir (read-directory-name
  363. "Attachment directory: "
  364. (org-entry-get nil "DIR")))
  365. (current-dir (file-name-directory (or default-directory
  366. buffer-file-name)))
  367. (attach-dir-relative (file-relative-name attach-dir current-dir)))
  368. (org-entry-put nil "DIR" (if org-attach-dir-relative
  369. attach-dir-relative
  370. attach-dir))
  371. attach-dir)))
  372. (unless (or (string= old new)
  373. (not old))
  374. (when (yes-or-no-p "Copy over attachments from old directory? ")
  375. (copy-directory old new t t t))
  376. (when (yes-or-no-p (concat "Delete " old))
  377. (delete-directory old t)))
  378. new))
  379. (defun org-attach-unset-directory ()
  380. "Removes DIR node property.
  381. If attachment folder is changed due to removal of DIR-property
  382. ask to move attachments to new location and ask to delete old
  383. attachment-folder.
  384. Change of attachment-folder due to unset might be if an ID
  385. property is set on the node, or if a separate inherited
  386. DIR-property exists (that is different than the unset one)."
  387. (interactive)
  388. (let ((old (org-attach-dir))
  389. (new
  390. (progn
  391. (org-entry-delete nil "DIR")
  392. ;; ATTACH-DIR is deprecated and removed from documentation,
  393. ;; but still works. Remove code for it after major nr change.
  394. (org-entry-delete nil "ATTACH_DIR")
  395. (org-attach-dir))))
  396. (unless (or (string= old new)
  397. (not old))
  398. (when (and new (yes-or-no-p "Copy over attachments from old directory? "))
  399. (copy-directory old new t nil t))
  400. (when (yes-or-no-p (concat "Delete " old))
  401. (delete-directory old t)))))
  402. (defun org-attach-tag (&optional off)
  403. "Turn the autotag on or (if OFF is set) off."
  404. (when org-attach-auto-tag
  405. (save-excursion
  406. (org-back-to-heading t)
  407. (org-toggle-tag org-attach-auto-tag (if off 'off 'on)))))
  408. (defun org-attach-untag ()
  409. "Turn the autotag off."
  410. (org-attach-tag 'off))
  411. (defun org-attach-store-link (file)
  412. "Add a link to `org-stored-link' when attaching a file.
  413. Only do this when `org-attach-store-link-p' is non-nil."
  414. (setq org-stored-links
  415. (cons (list (org-attach-expand-link file)
  416. (file-name-nondirectory file))
  417. org-stored-links)))
  418. (defun org-attach-url (url)
  419. (interactive "MURL of the file to attach: \n")
  420. (let ((org-attach-method 'url))
  421. (org-attach-attach url)))
  422. (defun org-attach-buffer (buffer-name)
  423. "Attach BUFFER-NAME's contents to current outline node.
  424. BUFFER-NAME is a string. Signals a `file-already-exists' error
  425. if it would overwrite an existing filename."
  426. (interactive "bBuffer whose contents should be attached: ")
  427. (let* ((attach-dir (org-attach-dir 'get-create))
  428. (output (expand-file-name buffer-name attach-dir)))
  429. (when (file-exists-p output)
  430. (signal 'file-already-exists (list "File exists" output)))
  431. (run-hook-with-args 'org-attach-after-change-hook attach-dir)
  432. (org-attach-tag)
  433. (with-temp-file output
  434. (insert-buffer-substring buffer-name))))
  435. (defun org-attach-attach (file &optional visit-dir method)
  436. "Move/copy/link FILE into the attachment directory of the current outline node.
  437. If VISIT-DIR is non-nil, visit the directory with dired.
  438. METHOD may be `cp', `mv', `ln', `lns' or `url' default taken from
  439. `org-attach-method'."
  440. (interactive
  441. (list
  442. (read-file-name "File to keep as an attachment:"
  443. (or (progn
  444. (require 'dired-aux)
  445. (dired-dwim-target-directory))
  446. default-directory))
  447. current-prefix-arg
  448. nil))
  449. (setq method (or method org-attach-method))
  450. (let ((basename (file-name-nondirectory file)))
  451. (let* ((attach-dir (org-attach-dir 'get-create))
  452. (fname (expand-file-name basename attach-dir)))
  453. (cond
  454. ((eq method 'mv) (rename-file file fname))
  455. ((eq method 'cp) (copy-file file fname))
  456. ((eq method 'ln) (add-name-to-file file fname))
  457. ((eq method 'lns) (make-symbolic-link file fname))
  458. ((eq method 'url) (url-copy-file file fname)))
  459. (run-hook-with-args 'org-attach-after-change-hook attach-dir)
  460. (org-attach-tag)
  461. (cond ((eq org-attach-store-link-p 'attached)
  462. (org-attach-store-link fname))
  463. ((eq org-attach-store-link-p t)
  464. (org-attach-store-link file)))
  465. (if visit-dir
  466. (dired attach-dir)
  467. (message "File %S is now an attachment." basename)))))
  468. (defun org-attach-attach-cp ()
  469. "Attach a file by copying it."
  470. (interactive)
  471. (let ((org-attach-method 'cp)) (call-interactively 'org-attach-attach)))
  472. (defun org-attach-attach-mv ()
  473. "Attach a file by moving (renaming) it."
  474. (interactive)
  475. (let ((org-attach-method 'mv)) (call-interactively 'org-attach-attach)))
  476. (defun org-attach-attach-ln ()
  477. "Attach a file by creating a hard link to it.
  478. Beware that this does not work on systems that do not support hard links.
  479. On some systems, this apparently does copy the file instead."
  480. (interactive)
  481. (let ((org-attach-method 'ln)) (call-interactively 'org-attach-attach)))
  482. (defun org-attach-attach-lns ()
  483. "Attach a file by creating a symbolic link to it.
  484. Beware that this does not work on systems that do not support symbolic links.
  485. On some systems, this apparently does copy the file instead."
  486. (interactive)
  487. (let ((org-attach-method 'lns)) (call-interactively 'org-attach-attach)))
  488. (defun org-attach-new (file)
  489. "Create a new attachment FILE for the current outline node.
  490. The attachment is created as an Emacs buffer."
  491. (interactive "sCreate attachment named: ")
  492. (let ((attach-dir (org-attach-dir 'get-create)))
  493. (org-attach-tag)
  494. (find-file (expand-file-name file attach-dir))
  495. (message "New attachment %s" file)))
  496. (defun org-attach-delete-one (&optional file)
  497. "Delete a single attachment."
  498. (interactive)
  499. (let* ((attach-dir (org-attach-dir))
  500. (files (org-attach-file-list attach-dir))
  501. (file (or file
  502. (completing-read
  503. "Delete attachment: "
  504. (mapcar (lambda (f)
  505. (list (file-name-nondirectory f)))
  506. files)))))
  507. (setq file (expand-file-name file attach-dir))
  508. (unless (file-exists-p file)
  509. (error "No such attachment: %s" file))
  510. (delete-file file)
  511. (run-hook-with-args 'org-attach-after-change-hook attach-dir)))
  512. (defun org-attach-delete-all (&optional force)
  513. "Delete all attachments from the current outline node.
  514. This actually deletes the entire attachment directory.
  515. A safer way is to open the directory in dired and delete from there."
  516. (interactive "P")
  517. (let ((attach-dir (org-attach-dir)))
  518. (when (and attach-dir
  519. (or force
  520. (yes-or-no-p "Really remove all attachments of this entry? ")))
  521. (delete-directory attach-dir (yes-or-no-p "Recursive?") t)
  522. (message "Attachment directory removed")
  523. (run-hook-with-args 'org-attach-after-change-hook attach-dir)
  524. (org-attach-untag))))
  525. (defun org-attach-sync ()
  526. "Synchronize the current outline node with its attachments.
  527. This can be used after files have been added externally."
  528. (interactive)
  529. (let ((attach-dir (org-attach-dir)))
  530. (when attach-dir
  531. (run-hook-with-args 'org-attach-after-change-hook attach-dir)
  532. (let ((files (org-attach-file-list attach-dir)))
  533. (org-attach-tag (not files))))
  534. (unless attach-dir (org-attach-tag t))))
  535. (defun org-attach-file-list (dir)
  536. "Return a list of files in the attachment directory.
  537. This ignores files ending in \"~\"."
  538. (delq nil
  539. (mapcar (lambda (x) (if (string-match "^\\.\\.?\\'" x) nil x))
  540. (directory-files dir nil "[^~]\\'"))))
  541. (defun org-attach-reveal ()
  542. "Show the attachment directory of the current outline node.
  543. This will attempt to use an external program to show the
  544. directory. Will create an attachment and folder if it doesn't
  545. exist yet. Respects `org-attach-preferred-new-method'."
  546. (interactive)
  547. (org-open-file (org-attach-dir-get-create)))
  548. (defun org-attach-reveal-in-emacs ()
  549. "Show the attachment directory of the current outline node in dired.
  550. Will create an attachment and folder if it doesn't exist yet.
  551. Respects `org-attach-preferred-new-method'."
  552. (interactive)
  553. (dired (org-attach-dir-get-create)))
  554. (defun org-attach-open (&optional in-emacs)
  555. "Open an attachment of the current outline node.
  556. If there are more than one attachment, you will be prompted for the file name.
  557. This command will open the file using the settings in `org-file-apps'
  558. and in the system-specific variants of this variable.
  559. If IN-EMACS is non-nil, force opening in Emacs."
  560. (interactive "P")
  561. (let ((attach-dir (org-attach-dir)))
  562. (if attach-dir
  563. (let* ((file (pcase (org-attach-file-list attach-dir)
  564. (`(,file) file)
  565. (files (completing-read "Open attachment: "
  566. (mapcar #'list files) nil t))))
  567. (path (expand-file-name file attach-dir)))
  568. (run-hook-with-args 'org-attach-open-hook path)
  569. (org-open-file path in-emacs))
  570. (error "No attachment directory exist"))))
  571. (defun org-attach-open-in-emacs ()
  572. "Open attachment, force opening in Emacs.
  573. See `org-attach-open'."
  574. (interactive)
  575. (org-attach-open 'in-emacs))
  576. (defun org-attach-expand (file)
  577. "Return the full path to the current entry's attachment file FILE.
  578. Basically, this adds the path to the attachment directory."
  579. (expand-file-name file (org-attach-dir)))
  580. (defun org-attach-expand-link (file)
  581. "Return a file link pointing to the current entry's attachment file FILE.
  582. Basically, this adds the path to the attachment directory, and a \"file:\"
  583. prefix."
  584. (concat "file:" (org-attach-expand file)))
  585. (org-link-set-parameters "attachment"
  586. :follow #'org-attach-open-link
  587. :export #'org-attach-export-link
  588. :complete #'org-attach-complete-link)
  589. (defun org-attach-open-link (link &optional in-emacs)
  590. "Attachment link type LINK is expanded with the attached directory and opened.
  591. With optional prefix argument IN-EMACS, Emacs will visit the file.
  592. With a double \\[universal-argument] \\[universal-argument] \
  593. prefix arg, Org tries to avoid opening in Emacs
  594. and to use an external application to visit the file."
  595. (interactive "P")
  596. (let (line search)
  597. (cond
  598. ((string-match "::\\([0-9]+\\)\\'" link)
  599. (setq line (string-to-number (match-string 1 link))
  600. link (substring link 0 (match-beginning 0))))
  601. ((string-match "::\\(.+\\)\\'" link)
  602. (setq search (match-string 1 link)
  603. link (substring link 0 (match-beginning 0)))))
  604. (if (string-match "[*?{]" (file-name-nondirectory link))
  605. (dired (org-attach-expand link))
  606. (org-open-file (org-attach-expand link) in-emacs line search))))
  607. (defun org-attach-complete-link ()
  608. "Advise the user with the available files in the attachment directory."
  609. (let ((attach-dir (org-attach-dir)))
  610. (if attach-dir
  611. (let* ((attached-dir (expand-file-name attach-dir))
  612. (file (read-file-name "File: " attached-dir))
  613. (pwd (file-name-as-directory attached-dir))
  614. (pwd-relative (file-name-as-directory
  615. (abbreviate-file-name attached-dir))))
  616. (cond
  617. ((string-match (concat "^" (regexp-quote pwd-relative) "\\(.+\\)") file)
  618. (concat "attachment:" (match-string 1 file)))
  619. ((string-match (concat "^" (regexp-quote pwd) "\\(.+\\)")
  620. (expand-file-name file))
  621. (concat "attachment:" (match-string 1 (expand-file-name file))))
  622. (t (concat "attachment:" file))))
  623. (error "No attachment directory exist"))))
  624. (defun org-attach-export-link (link description format)
  625. "Translate attachment LINK from Org mode format to exported FORMAT.
  626. Also includes the DESCRIPTION of the link in the export."
  627. (save-excursion
  628. (let (path desc)
  629. (cond
  630. ((string-match "::\\([0-9]+\\)\\'" link)
  631. (setq link (substring link 0 (match-beginning 0))))
  632. ((string-match "::\\(.+\\)\\'" link)
  633. (setq link (substring link 0 (match-beginning 0)))))
  634. (setq path (file-relative-name (org-attach-expand link))
  635. desc (or description link))
  636. (pcase format
  637. (`html (format "<a target=\"_blank\" href=\"%s\">%s</a>" path desc))
  638. (`latex (format "\\href{%s}{%s}" path desc))
  639. (`texinfo (format "@uref{%s,%s}" path desc))
  640. (`ascii (format "%s (%s)" desc path))
  641. (`md (format "[%s](%s)" desc path))
  642. (_ path)))))
  643. (defun org-attach-archive-delete-maybe ()
  644. "Maybe delete subtree attachments when archiving.
  645. This function is called by `org-archive-hook'. The option
  646. `org-attach-archive-delete' controls its behavior."
  647. (when org-attach-archive-delete
  648. (org-attach-delete-all (not (eq org-attach-archive-delete 'query)))))
  649. ;; Attach from dired.
  650. ;; Add the following lines to the config file to get a binding for
  651. ;; dired-mode.
  652. ;; (add-hook
  653. ;; 'dired-mode-hook
  654. ;; (lambda ()
  655. ;; (define-key dired-mode-map (kbd "C-c C-x a") #'org-attach-dired-to-subtree))))
  656. ;;;###autoload
  657. (defun org-attach-dired-to-subtree (files)
  658. "Attach FILES marked or current file in dired to subtree in other window.
  659. Takes the method given in `org-attach-method' for the attach action.
  660. Precondition: Point must be in a dired buffer.
  661. Idea taken from `gnus-dired-attach'."
  662. (interactive
  663. (list (dired-get-marked-files)))
  664. (unless (eq major-mode 'dired-mode)
  665. (user-error "This command must be triggered in a dired buffer"))
  666. (let ((start-win (selected-window))
  667. (other-win
  668. (get-window-with-predicate
  669. (lambda (window)
  670. (with-current-buffer (window-buffer window)
  671. (eq major-mode 'org-mode))))))
  672. (unless other-win
  673. (user-error
  674. "Can't attach to subtree. No window displaying an Org buffer"))
  675. (select-window other-win)
  676. (dolist (file files)
  677. (org-attach-attach file))
  678. (select-window start-win)
  679. (when (eq 'mv org-attach-method)
  680. (revert-buffer))))
  681. (add-hook 'org-archive-hook 'org-attach-archive-delete-maybe)
  682. (provide 'org-attach)
  683. ;; Local variables:
  684. ;; generated-autoload-file: "org-loaddefs.el"
  685. ;; End:
  686. ;;; org-attach.el ends here