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.
37 from django.db.models.sql import aggregates, compiler
38 from django.db.models.sql.where import AND, OR
40 def get_lookup_operator(lookup_type):
41 if lookup_type == 'gte':
43 elif lookup_type == 'lte':
48 def query_as_ldap(query):
49 filterstr = ''.join(['(objectClass=%s)' % cls for cls in query.model.object_classes])
50 sql, params = where_as_ldap(query.where)
52 return '(&%s)' % filterstr
54 def where_as_ldap(self):
56 for item in self.children:
57 if hasattr(item, 'as_sql'):
58 sql, params = where_as_ldap(item)
62 constraint, lookup_type, y, values = item
63 comp = get_lookup_operator(lookup_type)
64 if lookup_type == 'in':
65 equal_bits = [ "(%s%s%s)" % (constraint.col, comp, value) for value in values ]
66 clause = '(|%s)' % ''.join(equal_bits)
68 clause = "(%s%s%s)" % (constraint.col, comp, values)
77 elif self.connector == AND:
78 sql_string = '(&%s)' % ''.join(bits)
79 elif self.connector == OR:
80 sql_string = '(|%s)' % ''.join(bits)
82 raise Exception("Unhandled WHERE connector: %s" % self.connector)
85 sql_string = ('(!%s)' % sql_string)
89 class SQLCompiler(object):
90 def __init__(self, query, connection, using):
92 self.connection = connection
95 def execute_sql(self, result_type=compiler.MULTI):
96 if result_type !=compiler.SINGLE:
97 raise Exception("LDAP does not support MULTI queries")
100 vals = self.connection.search_s(
101 self.query.model.base_dn,
102 self.query.model.search_scope,
103 filterstr=query_as_ldap(self.query),
106 except ldap.NO_SUCH_OBJECT:
110 for key, aggregate in self.query.aggregate_select.items():
111 if not isinstance(aggregate, aggregates.Count):
112 raise Exception("Unsupported aggregate %s" % aggregate)
113 output.append(len(vals))
116 def results_iter(self):
117 if self.query.select_fields:
118 fields = self.query.select_fields
120 fields = self.query.model._meta.fields
122 attrlist = [ x.db_column for x in fields if x.db_column ]
125 vals = self.connection.search_s(
126 self.query.model.base_dn,
127 self.query.model.search_scope,
128 filterstr=query_as_ldap(self.query),
131 except ldap.NO_SUCH_OBJECT:
135 if self.query.extra_order_by:
136 ordering = self.query.extra_order_by
137 elif not self.query.default_ordering:
138 ordering = self.query.order_by
140 ordering = self.query.order_by or self.query.model._meta.ordering
142 for fieldname in ordering:
143 if fieldname.startswith('-'):
144 fieldname = fieldname[1:]
148 field = self.query.model._meta.get_field(fieldname)
149 attr_x = field.from_ldap(x[1].get(field.db_column, []), connection=self.connection)
150 attr_y = field.from_ldap(y[1].get(field.db_column, []), connection=self.connection)
151 # perform case insensitive comparison
152 if hasattr(attr_x, 'lower'):
153 attr_x = attr_x.lower()
154 if hasattr(attr_y, 'lower'):
155 attr_y = attr_y.lower()
156 val = negate and cmp(attr_y, attr_x) or cmp(attr_x, attr_y)
160 vals = sorted(vals, cmp=cmpvals)
164 for dn, attrs in vals:
165 # FIXME : This is not optimal, we retrieve more results than we need
166 # but there is probably no other options as we can't perform ordering
168 if (self.query.low_mark and pos < self.query.low_mark) or \
169 (self.query.high_mark is not None and pos >= self.query.high_mark):
173 for field in iter(fields):
174 if field.attname == 'dn':
176 elif hasattr(field, 'from_ldap'):
177 row.append(field.from_ldap(attrs.get(field.db_column, []), connection=self.connection))
183 class SQLInsertCompiler(compiler.SQLInsertCompiler, SQLCompiler):
186 class SQLDeleteCompiler(compiler.SQLDeleteCompiler, SQLCompiler):
187 def execute_sql(self, result_type=compiler.MULTI):
189 vals = self.connection.search_s(
190 self.query.model.base_dn,
191 self.query.model.search_scope,
192 filterstr=query_as_ldap(self.query),
195 except ldap.NO_SUCH_OBJECT:
198 # FIXME : there is probably a more efficient way to do this
199 for dn, attrs in vals:
200 self.connection.delete_s(dn)
202 class SQLUpdateCompiler(compiler.SQLUpdateCompiler, SQLCompiler):
205 class SQLAggregateCompiler(compiler.SQLAggregateCompiler, SQLCompiler):
208 class SQLDateCompiler(compiler.SQLDateCompiler, SQLCompiler):