1 ;;; eudcb-ldap.el --- Emacs Unified Directory Client - LDAP Backend
3 ;; Copyright (C) 1998, 1999, 2000, 2001, 2002, 2003, 2004,
4 ;; 2005, 2006, 2007, 2008, 2009, 2010, 2011 Free Software Foundation, Inc.
6 ;; Author: Oscar Figueiredo <oscar@cpe.fr>
7 ;; Maintainer: Pavel JanÃk <Pavel@Janik.cz>
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 of the License, or
16 ;; (at your option) any later version.
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. If not, see <http://www.gnu.org/licenses/>.
27 ;; This library provides specific LDAP protocol support for the
28 ;; Emacs Unified Directory Client package
31 ;; Install EUDC first. See EUDC documentation.
39 ;;{{{ Internal cooking
42 (if (fboundp 'ldap-get-host-parameter)
43 (fset 'eudc-ldap-get-host-parameter 'ldap-get-host-parameter)
44 (defun eudc-ldap-get-host-parameter (host parameter)
45 "Get the value of PARAMETER for HOST in `ldap-host-parameters-alist'."
46 (plist-get (cdr (assoc host ldap-host-parameters-alist))
49 (defvar eudc-ldap-attributes-translation-alist
51 (firstname . givenname)
53 (phone . telephonenumber))
54 "Alist mapping EUDC attribute names to LDAP names.")
56 (eudc-protocol-set 'eudc-query-function 'eudc-ldap-simple-query-internal
58 (eudc-protocol-set 'eudc-list-attributes-function 'eudc-ldap-get-field-list
60 (eudc-protocol-set 'eudc-protocol-attributes-translation-alist
61 'eudc-ldap-attributes-translation-alist 'ldap)
62 (eudc-protocol-set 'eudc-bbdb-conversion-alist
63 'eudc-ldap-bbdb-conversion-alist
65 (eudc-protocol-set 'eudc-protocol-has-default-query-attributes nil 'ldap)
66 (eudc-protocol-set 'eudc-attribute-display-method-alist
67 '(("jpegphoto" . eudc-display-jpeg-inline)
68 ("labeledurl" . eudc-display-url)
69 ("audio" . eudc-display-sound)
70 ("labeleduri" . eudc-display-url)
71 ("mail" . eudc-display-mail)
72 ("url" . eudc-display-url))
74 (eudc-protocol-set 'eudc-switch-to-server-hook
75 '(eudc-ldap-check-base)
78 (defun eudc-ldap-cleanup-record-simple (record)
79 "Do some cleanup in a RECORD to make it suitable for EUDC."
83 (cons (intern (car field))
89 (defun eudc-filter-$ (string)
90 (mapconcat 'identity (split-string string "\\$") "\n"))
92 ;; Cleanup a LDAP record to make it suitable for EUDC:
93 ;; Make the record a cons-cell instead of a list if it is single-valued
94 ;; Filter the $ character in addresses into \n if not done by the LDAP lib
95 (defun eudc-ldap-cleanup-record-filtering-addresses (record)
99 (let ((name (intern (car field)))
101 (if (memq name '(postaladdress registeredaddress))
102 (setq value (mapcar 'eudc-filter-$ value)))
109 (defun eudc-ldap-simple-query-internal (query &optional return-attrs)
110 "Query the LDAP server with QUERY.
111 QUERY is a list of cons cells (ATTR . VALUE) where ATTRs should be valid
112 LDAP attribute names.
113 RETURN-ATTRS is a list of attributes to return, defaulting to
114 `eudc-default-return-attributes'."
115 (let ((result (ldap-search (eudc-ldap-format-query-as-rfc1558 query)
117 (if (listp return-attrs)
118 (mapcar 'symbol-name return-attrs))))
120 (if (or (not (boundp 'ldap-ignore-attribute-codings))
121 ldap-ignore-attribute-codings)
123 (mapcar 'eudc-ldap-cleanup-record-filtering-addresses result))
124 (setq result (mapcar 'eudc-ldap-cleanup-record-simple result)))
126 (if (and eudc-strict-return-matches
128 (not (eq 'all return-attrs)))
129 (setq result (eudc-filter-partial-records result return-attrs)))
130 ;; Apply eudc-duplicate-attribute-handling-method
131 (if (not (eq 'list eudc-duplicate-attribute-handling-method))
133 (function (lambda (record)
135 (append (eudc-filter-duplicate-attributes record)
140 (defun eudc-ldap-get-field-list (dummy &optional objectclass)
141 "Return a list of valid attribute names for the current server.
142 OBJECTCLASS is the LDAP object class for which the valid
143 attribute names are returned. Default to `person'"
146 (call-interactively 'eudc-set-server))
147 (let ((ldap-host-parameters-alist
148 (list (cons eudc-server
149 '(scope subtree sizelimit 1)))))
150 (mapcar 'eudc-ldap-cleanup-record-simple
152 (eudc-ldap-format-query-as-rfc1558
153 (list (cons "objectclass"
156 eudc-server nil t))))
158 (defun eudc-ldap-escape-query-special-chars (string)
159 "Value is STRING with characters forbidden in LDAP queries escaped."
160 ;; Note that * should also be escaped but in most situations I suppose
161 ;; the user doesn't want this
162 (eudc-replace-in-string
163 (eudc-replace-in-string
164 (eudc-replace-in-string
165 (eudc-replace-in-string
170 (char-to-string ?\0) "\\00"))
172 (defun eudc-ldap-format-query-as-rfc1558 (query)
173 "Format the EUDC QUERY list as a RFC1558 LDAP search filter."
176 (mapcar '(lambda (item)
179 (eudc-ldap-escape-query-special-chars (cdr item))))
185 ;;{{{ High-level interfaces (interactive functions)
187 (defun eudc-ldap-customize ()
188 "Customize the EUDC LDAP support."
190 (customize-group 'eudc-ldap))
192 (defun eudc-ldap-check-base ()
193 "Check if the current LDAP server has a configured search base."
194 (unless (or (eudc-ldap-get-host-parameter eudc-server 'base)
196 (null (y-or-n-p "No search base defined. Configure it now? ")))
197 ;; If the server is not in ldap-host-parameters-alist we add it for the
199 (if (null (assoc eudc-server ldap-host-parameters-alist))
200 (setq ldap-host-parameters-alist
201 (cons (list eudc-server) ldap-host-parameters-alist)))
202 (customize-variable 'ldap-host-parameters-alist)))
207 (eudc-register-protocol 'ldap)
209 (provide 'eudcb-ldap)
211 ;;; eudcb-ldap.el ends here