1 # -*- coding: utf-8 -*-
4 # Copyright (C) 2009-2010 Bolloré telecom
5 # See AUTHORS file for a full list of contributors.
7 # This program is free software: you can redistribute it and/or modify
8 # it under the terms of the GNU General Public License as published by
9 # the Free Software Foundation, either version 3 of the License, or
10 # (at your option) any later version.
12 # This program is distributed in the hope that it will be useful,
13 # but WITHOUT ANY WARRANTY; without even the implied warranty of
14 # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
15 # GNU General Public License for more details.
17 # You should have received a copy of the GNU General Public License
18 # along with this program. If not, see <http://www.gnu.org/licenses/>.
21 from copy import deepcopy
24 from django.db.models.query import QuerySet as BaseQuerySet
25 from django.db.models.query_utils import Q
26 from django.db.models.sql import Query as BaseQuery
27 from django.db.models.sql.where import WhereNode as BaseWhereNode, Constraint as BaseConstraint, AND, OR
31 from ldapdb.models.fields import CharField
33 def get_lookup_operator(lookup_type):
34 if lookup_type == 'gte':
36 elif lookup_type == 'lte':
41 class Constraint(BaseConstraint):
43 An object that can be passed to WhereNode.add() and knows how to
44 pre-process itself prior to including in the WhereNode.
46 def process(self, lookup_type, value):
48 Returns a tuple of data suitable for inclusion in a WhereNode
51 # Because of circular imports, we need to import this here.
52 from django.db.models.base import ObjectDoesNotExist
56 params = self.field.get_db_prep_lookup(lookup_type, value)
57 db_type = self.field.db_type()
59 params = CharField().get_db_prep_lookup(lookup_type, value)
61 except ObjectDoesNotExist:
62 raise EmptyShortCircuit
64 return (self.alias, self.col, db_type), params
66 class Compiler(object):
67 def __init__(self, query, connection, using):
69 self.connection = connection
72 def results_iter(self):
75 filterstr = ''.join(['(objectClass=%s)' % cls for cls in query.model.object_classes])
76 sql, params = query.where.as_sql()
78 filterstr = '(&%s)' % filterstr
79 attrlist = [ x.db_column for x in query.model._meta.local_fields if x.db_column ]
82 vals = self.connection.search_s(
89 raise query.model.DoesNotExist
92 if query.extra_order_by:
93 ordering = query.extra_order_by
94 elif not query.default_ordering:
95 ordering = query.order_by
97 ordering = query.order_by or query.model._meta.ordering
99 for fieldname in ordering:
100 if fieldname.startswith('-'):
101 fieldname = fieldname[1:]
105 field = query.model._meta.get_field(fieldname)
106 attr_x = field.from_ldap(x[1].get(field.db_column, []), connection=self.connection)
107 attr_y = field.from_ldap(y[1].get(field.db_column, []), connection=self.connection)
108 # perform case insensitive comparison
109 if hasattr(attr_x, 'lower'):
110 attr_x = attr_x.lower()
111 if hasattr(attr_y, 'lower'):
112 attr_y = attr_y.lower()
113 val = negate and cmp(attr_y, attr_x) or cmp(attr_x, attr_y)
117 vals = sorted(vals, cmp=cmpvals)
120 for dn, attrs in vals:
122 for field in iter(query.model._meta.fields):
123 if field.attname == 'dn':
125 elif hasattr(field, 'from_ldap'):
126 row.append(field.from_ldap(attrs.get(field.db_column, []), connection=self.connection))
132 class WhereNode(BaseWhereNode):
133 def add(self, data, connector):
134 if not isinstance(data, (list, tuple)):
135 super(WhereNode, self).add(data, connector)
138 # we replace the native Constraint by our own
139 obj, lookup_type, value = data
140 if hasattr(obj, "process"):
141 obj = Constraint(obj.alias, obj.col, obj.field)
142 super(WhereNode, self).add((obj, lookup_type, value), connector)
144 def as_sql(self, qn=None, connection=None):
146 for item in self.children:
147 if hasattr(item, 'as_sql'):
148 sql, params = item.as_sql(qn=qn, connection=connection)
152 constraint, lookup_type, y, values = item
153 comp = get_lookup_operator(lookup_type)
154 if hasattr(constraint, "col"):
156 column = constraint.col
157 if lookup_type == 'in':
158 equal_bits = [ "(%s%s%s)" % (column, comp, value) for value in values ]
159 clause = '(|%s)' % ''.join(equal_bits)
161 clause = "(%s%s%s)" % (constraint.col, comp, values)
164 (table, column, db_type) = constraint
165 equal_bits = [ "(%s%s%s)" % (column, comp, value) for value in values ]
166 if len(equal_bits) == 1:
167 clause = equal_bits[0]
169 clause = '(|%s)' % ''.join(equal_bits)
172 bits.append('(!%s)' % clause)
177 elif self.connector == AND:
178 sql_string = '(&%s)' % ''.join(bits)
179 elif self.connector == OR:
180 sql_string = '(|%s)' % ''.join(bits)
182 raise Exception("Unhandled WHERE connector: %s" % self.connector)
183 return sql_string, []
185 class Query(BaseQuery):
186 def __init__(self, *args, **kwargs):
187 super(Query, self).__init__(*args, **kwargs)
188 self.connection = ldapdb.connection
191 filterstr = ''.join(['(objectClass=%s)' % cls for cls in self.model.object_classes])
192 sql, params = self.where.as_sql()
194 filterstr = '(&%s)' % filterstr
197 vals = self.connection.search_s(
204 raise self.model.DoesNotExist
208 def get_compiler(self, using=None, connection=None):
209 return Compiler(self, ldapdb.connection, using)
211 def results_iter(self):
212 "For django 1.1 compatibility"
213 return self.get_compiler().results_iter()
215 class QuerySet(BaseQuerySet):
216 def __init__(self, model=None, query=None, using=None):
219 spec = inspect.getargspec(BaseQuery.__init__)
220 if len(spec[0]) == 3:
222 query = Query(model, WhereNode)
225 query = Query(model, None, WhereNode)
226 super(QuerySet, self).__init__(model=model, query=query)