1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
|
;;; eudcb-ldap.el --- Emacs Unified Directory Client - LDAP Backend -*- lexical-binding: t; -*-
;; Copyright (C) 1998-2025 Free Software Foundation, Inc.
;; Author: Oscar Figueiredo <oscar@cpe.fr>
;; Pavel JanÃk <Pavel@Janik.cz>
;; Maintainer: Thomas Fitzsimmons <fitzsim@fitzsim.org>
;; Keywords: comm
;; Package: eudc
;; This file is part of GNU Emacs.
;; GNU Emacs is free software: you can redistribute it and/or modify
;; it under the terms of the GNU General Public License as published by
;; the Free Software Foundation, either version 3 of the License, or
;; (at your option) any later version.
;; GNU Emacs is distributed in the hope that it will be useful,
;; but WITHOUT ANY WARRANTY; without even the implied warranty of
;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
;; GNU General Public License for more details.
;; You should have received a copy of the GNU General Public License
;; along with GNU Emacs. If not, see <https://www.gnu.org/licenses/>.
;;; Commentary:
;; This library provides specific LDAP protocol support for the
;; Emacs Unified Directory Client package
;;; Installation:
;; Install EUDC first. See EUDC documentation.
;;; Code:
(require 'eudc)
(require 'ldap)
;;{{{ Internal cooking
(defvar eudc-ldap-attributes-translation-alist
'((name . sn)
(firstname . givenname)
(email . mail)
(phone . telephonenumber))
"Alist mapping EUDC attribute names to LDAP names.")
(eudc-protocol-set 'eudc-query-function 'eudc-ldap-simple-query-internal
'ldap)
(eudc-protocol-set 'eudc-list-attributes-function 'eudc-ldap-get-field-list
'ldap)
(eudc-protocol-set 'eudc-protocol-attributes-translation-alist
'eudc-ldap-attributes-translation-alist 'ldap)
(eudc-protocol-set 'eudc-bbdb-conversion-alist
'eudc-ldap-bbdb-conversion-alist
'ldap)
(eudc-protocol-set 'eudc-protocol-has-default-query-attributes nil 'ldap)
(eudc-protocol-set 'eudc-attribute-display-method-alist
'(("jpegphoto" . eudc-display-jpeg-inline)
("labeledurl" . eudc-display-url)
("audio" . eudc-display-sound)
("labeleduri" . eudc-display-url)
("mail" . eudc-display-mail)
("url" . eudc-display-url))
'ldap)
(defun eudc-ldap-cleanup-record-simple (record)
"Do some cleanup in a RECORD to make it suitable for EUDC."
(declare (obsolete eudc-ldap-cleanup-record-filtering-addresses "25.1"))
(mapcar
(lambda (field)
(cons (intern (downcase (car field)))
(if (cdr (cdr field))
(cdr field)
(car (cdr field)))))
record))
(defun eudc-filter-$ (string)
(mapconcat #'identity (split-string string "\\$") "\n"))
(defun eudc-ldap-cleanup-record-filtering-addresses (record)
"Clean up RECORD to make it suitable for EUDC.
Make the record a cons-cell instead of a list if it is
single-valued. Change the `$' character in postal addresses to a
newline. Combine separate mail fields into one mail field with
multiple addresses."
(let ((clean-up-addresses (or (not (boundp 'ldap-ignore-attribute-codings))
(not ldap-ignore-attribute-codings)))
result mail-addresses)
(dolist (field record)
;; Some servers return case-sensitive names (e.g. givenName
;; instead of givenname); downcase the field's name so that it
;; can be matched against
;; eudc-ldap-attributes-translation-alist.
(let ((name (intern (downcase (car field))))
(value (cdr field)))
(when (and clean-up-addresses
(memq name '(postaladdress registeredaddress)))
(setq value (mapcar #'eudc-filter-$ value)))
(if (eq name 'mail)
(setq mail-addresses (append mail-addresses value))
(push (cons name (if (cdr value)
value
(car value)))
result))))
(push (cons 'mail (if (cdr mail-addresses)
mail-addresses
(car mail-addresses)))
result)
(nreverse result)))
(defun eudc-ldap-simple-query-internal (query &optional return-attrs)
"Query the LDAP server with QUERY.
QUERY is a list of cons cells (ATTR . VALUE) where ATTRs should be valid
LDAP attribute names.
RETURN-ATTRS is a list of attributes to return, defaulting to
`eudc-default-return-attributes'."
(let ((result (ldap-search (eudc-ldap-format-query-as-rfc1558 query)
eudc-server
(if (listp return-attrs)
(mapcar #'symbol-name return-attrs))))
final-result)
(setq result (mapcar #'eudc-ldap-cleanup-record-filtering-addresses result))
(if (and eudc-strict-return-matches
return-attrs
(not (eq 'all return-attrs)))
(setq result (eudc-filter-partial-records result return-attrs)))
;; Apply eudc-duplicate-attribute-handling-method
(if (not (eq 'list eudc-duplicate-attribute-handling-method))
(mapc
(lambda (record)
(setq final-result
(append (eudc-filter-duplicate-attributes record)
final-result)))
result))
final-result))
(defun eudc-ldap-get-field-list (_dummy &optional objectclass)
"Return a list of valid attribute names for the current server.
OBJECTCLASS is the LDAP object class for which the valid
attribute names are returned. Default to `person'."
(interactive)
(or eudc-server
(call-interactively 'eudc-set-server))
(let ((plist (copy-sequence
(alist-get eudc-server ldap-host-parameters-alist
nil nil #'equal))))
(plist-put plist 'scope 'subtree)
(plist-put plist 'sizelimit '1)
(let ((ldap-host-parameters-alist
(list (cons eudc-server plist))))
(mapcar #'eudc-ldap-cleanup-record-filtering-addresses
(ldap-search
(eudc-ldap-format-query-as-rfc1558
(list (cons 'objectclass
(or objectclass
"person"))))
eudc-server nil t)))))
(defun eudc-ldap-escape-query-special-chars (string)
"Value is STRING with characters forbidden in LDAP queries escaped."
;; Note that * should also be escaped but in most situations I suppose
;; the user doesn't want this
(eudc-replace-in-string
(eudc-replace-in-string
(eudc-replace-in-string
(eudc-replace-in-string
string
"\\\\" "\\5c")
"(" "\\28")
")" "\\29")
(char-to-string ?\0) "\\00"))
(defun eudc-ldap-format-query-as-rfc1558 (query)
"Format the EUDC QUERY list as a RFC1558 LDAP search filter."
(let ((formatter
(lambda (item &optional wildcard)
(format "(%s=%s)"
(car item)
(concat
(eudc-ldap-escape-query-special-chars
(cdr item))
(if (and wildcard
(not (memq (car item)
eudc-ldap-no-wildcard-attributes)))
"*" ""))))))
(format "(&%s)"
(concat
(mapconcat formatter (butlast query) "")
(funcall formatter (car (last query)) t)))))
;;}}}
;;{{{ High-level interfaces (interactive functions)
(defun eudc-ldap-customize ()
"Customize the EUDC LDAP support."
(interactive)
(customize-group 'eudc-ldap))
(defun eudc-ldap-check-base ()
"Check if the current LDAP server has a configured search base."
(unless (or (ldap-get-host-parameter eudc-server 'base)
ldap-default-base
(null (y-or-n-p "No search base defined. Configure it now?")))
;; If the server is not in ldap-host-parameters-alist we add it for the
;; user
(if (null (assoc eudc-server ldap-host-parameters-alist))
(setq ldap-host-parameters-alist
(cons (list eudc-server) ldap-host-parameters-alist)))
(customize-variable 'ldap-host-parameters-alist)))
;;}}}
(eudc-register-protocol 'ldap)
(define-obsolete-function-alias 'eudc-ldap-get-host-parameter #'ldap-get-host-parameter "29.1")
(provide 'eudcb-ldap)
;;; eudcb-ldap.el ends here
|
