eudcb-ldap.el 6.88 KB
Newer Older
Gerd Moellmann's avatar
Gerd Moellmann committed
1 2
;;; eudcb-ldap.el --- Emacs Unified Directory Client - LDAP Backend

Glenn Morris's avatar
Glenn Morris committed
3
;; Copyright (C) 1998, 1999, 2000, 2001, 2002, 2003, 2004,
Glenn Morris's avatar
Glenn Morris committed
4
;;   2005, 2006, 2007 Free Software Foundation, Inc.
Gerd Moellmann's avatar
Gerd Moellmann committed
5

6 7
;; Author: Oscar Figueiredo <oscar@cpe.fr>
;; Maintainer: Pavel Jank <Pavel@Janik.cz>
Pavel Janík's avatar
Pavel Janík committed
8
;; Keywords: comm
Gerd Moellmann's avatar
Gerd Moellmann committed
9 10 11 12 13 14 15 16 17 18 19 20 21 22 23

;; 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 2, 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; see the file COPYING.  If not, write to the
Lute Kamstra's avatar
Lute Kamstra committed
24 25
;; Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor,
;; Boston, MA 02110-1301, USA.
Gerd Moellmann's avatar
Gerd Moellmann committed
26 27

;;; Commentary:
Pavel Janík's avatar
Pavel Janík committed
28
;;    This library provides specific LDAP protocol support for the
Gerd Moellmann's avatar
Gerd Moellmann committed
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
;;    Emacs Unified Directory Client package

;;; Installation:
;;    Install EUDC first. See EUDC documentation.

;;; Code:

(require 'eudc)
(require 'ldap)


;;{{{      Internal cooking

(eval-and-compile
  (if (fboundp 'ldap-get-host-parameter)
      (fset 'eudc-ldap-get-host-parameter 'ldap-get-host-parameter)
    (defun eudc-ldap-get-host-parameter (host parameter)
      "Get the value of PARAMETER for HOST in `ldap-host-parameters-alist'."
      (plist-get (cdr (assoc host ldap-host-parameters-alist))
		 parameter))))

(defvar eudc-ldap-attributes-translation-alist
  '((name . sn)
    (firstname . givenname)
    (email . mail)
    (phone . telephonenumber))
  "Alist mapping EUDC attribute names to LDAP names.")

Pavel Janík's avatar
Pavel Janík committed
57
(eudc-protocol-set 'eudc-query-function 'eudc-ldap-simple-query-internal
Gerd Moellmann's avatar
Gerd Moellmann committed
58 59 60
		   'ldap)
(eudc-protocol-set 'eudc-list-attributes-function 'eudc-ldap-get-field-list
		   'ldap)
Pavel Janík's avatar
Pavel Janík committed
61
(eudc-protocol-set 'eudc-protocol-attributes-translation-alist
Gerd Moellmann's avatar
Gerd Moellmann committed
62
		   'eudc-ldap-attributes-translation-alist 'ldap)
Pavel Janík's avatar
Pavel Janík committed
63 64
(eudc-protocol-set 'eudc-bbdb-conversion-alist
		   'eudc-ldap-bbdb-conversion-alist
Gerd Moellmann's avatar
Gerd Moellmann committed
65 66
		   'ldap)
(eudc-protocol-set 'eudc-protocol-has-default-query-attributes nil 'ldap)
Pavel Janík's avatar
Pavel Janík committed
67
(eudc-protocol-set 'eudc-attribute-display-method-alist
Gerd Moellmann's avatar
Gerd Moellmann committed
68 69 70
		   '(("jpegphoto" . eudc-display-jpeg-inline)
		     ("labeledurl" . eudc-display-url)
		     ("audio" . eudc-display-sound)
71
		     ("labeleduri" . eudc-display-url)
72
		     ("mail" . eudc-display-mail)
Pavel Janík's avatar
Pavel Janík committed
73
		     ("url" . eudc-display-url))
Gerd Moellmann's avatar
Gerd Moellmann committed
74
		   'ldap)
Pavel Janík's avatar
Pavel Janík committed
75 76
(eudc-protocol-set 'eudc-switch-to-server-hook
		   '(eudc-ldap-check-base)
Gerd Moellmann's avatar
Gerd Moellmann committed
77 78 79 80
		   'ldap)

(defun eudc-ldap-cleanup-record-simple (record)
  "Do some cleanup in a RECORD to make it suitable for EUDC."
Pavel Janík's avatar
Pavel Janík committed
81 82
  (mapcar
   (function
Gerd Moellmann's avatar
Gerd Moellmann committed
83 84 85 86 87 88 89 90 91 92 93
    (lambda (field)
      (cons (intern (car field))
	    (if (cdr (cdr field))
		(cdr field)
	      (car (cdr field))))))
   record))

(defun eudc-filter-$ (string)
  (mapconcat 'identity (split-string string "\\$") "\n"))

;; Cleanup a LDAP record to make it suitable for EUDC:
94
;;   Make the record a cons-cell instead of a list if it is single-valued
Gerd Moellmann's avatar
Gerd Moellmann committed
95 96
;;   Filter the $ character in addresses into \n if not done by the LDAP lib
(defun eudc-ldap-cleanup-record-filtering-addresses (record)
Pavel Janík's avatar
Pavel Janík committed
97 98
  (mapcar
   (function
Gerd Moellmann's avatar
Gerd Moellmann committed
99 100 101 102 103 104 105 106 107 108 109 110 111
    (lambda (field)
      (let ((name (intern (car field)))
	    (value (cdr field)))
	(if (memq name '(postaladdress registeredaddress))
	    (setq value (mapcar 'eudc-filter-$ value)))
	(cons name
	      (if (cdr value)
		  value
		(car value))))))
   record))

(defun eudc-ldap-simple-query-internal (query &optional return-attrs)
  "Query the LDAP server with QUERY.
Pavel Janík's avatar
Pavel Janík committed
112 113 114
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
Gerd Moellmann's avatar
Gerd Moellmann committed
115 116 117 118 119 120 121 122
`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)
    (if (or (not (boundp 'ldap-ignore-attribute-codings))
	    ldap-ignore-attribute-codings)
Pavel Janík's avatar
Pavel Janík committed
123
	(setq result
Gerd Moellmann's avatar
Gerd Moellmann committed
124 125 126 127 128 129 130 131 132
	      (mapcar 'eudc-ldap-cleanup-record-filtering-addresses result))
      (setq result (mapcar 'eudc-ldap-cleanup-record-simple 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))
Pavel Janík's avatar
Pavel Janík committed
133
	(mapcar
Gerd Moellmann's avatar
Gerd Moellmann committed
134
	 (function (lambda (record)
Pavel Janík's avatar
Pavel Janík committed
135
		     (setq final-result
Gerd Moellmann's avatar
Gerd Moellmann committed
136 137 138 139 140 141 142 143 144 145 146 147
			   (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))
Pavel Janík's avatar
Pavel Janík committed
148
  (let ((ldap-host-parameters-alist
Gerd Moellmann's avatar
Gerd Moellmann committed
149 150
	 (list (cons eudc-server
		     '(scope subtree sizelimit 1)))))
151
    (mapcar 'eudc-ldap-cleanup-record-simple
Pavel Janík's avatar
Pavel Janík committed
152 153
	    (ldap-search
	     (eudc-ldap-format-query-as-rfc1558
Gerd Moellmann's avatar
Gerd Moellmann committed
154 155 156 157 158 159 160
	      (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."
Pavel Janík's avatar
Pavel Janík committed
161
;; Note that * should also be escaped but in most situations I suppose
Gerd Moellmann's avatar
Gerd Moellmann committed
162 163 164 165
;; the user doesn't want this
  (eudc-replace-in-string
   (eudc-replace-in-string
    (eudc-replace-in-string
Pavel Janík's avatar
Pavel Janík committed
166 167
      (eudc-replace-in-string
       string
Gerd Moellmann's avatar
Gerd Moellmann committed
168 169 170 171 172 173 174
       "\\\\" "\\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."
Pavel Janík's avatar
Pavel Janík committed
175 176
  (format "(&%s)"
	  (apply 'concat
Gerd Moellmann's avatar
Gerd Moellmann committed
177
		 (mapcar '(lambda (item)
Pavel Janík's avatar
Pavel Janík committed
178 179
			    (format "(%s=%s)"
				    (car item)
Gerd Moellmann's avatar
Gerd Moellmann committed
180 181 182 183
				    (eudc-ldap-escape-query-special-chars (cdr item))))
			 query))))


Pavel Janík's avatar
Pavel Janík committed
184
;;}}}
Gerd Moellmann's avatar
Gerd Moellmann committed
185 186 187 188 189 190 191 192 193 194 195 196

;;{{{      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 (eudc-ldap-get-host-parameter eudc-server 'base)
	      ldap-default-base
197
	      (null (y-or-n-p "No search base defined. Configure it now? ")))
Gerd Moellmann's avatar
Gerd Moellmann committed
198 199 200
    ;; 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))
Pavel Janík's avatar
Pavel Janík committed
201
	(setq ldap-host-parameters-alist
Gerd Moellmann's avatar
Gerd Moellmann committed
202 203 204
	      (cons (list eudc-server) ldap-host-parameters-alist)))
    (customize-variable 'ldap-host-parameters-alist)))

Pavel Janík's avatar
Pavel Janík committed
205
;;}}}
Gerd Moellmann's avatar
Gerd Moellmann committed
206 207 208 209 210 211


(eudc-register-protocol 'ldap)

(provide 'eudcb-ldap)

Miles Bader's avatar
Miles Bader committed
212
;;; arch-tag: 0f254dc0-7378-4fd4-ae26-18666184e96b
Gerd Moellmann's avatar
Gerd Moellmann committed
213
;;; eudcb-ldap.el ends here