org-id.el 14.4 KB
Newer Older
1
;;; org-id.el --- Global identifier for Org-mode entries
Carsten Dominik's avatar
Carsten Dominik committed
2 3 4 5 6
;; Copyright (C) 2008 Free Software Foundation, Inc.
;;
;; Author: Carsten Dominik <carsten at orgmode dot org>
;; Keywords: outlines, hypermedia, calendar, wp
;; Homepage: http://orgmode.org
7
;; Version: 6.14
Carsten Dominik's avatar
Carsten Dominik committed
8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31
;;
;; This file is part of GNU Emacs.
;;
;; GNU Emacs is free software: you can redistribute it and/or modify
;; it under the terms of the GNU General Public License as published by
;; the Free Software Foundation, either version 3 of the License, or
;; (at your option) any later version.

;; GNU Emacs is distributed in the hope that it will be useful,
;; but WITHOUT ANY WARRANTY; without even the implied warranty of
;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
;; GNU General Public License for more details.

;; You should have received a copy of the GNU General Public License
;; along with GNU Emacs.  If not, see <http://www.gnu.org/licenses/>.
;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
;;
;;; Commentary:

;; This file implements globally unique identifiers for Org-mode entries.
;; Identifiers are stored in the entry as an :ID: property.  Functions
;; are provided that create and retrieve such identifiers, and that find
;; entries based on the identifier.

32 33 34 35 36
;; Identifiers consist of a prefix (default "Org" given by the variable
;; `org-id-prefix') and a unique part that can be created by a number
;; of different methods, see the variable `org-id-method'.
;; Org has a builtin method that uses a compact encoding of the creation
;; time of the ID, with microsecond accuracy.  This virtually
Carsten Dominik's avatar
Carsten Dominik committed
37 38
;; guarantees globally unique identifiers, even if several people are
;; creating ID's at the same time in files that will eventually be used
39 40
;; together.  As an exernal method `uuidgen' is supported, if installed
;; on the system.
Carsten Dominik's avatar
Carsten Dominik committed
41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80
;;
;; This file defines the following API:
;;
;; org-id-get-create
;;        Create an ID for the entry at point if it does not yet have one.
;;        Returns the ID (old or new).  This function can be used
;;        interactively, with prefix argument the creation of a new ID is
;;        forced, even if there was an old one.
;;
;; org-id-get
;;        Get the ID property of an entry.  Using appropriate arguments
;;        to the function, it can also create the ID for this entry.
;;
;; org-id-goto
;;        Command to go to a specific ID, this command can be used
;;        interactively.
;;
;; org-id-get-with-outline-path-completion
;;        Retrieve the ID of an entry, using outline path completion.
;;        This function can work for multiple files.
;;
;; org-id-get-with-outline-drilling
;;        Retrieve the ID of an entry, using outline path completion.
;;        This function only works for the current file.
;;
;; org-id-find
;;        Find the location of an entry with specific id.
;;

(require 'org)

(declare-function message-make-fqdn "message" ())

;;; Customization

(defgroup org-id nil
  "Options concerning global entry identifiers in Org-mode."
  :tag "Org ID"
  :group 'org)

81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99
(defcustom org-id-method 'org
  "The method that should be used to create new ID's.

An ID will consist of the prefix specified in `org-id-prefix', and a unique
part created by the method this variable specifies.

Allowed values are:

org        Org's own internal method, using an encoding of the current time,
           and the current domain of the computer.  This method will
           honor the variable `org-id-include-domain'.

uuidgen    Call the external command uuidgen."
  :group 'org-id
  :type '(choice
	  (const :tag "Org's internal method" org)
	  (const :tag "external: uuidgen" uuidgen)))

(defcustom org-id-prefix nil
Carsten Dominik's avatar
Carsten Dominik committed
100 101 102 103 104 105 106 107 108 109 110 111 112
  "The prefix for IDs.

This may be a string, or it can be nil to indicate that no prefix is required.
When a string, the string should have no space characters as IDs are expected
to have no space characters in them."
  :group 'org-id
  :type '(choice
	  (const :tag "No prefix")
	  (string :tag "Prefix")))

(defcustom org-id-include-domain t
  "Non-nil means, add the domain name to new IDs.
This ensures global uniqueness of ID's, and is also suggested by
113 114 115
RFC 2445 in combination with RFC 822.  This is only relevant if
`org-id-method' is `org'.  When uuidgen is used, the domain will never
be added."
Carsten Dominik's avatar
Carsten Dominik committed
116 117 118
  :group 'org-id
  :type 'boolean)

119
(defcustom org-id-locations-file (convert-standard-filename
120 121
				  "~/.org-id-locations")
  "The file for remembering the last ID number generated."
Carsten Dominik's avatar
Carsten Dominik committed
122 123 124 125
  :group 'org-id
  :type 'file)

(defvar org-id-locations nil
126
  "List of files with ID's in those files.")
Carsten Dominik's avatar
Carsten Dominik committed
127 128

(defcustom org-id-extra-files 'org-agenda-text-search-extra-files
129
  "Files to be searched for ID's, besides the agenda files."
Carsten Dominik's avatar
Carsten Dominik committed
130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147
  :group 'org-id
  :type
  '(choice
    (symbol :tag "Variable")
    (repeat :tag "List of files"
	    (file))))

;;; The API functions

;;;###autoload
(defun org-id-get-create (&optional force)
  "Create an ID for the current entry and return it.
If the entry already has an ID, just return it.
With optional argument FORCE, force the creation of a new ID."
  (interactive "P")
  (when force
    (org-entry-put (point) "ID" nil))
  (org-id-get (point) 'create))
148

Carsten Dominik's avatar
Carsten Dominik committed
149 150 151 152 153
;;;###autoload
(defun org-id-copy ()
  "Copy the ID of the entry at point to the kill ring.
Create an ID if necessary."
  (interactive)
154
  (kill-new (org-id-get nil 'create)))
Carsten Dominik's avatar
Carsten Dominik committed
155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182

;;;###autoload
(defun org-id-get (&optional pom create prefix)
  "Get the ID property of the entry at point-or-marker POM.
If POM is nil, refer to the entry at point.
If the entry does not have an ID, the function returns nil.
However, when CREATE is non nil, create an ID if none is present already.
PREFIX will be passed through to `org-id-new'.
In any case, the ID of the entry is returned."
  (let ((id (org-entry-get pom "ID")))
    (cond
     ((and id (stringp id) (string-match "\\S-" id))
      id)
     (create
      (setq id (org-id-new prefix))
      (org-entry-put pom "ID" id)
      (org-id-add-location id (buffer-file-name (buffer-base-buffer)))
      id)
     (t nil))))

;;;###autoload
(defun org-id-get-with-outline-path-completion (&optional targets)
  "Use outline-path-completion to retrieve the ID of an entry.
TARGETS may be a setting for `org-refile-targets' to define the eligible
headlines.  When omitted, all headlines in all agenda files are
eligible.
It returns the ID of the entry.  If necessary, the ID is created."
  (let* ((org-refile-targets (or targets '((nil . (:maxlevel . 10)))))
183
	 (org-refile-use-outline-path
Carsten Dominik's avatar
Carsten Dominik committed
184 185
	  (if (caar org-refile-targets) 'file t))
	 (spos (org-refile-get-location "Entry: "))
186
	 (pom (and spos (move-marker (make-marker) (nth 3 spos)
Carsten Dominik's avatar
Carsten Dominik committed
187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204
				     (get-file-buffer (nth 1 spos))))))
    (prog1 (org-id-get pom 'create)
      (move-marker pom nil))))

;;;###autoload
(defun org-id-get-with-outline-drilling (&optional targets)
  "Use an outline-cycling interface to retrieve the ID of an entry.
This only finds entries in the current buffer, using `org-get-location'.
It returns the ID of the entry.  If necessary, the ID is created."
  (let* ((spos (org-get-location (current-buffer) org-goto-help))
	 (pom (and spos (move-marker (make-marker) (car spos)))))
    (prog1 (org-id-get pom 'create)
      (move-marker pom nil))))

;;;###autoload
(defun org-id-goto (id)
  "Switch to the buffer containing the entry with id ID.
Move the cursor to that entry in that buffer."
205
  (interactive)
Carsten Dominik's avatar
Carsten Dominik committed
206 207 208 209 210 211
  (let ((m (org-id-find id 'marker)))
    (unless m
      (error "Cannot find entry with ID \"%s\"" id))
    (switch-to-buffer (marker-buffer m))
    (goto-char m)
    (move-marker m nil)
212
    (org-show-context)))
Carsten Dominik's avatar
Carsten Dominik committed
213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239

;;;###autoload
(defun org-id-find (id &optional markerp)
  "Return the location of the entry with the id ID.
The return value is a cons cell (file-name . position), or nil
if there is no entry with that ID.
With optional argument MARKERP, return the position as a new marker."
  (let ((file (org-id-find-id-file id))
	org-agenda-new-buffers where)
    (when file
      (setq where (org-id-find-id-in-file id file markerp)))
    (unless where
      (org-id-update-id-locations)
      (setq file (org-id-find-id-file id))
      (when file
	(setq where (org-id-find-id-in-file id file markerp))))
    where))

;;; Internal functions

;; Creating new IDs

(defun org-id-new (&optional prefix)
  "Create a new globally unique ID.

An ID consists of two parts separated by a colon:
- a prefix
240
- a unique part that will be created according to `org-id-method'.
Carsten Dominik's avatar
Carsten Dominik committed
241 242 243 244 245 246 247

PREFIX can specify the prefix, the default is given by the variable
`org-id-prefix'.  However, if PREFIX is the symbol `none', don't use any
prefix even if `org-id-prefix' specifies one.

So a typical ID could look like \"Org:4nd91V40HI\"."
  (let* ((prefix (if (eq prefix 'none)
248 249 250 251 252 253
		     ""
		   (concat (or prefix org-id-prefix) ":")))
	 unique)
    (if (equal prefix ":") (setq prefix ""))
    (cond
     ((eq org-id-method 'uuidgen)
254
      (setq unique (org-trim (shell-command-to-string "uuidgen"))))
255 256 257 258 259 260 261 262 263 264 265 266 267 268
     ((eq org-id-method 'org)
      (let* ((etime (org-id-reverse-string (org-id-time-to-b36)))
	     (postfix (if org-id-include-domain
			  (progn
			    (require 'message)
			    (concat "@" (message-make-fqdn))))))
	(setq unique (concat etime postfix))))
     (t (error "Invalid `org-id-method'")))
    (concat prefix unique)))

(defun org-id-reverse-string (s)
  (mapconcat 'char-to-string (nreverse (string-to-list s)) ""))

(defun org-id-int-to-b36-one-digit (i)
Carsten Dominik's avatar
Carsten Dominik committed
269 270 271
  "Turn an integer between 0 and 61 into a single character 0..9, A..Z, a..z."
  (cond
   ((< i 10) (+ ?0 i))
272 273
   ((< i 36) (+ ?a i -10))
   (t (error "Larger that 35"))))
Carsten Dominik's avatar
Carsten Dominik committed
274

275
(defun org-id-b36-to-int-one-digit (i)
Carsten Dominik's avatar
Carsten Dominik committed
276 277 278 279 280
  "Turn a character 0..9, A..Z, a..z into a number 0..61.
The input I may be a character, or a single-letter string."
  (and (stringp i) (setq i (string-to-char i)))
  (cond
   ((and (>= i ?0) (<= i ?9)) (- i ?0))
281 282
   ((and (>= i ?a) (<= i ?z)) (+ (- i ?a) 10))
   (t (error "Invalid b36 letter"))))
Carsten Dominik's avatar
Carsten Dominik committed
283

284 285
(defun org-id-int-to-b36 (i &optional length)
  "Convert an integer to a base-36 number represented as a string."
Carsten Dominik's avatar
Carsten Dominik committed
286 287 288
  (let ((s ""))
    (while (> i 0)
      (setq s (concat (char-to-string
289 290
		       (org-id-int-to-b36-one-digit (mod i 36))) s)
	    i (/ i 36)))
Carsten Dominik's avatar
Carsten Dominik committed
291 292 293 294 295
    (setq length (max 1 (or length 1)))
    (if (< (length s) length)
	(setq s (concat (make-string (- length (length s)) ?0) s)))
    s))

296 297
(defun org-id-b36-to-int (s)
  "Convert a base-36 string into the corresponding integer."
Carsten Dominik's avatar
Carsten Dominik committed
298
  (let ((r 0))
299
    (mapc (lambda (i) (setq r (+ (* r 36) (org-id-b36-to-int-one-digit i))))
Carsten Dominik's avatar
Carsten Dominik committed
300 301 302
	  s)
    r))

303
(defun org-id-time-to-b36 (&optional time)
Carsten Dominik's avatar
Carsten Dominik committed
304 305 306 307
  "Encode TIME as a 10-digit string.
This string holds the time to micro-second accuracy, and can be decoded
using `org-id-decode'."
  (setq time (or time (current-time)))
308 309 310
  (concat (org-id-int-to-b36 (nth 0 time) 4)
	  (org-id-int-to-b36 (nth 1 time) 4)
	  (org-id-int-to-b36 (or (nth 2 time) 0) 4)))
Carsten Dominik's avatar
Carsten Dominik committed
311 312 313 314 315 316 317 318 319 320

(defun org-id-decode (id)
  "Split ID into the prefix and the time value that was used to create it.
The return value is (prefix . time) where PREFIX is nil or a string,
and time is the usual three-integer representation of time."
  (let (prefix time parts)
    (setq parts (org-split-string id ":"))
    (if (= 2 (length parts))
	(setq prefix (car parts) time (nth 1 parts))
      (setq prefix nil time (nth 0 parts)))
321 322 323 324
    (setq time (org-id-reverse-string time))
    (setq time (list (org-id-b36-to-int (substring time 0 4))
		     (org-id-b36-to-int (substring time 4 8))
		     (org-id-b36-to-int (substring time 8 12))))
Carsten Dominik's avatar
Carsten Dominik committed
325 326 327 328
    (cons prefix time)))

;; Storing ID locations (files)

329
(defun org-id-update-id-locations ()
Carsten Dominik's avatar
Carsten Dominik committed
330
  "Scan relevant files for ID's.
331
Store the relation between files and corresponding ID's."
Carsten Dominik's avatar
Carsten Dominik committed
332
  (interactive)
333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357
  (let ((files (append (org-agenda-files)
		       (if (symbolp org-id-extra-files)
			   (symbol-value org-id-extra-files)
			 org-id-extra-files)))
	org-agenda-new-buffers
	file ids reg found id)
    (while (setq file (pop files))
      (setq ids nil)
      (with-current-buffer (org-get-agenda-file-buffer file)
	(save-excursion
	  (save-restriction
	    (widen)
	    (goto-char (point-min))
	    (while (re-search-forward "^[ \t]*:ID:[ \t]+\\(\\S-+\\)[ \t]*$"
				      nil t)
	      (setq id (org-match-string-no-properties 1))
	      (if (member id found)
		  (error "Duplicate ID \"%s\"" id))
	      (push id found)
	      (push id ids))
	    (push (cons file ids) reg)))))
    (org-release-buffers org-agenda-new-buffers)
    (setq org-agenda-new-buffers nil)
    (setq org-id-locations reg)
    (org-id-locations-save)))
Carsten Dominik's avatar
Carsten Dominik committed
358 359 360

(defun org-id-locations-save ()
  "Save `org-id-locations' in `org-id-locations-file'."
361 362
  (with-temp-file org-id-locations-file
    (print org-id-locations (current-buffer))))
Carsten Dominik's avatar
Carsten Dominik committed
363 364 365 366

(defun org-id-locations-load ()
  "Read the data from `org-id-locations-file'."
  (setq org-id-locations nil)
367 368 369 370 371 372 373 374 375
  (with-temp-buffer
    (condition-case nil
        (progn
          (insert-file-contents-literally org-id-locations-file)
          (goto-char (point-min))
          (setq org-id-locations (read (current-buffer))))
      (error
       (message "Could not read org-id-values from %s. Setting it to nil."
                org-id-locations-file)))))
Carsten Dominik's avatar
Carsten Dominik committed
376 377 378

(defun org-id-add-location (id file)
  "Add the ID with location FILE to the database of ID loations."
379
  (when (and id file) ; don't error when called from a buffer with no file
380
    (unless org-id-locations (org-id-locations-load))
381 382 383 384 385 386 387 388
    (catch 'exit
      (let ((locs org-id-locations) list)
	(while (setq list (pop locs))
	  (when (equal (file-truename file) (file-truename (car list)))
	    (setcdr list (cons id (cdr list)))
	    (throw 'exit t))))
      (push (list file id) org-id-locations))
    (org-id-locations-save)))
Carsten Dominik's avatar
Carsten Dominik committed
389 390 391 392 393 394

;; Finding entries with specified id

(defun org-id-find-id-file (id)
  "Query the id database for the file in which this ID is located."
  (unless org-id-locations (org-id-locations-load))
395 396 397 398 399
  (catch 'found
    (mapc (lambda (x) (if (member id (cdr x))
			  (throw 'found (car x))))
	  org-id-locations)
    nil))
Carsten Dominik's avatar
Carsten Dominik committed
400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421

(defun org-id-find-id-in-file (id file &optional markerp)
  "Return the position of the entry ID in FILE.
If that files does not exist, or if it does not contain this ID,
return nil.
The position is returned as a cons cell (file-name . position).  With
optional argument MARKERP, return the position as a new marker."
  (let (org-agenda-new-buffers m buf pos)
    (cond
     ((not file) nil)
     ((not (file-exists-p file)) nil)
     (t (with-current-buffer (setq buf (org-get-agenda-file-buffer file))
	  (setq pos (org-find-entry-with-id id))
	  (when pos
	    (if markerp
		(move-marker (make-marker) pos buf)
	      (cons file pos))))))))

(provide 'org-id)

;;; org-id.el ends here

Miles Bader's avatar
Miles Bader committed
422
;; arch-tag: e5abaca4-e16f-4b25-832a-540cfb63a712