annotate lisp/org/org-id.el @ 112218:376148b31b5e

Add 2011 to FSF/AIST copyright years.
author Glenn Morris <rgm@gnu.org>
date Sun, 02 Jan 2011 15:50:46 -0800
parents 1d1d5d9bd884
children 417b1e4d63cd
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
100448
cea079b68b76 2008-12-16 Carsten Dominik <carsten.dominik@gmail.com>
Carsten Dominik <dominik@science.uva.nl>
parents: 100269
diff changeset
1 ;;; org-id.el --- Global identifiers for Org-mode entries
101458
36abe982e7cd 2009-01-25 Carsten Dominik <carsten.dominik@gmail.com>
Carsten Dominik <dominik@science.uva.nl>
parents: 100908
diff changeset
2 ;;
112218
376148b31b5e Add 2011 to FSF/AIST copyright years.
Glenn Morris <rgm@gnu.org>
parents: 106815
diff changeset
3 ;; Copyright (C) 2008, 2009, 2010, 2011 Free Software Foundation, Inc.
96045
19a1d523548c New file: org-id.el.
Carsten Dominik <dominik@science.uva.nl>
parents:
diff changeset
4 ;;
19a1d523548c New file: org-id.el.
Carsten Dominik <dominik@science.uva.nl>
parents:
diff changeset
5 ;; Author: Carsten Dominik <carsten at orgmode dot org>
19a1d523548c New file: org-id.el.
Carsten Dominik <dominik@science.uva.nl>
parents:
diff changeset
6 ;; Keywords: outlines, hypermedia, calendar, wp
19a1d523548c New file: org-id.el.
Carsten Dominik <dominik@science.uva.nl>
parents:
diff changeset
7 ;; Homepage: http://orgmode.org
106168
83924fb4f59c 2009-11-20 Carsten Dominik <carsten.dominik@gmail.com>
Carsten Dominik <dominik@science.uva.nl>
parents: 106022
diff changeset
8 ;; Version: 6.33x
96045
19a1d523548c New file: org-id.el.
Carsten Dominik <dominik@science.uva.nl>
parents:
diff changeset
9 ;;
19a1d523548c New file: org-id.el.
Carsten Dominik <dominik@science.uva.nl>
parents:
diff changeset
10 ;; This file is part of GNU Emacs.
19a1d523548c New file: org-id.el.
Carsten Dominik <dominik@science.uva.nl>
parents:
diff changeset
11 ;;
19a1d523548c New file: org-id.el.
Carsten Dominik <dominik@science.uva.nl>
parents:
diff changeset
12 ;; GNU Emacs is free software: you can redistribute it and/or modify
19a1d523548c New file: org-id.el.
Carsten Dominik <dominik@science.uva.nl>
parents:
diff changeset
13 ;; it under the terms of the GNU General Public License as published by
19a1d523548c New file: org-id.el.
Carsten Dominik <dominik@science.uva.nl>
parents:
diff changeset
14 ;; the Free Software Foundation, either version 3 of the License, or
19a1d523548c New file: org-id.el.
Carsten Dominik <dominik@science.uva.nl>
parents:
diff changeset
15 ;; (at your option) any later version.
19a1d523548c New file: org-id.el.
Carsten Dominik <dominik@science.uva.nl>
parents:
diff changeset
16
19a1d523548c New file: org-id.el.
Carsten Dominik <dominik@science.uva.nl>
parents:
diff changeset
17 ;; GNU Emacs is distributed in the hope that it will be useful,
19a1d523548c New file: org-id.el.
Carsten Dominik <dominik@science.uva.nl>
parents:
diff changeset
18 ;; but WITHOUT ANY WARRANTY; without even the implied warranty of
19a1d523548c New file: org-id.el.
Carsten Dominik <dominik@science.uva.nl>
parents:
diff changeset
19 ;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
19a1d523548c New file: org-id.el.
Carsten Dominik <dominik@science.uva.nl>
parents:
diff changeset
20 ;; GNU General Public License for more details.
19a1d523548c New file: org-id.el.
Carsten Dominik <dominik@science.uva.nl>
parents:
diff changeset
21
19a1d523548c New file: org-id.el.
Carsten Dominik <dominik@science.uva.nl>
parents:
diff changeset
22 ;; You should have received a copy of the GNU General Public License
19a1d523548c New file: org-id.el.
Carsten Dominik <dominik@science.uva.nl>
parents:
diff changeset
23 ;; along with GNU Emacs. If not, see <http://www.gnu.org/licenses/>.
19a1d523548c New file: org-id.el.
Carsten Dominik <dominik@science.uva.nl>
parents:
diff changeset
24 ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
19a1d523548c New file: org-id.el.
Carsten Dominik <dominik@science.uva.nl>
parents:
diff changeset
25 ;;
19a1d523548c New file: org-id.el.
Carsten Dominik <dominik@science.uva.nl>
parents:
diff changeset
26 ;;; Commentary:
19a1d523548c New file: org-id.el.
Carsten Dominik <dominik@science.uva.nl>
parents:
diff changeset
27
19a1d523548c New file: org-id.el.
Carsten Dominik <dominik@science.uva.nl>
parents:
diff changeset
28 ;; This file implements globally unique identifiers for Org-mode entries.
19a1d523548c New file: org-id.el.
Carsten Dominik <dominik@science.uva.nl>
parents:
diff changeset
29 ;; Identifiers are stored in the entry as an :ID: property. Functions
19a1d523548c New file: org-id.el.
Carsten Dominik <dominik@science.uva.nl>
parents:
diff changeset
30 ;; are provided that create and retrieve such identifiers, and that find
19a1d523548c New file: org-id.el.
Carsten Dominik <dominik@science.uva.nl>
parents:
diff changeset
31 ;; entries based on the identifier.
19a1d523548c New file: org-id.el.
Carsten Dominik <dominik@science.uva.nl>
parents:
diff changeset
32
98644
e1cc41b9282d 2008-10-12 Carsten Dominik <carsten.dominik@gmail.com>
Carsten Dominik <dominik@science.uva.nl>
parents: 97027
diff changeset
33 ;; Identifiers consist of a prefix (default "Org" given by the variable
e1cc41b9282d 2008-10-12 Carsten Dominik <carsten.dominik@gmail.com>
Carsten Dominik <dominik@science.uva.nl>
parents: 97027
diff changeset
34 ;; `org-id-prefix') and a unique part that can be created by a number
e1cc41b9282d 2008-10-12 Carsten Dominik <carsten.dominik@gmail.com>
Carsten Dominik <dominik@science.uva.nl>
parents: 97027
diff changeset
35 ;; of different methods, see the variable `org-id-method'.
e1cc41b9282d 2008-10-12 Carsten Dominik <carsten.dominik@gmail.com>
Carsten Dominik <dominik@science.uva.nl>
parents: 97027
diff changeset
36 ;; Org has a builtin method that uses a compact encoding of the creation
e1cc41b9282d 2008-10-12 Carsten Dominik <carsten.dominik@gmail.com>
Carsten Dominik <dominik@science.uva.nl>
parents: 97027
diff changeset
37 ;; time of the ID, with microsecond accuracy. This virtually
96045
19a1d523548c New file: org-id.el.
Carsten Dominik <dominik@science.uva.nl>
parents:
diff changeset
38 ;; guarantees globally unique identifiers, even if several people are
100448
cea079b68b76 2008-12-16 Carsten Dominik <carsten.dominik@gmail.com>
Carsten Dominik <dominik@science.uva.nl>
parents: 100269
diff changeset
39 ;; creating IDs at the same time in files that will eventually be used
100458
ba23e35d3eaf 2008-12-17 Carsten Dominik <carsten.dominik@gmail.com>
Carsten Dominik <dominik@science.uva.nl>
parents: 100448
diff changeset
40 ;; together. As an external method `uuidgen' is supported, if installed
98644
e1cc41b9282d 2008-10-12 Carsten Dominik <carsten.dominik@gmail.com>
Carsten Dominik <dominik@science.uva.nl>
parents: 97027
diff changeset
41 ;; on the system.
96045
19a1d523548c New file: org-id.el.
Carsten Dominik <dominik@science.uva.nl>
parents:
diff changeset
42 ;;
19a1d523548c New file: org-id.el.
Carsten Dominik <dominik@science.uva.nl>
parents:
diff changeset
43 ;; This file defines the following API:
19a1d523548c New file: org-id.el.
Carsten Dominik <dominik@science.uva.nl>
parents:
diff changeset
44 ;;
19a1d523548c New file: org-id.el.
Carsten Dominik <dominik@science.uva.nl>
parents:
diff changeset
45 ;; org-id-get-create
19a1d523548c New file: org-id.el.
Carsten Dominik <dominik@science.uva.nl>
parents:
diff changeset
46 ;; Create an ID for the entry at point if it does not yet have one.
19a1d523548c New file: org-id.el.
Carsten Dominik <dominik@science.uva.nl>
parents:
diff changeset
47 ;; Returns the ID (old or new). This function can be used
19a1d523548c New file: org-id.el.
Carsten Dominik <dominik@science.uva.nl>
parents:
diff changeset
48 ;; interactively, with prefix argument the creation of a new ID is
19a1d523548c New file: org-id.el.
Carsten Dominik <dominik@science.uva.nl>
parents:
diff changeset
49 ;; forced, even if there was an old one.
19a1d523548c New file: org-id.el.
Carsten Dominik <dominik@science.uva.nl>
parents:
diff changeset
50 ;;
19a1d523548c New file: org-id.el.
Carsten Dominik <dominik@science.uva.nl>
parents:
diff changeset
51 ;; org-id-get
19a1d523548c New file: org-id.el.
Carsten Dominik <dominik@science.uva.nl>
parents:
diff changeset
52 ;; Get the ID property of an entry. Using appropriate arguments
19a1d523548c New file: org-id.el.
Carsten Dominik <dominik@science.uva.nl>
parents:
diff changeset
53 ;; to the function, it can also create the ID for this entry.
19a1d523548c New file: org-id.el.
Carsten Dominik <dominik@science.uva.nl>
parents:
diff changeset
54 ;;
19a1d523548c New file: org-id.el.
Carsten Dominik <dominik@science.uva.nl>
parents:
diff changeset
55 ;; org-id-goto
19a1d523548c New file: org-id.el.
Carsten Dominik <dominik@science.uva.nl>
parents:
diff changeset
56 ;; Command to go to a specific ID, this command can be used
19a1d523548c New file: org-id.el.
Carsten Dominik <dominik@science.uva.nl>
parents:
diff changeset
57 ;; interactively.
19a1d523548c New file: org-id.el.
Carsten Dominik <dominik@science.uva.nl>
parents:
diff changeset
58 ;;
19a1d523548c New file: org-id.el.
Carsten Dominik <dominik@science.uva.nl>
parents:
diff changeset
59 ;; org-id-get-with-outline-path-completion
19a1d523548c New file: org-id.el.
Carsten Dominik <dominik@science.uva.nl>
parents:
diff changeset
60 ;; Retrieve the ID of an entry, using outline path completion.
19a1d523548c New file: org-id.el.
Carsten Dominik <dominik@science.uva.nl>
parents:
diff changeset
61 ;; This function can work for multiple files.
19a1d523548c New file: org-id.el.
Carsten Dominik <dominik@science.uva.nl>
parents:
diff changeset
62 ;;
19a1d523548c New file: org-id.el.
Carsten Dominik <dominik@science.uva.nl>
parents:
diff changeset
63 ;; org-id-get-with-outline-drilling
19a1d523548c New file: org-id.el.
Carsten Dominik <dominik@science.uva.nl>
parents:
diff changeset
64 ;; Retrieve the ID of an entry, using outline path completion.
19a1d523548c New file: org-id.el.
Carsten Dominik <dominik@science.uva.nl>
parents:
diff changeset
65 ;; This function only works for the current file.
19a1d523548c New file: org-id.el.
Carsten Dominik <dominik@science.uva.nl>
parents:
diff changeset
66 ;;
19a1d523548c New file: org-id.el.
Carsten Dominik <dominik@science.uva.nl>
parents:
diff changeset
67 ;; org-id-find
19a1d523548c New file: org-id.el.
Carsten Dominik <dominik@science.uva.nl>
parents:
diff changeset
68 ;; Find the location of an entry with specific id.
19a1d523548c New file: org-id.el.
Carsten Dominik <dominik@science.uva.nl>
parents:
diff changeset
69 ;;
19a1d523548c New file: org-id.el.
Carsten Dominik <dominik@science.uva.nl>
parents:
diff changeset
70
19a1d523548c New file: org-id.el.
Carsten Dominik <dominik@science.uva.nl>
parents:
diff changeset
71 (require 'org)
19a1d523548c New file: org-id.el.
Carsten Dominik <dominik@science.uva.nl>
parents:
diff changeset
72
19a1d523548c New file: org-id.el.
Carsten Dominik <dominik@science.uva.nl>
parents:
diff changeset
73 (declare-function message-make-fqdn "message" ())
19a1d523548c New file: org-id.el.
Carsten Dominik <dominik@science.uva.nl>
parents:
diff changeset
74
19a1d523548c New file: org-id.el.
Carsten Dominik <dominik@science.uva.nl>
parents:
diff changeset
75 ;;; Customization
19a1d523548c New file: org-id.el.
Carsten Dominik <dominik@science.uva.nl>
parents:
diff changeset
76
19a1d523548c New file: org-id.el.
Carsten Dominik <dominik@science.uva.nl>
parents:
diff changeset
77 (defgroup org-id nil
19a1d523548c New file: org-id.el.
Carsten Dominik <dominik@science.uva.nl>
parents:
diff changeset
78 "Options concerning global entry identifiers in Org-mode."
19a1d523548c New file: org-id.el.
Carsten Dominik <dominik@science.uva.nl>
parents:
diff changeset
79 :tag "Org ID"
19a1d523548c New file: org-id.el.
Carsten Dominik <dominik@science.uva.nl>
parents:
diff changeset
80 :group 'org)
19a1d523548c New file: org-id.el.
Carsten Dominik <dominik@science.uva.nl>
parents:
diff changeset
81
104164
ac1a55cc2c38 2009-08-06 Carsten Dominik <carsten.dominik@gmail.com>
Carsten Dominik <dominik@science.uva.nl>
parents: 101757
diff changeset
82 (defcustom org-id-uuid-program "uuidgen"
ac1a55cc2c38 2009-08-06 Carsten Dominik <carsten.dominik@gmail.com>
Carsten Dominik <dominik@science.uva.nl>
parents: 101757
diff changeset
83 "The uuidgen program."
ac1a55cc2c38 2009-08-06 Carsten Dominik <carsten.dominik@gmail.com>
Carsten Dominik <dominik@science.uva.nl>
parents: 101757
diff changeset
84 :group 'org-id
ac1a55cc2c38 2009-08-06 Carsten Dominik <carsten.dominik@gmail.com>
Carsten Dominik <dominik@science.uva.nl>
parents: 101757
diff changeset
85 :type 'string)
98644
e1cc41b9282d 2008-10-12 Carsten Dominik <carsten.dominik@gmail.com>
Carsten Dominik <dominik@science.uva.nl>
parents: 97027
diff changeset
86
100458
ba23e35d3eaf 2008-12-17 Carsten Dominik <carsten.dominik@gmail.com>
Carsten Dominik <dominik@science.uva.nl>
parents: 100448
diff changeset
87 (defcustom org-id-method
100448
cea079b68b76 2008-12-16 Carsten Dominik <carsten.dominik@gmail.com>
Carsten Dominik <dominik@science.uva.nl>
parents: 100269
diff changeset
88 (condition-case nil
cea079b68b76 2008-12-16 Carsten Dominik <carsten.dominik@gmail.com>
Carsten Dominik <dominik@science.uva.nl>
parents: 100269
diff changeset
89 (if (string-match "\\`[-0-9a-fA-F]\\{36\\}\\'"
104164
ac1a55cc2c38 2009-08-06 Carsten Dominik <carsten.dominik@gmail.com>
Carsten Dominik <dominik@science.uva.nl>
parents: 101757
diff changeset
90 (org-trim (shell-command-to-string
ac1a55cc2c38 2009-08-06 Carsten Dominik <carsten.dominik@gmail.com>
Carsten Dominik <dominik@science.uva.nl>
parents: 101757
diff changeset
91 org-id-uuid-program)))
100448
cea079b68b76 2008-12-16 Carsten Dominik <carsten.dominik@gmail.com>
Carsten Dominik <dominik@science.uva.nl>
parents: 100269
diff changeset
92 'uuidgen
cea079b68b76 2008-12-16 Carsten Dominik <carsten.dominik@gmail.com>
Carsten Dominik <dominik@science.uva.nl>
parents: 100269
diff changeset
93 'org)
cea079b68b76 2008-12-16 Carsten Dominik <carsten.dominik@gmail.com>
Carsten Dominik <dominik@science.uva.nl>
parents: 100269
diff changeset
94 (error 'org))
cea079b68b76 2008-12-16 Carsten Dominik <carsten.dominik@gmail.com>
Carsten Dominik <dominik@science.uva.nl>
parents: 100269
diff changeset
95 "The method that should be used to create new IDs.
cea079b68b76 2008-12-16 Carsten Dominik <carsten.dominik@gmail.com>
Carsten Dominik <dominik@science.uva.nl>
parents: 100269
diff changeset
96
cea079b68b76 2008-12-16 Carsten Dominik <carsten.dominik@gmail.com>
Carsten Dominik <dominik@science.uva.nl>
parents: 100269
diff changeset
97 If `uuidgen' is available on the system, it will be used as the default method.
100458
ba23e35d3eaf 2008-12-17 Carsten Dominik <carsten.dominik@gmail.com>
Carsten Dominik <dominik@science.uva.nl>
parents: 100448
diff changeset
98 if not, the method `org' is used.
100448
cea079b68b76 2008-12-16 Carsten Dominik <carsten.dominik@gmail.com>
Carsten Dominik <dominik@science.uva.nl>
parents: 100269
diff changeset
99 An ID will consist of the optional prefix specified in `org-id-prefix',
cea079b68b76 2008-12-16 Carsten Dominik <carsten.dominik@gmail.com>
Carsten Dominik <dominik@science.uva.nl>
parents: 100269
diff changeset
100 and a unique part created by the method this variable specifies.
98644
e1cc41b9282d 2008-10-12 Carsten Dominik <carsten.dominik@gmail.com>
Carsten Dominik <dominik@science.uva.nl>
parents: 97027
diff changeset
101
e1cc41b9282d 2008-10-12 Carsten Dominik <carsten.dominik@gmail.com>
Carsten Dominik <dominik@science.uva.nl>
parents: 97027
diff changeset
102 Allowed values are:
e1cc41b9282d 2008-10-12 Carsten Dominik <carsten.dominik@gmail.com>
Carsten Dominik <dominik@science.uva.nl>
parents: 97027
diff changeset
103
100448
cea079b68b76 2008-12-16 Carsten Dominik <carsten.dominik@gmail.com>
Carsten Dominik <dominik@science.uva.nl>
parents: 100269
diff changeset
104 org Org's own internal method, using an encoding of the current time to
cea079b68b76 2008-12-16 Carsten Dominik <carsten.dominik@gmail.com>
Carsten Dominik <dominik@science.uva.nl>
parents: 100269
diff changeset
105 microsecond accuracy, and optionally the current domain of the
cea079b68b76 2008-12-16 Carsten Dominik <carsten.dominik@gmail.com>
Carsten Dominik <dominik@science.uva.nl>
parents: 100269
diff changeset
106 computer. See the variable `org-id-include-domain'.
98644
e1cc41b9282d 2008-10-12 Carsten Dominik <carsten.dominik@gmail.com>
Carsten Dominik <dominik@science.uva.nl>
parents: 97027
diff changeset
107
e1cc41b9282d 2008-10-12 Carsten Dominik <carsten.dominik@gmail.com>
Carsten Dominik <dominik@science.uva.nl>
parents: 97027
diff changeset
108 uuidgen Call the external command uuidgen."
e1cc41b9282d 2008-10-12 Carsten Dominik <carsten.dominik@gmail.com>
Carsten Dominik <dominik@science.uva.nl>
parents: 97027
diff changeset
109 :group 'org-id
e1cc41b9282d 2008-10-12 Carsten Dominik <carsten.dominik@gmail.com>
Carsten Dominik <dominik@science.uva.nl>
parents: 97027
diff changeset
110 :type '(choice
e1cc41b9282d 2008-10-12 Carsten Dominik <carsten.dominik@gmail.com>
Carsten Dominik <dominik@science.uva.nl>
parents: 97027
diff changeset
111 (const :tag "Org's internal method" org)
e1cc41b9282d 2008-10-12 Carsten Dominik <carsten.dominik@gmail.com>
Carsten Dominik <dominik@science.uva.nl>
parents: 97027
diff changeset
112 (const :tag "external: uuidgen" uuidgen)))
e1cc41b9282d 2008-10-12 Carsten Dominik <carsten.dominik@gmail.com>
Carsten Dominik <dominik@science.uva.nl>
parents: 97027
diff changeset
113
e1cc41b9282d 2008-10-12 Carsten Dominik <carsten.dominik@gmail.com>
Carsten Dominik <dominik@science.uva.nl>
parents: 97027
diff changeset
114 (defcustom org-id-prefix nil
96045
19a1d523548c New file: org-id.el.
Carsten Dominik <dominik@science.uva.nl>
parents:
diff changeset
115 "The prefix for IDs.
19a1d523548c New file: org-id.el.
Carsten Dominik <dominik@science.uva.nl>
parents:
diff changeset
116
19a1d523548c New file: org-id.el.
Carsten Dominik <dominik@science.uva.nl>
parents:
diff changeset
117 This may be a string, or it can be nil to indicate that no prefix is required.
19a1d523548c New file: org-id.el.
Carsten Dominik <dominik@science.uva.nl>
parents:
diff changeset
118 When a string, the string should have no space characters as IDs are expected
19a1d523548c New file: org-id.el.
Carsten Dominik <dominik@science.uva.nl>
parents:
diff changeset
119 to have no space characters in them."
19a1d523548c New file: org-id.el.
Carsten Dominik <dominik@science.uva.nl>
parents:
diff changeset
120 :group 'org-id
19a1d523548c New file: org-id.el.
Carsten Dominik <dominik@science.uva.nl>
parents:
diff changeset
121 :type '(choice
19a1d523548c New file: org-id.el.
Carsten Dominik <dominik@science.uva.nl>
parents:
diff changeset
122 (const :tag "No prefix")
19a1d523548c New file: org-id.el.
Carsten Dominik <dominik@science.uva.nl>
parents:
diff changeset
123 (string :tag "Prefix")))
19a1d523548c New file: org-id.el.
Carsten Dominik <dominik@science.uva.nl>
parents:
diff changeset
124
100448
cea079b68b76 2008-12-16 Carsten Dominik <carsten.dominik@gmail.com>
Carsten Dominik <dominik@science.uva.nl>
parents: 100269
diff changeset
125 (defcustom org-id-include-domain nil
96045
19a1d523548c New file: org-id.el.
Carsten Dominik <dominik@science.uva.nl>
parents:
diff changeset
126 "Non-nil means, add the domain name to new IDs.
100448
cea079b68b76 2008-12-16 Carsten Dominik <carsten.dominik@gmail.com>
Carsten Dominik <dominik@science.uva.nl>
parents: 100269
diff changeset
127 This ensures global uniqueness of IDs, and is also suggested by
98644
e1cc41b9282d 2008-10-12 Carsten Dominik <carsten.dominik@gmail.com>
Carsten Dominik <dominik@science.uva.nl>
parents: 97027
diff changeset
128 RFC 2445 in combination with RFC 822. This is only relevant if
e1cc41b9282d 2008-10-12 Carsten Dominik <carsten.dominik@gmail.com>
Carsten Dominik <dominik@science.uva.nl>
parents: 97027
diff changeset
129 `org-id-method' is `org'. When uuidgen is used, the domain will never
100448
cea079b68b76 2008-12-16 Carsten Dominik <carsten.dominik@gmail.com>
Carsten Dominik <dominik@science.uva.nl>
parents: 100269
diff changeset
130 be added.
cea079b68b76 2008-12-16 Carsten Dominik <carsten.dominik@gmail.com>
Carsten Dominik <dominik@science.uva.nl>
parents: 100269
diff changeset
131 The default is to not use this because we have no really good way to get
cea079b68b76 2008-12-16 Carsten Dominik <carsten.dominik@gmail.com>
Carsten Dominik <dominik@science.uva.nl>
parents: 100269
diff changeset
132 the true domain, and Org entries will normally not be shared with enough
cea079b68b76 2008-12-16 Carsten Dominik <carsten.dominik@gmail.com>
Carsten Dominik <dominik@science.uva.nl>
parents: 100269
diff changeset
133 people to make this necessary."
cea079b68b76 2008-12-16 Carsten Dominik <carsten.dominik@gmail.com>
Carsten Dominik <dominik@science.uva.nl>
parents: 100269
diff changeset
134 :group 'org-id
cea079b68b76 2008-12-16 Carsten Dominik <carsten.dominik@gmail.com>
Carsten Dominik <dominik@science.uva.nl>
parents: 100269
diff changeset
135 :type 'boolean)
cea079b68b76 2008-12-16 Carsten Dominik <carsten.dominik@gmail.com>
Carsten Dominik <dominik@science.uva.nl>
parents: 100269
diff changeset
136
cea079b68b76 2008-12-16 Carsten Dominik <carsten.dominik@gmail.com>
Carsten Dominik <dominik@science.uva.nl>
parents: 100269
diff changeset
137 (defcustom org-id-track-globally t
100458
ba23e35d3eaf 2008-12-17 Carsten Dominik <carsten.dominik@gmail.com>
Carsten Dominik <dominik@science.uva.nl>
parents: 100448
diff changeset
138 "Non-nil means, track IDs through files, so that links work globally.
100448
cea079b68b76 2008-12-16 Carsten Dominik <carsten.dominik@gmail.com>
Carsten Dominik <dominik@science.uva.nl>
parents: 100269
diff changeset
139 This work by maintaining a hash table for IDs and writing this table
cea079b68b76 2008-12-16 Carsten Dominik <carsten.dominik@gmail.com>
Carsten Dominik <dominik@science.uva.nl>
parents: 100269
diff changeset
140 to disk when exiting Emacs. Because of this, it works best if you use
cea079b68b76 2008-12-16 Carsten Dominik <carsten.dominik@gmail.com>
Carsten Dominik <dominik@science.uva.nl>
parents: 100269
diff changeset
141 a single Emacs process, not many.
cea079b68b76 2008-12-16 Carsten Dominik <carsten.dominik@gmail.com>
Carsten Dominik <dominik@science.uva.nl>
parents: 100269
diff changeset
142
cea079b68b76 2008-12-16 Carsten Dominik <carsten.dominik@gmail.com>
Carsten Dominik <dominik@science.uva.nl>
parents: 100269
diff changeset
143 When nil, IDs are not tracked. Links to IDs will still work within
cea079b68b76 2008-12-16 Carsten Dominik <carsten.dominik@gmail.com>
Carsten Dominik <dominik@science.uva.nl>
parents: 100269
diff changeset
144 a buffer, but not if the entry is located in another file.
cea079b68b76 2008-12-16 Carsten Dominik <carsten.dominik@gmail.com>
Carsten Dominik <dominik@science.uva.nl>
parents: 100269
diff changeset
145 IDs can still be used if the entry with the id is in the same file as
cea079b68b76 2008-12-16 Carsten Dominik <carsten.dominik@gmail.com>
Carsten Dominik <dominik@science.uva.nl>
parents: 100269
diff changeset
146 the link."
96045
19a1d523548c New file: org-id.el.
Carsten Dominik <dominik@science.uva.nl>
parents:
diff changeset
147 :group 'org-id
19a1d523548c New file: org-id.el.
Carsten Dominik <dominik@science.uva.nl>
parents:
diff changeset
148 :type 'boolean)
19a1d523548c New file: org-id.el.
Carsten Dominik <dominik@science.uva.nl>
parents:
diff changeset
149
99139
8fa7ef477c04 2008-10-26 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents: 98871
diff changeset
150 (defcustom org-id-locations-file (convert-standard-filename
100448
cea079b68b76 2008-12-16 Carsten Dominik <carsten.dominik@gmail.com>
Carsten Dominik <dominik@science.uva.nl>
parents: 100269
diff changeset
151 "~/.emacs.d/.org-id-locations")
cea079b68b76 2008-12-16 Carsten Dominik <carsten.dominik@gmail.com>
Carsten Dominik <dominik@science.uva.nl>
parents: 100269
diff changeset
152 "The file for remembering in which file an ID was defined.
cea079b68b76 2008-12-16 Carsten Dominik <carsten.dominik@gmail.com>
Carsten Dominik <dominik@science.uva.nl>
parents: 100269
diff changeset
153 This variable is only relevant when `org-id-track-globally' is set."
96045
19a1d523548c New file: org-id.el.
Carsten Dominik <dominik@science.uva.nl>
parents:
diff changeset
154 :group 'org-id
19a1d523548c New file: org-id.el.
Carsten Dominik <dominik@science.uva.nl>
parents:
diff changeset
155 :type 'file)
19a1d523548c New file: org-id.el.
Carsten Dominik <dominik@science.uva.nl>
parents:
diff changeset
156
19a1d523548c New file: org-id.el.
Carsten Dominik <dominik@science.uva.nl>
parents:
diff changeset
157 (defvar org-id-locations nil
100448
cea079b68b76 2008-12-16 Carsten Dominik <carsten.dominik@gmail.com>
Carsten Dominik <dominik@science.uva.nl>
parents: 100269
diff changeset
158 "List of files with IDs in those files.
cea079b68b76 2008-12-16 Carsten Dominik <carsten.dominik@gmail.com>
Carsten Dominik <dominik@science.uva.nl>
parents: 100269
diff changeset
159 Depending on `org-id-use-hash' this can also be a hash table mapping IDs
cea079b68b76 2008-12-16 Carsten Dominik <carsten.dominik@gmail.com>
Carsten Dominik <dominik@science.uva.nl>
parents: 100269
diff changeset
160 to files.")
cea079b68b76 2008-12-16 Carsten Dominik <carsten.dominik@gmail.com>
Carsten Dominik <dominik@science.uva.nl>
parents: 100269
diff changeset
161
cea079b68b76 2008-12-16 Carsten Dominik <carsten.dominik@gmail.com>
Carsten Dominik <dominik@science.uva.nl>
parents: 100269
diff changeset
162 (defvar org-id-files nil
cea079b68b76 2008-12-16 Carsten Dominik <carsten.dominik@gmail.com>
Carsten Dominik <dominik@science.uva.nl>
parents: 100269
diff changeset
163 "List of files that contain IDs.")
96045
19a1d523548c New file: org-id.el.
Carsten Dominik <dominik@science.uva.nl>
parents:
diff changeset
164
19a1d523548c New file: org-id.el.
Carsten Dominik <dominik@science.uva.nl>
parents:
diff changeset
165 (defcustom org-id-extra-files 'org-agenda-text-search-extra-files
100448
cea079b68b76 2008-12-16 Carsten Dominik <carsten.dominik@gmail.com>
Carsten Dominik <dominik@science.uva.nl>
parents: 100269
diff changeset
166 "Files to be searched for IDs, besides the agenda files.
cea079b68b76 2008-12-16 Carsten Dominik <carsten.dominik@gmail.com>
Carsten Dominik <dominik@science.uva.nl>
parents: 100269
diff changeset
167 When Org reparses files to remake the list of files and IDs it is tracking,
cea079b68b76 2008-12-16 Carsten Dominik <carsten.dominik@gmail.com>
Carsten Dominik <dominik@science.uva.nl>
parents: 100269
diff changeset
168 it will normally scan the agenda files, the archives related to agenda files,
cea079b68b76 2008-12-16 Carsten Dominik <carsten.dominik@gmail.com>
Carsten Dominik <dominik@science.uva.nl>
parents: 100269
diff changeset
169 any files that are listed as ID containing in the current register, and
cea079b68b76 2008-12-16 Carsten Dominik <carsten.dominik@gmail.com>
Carsten Dominik <dominik@science.uva.nl>
parents: 100269
diff changeset
170 any Org-mode files currently visited by Emacs.
cea079b68b76 2008-12-16 Carsten Dominik <carsten.dominik@gmail.com>
Carsten Dominik <dominik@science.uva.nl>
parents: 100269
diff changeset
171 You can list additional files here.
cea079b68b76 2008-12-16 Carsten Dominik <carsten.dominik@gmail.com>
Carsten Dominik <dominik@science.uva.nl>
parents: 100269
diff changeset
172 This variable is only relevant when `org-id-track-globally' is set."
96045
19a1d523548c New file: org-id.el.
Carsten Dominik <dominik@science.uva.nl>
parents:
diff changeset
173 :group 'org-id
19a1d523548c New file: org-id.el.
Carsten Dominik <dominik@science.uva.nl>
parents:
diff changeset
174 :type
19a1d523548c New file: org-id.el.
Carsten Dominik <dominik@science.uva.nl>
parents:
diff changeset
175 '(choice
19a1d523548c New file: org-id.el.
Carsten Dominik <dominik@science.uva.nl>
parents:
diff changeset
176 (symbol :tag "Variable")
19a1d523548c New file: org-id.el.
Carsten Dominik <dominik@science.uva.nl>
parents:
diff changeset
177 (repeat :tag "List of files"
19a1d523548c New file: org-id.el.
Carsten Dominik <dominik@science.uva.nl>
parents:
diff changeset
178 (file))))
19a1d523548c New file: org-id.el.
Carsten Dominik <dominik@science.uva.nl>
parents:
diff changeset
179
100448
cea079b68b76 2008-12-16 Carsten Dominik <carsten.dominik@gmail.com>
Carsten Dominik <dominik@science.uva.nl>
parents: 100269
diff changeset
180 (defcustom org-id-search-archives t
cea079b68b76 2008-12-16 Carsten Dominik <carsten.dominik@gmail.com>
Carsten Dominik <dominik@science.uva.nl>
parents: 100269
diff changeset
181 "Non-nil means, search also the archive files of agenda files for entries.
100458
ba23e35d3eaf 2008-12-17 Carsten Dominik <carsten.dominik@gmail.com>
Carsten Dominik <dominik@science.uva.nl>
parents: 100448
diff changeset
182 This is a possibility to reduce overhead, but it means that entries moved
100448
cea079b68b76 2008-12-16 Carsten Dominik <carsten.dominik@gmail.com>
Carsten Dominik <dominik@science.uva.nl>
parents: 100269
diff changeset
183 to the archives can no longer be found by ID.
cea079b68b76 2008-12-16 Carsten Dominik <carsten.dominik@gmail.com>
Carsten Dominik <dominik@science.uva.nl>
parents: 100269
diff changeset
184 This variable is only relevant when `org-id-track-globally' is set."
cea079b68b76 2008-12-16 Carsten Dominik <carsten.dominik@gmail.com>
Carsten Dominik <dominik@science.uva.nl>
parents: 100269
diff changeset
185 :group 'org-id
cea079b68b76 2008-12-16 Carsten Dominik <carsten.dominik@gmail.com>
Carsten Dominik <dominik@science.uva.nl>
parents: 100269
diff changeset
186 :type 'boolean)
cea079b68b76 2008-12-16 Carsten Dominik <carsten.dominik@gmail.com>
Carsten Dominik <dominik@science.uva.nl>
parents: 100269
diff changeset
187
96045
19a1d523548c New file: org-id.el.
Carsten Dominik <dominik@science.uva.nl>
parents:
diff changeset
188 ;;; The API functions
19a1d523548c New file: org-id.el.
Carsten Dominik <dominik@science.uva.nl>
parents:
diff changeset
189
19a1d523548c New file: org-id.el.
Carsten Dominik <dominik@science.uva.nl>
parents:
diff changeset
190 ;;;###autoload
19a1d523548c New file: org-id.el.
Carsten Dominik <dominik@science.uva.nl>
parents:
diff changeset
191 (defun org-id-get-create (&optional force)
19a1d523548c New file: org-id.el.
Carsten Dominik <dominik@science.uva.nl>
parents:
diff changeset
192 "Create an ID for the current entry and return it.
19a1d523548c New file: org-id.el.
Carsten Dominik <dominik@science.uva.nl>
parents:
diff changeset
193 If the entry already has an ID, just return it.
19a1d523548c New file: org-id.el.
Carsten Dominik <dominik@science.uva.nl>
parents:
diff changeset
194 With optional argument FORCE, force the creation of a new ID."
19a1d523548c New file: org-id.el.
Carsten Dominik <dominik@science.uva.nl>
parents:
diff changeset
195 (interactive "P")
19a1d523548c New file: org-id.el.
Carsten Dominik <dominik@science.uva.nl>
parents:
diff changeset
196 (when force
19a1d523548c New file: org-id.el.
Carsten Dominik <dominik@science.uva.nl>
parents:
diff changeset
197 (org-entry-put (point) "ID" nil))
19a1d523548c New file: org-id.el.
Carsten Dominik <dominik@science.uva.nl>
parents:
diff changeset
198 (org-id-get (point) 'create))
100267
c851df8e004e 2008-12-07 Carsten Dominik <carsten.dominik@gmail.com>
Carsten Dominik <dominik@science.uva.nl>
parents: 99866
diff changeset
199
96045
19a1d523548c New file: org-id.el.
Carsten Dominik <dominik@science.uva.nl>
parents:
diff changeset
200 ;;;###autoload
19a1d523548c New file: org-id.el.
Carsten Dominik <dominik@science.uva.nl>
parents:
diff changeset
201 (defun org-id-copy ()
19a1d523548c New file: org-id.el.
Carsten Dominik <dominik@science.uva.nl>
parents:
diff changeset
202 "Copy the ID of the entry at point to the kill ring.
19a1d523548c New file: org-id.el.
Carsten Dominik <dominik@science.uva.nl>
parents:
diff changeset
203 Create an ID if necessary."
19a1d523548c New file: org-id.el.
Carsten Dominik <dominik@science.uva.nl>
parents:
diff changeset
204 (interactive)
104164
ac1a55cc2c38 2009-08-06 Carsten Dominik <carsten.dominik@gmail.com>
Carsten Dominik <dominik@science.uva.nl>
parents: 101757
diff changeset
205 (org-kill-new (org-id-get nil 'create)))
96045
19a1d523548c New file: org-id.el.
Carsten Dominik <dominik@science.uva.nl>
parents:
diff changeset
206
19a1d523548c New file: org-id.el.
Carsten Dominik <dominik@science.uva.nl>
parents:
diff changeset
207 ;;;###autoload
19a1d523548c New file: org-id.el.
Carsten Dominik <dominik@science.uva.nl>
parents:
diff changeset
208 (defun org-id-get (&optional pom create prefix)
19a1d523548c New file: org-id.el.
Carsten Dominik <dominik@science.uva.nl>
parents:
diff changeset
209 "Get the ID property of the entry at point-or-marker POM.
19a1d523548c New file: org-id.el.
Carsten Dominik <dominik@science.uva.nl>
parents:
diff changeset
210 If POM is nil, refer to the entry at point.
19a1d523548c New file: org-id.el.
Carsten Dominik <dominik@science.uva.nl>
parents:
diff changeset
211 If the entry does not have an ID, the function returns nil.
19a1d523548c New file: org-id.el.
Carsten Dominik <dominik@science.uva.nl>
parents:
diff changeset
212 However, when CREATE is non nil, create an ID if none is present already.
19a1d523548c New file: org-id.el.
Carsten Dominik <dominik@science.uva.nl>
parents:
diff changeset
213 PREFIX will be passed through to `org-id-new'.
19a1d523548c New file: org-id.el.
Carsten Dominik <dominik@science.uva.nl>
parents:
diff changeset
214 In any case, the ID of the entry is returned."
105341
2a8a3a69c1c7 2009-10-01 Carsten Dominik <carsten.dominik@gmail.com>
Carsten Dominik <dominik@science.uva.nl>
parents: 105166
diff changeset
215 (org-with-point-at pom
2a8a3a69c1c7 2009-10-01 Carsten Dominik <carsten.dominik@gmail.com>
Carsten Dominik <dominik@science.uva.nl>
parents: 105166
diff changeset
216 (let ((id (org-entry-get nil "ID")))
2a8a3a69c1c7 2009-10-01 Carsten Dominik <carsten.dominik@gmail.com>
Carsten Dominik <dominik@science.uva.nl>
parents: 105166
diff changeset
217 (cond
2a8a3a69c1c7 2009-10-01 Carsten Dominik <carsten.dominik@gmail.com>
Carsten Dominik <dominik@science.uva.nl>
parents: 105166
diff changeset
218 ((and id (stringp id) (string-match "\\S-" id))
2a8a3a69c1c7 2009-10-01 Carsten Dominik <carsten.dominik@gmail.com>
Carsten Dominik <dominik@science.uva.nl>
parents: 105166
diff changeset
219 id)
2a8a3a69c1c7 2009-10-01 Carsten Dominik <carsten.dominik@gmail.com>
Carsten Dominik <dominik@science.uva.nl>
parents: 105166
diff changeset
220 (create
2a8a3a69c1c7 2009-10-01 Carsten Dominik <carsten.dominik@gmail.com>
Carsten Dominik <dominik@science.uva.nl>
parents: 105166
diff changeset
221 (setq id (org-id-new prefix))
2a8a3a69c1c7 2009-10-01 Carsten Dominik <carsten.dominik@gmail.com>
Carsten Dominik <dominik@science.uva.nl>
parents: 105166
diff changeset
222 (org-entry-put pom "ID" id)
2a8a3a69c1c7 2009-10-01 Carsten Dominik <carsten.dominik@gmail.com>
Carsten Dominik <dominik@science.uva.nl>
parents: 105166
diff changeset
223 (org-id-add-location id (buffer-file-name (buffer-base-buffer)))
2a8a3a69c1c7 2009-10-01 Carsten Dominik <carsten.dominik@gmail.com>
Carsten Dominik <dominik@science.uva.nl>
parents: 105166
diff changeset
224 id)
2a8a3a69c1c7 2009-10-01 Carsten Dominik <carsten.dominik@gmail.com>
Carsten Dominik <dominik@science.uva.nl>
parents: 105166
diff changeset
225 (t nil)))))
96045
19a1d523548c New file: org-id.el.
Carsten Dominik <dominik@science.uva.nl>
parents:
diff changeset
226
19a1d523548c New file: org-id.el.
Carsten Dominik <dominik@science.uva.nl>
parents:
diff changeset
227 ;;;###autoload
19a1d523548c New file: org-id.el.
Carsten Dominik <dominik@science.uva.nl>
parents:
diff changeset
228 (defun org-id-get-with-outline-path-completion (&optional targets)
19a1d523548c New file: org-id.el.
Carsten Dominik <dominik@science.uva.nl>
parents:
diff changeset
229 "Use outline-path-completion to retrieve the ID of an entry.
19a1d523548c New file: org-id.el.
Carsten Dominik <dominik@science.uva.nl>
parents:
diff changeset
230 TARGETS may be a setting for `org-refile-targets' to define the eligible
19a1d523548c New file: org-id.el.
Carsten Dominik <dominik@science.uva.nl>
parents:
diff changeset
231 headlines. When omitted, all headlines in all agenda files are
19a1d523548c New file: org-id.el.
Carsten Dominik <dominik@science.uva.nl>
parents:
diff changeset
232 eligible.
19a1d523548c New file: org-id.el.
Carsten Dominik <dominik@science.uva.nl>
parents:
diff changeset
233 It returns the ID of the entry. If necessary, the ID is created."
19a1d523548c New file: org-id.el.
Carsten Dominik <dominik@science.uva.nl>
parents:
diff changeset
234 (let* ((org-refile-targets (or targets '((nil . (:maxlevel . 10)))))
100267
c851df8e004e 2008-12-07 Carsten Dominik <carsten.dominik@gmail.com>
Carsten Dominik <dominik@science.uva.nl>
parents: 99866
diff changeset
235 (org-refile-use-outline-path
96045
19a1d523548c New file: org-id.el.
Carsten Dominik <dominik@science.uva.nl>
parents:
diff changeset
236 (if (caar org-refile-targets) 'file t))
104164
ac1a55cc2c38 2009-08-06 Carsten Dominik <carsten.dominik@gmail.com>
Carsten Dominik <dominik@science.uva.nl>
parents: 101757
diff changeset
237 (org-refile-target-verify-function nil)
96045
19a1d523548c New file: org-id.el.
Carsten Dominik <dominik@science.uva.nl>
parents:
diff changeset
238 (spos (org-refile-get-location "Entry: "))
100267
c851df8e004e 2008-12-07 Carsten Dominik <carsten.dominik@gmail.com>
Carsten Dominik <dominik@science.uva.nl>
parents: 99866
diff changeset
239 (pom (and spos (move-marker (make-marker) (nth 3 spos)
96045
19a1d523548c New file: org-id.el.
Carsten Dominik <dominik@science.uva.nl>
parents:
diff changeset
240 (get-file-buffer (nth 1 spos))))))
19a1d523548c New file: org-id.el.
Carsten Dominik <dominik@science.uva.nl>
parents:
diff changeset
241 (prog1 (org-id-get pom 'create)
19a1d523548c New file: org-id.el.
Carsten Dominik <dominik@science.uva.nl>
parents:
diff changeset
242 (move-marker pom nil))))
19a1d523548c New file: org-id.el.
Carsten Dominik <dominik@science.uva.nl>
parents:
diff changeset
243
19a1d523548c New file: org-id.el.
Carsten Dominik <dominik@science.uva.nl>
parents:
diff changeset
244 ;;;###autoload
19a1d523548c New file: org-id.el.
Carsten Dominik <dominik@science.uva.nl>
parents:
diff changeset
245 (defun org-id-get-with-outline-drilling (&optional targets)
19a1d523548c New file: org-id.el.
Carsten Dominik <dominik@science.uva.nl>
parents:
diff changeset
246 "Use an outline-cycling interface to retrieve the ID of an entry.
19a1d523548c New file: org-id.el.
Carsten Dominik <dominik@science.uva.nl>
parents:
diff changeset
247 This only finds entries in the current buffer, using `org-get-location'.
19a1d523548c New file: org-id.el.
Carsten Dominik <dominik@science.uva.nl>
parents:
diff changeset
248 It returns the ID of the entry. If necessary, the ID is created."
19a1d523548c New file: org-id.el.
Carsten Dominik <dominik@science.uva.nl>
parents:
diff changeset
249 (let* ((spos (org-get-location (current-buffer) org-goto-help))
19a1d523548c New file: org-id.el.
Carsten Dominik <dominik@science.uva.nl>
parents:
diff changeset
250 (pom (and spos (move-marker (make-marker) (car spos)))))
19a1d523548c New file: org-id.el.
Carsten Dominik <dominik@science.uva.nl>
parents:
diff changeset
251 (prog1 (org-id-get pom 'create)
19a1d523548c New file: org-id.el.
Carsten Dominik <dominik@science.uva.nl>
parents:
diff changeset
252 (move-marker pom nil))))
19a1d523548c New file: org-id.el.
Carsten Dominik <dominik@science.uva.nl>
parents:
diff changeset
253
19a1d523548c New file: org-id.el.
Carsten Dominik <dominik@science.uva.nl>
parents:
diff changeset
254 ;;;###autoload
19a1d523548c New file: org-id.el.
Carsten Dominik <dominik@science.uva.nl>
parents:
diff changeset
255 (defun org-id-goto (id)
19a1d523548c New file: org-id.el.
Carsten Dominik <dominik@science.uva.nl>
parents:
diff changeset
256 "Switch to the buffer containing the entry with id ID.
19a1d523548c New file: org-id.el.
Carsten Dominik <dominik@science.uva.nl>
parents:
diff changeset
257 Move the cursor to that entry in that buffer."
100448
cea079b68b76 2008-12-16 Carsten Dominik <carsten.dominik@gmail.com>
Carsten Dominik <dominik@science.uva.nl>
parents: 100269
diff changeset
258 (interactive "sID: ")
96045
19a1d523548c New file: org-id.el.
Carsten Dominik <dominik@science.uva.nl>
parents:
diff changeset
259 (let ((m (org-id-find id 'marker)))
19a1d523548c New file: org-id.el.
Carsten Dominik <dominik@science.uva.nl>
parents:
diff changeset
260 (unless m
19a1d523548c New file: org-id.el.
Carsten Dominik <dominik@science.uva.nl>
parents:
diff changeset
261 (error "Cannot find entry with ID \"%s\"" id))
19a1d523548c New file: org-id.el.
Carsten Dominik <dominik@science.uva.nl>
parents:
diff changeset
262 (switch-to-buffer (marker-buffer m))
19a1d523548c New file: org-id.el.
Carsten Dominik <dominik@science.uva.nl>
parents:
diff changeset
263 (goto-char m)
19a1d523548c New file: org-id.el.
Carsten Dominik <dominik@science.uva.nl>
parents:
diff changeset
264 (move-marker m nil)
100267
c851df8e004e 2008-12-07 Carsten Dominik <carsten.dominik@gmail.com>
Carsten Dominik <dominik@science.uva.nl>
parents: 99866
diff changeset
265 (org-show-context)))
96045
19a1d523548c New file: org-id.el.
Carsten Dominik <dominik@science.uva.nl>
parents:
diff changeset
266
19a1d523548c New file: org-id.el.
Carsten Dominik <dominik@science.uva.nl>
parents:
diff changeset
267 ;;;###autoload
19a1d523548c New file: org-id.el.
Carsten Dominik <dominik@science.uva.nl>
parents:
diff changeset
268 (defun org-id-find (id &optional markerp)
19a1d523548c New file: org-id.el.
Carsten Dominik <dominik@science.uva.nl>
parents:
diff changeset
269 "Return the location of the entry with the id ID.
19a1d523548c New file: org-id.el.
Carsten Dominik <dominik@science.uva.nl>
parents:
diff changeset
270 The return value is a cons cell (file-name . position), or nil
19a1d523548c New file: org-id.el.
Carsten Dominik <dominik@science.uva.nl>
parents:
diff changeset
271 if there is no entry with that ID.
19a1d523548c New file: org-id.el.
Carsten Dominik <dominik@science.uva.nl>
parents:
diff changeset
272 With optional argument MARKERP, return the position as a new marker."
101458
36abe982e7cd 2009-01-25 Carsten Dominik <carsten.dominik@gmail.com>
Carsten Dominik <dominik@science.uva.nl>
parents: 100908
diff changeset
273 (cond
36abe982e7cd 2009-01-25 Carsten Dominik <carsten.dominik@gmail.com>
Carsten Dominik <dominik@science.uva.nl>
parents: 100908
diff changeset
274 ((symbolp id) (setq id (symbol-name id)))
36abe982e7cd 2009-01-25 Carsten Dominik <carsten.dominik@gmail.com>
Carsten Dominik <dominik@science.uva.nl>
parents: 100908
diff changeset
275 ((numberp id) (setq id (number-to-string id))))
96045
19a1d523548c New file: org-id.el.
Carsten Dominik <dominik@science.uva.nl>
parents:
diff changeset
276 (let ((file (org-id-find-id-file id))
19a1d523548c New file: org-id.el.
Carsten Dominik <dominik@science.uva.nl>
parents:
diff changeset
277 org-agenda-new-buffers where)
19a1d523548c New file: org-id.el.
Carsten Dominik <dominik@science.uva.nl>
parents:
diff changeset
278 (when file
19a1d523548c New file: org-id.el.
Carsten Dominik <dominik@science.uva.nl>
parents:
diff changeset
279 (setq where (org-id-find-id-in-file id file markerp)))
19a1d523548c New file: org-id.el.
Carsten Dominik <dominik@science.uva.nl>
parents:
diff changeset
280 (unless where
19a1d523548c New file: org-id.el.
Carsten Dominik <dominik@science.uva.nl>
parents:
diff changeset
281 (org-id-update-id-locations)
19a1d523548c New file: org-id.el.
Carsten Dominik <dominik@science.uva.nl>
parents:
diff changeset
282 (setq file (org-id-find-id-file id))
19a1d523548c New file: org-id.el.
Carsten Dominik <dominik@science.uva.nl>
parents:
diff changeset
283 (when file
19a1d523548c New file: org-id.el.
Carsten Dominik <dominik@science.uva.nl>
parents:
diff changeset
284 (setq where (org-id-find-id-in-file id file markerp))))
19a1d523548c New file: org-id.el.
Carsten Dominik <dominik@science.uva.nl>
parents:
diff changeset
285 where))
19a1d523548c New file: org-id.el.
Carsten Dominik <dominik@science.uva.nl>
parents:
diff changeset
286
19a1d523548c New file: org-id.el.
Carsten Dominik <dominik@science.uva.nl>
parents:
diff changeset
287 ;;; Internal functions
19a1d523548c New file: org-id.el.
Carsten Dominik <dominik@science.uva.nl>
parents:
diff changeset
288
19a1d523548c New file: org-id.el.
Carsten Dominik <dominik@science.uva.nl>
parents:
diff changeset
289 ;; Creating new IDs
19a1d523548c New file: org-id.el.
Carsten Dominik <dominik@science.uva.nl>
parents:
diff changeset
290
19a1d523548c New file: org-id.el.
Carsten Dominik <dominik@science.uva.nl>
parents:
diff changeset
291 (defun org-id-new (&optional prefix)
19a1d523548c New file: org-id.el.
Carsten Dominik <dominik@science.uva.nl>
parents:
diff changeset
292 "Create a new globally unique ID.
19a1d523548c New file: org-id.el.
Carsten Dominik <dominik@science.uva.nl>
parents:
diff changeset
293
19a1d523548c New file: org-id.el.
Carsten Dominik <dominik@science.uva.nl>
parents:
diff changeset
294 An ID consists of two parts separated by a colon:
19a1d523548c New file: org-id.el.
Carsten Dominik <dominik@science.uva.nl>
parents:
diff changeset
295 - a prefix
98644
e1cc41b9282d 2008-10-12 Carsten Dominik <carsten.dominik@gmail.com>
Carsten Dominik <dominik@science.uva.nl>
parents: 97027
diff changeset
296 - a unique part that will be created according to `org-id-method'.
96045
19a1d523548c New file: org-id.el.
Carsten Dominik <dominik@science.uva.nl>
parents:
diff changeset
297
19a1d523548c New file: org-id.el.
Carsten Dominik <dominik@science.uva.nl>
parents:
diff changeset
298 PREFIX can specify the prefix, the default is given by the variable
19a1d523548c New file: org-id.el.
Carsten Dominik <dominik@science.uva.nl>
parents:
diff changeset
299 `org-id-prefix'. However, if PREFIX is the symbol `none', don't use any
19a1d523548c New file: org-id.el.
Carsten Dominik <dominik@science.uva.nl>
parents:
diff changeset
300 prefix even if `org-id-prefix' specifies one.
19a1d523548c New file: org-id.el.
Carsten Dominik <dominik@science.uva.nl>
parents:
diff changeset
301
19a1d523548c New file: org-id.el.
Carsten Dominik <dominik@science.uva.nl>
parents:
diff changeset
302 So a typical ID could look like \"Org:4nd91V40HI\"."
19a1d523548c New file: org-id.el.
Carsten Dominik <dominik@science.uva.nl>
parents:
diff changeset
303 (let* ((prefix (if (eq prefix 'none)
98644
e1cc41b9282d 2008-10-12 Carsten Dominik <carsten.dominik@gmail.com>
Carsten Dominik <dominik@science.uva.nl>
parents: 97027
diff changeset
304 ""
e1cc41b9282d 2008-10-12 Carsten Dominik <carsten.dominik@gmail.com>
Carsten Dominik <dominik@science.uva.nl>
parents: 97027
diff changeset
305 (concat (or prefix org-id-prefix) ":")))
e1cc41b9282d 2008-10-12 Carsten Dominik <carsten.dominik@gmail.com>
Carsten Dominik <dominik@science.uva.nl>
parents: 97027
diff changeset
306 unique)
e1cc41b9282d 2008-10-12 Carsten Dominik <carsten.dominik@gmail.com>
Carsten Dominik <dominik@science.uva.nl>
parents: 97027
diff changeset
307 (if (equal prefix ":") (setq prefix ""))
e1cc41b9282d 2008-10-12 Carsten Dominik <carsten.dominik@gmail.com>
Carsten Dominik <dominik@science.uva.nl>
parents: 97027
diff changeset
308 (cond
e1cc41b9282d 2008-10-12 Carsten Dominik <carsten.dominik@gmail.com>
Carsten Dominik <dominik@science.uva.nl>
parents: 97027
diff changeset
309 ((eq org-id-method 'uuidgen)
104164
ac1a55cc2c38 2009-08-06 Carsten Dominik <carsten.dominik@gmail.com>
Carsten Dominik <dominik@science.uva.nl>
parents: 101757
diff changeset
310 (setq unique (org-trim (shell-command-to-string org-id-uuid-program))))
98644
e1cc41b9282d 2008-10-12 Carsten Dominik <carsten.dominik@gmail.com>
Carsten Dominik <dominik@science.uva.nl>
parents: 97027
diff changeset
311 ((eq org-id-method 'org)
e1cc41b9282d 2008-10-12 Carsten Dominik <carsten.dominik@gmail.com>
Carsten Dominik <dominik@science.uva.nl>
parents: 97027
diff changeset
312 (let* ((etime (org-id-reverse-string (org-id-time-to-b36)))
e1cc41b9282d 2008-10-12 Carsten Dominik <carsten.dominik@gmail.com>
Carsten Dominik <dominik@science.uva.nl>
parents: 97027
diff changeset
313 (postfix (if org-id-include-domain
e1cc41b9282d 2008-10-12 Carsten Dominik <carsten.dominik@gmail.com>
Carsten Dominik <dominik@science.uva.nl>
parents: 97027
diff changeset
314 (progn
e1cc41b9282d 2008-10-12 Carsten Dominik <carsten.dominik@gmail.com>
Carsten Dominik <dominik@science.uva.nl>
parents: 97027
diff changeset
315 (require 'message)
e1cc41b9282d 2008-10-12 Carsten Dominik <carsten.dominik@gmail.com>
Carsten Dominik <dominik@science.uva.nl>
parents: 97027
diff changeset
316 (concat "@" (message-make-fqdn))))))
e1cc41b9282d 2008-10-12 Carsten Dominik <carsten.dominik@gmail.com>
Carsten Dominik <dominik@science.uva.nl>
parents: 97027
diff changeset
317 (setq unique (concat etime postfix))))
e1cc41b9282d 2008-10-12 Carsten Dominik <carsten.dominik@gmail.com>
Carsten Dominik <dominik@science.uva.nl>
parents: 97027
diff changeset
318 (t (error "Invalid `org-id-method'")))
e1cc41b9282d 2008-10-12 Carsten Dominik <carsten.dominik@gmail.com>
Carsten Dominik <dominik@science.uva.nl>
parents: 97027
diff changeset
319 (concat prefix unique)))
96045
19a1d523548c New file: org-id.el.
Carsten Dominik <dominik@science.uva.nl>
parents:
diff changeset
320
98644
e1cc41b9282d 2008-10-12 Carsten Dominik <carsten.dominik@gmail.com>
Carsten Dominik <dominik@science.uva.nl>
parents: 97027
diff changeset
321 (defun org-id-reverse-string (s)
e1cc41b9282d 2008-10-12 Carsten Dominik <carsten.dominik@gmail.com>
Carsten Dominik <dominik@science.uva.nl>
parents: 97027
diff changeset
322 (mapconcat 'char-to-string (nreverse (string-to-list s)) ""))
e1cc41b9282d 2008-10-12 Carsten Dominik <carsten.dominik@gmail.com>
Carsten Dominik <dominik@science.uva.nl>
parents: 97027
diff changeset
323
e1cc41b9282d 2008-10-12 Carsten Dominik <carsten.dominik@gmail.com>
Carsten Dominik <dominik@science.uva.nl>
parents: 97027
diff changeset
324 (defun org-id-int-to-b36-one-digit (i)
96045
19a1d523548c New file: org-id.el.
Carsten Dominik <dominik@science.uva.nl>
parents:
diff changeset
325 "Turn an integer between 0 and 61 into a single character 0..9, A..Z, a..z."
19a1d523548c New file: org-id.el.
Carsten Dominik <dominik@science.uva.nl>
parents:
diff changeset
326 (cond
19a1d523548c New file: org-id.el.
Carsten Dominik <dominik@science.uva.nl>
parents:
diff changeset
327 ((< i 10) (+ ?0 i))
98644
e1cc41b9282d 2008-10-12 Carsten Dominik <carsten.dominik@gmail.com>
Carsten Dominik <dominik@science.uva.nl>
parents: 97027
diff changeset
328 ((< i 36) (+ ?a i -10))
e1cc41b9282d 2008-10-12 Carsten Dominik <carsten.dominik@gmail.com>
Carsten Dominik <dominik@science.uva.nl>
parents: 97027
diff changeset
329 (t (error "Larger that 35"))))
96045
19a1d523548c New file: org-id.el.
Carsten Dominik <dominik@science.uva.nl>
parents:
diff changeset
330
98644
e1cc41b9282d 2008-10-12 Carsten Dominik <carsten.dominik@gmail.com>
Carsten Dominik <dominik@science.uva.nl>
parents: 97027
diff changeset
331 (defun org-id-b36-to-int-one-digit (i)
96045
19a1d523548c New file: org-id.el.
Carsten Dominik <dominik@science.uva.nl>
parents:
diff changeset
332 "Turn a character 0..9, A..Z, a..z into a number 0..61.
19a1d523548c New file: org-id.el.
Carsten Dominik <dominik@science.uva.nl>
parents:
diff changeset
333 The input I may be a character, or a single-letter string."
19a1d523548c New file: org-id.el.
Carsten Dominik <dominik@science.uva.nl>
parents:
diff changeset
334 (and (stringp i) (setq i (string-to-char i)))
19a1d523548c New file: org-id.el.
Carsten Dominik <dominik@science.uva.nl>
parents:
diff changeset
335 (cond
19a1d523548c New file: org-id.el.
Carsten Dominik <dominik@science.uva.nl>
parents:
diff changeset
336 ((and (>= i ?0) (<= i ?9)) (- i ?0))
98644
e1cc41b9282d 2008-10-12 Carsten Dominik <carsten.dominik@gmail.com>
Carsten Dominik <dominik@science.uva.nl>
parents: 97027
diff changeset
337 ((and (>= i ?a) (<= i ?z)) (+ (- i ?a) 10))
e1cc41b9282d 2008-10-12 Carsten Dominik <carsten.dominik@gmail.com>
Carsten Dominik <dominik@science.uva.nl>
parents: 97027
diff changeset
338 (t (error "Invalid b36 letter"))))
96045
19a1d523548c New file: org-id.el.
Carsten Dominik <dominik@science.uva.nl>
parents:
diff changeset
339
98644
e1cc41b9282d 2008-10-12 Carsten Dominik <carsten.dominik@gmail.com>
Carsten Dominik <dominik@science.uva.nl>
parents: 97027
diff changeset
340 (defun org-id-int-to-b36 (i &optional length)
e1cc41b9282d 2008-10-12 Carsten Dominik <carsten.dominik@gmail.com>
Carsten Dominik <dominik@science.uva.nl>
parents: 97027
diff changeset
341 "Convert an integer to a base-36 number represented as a string."
96045
19a1d523548c New file: org-id.el.
Carsten Dominik <dominik@science.uva.nl>
parents:
diff changeset
342 (let ((s ""))
19a1d523548c New file: org-id.el.
Carsten Dominik <dominik@science.uva.nl>
parents:
diff changeset
343 (while (> i 0)
19a1d523548c New file: org-id.el.
Carsten Dominik <dominik@science.uva.nl>
parents:
diff changeset
344 (setq s (concat (char-to-string
98644
e1cc41b9282d 2008-10-12 Carsten Dominik <carsten.dominik@gmail.com>
Carsten Dominik <dominik@science.uva.nl>
parents: 97027
diff changeset
345 (org-id-int-to-b36-one-digit (mod i 36))) s)
e1cc41b9282d 2008-10-12 Carsten Dominik <carsten.dominik@gmail.com>
Carsten Dominik <dominik@science.uva.nl>
parents: 97027
diff changeset
346 i (/ i 36)))
96045
19a1d523548c New file: org-id.el.
Carsten Dominik <dominik@science.uva.nl>
parents:
diff changeset
347 (setq length (max 1 (or length 1)))
19a1d523548c New file: org-id.el.
Carsten Dominik <dominik@science.uva.nl>
parents:
diff changeset
348 (if (< (length s) length)
19a1d523548c New file: org-id.el.
Carsten Dominik <dominik@science.uva.nl>
parents:
diff changeset
349 (setq s (concat (make-string (- length (length s)) ?0) s)))
19a1d523548c New file: org-id.el.
Carsten Dominik <dominik@science.uva.nl>
parents:
diff changeset
350 s))
19a1d523548c New file: org-id.el.
Carsten Dominik <dominik@science.uva.nl>
parents:
diff changeset
351
98644
e1cc41b9282d 2008-10-12 Carsten Dominik <carsten.dominik@gmail.com>
Carsten Dominik <dominik@science.uva.nl>
parents: 97027
diff changeset
352 (defun org-id-b36-to-int (s)
e1cc41b9282d 2008-10-12 Carsten Dominik <carsten.dominik@gmail.com>
Carsten Dominik <dominik@science.uva.nl>
parents: 97027
diff changeset
353 "Convert a base-36 string into the corresponding integer."
96045
19a1d523548c New file: org-id.el.
Carsten Dominik <dominik@science.uva.nl>
parents:
diff changeset
354 (let ((r 0))
98644
e1cc41b9282d 2008-10-12 Carsten Dominik <carsten.dominik@gmail.com>
Carsten Dominik <dominik@science.uva.nl>
parents: 97027
diff changeset
355 (mapc (lambda (i) (setq r (+ (* r 36) (org-id-b36-to-int-one-digit i))))
96045
19a1d523548c New file: org-id.el.
Carsten Dominik <dominik@science.uva.nl>
parents:
diff changeset
356 s)
19a1d523548c New file: org-id.el.
Carsten Dominik <dominik@science.uva.nl>
parents:
diff changeset
357 r))
19a1d523548c New file: org-id.el.
Carsten Dominik <dominik@science.uva.nl>
parents:
diff changeset
358
98644
e1cc41b9282d 2008-10-12 Carsten Dominik <carsten.dominik@gmail.com>
Carsten Dominik <dominik@science.uva.nl>
parents: 97027
diff changeset
359 (defun org-id-time-to-b36 (&optional time)
96045
19a1d523548c New file: org-id.el.
Carsten Dominik <dominik@science.uva.nl>
parents:
diff changeset
360 "Encode TIME as a 10-digit string.
19a1d523548c New file: org-id.el.
Carsten Dominik <dominik@science.uva.nl>
parents:
diff changeset
361 This string holds the time to micro-second accuracy, and can be decoded
19a1d523548c New file: org-id.el.
Carsten Dominik <dominik@science.uva.nl>
parents:
diff changeset
362 using `org-id-decode'."
19a1d523548c New file: org-id.el.
Carsten Dominik <dominik@science.uva.nl>
parents:
diff changeset
363 (setq time (or time (current-time)))
98644
e1cc41b9282d 2008-10-12 Carsten Dominik <carsten.dominik@gmail.com>
Carsten Dominik <dominik@science.uva.nl>
parents: 97027
diff changeset
364 (concat (org-id-int-to-b36 (nth 0 time) 4)
e1cc41b9282d 2008-10-12 Carsten Dominik <carsten.dominik@gmail.com>
Carsten Dominik <dominik@science.uva.nl>
parents: 97027
diff changeset
365 (org-id-int-to-b36 (nth 1 time) 4)
e1cc41b9282d 2008-10-12 Carsten Dominik <carsten.dominik@gmail.com>
Carsten Dominik <dominik@science.uva.nl>
parents: 97027
diff changeset
366 (org-id-int-to-b36 (or (nth 2 time) 0) 4)))
96045
19a1d523548c New file: org-id.el.
Carsten Dominik <dominik@science.uva.nl>
parents:
diff changeset
367
19a1d523548c New file: org-id.el.
Carsten Dominik <dominik@science.uva.nl>
parents:
diff changeset
368 (defun org-id-decode (id)
19a1d523548c New file: org-id.el.
Carsten Dominik <dominik@science.uva.nl>
parents:
diff changeset
369 "Split ID into the prefix and the time value that was used to create it.
19a1d523548c New file: org-id.el.
Carsten Dominik <dominik@science.uva.nl>
parents:
diff changeset
370 The return value is (prefix . time) where PREFIX is nil or a string,
19a1d523548c New file: org-id.el.
Carsten Dominik <dominik@science.uva.nl>
parents:
diff changeset
371 and time is the usual three-integer representation of time."
19a1d523548c New file: org-id.el.
Carsten Dominik <dominik@science.uva.nl>
parents:
diff changeset
372 (let (prefix time parts)
19a1d523548c New file: org-id.el.
Carsten Dominik <dominik@science.uva.nl>
parents:
diff changeset
373 (setq parts (org-split-string id ":"))
19a1d523548c New file: org-id.el.
Carsten Dominik <dominik@science.uva.nl>
parents:
diff changeset
374 (if (= 2 (length parts))
19a1d523548c New file: org-id.el.
Carsten Dominik <dominik@science.uva.nl>
parents:
diff changeset
375 (setq prefix (car parts) time (nth 1 parts))
19a1d523548c New file: org-id.el.
Carsten Dominik <dominik@science.uva.nl>
parents:
diff changeset
376 (setq prefix nil time (nth 0 parts)))
98644
e1cc41b9282d 2008-10-12 Carsten Dominik <carsten.dominik@gmail.com>
Carsten Dominik <dominik@science.uva.nl>
parents: 97027
diff changeset
377 (setq time (org-id-reverse-string time))
e1cc41b9282d 2008-10-12 Carsten Dominik <carsten.dominik@gmail.com>
Carsten Dominik <dominik@science.uva.nl>
parents: 97027
diff changeset
378 (setq time (list (org-id-b36-to-int (substring time 0 4))
e1cc41b9282d 2008-10-12 Carsten Dominik <carsten.dominik@gmail.com>
Carsten Dominik <dominik@science.uva.nl>
parents: 97027
diff changeset
379 (org-id-b36-to-int (substring time 4 8))
e1cc41b9282d 2008-10-12 Carsten Dominik <carsten.dominik@gmail.com>
Carsten Dominik <dominik@science.uva.nl>
parents: 97027
diff changeset
380 (org-id-b36-to-int (substring time 8 12))))
96045
19a1d523548c New file: org-id.el.
Carsten Dominik <dominik@science.uva.nl>
parents:
diff changeset
381 (cons prefix time)))
19a1d523548c New file: org-id.el.
Carsten Dominik <dominik@science.uva.nl>
parents:
diff changeset
382
19a1d523548c New file: org-id.el.
Carsten Dominik <dominik@science.uva.nl>
parents:
diff changeset
383 ;; Storing ID locations (files)
19a1d523548c New file: org-id.el.
Carsten Dominik <dominik@science.uva.nl>
parents:
diff changeset
384
100448
cea079b68b76 2008-12-16 Carsten Dominik <carsten.dominik@gmail.com>
Carsten Dominik <dominik@science.uva.nl>
parents: 100269
diff changeset
385 (defun org-id-update-id-locations (&optional files)
cea079b68b76 2008-12-16 Carsten Dominik <carsten.dominik@gmail.com>
Carsten Dominik <dominik@science.uva.nl>
parents: 100269
diff changeset
386 "Scan relevant files for IDs.
cea079b68b76 2008-12-16 Carsten Dominik <carsten.dominik@gmail.com>
Carsten Dominik <dominik@science.uva.nl>
parents: 100269
diff changeset
387 Store the relation between files and corresponding IDs.
cea079b68b76 2008-12-16 Carsten Dominik <carsten.dominik@gmail.com>
Carsten Dominik <dominik@science.uva.nl>
parents: 100269
diff changeset
388 This will scan all agenda files, all associated archives, and all
cea079b68b76 2008-12-16 Carsten Dominik <carsten.dominik@gmail.com>
Carsten Dominik <dominik@science.uva.nl>
parents: 100269
diff changeset
389 files currently mentioned in `org-id-locations'.
cea079b68b76 2008-12-16 Carsten Dominik <carsten.dominik@gmail.com>
Carsten Dominik <dominik@science.uva.nl>
parents: 100269
diff changeset
390 When FILES is given, scan these files instead.
100458
ba23e35d3eaf 2008-12-17 Carsten Dominik <carsten.dominik@gmail.com>
Carsten Dominik <dominik@science.uva.nl>
parents: 100448
diff changeset
391 When CHECK is given, prepare detailed information about duplicate IDs."
96045
19a1d523548c New file: org-id.el.
Carsten Dominik <dominik@science.uva.nl>
parents:
diff changeset
392 (interactive)
100448
cea079b68b76 2008-12-16 Carsten Dominik <carsten.dominik@gmail.com>
Carsten Dominik <dominik@science.uva.nl>
parents: 100269
diff changeset
393 (if (not org-id-track-globally)
105166
172e1951f385 * org.el (org-tree-to-indirect-buffer, org-convert-to-oddeven-levels)
Juanma Barranquero <lekktu@gmail.com>
parents: 104810
diff changeset
394 (error "Please turn on `org-id-track-globally' if you want to track IDs")
105973
b7d8222914b4 2009-11-13 Carsten Dominik <carsten.dominik@gmail.com>
Carsten Dominik <dominik@science.uva.nl>
parents: 105341
diff changeset
395 (let* ((org-id-search-archives
b7d8222914b4 2009-11-13 Carsten Dominik <carsten.dominik@gmail.com>
Carsten Dominik <dominik@science.uva.nl>
parents: 105341
diff changeset
396 (or org-id-search-archives
b7d8222914b4 2009-11-13 Carsten Dominik <carsten.dominik@gmail.com>
Carsten Dominik <dominik@science.uva.nl>
parents: 105341
diff changeset
397 (and (symbolp org-id-extra-files)
b7d8222914b4 2009-11-13 Carsten Dominik <carsten.dominik@gmail.com>
Carsten Dominik <dominik@science.uva.nl>
parents: 105341
diff changeset
398 (symbol-value org-id-extra-files)
b7d8222914b4 2009-11-13 Carsten Dominik <carsten.dominik@gmail.com>
Carsten Dominik <dominik@science.uva.nl>
parents: 105341
diff changeset
399 (member 'agenda-archives org-id-extra-files))))
b7d8222914b4 2009-11-13 Carsten Dominik <carsten.dominik@gmail.com>
Carsten Dominik <dominik@science.uva.nl>
parents: 105341
diff changeset
400 (files
b7d8222914b4 2009-11-13 Carsten Dominik <carsten.dominik@gmail.com>
Carsten Dominik <dominik@science.uva.nl>
parents: 105341
diff changeset
401 (or files
b7d8222914b4 2009-11-13 Carsten Dominik <carsten.dominik@gmail.com>
Carsten Dominik <dominik@science.uva.nl>
parents: 105341
diff changeset
402 (append
b7d8222914b4 2009-11-13 Carsten Dominik <carsten.dominik@gmail.com>
Carsten Dominik <dominik@science.uva.nl>
parents: 105341
diff changeset
403 ;; Agenda files and all associated archives
b7d8222914b4 2009-11-13 Carsten Dominik <carsten.dominik@gmail.com>
Carsten Dominik <dominik@science.uva.nl>
parents: 105341
diff changeset
404 (org-agenda-files t org-id-search-archives)
b7d8222914b4 2009-11-13 Carsten Dominik <carsten.dominik@gmail.com>
Carsten Dominik <dominik@science.uva.nl>
parents: 105341
diff changeset
405 ;; Explicit extra files
b7d8222914b4 2009-11-13 Carsten Dominik <carsten.dominik@gmail.com>
Carsten Dominik <dominik@science.uva.nl>
parents: 105341
diff changeset
406 (if (symbolp org-id-extra-files)
b7d8222914b4 2009-11-13 Carsten Dominik <carsten.dominik@gmail.com>
Carsten Dominik <dominik@science.uva.nl>
parents: 105341
diff changeset
407 (symbol-value org-id-extra-files)
b7d8222914b4 2009-11-13 Carsten Dominik <carsten.dominik@gmail.com>
Carsten Dominik <dominik@science.uva.nl>
parents: 105341
diff changeset
408 org-id-extra-files)
100448
cea079b68b76 2008-12-16 Carsten Dominik <carsten.dominik@gmail.com>
Carsten Dominik <dominik@science.uva.nl>
parents: 100269
diff changeset
409 ;; Files associated with live org-mode buffers
105973
b7d8222914b4 2009-11-13 Carsten Dominik <carsten.dominik@gmail.com>
Carsten Dominik <dominik@science.uva.nl>
parents: 105341
diff changeset
410 (delq nil
b7d8222914b4 2009-11-13 Carsten Dominik <carsten.dominik@gmail.com>
Carsten Dominik <dominik@science.uva.nl>
parents: 105341
diff changeset
411 (mapcar (lambda (b)
b7d8222914b4 2009-11-13 Carsten Dominik <carsten.dominik@gmail.com>
Carsten Dominik <dominik@science.uva.nl>
parents: 105341
diff changeset
412 (with-current-buffer b
b7d8222914b4 2009-11-13 Carsten Dominik <carsten.dominik@gmail.com>
Carsten Dominik <dominik@science.uva.nl>
parents: 105341
diff changeset
413 (and (org-mode-p) (buffer-file-name))))
b7d8222914b4 2009-11-13 Carsten Dominik <carsten.dominik@gmail.com>
Carsten Dominik <dominik@science.uva.nl>
parents: 105341
diff changeset
414 (buffer-list)))
b7d8222914b4 2009-11-13 Carsten Dominik <carsten.dominik@gmail.com>
Carsten Dominik <dominik@science.uva.nl>
parents: 105341
diff changeset
415 ;; All files known to have IDs
b7d8222914b4 2009-11-13 Carsten Dominik <carsten.dominik@gmail.com>
Carsten Dominik <dominik@science.uva.nl>
parents: 105341
diff changeset
416 org-id-files)))
b7d8222914b4 2009-11-13 Carsten Dominik <carsten.dominik@gmail.com>
Carsten Dominik <dominik@science.uva.nl>
parents: 105341
diff changeset
417 org-agenda-new-buffers
b7d8222914b4 2009-11-13 Carsten Dominik <carsten.dominik@gmail.com>
Carsten Dominik <dominik@science.uva.nl>
parents: 105341
diff changeset
418 file nfiles tfile ids reg found id seen (ndup 0))
b7d8222914b4 2009-11-13 Carsten Dominik <carsten.dominik@gmail.com>
Carsten Dominik <dominik@science.uva.nl>
parents: 105341
diff changeset
419 (when (member 'agenda-archives files)
b7d8222914b4 2009-11-13 Carsten Dominik <carsten.dominik@gmail.com>
Carsten Dominik <dominik@science.uva.nl>
parents: 105341
diff changeset
420 (setq files (delq 'agenda-archives (copy-sequence files))))
100448
cea079b68b76 2008-12-16 Carsten Dominik <carsten.dominik@gmail.com>
Carsten Dominik <dominik@science.uva.nl>
parents: 100269
diff changeset
421 (setq nfiles (length files))
cea079b68b76 2008-12-16 Carsten Dominik <carsten.dominik@gmail.com>
Carsten Dominik <dominik@science.uva.nl>
parents: 100269
diff changeset
422 (while (setq file (pop files))
cea079b68b76 2008-12-16 Carsten Dominik <carsten.dominik@gmail.com>
Carsten Dominik <dominik@science.uva.nl>
parents: 100269
diff changeset
423 (message "Finding ID locations (%d/%d files): %s"
cea079b68b76 2008-12-16 Carsten Dominik <carsten.dominik@gmail.com>
Carsten Dominik <dominik@science.uva.nl>
parents: 100269
diff changeset
424 (- nfiles (length files)) nfiles file)
cea079b68b76 2008-12-16 Carsten Dominik <carsten.dominik@gmail.com>
Carsten Dominik <dominik@science.uva.nl>
parents: 100269
diff changeset
425 (setq tfile (file-truename file))
cea079b68b76 2008-12-16 Carsten Dominik <carsten.dominik@gmail.com>
Carsten Dominik <dominik@science.uva.nl>
parents: 100269
diff changeset
426 (when (and (file-exists-p file) (not (member tfile seen)))
cea079b68b76 2008-12-16 Carsten Dominik <carsten.dominik@gmail.com>
Carsten Dominik <dominik@science.uva.nl>
parents: 100269
diff changeset
427 (push tfile seen)
cea079b68b76 2008-12-16 Carsten Dominik <carsten.dominik@gmail.com>
Carsten Dominik <dominik@science.uva.nl>
parents: 100269
diff changeset
428 (setq ids nil)
cea079b68b76 2008-12-16 Carsten Dominik <carsten.dominik@gmail.com>
Carsten Dominik <dominik@science.uva.nl>
parents: 100269
diff changeset
429 (with-current-buffer (org-get-agenda-file-buffer file)
cea079b68b76 2008-12-16 Carsten Dominik <carsten.dominik@gmail.com>
Carsten Dominik <dominik@science.uva.nl>
parents: 100269
diff changeset
430 (save-excursion
cea079b68b76 2008-12-16 Carsten Dominik <carsten.dominik@gmail.com>
Carsten Dominik <dominik@science.uva.nl>
parents: 100269
diff changeset
431 (save-restriction
cea079b68b76 2008-12-16 Carsten Dominik <carsten.dominik@gmail.com>
Carsten Dominik <dominik@science.uva.nl>
parents: 100269
diff changeset
432 (widen)
cea079b68b76 2008-12-16 Carsten Dominik <carsten.dominik@gmail.com>
Carsten Dominik <dominik@science.uva.nl>
parents: 100269
diff changeset
433 (goto-char (point-min))
cea079b68b76 2008-12-16 Carsten Dominik <carsten.dominik@gmail.com>
Carsten Dominik <dominik@science.uva.nl>
parents: 100269
diff changeset
434 (while (re-search-forward "^[ \t]*:ID:[ \t]+\\(\\S-+\\)[ \t]*$"
cea079b68b76 2008-12-16 Carsten Dominik <carsten.dominik@gmail.com>
Carsten Dominik <dominik@science.uva.nl>
parents: 100269
diff changeset
435 nil t)
cea079b68b76 2008-12-16 Carsten Dominik <carsten.dominik@gmail.com>
Carsten Dominik <dominik@science.uva.nl>
parents: 100269
diff changeset
436 (setq id (org-match-string-no-properties 1))
cea079b68b76 2008-12-16 Carsten Dominik <carsten.dominik@gmail.com>
Carsten Dominik <dominik@science.uva.nl>
parents: 100269
diff changeset
437 (if (member id found)
cea079b68b76 2008-12-16 Carsten Dominik <carsten.dominik@gmail.com>
Carsten Dominik <dominik@science.uva.nl>
parents: 100269
diff changeset
438 (progn
cea079b68b76 2008-12-16 Carsten Dominik <carsten.dominik@gmail.com>
Carsten Dominik <dominik@science.uva.nl>
parents: 100269
diff changeset
439 (message "Duplicate ID \"%s\", also in file %s"
105973
b7d8222914b4 2009-11-13 Carsten Dominik <carsten.dominik@gmail.com>
Carsten Dominik <dominik@science.uva.nl>
parents: 105341
diff changeset
440 id (or (car (delq
b7d8222914b4 2009-11-13 Carsten Dominik <carsten.dominik@gmail.com>
Carsten Dominik <dominik@science.uva.nl>
parents: 105341
diff changeset
441 nil
b7d8222914b4 2009-11-13 Carsten Dominik <carsten.dominik@gmail.com>
Carsten Dominik <dominik@science.uva.nl>
parents: 105341
diff changeset
442 (mapcar
b7d8222914b4 2009-11-13 Carsten Dominik <carsten.dominik@gmail.com>
Carsten Dominik <dominik@science.uva.nl>
parents: 105341
diff changeset
443 (lambda (x)
b7d8222914b4 2009-11-13 Carsten Dominik <carsten.dominik@gmail.com>
Carsten Dominik <dominik@science.uva.nl>
parents: 105341
diff changeset
444 (if (member id (cdr x))
b7d8222914b4 2009-11-13 Carsten Dominik <carsten.dominik@gmail.com>
Carsten Dominik <dominik@science.uva.nl>
parents: 105341
diff changeset
445 (car x)))
b7d8222914b4 2009-11-13 Carsten Dominik <carsten.dominik@gmail.com>
Carsten Dominik <dominik@science.uva.nl>
parents: 105341
diff changeset
446 reg)))
b7d8222914b4 2009-11-13 Carsten Dominik <carsten.dominik@gmail.com>
Carsten Dominik <dominik@science.uva.nl>
parents: 105341
diff changeset
447 (buffer-file-name)))
100448
cea079b68b76 2008-12-16 Carsten Dominik <carsten.dominik@gmail.com>
Carsten Dominik <dominik@science.uva.nl>
parents: 100269
diff changeset
448 (when (= ndup 0)
cea079b68b76 2008-12-16 Carsten Dominik <carsten.dominik@gmail.com>
Carsten Dominik <dominik@science.uva.nl>
parents: 100269
diff changeset
449 (ding)
cea079b68b76 2008-12-16 Carsten Dominik <carsten.dominik@gmail.com>
Carsten Dominik <dominik@science.uva.nl>
parents: 100269
diff changeset
450 (sit-for 2))
cea079b68b76 2008-12-16 Carsten Dominik <carsten.dominik@gmail.com>
Carsten Dominik <dominik@science.uva.nl>
parents: 100269
diff changeset
451 (setq ndup (1+ ndup)))
cea079b68b76 2008-12-16 Carsten Dominik <carsten.dominik@gmail.com>
Carsten Dominik <dominik@science.uva.nl>
parents: 100269
diff changeset
452 (push id found)
cea079b68b76 2008-12-16 Carsten Dominik <carsten.dominik@gmail.com>
Carsten Dominik <dominik@science.uva.nl>
parents: 100269
diff changeset
453 (push id ids)))
cea079b68b76 2008-12-16 Carsten Dominik <carsten.dominik@gmail.com>
Carsten Dominik <dominik@science.uva.nl>
parents: 100269
diff changeset
454 (push (cons (abbreviate-file-name file) ids) reg))))))
cea079b68b76 2008-12-16 Carsten Dominik <carsten.dominik@gmail.com>
Carsten Dominik <dominik@science.uva.nl>
parents: 100269
diff changeset
455 (org-release-buffers org-agenda-new-buffers)
cea079b68b76 2008-12-16 Carsten Dominik <carsten.dominik@gmail.com>
Carsten Dominik <dominik@science.uva.nl>
parents: 100269
diff changeset
456 (setq org-agenda-new-buffers nil)
cea079b68b76 2008-12-16 Carsten Dominik <carsten.dominik@gmail.com>
Carsten Dominik <dominik@science.uva.nl>
parents: 100269
diff changeset
457 (setq org-id-locations reg)
cea079b68b76 2008-12-16 Carsten Dominik <carsten.dominik@gmail.com>
Carsten Dominik <dominik@science.uva.nl>
parents: 100269
diff changeset
458 (setq org-id-files (mapcar 'car org-id-locations))
cea079b68b76 2008-12-16 Carsten Dominik <carsten.dominik@gmail.com>
Carsten Dominik <dominik@science.uva.nl>
parents: 100269
diff changeset
459 (org-id-locations-save) ;; this function can also handle the alist form
cea079b68b76 2008-12-16 Carsten Dominik <carsten.dominik@gmail.com>
Carsten Dominik <dominik@science.uva.nl>
parents: 100269
diff changeset
460 ;; now convert to a hash
cea079b68b76 2008-12-16 Carsten Dominik <carsten.dominik@gmail.com>
Carsten Dominik <dominik@science.uva.nl>
parents: 100269
diff changeset
461 (setq org-id-locations (org-id-alist-to-hash org-id-locations))
cea079b68b76 2008-12-16 Carsten Dominik <carsten.dominik@gmail.com>
Carsten Dominik <dominik@science.uva.nl>
parents: 100269
diff changeset
462 (if (> ndup 0)
cea079b68b76 2008-12-16 Carsten Dominik <carsten.dominik@gmail.com>
Carsten Dominik <dominik@science.uva.nl>
parents: 100269
diff changeset
463 (message "WARNING: %d duplicate IDs found, check *Messages* buffer" ndup)
cea079b68b76 2008-12-16 Carsten Dominik <carsten.dominik@gmail.com>
Carsten Dominik <dominik@science.uva.nl>
parents: 100269
diff changeset
464 (message "%d unique files scanned for IDs" (length org-id-files)))
cea079b68b76 2008-12-16 Carsten Dominik <carsten.dominik@gmail.com>
Carsten Dominik <dominik@science.uva.nl>
parents: 100269
diff changeset
465 org-id-locations)))
96045
19a1d523548c New file: org-id.el.
Carsten Dominik <dominik@science.uva.nl>
parents:
diff changeset
466
19a1d523548c New file: org-id.el.
Carsten Dominik <dominik@science.uva.nl>
parents:
diff changeset
467 (defun org-id-locations-save ()
19a1d523548c New file: org-id.el.
Carsten Dominik <dominik@science.uva.nl>
parents:
diff changeset
468 "Save `org-id-locations' in `org-id-locations-file'."
100448
cea079b68b76 2008-12-16 Carsten Dominik <carsten.dominik@gmail.com>
Carsten Dominik <dominik@science.uva.nl>
parents: 100269
diff changeset
469 (when org-id-track-globally
cea079b68b76 2008-12-16 Carsten Dominik <carsten.dominik@gmail.com>
Carsten Dominik <dominik@science.uva.nl>
parents: 100269
diff changeset
470 (let ((out (if (hash-table-p org-id-locations)
cea079b68b76 2008-12-16 Carsten Dominik <carsten.dominik@gmail.com>
Carsten Dominik <dominik@science.uva.nl>
parents: 100269
diff changeset
471 (org-id-hash-to-alist org-id-locations)
cea079b68b76 2008-12-16 Carsten Dominik <carsten.dominik@gmail.com>
Carsten Dominik <dominik@science.uva.nl>
parents: 100269
diff changeset
472 org-id-locations)))
cea079b68b76 2008-12-16 Carsten Dominik <carsten.dominik@gmail.com>
Carsten Dominik <dominik@science.uva.nl>
parents: 100269
diff changeset
473 (with-temp-file org-id-locations-file
cea079b68b76 2008-12-16 Carsten Dominik <carsten.dominik@gmail.com>
Carsten Dominik <dominik@science.uva.nl>
parents: 100269
diff changeset
474 (print out (current-buffer))))))
96045
19a1d523548c New file: org-id.el.
Carsten Dominik <dominik@science.uva.nl>
parents:
diff changeset
475
19a1d523548c New file: org-id.el.
Carsten Dominik <dominik@science.uva.nl>
parents:
diff changeset
476 (defun org-id-locations-load ()
19a1d523548c New file: org-id.el.
Carsten Dominik <dominik@science.uva.nl>
parents:
diff changeset
477 "Read the data from `org-id-locations-file'."
19a1d523548c New file: org-id.el.
Carsten Dominik <dominik@science.uva.nl>
parents:
diff changeset
478 (setq org-id-locations nil)
100448
cea079b68b76 2008-12-16 Carsten Dominik <carsten.dominik@gmail.com>
Carsten Dominik <dominik@science.uva.nl>
parents: 100269
diff changeset
479 (when org-id-track-globally
cea079b68b76 2008-12-16 Carsten Dominik <carsten.dominik@gmail.com>
Carsten Dominik <dominik@science.uva.nl>
parents: 100269
diff changeset
480 (with-temp-buffer
cea079b68b76 2008-12-16 Carsten Dominik <carsten.dominik@gmail.com>
Carsten Dominik <dominik@science.uva.nl>
parents: 100269
diff changeset
481 (condition-case nil
cea079b68b76 2008-12-16 Carsten Dominik <carsten.dominik@gmail.com>
Carsten Dominik <dominik@science.uva.nl>
parents: 100269
diff changeset
482 (progn
cea079b68b76 2008-12-16 Carsten Dominik <carsten.dominik@gmail.com>
Carsten Dominik <dominik@science.uva.nl>
parents: 100269
diff changeset
483 (insert-file-contents-literally org-id-locations-file)
cea079b68b76 2008-12-16 Carsten Dominik <carsten.dominik@gmail.com>
Carsten Dominik <dominik@science.uva.nl>
parents: 100269
diff changeset
484 (goto-char (point-min))
cea079b68b76 2008-12-16 Carsten Dominik <carsten.dominik@gmail.com>
Carsten Dominik <dominik@science.uva.nl>
parents: 100269
diff changeset
485 (setq org-id-locations (read (current-buffer))))
cea079b68b76 2008-12-16 Carsten Dominik <carsten.dominik@gmail.com>
Carsten Dominik <dominik@science.uva.nl>
parents: 100269
diff changeset
486 (error
cea079b68b76 2008-12-16 Carsten Dominik <carsten.dominik@gmail.com>
Carsten Dominik <dominik@science.uva.nl>
parents: 100269
diff changeset
487 (message "Could not read org-id-values from %s. Setting it to nil."
cea079b68b76 2008-12-16 Carsten Dominik <carsten.dominik@gmail.com>
Carsten Dominik <dominik@science.uva.nl>
parents: 100269
diff changeset
488 org-id-locations-file))))
cea079b68b76 2008-12-16 Carsten Dominik <carsten.dominik@gmail.com>
Carsten Dominik <dominik@science.uva.nl>
parents: 100269
diff changeset
489 (setq org-id-files (mapcar 'car org-id-locations))
cea079b68b76 2008-12-16 Carsten Dominik <carsten.dominik@gmail.com>
Carsten Dominik <dominik@science.uva.nl>
parents: 100269
diff changeset
490 (setq org-id-locations (org-id-alist-to-hash org-id-locations))))
96045
19a1d523548c New file: org-id.el.
Carsten Dominik <dominik@science.uva.nl>
parents:
diff changeset
491
19a1d523548c New file: org-id.el.
Carsten Dominik <dominik@science.uva.nl>
parents:
diff changeset
492 (defun org-id-add-location (id file)
100458
ba23e35d3eaf 2008-12-17 Carsten Dominik <carsten.dominik@gmail.com>
Carsten Dominik <dominik@science.uva.nl>
parents: 100448
diff changeset
493 "Add the ID with location FILE to the database of ID locations."
100448
cea079b68b76 2008-12-16 Carsten Dominik <carsten.dominik@gmail.com>
Carsten Dominik <dominik@science.uva.nl>
parents: 100269
diff changeset
494 ;; Only if global tracking is on, and when the buffer has a file
100458
ba23e35d3eaf 2008-12-17 Carsten Dominik <carsten.dominik@gmail.com>
Carsten Dominik <dominik@science.uva.nl>
parents: 100448
diff changeset
495 (when (and org-id-track-globally id file)
99849
621e15919df0 2008-11-23 Carsten Dominik <carsten.dominik@gmail.com>
Carsten Dominik <dominik@science.uva.nl>
parents: 99501
diff changeset
496 (unless org-id-locations (org-id-locations-load))
100448
cea079b68b76 2008-12-16 Carsten Dominik <carsten.dominik@gmail.com>
Carsten Dominik <dominik@science.uva.nl>
parents: 100269
diff changeset
497 (puthash id (abbreviate-file-name file) org-id-locations)
cea079b68b76 2008-12-16 Carsten Dominik <carsten.dominik@gmail.com>
Carsten Dominik <dominik@science.uva.nl>
parents: 100269
diff changeset
498 (add-to-list 'org-id-files (abbreviate-file-name file))))
cea079b68b76 2008-12-16 Carsten Dominik <carsten.dominik@gmail.com>
Carsten Dominik <dominik@science.uva.nl>
parents: 100269
diff changeset
499
cea079b68b76 2008-12-16 Carsten Dominik <carsten.dominik@gmail.com>
Carsten Dominik <dominik@science.uva.nl>
parents: 100269
diff changeset
500 (add-hook 'kill-emacs-hook 'org-id-locations-save)
cea079b68b76 2008-12-16 Carsten Dominik <carsten.dominik@gmail.com>
Carsten Dominik <dominik@science.uva.nl>
parents: 100269
diff changeset
501
cea079b68b76 2008-12-16 Carsten Dominik <carsten.dominik@gmail.com>
Carsten Dominik <dominik@science.uva.nl>
parents: 100269
diff changeset
502 (defun org-id-hash-to-alist (hash)
cea079b68b76 2008-12-16 Carsten Dominik <carsten.dominik@gmail.com>
Carsten Dominik <dominik@science.uva.nl>
parents: 100269
diff changeset
503 "Turn an org-id hash into an alist, so that it can be written to a file."
cea079b68b76 2008-12-16 Carsten Dominik <carsten.dominik@gmail.com>
Carsten Dominik <dominik@science.uva.nl>
parents: 100269
diff changeset
504 (let (res x)
cea079b68b76 2008-12-16 Carsten Dominik <carsten.dominik@gmail.com>
Carsten Dominik <dominik@science.uva.nl>
parents: 100269
diff changeset
505 (maphash
cea079b68b76 2008-12-16 Carsten Dominik <carsten.dominik@gmail.com>
Carsten Dominik <dominik@science.uva.nl>
parents: 100269
diff changeset
506 (lambda (k v)
cea079b68b76 2008-12-16 Carsten Dominik <carsten.dominik@gmail.com>
Carsten Dominik <dominik@science.uva.nl>
parents: 100269
diff changeset
507 (if (setq x (member v res))
cea079b68b76 2008-12-16 Carsten Dominik <carsten.dominik@gmail.com>
Carsten Dominik <dominik@science.uva.nl>
parents: 100269
diff changeset
508 (setcdr x (cons k (cdr x)))
cea079b68b76 2008-12-16 Carsten Dominik <carsten.dominik@gmail.com>
Carsten Dominik <dominik@science.uva.nl>
parents: 100269
diff changeset
509 (push (list v k) res)))
cea079b68b76 2008-12-16 Carsten Dominik <carsten.dominik@gmail.com>
Carsten Dominik <dominik@science.uva.nl>
parents: 100269
diff changeset
510 hash)
cea079b68b76 2008-12-16 Carsten Dominik <carsten.dominik@gmail.com>
Carsten Dominik <dominik@science.uva.nl>
parents: 100269
diff changeset
511 res))
cea079b68b76 2008-12-16 Carsten Dominik <carsten.dominik@gmail.com>
Carsten Dominik <dominik@science.uva.nl>
parents: 100269
diff changeset
512
cea079b68b76 2008-12-16 Carsten Dominik <carsten.dominik@gmail.com>
Carsten Dominik <dominik@science.uva.nl>
parents: 100269
diff changeset
513 (defun org-id-alist-to-hash (list)
cea079b68b76 2008-12-16 Carsten Dominik <carsten.dominik@gmail.com>
Carsten Dominik <dominik@science.uva.nl>
parents: 100269
diff changeset
514 "Turn an org-id location list into a hash table."
cea079b68b76 2008-12-16 Carsten Dominik <carsten.dominik@gmail.com>
Carsten Dominik <dominik@science.uva.nl>
parents: 100269
diff changeset
515 (let ((res (make-hash-table
cea079b68b76 2008-12-16 Carsten Dominik <carsten.dominik@gmail.com>
Carsten Dominik <dominik@science.uva.nl>
parents: 100269
diff changeset
516 :test 'equal
cea079b68b76 2008-12-16 Carsten Dominik <carsten.dominik@gmail.com>
Carsten Dominik <dominik@science.uva.nl>
parents: 100269
diff changeset
517 :size (apply '+ (mapcar 'length list))))
101568
f5aedb5cbd80 2009-01-27 Carsten Dominik <carsten.dominik@gmail.com>
Carsten Dominik <dominik@science.uva.nl>
parents: 101458
diff changeset
518 f)
100448
cea079b68b76 2008-12-16 Carsten Dominik <carsten.dominik@gmail.com>
Carsten Dominik <dominik@science.uva.nl>
parents: 100269
diff changeset
519 (mapc
cea079b68b76 2008-12-16 Carsten Dominik <carsten.dominik@gmail.com>
Carsten Dominik <dominik@science.uva.nl>
parents: 100269
diff changeset
520 (lambda (x)
cea079b68b76 2008-12-16 Carsten Dominik <carsten.dominik@gmail.com>
Carsten Dominik <dominik@science.uva.nl>
parents: 100269
diff changeset
521 (setq f (car x))
cea079b68b76 2008-12-16 Carsten Dominik <carsten.dominik@gmail.com>
Carsten Dominik <dominik@science.uva.nl>
parents: 100269
diff changeset
522 (mapc (lambda (i) (puthash i f res)) (cdr x)))
cea079b68b76 2008-12-16 Carsten Dominik <carsten.dominik@gmail.com>
Carsten Dominik <dominik@science.uva.nl>
parents: 100269
diff changeset
523 list)
cea079b68b76 2008-12-16 Carsten Dominik <carsten.dominik@gmail.com>
Carsten Dominik <dominik@science.uva.nl>
parents: 100269
diff changeset
524 res))
cea079b68b76 2008-12-16 Carsten Dominik <carsten.dominik@gmail.com>
Carsten Dominik <dominik@science.uva.nl>
parents: 100269
diff changeset
525
cea079b68b76 2008-12-16 Carsten Dominik <carsten.dominik@gmail.com>
Carsten Dominik <dominik@science.uva.nl>
parents: 100269
diff changeset
526 (defun org-id-paste-tracker (txt &optional buffer-or-file)
cea079b68b76 2008-12-16 Carsten Dominik <carsten.dominik@gmail.com>
Carsten Dominik <dominik@science.uva.nl>
parents: 100269
diff changeset
527 "Update any IDs in TXT and assign BUFFER-OR-FILE to them."
cea079b68b76 2008-12-16 Carsten Dominik <carsten.dominik@gmail.com>
Carsten Dominik <dominik@science.uva.nl>
parents: 100269
diff changeset
528 (when org-id-track-globally
cea079b68b76 2008-12-16 Carsten Dominik <carsten.dominik@gmail.com>
Carsten Dominik <dominik@science.uva.nl>
parents: 100269
diff changeset
529 (save-match-data
cea079b68b76 2008-12-16 Carsten Dominik <carsten.dominik@gmail.com>
Carsten Dominik <dominik@science.uva.nl>
parents: 100269
diff changeset
530 (setq buffer-or-file (or buffer-or-file (current-buffer)))
cea079b68b76 2008-12-16 Carsten Dominik <carsten.dominik@gmail.com>
Carsten Dominik <dominik@science.uva.nl>
parents: 100269
diff changeset
531 (when (bufferp buffer-or-file)
cea079b68b76 2008-12-16 Carsten Dominik <carsten.dominik@gmail.com>
Carsten Dominik <dominik@science.uva.nl>
parents: 100269
diff changeset
532 (setq buffer-or-file (or (buffer-base-buffer buffer-or-file)
cea079b68b76 2008-12-16 Carsten Dominik <carsten.dominik@gmail.com>
Carsten Dominik <dominik@science.uva.nl>
parents: 100269
diff changeset
533 buffer-or-file))
cea079b68b76 2008-12-16 Carsten Dominik <carsten.dominik@gmail.com>
Carsten Dominik <dominik@science.uva.nl>
parents: 100269
diff changeset
534 (setq buffer-or-file (buffer-file-name buffer-or-file)))
cea079b68b76 2008-12-16 Carsten Dominik <carsten.dominik@gmail.com>
Carsten Dominik <dominik@science.uva.nl>
parents: 100269
diff changeset
535 (when buffer-or-file
cea079b68b76 2008-12-16 Carsten Dominik <carsten.dominik@gmail.com>
Carsten Dominik <dominik@science.uva.nl>
parents: 100269
diff changeset
536 (let ((fname (abbreviate-file-name buffer-or-file))
cea079b68b76 2008-12-16 Carsten Dominik <carsten.dominik@gmail.com>
Carsten Dominik <dominik@science.uva.nl>
parents: 100269
diff changeset
537 (s 0))
cea079b68b76 2008-12-16 Carsten Dominik <carsten.dominik@gmail.com>
Carsten Dominik <dominik@science.uva.nl>
parents: 100269
diff changeset
538 (while (string-match "^[ \t]*:ID:[ \t]+\\([^ \t\n\r]+\\)" txt s)
cea079b68b76 2008-12-16 Carsten Dominik <carsten.dominik@gmail.com>
Carsten Dominik <dominik@science.uva.nl>
parents: 100269
diff changeset
539 (setq s (match-end 0))
cea079b68b76 2008-12-16 Carsten Dominik <carsten.dominik@gmail.com>
Carsten Dominik <dominik@science.uva.nl>
parents: 100269
diff changeset
540 (org-id-add-location (match-string 1 txt) fname)))))))
96045
19a1d523548c New file: org-id.el.
Carsten Dominik <dominik@science.uva.nl>
parents:
diff changeset
541
19a1d523548c New file: org-id.el.
Carsten Dominik <dominik@science.uva.nl>
parents:
diff changeset
542 ;; Finding entries with specified id
19a1d523548c New file: org-id.el.
Carsten Dominik <dominik@science.uva.nl>
parents:
diff changeset
543
101458
36abe982e7cd 2009-01-25 Carsten Dominik <carsten.dominik@gmail.com>
Carsten Dominik <dominik@science.uva.nl>
parents: 100908
diff changeset
544 ;;;###autoload
96045
19a1d523548c New file: org-id.el.
Carsten Dominik <dominik@science.uva.nl>
parents:
diff changeset
545 (defun org-id-find-id-file (id)
19a1d523548c New file: org-id.el.
Carsten Dominik <dominik@science.uva.nl>
parents:
diff changeset
546 "Query the id database for the file in which this ID is located."
19a1d523548c New file: org-id.el.
Carsten Dominik <dominik@science.uva.nl>
parents:
diff changeset
547 (unless org-id-locations (org-id-locations-load))
100448
cea079b68b76 2008-12-16 Carsten Dominik <carsten.dominik@gmail.com>
Carsten Dominik <dominik@science.uva.nl>
parents: 100269
diff changeset
548 (or (gethash id org-id-locations)
cea079b68b76 2008-12-16 Carsten Dominik <carsten.dominik@gmail.com>
Carsten Dominik <dominik@science.uva.nl>
parents: 100269
diff changeset
549 ;; ball back on current buffer
cea079b68b76 2008-12-16 Carsten Dominik <carsten.dominik@gmail.com>
Carsten Dominik <dominik@science.uva.nl>
parents: 100269
diff changeset
550 (buffer-file-name (or (buffer-base-buffer (current-buffer))
cea079b68b76 2008-12-16 Carsten Dominik <carsten.dominik@gmail.com>
Carsten Dominik <dominik@science.uva.nl>
parents: 100269
diff changeset
551 (current-buffer)))))
96045
19a1d523548c New file: org-id.el.
Carsten Dominik <dominik@science.uva.nl>
parents:
diff changeset
552
19a1d523548c New file: org-id.el.
Carsten Dominik <dominik@science.uva.nl>
parents:
diff changeset
553 (defun org-id-find-id-in-file (id file &optional markerp)
19a1d523548c New file: org-id.el.
Carsten Dominik <dominik@science.uva.nl>
parents:
diff changeset
554 "Return the position of the entry ID in FILE.
19a1d523548c New file: org-id.el.
Carsten Dominik <dominik@science.uva.nl>
parents:
diff changeset
555 If that files does not exist, or if it does not contain this ID,
19a1d523548c New file: org-id.el.
Carsten Dominik <dominik@science.uva.nl>
parents:
diff changeset
556 return nil.
19a1d523548c New file: org-id.el.
Carsten Dominik <dominik@science.uva.nl>
parents:
diff changeset
557 The position is returned as a cons cell (file-name . position). With
19a1d523548c New file: org-id.el.
Carsten Dominik <dominik@science.uva.nl>
parents:
diff changeset
558 optional argument MARKERP, return the position as a new marker."
101568
f5aedb5cbd80 2009-01-27 Carsten Dominik <carsten.dominik@gmail.com>
Carsten Dominik <dominik@science.uva.nl>
parents: 101458
diff changeset
559 (let (org-agenda-new-buffers buf pos)
96045
19a1d523548c New file: org-id.el.
Carsten Dominik <dominik@science.uva.nl>
parents:
diff changeset
560 (cond
19a1d523548c New file: org-id.el.
Carsten Dominik <dominik@science.uva.nl>
parents:
diff changeset
561 ((not file) nil)
19a1d523548c New file: org-id.el.
Carsten Dominik <dominik@science.uva.nl>
parents:
diff changeset
562 ((not (file-exists-p file)) nil)
19a1d523548c New file: org-id.el.
Carsten Dominik <dominik@science.uva.nl>
parents:
diff changeset
563 (t (with-current-buffer (setq buf (org-get-agenda-file-buffer file))
19a1d523548c New file: org-id.el.
Carsten Dominik <dominik@science.uva.nl>
parents:
diff changeset
564 (setq pos (org-find-entry-with-id id))
19a1d523548c New file: org-id.el.
Carsten Dominik <dominik@science.uva.nl>
parents:
diff changeset
565 (when pos
19a1d523548c New file: org-id.el.
Carsten Dominik <dominik@science.uva.nl>
parents:
diff changeset
566 (if markerp
19a1d523548c New file: org-id.el.
Carsten Dominik <dominik@science.uva.nl>
parents:
diff changeset
567 (move-marker (make-marker) pos buf)
19a1d523548c New file: org-id.el.
Carsten Dominik <dominik@science.uva.nl>
parents:
diff changeset
568 (cons file pos))))))))
19a1d523548c New file: org-id.el.
Carsten Dominik <dominik@science.uva.nl>
parents:
diff changeset
569
100448
cea079b68b76 2008-12-16 Carsten Dominik <carsten.dominik@gmail.com>
Carsten Dominik <dominik@science.uva.nl>
parents: 100269
diff changeset
570 ;; id link type
cea079b68b76 2008-12-16 Carsten Dominik <carsten.dominik@gmail.com>
Carsten Dominik <dominik@science.uva.nl>
parents: 100269
diff changeset
571
cea079b68b76 2008-12-16 Carsten Dominik <carsten.dominik@gmail.com>
Carsten Dominik <dominik@science.uva.nl>
parents: 100269
diff changeset
572 ;; Calling the following function is hard-coded into `org-store-link',
cea079b68b76 2008-12-16 Carsten Dominik <carsten.dominik@gmail.com>
Carsten Dominik <dominik@science.uva.nl>
parents: 100269
diff changeset
573 ;; so we do have to add it to `org-store-link-functions'.
cea079b68b76 2008-12-16 Carsten Dominik <carsten.dominik@gmail.com>
Carsten Dominik <dominik@science.uva.nl>
parents: 100269
diff changeset
574
cea079b68b76 2008-12-16 Carsten Dominik <carsten.dominik@gmail.com>
Carsten Dominik <dominik@science.uva.nl>
parents: 100269
diff changeset
575 (defun org-id-store-link ()
104810
86b7fe7d1d8f 2009-09-02 Carsten Dominik <carsten.dominik@gmail.com>
Carsten Dominik <dominik@science.uva.nl>
parents: 104201
diff changeset
576 "Store a link to the current entry, using its ID."
100448
cea079b68b76 2008-12-16 Carsten Dominik <carsten.dominik@gmail.com>
Carsten Dominik <dominik@science.uva.nl>
parents: 100269
diff changeset
577 (interactive)
cea079b68b76 2008-12-16 Carsten Dominik <carsten.dominik@gmail.com>
Carsten Dominik <dominik@science.uva.nl>
parents: 100269
diff changeset
578 (let* ((link (org-make-link "id:" (org-id-get-create)))
cea079b68b76 2008-12-16 Carsten Dominik <carsten.dominik@gmail.com>
Carsten Dominik <dominik@science.uva.nl>
parents: 100269
diff changeset
579 (desc (save-excursion
cea079b68b76 2008-12-16 Carsten Dominik <carsten.dominik@gmail.com>
Carsten Dominik <dominik@science.uva.nl>
parents: 100269
diff changeset
580 (org-back-to-heading t)
cea079b68b76 2008-12-16 Carsten Dominik <carsten.dominik@gmail.com>
Carsten Dominik <dominik@science.uva.nl>
parents: 100269
diff changeset
581 (or (and (looking-at org-complex-heading-regexp)
cea079b68b76 2008-12-16 Carsten Dominik <carsten.dominik@gmail.com>
Carsten Dominik <dominik@science.uva.nl>
parents: 100269
diff changeset
582 (if (match-end 4) (match-string 4) (match-string 0)))
cea079b68b76 2008-12-16 Carsten Dominik <carsten.dominik@gmail.com>
Carsten Dominik <dominik@science.uva.nl>
parents: 100269
diff changeset
583 link))))
cea079b68b76 2008-12-16 Carsten Dominik <carsten.dominik@gmail.com>
Carsten Dominik <dominik@science.uva.nl>
parents: 100269
diff changeset
584 (org-store-link-props :link link :description desc :type "id")
cea079b68b76 2008-12-16 Carsten Dominik <carsten.dominik@gmail.com>
Carsten Dominik <dominik@science.uva.nl>
parents: 100269
diff changeset
585 link))
cea079b68b76 2008-12-16 Carsten Dominik <carsten.dominik@gmail.com>
Carsten Dominik <dominik@science.uva.nl>
parents: 100269
diff changeset
586
cea079b68b76 2008-12-16 Carsten Dominik <carsten.dominik@gmail.com>
Carsten Dominik <dominik@science.uva.nl>
parents: 100269
diff changeset
587 (defun org-id-open (id)
cea079b68b76 2008-12-16 Carsten Dominik <carsten.dominik@gmail.com>
Carsten Dominik <dominik@science.uva.nl>
parents: 100269
diff changeset
588 "Go to the entry with id ID."
cea079b68b76 2008-12-16 Carsten Dominik <carsten.dominik@gmail.com>
Carsten Dominik <dominik@science.uva.nl>
parents: 100269
diff changeset
589 (org-mark-ring-push)
104164
ac1a55cc2c38 2009-08-06 Carsten Dominik <carsten.dominik@gmail.com>
Carsten Dominik <dominik@science.uva.nl>
parents: 101757
diff changeset
590 (let ((m (org-id-find id 'marker))
ac1a55cc2c38 2009-08-06 Carsten Dominik <carsten.dominik@gmail.com>
Carsten Dominik <dominik@science.uva.nl>
parents: 101757
diff changeset
591 cmd)
100448
cea079b68b76 2008-12-16 Carsten Dominik <carsten.dominik@gmail.com>
Carsten Dominik <dominik@science.uva.nl>
parents: 100269
diff changeset
592 (unless m
cea079b68b76 2008-12-16 Carsten Dominik <carsten.dominik@gmail.com>
Carsten Dominik <dominik@science.uva.nl>
parents: 100269
diff changeset
593 (error "Cannot find entry with ID \"%s\"" id))
104164
ac1a55cc2c38 2009-08-06 Carsten Dominik <carsten.dominik@gmail.com>
Carsten Dominik <dominik@science.uva.nl>
parents: 101757
diff changeset
594 ;; Use a buffer-switching command in analogy to finding files
ac1a55cc2c38 2009-08-06 Carsten Dominik <carsten.dominik@gmail.com>
Carsten Dominik <dominik@science.uva.nl>
parents: 101757
diff changeset
595 (setq cmd
ac1a55cc2c38 2009-08-06 Carsten Dominik <carsten.dominik@gmail.com>
Carsten Dominik <dominik@science.uva.nl>
parents: 101757
diff changeset
596 (or
ac1a55cc2c38 2009-08-06 Carsten Dominik <carsten.dominik@gmail.com>
Carsten Dominik <dominik@science.uva.nl>
parents: 101757
diff changeset
597 (cdr
ac1a55cc2c38 2009-08-06 Carsten Dominik <carsten.dominik@gmail.com>
Carsten Dominik <dominik@science.uva.nl>
parents: 101757
diff changeset
598 (assq
ac1a55cc2c38 2009-08-06 Carsten Dominik <carsten.dominik@gmail.com>
Carsten Dominik <dominik@science.uva.nl>
parents: 101757
diff changeset
599 (cdr (assq 'file org-link-frame-setup))
ac1a55cc2c38 2009-08-06 Carsten Dominik <carsten.dominik@gmail.com>
Carsten Dominik <dominik@science.uva.nl>
parents: 101757
diff changeset
600 '((find-file . switch-to-buffer)
ac1a55cc2c38 2009-08-06 Carsten Dominik <carsten.dominik@gmail.com>
Carsten Dominik <dominik@science.uva.nl>
parents: 101757
diff changeset
601 (find-file-other-window . switch-to-buffer-other-window)
ac1a55cc2c38 2009-08-06 Carsten Dominik <carsten.dominik@gmail.com>
Carsten Dominik <dominik@science.uva.nl>
parents: 101757
diff changeset
602 (find-file-other-frame . switch-to-buffer-other-frame))))
ac1a55cc2c38 2009-08-06 Carsten Dominik <carsten.dominik@gmail.com>
Carsten Dominik <dominik@science.uva.nl>
parents: 101757
diff changeset
603 'switch-to-buffer-other-window))
100448
cea079b68b76 2008-12-16 Carsten Dominik <carsten.dominik@gmail.com>
Carsten Dominik <dominik@science.uva.nl>
parents: 100269
diff changeset
604 (if (not (equal (current-buffer) (marker-buffer m)))
104164
ac1a55cc2c38 2009-08-06 Carsten Dominik <carsten.dominik@gmail.com>
Carsten Dominik <dominik@science.uva.nl>
parents: 101757
diff changeset
605 (funcall cmd (marker-buffer m)))
100448
cea079b68b76 2008-12-16 Carsten Dominik <carsten.dominik@gmail.com>
Carsten Dominik <dominik@science.uva.nl>
parents: 100269
diff changeset
606 (goto-char m)
cea079b68b76 2008-12-16 Carsten Dominik <carsten.dominik@gmail.com>
Carsten Dominik <dominik@science.uva.nl>
parents: 100269
diff changeset
607 (move-marker m nil)
cea079b68b76 2008-12-16 Carsten Dominik <carsten.dominik@gmail.com>
Carsten Dominik <dominik@science.uva.nl>
parents: 100269
diff changeset
608 (org-show-context)))
cea079b68b76 2008-12-16 Carsten Dominik <carsten.dominik@gmail.com>
Carsten Dominik <dominik@science.uva.nl>
parents: 100269
diff changeset
609
cea079b68b76 2008-12-16 Carsten Dominik <carsten.dominik@gmail.com>
Carsten Dominik <dominik@science.uva.nl>
parents: 100269
diff changeset
610 (org-add-link-type "id" 'org-id-open)
cea079b68b76 2008-12-16 Carsten Dominik <carsten.dominik@gmail.com>
Carsten Dominik <dominik@science.uva.nl>
parents: 100269
diff changeset
611
96045
19a1d523548c New file: org-id.el.
Carsten Dominik <dominik@science.uva.nl>
parents:
diff changeset
612 (provide 'org-id)
19a1d523548c New file: org-id.el.
Carsten Dominik <dominik@science.uva.nl>
parents:
diff changeset
613
19a1d523548c New file: org-id.el.
Carsten Dominik <dominik@science.uva.nl>
parents:
diff changeset
614 ;;; org-id.el ends here
19a1d523548c New file: org-id.el.
Carsten Dominik <dominik@science.uva.nl>
parents:
diff changeset
615
104810
86b7fe7d1d8f 2009-09-02 Carsten Dominik <carsten.dominik@gmail.com>
Carsten Dominik <dominik@science.uva.nl>
parents: 104201
diff changeset
616 ;; arch-tag: e5abaca4-e16f-4b25-832a-540cfb63a712
100448
cea079b68b76 2008-12-16 Carsten Dominik <carsten.dominik@gmail.com>
Carsten Dominik <dominik@science.uva.nl>
parents: 100269
diff changeset
617
cea079b68b76 2008-12-16 Carsten Dominik <carsten.dominik@gmail.com>
Carsten Dominik <dominik@science.uva.nl>
parents: 100269
diff changeset
618