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.
61 - we redefine this class, because when self.field is None calls
62 Field().get_db_prep_lookup(), which short-circuits our LDAP-specific code.
64 def process(self, lookup_type, value, connection):
66 Returns a tuple of data suitable for inclusion in a WhereNode
69 # Because of circular imports, we need to import this here.
70 from django.db.models.base import ObjectDoesNotExist
74 params = self.field.get_db_prep_lookup(lookup_type, value,
75 connection=connection, prepared=True)
76 db_type = self.field.db_type()
78 params = CharField().get_db_prep_lookup(lookup_type, value,
79 connection=connection, prepared=True)
81 except ObjectDoesNotExist:
82 raise EmptyShortCircuit
84 return (self.alias, self.col, db_type), params
86 class Compiler(object):
87 def __init__(self, query, connection, using):
89 self.connection = connection
92 def results_iter(self):
93 if self.query.select_fields:
94 fields = self.query.select_fields
96 fields = self.query.model._meta.fields
98 attrlist = [ x.db_column for x in fields if x.db_column ]
101 vals = self.connection.search_s(
102 self.query.model.base_dn,
103 self.query.model.search_scope,
104 filterstr=self.query._ldap_filter(),
107 except ldap.NO_SUCH_OBJECT:
111 if self.query.extra_order_by:
112 ordering = self.query.extra_order_by
113 elif not self.query.default_ordering:
114 ordering = self.query.order_by
116 ordering = self.query.order_by or self.query.model._meta.ordering
118 for fieldname in ordering:
119 if fieldname.startswith('-'):
120 fieldname = fieldname[1:]
124 field = self.query.model._meta.get_field(fieldname)
125 attr_x = field.from_ldap(x[1].get(field.db_column, []), connection=self.connection)
126 attr_y = field.from_ldap(y[1].get(field.db_column, []), connection=self.connection)
127 # perform case insensitive comparison
128 if hasattr(attr_x, 'lower'):
129 attr_x = attr_x.lower()
130 if hasattr(attr_y, 'lower'):
131 attr_y = attr_y.lower()
132 val = negate and cmp(attr_y, attr_x) or cmp(attr_x, attr_y)
136 vals = sorted(vals, cmp=cmpvals)
140 for dn, attrs in vals:
141 # FIXME : This is not optimal, we retrieve more results than we need
142 # but there is probably no other options as we can't perform ordering
144 if (self.query.low_mark and pos < self.query.low_mark) or \
145 (self.query.high_mark is not None and pos >= self.query.high_mark):
149 for field in iter(fields):
150 if field.attname == 'dn':
152 elif hasattr(field, 'from_ldap'):
153 row.append(field.from_ldap(attrs.get(field.db_column, []), connection=self.connection))
160 class WhereNode(BaseWhereNode):
161 def add(self, data, connector):
162 if not isinstance(data, (list, tuple)):
163 super(WhereNode, self).add(data, connector)
166 # we replace the native Constraint by our own
167 obj, lookup_type, value = data
168 if hasattr(obj, "process"):
169 obj = Constraint(obj.alias, obj.col, obj.field)
170 super(WhereNode, self).add((obj, lookup_type, value), connector)
172 def as_sql(self, qn=None, connection=None):
174 for item in self.children:
175 if hasattr(item, 'as_sql'):
176 sql, params = item.as_sql(qn=qn, connection=connection)
180 constraint, lookup_type, y, values = item
181 comp = get_lookup_operator(lookup_type)
182 if lookup_type == 'in':
183 equal_bits = [ "(%s%s%s)" % (constraint.col, comp, value) for value in values ]
184 clause = '(|%s)' % ''.join(equal_bits)
186 clause = "(%s%s%s)" % (constraint.col, comp, values)
195 elif self.connector == AND:
196 sql_string = '(&%s)' % ''.join(bits)
197 elif self.connector == OR:
198 sql_string = '(|%s)' % ''.join(bits)
200 raise Exception("Unhandled WHERE connector: %s" % self.connector)
203 sql_string = ('(!%s)' % sql_string)
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):
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 has_results(self, using):
242 return self.get_count(using) != 0
244 class QuerySet(BaseQuerySet):
245 def __init__(self, model=None, query=None, using=None):
247 query = Query(model, WhereNode)
248 super(QuerySet, self).__init__(model=model, query=query, using=using)
253 vals = ldapdb.connection.search_s(
255 self.model.search_scope,
256 filterstr=self.query._ldap_filter(),
259 except ldap.NO_SUCH_OBJECT:
262 # FIXME : there is probably a more efficient way to do this
263 for dn, attrs in vals:
264 ldapdb.connection.delete_s(dn)