1 ;;; eudcb-ldap.el --- Emacs Unified Directory Client - LDAP Backend
3 ;; Copyright (C) 1998, 1999, 2000 Free Software Foundation, Inc.
5 ;; Author: Oscar Figueiredo <oscar@xemacs.org>
6 ;; Maintainer: Oscar Figueiredo <oscar@xemacs.org>
9 ;; This file is part of GNU Emacs.
11 ;; GNU Emacs is free software; you can redistribute it and/or modify
12 ;; it under the terms of the GNU General Public License as published by
13 ;; the Free Software Foundation; either version 2, or (at your option)
16 ;; GNU Emacs is distributed in the hope that it will be useful,
17 ;; but WITHOUT ANY WARRANTY; without even the implied warranty of
18 ;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
19 ;; GNU General Public License for more details.
21 ;; You should have received a copy of the GNU General Public License
22 ;; along with GNU Emacs; see the file COPYING. If not, write to the
23 ;; Free Software Foundation, Inc., 59 Temple Place - Suite 330,
24 ;; Boston, MA 02111-1307, USA.
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 ("labeledurl" . eudc-display-url)
71 ("url" . eudc-display-url))
73 (eudc-protocol-set 'eudc-switch-to-server-hook
74 '(eudc-ldap-check-base)
77 (defun eudc-ldap-cleanup-record-simple (record)
78 "Do some cleanup in a RECORD to make it suitable for EUDC."
82 (cons (intern (car field))
88 (defun eudc-filter-$ (string)
89 (mapconcat 'identity (split-string string "\\$") "\n"))
91 ;; Cleanup a LDAP record to make it suitable for EUDC:
92 ;; Make the record a cons-cell instead of a list if the it's single-valued
93 ;; Filter the $ character in addresses into \n if not done by the LDAP lib
94 (defun eudc-ldap-cleanup-record-filtering-addresses (record)
98 (let ((name (intern (car field)))
100 (if (memq name '(postaladdress registeredaddress))
101 (setq value (mapcar 'eudc-filter-$ value)))
108 (defun eudc-ldap-simple-query-internal (query &optional return-attrs)
109 "Query the LDAP server with QUERY.
110 QUERY is a list of cons cells (ATTR . VALUE) where ATTRs should be valid
111 LDAP attribute names.
112 RETURN-ATTRS is a list of attributes to return, defaulting to
113 `eudc-default-return-attributes'."
114 (let ((result (ldap-search (eudc-ldap-format-query-as-rfc1558 query)
116 (if (listp return-attrs)
117 (mapcar 'symbol-name return-attrs))))
119 (if (or (not (boundp 'ldap-ignore-attribute-codings))
120 ldap-ignore-attribute-codings)
122 (mapcar 'eudc-ldap-cleanup-record-filtering-addresses result))
123 (setq result (mapcar 'eudc-ldap-cleanup-record-simple result)))
125 (if (and eudc-strict-return-matches
127 (not (eq 'all return-attrs)))
128 (setq result (eudc-filter-partial-records result return-attrs)))
129 ;; Apply eudc-duplicate-attribute-handling-method
130 (if (not (eq 'list eudc-duplicate-attribute-handling-method))
132 (function (lambda (record)
134 (append (eudc-filter-duplicate-attributes record)
139 (defun eudc-ldap-get-field-list (dummy &optional objectclass)
140 "Return a list of valid attribute names for the current server.
141 OBJECTCLASS is the LDAP object class for which the valid
142 attribute names are returned. Default to `person'"
145 (call-interactively 'eudc-set-server))
146 (let ((ldap-host-parameters-alist
147 (list (cons eudc-server
148 '(scope subtree sizelimit 1)))))
149 (mapcar 'eudc-ldap-cleanup-record
151 (eudc-ldap-format-query-as-rfc1558
152 (list (cons "objectclass"
155 eudc-server nil t))))
157 (defun eudc-ldap-escape-query-special-chars (string)
158 "Value is STRING with characters forbidden in LDAP queries escaped."
159 ;; Note that * should also be escaped but in most situations I suppose
160 ;; the user doesn't want this
161 (eudc-replace-in-string
162 (eudc-replace-in-string
163 (eudc-replace-in-string
164 (eudc-replace-in-string
169 (char-to-string ?\0) "\\00"))
171 (defun eudc-ldap-format-query-as-rfc1558 (query)
172 "Format the EUDC QUERY list as a RFC1558 LDAP search filter."
175 (mapcar '(lambda (item)
178 (eudc-ldap-escape-query-special-chars (cdr item))))
184 ;;{{{ High-level interfaces (interactive functions)
186 (defun eudc-ldap-customize ()
187 "Customize the EUDC LDAP support."
189 (customize-group 'eudc-ldap))
191 (defun eudc-ldap-check-base ()
192 "Check if the current LDAP server has a configured search base."
193 (unless (or (eudc-ldap-get-host-parameter eudc-server 'base)
195 (null (y-or-n-p "No search base defined. Configure it now ?")))
196 ;; If the server is not in ldap-host-parameters-alist we add it for the
198 (if (null (assoc eudc-server ldap-host-parameters-alist))
199 (setq ldap-host-parameters-alist
200 (cons (list eudc-server) ldap-host-parameters-alist)))
201 (customize-variable 'ldap-host-parameters-alist)))
206 (eudc-register-protocol 'ldap)
208 (provide 'eudcb-ldap)
210 ;;; eudcb-ldap.el ends here