Scott Baker | fd44dfc | 2014-05-23 13:20:53 -0700 | [diff] [blame] | 1 | import datetime |
Siobhan Tully | 4bc09f2 | 2013-04-10 21:15:21 -0400 | [diff] [blame] | 2 | import os |
Scott Baker | 65d5a9a | 2014-05-26 15:58:09 -0700 | [diff] [blame] | 3 | import sys |
Siobhan Tully | 4bc09f2 | 2013-04-10 21:15:21 -0400 | [diff] [blame] | 4 | from django.db import models |
Scott Baker | 13acdd6 | 2013-05-08 17:42:56 -0700 | [diff] [blame] | 5 | from django.forms.models import model_to_dict |
Scott Baker | c1c45f8 | 2014-01-21 16:23:51 -0800 | [diff] [blame] | 6 | from django.core.urlresolvers import reverse |
Scott Baker | 6ecd426 | 2014-01-21 23:15:21 -0800 | [diff] [blame] | 7 | from django.forms.models import model_to_dict |
Scott Baker | 9e99074 | 2014-03-19 22:14:58 -0700 | [diff] [blame] | 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: |
Scott Baker | 65d5a9a | 2014-05-26 15:58:09 -0700 | [diff] [blame] | 13 | print >> sys.stderr, "import of observer failed! printing traceback and disabling observer:" |
Scott Baker | 9e99074 | 2014-03-19 22:14:58 -0700 | [diff] [blame] | 14 | import traceback |
| 15 | traceback.print_exc() |
| 16 | |
| 17 | # guard against something failing |
Scott Baker | fd44dfc | 2014-05-23 13:20:53 -0700 | [diff] [blame] | 18 | def notify_observer(*args, **kwargs): |
Scott Baker | 9e99074 | 2014-03-19 22:14:58 -0700 | [diff] [blame] | 19 | pass |
Siobhan Tully | 4bc09f2 | 2013-04-10 21:15:21 -0400 | [diff] [blame] | 20 | |
Sapan Bhatia | 3089d83 | 2014-04-29 14:36:51 -0400 | [diff] [blame] | 21 | # This manager will be inherited by all subclasses because |
| 22 | # the core model is abstract. |
Sapan Bhatia | 15bf5ac | 2014-07-21 20:06:59 -0400 | [diff] [blame] | 23 | class PlCoreBaseDeletionManager(models.Manager): |
| 24 | def get_query_set(self): |
| 25 | return super(PlCoreBaseDeletedManager, self).get_query_set().filter(deleted=True) |
| 26 | |
| 27 | # This manager will be inherited by all subclasses because |
| 28 | # the core model is abstract. |
Sapan Bhatia | 4eb663a | 2014-04-29 14:26:10 -0400 | [diff] [blame] | 29 | class PlCoreBaseManager(models.Manager): |
| 30 | def get_query_set(self): |
| 31 | return super(PlCoreBaseManager, self).get_query_set().filter(deleted=False) |
Siobhan Tully | 4bc09f2 | 2013-04-10 21:15:21 -0400 | [diff] [blame] | 32 | |
Sapan Bhatia | 4eb663a | 2014-04-29 14:26:10 -0400 | [diff] [blame] | 33 | class PlCoreBase(models.Model): |
| 34 | objects = PlCoreBaseManager() |
Sapan Bhatia | 15bf5ac | 2014-07-21 20:06:59 -0400 | [diff] [blame] | 35 | deleted_objects = PlCoreBaseDeletionManager() |
| 36 | |
| 37 | # default values for created and updated are only there to keep evolution |
| 38 | # from failing. |
Scott Baker | fd44dfc | 2014-05-23 13:20:53 -0700 | [diff] [blame] | 39 | created = models.DateTimeField(auto_now_add=True, default=datetime.datetime.now()) |
| 40 | updated = models.DateTimeField(auto_now=True, default=datetime.datetime.now()) |
Sapan Bhatia | 9c2c8fa | 2013-10-16 13:26:05 -0400 | [diff] [blame] | 41 | enacted = models.DateTimeField(null=True, default=None) |
Sapan Bhatia | 34aee75 | 2014-04-28 21:06:39 -0400 | [diff] [blame] | 42 | backend_status = models.CharField(max_length=140, |
Sapan Bhatia | d507f43 | 2014-04-29 00:41:39 -0400 | [diff] [blame] | 43 | default="Provisioning in progress") |
Sapan Bhatia | bcc1899 | 2014-04-29 10:32:14 -0400 | [diff] [blame] | 44 | deleted = models.BooleanField(default=False) |
Siobhan Tully | 4bc09f2 | 2013-04-10 21:15:21 -0400 | [diff] [blame] | 45 | |
Sapan Bhatia | 9c2c8fa | 2013-10-16 13:26:05 -0400 | [diff] [blame] | 46 | class Meta: |
Sapan Bhatia | 3089d83 | 2014-04-29 14:36:51 -0400 | [diff] [blame] | 47 | # Changing abstract to False would require the managers of subclasses of |
| 48 | # PlCoreBase to be customized individually. |
Sapan Bhatia | 9c2c8fa | 2013-10-16 13:26:05 -0400 | [diff] [blame] | 49 | abstract = True |
| 50 | app_label = "core" |
Siobhan Tully | 4bc09f2 | 2013-04-10 21:15:21 -0400 | [diff] [blame] | 51 | |
Sapan Bhatia | 9c2c8fa | 2013-10-16 13:26:05 -0400 | [diff] [blame] | 52 | def __init__(self, *args, **kwargs): |
| 53 | super(PlCoreBase, self).__init__(*args, **kwargs) |
| 54 | self.__initial = self._dict |
Scott Baker | 13acdd6 | 2013-05-08 17:42:56 -0700 | [diff] [blame] | 55 | |
Sapan Bhatia | 9c2c8fa | 2013-10-16 13:26:05 -0400 | [diff] [blame] | 56 | @property |
| 57 | def diff(self): |
| 58 | d1 = self.__initial |
| 59 | d2 = self._dict |
| 60 | diffs = [(k, (v, d2[k])) for k, v in d1.items() if v != d2[k]] |
| 61 | return dict(diffs) |
Siobhan Tully | 7329134 | 2013-05-10 10:50:08 -0400 | [diff] [blame] | 62 | |
Sapan Bhatia | 9c2c8fa | 2013-10-16 13:26:05 -0400 | [diff] [blame] | 63 | @property |
| 64 | def has_changed(self): |
| 65 | return bool(self.diff) |
Siobhan Tully | 7329134 | 2013-05-10 10:50:08 -0400 | [diff] [blame] | 66 | |
Sapan Bhatia | 9c2c8fa | 2013-10-16 13:26:05 -0400 | [diff] [blame] | 67 | @property |
| 68 | def changed_fields(self): |
| 69 | return self.diff.keys() |
Siobhan Tully | 7329134 | 2013-05-10 10:50:08 -0400 | [diff] [blame] | 70 | |
Sapan Bhatia | 9c2c8fa | 2013-10-16 13:26:05 -0400 | [diff] [blame] | 71 | def get_field_diff(self, field_name): |
| 72 | return self.diff.get(field_name, None) |
Siobhan Tully | 7329134 | 2013-05-10 10:50:08 -0400 | [diff] [blame] | 73 | |
Tony Mack | 5b06147 | 2014-02-04 07:57:10 -0500 | [diff] [blame] | 74 | def can_update(self, user): |
| 75 | if user.is_readonly: |
| 76 | return False |
| 77 | if user.is_admin: |
| 78 | return True |
| 79 | return False |
| 80 | |
Sapan Bhatia | 9c2c8fa | 2013-10-16 13:26:05 -0400 | [diff] [blame] | 81 | def delete(self, *args, **kwds): |
Scott Baker | 6ecd426 | 2014-01-21 23:15:21 -0800 | [diff] [blame] | 82 | # so we have something to give the observer |
Sapan Bhatia | 77d1d89 | 2014-07-21 20:07:23 -0400 | [diff] [blame] | 83 | purge = kwds.get('purge',False) |
| 84 | try: |
| 85 | purge = purge or observer_disabled |
| 86 | except NameError: |
| 87 | pass |
| 88 | |
| 89 | if (purge): |
| 90 | super(PlCoreBase, self).delete(*args, **kwds) |
Sapan Bhatia | c860243 | 2014-04-29 20:33:51 -0400 | [diff] [blame] | 91 | else: |
| 92 | self.deleted = True |
| 93 | self.enacted=None |
| 94 | self.save(update_fields=['enacted','deleted']) |
Scott Baker | 6ecd426 | 2014-01-21 23:15:21 -0800 | [diff] [blame] | 95 | |
Sapan Bhatia | dbaf193 | 2013-09-03 11:28:52 -0400 | [diff] [blame] | 96 | |
Sapan Bhatia | 9c2c8fa | 2013-10-16 13:26:05 -0400 | [diff] [blame] | 97 | def save(self, *args, **kwargs): |
| 98 | super(PlCoreBase, self).save(*args, **kwargs) |
Sapan Bhatia | c860243 | 2014-04-29 20:33:51 -0400 | [diff] [blame] | 99 | |
Sapan Bhatia | 9c2c8fa | 2013-10-16 13:26:05 -0400 | [diff] [blame] | 100 | # This is a no-op if observer_disabled is set |
| 101 | notify_observer() |
Sapan Bhatia | 66f4e61 | 2013-07-02 12:12:38 -0400 | [diff] [blame] | 102 | |
Sapan Bhatia | 9c2c8fa | 2013-10-16 13:26:05 -0400 | [diff] [blame] | 103 | self.__initial = self._dict |
Scott Baker | 13acdd6 | 2013-05-08 17:42:56 -0700 | [diff] [blame] | 104 | |
Tony Mack | 5b06147 | 2014-02-04 07:57:10 -0500 | [diff] [blame] | 105 | def save_by_user(self, user, *args, **kwds): |
| 106 | if self.can_update(user): |
| 107 | self.save(*args, **kwds) |
| 108 | |
Tony Mack | 332ee1d | 2014-02-04 15:33:45 -0500 | [diff] [blame] | 109 | def delete_by_user(self, user, *args, **kwds): |
| 110 | if self.can_update(user): |
| 111 | self.delete(*args, **kwds) |
| 112 | |
Sapan Bhatia | 9c2c8fa | 2013-10-16 13:26:05 -0400 | [diff] [blame] | 113 | @property |
| 114 | def _dict(self): |
| 115 | return model_to_dict(self, fields=[field.name for field in |
| 116 | self._meta.fields]) |
Scott Baker | 13acdd6 | 2013-05-08 17:42:56 -0700 | [diff] [blame] | 117 | |
Siobhan Tully | 4bc09f2 | 2013-04-10 21:15:21 -0400 | [diff] [blame] | 118 | |
| 119 | |