1 # -*- coding: utf-8 -*-
4 # Copyright (c) 2009-2010, Bolloré telecom
7 # See AUTHORS file for a full list of contributors.
9 # Redistribution and use in source and binary forms, with or without modification,
10 # are permitted provided that the following conditions are met:
12 # 1. Redistributions of source code must retain the above copyright notice,
13 # this list of conditions and the following disclaimer.
15 # 2. Redistributions in binary form must reproduce the above copyright
16 # notice, this list of conditions and the following disclaimer in the
17 # documentation and/or other materials provided with the distribution.
19 # 3. Neither the name of Bolloré telecom nor the names of its contributors
20 # may be used to endorse or promote products derived from this software
21 # without specific prior written permission.
23 # THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND
24 # ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
25 # WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
26 # DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR
27 # ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
28 # (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
29 # LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON
30 # ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
31 # (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
32 # SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
35 from copy import deepcopy
38 from django.db.models.query import QuerySet as BaseQuerySet
39 from django.db.models.query_utils import Q
40 from django.db.models.sql import Query as BaseQuery
41 from django.db.models.sql.where import WhereNode as BaseWhereNode, Constraint as BaseConstraint, AND, OR
45 from ldapdb.models.fields import CharField
47 def get_lookup_operator(lookup_type):
48 if lookup_type == 'gte':
50 elif lookup_type == 'lte':
55 class Constraint(BaseConstraint):
57 An object that can be passed to WhereNode.add() and knows how to
58 pre-process itself prior to including in the WhereNode.
60 def process(self, lookup_type, value):
62 Returns a tuple of data suitable for inclusion in a WhereNode
65 # Because of circular imports, we need to import this here.
66 from django.db.models.base import ObjectDoesNotExist
70 params = self.field.get_db_prep_lookup(lookup_type, value)
71 db_type = self.field.db_type()
73 params = CharField().get_db_prep_lookup(lookup_type, value)
75 except ObjectDoesNotExist:
76 raise EmptyShortCircuit
78 return (self.alias, self.col, db_type), params
80 class Compiler(object):
81 def __init__(self, query, connection, using):
83 self.connection = connection
86 def results_iter(self):
87 if self.query.select_fields:
88 fields = self.query.select_fields
90 fields = self.query.model._meta.fields
92 attrlist = [ x.db_column for x in fields if x.db_column ]
95 vals = self.connection.search_s(
96 self.query.model.base_dn,
97 self.query.model.search_scope,
98 filterstr=self.query._ldap_filter(),
101 except ldap.NO_SUCH_OBJECT:
105 if self.query.extra_order_by:
106 ordering = self.query.extra_order_by
107 elif not self.query.default_ordering:
108 ordering = self.query.order_by
110 ordering = self.query.order_by or self.query.model._meta.ordering
112 for fieldname in ordering:
113 if fieldname.startswith('-'):
114 fieldname = fieldname[1:]
118 field = self.query.model._meta.get_field(fieldname)
119 attr_x = field.from_ldap(x[1].get(field.db_column, []), connection=self.connection)
120 attr_y = field.from_ldap(y[1].get(field.db_column, []), connection=self.connection)
121 # perform case insensitive comparison
122 if hasattr(attr_x, 'lower'):
123 attr_x = attr_x.lower()
124 if hasattr(attr_y, 'lower'):
125 attr_y = attr_y.lower()
126 val = negate and cmp(attr_y, attr_x) or cmp(attr_x, attr_y)
130 vals = sorted(vals, cmp=cmpvals)
134 for dn, attrs in vals:
135 # FIXME : This is not optimal, we retrieve more results than we need
136 # but there is probably no other options as we can't perform ordering
138 if (self.query.low_mark and pos < self.query.low_mark) or \
139 (self.query.high_mark is not None and pos >= self.query.high_mark):
143 for field in iter(fields):
144 if field.attname == 'dn':
146 elif hasattr(field, 'from_ldap'):
147 row.append(field.from_ldap(attrs.get(field.db_column, []), connection=self.connection))
154 class WhereNode(BaseWhereNode):
155 def add(self, data, connector):
156 if not isinstance(data, (list, tuple)):
157 super(WhereNode, self).add(data, connector)
160 # we replace the native Constraint by our own
161 obj, lookup_type, value = data
162 if hasattr(obj, "process"):
163 obj = Constraint(obj.alias, obj.col, obj.field)
164 super(WhereNode, self).add((obj, lookup_type, value), connector)
166 def as_sql(self, qn=None, connection=None):
168 for item in self.children:
169 if hasattr(item, 'as_sql'):
170 sql, params = item.as_sql(qn=qn, connection=connection)
174 constraint, lookup_type, y, values = item
175 comp = get_lookup_operator(lookup_type)
176 if hasattr(constraint, "col"):
178 column = constraint.col
179 if lookup_type == 'in':
180 equal_bits = [ "(%s%s%s)" % (column, comp, value) for value in values ]
181 clause = '(|%s)' % ''.join(equal_bits)
183 clause = "(%s%s%s)" % (constraint.col, comp, values)
186 (table, column, db_type) = constraint
187 equal_bits = [ "(%s%s%s)" % (column, comp, value) for value in values ]
188 if len(equal_bits) == 1:
189 clause = equal_bits[0]
191 clause = '(|%s)' % ''.join(equal_bits)
194 bits.append('(!%s)' % clause)
199 elif self.connector == AND:
200 sql_string = '(&%s)' % ''.join(bits)
201 elif self.connector == OR:
202 sql_string = '(|%s)' % ''.join(bits)
204 raise Exception("Unhandled WHERE connector: %s" % self.connector)
205 return sql_string, []
207 class Query(BaseQuery):
208 def __init__(self, *args, **kwargs):
209 super(Query, self).__init__(*args, **kwargs)
210 self.connection = ldapdb.connection
212 def _ldap_filter(self):
213 filterstr = ''.join(['(objectClass=%s)' % cls for cls in self.model.object_classes])
214 sql, params = self.where.as_sql()
216 return '(&%s)' % filterstr
218 def get_count(self, using=None):
220 vals = ldapdb.connection.search_s(
222 self.model.search_scope,
223 filterstr=self._ldap_filter(),
226 except ldap.NO_SUCH_OBJECT:
231 # apply limit and offset
232 number = max(0, number - self.low_mark)
233 if self.high_mark is not None:
234 number = min(number, self.high_mark - self.low_mark)
238 def get_compiler(self, using=None, connection=None):
239 return Compiler(self, ldapdb.connection, using)
241 def results_iter(self):
242 "For django 1.1 compatibility"
243 return self.get_compiler().results_iter()
245 class QuerySet(BaseQuerySet):
246 def __init__(self, model=None, query=None, using=None):
249 spec = inspect.getargspec(BaseQuery.__init__)
250 if len(spec[0]) == 3:
252 query = Query(model, WhereNode)
255 query = Query(model, None, WhereNode)
256 super(QuerySet, self).__init__(model=model, query=query)
261 vals = ldapdb.connection.search_s(
263 self.model.search_scope,
264 filterstr=self.query._ldap_filter(),
267 except ldap.NO_SUCH_OBJECT:
270 # FIXME : there is probably a more efficient way to do this
271 for dn, attrs in vals:
272 ldapdb.connection.delete_s(dn)