ldapdb/models/base.py

   1 # -*- coding: utf-8 -*-
   2 #
   3 # django-ldapdb
   4 # Copyright (C) 2009 Bolloré telecom
   5 # See AUTHORS file for a full list of contributors.
   6 #
   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.
  11 #
  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.
  16 #
  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/>.
  19 #
  20
  21 # -*- coding: utf-8 -*-
  22
  23 import ldap
  24 import logging
  25
  26 import django.db.models
  27 from django.db.models import signals
  28
  29 import ldapdb
  30 from ldapdb.models.query import QuerySet
  31
  32 class ModelBase(django.db.models.base.ModelBase):
  33     """
  34     Metaclass for all LDAP models.
  35     """
  36     def __new__(cls, name, bases, attrs):
  37         attr_meta = attrs.pop('Ldap', None)
  38
  39         super_new = super(ModelBase, cls).__new__
  40         new_class = super_new(cls, name, bases, attrs)
  41
  42         # patch manager to use our own QuerySet class
  43         def get_query_set():
  44             return QuerySet(new_class)
  45         new_class.objects.get_query_set = get_query_set
  46         new_class._default_manager.get_query_set = get_query_set
  47
  48         if attr_meta:
  49             new_class._meta.dn = attr_meta.dn
  50             new_class._meta.object_classes = attr_meta.object_classes
  51
  52         return new_class
  53
  54 class Model(django.db.models.base.Model):
  55     """
  56     Base class for all LDAP models.
  57     """
  58     __metaclass__ = ModelBase
  59
  60     dn = django.db.models.fields.CharField(max_length=200)
  61
  62     def __init__(self, *args, **kwargs):
  63         super(Model, self).__init__(*args, **kwargs)
  64         self.saved_pk = self.pk
  65
  66     def build_rdn(self):
  67         """
  68         Build the Relative Distinguished Name for this entry.
  69         """
  70         bits = []
  71         for field in self._meta.local_fields:
  72             if field.primary_key:
  73                 bits.append("%s=%s" % (field.db_column, getattr(self, field.name)))
  74         if not len(bits):
  75             raise Exception("Could not build Distinguished Name")
  76         return '+'.join(bits)
  77
  78     def build_dn(self):
  79         """
  80         Build the Distinguished Name for this entry.
  81         """
  82         return "%s,%s" % (self.build_rdn(), self._meta.dn)
  83         raise Exception("Could not build Distinguished Name")
  84
  85     def delete(self):
  86         """
  87         Delete this entry.
  88         """
  89         logging.debug("Deleting LDAP entry %s" % self.dn)
  90         ldapdb.connection.delete_s(self.dn)
  91         signals.post_delete.send(sender=self.__class__, instance=self)
  92
  93     def save(self):
  94         if not self.dn:
  95             # create a new entry
  96             record_exists = False
  97             entry = [('objectClass', self._meta.object_classes)]
  98             new_dn = self.build_dn()
  99
 100             for field in self._meta.local_fields:
 101                 if not field.db_column:
 102                     continue
 103                 value = getattr(self, field.name)
 104                 if value:
 105                     entry.append((field.db_column, value))
 106
 107             logging.debug("Creating new LDAP entry %s" % new_dn)
 108             ldapdb.connection.add_s(new_dn, entry)
 109
 110             # update object
 111             self.dn = new_dn
 112
 113         else:
 114             # update an existing entry
 115             record_exists = True
 116             modlist = []
 117             orig = self.__class__.objects.get(pk=self.saved_pk)
 118             for field in self._meta.local_fields:
 119                 if not field.db_column:
 120                     continue
 121                 old_value = getattr(orig, field.name, None)
 122                 new_value = getattr(self, field.name, None)
 123                 if old_value != new_value:
 124                     if new_value:
 125                         modlist.append((ldap.MOD_REPLACE, field.db_column, new_value))
 126                     elif old_value:
 127                         modlist.append((ldap.MOD_DELETE, field.db_column, None))
 128
 129             if len(modlist):
 130                 # handle renaming
 131                 new_dn = self.build_dn()
 132                 if new_dn != self.dn:
 133                     logging.debug("Renaming LDAP entry %s to %s" % (self.dn, new_dn))
 134                     ldapdb.connection.rename_s(self.dn, self.build_rdn())
 135                     self.dn = new_dn
 136
 137                 logging.debug("Modifying existing LDAP entry %s" % self.dn)
 138                 ldapdb.connection.modify_s(self.dn, modlist)
 139             else:
 140                 logging.debug("No changes to be saved to LDAP entry %s" % self.dn)
 141
 142         # done
 143         self.saved_pk = self.pk
 144         signals.post_save.send(sender=self.__class__, instance=self, created=(not record_exists))
 145