org-id.el 22 KB
Newer Older
1
;;; org-id.el --- Global identifiers for Org-mode entries
2
;;
3
;; Copyright (C) 2008-2011 Free Software Foundation, Inc.
Carsten Dominik's avatar
Carsten Dominik committed
4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31
;;
;; Author: Carsten Dominik <carsten at orgmode dot org>
;; Keywords: outlines, hypermedia, calendar, wp
;; Homepage: http://orgmode.org
;;
;; 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
;; guarantees globally unique identifiers, even if several people are
38
;; creating IDs at the same time in files that will eventually be used
39 40 41
;; together.
;;
;; By default Org uses UUIDs as global unique identifiers.
Carsten Dominik's avatar
Carsten Dominik committed
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
;;
;; 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.
;;

71 72
;;; Code:

Carsten Dominik's avatar
Carsten Dominik committed
73 74 75
(require 'org)

(declare-function message-make-fqdn "message" ())
Bastien Guerry's avatar
Bastien Guerry committed
76 77
(declare-function org-pop-to-buffer-same-window 
		  "org-compat" (&optional buffer-or-name norecord label))
Carsten Dominik's avatar
Carsten Dominik committed
78 79 80 81 82 83 84 85

;;; Customization

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

86 87 88 89
(defcustom org-id-uuid-program "uuidgen"
  "The uuidgen program."
  :group 'org-id
  :type 'string)
90

91
(defcustom org-id-method 'uuid
92 93 94 95
  "The method that should be used to create new IDs.

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

Allowed values are:

99 100 101
org        Org's own internal method, using an encoding of the current time to
           microsecond accuracy, and optionally the current domain of the
           computer.  See the variable `org-id-include-domain'.
102

103 104 105
uuid       Create random (version 4) UUIDs.  If the program defined in
           `org-id-uuid-program' is available it is used to create the ID.
           Otherwise an internal functions is used."
106 107 108
  :group 'org-id
  :type '(choice
	  (const :tag "Org's internal method" org)
109
	  (const :tag "external: uuidgen" uuid)))
110 111

(defcustom org-id-prefix nil
Carsten Dominik's avatar
Carsten Dominik committed
112 113 114 115 116 117 118 119 120 121
  "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")))

122
(defcustom org-id-include-domain nil
123
  "Non-nil means add the domain name to new IDs.
124
This ensures global uniqueness of IDs, and is also suggested by
125 126
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
127 128 129 130 131 132 133 134
be added.
The default is to not use this because we have no really good way to get
the true domain, and Org entries will normally not be shared with enough
people to make this necessary."
  :group 'org-id
  :type 'boolean)

(defcustom org-id-track-globally t
135
  "Non-nil means track IDs through files, so that links work globally.
136 137 138 139 140 141 142 143
This work by maintaining a hash table for IDs and writing this table
to disk when exiting Emacs.  Because of this, it works best if you use
a single Emacs process, not many.

When nil, IDs are not tracked.  Links to IDs will still work within
a buffer, but not if the entry is located in another file.
IDs can still be used if the entry with the id is in the same file as
the link."
Carsten Dominik's avatar
Carsten Dominik committed
144 145 146
  :group 'org-id
  :type 'boolean)

147
(defcustom org-id-locations-file (convert-standard-filename
148 149 150
				  "~/.emacs.d/.org-id-locations")
  "The file for remembering in which file an ID was defined.
This variable is only relevant when `org-id-track-globally' is set."
Carsten Dominik's avatar
Carsten Dominik committed
151 152 153 154
  :group 'org-id
  :type 'file)

(defvar org-id-locations nil
155
  "List of files with IDs in those files.")
156 157 158

(defvar org-id-files nil
  "List of files that contain IDs.")
Carsten Dominik's avatar
Carsten Dominik committed
159 160

(defcustom org-id-extra-files 'org-agenda-text-search-extra-files
161 162 163 164 165 166 167
  "Files to be searched for IDs, besides the agenda files.
When Org reparses files to remake the list of files and IDs it is tracking,
it will normally scan the agenda files, the archives related to agenda files,
any files that are listed as ID containing in the current register, and
any Org-mode files currently visited by Emacs.
You can list additional files here.
This variable is only relevant when `org-id-track-globally' is set."
Carsten Dominik's avatar
Carsten Dominik committed
168 169 170 171 172 173 174
  :group 'org-id
  :type
  '(choice
    (symbol :tag "Variable")
    (repeat :tag "List of files"
	    (file))))

175
(defcustom org-id-search-archives t
176
  "Non-nil means search also the archive files of agenda files for entries.
177
This is a possibility to reduce overhead, but it means that entries moved
178 179 180 181 182
to the archives can no longer be found by ID.
This variable is only relevant when `org-id-track-globally' is set."
  :group 'org-id
  :type 'boolean)

Carsten Dominik's avatar
Carsten Dominik committed
183 184 185 186 187 188 189 190 191 192 193
;;; 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))
194

Carsten Dominik's avatar
Carsten Dominik committed
195 196 197 198 199
;;;###autoload
(defun org-id-copy ()
  "Copy the ID of the entry at point to the kill ring.
Create an ID if necessary."
  (interactive)
200
  (org-kill-new (org-id-get nil 'create)))
Carsten Dominik's avatar
Carsten Dominik committed
201 202 203 204 205 206 207 208 209

;;;###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."
210 211 212 213 214 215 216 217 218 219 220
  (org-with-point-at pom
    (let ((id (org-entry-get nil "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)))))
Carsten Dominik's avatar
Carsten Dominik committed
221 222 223 224 225 226 227 228 229

;;;###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)))))
230
	 (org-refile-use-outline-path
Carsten Dominik's avatar
Carsten Dominik committed
231
	  (if (caar org-refile-targets) 'file t))
232
	 (org-refile-target-verify-function nil)
233
	 (spos (org-refile-get-location "Entry"))
234
	 (pom (and spos (move-marker (make-marker) (nth 3 spos)
Carsten Dominik's avatar
Carsten Dominik committed
235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252
				     (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."
253
  (interactive "sID: ")
Carsten Dominik's avatar
Carsten Dominik committed
254 255 256
  (let ((m (org-id-find id 'marker)))
    (unless m
      (error "Cannot find entry with ID \"%s\"" id))
Bastien Guerry's avatar
Bastien Guerry committed
257
    (org-pop-to-buffer-same-window (marker-buffer m))
Carsten Dominik's avatar
Carsten Dominik committed
258 259
    (goto-char m)
    (move-marker m nil)
260
    (org-show-context)))
Carsten Dominik's avatar
Carsten Dominik committed
261 262 263 264 265 266 267

;;;###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."
268 269 270
  (cond
   ((symbolp id) (setq id (symbol-name id)))
   ((numberp id) (setq id (number-to-string id))))
Carsten Dominik's avatar
Carsten Dominik committed
271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290
  (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
291
- a unique part that will be created according to `org-id-method'.
Carsten Dominik's avatar
Carsten Dominik committed
292 293 294 295 296 297 298

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)
299 300 301 302 303
		     ""
		   (concat (or prefix org-id-prefix) ":")))
	 unique)
    (if (equal prefix ":") (setq prefix ""))
    (cond
304 305 306 307
     ((memq org-id-method '(uuidgen uuid))
      (setq unique (org-trim (shell-command-to-string org-id-uuid-program)))
      (unless (org-uuidgen-p unique)
	(setq unique (org-id-uuid))))
308 309 310 311 312 313 314 315 316 317
     ((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)))

318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341
(defun org-id-uuid ()
  "Return string with random (version 4) UUID."
  (let ((rnd (md5 (format "%s%s%s%s%s%s%s"
			  (random t)
			  (current-time)
			  (user-uid)
			  (emacs-pid)
			  (user-full-name)
			  user-mail-address
			  (recent-keys)))))
    (format "%s-%s-4%s-%s%s-%s"
	    (substring rnd 0 8)
	    (substring rnd 8 12)
	    (substring rnd 13 16)
	    (format "%x"
		    (logior
		     #b10000000
		     (logand
		      #b10111111
		      (string-to-number
		       (substring rnd 16 18) 16))))
	    (substring rnd 18 20)
	    (substring rnd 20 32))))

342 343 344 345
(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
346 347 348
  "Turn an integer between 0 and 61 into a single character 0..9, A..Z, a..z."
  (cond
   ((< i 10) (+ ?0 i))
349 350
   ((< i 36) (+ ?a i -10))
   (t (error "Larger that 35"))))
Carsten Dominik's avatar
Carsten Dominik committed
351

352
(defun org-id-b36-to-int-one-digit (i)
Carsten Dominik's avatar
Carsten Dominik committed
353 354 355 356 357
  "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))
358 359
   ((and (>= i ?a) (<= i ?z)) (+ (- i ?a) 10))
   (t (error "Invalid b36 letter"))))
Carsten Dominik's avatar
Carsten Dominik committed
360

361 362
(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
363 364 365
  (let ((s ""))
    (while (> i 0)
      (setq s (concat (char-to-string
366 367
		       (org-id-int-to-b36-one-digit (mod i 36))) s)
	    i (/ i 36)))
Carsten Dominik's avatar
Carsten Dominik committed
368 369 370 371 372
    (setq length (max 1 (or length 1)))
    (if (< (length s) length)
	(setq s (concat (make-string (- length (length s)) ?0) s)))
    s))

373 374
(defun org-id-b36-to-int (s)
  "Convert a base-36 string into the corresponding integer."
Carsten Dominik's avatar
Carsten Dominik committed
375
  (let ((r 0))
376
    (mapc (lambda (i) (setq r (+ (* r 36) (org-id-b36-to-int-one-digit i))))
Carsten Dominik's avatar
Carsten Dominik committed
377 378 379
	  s)
    r))

380
(defun org-id-time-to-b36 (&optional time)
Carsten Dominik's avatar
Carsten Dominik committed
381 382 383 384
  "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)))
385 386 387
  (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
388 389 390 391 392 393 394 395 396 397

(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)))
398 399 400 401
    (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
402 403 404 405
    (cons prefix time)))

;; Storing ID locations (files)

406 407 408 409 410 411
(defun org-id-update-id-locations (&optional files)
  "Scan relevant files for IDs.
Store the relation between files and corresponding IDs.
This will scan all agenda files, all associated archives, and all
files currently mentioned in `org-id-locations'.
When FILES is given, scan these files instead.
412
When CHECK is given, prepare detailed information about duplicate IDs."
Carsten Dominik's avatar
Carsten Dominik committed
413
  (interactive)
414
  (if (not org-id-track-globally)
415
      (error "Please turn on `org-id-track-globally' if you want to track IDs")
416 417 418 419 420 421 422 423 424 425 426 427 428 429
    (let* ((org-id-search-archives
	    (or org-id-search-archives
		(and (symbolp org-id-extra-files)
		     (symbol-value org-id-extra-files)
		     (member 'agenda-archives org-id-extra-files))))
	   (files
	    (or files
		(append
		 ;; Agenda files and all associated archives
		 (org-agenda-files t org-id-search-archives)
		 ;; Explicit extra files
		 (if (symbolp org-id-extra-files)
		     (symbol-value org-id-extra-files)
		   org-id-extra-files)
430
	      ;; Files associated with live org-mode buffers
431 432 433
		 (delq nil
		       (mapcar (lambda (b)
				 (with-current-buffer b
Bastien Guerry's avatar
Bastien Guerry committed
434
				   (and (eq major-mode 'org-mode) (buffer-file-name))))
435 436 437 438 439 440 441
			       (buffer-list)))
		 ;; All files known to have IDs
		 org-id-files)))
	   org-agenda-new-buffers
	   file nfiles tfile ids reg found id seen (ndup 0))
      (when (member 'agenda-archives files)
	(setq files (delq 'agenda-archives (copy-sequence files))))
442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460
      (setq nfiles (length files))
      (while (setq file (pop files))
	(message "Finding ID locations (%d/%d files): %s"
		 (- nfiles (length files)) nfiles file)
	(setq tfile (file-truename file))
	(when (and (file-exists-p file) (not (member tfile seen)))
	  (push tfile seen)
	  (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)
		      (progn
			(message "Duplicate ID \"%s\", also in file %s"
461 462 463 464 465 466 467 468
				 id (or (car (delq
					      nil
					      (mapcar
					       (lambda (x)
						 (if (member id (cdr x))
						     (car x)))
					       reg)))
					(buffer-file-name)))
469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486
			(when (= ndup 0)
			  (ding)
			  (sit-for 2))
			(setq ndup (1+ ndup)))
		    (push id found)
		    (push id ids)))
		(push (cons (abbreviate-file-name file) ids) reg))))))
      (org-release-buffers org-agenda-new-buffers)
      (setq org-agenda-new-buffers nil)
      (setq org-id-locations reg)
      (setq org-id-files (mapcar 'car org-id-locations))
      (org-id-locations-save) ;; this function can also handle the alist form
      ;; now convert to a hash
      (setq org-id-locations (org-id-alist-to-hash org-id-locations))
      (if (> ndup 0)
	  (message "WARNING: %d duplicate IDs found, check *Messages* buffer" ndup)
	(message "%d unique files scanned for IDs" (length org-id-files)))
      org-id-locations)))
Carsten Dominik's avatar
Carsten Dominik committed
487 488 489

(defun org-id-locations-save ()
  "Save `org-id-locations' in `org-id-locations-file'."
490
  (when (and org-id-track-globally org-id-locations)
491 492 493 494 495
    (let ((out (if (hash-table-p org-id-locations)
		   (org-id-hash-to-alist org-id-locations)
		 org-id-locations)))
      (with-temp-file org-id-locations-file
	(print out (current-buffer))))))
Carsten Dominik's avatar
Carsten Dominik committed
496 497 498 499

(defun org-id-locations-load ()
  "Read the data from `org-id-locations-file'."
  (setq org-id-locations nil)
500 501 502 503 504 505 506 507 508 509 510 511
  (when org-id-track-globally
    (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))))
    (setq org-id-files (mapcar 'car org-id-locations))
    (setq org-id-locations (org-id-alist-to-hash org-id-locations))))
Carsten Dominik's avatar
Carsten Dominik committed
512 513

(defun org-id-add-location (id file)
514
  "Add the ID with location FILE to the database of ID locations."
515
  ;; Only if global tracking is on, and when the buffer has a file
516
  (when (and org-id-track-globally id file)
517
    (unless org-id-locations (org-id-locations-load))
518 519 520
    (puthash id (abbreviate-file-name file) org-id-locations)
    (add-to-list 'org-id-files (abbreviate-file-name file))))

Juanma Barranquero's avatar
Juanma Barranquero committed
521 522
(unless noninteractive
  (add-hook 'kill-emacs-hook 'org-id-locations-save))
523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539

(defun org-id-hash-to-alist (hash)
  "Turn an org-id hash into an alist, so that it can be written to a file."
  (let (res x)
    (maphash
     (lambda (k v)
       (if (setq x (member v res))
	   (setcdr x (cons k (cdr x)))
	 (push (list v k) res)))
     hash)
    res))

(defun org-id-alist-to-hash (list)
  "Turn an org-id location list into a hash table."
  (let ((res (make-hash-table
	      :test 'equal
	      :size (apply '+ (mapcar 'length list))))
540
	f)
541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562
    (mapc
     (lambda (x)
       (setq f (car x))
       (mapc (lambda (i) (puthash i f res)) (cdr x)))
     list)
    res))

(defun org-id-paste-tracker (txt &optional buffer-or-file)
  "Update any IDs in TXT and assign BUFFER-OR-FILE to them."
  (when org-id-track-globally
    (save-match-data
      (setq buffer-or-file (or buffer-or-file (current-buffer)))
      (when (bufferp buffer-or-file)
	(setq buffer-or-file (or (buffer-base-buffer buffer-or-file)
				 buffer-or-file))
	(setq buffer-or-file (buffer-file-name buffer-or-file)))
      (when buffer-or-file
	(let ((fname (abbreviate-file-name buffer-or-file))
	      (s 0))
	  (while (string-match "^[ \t]*:ID:[ \t]+\\([^ \t\n\r]+\\)" txt s)
	    (setq s (match-end 0))
	    (org-id-add-location (match-string 1 txt) fname)))))))
Carsten Dominik's avatar
Carsten Dominik committed
563 564 565

;; Finding entries with specified id

566
;;;###autoload
Carsten Dominik's avatar
Carsten Dominik committed
567 568 569
(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))
570 571 572
  (or (and org-id-locations
	   (hash-table-p org-id-locations)
	   (gethash id org-id-locations))
573 574 575
      ;; ball back on current buffer
      (buffer-file-name (or (buffer-base-buffer (current-buffer))
			    (current-buffer)))))
Carsten Dominik's avatar
Carsten Dominik committed
576 577 578 579 580 581 582

(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."
583
  (let (org-agenda-new-buffers buf pos)
Carsten Dominik's avatar
Carsten Dominik committed
584 585 586 587 588 589 590 591 592 593
    (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))))))))

594 595 596 597 598
;; id link type

;; Calling the following function is hard-coded into `org-store-link',
;; so we do have to add it to `org-store-link-functions'.

Carsten Dominik's avatar
Carsten Dominik committed
599
;;;###autoload
600
(defun org-id-store-link ()
601
  "Store a link to the current entry, using its ID."
602
  (interactive)
Bastien Guerry's avatar
Bastien Guerry committed
603
  (when (and (buffer-file-name (buffer-base-buffer)) (eq major-mode 'org-mode))
Carsten Dominik's avatar
Carsten Dominik committed
604 605 606 607 608 609 610 611 612 613 614
    (let* ((link (org-make-link "id:" (org-id-get-create)))
	   (case-fold-search nil)
	   (desc (save-excursion
		   (org-back-to-heading t)
		   (or (and (looking-at org-complex-heading-regexp)
			    (if (match-end 4)
				(match-string 4)
			      (match-string 0)))
		       link))))
      (org-store-link-props :link link :description desc :type "id")
      link)))
615 616 617 618

(defun org-id-open (id)
  "Go to the entry with id ID."
  (org-mark-ring-push)
619 620
  (let ((m (org-id-find id 'marker))
	cmd)
621 622
    (unless m
      (error "Cannot find entry with ID \"%s\"" id))
623 624 625 626 627 628 629 630 631 632
    ;; Use a buffer-switching command in analogy to finding files
    (setq cmd
	  (or
	   (cdr
	    (assq
	     (cdr (assq 'file org-link-frame-setup))
	     '((find-file . switch-to-buffer)
	       (find-file-other-window . switch-to-buffer-other-window)
	       (find-file-other-frame . switch-to-buffer-other-frame))))
	   'switch-to-buffer-other-window))
633
    (if (not (equal (current-buffer) (marker-buffer m)))
634
	(funcall cmd (marker-buffer m)))
635 636 637 638 639 640
    (goto-char m)
    (move-marker m nil)
    (org-show-context)))

(org-add-link-type "id" 'org-id-open)

Carsten Dominik's avatar
Carsten Dominik committed
641 642 643 644
(provide 'org-id)

;;; org-id.el ends here

645

646 647