[Zope-CVS] SVN: ldapadapter/trunk/utility.py Initial untested checkin.

[Florent Guillaume]

Log message for revision 27816:
  Initial untested checkin.
  


Changed:
  A   ldapadapter/trunk/utility.py


-=-
Added: ldapadapter/trunk/utility.py
===================================================================
--- ldapadapter/trunk/utility.py	2004-10-09 12:26:31 UTC (rev 27815)
+++ ldapadapter/trunk/utility.py	2004-10-09 12:28:58 UTC (rev 27816)
@@ -0,0 +1,80 @@
+##############################################################################
+#
+# Copyright (c) 2004 Zope Corporation and Contributors.
+# All Rights Reserved.
+#
+# This software is subject to the provisions of the Zope Public License,
+# Version 2.1 (ZPL).  A copy of the ZPL should accompany this distribution.
+# THIS SOFTWARE IS PROVIDED "AS IS" AND ANY AND ALL EXPRESS OR IMPLIED
+# WARRANTIES ARE DISCLAIMED, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
+# WARRANTIES OF TITLE, MERCHANTABILITY, AGAINST INFRINGEMENT, AND FITNESS
+# FOR A PARTICULAR PURPOSE.
+#
+##############################################################################
+"""LDAP Adapter utility.
+
+$Id$
+"""
+
+import ldap
+from ldap import OPT_PROTOCOL_VERSION
+from ldap import VERSION3
+
+from persistent import Persistent
+
+from zope.interface import implements
+from zope.app.container.contained import Contained
+
+from interfaces import ILDAPAdapter
+from interfaces import ILDAPConnection
+
+
+class LDAPAdapter(object):
+    implements(ILDAPAdapter)
+
+    def __init__(self, host='localhost', port=389, useSSL=False):
+        self.host = host
+        self.port = port
+        self.useSSL = useSSL
+
+    def connect(self, dn, password=None):
+        proto = self.useSSL and 'ldaps' or 'ldap'
+        conn_str = '%s://%s:%s/' % (proto, self.host, self.port)
+        conn = ldap.initialize(conn_str)
+        try:
+            conn.set_option(OPT_PROTOCOL_VERSION, VERSION3)
+        except LDAPError:
+            # TODO: fallback on VERSION2 and note that the values
+            # are then not utf-8 encoded (charset is implicit (?))
+            raise Exception("Server should be LDAP v3")
+        # TODO: conn.set_option(OPT_REFERRALS, 1)
+
+        # Bind the connection to the dn
+        conn.simple_bind_s(db, password)
+        # May raise INVALID_CREDENTIALS, SERVER_DOWN, ...
+
+        return LDAPConnection(conn)
+
+
+class LDAPConnection(object):
+    implements(ILDAPConnection)
+
+    def __init__(self, conn):
+        self.conn = conn
+
+    def search(self, base, scope='one', filter='(objectclass=*)',
+               attrs=None):
+        # XXX convert from unicode to utf-8
+        ldap_entries = conn.search_s(base, scope, filter, attrs)
+        # May raise NO_SUCH_OBJECT, SERVER_DOWN, SIZELIMIT_EXCEEDED
+
+        # Convert returned values from utf-8 to unicode
+        results = []
+        for dn, entry in ldap_entries:
+            dn = unicode(dn, 'utf-8')
+            for key, values in entry:
+                # TODO: Can key be non-ascii? Check LDAP spec.
+                # FIXME: there may be non-textual binary values.
+                values[:] = [unicode(v, 'utf-8') for v in values]
+            results.append((dn, entry))
+        return results