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/>.
24 import django.db.models
25 from django.db.models import signals
28 from ldapdb.models.query import QuerySet
30 class ModelBase(django.db.models.base.ModelBase):
32 Metaclass for all LDAP models.
34 def __new__(cls, name, bases, attrs):
35 super_new = super(ModelBase, cls).__new__
36 new_class = super_new(cls, name, bases, attrs)
38 # patch manager to use our own QuerySet class
39 if not new_class._meta.abstract:
41 return QuerySet(new_class)
42 new_class.objects.get_query_set = get_query_set
43 new_class._default_manager.get_query_set = get_query_set
47 class Model(django.db.models.base.Model):
49 Base class for all LDAP models.
51 __metaclass__ = ModelBase
53 dn = django.db.models.fields.CharField(max_length=200)
57 object_classes = ['top']
59 def __init__(self, *args, **kwargs):
60 super(Model, self).__init__(*args, **kwargs)
61 self.saved_pk = self.pk
63 def _collect_sub_objects(self, collector):
65 This private API seems to be called by the admin interface in django 1.2
71 Build the Relative Distinguished Name for this entry.
74 for field in self._meta.local_fields:
76 bits.append("%s=%s" % (field.db_column, getattr(self, field.name)))
78 raise Exception("Could not build Distinguished Name")
83 Build the Distinguished Name for this entry.
85 return "%s,%s" % (self.build_rdn(), self.base_dn)
86 raise Exception("Could not build Distinguished Name")
92 logging.debug("Deleting LDAP entry %s" % self.dn)
93 ldapdb.connection.delete_s(self.dn)
94 signals.post_delete.send(sender=self.__class__, instance=self)
100 entry = [('objectClass', self.object_classes)]
101 new_dn = self.build_dn()
103 for field in self._meta.local_fields:
104 if not field.db_column:
106 value = getattr(self, field.name)
108 entry.append((field.db_column, field.get_db_prep_save(value, connection=ldapdb.connection)))
110 logging.debug("Creating new LDAP entry %s" % new_dn)
111 ldapdb.connection.add_s(new_dn, entry)
117 # update an existing entry
120 orig = self.__class__.objects.get(pk=self.saved_pk)
121 for field in self._meta.local_fields:
122 if not field.db_column:
124 old_value = getattr(orig, field.name, None)
125 new_value = getattr(self, field.name, None)
126 if old_value != new_value:
128 modlist.append((ldap.MOD_REPLACE, field.db_column, field.get_db_prep_save(new_value, connection=ldapdb.connection)))
130 modlist.append((ldap.MOD_DELETE, field.db_column, None))
134 new_dn = self.build_dn()
135 if new_dn != self.dn:
136 logging.debug("Renaming LDAP entry %s to %s" % (self.dn, new_dn))
137 ldapdb.connection.rename_s(self.dn, self.build_rdn())
140 logging.debug("Modifying existing LDAP entry %s" % self.dn)
141 ldapdb.connection.modify_s(self.dn, modlist)
143 logging.debug("No changes to be saved to LDAP entry %s" % self.dn)
146 self.saved_pk = self.pk
147 signals.post_save.send(sender=self.__class__, instance=self, created=(not record_exists))
150 def scoped(base_class, base_dn):
152 Returns a copy of the current class with a different base_dn.
156 suffix = re.sub('[=,]', '_', base_dn)
157 name = "%s_%s" % (base_class.__name__, str(suffix))
158 new_class = new.classobj(name, (base_class,), {'base_dn': base_dn, '__module__': base_class.__module__})