X-Git-Url: https://git.stderr.nl/gitweb?p=matthijs%2Fupstream%2Fdjango-ldapdb.git;a=blobdiff_plain;f=ldapdb%2Fmodels%2Fbase.py;h=85353460ef1661e64283f54db73f20de27875ca1;hp=661c2eda2593ae45bb0f91960d7e9f398d0cf7a6;hb=d8c01bc4028d5b030667acf34d003d8145c8c979;hpb=8aafb73e2347febe83c7760a72d10976cc0a35f3 diff --git a/ldapdb/models/base.py b/ldapdb/models/base.py index 661c2ed..8535346 100644 --- a/ldapdb/models/base.py +++ b/ldapdb/models/base.py @@ -1,7 +1,7 @@ # -*- coding: utf-8 -*- # # django-ldapdb -# Copyright (c) 2009-2010, Bolloré telecom +# Copyright (c) 2009-2011, Bolloré telecom # All rights reserved. # # See AUTHORS file for a full list of contributors. @@ -36,34 +36,19 @@ import ldap import logging import django.db.models +from django.db import connections, router from django.db.models import signals import ldapdb -from ldapdb.models.query import QuerySet +import fields -class ModelBase(django.db.models.base.ModelBase): - """ - Metaclass for all LDAP models. - """ - def __new__(cls, name, bases, attrs): - super_new = super(ModelBase, cls).__new__ - new_class = super_new(cls, name, bases, attrs) - - # patch manager to use our own QuerySet class - if not new_class._meta.abstract: - def get_query_set(): - return QuerySet(new_class) - new_class.objects.get_query_set = get_query_set - new_class._default_manager.get_query_set = get_query_set - - return new_class +# Dict containing +object_classes = {} class Model(django.db.models.base.Model): """ Base class for all LDAP models. """ - __metaclass__ = ModelBase - dn = django.db.models.fields.CharField(max_length=200) # meta-data @@ -75,14 +60,6 @@ class Model(django.db.models.base.Model): super(Model, self).__init__(*args, **kwargs) self.saved_pk = self.pk - def _collect_sub_objects(self, seen_objs, parent=None, nullable=False): - """ - This private API seems to be called by the admin interface in django 1.2 - """ - pk_val = self._get_pk_val() - seen_objs.add(self.__class__, pk_val, self, - type(parent), parent, nullable) - def build_rdn(self): """ Build the Relative Distinguished Name for this entry. @@ -102,15 +79,22 @@ class Model(django.db.models.base.Model): return "%s,%s" % (self.build_rdn(), self.base_dn) raise Exception("Could not build Distinguished Name") - def delete(self): + def delete(self, using=None): """ Delete this entry. """ + using = using or router.db_for_write(self.__class__, instance=self) + connection = connections[using] logging.debug("Deleting LDAP entry %s" % self.dn) - ldapdb.connection.delete_s(self.dn) + connection.delete_s(self.dn) signals.post_delete.send(sender=self.__class__, instance=self) - - def save(self): + + def save(self, using=None): + """ + Saves the current instance. + """ + using = using or router.db_for_write(self.__class__, instance=self) + connection = connections[using] if not self.dn: # create a new entry record_exists = False @@ -122,10 +106,10 @@ class Model(django.db.models.base.Model): continue value = getattr(self, field.name) if value: - entry.append((field.db_column, field.get_db_prep_save(value, connection=ldapdb.connection))) + entry.append((field.db_column, field.get_db_prep_save(value, connection=connection))) logging.debug("Creating new LDAP entry %s" % new_dn) - ldapdb.connection.add_s(new_dn, entry) + connection.add_s(new_dn, entry) # update object self.dn = new_dn @@ -134,6 +118,7 @@ class Model(django.db.models.base.Model): # update an existing entry record_exists = True modlist = [] + modlist.append((ldap.MOD_REPLACE, 'objectClass', [x.encode(connection.charset) for x in self.object_classes])) orig = self.__class__.objects.get(pk=self.saved_pk) for field in self._meta.fields: if not field.db_column: @@ -142,7 +127,7 @@ class Model(django.db.models.base.Model): new_value = getattr(self, field.name, None) if old_value != new_value: if new_value: - modlist.append((ldap.MOD_REPLACE, field.db_column, field.get_db_prep_save(new_value, connection=ldapdb.connection))) + modlist.append((ldap.MOD_REPLACE, field.db_column, field.get_db_prep_save(new_value, connection=connection))) elif old_value: modlist.append((ldap.MOD_DELETE, field.db_column, None)) @@ -151,11 +136,11 @@ class Model(django.db.models.base.Model): new_dn = self.build_dn() if new_dn != self.dn: logging.debug("Renaming LDAP entry %s to %s" % (self.dn, new_dn)) - ldapdb.connection.rename_s(self.dn, self.build_rdn()) + connection.rename_s(self.dn, self.build_rdn()) self.dn = new_dn logging.debug("Modifying existing LDAP entry %s" % self.dn) - ldapdb.connection.modify_s(self.dn, modlist) + connection.modify_s(self.dn, modlist) else: logging.debug("No changes to be saved to LDAP entry %s" % self.dn) @@ -163,6 +148,58 @@ class Model(django.db.models.base.Model): self.saved_pk = self.pk signals.post_save.send(sender=self.__class__, instance=self, created=(not record_exists)) + def add_object_class(self, oc): + """ + Add an extra object class to this object. The added objectclass + must be defined as a subclass of ObjectClass. This changes the + type of this object to add the fields of the new + objectclass. + + The objectclass passed can be a string naming the objectclass, + or an ObjectClass subclass. + """ + + # The new class is a subclass of Model + bases = [Model] + list(Model.__bases__) + + object_classes = self.__class__.object_classes + object_classes.append(oc) + + dict_ = { + # Copy the module from Model + '__module__': Model.__module__, + # Generate some documentation + '__doc__': 'Automatically generated class for LDAP objects with objectclasses: ' + (', '.join(object_classes)), + # Add a class variable containing the object_classes + 'object_classes': object_classes, + # Copy the base_dn from the old class + 'base_dn': self.__class__.base_dn, + } + + # Add all current fields, but leave out fields that Model + # already has (these will be added by Django later, since we + # make the new class a subclass of Model). + dict_.update([(f.name, f) for f in self._meta.fields if not f in Model._meta.fields]) + + # If the passed object class is a string, resolve it to an + # ObjectClass object. + if (isinstance(oc, basestring)): + oc = ObjectClass.object_classes[oc] + + # Copy all fields (e.g., subclasses of Field) from the new + # ObjectClass + for k,v in oc.__dict__.items(): + if isinstance(v, django.db.models.fields.Field): + dict_[k] = v + + # Generate a name for the class (gotta have something...) + name = '_'.join(object_classes) + + # And finally, generate the type + self.__class__ = type(name, tuple(bases), dict_) + + # TODO: remove_object_class + @classmethod def scoped(base_class, base_dn): """ @@ -175,3 +212,18 @@ class Model(django.db.models.base.Model): new_class = new.classobj(name, (base_class,), {'base_dn': base_dn, '__module__': base_class.__module__}) return new_class + class Meta: + abstract = True + +class ObjectClass(object): + """ + Superclass for LDAP objectclass descriptors. + """ + + # Mapping from objectclass name (string) to the ObjectClass subclass + # that describes it. Used when loading items from the database or + # when adding object classes. + # + # TODO: Automatically fill this list from a fancy metaclass + object_classes = {} +