planetstack/core/models/plcorebase.py

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