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)
87 def getValidators(cls):
88 """ primarily for REST API, return a dictionary of field names mapped
89 to lists of the type of validations that need to be applied to
93 for field in cls._meta.fields:
95 if field.blank==False:
97 if field.__class__.__name__=="URLField":
99 validators[field.name] = l
102 class PlCoreBase(models.Model): # , DiffModelMixIn):
103 objects = PlCoreBaseManager()
104 deleted_objects = PlCoreBaseDeletionManager()
106 # ---- copy stuff from DiffModelMixin ----
108 # XXX Django fails miserably when trying to create initial migrations when
109 # DiffModelMixin is used. So, until we figure out what's wrong,
110 # just copied the guts of DiffModelMixIn here.
114 return model_to_dict(self, fields=[field.name for field in
121 diffs = [(k, (v, d2[k])) for k, v in d1.items() if v != d2[k]]
125 def has_changed(self):
126 return bool(self.diff)
129 def changed_fields(self):
130 return self.diff.keys()
132 def has_field_changed(self, field_name):
133 return field_name in self.diff.keys()
135 def get_field_diff(self, field_name):
136 return self.diff.get(field_name, None)
139 def getValidators(cls):
140 """ primarily for REST API, return a dictionary of field names mapped
141 to lists of the type of validations that need to be applied to
145 for field in cls._meta.fields:
147 if field.blank==False:
149 if field.__class__.__name__=="URLField":
151 validators[field.name] = l
154 # ---- end copy stuff from DiffModelMixin ----
156 # default values for created and updated are only there to keep evolution
158 created = models.DateTimeField(auto_now_add=True, default=timezone.now)
159 updated = models.DateTimeField(auto_now=True, default=timezone.now)
160 enacted = models.DateTimeField(null=True, blank=True, default=None)
161 policed = models.DateTimeField(null=True, blank=True, default=None)
162 backend_status = models.CharField(max_length=140,
163 default="0 - Provisioning in progress")
164 deleted = models.BooleanField(default=False)
167 # Changing abstract to False would require the managers of subclasses of
168 # PlCoreBase to be customized individually.
172 def __init__(self, *args, **kwargs):
173 super(PlCoreBase, self).__init__(*args, **kwargs)
174 self._initial = self._dict # for DiffModelMixIn
177 def can_update(self, user):
185 def delete(self, *args, **kwds):
186 # so we have something to give the observer
187 purge = kwds.get('purge',False)
190 silent = kwds.get('silent',False)
194 purge = purge or observer_disabled
199 super(PlCoreBase, self).delete(*args, **kwds)
203 self.save(update_fields=['enacted','deleted'], silent=silent)
205 def save(self, *args, **kwargs):
206 # let the user specify silence as either a kwarg or an instance varible
208 if "silent" in kwargs:
209 silent=silent or kwargs.pop("silent")
211 super(PlCoreBase, self).save(*args, **kwargs)
213 # This is a no-op if observer_disabled is set
217 self._initial = self._dict
219 def save_by_user(self, user, *args, **kwds):
220 if not self.can_update(user):
221 if getattr(self, "_cant_update_fieldName", None) is not None:
222 raise PermissionDenied("You do not have permission to update field %s on object %s" % (self._cant_update_fieldName, self.__class__.__name__))
224 raise PermissionDenied("You do not have permission to update %s objects" % self.__class__.__name__)
226 self.save(*args, **kwds)
228 def delete_by_user(self, user, *args, **kwds):
229 if not self.can_update(user):
230 raise PermissionDenied("You do not have permission to delete %s objects" % self.__class__.__name__)
231 self.delete(*args, **kwds)
234 def select_by_user(cls, user):
235 # This should be overridden by descendant classes that want to perform
236 # filtering of visible objects by user.
237 return cls.objects.all()
240 def is_ephemeral(cls):
241 return cls in ephemeral_models