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 from model_autodeletion import ephemeral_models
  11
  12 try:
  13     # This is a no-op if observer_disabled is set to 1 in the config file
  14     from observer import *
  15 except:
  16     print >> sys.stderr, "import of observer failed! printing traceback and disabling observer:"
  17     import traceback
  18     traceback.print_exc()
  19
  20     # guard against something failing
  21     def notify_observer(*args, **kwargs):
  22         pass
  23
  24 # This manager will be inherited by all subclasses because
  25 # the core model is abstract.
  26 class PlCoreBaseDeletionManager(models.Manager):
  27     def get_queryset(self):
  28         parent=super(PlCoreBaseDeletionManager, self)
  29         if hasattr(parent, "get_queryset"):
  30             return parent.get_queryset().filter(deleted=True)
  31         else:
  32             return parent.get_query_set().filter(deleted=True)
  33
  34     # deprecated in django 1.7 in favor of get_queryset().
  35     def get_query_set(self):
  36         return self.get_queryset()
  37
  38 # This manager will be inherited by all subclasses because
  39 # the core model is abstract.
  40 class PlCoreBaseManager(models.Manager):
  41     def get_queryset(self):
  42         parent=super(PlCoreBaseManager, self)
  43         if hasattr(parent, "get_queryset"):
  44             return parent.get_queryset().filter(deleted=False)
  45         else:
  46             return parent.get_query_set().filter(deleted=False)
  47
  48     # deprecated in django 1.7 in favor of get_queryset().
  49     def get_query_set(self):
  50         return self.get_queryset()
  51
  52 class DiffModelMixIn:
  53     # Provides useful methods for computing which objects in a model have
  54     # changed. Make sure to do self._initial = self._dict in the __init__
  55     # method.
  56
  57     # This is broken out of PlCoreBase into a Mixin so the User model can
  58     # also make use of it.
  59
  60     @property
  61     def _dict(self):
  62         return model_to_dict(self, fields=[field.name for field in
  63                              self._meta.fields])
  64
  65     @property
  66     def diff(self):
  67         d1 = self._initial
  68         d2 = self._dict
  69         diffs = [(k, (v, d2[k])) for k, v in d1.items() if v != d2[k]]
  70         return dict(diffs)
  71
  72     @property
  73     def has_changed(self):
  74         return bool(self.diff)
  75
  76     @property
  77     def changed_fields(self):
  78         return self.diff.keys()
  79
  80     def has_field_changed(self, field_name):
  81         return field_name in self.diff.keys()
  82
  83     def get_field_diff(self, field_name):
  84         return self.diff.get(field_name, None)
  85
  86     #classmethod
  87     def getValidators(cls):
  88         """ primarily for REST API, return a dictionary of field names mapped
  89             to lists of the type of validations that need to be applied to
  90             those fields.
  91         """
  92         validators = {}
  93         for field in cls._meta.fields:
  94             l = []
  95             if field.blank==False:
  96                 l.append("notBlank")
  97             validators[field.name] = l
  98         return validators
  99
 100 class PlCoreBase(models.Model): # , DiffModelMixIn):
 101     objects = PlCoreBaseManager()
 102     deleted_objects = PlCoreBaseDeletionManager()
 103
 104     # ---- copy stuff from DiffModelMixin ----
 105
 106     # XXX Django fails miserably when trying to create initial migrations when
 107     #    DiffModelMixin is used. So, until we figure out what's wrong,
 108     #    just copied the guts of DiffModelMixIn here.
 109
 110     @property
 111     def _dict(self):
 112         return model_to_dict(self, fields=[field.name for field in
 113                              self._meta.fields])
 114
 115     @property
 116     def diff(self):
 117         d1 = self._initial
 118         d2 = self._dict
 119         diffs = [(k, (v, d2[k])) for k, v in d1.items() if v != d2[k]]
 120         return dict(diffs)
 121
 122     @property
 123     def has_changed(self):
 124         return bool(self.diff)
 125
 126     @property
 127     def changed_fields(self):
 128         return self.diff.keys()
 129
 130     def has_field_changed(self, field_name):
 131         return field_name in self.diff.keys()
 132
 133     def get_field_diff(self, field_name):
 134         return self.diff.get(field_name, None)
 135
 136     #classmethod
 137     def getValidators(cls):
 138         """ primarily for REST API, return a dictionary of field names mapped
 139             to lists of the type of validations that need to be applied to
 140             those fields.
 141         """
 142         validators = {}
 143         for field in cls._meta.fields:
 144             l = []
 145             if field.blank==False:
 146                 l.append("notBlank")
 147             validators[field.name] = l
 148         return validators
 149
 150     # ---- end copy stuff from DiffModelMixin ----
 151
 152     # default values for created and updated are only there to keep evolution
 153     # from failing.
 154     created = models.DateTimeField(auto_now_add=True, default=timezone.now)
 155     updated = models.DateTimeField(auto_now=True, default=timezone.now)
 156     enacted = models.DateTimeField(null=True, default=None)
 157     backend_status = models.CharField(max_length=140,
 158                                       default="Provisioning in progress")
 159     deleted = models.BooleanField(default=False)
 160
 161     class Meta:
 162         # Changing abstract to False would require the managers of subclasses of
 163         # PlCoreBase to be customized individually.
 164         abstract = True
 165         app_label = "core"
 166
 167     def __init__(self, *args, **kwargs):
 168         super(PlCoreBase, self).__init__(*args, **kwargs)
 169         self._initial = self._dict # for DiffModelMixIn
 170         self.silent = False
 171
 172     def can_update(self, user):
 173         if user.is_readonly:
 174             return False
 175         if user.is_admin:
 176             return True
 177
 178         return False
 179
 180     def delete(self, *args, **kwds):
 181         # so we have something to give the observer
 182         purge = kwds.get('purge',False)
 183         if purge:
 184             del kwds['purge']
 185         silent = kwds.get('silent',False)
 186         if silent:
 187             del kwds['silent']
 188         try:
 189             purge = purge or observer_disabled
 190         except NameError:
 191             pass
 192
 193         if (purge):
 194             super(PlCoreBase, self).delete(*args, **kwds)
 195         else:
 196             self.deleted = True
 197             self.enacted=None
 198             self.save(update_fields=['enacted','deleted'], silent=silent)
 199
 200     def save(self, *args, **kwargs):
 201         # let the user specify silence as either a kwarg or an instance varible
 202         silent = self.silent
 203         if "silent" in kwargs:
 204             silent=silent or kwargs.pop("silent")
 205
 206         super(PlCoreBase, self).save(*args, **kwargs)
 207
 208         # This is a no-op if observer_disabled is set
 209         if not silent:
 210             notify_observer()
 211
 212         self._initial = self._dict
 213
 214     def save_by_user(self, user, *args, **kwds):
 215         if not self.can_update(user):
 216             if getattr(self, "_cant_update_fieldName", None) is not None:
 217                 raise PermissionDenied("You do not have permission to update field %s on object %s" % (self._cant_update_fieldName, self.__class__.__name__))
 218             else:
 219                 raise PermissionDenied("You do not have permission to update %s objects" % self.__class__.__name__)
 220
 221         self.save(*args, **kwds)
 222
 223     def delete_by_user(self, user, *args, **kwds):
 224         if not self.can_update(user):
 225             raise PermissionDenied("You do not have permission to delete %s objects" % self.__class__.__name__)
 226         self.delete(*args, **kwds)
 227
 228     @classmethod
 229     def select_by_user(cls, user):
 230         # This should be overridden by descendant classes that want to perform
 231         # filtering of visible objects by user.
 232         return cls.objects.all()
 233
 234     @classmethod
 235     def is_ephemeral(cls):
 236         return cls in ephemeral_models
 237
 238
 239
 240
 241
 242