1 ;;; eudcb-bbdb.el --- Emacs Unified Directory Client - BBDB Backend
3 ;; Copyright (C) 1998, 1999, 2000, 2001, 2002, 2003, 2004,
4 ;; 2005, 2006, 2007, 2008 Free Software Foundation, Inc.
6 ;; Author: Oscar Figueiredo <oscar@cpe.fr>
7 ;; Maintainer: Pavel JanÃk <Pavel@Janik.cz>
10 ;; This file is part of GNU Emacs.
12 ;; GNU Emacs is free software; you can redistribute it and/or modify
13 ;; it under the terms of the GNU General Public License as published by
14 ;; the Free Software Foundation; either version 3, or (at your option)
17 ;; GNU Emacs is distributed in the hope that it will be useful,
18 ;; but WITHOUT ANY WARRANTY; without even the implied warranty of
19 ;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
20 ;; GNU General Public License for more details.
22 ;; You should have received a copy of the GNU General Public License
23 ;; along with GNU Emacs; see the file COPYING. If not, write to the
24 ;; Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor,
25 ;; Boston, MA 02110-1301, USA.
28 ;; This library provides an interface to use BBDB as a backend of
29 ;; the Emacs Unified Directory Client.
34 (if (not (featurep 'bbdb
))
35 (load-library "bbdb"))
36 (if (not (featurep 'bbdb-com
))
37 (load-library "bbdb-com"))
39 ;;{{{ Internal cooking
41 ;; I don't like this but mapcar does not accept a parameter to the function and
42 ;; I don't want to use mapcar*
43 (defvar eudc-bbdb-current-query nil
)
44 (defvar eudc-bbdb-current-return-attributes nil
)
46 (defvar eudc-bbdb-attributes-translation-alist
50 "Alist mapping EUDC attribute names to BBDB names.")
52 (eudc-protocol-set 'eudc-query-function
'eudc-bbdb-query-internal
'bbdb
)
53 (eudc-protocol-set 'eudc-list-attributes-function nil
'bbdb
)
54 (eudc-protocol-set 'eudc-protocol-attributes-translation-alist
55 'eudc-bbdb-attributes-translation-alist
'bbdb
)
56 (eudc-protocol-set 'eudc-bbdb-conversion-alist nil
'bbdb
)
57 (eudc-protocol-set 'eudc-protocol-has-default-query-attributes nil
'bbdb
)
59 (defun eudc-bbdb-format-query (query)
60 "Format a EUDC query alist into a list suitable to `bbdb-search'."
61 (let* ((firstname (cdr (assq 'firstname query
)))
62 (lastname (cdr (assq 'lastname query
)))
63 (name (or (and firstname lastname
64 (concat firstname
" " lastname
))
67 (company (cdr (assq 'company query
)))
68 (net (cdr (assq 'net query
)))
69 (notes (cdr (assq 'notes query
)))
70 (phone (cdr (assq 'phone query
))))
71 (list name company net notes phone
)))
74 (defun eudc-bbdb-filter-non-matching-record (record)
75 "Return RECORD if it matches `eudc-bbdb-current-query', nil otherwise."
81 (let ((attr (car condition
))
85 (or (and (memq attr
'(firstname lastname aka company phones addresses net
))
88 (eval (list (intern (concat "bbdb-record-"
92 (if eudc-bbdb-enable-substring-matches
93 (eval `(or ,@(mapcar '(lambda (subval)
97 (member (downcase val
)
98 (mapcar 'downcase bbdb-val
)))
99 (if eudc-bbdb-enable-substring-matches
100 (string-match val bbdb-val
)
101 (string-equal (downcase val
) (downcase bbdb-val
))))))
102 (throw 'unmatch nil
)))))
103 eudc-bbdb-current-query
)
107 (declare-function bbdb-phone-location
"ext:bbdb" t
) ; via bbdb-defstruct
108 (declare-function bbdb-phone-string
"ext:bbdb" (phone))
109 (declare-function bbdb-record-phones
"ext:bbdb" t
) ; via bbdb-defstruct
110 (declare-function bbdb-address-streets
"ext:bbdb" t
) ; via bbdb-defstruct
111 (declare-function bbdb-address-city
"ext:bbdb" t
) ; via bbdb-defstruct
112 (declare-function bbdb-address-state
"ext:bbdb" t
) ; via bbdb-defstruct
113 (declare-function bbdb-address-zip
"ext:bbdb" t
) ; via bbdb-defstruct
114 (declare-function bbdb-address-location
"ext:bbdb" t
) ; via bbdb-defstruct
115 (declare-function bbdb-record-addresses
"ext:bbdb" t
) ; via bbdb-defstruct
116 (declare-function bbdb-records
"ext:bbdb"
117 (&optional dont-check-disk already-in-db-buffer
))
119 (defun eudc-bbdb-extract-phones (record)
122 (if eudc-bbdb-use-locations-as-attribute-names
123 (cons (intern (bbdb-phone-location phone
))
124 (bbdb-phone-string phone
))
125 (cons 'phones
(format "%s: %s"
126 (bbdb-phone-location phone
)
127 (bbdb-phone-string phone
))))))
128 (bbdb-record-phones record
)))
130 (defun eudc-bbdb-extract-addresses (record)
132 (mapcar (lambda (address)
133 (setq c
(bbdb-address-streets address
))
135 (unless (zerop (length (setq s
(nth n c
))))
136 (setq val
(concat val s
"\n"))))
137 (setq c
(bbdb-address-city address
)
138 s
(bbdb-address-state address
))
139 (setq val
(concat val
140 (if (and (> (length c
) 0) (> (length s
) 0))
144 (bbdb-address-zip address
)))
145 (if eudc-bbdb-use-locations-as-attribute-names
146 (cons (intern (bbdb-address-location address
)) val
)
147 (cons 'addresses
(concat (bbdb-address-location address
)
149 (bbdb-record-addresses record
))))
151 (defun eudc-bbdb-format-record-as-result (record)
152 "Format the BBDB RECORD as a EUDC query result record.
153 The record is filtered according to `eudc-bbdb-current-return-attributes'"
154 (let ((attrs (or eudc-bbdb-current-return-attributes
155 '(firstname lastname aka company phones addresses net notes
)))
160 (setq attr
(car attrs
))
161 (setq attrs
(cdr attrs
)))
164 (setq val
(eudc-bbdb-extract-phones record
)))
165 ((eq attr
'addresses
)
166 (setq val
(eudc-bbdb-extract-addresses record
)))
167 ((memq attr
'(firstname lastname aka company net notes
))
170 (concat "bbdb-record-"
174 (setq val
"Unknown BBDB attribute")))
177 ((memq attr
'(phones addresses
))
178 (setq eudc-rec
(append val eudc-rec
)))
181 (setq eudc-rec
(cons (cons attr
(car val
)) eudc-rec
)))
183 (setq eudc-rec
(cons (cons attr val
) eudc-rec
)))
185 (error "Unexpected attribute value")))))
186 (nreverse eudc-rec
)))
190 (defun eudc-bbdb-query-internal (query &optional return-attrs
)
191 "Query BBDB with QUERY.
192 QUERY is a list of cons cells (ATTR . VALUE) where ATTRs should be valid
193 BBDB attribute names.
194 RETURN-ATTRS is a list of attributes to return, defaulting to
195 `eudc-default-return-attributes'."
197 (let ((eudc-bbdb-current-query query
)
198 (eudc-bbdb-current-return-attributes return-attrs
)
199 (query-attrs (eudc-bbdb-format-query query
))
201 (records (bbdb-records))
204 ;; BBDB ORs its query attributes while EUDC ANDs them, hence we need to
205 ;; call bbdb-search iteratively on the returned records for each of the
206 ;; requested attributes
207 (while (and records
(> (length query-attrs
) 0))
208 (setq bbdb-attrs
(append bbdb-attrs
(list (car query-attrs
))))
209 (if (car query-attrs
)
210 (setq records
(eval `(bbdb-search ,(quote records
) ,@bbdb-attrs
))))
211 (setq query-attrs
(cdr query-attrs
)))
214 (setq filtered
(eudc-filter-duplicate-attributes record
))
215 ;; If there were duplicate attributes reverse the order of the
216 ;; record so the unique attributes appear first
217 (if (> (length filtered
) 1)
218 (setq filtered
(mapcar (function
222 (setq result
(append result filtered
))))
224 (mapcar 'eudc-bbdb-format-record-as-result
226 (mapcar 'eudc-bbdb-filter-non-matching-record
232 ;;{{{ High-level interfaces (interactive functions)
234 (defun eudc-bbdb-set-server (dummy)
235 "Set the EUDC server to BBDB."
237 (eudc-set-server dummy
'bbdb
)
238 (message "BBDB server selected"))
243 (eudc-register-protocol 'bbdb
)
245 (provide 'eudcb-bbdb
)
247 ;; arch-tag: 38276208-75de-4dbc-ba6f-8db684c32e0a
248 ;;; eudcb-bbdb.el ends here