1 ;;; org-bbdb.el --- Support for links to BBDB entries from within Org-mode
3 ;; Copyright (C) 2004, 2005, 2006, 2007, 2008 Free Software Foundation, Inc.
5 ;; Author: Carsten Dominik <carsten at orgmode dot org>,
6 ;; Thomas Baumann <thomas dot baumann at ch dot tum dot de>
7 ;; Keywords: outlines, hypermedia, calendar, wp
8 ;; Homepage: http://orgmode.org
11 ;; This file is part of GNU Emacs.
13 ;; GNU Emacs is free software; you can redistribute it and/or modify
14 ;; it under the terms of the GNU General Public License as published by
15 ;; the Free Software Foundation; either version 3, or (at your option)
18 ;; GNU Emacs is distributed in the hope that it will be useful,
19 ;; but WITHOUT ANY WARRANTY; without even the implied warranty of
20 ;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
21 ;; GNU General Public License for more details.
23 ;; You should have received a copy of the GNU General Public License
24 ;; along with GNU Emacs; see the file COPYING. If not, write to the
25 ;; Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor,
26 ;; Boston, MA 02110-1301, USA.
27 ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
31 ;; This file implements links to BBDB database entries from within Org-mode.
32 ;; Org-mode loads this module by default - if this is not what you want,
33 ;; configure the variable `org-modules'.
36 ;; It also implements an interface (based on Ivar Rummelhoff's
37 ;; bbdb-anniv.el) for those org-mode users, who do not use the diary
38 ;; but who do want to include the anniversaries stored in the BBDB
39 ;; into the org-agenda. If you already include the `diary' into the
40 ;; agenda, you might want to prefer to include the anniversaries in
41 ;; the diary using bbdb-anniv.el.
43 ;; Put the following in /somewhere/at/home/diary.org and make sure
44 ;; that this file is in `org-agenda-files`
46 ;; %%(org-bbdb-anniversaries)
48 ;; For example my diary.org looks like:
51 ;; %%(org-bbdb-anniversaries)
54 ;; The anniversaries are stored in BBDB in the field `anniversary'
57 ;; YYYY-MM-DD{ CLASS-OR-FORMAT-STRING}*
58 ;; {\nYYYY-MM-DD CLASS-OR-FORMAT-STRING}*
60 ;; CLASS-OR-FORMAT-STRING is one of two things:
62 ;; * an identifier for a class of anniversaries (eg. birthday or
63 ;; wedding) from `org-bbdb-anniversary-format-alist'.
64 ;; * the (format) string displayed in the diary.
66 ;; It defaults to the value of `org-bbdb-default-anniversary-format'
67 ;; ("birthday" by default).
69 ;; The substitutions in the format string are (in order):
70 ;; * the name of the record containing this anniversary
71 ;; * the number of years
72 ;; * an ordinal suffix (st, nd, rd, th) for the year
74 ;; See the documentation of `org-bbdb-anniversary-format-alist' for
81 ;; 1998-03-12 %s created bbdb-anniv.el %d years ago
89 ;; Declare external functions and variables
91 (declare-function bbdb
"ext:bbdb-com" (string elidep
))
92 (declare-function bbdb-company
"ext:bbdb-com" (string elidep
))
93 (declare-function bbdb-current-record
"ext:bbdb-com"
94 (&optional planning-on-modifying
))
95 (declare-function bbdb-name
"ext:bbdb-com" (string elidep
))
96 (declare-function bbdb-record-getprop
"ext:bbdb" (record property
))
97 (declare-function bbdb-record-name
"ext:bbdb" (record))
98 (declare-function bbdb-records
"ext:bbdb"
99 (&optional dont-check-disk already-in-db-buffer
))
100 (declare-function bbdb-split
"ext:bbdb" (string separators
))
101 (declare-function bbdb-string-trim
"ext:bbdb" (string))
102 (declare-function calendar-leap-year-p
"calendar" (year))
103 (declare-function diary-ordinal-suffix
"diary-lib" (n))
109 (defgroup org-bbdb-anniversaries nil
110 "Customizations for including anniversaries from BBDB into Agenda."
113 (defcustom org-bbdb-default-anniversary-format
"birthday"
114 "Default anniversary class."
116 :group
'org-bbdb-anniversaries
119 (defcustom org-bbdb-anniversary-format-alist
120 '( ("birthday" .
"Birthday: %s (%d%s)")
121 ("wedding" .
"%s's %d%s wedding anniversary") )
122 "How different types of anniversaries should be formatted.
123 An alist of elements (STRING . FORMAT) where STRING is the name of an
124 anniversary class and format is either:
125 1) A format string with the following substitutions (in order):
126 * the name of the record containing this anniversary
127 * the number of years
128 * an ordinal suffix (st, nd, rd, th) for the year
130 2) A function to be called with three arguments: NAME YEARS SUFFIX
131 (string int string) returning a string for the diary or nil.
133 3) An Emacs Lisp form that should evaluate to a string (or nil) in the
134 scope of variables NAME, YEARS and SUFFIX (among others)."
136 :group
'org-bbdb-anniversaries
139 (defcustom org-bbdb-anniversary-field
'anniversary
140 "The BBDB field which contains anniversaries.
141 The anniversaries are stored in the following format
143 YYYY-MM-DD Class-or-Format-String
145 where class is one of the customized classes for anniversaries;
146 birthday and wedding are predefined. Format-String can take three
147 substitutions 1) the name of the record containing this
148 anniversary, 2) the number of years, and 3) an ordinal suffix for
151 Multiple anniversaries can be separated by \\n"
153 :group
'org-bbdb-anniversaries
156 (defcustom org-bbdb-extract-date-fun
'org-bbdb-anniv-extract-date
157 "How to retrieve `month date year' from the anniversary field.
159 Customize if you have already filled your bbdb with dates
160 different from YYYY-MM-DD. The function must return a list (month
163 :group
'org-bbdb-anniversaries
167 ;; Install the link type
168 (org-add-link-type "bbdb" 'org-bbdb-open
'org-bbdb-export
)
169 (add-hook 'org-store-link-functions
'org-bbdb-store-link
)
172 (defun org-bbdb-store-link ()
173 "Store a link to a BBDB database entry."
174 (when (eq major-mode
'bbdb-mode
)
175 ;; This is BBDB, we make this link!
176 (let* ((name (bbdb-record-name (bbdb-current-record)))
177 (company (bbdb-record-getprop (bbdb-current-record) 'company
))
178 (link (org-make-link "bbdb:" name
)))
179 (org-store-link-props :type
"bbdb" :name name
:company company
180 :link link
:description name
)
183 (defun org-bbdb-export (path desc format
)
184 "Create the export version of a BBDB link specified by PATH or DESC.
185 If exporting to either HTML or LaTeX FORMAT the link will be
186 italicised, in all other cases it is left unchanged."
187 "Create the exprt verison of a bbdb link."
189 ((eq format
'html
) (format "<i>%s</i>" (or desc path
)))
190 ((eq format
'latex
) (format "\\textit{%s}" (or desc path
)))
193 (defun org-bbdb-open (name)
194 "Follow a BBDB link to NAME."
196 (let ((inhibit-redisplay (not debug-on-error
))
197 (bbdb-electric-p nil
))
199 ;; Exact match on name
200 (bbdb-name (concat "\\`" name
"\\'") nil
)
201 (if (< 0 (buffer-size (get-buffer "*BBDB*"))) (throw 'exit nil
))
202 ;; Exact match on name
203 (bbdb-company (concat "\\`" name
"\\'") nil
)
204 (if (< 0 (buffer-size (get-buffer "*BBDB*"))) (throw 'exit nil
))
205 ;; Partial match on name
207 (if (< 0 (buffer-size (get-buffer "*BBDB*"))) (throw 'exit nil
))
208 ;; Partial match on company
209 (bbdb-company name nil
)
210 (if (< 0 (buffer-size (get-buffer "*BBDB*"))) (throw 'exit nil
))
211 ;; General match including network address and notes
213 (when (= 0 (buffer-size (get-buffer "*BBDB*")))
214 (delete-window (get-buffer-window "*BBDB*"))
215 (error "No matching BBDB record")))))
217 (defun org-bbdb-anniv-extract-date (time-str)
218 "Convert YYYY-MM-DD to (month date year).
219 Argument TIME-STR is the value retrieved from BBDB."
220 (multiple-value-bind (y m d
) (bbdb-split time-str
"-")
221 (list (string-to-number m
)
223 (string-to-number y
))))
225 (defun org-bbdb-anniv-split (str)
226 "Split mutliple entries in the BBDB anniversary field.
227 Argument STR is the anniversary field in BBDB."
228 (let ((pos (string-match "[ \t]" str
)))
229 (if pos
(list (substring str
0 pos
)
230 (bbdb-string-trim (substring str pos
)))
235 (defun org-bbdb-anniversaries ()
236 "Extract anniversaries from BBDB for display in the agenda."
238 (let ((dates (list (cons (cons (car date
) ; month
240 (nth 2 date
)))) ; year
244 (dolist (rec (bbdb-records))
245 (when (setq annivs
(bbdb-record-getprop
246 rec org-bbdb-anniversary-field
))
247 (setq annivs
(bbdb-split annivs
"\n"))
249 (setq split
(org-bbdb-anniv-split (pop annivs
)))
250 (multiple-value-bind (m d y
)
251 (funcall org-bbdb-extract-date-fun
(car split
))
253 (when (and (or (setq date
(assoc (cons m d
) dates
))
256 (setq date
(assoc '(3 .
1) dates
))
257 (not (calendar-leap-year-p (cdr date
)))))
258 (< 0 (setq years
(- (cdr date
) y
))))
259 (let* ((class (or (cadr split
)
260 org-bbdb-default-anniversary-format
))
261 (form (or (cdr (assoc class
262 org-bbdb-anniversary-format-alist
))
263 class
)) ; (as format string)
264 (name (bbdb-record-name rec
))
265 (suffix (diary-ordinal-suffix years
))
268 (funcall form name years suffix
))
269 ((listp form
) (eval form
))
270 (t (format form name years suffix
)))))
272 (setq text
(append text
(list tmp
)))
273 (setq text
(list tmp
))))
276 (mapconcat 'identity text
"; "))))
280 ;; arch-tag: 9e4f275d-d080-48c1-b040-62247f66b5c2
281 ;;; org-bbdb.el ends here