3 from django.db import models
4 from django.forms.models import model_to_dict
5 from django.core.urlresolvers import reverse
6 from django.forms.models import model_to_dict
7 from django.utils import timezone
8 from django.core.exceptions import PermissionDenied
10 from model_autodeletion import ephemeral_models
13 # This is a no-op if observer_disabled is set to 1 in the config file
14 from observer import *
16 print >> sys.stderr, "import of observer failed! printing traceback and disabling observer:"
20 # guard against something failing
21 def notify_observer(*args, **kwargs):
24 # This manager will be inherited by all subclasses because
25 # the core model is abstract.
26 class PlCoreBaseDeletionManager(models.Manager):
27 def get_queryset(self):
28 parent=super(PlCoreBaseDeletionManager, self)
29 if hasattr(parent, "get_queryset"):
30 return parent.get_queryset().filter(deleted=True)
32 return parent.get_query_set().filter(deleted=True)
34 # deprecated in django 1.7 in favor of get_queryset().
35 def get_query_set(self):
36 return self.get_queryset()
38 # This manager will be inherited by all subclasses because
39 # the core model is abstract.
40 class PlCoreBaseManager(models.Manager):
41 def get_queryset(self):
42 parent=super(PlCoreBaseManager, self)
43 if hasattr(parent, "get_queryset"):
44 return parent.get_queryset().filter(deleted=False)
46 return parent.get_query_set().filter(deleted=False)
48 # deprecated in django 1.7 in favor of get_queryset().
49 def get_query_set(self):
50 return self.get_queryset()
53 # Provides useful methods for computing which objects in a model have
54 # changed. Make sure to do self._initial = self._dict in the __init__
57 # This is broken out of PlCoreBase into a Mixin so the User model can
58 # also make use of it.
62 return model_to_dict(self, fields=[field.name for field in
69 diffs = [(k, (v, d2[k])) for k, v in d1.items() if v != d2[k]]
73 def has_changed(self):
74 return bool(self.diff)
77 def changed_fields(self):
78 return self.diff.keys()
80 def has_field_changed(self, field_name):
81 return field_name in self.diff.keys()
83 def get_field_diff(self, field_name):
84 return self.diff.get(field_name, None)
86 class PlCoreBase(models.Model): # , DiffModelMixIn):
87 objects = PlCoreBaseManager()
88 deleted_objects = PlCoreBaseDeletionManager()
90 # ---- copy stuff from DiffModelMixin ----
92 # XXX Django fails miserably when trying to create initial migrations when
93 # DiffModelMixin is used. So, until we figure out what's wrong,
94 # just copied the guts of DiffModelMixIn here.
98 return model_to_dict(self, fields=[field.name for field in
105 diffs = [(k, (v, d2[k])) for k, v in d1.items() if v != d2[k]]
109 def has_changed(self):
110 return bool(self.diff)
113 def changed_fields(self):
114 return self.diff.keys()
116 def has_field_changed(self, field_name):
117 return field_name in self.diff.keys()
119 def get_field_diff(self, field_name):
120 return self.diff.get(field_name, None)
121 # ---- end copy stuff from DiffModelMixin ----
123 # default values for created and updated are only there to keep evolution
125 created = models.DateTimeField(auto_now_add=True, default=timezone.now)
126 updated = models.DateTimeField(auto_now=True, default=timezone.now)
127 enacted = models.DateTimeField(null=True, default=None)
128 backend_status = models.CharField(max_length=140,
129 default="Provisioning in progress")
130 deleted = models.BooleanField(default=False)
133 # Changing abstract to False would require the managers of subclasses of
134 # PlCoreBase to be customized individually.
138 def __init__(self, *args, **kwargs):
139 super(PlCoreBase, self).__init__(*args, **kwargs)
140 self._initial = self._dict # for DiffModelMixIn
143 def can_update(self, user):
151 def delete(self, *args, **kwds):
152 # so we have something to give the observer
153 purge = kwds.get('purge',False)
156 silent = kwds.get('silent',False)
160 purge = purge or observer_disabled
165 super(PlCoreBase, self).delete(*args, **kwds)
169 self.save(update_fields=['enacted','deleted'], silent=silent)
171 def save(self, *args, **kwargs):
172 # let the user specify silence as either a kwarg or an instance varible
174 if "silent" in kwargs:
175 silent=silent or kwargs.pop("silent")
177 super(PlCoreBase, self).save(*args, **kwargs)
179 # This is a no-op if observer_disabled is set
183 self._initial = self._dict
185 def save_by_user(self, user, *args, **kwds):
186 if not self.can_update(user):
187 if getattr(self, "_cant_update_fieldName", None) is not None:
188 raise PermissionDenied("You do not have permission to update field %s on object %s" % (self._cant_update_fieldName, self.__class__.__name__))
190 raise PermissionDenied("You do not have permission to update %s objects" % self.__class__.__name__)
192 self.save(*args, **kwds)
194 def delete_by_user(self, user, *args, **kwds):
195 if not self.can_update(user):
196 raise PermissionDenied("You do not have permission to delete %s objects" % self.__class__.__name__)
197 self.delete(*args, **kwds)
200 def select_by_user(cls, user):
201 # This should be overridden by descendant classes that want to perform
202 # filtering of visible objects by user.
203 return cls.objects.all()
206 def is_ephemeral(cls):
207 return cls in ephemeral_models