ldapdb/backends/ldap/compiler.py

   1 # -*- coding: utf-8 -*-
   2 #
   3 # django-ldapdb
   4 # Copyright (c) 2009-2010, Bolloré telecom
   5 # All rights reserved.
   6 #
   7 # See AUTHORS file for a full list of contributors.
   8 #
   9 # Redistribution and use in source and binary forms, with or without modification,
  10 # are permitted provided that the following conditions are met:
  11 #
  12 #     1. Redistributions of source code must retain the above copyright notice,
  13 #        this list of conditions and the following disclaimer.
  14 #
  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.
  18 #
  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.
  22 #
  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.
  33 #
  34
  35 import ldap
  36
  37 class SQLCompiler(object):
  38     def __init__(self, query, connection, using):
  39         self.query = query
  40         self.connection = connection
  41         self.using = using
  42
  43     def results_iter(self):
  44         if self.query.select_fields:
  45             fields = self.query.select_fields
  46         else:
  47             fields = self.query.model._meta.fields
  48
  49         attrlist = [ x.db_column for x in fields if x.db_column ]
  50
  51         try:
  52             vals = self.connection.search_s(
  53                 self.query.model.base_dn,
  54                 self.query.model.search_scope,
  55                 filterstr=self.query._ldap_filter(),
  56                 attrlist=attrlist,
  57             )
  58         except ldap.NO_SUCH_OBJECT:
  59             return
  60
  61         # perform sorting
  62         if self.query.extra_order_by:
  63             ordering = self.query.extra_order_by
  64         elif not self.query.default_ordering:
  65             ordering = self.query.order_by
  66         else:
  67             ordering = self.query.order_by or self.query.model._meta.ordering
  68         def cmpvals(x, y):
  69             for fieldname in ordering:
  70                 if fieldname.startswith('-'):
  71                     fieldname = fieldname[1:]
  72                     negate = True
  73                 else:
  74                     negate = False
  75                 field = self.query.model._meta.get_field(fieldname)
  76                 attr_x = field.from_ldap(x[1].get(field.db_column, []), connection=self.connection)
  77                 attr_y = field.from_ldap(y[1].get(field.db_column, []), connection=self.connection)
  78                 # perform case insensitive comparison
  79                 if hasattr(attr_x, 'lower'):
  80                     attr_x = attr_x.lower()
  81                 if hasattr(attr_y, 'lower'):
  82                     attr_y = attr_y.lower()
  83                 val = negate and cmp(attr_y, attr_x) or cmp(attr_x, attr_y)
  84                 if val:
  85                     return val
  86             return 0
  87         vals = sorted(vals, cmp=cmpvals)
  88
  89         # process results
  90         pos = 0
  91         for dn, attrs in vals:
  92             # FIXME : This is not optimal, we retrieve more results than we need
  93             # but there is probably no other options as we can't perform ordering
  94             # server side.
  95             if (self.query.low_mark and pos < self.query.low_mark) or \
  96                (self.query.high_mark is not None and pos >= self.query.high_mark):
  97                 pos += 1
  98                 continue
  99             row = []
 100             for field in iter(fields):
 101                 if field.attname == 'dn':
 102                     row.append(dn)
 103                 elif hasattr(field, 'from_ldap'):
 104                     row.append(field.from_ldap(attrs.get(field.db_column, []), connection=self.connection))
 105                 else:
 106                     row.append(None)
 107             yield row
 108             pos += 1
 109