planetstack/core/models/plcorebase.py

   1 import os
   2 import sys
   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 from django.utils import timezone
   8 from django.core.exceptions import PermissionDenied
   9 import model_policy
  10
  11 try:
  12     # This is a no-op if observer_disabled is set to 1 in the config file
  13     from observer import *
  14 except:
  15     print >> sys.stderr, "import of observer failed! printing traceback and disabling observer:"
  16     import traceback
  17     traceback.print_exc()
  18
  19     # guard against something failing
  20     def notify_observer(*args, **kwargs):
  21         pass
  22
  23 # This manager will be inherited by all subclasses because
  24 # the core model is abstract.
  25 class PlCoreBaseDeletionManager(models.Manager):
  26     def get_queryset(self):
  27         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)
  32
  33     # deprecated in django 1.7 in favor of get_queryset().
  34     def get_query_set(self):
  35         return self.get_queryset()
  36
  37 # This manager will be inherited by all subclasses because
  38 # the core model is abstract.
  39 class PlCoreBaseManager(models.Manager):
  40     def get_queryset(self):
  41         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)
  46
  47     # deprecated in django 1.7 in favor of get_queryset().
  48     def get_query_set(self):
  49         return self.get_queryset()
  50
  51 class PlCoreBase(models.Model):
  52     objects = PlCoreBaseManager()
  53     deleted_objects = PlCoreBaseDeletionManager()
  54
  55     # default values for created and updated are only there to keep evolution
  56     # from failing.
  57     created = models.DateTimeField(auto_now_add=True, default=timezone.now)
  58     updated = models.DateTimeField(auto_now=True, default=timezone.now)
  59     enacted = models.DateTimeField(null=True, default=None)
  60     backend_status = models.CharField(max_length=140,
  61                                       default="Provisioning in progress")
  62     deleted = models.BooleanField(default=False)
  63
  64     class Meta:
  65         # Changing abstract to False would require the managers of subclasses of
  66         # PlCoreBase to be customized individually.
  67         abstract = True
  68         app_label = "core"
  69
  70     def __init__(self, *args, **kwargs):
  71         super(PlCoreBase, self).__init__(*args, **kwargs)
  72         self.__initial = self._dict
  73         self.silent = False
  74
  75     @property
  76     def diff(self):
  77         d1 = self.__initial
  78         d2 = self._dict
  79         diffs = [(k, (v, d2[k])) for k, v in d1.items() if v != d2[k]]
  80         return dict(diffs)
  81
  82     @property
  83     def has_changed(self):
  84         return bool(self.diff)
  85
  86     @property
  87     def changed_fields(self):
  88         return self.diff.keys()
  89
  90     def get_field_diff(self, field_name):
  91         return self.diff.get(field_name, None)
  92
  93     def can_update(self, user):
  94         if user.is_readonly:
  95             return False
  96         if user.is_admin:
  97             return True
  98         return False
  99
 100     def delete(self, *args, **kwds):
 101         # so we have something to give the observer
 102         purge = kwds.get('purge',False)
 103         silent = kwds.get('silent',False)
 104         try:
 105             purge = purge or observer_disabled
 106         except NameError:
 107             pass
 108
 109         if (purge):
 110             del kwds['purge']
 111             super(PlCoreBase, self).delete(*args, **kwds)
 112         else:
 113             self.deleted = True
 114             self.enacted=None
 115             self.save(update_fields=['enacted','deleted'], silent=silent)
 116
 117     def save(self, *args, **kwargs):
 118         # let the user specify silence as either a kwarg or an instance varible
 119         silent = self.silent
 120         if "silent" in kwargs:
 121             silent=silent or kwargs.pop("silent")
 122
 123         super(PlCoreBase, self).save(*args, **kwargs)
 124
 125         # This is a no-op if observer_disabled is set
 126         if not silent:
 127             notify_observer()
 128
 129         self.__initial = self._dict
 130
 131     def save_by_user(self, user, *args, **kwds):
 132         if not self.can_update(user):
 133             raise PermissionDenied("You do not have permission to update %s objects" % self.__class__.__name__)
 134         self.save(*args, **kwds)
 135
 136     def delete_by_user(self, user, *args, **kwds):
 137         if not self.can_update(user):
 138             raise PermissionDenied("You do not have permission to delete %s objects" % self.__class__.__name__)
 139         self.delete(*args, **kwds)
 140
 141     @property
 142     def _dict(self):
 143         return model_to_dict(self, fields=[field.name for field in
 144                              self._meta.fields])
 145
 146
 147