planetstack/core/models/plcorebase.py

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