make sure escape_ldap_filter handles unicode correctly
[matthijs/upstream/django-ldapdb.git] / ldapdb / __init__.py
index c8c56eda8704e34532b4db35b0433849b8ee5922..72f0889895c666b032c5433511f402c2c78b2cbf 100644 (file)
 # -*- coding: utf-8 -*-
 # 
 # django-ldapdb
-# Copyright (C) 2009 BollorĂ© telecom
+# Copyright (c) 2009-2010, BollorĂ© telecom
+# All rights reserved.
+# 
 # See AUTHORS file for a full list of contributors.
 # 
-# This program 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.
+# Redistribution and use in source and binary forms, with or without modification,
+# are permitted provided that the following conditions are met:
+# 
+#     1. Redistributions of source code must retain the above copyright notice, 
+#        this list of conditions and the following disclaimer.
+#     
+#     2. Redistributions in binary form must reproduce the above copyright 
+#        notice, this list of conditions and the following disclaimer in the
+#        documentation and/or other materials provided with the distribution.
 # 
-# This program 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.
+#     3. Neither the name of BollorĂ© telecom nor the names of its contributors
+#        may be used to endorse or promote products derived from this software
+#        without specific prior written permission.
 # 
-# You should have received a copy of the GNU General Public License
-# along with this program.  If not, see <http://www.gnu.org/licenses/>.
+# THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND
+# ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
+# WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
+# DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR
+# ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
+# (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
+# LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON
+# ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
+# (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
+# SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
 #
 
 import ldap
 
 from django.conf import settings
+from django.db.backends import BaseDatabaseFeatures, BaseDatabaseOperations
+
+def escape_ldap_filter(value):
+    value = unicode(value)
+    return value.replace('\\', '\\5c') \
+                .replace('*', '\\2a') \
+                .replace('(', '\\28') \
+                .replace(')', '\\29') \
+                .replace('\0', '\\00')
+
+class DatabaseCursor(object):
+    def __init__(self, ldap_connection):
+        self.connection = ldap_connection
+
+class DatabaseFeatures(BaseDatabaseFeatures):
+    pass
+
+class DatabaseOperations(BaseDatabaseOperations):
+    def quote_name(self, name):
+        return name
 
-def convert(field, value, func):
-    if not value or field == 'jpegPhoto':
-        return value
-    elif isinstance(value, int):
-        return str(value)
-    elif isinstance(value, list):
-        return [ func(x) for x in value ]
-    else:
-        return func(value)
-        
 class LdapConnection(object):
-    def __init__(self, server, bind_dn, bind_password):
-        self.connection = ldap.initialize(server)
-        self.connection.simple_bind_s(bind_dn, bind_password)
+    def __init__(self):
+        self.connection = None
         self.charset = "utf-8"
+        self.features = DatabaseFeatures()
+        self.ops = DatabaseOperations()
+
+    def _cursor(self):
+        if self.connection is None:
+            self.connection = ldap.initialize(settings.LDAPDB_SERVER_URI)
+            self.connection.simple_bind_s(
+                settings.LDAPDB_BIND_DN,
+                settings.LDAPDB_BIND_PASSWORD)
+        return DatabaseCursor(self.connection)
 
     def add_s(self, dn, modlist):
-        mods = []
-        for field, value in modlist:
-            converted = convert(field, value, lambda x: x.encode(self.charset))
-            if isinstance(converted, list):
-                mods.append((field, converted))
-            else:
-                mods.append((field, [converted]))
-        return self.connection.add_s(dn.encode(self.charset), mods)
+        cursor = self._cursor()
+        return cursor.connection.add_s(dn.encode(self.charset), modlist)
 
     def delete_s(self, dn):
-        return self.connection.delete_s(dn)
+        cursor = self._cursor()
+        return cursor.connection.delete_s(dn.encode(self.charset))
 
     def modify_s(self, dn, modlist):
-        mods = []
-        for op, field, value in modlist:
-            mods.append((op, field, convert(field, value, lambda x: x.encode(self.charset))))
-        return self.connection.modify_s(dn.encode(self.charset), mods)
+        cursor = self._cursor()
+        return cursor.connection.modify_s(dn.encode(self.charset), modlist)
 
     def rename_s(self, dn, newrdn):
-        return self.connection.rename_s(dn.encode(self.charset), newrdn.encode(self.charset))
+        cursor = self._cursor()
+        return cursor.connection.rename_s(dn.encode(self.charset), newrdn.encode(self.charset))
 
     def search_s(self, base, scope, filterstr, attrlist):
-        results = self.connection.search_s(base, scope, filterstr.encode(self.charset), attrlist)
+        cursor = self._cursor()
+        results = cursor.connection.search_s(base, scope, filterstr.encode(self.charset), attrlist)
+        output = []
         for dn, attrs in results:
-            for field in attrs:
-                if field == "member" or field == "memberUid":
-                    attrs[field] = convert(field, attrs[field], lambda x: x.decode(self.charset))
-                else:
-                    attrs[field] = convert(field, attrs[field][0], lambda x: x.decode(self.charset))
-        return results
+            output.append((dn.decode(self.charset), attrs))
+        return output
 
 # FIXME: is this the right place to initialize the LDAP connection?
-connection = LdapConnection(settings.LDAPDB_SERVER_URI,
-    settings.LDAPDB_BIND_DN,
-    settings.LDAPDB_BIND_PASSWORD)
+connection = LdapConnection()