blob: e483a796f1d09b44e7fed43bb0f5d85918645d70 [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
Scott Baker9e990742014-03-19 22:14:58 -070010
11try:
12 # This is a no-op if observer_disabled is set to 1 in the config file
13 from observer import *
14except:
Scott Baker65d5a9a2014-05-26 15:58:09 -070015 print >> sys.stderr, "import of observer failed! printing traceback and disabling observer:"
Scott Baker9e990742014-03-19 22:14:58 -070016 import traceback
17 traceback.print_exc()
18
19 # guard against something failing
Scott Bakerfd44dfc2014-05-23 13:20:53 -070020 def notify_observer(*args, **kwargs):
Scott Baker9e990742014-03-19 22:14:58 -070021 pass
Siobhan Tully4bc09f22013-04-10 21:15:21 -040022
Sapan Bhatia3089d832014-04-29 14:36:51 -040023# This manager will be inherited by all subclasses because
24# the core model is abstract.
Sapan Bhatia15bf5ac2014-07-21 20:06:59 -040025class PlCoreBaseDeletionManager(models.Manager):
Scott Baker92f14222014-09-12 12:57:27 -070026 def get_queryset(self):
Scott Baker02b59522014-09-17 22:18:46 -070027 parent=super(PlCoreBaseDeletionManager, self)
28 if hasattr(parent, "get_queryset"):
29 return parent.get_queryset().filter(deleted=True)
30 else:
31 return parent.get_query_set().filter(deleted=True)
Sapan Bhatia15bf5ac2014-07-21 20:06:59 -040032
Scott Baker02b59522014-09-17 22:18:46 -070033 # deprecated in django 1.7 in favor of get_queryset().
Scott Baker92f14222014-09-12 12:57:27 -070034 def get_query_set(self):
35 return self.get_queryset()
36
Sapan Bhatia15bf5ac2014-07-21 20:06:59 -040037# This manager will be inherited by all subclasses because
38# the core model is abstract.
Sapan Bhatia4eb663a2014-04-29 14:26:10 -040039class PlCoreBaseManager(models.Manager):
Scott Baker92f14222014-09-12 12:57:27 -070040 def get_queryset(self):
Scott Baker02b59522014-09-17 22:18:46 -070041 parent=super(PlCoreBaseManager, self)
42 if hasattr(parent, "get_queryset"):
43 return parent.get_queryset().filter(deleted=False)
44 else:
45 return parent.get_query_set().filter(deleted=False)
Siobhan Tully4bc09f22013-04-10 21:15:21 -040046
Scott Baker02b59522014-09-17 22:18:46 -070047 # deprecated in django 1.7 in favor of get_queryset().
Scott Baker92f14222014-09-12 12:57:27 -070048 def get_query_set(self):
49 return self.get_queryset()
50
Scott Baker1a6a3902014-10-03 00:32:37 -070051class DiffModelMixIn:
52 # Provides useful methods for computing which objects in a model have
53 # changed. Make sure to do self._initial = self._dict in the __init__
54 # method.
55
56 # This is broken out of PlCoreBase into a Mixin so the User model can
57 # also make use of it.
58
59 @property
60 def _dict(self):
61 return model_to_dict(self, fields=[field.name for field in
62 self._meta.fields])
63
64 @property
65 def diff(self):
66 d1 = self._initial
67 d2 = self._dict
68 diffs = [(k, (v, d2[k])) for k, v in d1.items() if v != d2[k]]
69 return dict(diffs)
70
71 @property
72 def has_changed(self):
73 return bool(self.diff)
74
75 @property
76 def changed_fields(self):
77 return self.diff.keys()
78
Scott Baker1a6a3902014-10-03 00:32:37 -070079 def has_field_changed(self, field_name):
80 return field_name in self.diff.keys()
81
82 def get_field_diff(self, field_name):
83 return self.diff.get(field_name, None)
84
Scott Baker82db43c2014-11-06 17:33:27 -080085class PlCoreBase(models.Model): # , DiffModelMixIn):
Sapan Bhatia4eb663a2014-04-29 14:26:10 -040086 objects = PlCoreBaseManager()
Sapan Bhatia15bf5ac2014-07-21 20:06:59 -040087 deleted_objects = PlCoreBaseDeletionManager()
88
Scott Baker82db43c2014-11-06 17:33:27 -080089 # ---- copy stuff from DiffModelMixin ----
90
91 # XXX Django fails miserably when trying to create initial migrations when
92 # DiffModelMixin is used. So, until we figure out what's wrong,
93 # just copied the guts of DiffModelMixIn here.
94
95 @property
96 def _dict(self):
97 return model_to_dict(self, fields=[field.name for field in
98 self._meta.fields])
99
100 @property
101 def diff(self):
102 d1 = self._initial
103 d2 = self._dict
104 diffs = [(k, (v, d2[k])) for k, v in d1.items() if v != d2[k]]
105 return dict(diffs)
106
107 @property
108 def has_changed(self):
109 return bool(self.diff)
110
111 @property
112 def changed_fields(self):
113 return self.diff.keys()
114
115 def has_field_changed(self, field_name):
116 return field_name in self.diff.keys()
117
118 def get_field_diff(self, field_name):
119 return self.diff.get(field_name, None)
120 # ---- end copy stuff from DiffModelMixin ----
121
Sapan Bhatia15bf5ac2014-07-21 20:06:59 -0400122 # default values for created and updated are only there to keep evolution
123 # from failing.
Scott Baker02b59522014-09-17 22:18:46 -0700124 created = models.DateTimeField(auto_now_add=True, default=timezone.now)
125 updated = models.DateTimeField(auto_now=True, default=timezone.now)
Sapan Bhatia9c2c8fa2013-10-16 13:26:05 -0400126 enacted = models.DateTimeField(null=True, default=None)
Sapan Bhatia34aee752014-04-28 21:06:39 -0400127 backend_status = models.CharField(max_length=140,
Sapan Bhatiad507f432014-04-29 00:41:39 -0400128 default="Provisioning in progress")
Sapan Bhatiabcc18992014-04-29 10:32:14 -0400129 deleted = models.BooleanField(default=False)
Siobhan Tully4bc09f22013-04-10 21:15:21 -0400130
Sapan Bhatia9c2c8fa2013-10-16 13:26:05 -0400131 class Meta:
Sapan Bhatia3089d832014-04-29 14:36:51 -0400132 # Changing abstract to False would require the managers of subclasses of
133 # PlCoreBase to be customized individually.
Sapan Bhatia9c2c8fa2013-10-16 13:26:05 -0400134 abstract = True
135 app_label = "core"
Siobhan Tully4bc09f22013-04-10 21:15:21 -0400136
Sapan Bhatia9c2c8fa2013-10-16 13:26:05 -0400137 def __init__(self, *args, **kwargs):
138 super(PlCoreBase, self).__init__(*args, **kwargs)
Scott Baker1a6a3902014-10-03 00:32:37 -0700139 self._initial = self._dict # for DiffModelMixIn
Scott Bakerf3f895c2014-09-23 22:41:17 -0700140 self.silent = False
Scott Baker13acdd62013-05-08 17:42:56 -0700141
Tony Mack5b061472014-02-04 07:57:10 -0500142 def can_update(self, user):
143 if user.is_readonly:
144 return False
145 if user.is_admin:
146 return True
Tony Mack5b061472014-02-04 07:57:10 -0500147
Scott Baker1bffe942014-10-06 22:58:48 -0700148 return False
Scott Baker1a6a3902014-10-03 00:32:37 -0700149
Sapan Bhatia9c2c8fa2013-10-16 13:26:05 -0400150 def delete(self, *args, **kwds):
Scott Baker6ecd4262014-01-21 23:15:21 -0800151 # so we have something to give the observer
Sapan Bhatia77d1d892014-07-21 20:07:23 -0400152 purge = kwds.get('purge',False)
Scott Baker3d2d3e42014-10-09 16:22:00 -0700153 if purge:
154 del kwds['purge']
Scott Baker6594bea2014-09-23 16:04:36 -0700155 silent = kwds.get('silent',False)
Scott Baker3d2d3e42014-10-09 16:22:00 -0700156 if silent:
157 del kwds['silent']
Sapan Bhatia77d1d892014-07-21 20:07:23 -0400158 try:
159 purge = purge or observer_disabled
160 except NameError:
161 pass
Scott Baker6594bea2014-09-23 16:04:36 -0700162
Sapan Bhatia77d1d892014-07-21 20:07:23 -0400163 if (purge):
164 super(PlCoreBase, self).delete(*args, **kwds)
Sapan Bhatiac8602432014-04-29 20:33:51 -0400165 else:
166 self.deleted = True
167 self.enacted=None
Scott Baker6594bea2014-09-23 16:04:36 -0700168 self.save(update_fields=['enacted','deleted'], silent=silent)
Sapan Bhatiadbaf1932013-09-03 11:28:52 -0400169
Sapan Bhatia9c2c8fa2013-10-16 13:26:05 -0400170 def save(self, *args, **kwargs):
Scott Bakerf3f895c2014-09-23 22:41:17 -0700171 # let the user specify silence as either a kwarg or an instance varible
172 silent = self.silent
Scott Baker6594bea2014-09-23 16:04:36 -0700173 if "silent" in kwargs:
Scott Bakerf3f895c2014-09-23 22:41:17 -0700174 silent=silent or kwargs.pop("silent")
Scott Baker6594bea2014-09-23 16:04:36 -0700175
Sapan Bhatia9c2c8fa2013-10-16 13:26:05 -0400176 super(PlCoreBase, self).save(*args, **kwargs)
Sapan Bhatiac8602432014-04-29 20:33:51 -0400177
Sapan Bhatia9c2c8fa2013-10-16 13:26:05 -0400178 # This is a no-op if observer_disabled is set
Scott Baker6594bea2014-09-23 16:04:36 -0700179 if not silent:
180 notify_observer()
Sapan Bhatia66f4e612013-07-02 12:12:38 -0400181
Scott Baker5e5f4552014-10-03 14:48:06 -0700182 self._initial = self._dict
Scott Baker13acdd62013-05-08 17:42:56 -0700183
Tony Mack5b061472014-02-04 07:57:10 -0500184 def save_by_user(self, user, *args, **kwds):
Scott Bakere5f41b02014-10-02 22:50:18 -0700185 if not self.can_update(user):
Scott Baker1bffe942014-10-06 22:58:48 -0700186 if getattr(self, "_cant_update_fieldName", None) is not None:
187 raise PermissionDenied("You do not have permission to update field %s on object %s" % (self._cant_update_fieldName, self.__class__.__name__))
188 else:
189 raise PermissionDenied("You do not have permission to update %s objects" % self.__class__.__name__)
Scott Baker1a6a3902014-10-03 00:32:37 -0700190
Scott Bakere5f41b02014-10-02 22:50:18 -0700191 self.save(*args, **kwds)
Tony Mack5b061472014-02-04 07:57:10 -0500192
Tony Mack332ee1d2014-02-04 15:33:45 -0500193 def delete_by_user(self, user, *args, **kwds):
Scott Bakere5f41b02014-10-02 22:50:18 -0700194 if not self.can_update(user):
195 raise PermissionDenied("You do not have permission to delete %s objects" % self.__class__.__name__)
196 self.delete(*args, **kwds)
Tony Mack332ee1d2014-02-04 15:33:45 -0500197
Scott Baker5e5f4552014-10-03 14:48:06 -0700198 @classmethod
199 def select_by_user(cls, user):
200 # This should be overridden by descendant classes that want to perform
201 # filtering of visible objects by user.
202 return cls.objects.all()
203
Scott Baker13acdd62013-05-08 17:42:56 -0700204
Siobhan Tully4bc09f22013-04-10 21:15:21 -0400205
206