lisp/org-bbdb.el

   1 ;;; org-bbdb.el --- Support for links to BBDB entries from within Org-mode
   2
   3 ;; Copyright (C) 2004, 2005, 2006, 2007, 2008 Free Software Foundation, Inc.
   4
   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
   9 ;; Version: 6.01a
  10 ;;
  11 ;; This file is part of GNU Emacs.
  12 ;;
  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)
  16 ;; any later version.
  17
  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.
  22
  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 ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
  28 ;;
  29 ;;; Commentary:
  30
  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'.
  34
  35
  36 ;; It also implements an interface for those org-mode users, who do
  37 ;; not use the diary but who do want to include the anniversaries
  38 ;; stored in the BBDB into the org-agenda.  If you already include the
  39 ;; `diary' into the agenda, you'd better include the anniversaries in
  40 ;; the diary using bbdb-anniv.el
  41 ;;
  42 ;; Put the following in /somewhere/at/home/diary.org and make sure
  43 ;; that this file is in `org-agenda-files`
  44 ;;
  45 ;; %%(org-bbdb-anniversaries)
  46 ;;
  47 ;; For example my diary.org looks like:
  48 ;; * Anniversaries
  49 ;; #+CATEGORY: Anniv
  50 ;; %%(org-bbdb-anniversaries)
  51 ;;
  52 ;;
  53 ;; The anniversaries are stored in BBDB in the field `anniversary'
  54 ;; in the format
  55 ;;
  56 ;;     YYYY-MM-DD{ CLASS-OR-FORMAT-STRING}*
  57 ;;     {\nYYYY-MM-DD CLASS-OR-FORMAT-STRING}*
  58 ;;
  59 ;; CLASS-OR-FORMAT-STRING is one of two things:
  60 ;;
  61 ;;  * an identifier for a class of anniversaries (eg. birthday or
  62 ;;    wedding) from `org-bbdb-anniversary-format-alist'.
  63 ;;  * the (format) string displayed in the diary.
  64 ;;
  65 ;; It defaults to the value of `org-bbdb-default-anniversary-format'
  66 ;; ("birthday" by default).
  67 ;;
  68 ;; The substitutions in the format string are (in order):
  69 ;;  * the name of the record containing this anniversary
  70 ;;  * the number of years
  71 ;;  * an ordinal suffix (st, nd, rd, th) for the year
  72 ;;
  73 ;; See the documentation of `org-bbdb-anniversary-format-alist' for
  74 ;; further options.
  75 ;;
  76 ;; Example
  77 ;;
  78 ;;       1973-06-22
  79 ;;       20??-??-?? wedding
  80 ;;       1998-03-12 %s created bbdb-anniv.el %d years ago
  81
  82 ;;; Code:
  83
  84 (require 'org)
  85 (eval-when-compile
  86   (require 'cl))
  87
  88 ;; Declare external functions and variables
  89
  90 (declare-function bbdb "ext:bbdb-com" (string elidep))
  91 (declare-function bbdb-company "ext:bbdb-com" (string elidep))
  92 (declare-function bbdb-current-record "ext:bbdb-com"
  93                   (&optional planning-on-modifying))
  94 (declare-function bbdb-name "ext:bbdb-com" (string elidep))
  95 (declare-function bbdb-record-getprop "ext:bbdb" (record property))
  96 (declare-function bbdb-record-name "ext:bbdb" (record))
  97 (declare-function bbdb-records "ext:bbdb"
  98           (&optional dont-check-disk already-in-db-buffer))
  99 (declare-function bbdb-split "ext:bbdb" (string separators))
 100 (declare-function bbdb-string-trim "ext:bbdb" (string))
 101 (declare-function calendar-extract-day "calendar" (date))
 102 (declare-function calendar-extract-month "calendar" (date))
 103 (declare-function calendar-extract-year "calendar" (date))
 104 (declare-function calendar-leap-year-p "calendar" (year))
 105 (declare-function diary-ordinal-suffix "diary-lib" (n))
 106
 107 (defvar date)
 108
 109 (defgroup org-bbdb-anniversaries nil
 110   "Customizations for including anniversaries from BBDB into Agenda."
 111   :group 'org-bbdb)
 112
 113 (defcustom org-bbdb-default-anniversary-format "birthday"
 114   "Default anniversary class."
 115   :type  'string
 116   :group 'org-bbdb-anniversaries
 117   :require 'bbdb)
 118
 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
 129
 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.
 132
 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)."
 135   :type 'sexp
 136   :group 'org-bbdb-anniversaries
 137   :require 'bbdb)
 138
 139 (defcustom org-bbdb-anniversary-field 'anniversary
 140   "The BBDB field which contains anniversaries.
 141 The anniversaries are stored in the following format
 142
 143 YYYY-MM-DD Class-or-Format-String
 144
 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
 149 the year.
 150
 151 Multiple anniversaries can be separated by \\n"
 152   :type    'symbol
 153   :group   'org-bbdb-anniversaries
 154   :require 'bbdb)
 155
 156 (defcustom org-bbdb-extract-date-fun 'org-bbdb-anniv-extract-date
 157   "How to retrieve `month date year' from the anniversary field.
 158
 159 Customize if you have already filled your bbdb with dates
 160 different from YYYY-MM-DD.  The function must return a list (month
 161 date year)"
 162   :type 'function
 163   :group 'org-bbdb-anniversaries
 164   :require 'bbdb)
 165
 166
 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)
 170
 171 ;; Implementation
 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)
 181       link)))
 182
 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."
 188   (cond
 189    ((eq format 'html) (format "<i>%s</i>" (or desc path)))
 190    ((eq format 'latex) (format "\\textit{%s}" (or desc path)))
 191    (t (or desc path))))
 192
 193 (defun org-bbdb-open (name)
 194   "Follow a BBDB link to NAME."
 195   (require 'bbdb)
 196   (let ((inhibit-redisplay (not debug-on-error))
 197         (bbdb-electric-p nil))
 198     (catch 'exit
 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
 206       (bbdb-name name nil)
 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
 212       (bbdb name nil)
 213       (when (= 0 (buffer-size (get-buffer "*BBDB*")))
 214         (delete-window (get-buffer-window "*BBDB*"))
 215         (error "No matching BBDB record")))))
 216
 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)
 222           (string-to-number d)
 223           (string-to-number y))))
 224
 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)))
 231       (list str nil))))
 232
 233
 234 ;;;###autoload
 235 (defun org-bbdb-anniversaries ()
 236   "Extract anniversaries from BBDB for display in the agenda."
 237   (require 'diary-lib)
 238   (let ((dates (list (cons (cons (calendar-extract-month date)
 239                                  (calendar-extract-day date))
 240                            (calendar-extract-year date))))
 241         (text ())
 242         annivs date years
 243         split class form)
 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"))
 248         (while annivs
 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))
 252
 253             (when (and (or (setq date (assoc (cons m d) dates))
 254                            (and (= d 29)
 255                                 (= m 2)
 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))
 266                      (tmp (cond
 267                            ((functionp form)
 268                             (funcall form name years suffix))
 269                            ((listp form) (eval form))
 270                            (t (format form name years suffix)))))
 271                 (if text
 272                     (setq text (append text (list tmp)))
 273                   (setq text (list tmp))))
 274               )))))
 275     (when text
 276       (mapconcat 'identity text "; "))))
 277
 278 (provide 'org-bbdb)
 279
 280 ;;; org-bbdb.el ends here