org-bbdb.el 18 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502
  1. ;;; org-bbdb.el --- Support for links to BBDB entries from within Org-mode
  2. ;; Copyright (C) 2004-2015 Free Software Foundation, Inc.
  3. ;; Authors: Carsten Dominik <carsten at orgmode dot org>
  4. ;; Thomas Baumann <thomas dot baumann at ch dot tum dot de>
  5. ;; Keywords: outlines, hypermedia, calendar, wp
  6. ;; Homepage: http://orgmode.org
  7. ;;
  8. ;; This file is part of GNU Emacs.
  9. ;;
  10. ;; GNU Emacs is free software: you can redistribute it and/or modify
  11. ;; it under the terms of the GNU General Public License as published by
  12. ;; the Free Software Foundation, either version 3 of the License, or
  13. ;; (at your option) any later version.
  14. ;; GNU Emacs is distributed in the hope that it will be useful,
  15. ;; but WITHOUT ANY WARRANTY; without even the implied warranty of
  16. ;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
  17. ;; GNU General Public License for more details.
  18. ;; You should have received a copy of the GNU General Public License
  19. ;; along with GNU Emacs. If not, see <http://www.gnu.org/licenses/>.
  20. ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
  21. ;;
  22. ;;; Commentary:
  23. ;; This file implements links to BBDB database entries from within Org-mode.
  24. ;; Org-mode loads this module by default - if this is not what you want,
  25. ;; configure the variable `org-modules'.
  26. ;; It also implements an interface (based on Ivar Rummelhoff's
  27. ;; bbdb-anniv.el) for those org-mode users, who do not use the diary
  28. ;; but who do want to include the anniversaries stored in the BBDB
  29. ;; into the org-agenda. If you already include the `diary' into the
  30. ;; agenda, you might want to prefer to include the anniversaries in
  31. ;; the diary using bbdb-anniv.el.
  32. ;;
  33. ;; Put the following in /somewhere/at/home/diary.org and make sure
  34. ;; that this file is in `org-agenda-files'.
  35. ;;
  36. ;; %%(org-bbdb-anniversaries)
  37. ;;
  38. ;; For example my diary.org looks like:
  39. ;; * Anniversaries
  40. ;; #+CATEGORY: Anniv
  41. ;; %%(org-bbdb-anniversaries)
  42. ;;
  43. ;;
  44. ;; To add an anniversary to a BBDB record, press `C-o' in the record.
  45. ;; You will be prompted for the field name, in this case it must be
  46. ;; "anniversary". If this is the first time you are using this field,
  47. ;; you need to confirm that it should be created.
  48. ;;
  49. ;; The format of an anniversary field stored in BBDB is the following
  50. ;; (items in {} are optional):
  51. ;;
  52. ;; YYYY-MM-DD{ CLASS-OR-FORMAT-STRING}
  53. ;; {\nYYYY-MM-DD CLASS-OR-FORMAT-STRING}...
  54. ;;
  55. ;; CLASS-OR-FORMAT-STRING is one of two things:
  56. ;;
  57. ;; - an identifier for a class of anniversaries (eg. birthday or
  58. ;; wedding) from `org-bbdb-anniversary-format-alist' which then
  59. ;; defines the format string for this class
  60. ;; - the (format) string displayed in the diary.
  61. ;;
  62. ;; You can enter multiple anniversaries for a single BBDB record by
  63. ;; separating them with a newline character. At the BBDB prompt for
  64. ;; the field value, type `C-q C-j' to enter a newline between two
  65. ;; anniversaries.
  66. ;;
  67. ;; If you omit the CLASS-OR-FORMAT-STRING entirely, it defaults to the
  68. ;; value of `org-bbdb-default-anniversary-format' ("birthday" by
  69. ;; default).
  70. ;;
  71. ;; The substitutions in the format string are (in order):
  72. ;; - the name of the record containing this anniversary
  73. ;; - the number of years
  74. ;; - an ordinal suffix (st, nd, rd, th) for the year
  75. ;;
  76. ;; See the documentation of `org-bbdb-anniversary-format-alist' for
  77. ;; further options.
  78. ;;
  79. ;; Example
  80. ;;
  81. ;; 1973-06-22
  82. ;; 20??-??-?? wedding
  83. ;; 1998-03-12 %s created bbdb-anniv.el %d years ago
  84. ;;
  85. ;; From Org's agenda, you can use `C-c C-o' to jump to the BBDB
  86. ;; link from which the entry at point originates.
  87. ;;
  88. ;;; Code:
  89. (require 'org)
  90. (eval-when-compile
  91. (require 'cl))
  92. ;; Declare external functions and variables
  93. (declare-function bbdb "ext:bbdb-com" (string elidep))
  94. (declare-function bbdb-company "ext:bbdb-com" (string elidep))
  95. (declare-function bbdb-current-record "ext:bbdb-com"
  96. (&optional planning-on-modifying))
  97. (declare-function bbdb-name "ext:bbdb-com" (string elidep))
  98. (declare-function bbdb-completing-read-record "ext:bbdb-com"
  99. (prompt &optional omit-records))
  100. (declare-function bbdb-record-getprop "ext:bbdb" (record property))
  101. (declare-function bbdb-record-name "ext:bbdb" (record))
  102. (declare-function bbdb-records "ext:bbdb"
  103. (&optional dont-check-disk already-in-db-buffer))
  104. (declare-function bbdb-split "ext:bbdb" (string separators))
  105. (declare-function bbdb-string-trim "ext:bbdb" (string))
  106. (declare-function bbdb-record-get-field "ext:bbdb" (record field))
  107. (declare-function bbdb-search-name "ext:bbdb-com" (regexp &optional layout))
  108. (declare-function bbdb-search-organization "ext:bbdb-com" (regexp &optional layout))
  109. ;; `bbdb-record-note' was part of BBDB v3.x
  110. (declare-function bbdb-record-note "ext:bbdb" (record label))
  111. ;; `bbdb-record-xfield' replaces it in recent BBDB v3.x+
  112. (declare-function bbdb-record-xfield "ext:bbdb" (record label))
  113. (declare-function calendar-leap-year-p "calendar" (year))
  114. (declare-function diary-ordinal-suffix "diary-lib" (n))
  115. (org-no-warnings (defvar date)) ;; unprefixed, from calendar.el
  116. ;; Customization
  117. (defgroup org-bbdb-anniversaries nil
  118. "Customizations for including anniversaries from BBDB into Agenda."
  119. :group 'org-bbdb)
  120. (defcustom org-bbdb-default-anniversary-format "birthday"
  121. "Default anniversary class."
  122. :type 'string
  123. :group 'org-bbdb-anniversaries
  124. :require 'bbdb)
  125. (defcustom org-bbdb-anniversary-format-alist
  126. '(("birthday" .
  127. (lambda (name years suffix)
  128. (concat "Birthday: [[bbdb:" name "][" name " ("
  129. (format "%s" years) ; handles numbers as well as strings
  130. suffix ")]]")))
  131. ("wedding" .
  132. (lambda (name years suffix)
  133. (concat "[[bbdb:" name "][" name "'s "
  134. (format "%s" years)
  135. suffix " wedding anniversary]]"))))
  136. "How different types of anniversaries should be formatted.
  137. An alist of elements (STRING . FORMAT) where STRING is the name of an
  138. anniversary class and format is either:
  139. 1) A format string with the following substitutions (in order):
  140. - the name of the record containing this anniversary
  141. - the number of years
  142. - an ordinal suffix (st, nd, rd, th) for the year
  143. 2) A function to be called with three arguments: NAME YEARS SUFFIX
  144. (string int string) returning a string for the diary or nil.
  145. 3) An Emacs Lisp form that should evaluate to a string (or nil) in the
  146. scope of variables NAME, YEARS and SUFFIX (among others)."
  147. :type '(alist :key-type (string :tag "Class")
  148. :value-type (function :tag "Function"))
  149. :group 'org-bbdb-anniversaries
  150. :require 'bbdb)
  151. (defcustom org-bbdb-anniversary-field 'anniversary
  152. "The BBDB field which contains anniversaries.
  153. The anniversaries are stored in the following format
  154. YYYY-MM-DD Class-or-Format-String
  155. where class is one of the customized classes for anniversaries;
  156. birthday and wedding are predefined. Format-String can take three
  157. substitutions 1) the name of the record containing this
  158. anniversary, 2) the number of years, and 3) an ordinal suffix for
  159. the year.
  160. Multiple anniversaries can be separated by \\n."
  161. :type 'symbol
  162. :group 'org-bbdb-anniversaries
  163. :require 'bbdb)
  164. (defcustom org-bbdb-extract-date-fun 'org-bbdb-anniv-extract-date
  165. "How to retrieve `month date year' from the anniversary field.
  166. Customize if you have already filled your BBDB with dates
  167. different from YYYY-MM-DD. The function must return a list (month
  168. date year)."
  169. :type 'function
  170. :group 'org-bbdb-anniversaries
  171. :require 'bbdb)
  172. ;; Install the link type
  173. (org-add-link-type "bbdb" 'org-bbdb-open 'org-bbdb-export)
  174. (add-hook 'org-store-link-functions 'org-bbdb-store-link)
  175. ;; Implementation
  176. (defun org-bbdb-store-link ()
  177. "Store a link to a BBDB database entry."
  178. (when (eq major-mode 'bbdb-mode)
  179. ;; This is BBDB, we make this link!
  180. (let* ((rec (bbdb-current-record))
  181. (name (bbdb-record-name rec))
  182. (company (if (fboundp 'bbdb-record-getprop)
  183. (bbdb-record-getprop rec 'company)
  184. (car (bbdb-record-get-field rec 'organization))))
  185. (link (concat "bbdb:" name)))
  186. (org-store-link-props :type "bbdb" :name name :company company
  187. :link link :description name)
  188. link)))
  189. (defun org-bbdb-export (path desc format)
  190. "Create the export version of a BBDB link specified by PATH or DESC.
  191. If exporting to either HTML or LaTeX FORMAT the link will be
  192. italicized, in all other cases it is left unchanged."
  193. (when (string= desc (format "bbdb:%s" path))
  194. (setq desc path))
  195. (cond
  196. ((eq format 'html) (format "<i>%s</i>" desc))
  197. ((eq format 'latex) (format "\\textit{%s}" desc))
  198. ((eq format 'odt)
  199. (format "<text:span text:style-name=\"Emphasis\">%s</text:span>" desc))
  200. (t desc)))
  201. (defun org-bbdb-open (name)
  202. "Follow a BBDB link to NAME."
  203. (require 'bbdb-com)
  204. (let ((inhibit-redisplay (not debug-on-error))
  205. (bbdb-electric-p nil))
  206. (if (fboundp 'bbdb-name)
  207. (org-bbdb-open-old name)
  208. (org-bbdb-open-new name))))
  209. (defun org-bbdb-open-old (name)
  210. (catch 'exit
  211. ;; Exact match on name
  212. (bbdb-name (concat "\\`" name "\\'") nil)
  213. (if (< 0 (buffer-size (get-buffer "*BBDB*"))) (throw 'exit nil))
  214. ;; Exact match on name
  215. (bbdb-company (concat "\\`" name "\\'") nil)
  216. (if (< 0 (buffer-size (get-buffer "*BBDB*"))) (throw 'exit nil))
  217. ;; Partial match on name
  218. (bbdb-name name nil)
  219. (if (< 0 (buffer-size (get-buffer "*BBDB*"))) (throw 'exit nil))
  220. ;; Partial match on company
  221. (bbdb-company name nil)
  222. (if (< 0 (buffer-size (get-buffer "*BBDB*"))) (throw 'exit nil))
  223. ;; General match including network address and notes
  224. (bbdb name nil)
  225. (when (= 0 (buffer-size (get-buffer "*BBDB*")))
  226. (delete-window (get-buffer-window "*BBDB*"))
  227. (error "No matching BBDB record"))))
  228. (defun org-bbdb-open-new (name)
  229. (catch 'exit
  230. ;; Exact match on name
  231. (bbdb-search-name (concat "\\`" name "\\'") nil)
  232. (if (< 0 (buffer-size (get-buffer "*BBDB*"))) (throw 'exit nil))
  233. ;; Exact match on name
  234. (bbdb-search-organization (concat "\\`" name "\\'") nil)
  235. (if (< 0 (buffer-size (get-buffer "*BBDB*"))) (throw 'exit nil))
  236. ;; Partial match on name
  237. (bbdb-search-name name nil)
  238. (if (< 0 (buffer-size (get-buffer "*BBDB*"))) (throw 'exit nil))
  239. ;; Partial match on company
  240. (bbdb-search-organization name nil)
  241. (if (< 0 (buffer-size (get-buffer "*BBDB*"))) (throw 'exit nil))
  242. ;; General match including network address and notes
  243. (bbdb name nil)
  244. (when (= 0 (buffer-size (get-buffer "*BBDB*")))
  245. (delete-window (get-buffer-window "*BBDB*"))
  246. (error "No matching BBDB record"))))
  247. (defun org-bbdb-anniv-extract-date (time-str)
  248. "Convert YYYY-MM-DD to (month date year).
  249. Argument TIME-STR is the value retrieved from BBDB. If YYYY- is omitted
  250. it will be considered unknown."
  251. (multiple-value-bind (a b c) (values-list (org-split-string time-str "-"))
  252. (if (eq c nil)
  253. (list (string-to-number a)
  254. (string-to-number b)
  255. nil)
  256. (list (string-to-number b)
  257. (string-to-number c)
  258. (string-to-number a)))))
  259. (defun org-bbdb-anniv-split (str)
  260. "Split multiple entries in the BBDB anniversary field.
  261. Argument STR is the anniversary field in BBDB."
  262. (let ((pos (string-match "[ \t]" str)))
  263. (if pos (list (substring str 0 pos)
  264. (bbdb-string-trim (substring str pos)))
  265. (list str nil))))
  266. (defvar org-bbdb-anniv-hash nil
  267. "A hash holding anniversaries extracted from BBDB.
  268. The hash table is created on first use.")
  269. (defvar org-bbdb-updated-p t
  270. "This is non-nil if BBDB has been updated since we last built the hash.")
  271. (defun org-bbdb-make-anniv-hash ()
  272. "Create a hash with anniversaries extracted from BBDB, for fast access.
  273. The anniversaries are assumed to be stored `org-bbdb-anniversary-field'."
  274. (let ((old-bbdb (fboundp 'bbdb-record-getprop))
  275. (record-func (if (fboundp 'bbdb-record-xfield)
  276. 'bbdb-record-xfield
  277. 'bbdb-record-note))
  278. split tmp annivs)
  279. (clrhash org-bbdb-anniv-hash)
  280. (dolist (rec (bbdb-records))
  281. (when (setq annivs (if old-bbdb
  282. (bbdb-record-getprop
  283. rec org-bbdb-anniversary-field)
  284. (funcall record-func
  285. rec org-bbdb-anniversary-field)))
  286. (setq annivs (if old-bbdb
  287. (bbdb-split annivs "\n")
  288. ;; parameter order is reversed in new bbdb
  289. (bbdb-split "\n" annivs)))
  290. (while annivs
  291. (setq split (org-bbdb-anniv-split (pop annivs)))
  292. (multiple-value-bind (m d y)
  293. (values-list (funcall org-bbdb-extract-date-fun (car split)))
  294. (setq tmp (gethash (list m d) org-bbdb-anniv-hash))
  295. (puthash (list m d) (cons (list y
  296. (bbdb-record-name rec)
  297. (cadr split))
  298. tmp)
  299. org-bbdb-anniv-hash))))))
  300. (setq org-bbdb-updated-p nil))
  301. (defun org-bbdb-updated (rec)
  302. "Record the fact that BBDB has been updated.
  303. This is used by Org to re-create the anniversary hash table."
  304. (setq org-bbdb-updated-p t))
  305. (add-hook 'bbdb-after-change-hook 'org-bbdb-updated)
  306. ;;;###autoload
  307. (defun org-bbdb-anniversaries ()
  308. "Extract anniversaries from BBDB for display in the agenda."
  309. (require 'bbdb)
  310. (require 'diary-lib)
  311. (unless (hash-table-p org-bbdb-anniv-hash)
  312. (setq org-bbdb-anniv-hash
  313. (make-hash-table :test 'equal :size 366)))
  314. (when (or org-bbdb-updated-p
  315. (= 0 (hash-table-count org-bbdb-anniv-hash)))
  316. (org-bbdb-make-anniv-hash))
  317. (let* ((m (car date)) ; month
  318. (d (nth 1 date)) ; day
  319. (y (nth 2 date)) ; year
  320. (annivs (gethash (list m d) org-bbdb-anniv-hash))
  321. (text ())
  322. rec recs)
  323. ;; we don't want to miss people born on Feb. 29th
  324. (when (and (= m 3) (= d 1)
  325. (not (null (gethash (list 2 29) org-bbdb-anniv-hash)))
  326. (not (calendar-leap-year-p y)))
  327. (setq recs (gethash (list 2 29) org-bbdb-anniv-hash))
  328. (while (setq rec (pop recs))
  329. (push rec annivs)))
  330. (when annivs
  331. (while (setq rec (pop annivs))
  332. (when rec
  333. (let* ((class (or (nth 2 rec)
  334. org-bbdb-default-anniversary-format))
  335. (form (or (cdr (assoc-string
  336. class org-bbdb-anniversary-format-alist t))
  337. class)) ; (as format string)
  338. (name (nth 1 rec))
  339. (years (if (eq (car rec) nil)
  340. "unknown"
  341. (- y (car rec))))
  342. (suffix (if (eq (car rec) nil)
  343. ""
  344. (diary-ordinal-suffix years)))
  345. (tmp (cond
  346. ((functionp form)
  347. (funcall form name years suffix))
  348. ((listp form) (eval form))
  349. (t (format form name years suffix)))))
  350. (org-add-props tmp nil 'org-bbdb-name name)
  351. (if text
  352. (setq text (append text (list tmp)))
  353. (setq text (list tmp)))))
  354. ))
  355. text))
  356. ;;; Return list of anniversaries for today and the next n-1 (default: n=7) days.
  357. ;;; This is meant to be used in an org file instead of org-bbdb-anniversaries:
  358. ;;;
  359. ;;; %%(org-bbdb-anniversaries-future)
  360. ;;;
  361. ;;; or
  362. ;;;
  363. ;;; %%(org-bbdb-anniversaries-future 3)
  364. ;;;
  365. ;;; to override the 7-day default.
  366. (defun org-bbdb-date-list (date n)
  367. "Return a list of dates in (m d y) format from the given 'date' to n-1 days hence."
  368. (let ((abs (calendar-absolute-from-gregorian date))
  369. ret)
  370. (dotimes (i n (nreverse ret))
  371. (push (calendar-gregorian-from-absolute (+ abs i)) ret))))
  372. ;;;###autoload
  373. (defun org-bbdb-anniversaries-future (&optional n)
  374. "Return list of anniversaries for today and the next n-1 days (default n=7)."
  375. (let ((n (or n 7)))
  376. (when (<= n 0)
  377. (error "The (optional) argument of `org-bbdb-anniversaries-future' must be positive"))
  378. (let (
  379. ;; List of relevant dates.
  380. (dates (org-bbdb-date-list date n))
  381. ;; Function to annotate text of each element of l with the anniversary date d.
  382. (annotate-descriptions
  383. (lambda (d l)
  384. (mapcar (lambda (x)
  385. ;; The assumption here is that x is a bbdb link of the form
  386. ;; [[bbdb:name][description]].
  387. ;; This function rather arbitrarily modifies the description
  388. ;; by adding the date to it in a fixed format.
  389. (string-match "]]" x)
  390. (replace-match (format " -- %d-%02d-%02d\\&" (third d) (first d) (second d))
  391. nil nil x))
  392. l))))
  393. ;; Map a function that generates anniversaries for each date over the dates
  394. ;; and nconc the results into a single list. When it is no longer necessary
  395. ;; to support older versions of emacs, this can be done with a cl-mapcan;
  396. ;; for now, we use the (apply #'nconc ...) method for compatibility.
  397. (apply #'nconc
  398. (mapcar
  399. (lambda (d)
  400. (let ((date d))
  401. ;; Rebind 'date' so that org-bbdb-anniversaries will be
  402. ;; fooled into giving us the list for the given date
  403. ;; and then annotate the descriptions for that date.
  404. (funcall annotate-descriptions d (org-bbdb-anniversaries))))
  405. dates)))))
  406. (defun org-bbdb-complete-link ()
  407. "Read a bbdb link with name completion."
  408. (require 'bbdb-com)
  409. (let ((rec (bbdb-completing-read-record "Name: ")))
  410. (concat "bbdb:"
  411. (bbdb-record-name (if (listp rec)
  412. (car rec)
  413. rec)))))
  414. (defun org-bbdb-anniv-export-ical ()
  415. "Extract anniversaries from BBDB and convert them to icalendar format."
  416. (require 'bbdb)
  417. (require 'diary-lib)
  418. (unless (hash-table-p org-bbdb-anniv-hash)
  419. (setq org-bbdb-anniv-hash
  420. (make-hash-table :test 'equal :size 366)))
  421. (when (or org-bbdb-updated-p
  422. (= 0 (hash-table-count org-bbdb-anniv-hash)))
  423. (org-bbdb-make-anniv-hash))
  424. (maphash 'org-bbdb-format-vevent org-bbdb-anniv-hash))
  425. (defun org-bbdb-format-vevent (key recs)
  426. (let (rec categ)
  427. (while (setq rec (pop recs))
  428. (setq categ (or (nth 2 rec) org-bbdb-default-anniversary-format))
  429. (princ (format "BEGIN:VEVENT
  430. UID: ANNIV-%4i%02i%02i-%s
  431. DTSTART:%4i%02i%02i
  432. SUMMARY:%s
  433. DESCRIPTION:%s
  434. CATEGORIES:%s
  435. RRULE:FREQ=YEARLY
  436. END:VEVENT\n"
  437. (nth 0 rec) (nth 0 key) (nth 1 key)
  438. (mapconcat 'identity
  439. (org-split-string (nth 1 rec) "[^a-zA-Z0-90]+")
  440. "-")
  441. (nth 0 rec) (nth 0 key) (nth 1 key)
  442. (nth 1 rec)
  443. (concat (capitalize categ) " " (nth 1 rec))
  444. categ)))))
  445. (provide 'org-bbdb)
  446. ;; Local variables:
  447. ;; generated-autoload-file: "org-loaddefs.el"
  448. ;; End:
  449. ;;; org-bbdb.el ends here