Added a 'deleted' field to all models. Specifically to:
[plstackapi.git] / planetstack / core / models / plcorebase.py
1 import datetime
2 import os
3 import sys
4 from django.db import models
5 from django.forms.models import model_to_dict
6 from django.core.urlresolvers import reverse
7 from django.forms.models import model_to_dict
8
9 try:
10     # This is a no-op if observer_disabled is set to 1 in the config file
11     from observer import *
12 except:
13     print >> sys.stderr, "import of observer failed! printing traceback and disabling observer:"
14     import traceback
15     traceback.print_exc()
16
17     # guard against something failing
18     def notify_observer(*args, **kwargs):
19         pass
20
21 class PlCoreBase(models.Model):
22
23     # default values for created and updated are only there to keep evolution
24     # from failing.
25
26     created = models.DateTimeField(auto_now_add=True, default=datetime.datetime.now())
27     updated = models.DateTimeField(auto_now=True, default=datetime.datetime.now())
28     enacted = models.DateTimeField(null=True, default=None)
29     backend_status = models.CharField(max_length=140,
30                                       default="Provisioning in progress")
31     deleted = models.BooleanField(default=False)
32
33     class Meta:
34         abstract = True
35         app_label = "core"
36
37     def __init__(self, *args, **kwargs):
38         super(PlCoreBase, self).__init__(*args, **kwargs)
39         self.__initial = self._dict
40
41     @property
42     def diff(self):
43         d1 = self.__initial
44         d2 = self._dict
45         diffs = [(k, (v, d2[k])) for k, v in d1.items() if v != d2[k]]
46         return dict(diffs)
47
48     @property
49     def has_changed(self):
50         return bool(self.diff)
51
52     @property
53     def changed_fields(self):
54         return self.diff.keys()
55
56     def get_field_diff(self, field_name):
57         return self.diff.get(field_name, None)
58
59     def can_update(self, user):
60         if user.is_readonly:
61             return False
62         if user.is_admin:
63             return True
64         return False
65
66     def delete(self, *args, **kwds):
67         # so we have something to give the observer
68         pk = self.pk
69         model_dict = model_to_dict(self)
70         for (k,v) in model_dict.items():
71             # things like datetime are not JSON serializable
72             model_dict[k] = str(v)
73
74         super(PlCoreBase, self).delete(*args, **kwds)
75
76         # This is a no-op if observer_disabled is set
77         notify_observer(model=self, delete=True, pk=pk, model_dict=model_dict)
78
79     def save(self, *args, **kwargs):
80         super(PlCoreBase, self).save(*args, **kwargs)
81         
82         # This is a no-op if observer_disabled is set
83         notify_observer()
84
85         self.__initial = self._dict
86
87     def save_by_user(self, user, *args, **kwds):
88         if self.can_update(user):
89             self.save(*args, **kwds)
90
91     def delete_by_user(self, user, *args, **kwds):
92         if self.can_update(user):
93             self.delete(*args, **kwds)
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
101