blob: dee8a87e1d575d8f2443195620efc4a8b708df8f [file] [log] [blame]
Siobhan Tully4bc09f22013-04-10 21:15:21 -04001import os
Scott Baker65d5a9a2014-05-26 15:58:09 -07002import sys
Siobhan Tully4bc09f22013-04-10 21:15:21 -04003from django.db import models
Scott Baker13acdd62013-05-08 17:42:56 -07004from django.forms.models import model_to_dict
Scott Bakerc1c45f82014-01-21 16:23:51 -08005from django.core.urlresolvers import reverse
Scott Baker6ecd4262014-01-21 23:15:21 -08006from django.forms.models import model_to_dict
Scott Baker02b59522014-09-17 22:18:46 -07007from django.utils import timezone
Scott Bakere5f41b02014-10-02 22:50:18 -07008from django.core.exceptions import PermissionDenied
Sapan Bhatia39097192014-09-04 00:39:19 -04009import model_policy
Sapan Bhatiaf6613e32014-11-12 10:38:23 -050010from model_autodeletion import ephemeral_models
Scott Baker9e990742014-03-19 22:14:58 -070011
12try:
13 # This is a no-op if observer_disabled is set to 1 in the config file
14 from observer import *
15except:
Scott Baker65d5a9a2014-05-26 15:58:09 -070016 print >> sys.stderr, "import of observer failed! printing traceback and disabling observer:"
Scott Baker9e990742014-03-19 22:14:58 -070017 import traceback
18 traceback.print_exc()
19
20 # guard against something failing
Scott Bakerfd44dfc2014-05-23 13:20:53 -070021 def notify_observer(*args, **kwargs):
Scott Baker9e990742014-03-19 22:14:58 -070022 pass
Siobhan Tully4bc09f22013-04-10 21:15:21 -040023
Sapan Bhatia3089d832014-04-29 14:36:51 -040024# This manager will be inherited by all subclasses because
25# the core model is abstract.
Sapan Bhatia15bf5ac2014-07-21 20:06:59 -040026class PlCoreBaseDeletionManager(models.Manager):
Scott Baker92f14222014-09-12 12:57:27 -070027 def get_queryset(self):
Scott Baker02b59522014-09-17 22:18:46 -070028 parent=super(PlCoreBaseDeletionManager, self)
29 if hasattr(parent, "get_queryset"):
30 return parent.get_queryset().filter(deleted=True)
31 else:
32 return parent.get_query_set().filter(deleted=True)
Sapan Bhatia15bf5ac2014-07-21 20:06:59 -040033
Scott Baker02b59522014-09-17 22:18:46 -070034 # deprecated in django 1.7 in favor of get_queryset().
Scott Baker92f14222014-09-12 12:57:27 -070035 def get_query_set(self):
36 return self.get_queryset()
37
Sapan Bhatia15bf5ac2014-07-21 20:06:59 -040038# This manager will be inherited by all subclasses because
39# the core model is abstract.
Sapan Bhatia4eb663a2014-04-29 14:26:10 -040040class PlCoreBaseManager(models.Manager):
Scott Baker92f14222014-09-12 12:57:27 -070041 def get_queryset(self):
Scott Baker02b59522014-09-17 22:18:46 -070042 parent=super(PlCoreBaseManager, self)
43 if hasattr(parent, "get_queryset"):
44 return parent.get_queryset().filter(deleted=False)
45 else:
46 return parent.get_query_set().filter(deleted=False)
Siobhan Tully4bc09f22013-04-10 21:15:21 -040047
Scott Baker02b59522014-09-17 22:18:46 -070048 # deprecated in django 1.7 in favor of get_queryset().
Scott Baker92f14222014-09-12 12:57:27 -070049 def get_query_set(self):
50 return self.get_queryset()
51
Scott Baker1a6a3902014-10-03 00:32:37 -070052class DiffModelMixIn:
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__
55 # method.
56
57 # This is broken out of PlCoreBase into a Mixin so the User model can
58 # also make use of it.
59
60 @property
61 def _dict(self):
62 return model_to_dict(self, fields=[field.name for field in
63 self._meta.fields])
64
65 @property
66 def diff(self):
67 d1 = self._initial
68 d2 = self._dict
69 diffs = [(k, (v, d2[k])) for k, v in d1.items() if v != d2[k]]
70 return dict(diffs)
71
72 @property
73 def has_changed(self):
74 return bool(self.diff)
75
76 @property
77 def changed_fields(self):
78 return self.diff.keys()
79
Scott Baker1a6a3902014-10-03 00:32:37 -070080 def has_field_changed(self, field_name):
81 return field_name in self.diff.keys()
82
83 def get_field_diff(self, field_name):
84 return self.diff.get(field_name, None)
85
Scott Bakerd48371e2014-11-25 11:35:19 -080086 #classmethod
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
90 those fields.
91 """
92 validators = {}
93 for field in cls._meta.fields:
94 l = []
95 if field.blank==False:
96 l.append("notBlank")
97 validators[field.name] = l
98 return validators
99
Scott Baker82db43c2014-11-06 17:33:27 -0800100class PlCoreBase(models.Model): # , DiffModelMixIn):
Sapan Bhatia4eb663a2014-04-29 14:26:10 -0400101 objects = PlCoreBaseManager()
Sapan Bhatia15bf5ac2014-07-21 20:06:59 -0400102 deleted_objects = PlCoreBaseDeletionManager()
103
Scott Baker82db43c2014-11-06 17:33:27 -0800104 # ---- copy stuff from DiffModelMixin ----
105
106 # XXX Django fails miserably when trying to create initial migrations when
107 # DiffModelMixin is used. So, until we figure out what's wrong,
108 # just copied the guts of DiffModelMixIn here.
109
110 @property
111 def _dict(self):
112 return model_to_dict(self, fields=[field.name for field in
113 self._meta.fields])
114
115 @property
116 def diff(self):
117 d1 = self._initial
118 d2 = self._dict
119 diffs = [(k, (v, d2[k])) for k, v in d1.items() if v != d2[k]]
120 return dict(diffs)
121
122 @property
123 def has_changed(self):
124 return bool(self.diff)
125
126 @property
127 def changed_fields(self):
128 return self.diff.keys()
129
130 def has_field_changed(self, field_name):
131 return field_name in self.diff.keys()
132
133 def get_field_diff(self, field_name):
134 return self.diff.get(field_name, None)
Scott Bakerd48371e2014-11-25 11:35:19 -0800135
136 #classmethod
137 def getValidators(cls):
138 """ primarily for REST API, return a dictionary of field names mapped
139 to lists of the type of validations that need to be applied to
140 those fields.
141 """
142 validators = {}
143 for field in cls._meta.fields:
144 l = []
145 if field.blank==False:
146 l.append("notBlank")
147 validators[field.name] = l
148 return validators
149
Scott Baker82db43c2014-11-06 17:33:27 -0800150 # ---- end copy stuff from DiffModelMixin ----
151
Sapan Bhatia15bf5ac2014-07-21 20:06:59 -0400152 # default values for created and updated are only there to keep evolution
153 # from failing.
Scott Baker02b59522014-09-17 22:18:46 -0700154 created = models.DateTimeField(auto_now_add=True, default=timezone.now)
155 updated = models.DateTimeField(auto_now=True, default=timezone.now)
Sapan Bhatia9c2c8fa2013-10-16 13:26:05 -0400156 enacted = models.DateTimeField(null=True, default=None)
Sapan Bhatia34aee752014-04-28 21:06:39 -0400157 backend_status = models.CharField(max_length=140,
Sapan Bhatiad507f432014-04-29 00:41:39 -0400158 default="Provisioning in progress")
Sapan Bhatiabcc18992014-04-29 10:32:14 -0400159 deleted = models.BooleanField(default=False)
Siobhan Tully4bc09f22013-04-10 21:15:21 -0400160
Sapan Bhatia9c2c8fa2013-10-16 13:26:05 -0400161 class Meta:
Sapan Bhatia3089d832014-04-29 14:36:51 -0400162 # Changing abstract to False would require the managers of subclasses of
163 # PlCoreBase to be customized individually.
Sapan Bhatia9c2c8fa2013-10-16 13:26:05 -0400164 abstract = True
165 app_label = "core"
Siobhan Tully4bc09f22013-04-10 21:15:21 -0400166
Sapan Bhatia9c2c8fa2013-10-16 13:26:05 -0400167 def __init__(self, *args, **kwargs):
168 super(PlCoreBase, self).__init__(*args, **kwargs)
Scott Baker1a6a3902014-10-03 00:32:37 -0700169 self._initial = self._dict # for DiffModelMixIn
Scott Bakerf3f895c2014-09-23 22:41:17 -0700170 self.silent = False
Scott Baker13acdd62013-05-08 17:42:56 -0700171
Tony Mack5b061472014-02-04 07:57:10 -0500172 def can_update(self, user):
173 if user.is_readonly:
174 return False
175 if user.is_admin:
176 return True
Tony Mack5b061472014-02-04 07:57:10 -0500177
Scott Baker1bffe942014-10-06 22:58:48 -0700178 return False
Scott Baker1a6a3902014-10-03 00:32:37 -0700179
Sapan Bhatia9c2c8fa2013-10-16 13:26:05 -0400180 def delete(self, *args, **kwds):
Scott Baker6ecd4262014-01-21 23:15:21 -0800181 # so we have something to give the observer
Sapan Bhatia77d1d892014-07-21 20:07:23 -0400182 purge = kwds.get('purge',False)
Scott Baker3d2d3e42014-10-09 16:22:00 -0700183 if purge:
184 del kwds['purge']
Scott Baker6594bea2014-09-23 16:04:36 -0700185 silent = kwds.get('silent',False)
Scott Baker3d2d3e42014-10-09 16:22:00 -0700186 if silent:
187 del kwds['silent']
Sapan Bhatia77d1d892014-07-21 20:07:23 -0400188 try:
189 purge = purge or observer_disabled
190 except NameError:
191 pass
Scott Baker6594bea2014-09-23 16:04:36 -0700192
Sapan Bhatia77d1d892014-07-21 20:07:23 -0400193 if (purge):
194 super(PlCoreBase, self).delete(*args, **kwds)
Sapan Bhatiac8602432014-04-29 20:33:51 -0400195 else:
196 self.deleted = True
197 self.enacted=None
Scott Baker6594bea2014-09-23 16:04:36 -0700198 self.save(update_fields=['enacted','deleted'], silent=silent)
Sapan Bhatiadbaf1932013-09-03 11:28:52 -0400199
Sapan Bhatia9c2c8fa2013-10-16 13:26:05 -0400200 def save(self, *args, **kwargs):
Scott Bakerf3f895c2014-09-23 22:41:17 -0700201 # let the user specify silence as either a kwarg or an instance varible
202 silent = self.silent
Scott Baker6594bea2014-09-23 16:04:36 -0700203 if "silent" in kwargs:
Scott Bakerf3f895c2014-09-23 22:41:17 -0700204 silent=silent or kwargs.pop("silent")
Scott Baker6594bea2014-09-23 16:04:36 -0700205
Sapan Bhatia9c2c8fa2013-10-16 13:26:05 -0400206 super(PlCoreBase, self).save(*args, **kwargs)
Sapan Bhatiac8602432014-04-29 20:33:51 -0400207
Sapan Bhatia9c2c8fa2013-10-16 13:26:05 -0400208 # This is a no-op if observer_disabled is set
Scott Baker6594bea2014-09-23 16:04:36 -0700209 if not silent:
210 notify_observer()
Sapan Bhatia66f4e612013-07-02 12:12:38 -0400211
Scott Baker5e5f4552014-10-03 14:48:06 -0700212 self._initial = self._dict
Scott Baker13acdd62013-05-08 17:42:56 -0700213
Tony Mack5b061472014-02-04 07:57:10 -0500214 def save_by_user(self, user, *args, **kwds):
Scott Bakere5f41b02014-10-02 22:50:18 -0700215 if not self.can_update(user):
Scott Baker1bffe942014-10-06 22:58:48 -0700216 if getattr(self, "_cant_update_fieldName", None) is not None:
217 raise PermissionDenied("You do not have permission to update field %s on object %s" % (self._cant_update_fieldName, self.__class__.__name__))
218 else:
219 raise PermissionDenied("You do not have permission to update %s objects" % self.__class__.__name__)
Scott Baker1a6a3902014-10-03 00:32:37 -0700220
Scott Bakere5f41b02014-10-02 22:50:18 -0700221 self.save(*args, **kwds)
Tony Mack5b061472014-02-04 07:57:10 -0500222
Tony Mack332ee1d2014-02-04 15:33:45 -0500223 def delete_by_user(self, user, *args, **kwds):
Scott Bakere5f41b02014-10-02 22:50:18 -0700224 if not self.can_update(user):
225 raise PermissionDenied("You do not have permission to delete %s objects" % self.__class__.__name__)
226 self.delete(*args, **kwds)
Tony Mack332ee1d2014-02-04 15:33:45 -0500227
Scott Baker5e5f4552014-10-03 14:48:06 -0700228 @classmethod
229 def select_by_user(cls, user):
230 # This should be overridden by descendant classes that want to perform
231 # filtering of visible objects by user.
232 return cls.objects.all()
233
Sapan Bhatiae33b9dc2014-11-12 10:06:23 -0500234 @classmethod
235 def is_ephemeral(cls):
Sapan Bhatiaf6613e32014-11-12 10:38:23 -0500236 return cls in ephemeral_models
Sapan Bhatiae33b9dc2014-11-12 10:06:23 -0500237
Scott Baker17dbb022014-11-25 00:49:17 -0800238
239
Scott Baker13acdd62013-05-08 17:42:56 -0700240
Siobhan Tully4bc09f22013-04-10 21:15:21 -0400241
242