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             if field.__class__.__name__=="URLField":
  98                 l.append("url")
  99             validators[field.name] = l
 100         return validators
 101
 102 class PlCoreBase(models.Model): # , DiffModelMixIn):
 103     objects = PlCoreBaseManager()
 104     deleted_objects = PlCoreBaseDeletionManager()
 105
 106     # ---- copy stuff from DiffModelMixin ----
 107
 108     # XXX Django fails miserably when trying to create initial migrations when
 109     #    DiffModelMixin is used. So, until we figure out what's wrong,
 110     #    just copied the guts of DiffModelMixIn here.
 111
 112     @property
 113     def _dict(self):
 114         return model_to_dict(self, fields=[field.name for field in
 115                              self._meta.fields])
 116
 117     @property
 118     def diff(self):
 119         d1 = self._initial
 120         d2 = self._dict
 121         diffs = [(k, (v, d2[k])) for k, v in d1.items() if v != d2[k]]
 122         return dict(diffs)
 123
 124     @property
 125     def has_changed(self):
 126         return bool(self.diff)
 127
 128     @property
 129     def changed_fields(self):
 130         return self.diff.keys()
 131
 132     def has_field_changed(self, field_name):
 133         return field_name in self.diff.keys()
 134
 135     def get_field_diff(self, field_name):
 136         return self.diff.get(field_name, None)
 137
 138     #classmethod
 139     def getValidators(cls):
 140         """ primarily for REST API, return a dictionary of field names mapped
 141             to lists of the type of validations that need to be applied to
 142             those fields.
 143         """
 144         validators = {}
 145         for field in cls._meta.fields:
 146             l = []
 147             if field.blank==False:
 148                 l.append("notBlank")
 149             if field.__class__.__name__=="URLField":
 150                 l.append("url")
 151             validators[field.name] = l
 152         return validators
 153
 154     # ---- end copy stuff from DiffModelMixin ----
 155
 156     # default values for created and updated are only there to keep evolution
 157     # from failing.
 158     created = models.DateTimeField(auto_now_add=True, default=timezone.now)
 159     updated = models.DateTimeField(auto_now=True, default=timezone.now)
 160     enacted = models.DateTimeField(null=True, blank=True, default=None)
 161     policed = models.DateTimeField(null=True, blank=True, default=None)
 162     backend_status = models.CharField(max_length=140,
 163                                       default="0 - Provisioning in progress")
 164     deleted = models.BooleanField(default=False)
 165
 166     class Meta:
 167         # Changing abstract to False would require the managers of subclasses of
 168         # PlCoreBase to be customized individually.
 169         abstract = True
 170         app_label = "core"
 171
 172     def __init__(self, *args, **kwargs):
 173         super(PlCoreBase, self).__init__(*args, **kwargs)
 174         self._initial = self._dict # for DiffModelMixIn
 175         self.silent = False
 176
 177     def can_update(self, user):
 178         if user.is_readonly:
 179             return False
 180         if user.is_admin:
 181             return True
 182
 183         return False
 184
 185     def delete(self, *args, **kwds):
 186         # so we have something to give the observer
 187         purge = kwds.get('purge',False)
 188         if purge:
 189             del kwds['purge']
 190         silent = kwds.get('silent',False)
 191         if silent:
 192             del kwds['silent']
 193         try:
 194             purge = purge or observer_disabled
 195         except NameError:
 196             pass
 197
 198         if (purge):
 199             super(PlCoreBase, self).delete(*args, **kwds)
 200         else:
 201             self.deleted = True
 202             self.enacted=None
 203             self.save(update_fields=['enacted','deleted'], silent=silent)
 204
 205     def save(self, *args, **kwargs):
 206         # let the user specify silence as either a kwarg or an instance varible
 207         silent = self.silent
 208         if "silent" in kwargs:
 209             silent=silent or kwargs.pop("silent")
 210
 211         super(PlCoreBase, self).save(*args, **kwargs)
 212
 213         # This is a no-op if observer_disabled is set
 214         if not silent:
 215             notify_observer()
 216
 217         self._initial = self._dict
 218
 219     def save_by_user(self, user, *args, **kwds):
 220         if not self.can_update(user):
 221             if getattr(self, "_cant_update_fieldName", None) is not None:
 222                 raise PermissionDenied("You do not have permission to update field %s on object %s" % (self._cant_update_fieldName, self.__class__.__name__))
 223             else:
 224                 raise PermissionDenied("You do not have permission to update %s objects" % self.__class__.__name__)
 225
 226         self.save(*args, **kwds)
 227
 228     def delete_by_user(self, user, *args, **kwds):
 229         if not self.can_update(user):
 230             raise PermissionDenied("You do not have permission to delete %s objects" % self.__class__.__name__)
 231         self.delete(*args, **kwds)
 232
 233     @classmethod
 234     def select_by_user(cls, user):
 235         # This should be overridden by descendant classes that want to perform
 236         # filtering of visible objects by user.
 237         return cls.objects.all()
 238
 239     @classmethod
 240     def is_ephemeral(cls):
 241         return cls in ephemeral_models
 242
 243
 244
 245
 246
 247