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
  30     class Meta:
  31         abstract = True
  32         app_label = "core"
  33
  34     def __init__(self, *args, **kwargs):
  35         super(PlCoreBase, self).__init__(*args, **kwargs)
  36         self.__initial = self._dict
  37
  38     @property
  39     def diff(self):
  40         d1 = self.__initial
  41         d2 = self._dict
  42         diffs = [(k, (v, d2[k])) for k, v in d1.items() if v != d2[k]]
  43         return dict(diffs)
  44
  45     @property
  46     def has_changed(self):
  47         return bool(self.diff)
  48
  49     @property
  50     def changed_fields(self):
  51         return self.diff.keys()
  52
  53     def get_field_diff(self, field_name):
  54         return self.diff.get(field_name, None)
  55
  56     def can_update(self, user):
  57         if user.is_readonly:
  58             return False
  59         if user.is_admin:
  60             return True
  61         return False
  62
  63     def delete(self, *args, **kwds):
  64         # so we have something to give the observer
  65         pk = self.pk
  66         model_dict = model_to_dict(self)
  67         for (k,v) in model_dict.items():
  68             # things like datetime are not JSON serializable
  69             model_dict[k] = str(v)
  70
  71         super(PlCoreBase, self).delete(*args, **kwds)
  72
  73         # This is a no-op if observer_disabled is set
  74         notify_observer(model=self, delete=True, pk=pk, model_dict=model_dict)
  75
  76     def save(self, *args, **kwargs):
  77         super(PlCoreBase, self).save(*args, **kwargs)
  78
  79         # This is a no-op if observer_disabled is set
  80         notify_observer()
  81
  82         self.__initial = self._dict
  83
  84     def save_by_user(self, user, *args, **kwds):
  85         if self.can_update(user):
  86             self.save(*args, **kwds)
  87
  88     def delete_by_user(self, user, *args, **kwds):
  89         if self.can_update(user):
  90             self.delete(*args, **kwds)
  91
  92     @property
  93     def _dict(self):
  94         return model_to_dict(self, fields=[field.name for field in
  95                              self._meta.fields])
  96
  97
  98