better fix for unicity checks : implement query.has_results()
[matthijs/upstream/django-ldapdb.git] / ldapdb / models / query.py
index fc211b45715099f3e48c2ca3eb489635249c921b..ab5f19ec727b574cc845d44995d1b4371611ead7 100644 (file)
@@ -1,21 +1,35 @@
 # -*- coding: utf-8 -*-
 # 
 # django-ldapdb
-# Copyright (C) 2009-2010 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.
 #
 
 from copy import deepcopy
@@ -70,41 +84,45 @@ class Compiler(object):
         self.using = using
 
     def results_iter(self):
-        query = self.query
+        if self.query.select_fields:
+            fields = self.query.select_fields
+        else:
+            fields = self.query.model._meta.fields
 
-        filterstr = ''.join(['(objectClass=%s)' % cls for cls in query.model.object_classes])
-        sql, params = query.where.as_sql()
-        filterstr += sql
-        filterstr = '(&%s)' % filterstr
-        attrlist = [ x.db_column for x in query.model._meta.local_fields if x.db_column ]
+        attrlist = [ x.db_column for x in fields if x.db_column ]
 
         try:
             vals = self.connection.search_s(
-                query.model.base_dn,
-                ldap.SCOPE_SUBTREE,
-                filterstr=filterstr,
+                self.query.model.base_dn,
+                self.query.model.search_scope,
+                filterstr=self.query._ldap_filter(),
                 attrlist=attrlist,
             )
-        except:
-            raise query.model.DoesNotExist
+        except ldap.NO_SUCH_OBJECT:
+            return
 
         # perform sorting
-        if query.extra_order_by:
-            ordering = query.extra_order_by
-        elif not query.default_ordering:
-            ordering = query.order_by
+        if self.query.extra_order_by:
+            ordering = self.query.extra_order_by
+        elif not self.query.default_ordering:
+            ordering = self.query.order_by
         else:
-            ordering = query.order_by or query.model._meta.ordering
+            ordering = self.query.order_by or self.query.model._meta.ordering
         def cmpvals(x, y):
-            for field in ordering:
-                if field.startswith('-'):
-                    field = field[1:]
+            for fieldname in ordering:
+                if fieldname.startswith('-'):
+                    fieldname = fieldname[1:]
                     negate = True
                 else:
                     negate = False
-                attr = query.model._meta.get_field(field).db_column
-                attr_x = x[1].get(attr, '').lower()
-                attr_y = y[1].get(attr, '').lower()
+                field = self.query.model._meta.get_field(fieldname)
+                attr_x = field.from_ldap(x[1].get(field.db_column, []), connection=self.connection)
+                attr_y = field.from_ldap(y[1].get(field.db_column, []), connection=self.connection)
+                # perform case insensitive comparison
+                if hasattr(attr_x, 'lower'):
+                    attr_x = attr_x.lower()
+                if hasattr(attr_y, 'lower'):
+                    attr_y = attr_y.lower()
                 val = negate and cmp(attr_y, attr_x) or cmp(attr_x, attr_y)
                 if val:
                     return val
@@ -112,9 +130,17 @@ class Compiler(object):
         vals = sorted(vals, cmp=cmpvals)
 
         # process results
+        pos = 0
         for dn, attrs in vals:
+            # FIXME : This is not optimal, we retrieve more results than we need
+            # but there is probably no other options as we can't perform ordering
+            # server side.
+            if (self.query.low_mark and pos < self.query.low_mark) or \
+               (self.query.high_mark is not None and pos >= self.query.high_mark):
+                pos += 1
+                continue
             row = []
-            for field in iter(query.model._meta.fields):
+            for field in iter(fields):
                 if field.attname == 'dn':
                     row.append(dn)
                 elif hasattr(field, 'from_ldap'):
@@ -122,6 +148,7 @@ class Compiler(object):
                 else:
                     row.append(None)
             yield row
+            pos += 1
 
 
 class WhereNode(BaseWhereNode):
@@ -182,27 +209,38 @@ class Query(BaseQuery):
         super(Query, self).__init__(*args, **kwargs)
         self.connection = ldapdb.connection
 
-    def get_count(self):
+    def _ldap_filter(self):
         filterstr = ''.join(['(objectClass=%s)' % cls for cls in self.model.object_classes])
         sql, params = self.where.as_sql()
         filterstr += sql
-        filterstr = '(&%s)' % filterstr
+        return '(&%s)' % filterstr
 
+    def get_count(self, using=None):
         try:
-            vals = self.connection.search_s(
+            vals = ldapdb.connection.search_s(
                 self.model.base_dn,
-                ldap.SCOPE_SUBTREE,
-                filterstr=filterstr,
+                self.model.search_scope,
+                filterstr=self._ldap_filter(),
                 attrlist=[],
             )
-        except:
-            raise self.model.DoesNotExist
+        except ldap.NO_SUCH_OBJECT:
+            return 0
+
+        number = len(vals)
+
+        # apply limit and offset
+        number = max(0, number - self.low_mark)
+        if self.high_mark is not None:
+            number = min(number, self.high_mark - self.low_mark)
 
-        return len(vals)
+        return number
 
     def get_compiler(self, using=None, connection=None):
         return Compiler(self, ldapdb.connection, using)
 
+    def has_results(self, using):
+        return self.get_count() != 0
+
     def results_iter(self):
         "For django 1.1 compatibility"
         return self.get_compiler().results_iter()
@@ -220,3 +258,19 @@ class QuerySet(BaseQuerySet):
                 query = Query(model, None, WhereNode)
         super(QuerySet, self).__init__(model=model, query=query)
 
+    def delete(self):
+        "Bulk deletion."
+        try:
+            vals = ldapdb.connection.search_s(
+                self.model.base_dn,
+                self.model.search_scope,
+                filterstr=self.query._ldap_filter(),
+                attrlist=[],
+            )
+        except ldap.NO_SUCH_OBJECT:
+            return
+
+        # FIXME : there is probably a more efficient way to do this 
+        for dn, attrs in vals:
+            ldapdb.connection.delete_s(dn)
+