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.
38 import django.db.models
39 from django.db.models import signals
42 from ldapdb.models.query import QuerySet
44 class ModelBase(django.db.models.base.ModelBase):
46 Metaclass for all LDAP models.
48 def __new__(cls, name, bases, attrs):
49 super_new = super(ModelBase, cls).__new__
50 new_class = super_new(cls, name, bases, attrs)
52 # patch manager to use our own QuerySet class
53 if not new_class._meta.abstract:
55 return QuerySet(new_class)
56 new_class.objects.get_query_set = get_query_set
57 new_class._default_manager.get_query_set = get_query_set
61 class Model(django.db.models.base.Model):
63 Base class for all LDAP models.
65 __metaclass__ = ModelBase
67 dn = django.db.models.fields.CharField(max_length=200)
71 search_scope = ldap.SCOPE_SUBTREE
72 object_classes = ['top']
74 def __init__(self, *args, **kwargs):
75 super(Model, self).__init__(*args, **kwargs)
76 self.saved_pk = self.pk
78 def _collect_sub_objects(self, collector):
80 This private API seems to be called by the admin interface in django 1.2
86 Build the Relative Distinguished Name for this entry.
89 for field in self._meta.fields:
90 if field.db_column and field.primary_key:
91 bits.append("%s=%s" % (field.db_column, getattr(self, field.name)))
93 raise Exception("Could not build Distinguished Name")
98 Build the Distinguished Name for this entry.
100 return "%s,%s" % (self.build_rdn(), self.base_dn)
101 raise Exception("Could not build Distinguished Name")
107 logging.debug("Deleting LDAP entry %s" % self.dn)
108 ldapdb.connection.delete_s(self.dn)
109 signals.post_delete.send(sender=self.__class__, instance=self)
114 record_exists = False
115 entry = [('objectClass', self.object_classes)]
116 new_dn = self.build_dn()
118 for field in self._meta.fields:
119 if not field.db_column:
121 value = getattr(self, field.name)
123 entry.append((field.db_column, field.get_db_prep_save(value, connection=ldapdb.connection)))
125 logging.debug("Creating new LDAP entry %s" % new_dn)
126 ldapdb.connection.add_s(new_dn, entry)
132 # update an existing entry
135 orig = self.__class__.objects.get(pk=self.saved_pk)
136 for field in self._meta.fields:
137 if not field.db_column:
139 old_value = getattr(orig, field.name, None)
140 new_value = getattr(self, field.name, None)
141 if old_value != new_value:
143 modlist.append((ldap.MOD_REPLACE, field.db_column, field.get_db_prep_save(new_value, connection=ldapdb.connection)))
145 modlist.append((ldap.MOD_DELETE, field.db_column, None))
149 new_dn = self.build_dn()
150 if new_dn != self.dn:
151 logging.debug("Renaming LDAP entry %s to %s" % (self.dn, new_dn))
152 ldapdb.connection.rename_s(self.dn, self.build_rdn())
155 logging.debug("Modifying existing LDAP entry %s" % self.dn)
156 ldapdb.connection.modify_s(self.dn, modlist)
158 logging.debug("No changes to be saved to LDAP entry %s" % self.dn)
161 self.saved_pk = self.pk
162 signals.post_save.send(sender=self.__class__, instance=self, created=(not record_exists))
165 def scoped(base_class, base_dn):
167 Returns a copy of the current class with a different base_dn.
171 suffix = re.sub('[=,]', '_', base_dn)
172 name = "%s_%s" % (base_class.__name__, str(suffix))
173 new_class = new.classobj(name, (base_class,), {'base_dn': base_dn, '__module__': base_class.__module__})