Siobhan Tully | 5343728 | 2013-04-26 19:30:27 -0400 | [diff] [blame] | 1 | import os |
| 2 | import datetime |
Tony Mack | c14de8f | 2013-05-09 21:44:17 -0400 | [diff] [blame] | 3 | from collections import defaultdict |
Siobhan Tully | 5343728 | 2013-04-26 19:30:27 -0400 | [diff] [blame] | 4 | from django.db import models |
Tony Mack | 5b06147 | 2014-02-04 07:57:10 -0500 | [diff] [blame] | 5 | from django.db.models import F, Q |
Scott Baker | cbfb600 | 2014-10-03 00:32:37 -0700 | [diff] [blame] | 6 | from core.models import PlCoreBase,Site, DashboardView, DiffModelMixIn |
Sapan Bhatia | f7b29d2 | 2014-06-11 17:10:11 -0400 | [diff] [blame] | 7 | from core.models.site import Deployment |
Siobhan Tully | 30fd429 | 2013-05-10 08:59:56 -0400 | [diff] [blame] | 8 | from django.contrib.auth.models import AbstractBaseUser, BaseUserManager |
Scott Baker | 9266e6b | 2013-05-19 15:54:48 -0700 | [diff] [blame] | 9 | from timezones.fields import TimeZoneField |
Scott Baker | 2c3cb64 | 2014-05-19 17:55:56 -0700 | [diff] [blame] | 10 | from operator import itemgetter, attrgetter |
Scott Baker | a36d77e | 2014-08-29 11:43:23 -0700 | [diff] [blame] | 11 | from django.core.mail import EmailMultiAlternatives |
| 12 | from core.middleware import get_request |
Sapan Bhatia | bad6774 | 2014-09-04 00:39:19 -0400 | [diff] [blame] | 13 | import model_policy |
Scott Baker | cbfb600 | 2014-10-03 00:32:37 -0700 | [diff] [blame] | 14 | from django.core.exceptions import PermissionDenied |
Siobhan Tully | 5343728 | 2013-04-26 19:30:27 -0400 | [diff] [blame] | 15 | |
Scott Baker | fd8c7c4 | 2014-10-09 16:16:02 -0700 | [diff] [blame] | 16 | # ------ from plcorebase.py ------ |
| 17 | try: |
| 18 | # This is a no-op if observer_disabled is set to 1 in the config file |
| 19 | from observer import * |
| 20 | except: |
| 21 | print >> sys.stderr, "import of observer failed! printing traceback and disabling observer:" |
| 22 | import traceback |
| 23 | traceback.print_exc() |
| 24 | |
| 25 | # guard against something failing |
| 26 | def notify_observer(*args, **kwargs): |
| 27 | pass |
| 28 | # ------ ------ |
| 29 | |
Siobhan Tully | 5343728 | 2013-04-26 19:30:27 -0400 | [diff] [blame] | 30 | # Create your models here. |
Siobhan Tully | 30fd429 | 2013-05-10 08:59:56 -0400 | [diff] [blame] | 31 | class UserManager(BaseUserManager): |
Siobhan Tully | 5343728 | 2013-04-26 19:30:27 -0400 | [diff] [blame] | 32 | def create_user(self, email, firstname, lastname, password=None): |
| 33 | """ |
| 34 | Creates and saves a User with the given email, date of |
| 35 | birth and password. |
| 36 | """ |
| 37 | if not email: |
| 38 | raise ValueError('Users must have an email address') |
| 39 | |
| 40 | user = self.model( |
Siobhan Tully | 30fd429 | 2013-05-10 08:59:56 -0400 | [diff] [blame] | 41 | email=UserManager.normalize_email(email), |
Siobhan Tully | 5343728 | 2013-04-26 19:30:27 -0400 | [diff] [blame] | 42 | firstname=firstname, |
Siobhan Tully | 30fd429 | 2013-05-10 08:59:56 -0400 | [diff] [blame] | 43 | lastname=lastname, |
| 44 | password=password |
Siobhan Tully | 5343728 | 2013-04-26 19:30:27 -0400 | [diff] [blame] | 45 | ) |
Siobhan Tully | 30fd429 | 2013-05-10 08:59:56 -0400 | [diff] [blame] | 46 | #user.set_password(password) |
Siobhan Tully | 5343728 | 2013-04-26 19:30:27 -0400 | [diff] [blame] | 47 | user.is_admin = True |
| 48 | user.save(using=self._db) |
| 49 | return user |
| 50 | |
| 51 | def create_superuser(self, email, firstname, lastname, password): |
| 52 | """ |
| 53 | Creates and saves a superuser with the given email, date of |
| 54 | birth and password. |
| 55 | """ |
| 56 | user = self.create_user(email, |
| 57 | password=password, |
| 58 | firstname=firstname, |
| 59 | lastname=lastname |
| 60 | ) |
| 61 | user.is_admin = True |
| 62 | user.save(using=self._db) |
| 63 | return user |
| 64 | |
Scott Baker | 6c68484 | 2014-10-17 18:45:00 -0700 | [diff] [blame] | 65 | def get_queryset(self): |
| 66 | parent=super(UserManager, self) |
| 67 | if hasattr(parent, "get_queryset"): |
| 68 | return parent.get_queryset().filter(deleted=False) |
| 69 | else: |
| 70 | return parent.get_query_set().filter(deleted=False) |
| 71 | |
| 72 | # deprecated in django 1.7 in favor of get_queryset(). |
| 73 | def get_query_set(self): |
| 74 | return self.get_queryset() |
| 75 | |
Sapan Bhatia | 5d605ff | 2014-07-21 20:08:04 -0400 | [diff] [blame] | 76 | class DeletedUserManager(UserManager): |
Scott Baker | b08d656 | 2014-09-12 12:57:27 -0700 | [diff] [blame] | 77 | def get_queryset(self): |
Sapan Bhatia | 5d605ff | 2014-07-21 20:08:04 -0400 | [diff] [blame] | 78 | return super(UserManager, self).get_query_set().filter(deleted=True) |
Siobhan Tully | 5343728 | 2013-04-26 19:30:27 -0400 | [diff] [blame] | 79 | |
Scott Baker | b08d656 | 2014-09-12 12:57:27 -0700 | [diff] [blame] | 80 | # deprecated in django 1.7 in favor of get_queryset() |
| 81 | def get_query_set(self): |
| 82 | return self.get_queryset() |
| 83 | |
Scott Baker | cbfb600 | 2014-10-03 00:32:37 -0700 | [diff] [blame] | 84 | class User(AbstractBaseUser, DiffModelMixIn): |
Siobhan Tully | 5343728 | 2013-04-26 19:30:27 -0400 | [diff] [blame] | 85 | |
| 86 | class Meta: |
| 87 | app_label = "core" |
| 88 | |
| 89 | email = models.EmailField( |
| 90 | verbose_name='email address', |
| 91 | max_length=255, |
| 92 | unique=True, |
| 93 | db_index=True, |
| 94 | ) |
Siobhan Tully | fece0d5 | 2013-09-06 12:57:05 -0400 | [diff] [blame] | 95 | |
| 96 | username = models.CharField(max_length=255, default="Something" ) |
| 97 | |
Siobhan Tully | 5343728 | 2013-04-26 19:30:27 -0400 | [diff] [blame] | 98 | firstname = models.CharField(help_text="person's given name", max_length=200) |
| 99 | lastname = models.CharField(help_text="person's surname", max_length=200) |
| 100 | |
| 101 | phone = models.CharField(null=True, blank=True, help_text="phone number contact", max_length=100) |
| 102 | user_url = models.URLField(null=True, blank=True) |
Siobhan Tully | bfd11dc | 2013-09-03 12:59:24 -0400 | [diff] [blame] | 103 | site = models.ForeignKey(Site, related_name='users', help_text="Site this user will be homed too", null=True) |
Tony Mack | 5cbadf8 | 2013-06-10 13:56:07 -0400 | [diff] [blame] | 104 | public_key = models.TextField(null=True, blank=True, max_length=1024, help_text="Public key string") |
Siobhan Tully | 5343728 | 2013-04-26 19:30:27 -0400 | [diff] [blame] | 105 | |
| 106 | is_active = models.BooleanField(default=True) |
| 107 | is_admin = models.BooleanField(default=True) |
| 108 | is_staff = models.BooleanField(default=True) |
Siobhan Tully | cf04fb6 | 2014-01-11 11:25:57 -0500 | [diff] [blame] | 109 | is_readonly = models.BooleanField(default=False) |
Siobhan Tully | 5343728 | 2013-04-26 19:30:27 -0400 | [diff] [blame] | 110 | |
Tony Mack | 0553f28 | 2013-06-10 22:54:50 -0400 | [diff] [blame] | 111 | created = models.DateTimeField(auto_now_add=True) |
| 112 | updated = models.DateTimeField(auto_now=True) |
| 113 | enacted = models.DateTimeField(null=True, default=None) |
Sapan Bhatia | 47b9bf2 | 2014-04-28 21:09:53 -0400 | [diff] [blame] | 114 | backend_status = models.CharField(max_length=140, |
Sapan Bhatia | d507f43 | 2014-04-29 00:41:39 -0400 | [diff] [blame] | 115 | default="Provisioning in progress") |
Sapan Bhatia | bcc1899 | 2014-04-29 10:32:14 -0400 | [diff] [blame] | 116 | deleted = models.BooleanField(default=False) |
Tony Mack | 0553f28 | 2013-06-10 22:54:50 -0400 | [diff] [blame] | 117 | |
Scott Baker | 9266e6b | 2013-05-19 15:54:48 -0700 | [diff] [blame] | 118 | timezone = TimeZoneField() |
| 119 | |
Scott Baker | 2c3cb64 | 2014-05-19 17:55:56 -0700 | [diff] [blame] | 120 | dashboards = models.ManyToManyField('DashboardView', through='UserDashboardView', blank=True) |
| 121 | |
Siobhan Tully | 30fd429 | 2013-05-10 08:59:56 -0400 | [diff] [blame] | 122 | objects = UserManager() |
Sapan Bhatia | 5d605ff | 2014-07-21 20:08:04 -0400 | [diff] [blame] | 123 | deleted_objects = DeletedUserManager() |
Siobhan Tully | 5343728 | 2013-04-26 19:30:27 -0400 | [diff] [blame] | 124 | |
| 125 | USERNAME_FIELD = 'email' |
| 126 | REQUIRED_FIELDS = ['firstname', 'lastname'] |
| 127 | |
Scott Baker | 0119c15 | 2014-10-06 22:58:48 -0700 | [diff] [blame] | 128 | PI_FORBIDDEN_FIELDS = ["is_admin", "site", "is_staff"] |
| 129 | USER_FORBIDDEN_FIELDS = ["is_admin", "is_active", "site", "is_staff", "is_readonly"] |
| 130 | |
Scott Baker | cbfb600 | 2014-10-03 00:32:37 -0700 | [diff] [blame] | 131 | def __init__(self, *args, **kwargs): |
| 132 | super(User, self).__init__(*args, **kwargs) |
| 133 | self._initial = self._dict # for DiffModelMixIn |
| 134 | |
Siobhan Tully | cf04fb6 | 2014-01-11 11:25:57 -0500 | [diff] [blame] | 135 | def isReadOnlyUser(self): |
| 136 | return self.is_readonly |
| 137 | |
Siobhan Tully | 5343728 | 2013-04-26 19:30:27 -0400 | [diff] [blame] | 138 | def get_full_name(self): |
| 139 | # The user is identified by their email address |
| 140 | return self.email |
| 141 | |
| 142 | def get_short_name(self): |
| 143 | # The user is identified by their email address |
| 144 | return self.email |
| 145 | |
Sapan Bhatia | 5d605ff | 2014-07-21 20:08:04 -0400 | [diff] [blame] | 146 | def delete(self, *args, **kwds): |
| 147 | # so we have something to give the observer |
| 148 | purge = kwds.get('purge',False) |
Scott Baker | c5b5060 | 2014-10-09 16:22:00 -0700 | [diff] [blame] | 149 | if purge: |
| 150 | del kwds['purge'] |
Sapan Bhatia | 5d605ff | 2014-07-21 20:08:04 -0400 | [diff] [blame] | 151 | try: |
| 152 | purge = purge or observer_disabled |
| 153 | except NameError: |
| 154 | pass |
| 155 | |
| 156 | if (purge): |
| 157 | super(User, self).delete(*args, **kwds) |
| 158 | else: |
| 159 | self.deleted = True |
| 160 | self.enacted=None |
| 161 | self.save(update_fields=['enacted','deleted']) |
| 162 | |
Tony Mack | b0d9742 | 2013-06-10 09:57:45 -0400 | [diff] [blame] | 163 | @property |
| 164 | def keyname(self): |
| 165 | return self.email[:self.email.find('@')] |
| 166 | |
Siobhan Tully | 5343728 | 2013-04-26 19:30:27 -0400 | [diff] [blame] | 167 | def __unicode__(self): |
| 168 | return self.email |
| 169 | |
| 170 | def has_perm(self, perm, obj=None): |
| 171 | "Does the user have a specific permission?" |
| 172 | # Simplest possible answer: Yes, always |
| 173 | return True |
| 174 | |
| 175 | def has_module_perms(self, app_label): |
| 176 | "Does the user have permissions to view the app `app_label`?" |
| 177 | # Simplest possible answer: Yes, always |
| 178 | return True |
| 179 | |
Siobhan Tully | bfd11dc | 2013-09-03 12:59:24 -0400 | [diff] [blame] | 180 | def is_superuser(self): |
| 181 | return False |
Siobhan Tully | 5343728 | 2013-04-26 19:30:27 -0400 | [diff] [blame] | 182 | |
Scott Baker | 2c3cb64 | 2014-05-19 17:55:56 -0700 | [diff] [blame] | 183 | def get_dashboards(self): |
| 184 | DEFAULT_DASHBOARDS=["Tenant"] |
| 185 | |
Sapan Bhatia | 13d2db9 | 2014-11-11 21:47:45 -0500 | [diff] [blame] | 186 | dashboards = sorted(list(self.userdashboardviews.all()), key=attrgetter('order')) |
Scott Baker | 2c3cb64 | 2014-05-19 17:55:56 -0700 | [diff] [blame] | 187 | dashboards = [x.dashboardView for x in dashboards] |
| 188 | |
| 189 | if not dashboards: |
| 190 | for dashboardName in DEFAULT_DASHBOARDS: |
| 191 | dbv = DashboardView.objects.filter(name=dashboardName) |
| 192 | if dbv: |
| 193 | dashboards.append(dbv[0]) |
| 194 | |
| 195 | return dashboards |
| 196 | |
Siobhan Tully | bfd11dc | 2013-09-03 12:59:24 -0400 | [diff] [blame] | 197 | # def get_roles(self): |
| 198 | # from core.models.site import SitePrivilege |
| 199 | # from core.models.slice import SliceMembership |
| 200 | # |
| 201 | # site_privileges = SitePrivilege.objects.filter(user=self) |
| 202 | # slice_memberships = SliceMembership.objects.filter(user=self) |
| 203 | # roles = defaultdict(list) |
| 204 | # for site_privilege in site_privileges: |
| 205 | # roles[site_privilege.role.role_type].append(site_privilege.site.login_base) |
| 206 | # for slice_membership in slice_memberships: |
| 207 | # roles[slice_membership.role.role_type].append(slice_membership.slice.name) |
| 208 | # return roles |
Siobhan Tully | 5343728 | 2013-04-26 19:30:27 -0400 | [diff] [blame] | 209 | |
Tony Mack | 53106f3 | 2013-04-27 16:43:01 -0400 | [diff] [blame] | 210 | def save(self, *args, **kwds): |
Siobhan Tully | 30fd429 | 2013-05-10 08:59:56 -0400 | [diff] [blame] | 211 | if not self.id: |
Scott Baker | a36d77e | 2014-08-29 11:43:23 -0700 | [diff] [blame] | 212 | self.set_password(self.password) |
| 213 | if self.is_active: |
| 214 | if self.password=="!":
|
| 215 | self.send_temporary_password()
|
| 216 |
|
Siobhan Tully | fece0d5 | 2013-09-06 12:57:05 -0400 | [diff] [blame] | 217 | self.username = self.email |
Scott Baker | a36d77e | 2014-08-29 11:43:23 -0700 | [diff] [blame] | 218 | super(User, self).save(*args, **kwds) |
| 219 | |
Scott Baker | cbfb600 | 2014-10-03 00:32:37 -0700 | [diff] [blame] | 220 | self._initial = self._dict |
| 221 | |
Scott Baker | a36d77e | 2014-08-29 11:43:23 -0700 | [diff] [blame] | 222 | def send_temporary_password(self): |
| 223 | password = User.objects.make_random_password() |
| 224 | self.set_password(password)
|
| 225 | subject, from_email, to = 'OpenCloud Account Credentials', 'support@opencloud.us', str(self.email)
|
| 226 | text_content = 'This is an important message.'
|
Scott Baker | 51e7d40 | 2014-08-29 12:32:46 -0700 | [diff] [blame] | 227 | userUrl="http://%s/" % get_request().get_host()
|
Scott Baker | a36d77e | 2014-08-29 11:43:23 -0700 | [diff] [blame] | 228 | html_content = """<p>Your account has been created on OpenCloud. Please log in <a href="""+userUrl+""">here</a> to activate your account<br><br>Username: """+self.email+"""<br>Temporary Password: """+password+"""<br>Please change your password once you successully login into the site.</p>"""
|
| 229 | msg = EmailMultiAlternatives(subject,text_content, from_email, [to])
|
| 230 | msg.attach_alternative(html_content, "text/html")
|
| 231 | msg.send() |
Tony Mack | 5b06147 | 2014-02-04 07:57:10 -0500 | [diff] [blame] | 232 | |
Scott Baker | cbfb600 | 2014-10-03 00:32:37 -0700 | [diff] [blame] | 233 | def can_update(self, user): |
| 234 | from core.models import SitePrivilege |
Scott Baker | 0119c15 | 2014-10-06 22:58:48 -0700 | [diff] [blame] | 235 | _cant_update_fieldName = None |
Scott Baker | cbfb600 | 2014-10-03 00:32:37 -0700 | [diff] [blame] | 236 | if user.is_readonly: |
| 237 | return False |
| 238 | if user.is_admin: |
| 239 | return True |
Scott Baker | cbfb600 | 2014-10-03 00:32:37 -0700 | [diff] [blame] | 240 | # site pis can update |
| 241 | site_privs = SitePrivilege.objects.filter(user=user, site=self.site) |
| 242 | for site_priv in site_privs: |
| 243 | if site_priv.role.role == 'pi': |
Scott Baker | 0119c15 | 2014-10-06 22:58:48 -0700 | [diff] [blame] | 244 | for fieldName in self.diff.keys(): |
| 245 | if fieldName in self.PI_FORBIDDEN_FIELDS: |
| 246 | _cant_update_fieldName = fieldName |
| 247 | return False |
Scott Baker | cbfb600 | 2014-10-03 00:32:37 -0700 | [diff] [blame] | 248 | return True |
Scott Baker | 0119c15 | 2014-10-06 22:58:48 -0700 | [diff] [blame] | 249 | if (user.id == self.id): |
| 250 | for fieldName in self.diff.keys(): |
| 251 | if fieldName in self.USER_FORBIDDEN_FIELDS: |
| 252 | _cant_update_fieldName = fieldName |
| 253 | return False |
| 254 | return True |
Scott Baker | cbfb600 | 2014-10-03 00:32:37 -0700 | [diff] [blame] | 255 | |
| 256 | return False |
| 257 | |
Tony Mack | 5b06147 | 2014-02-04 07:57:10 -0500 | [diff] [blame] | 258 | @staticmethod |
| 259 | def select_by_user(user): |
| 260 | if user.is_admin: |
| 261 | qs = User.objects.all() |
| 262 | else: |
| 263 | # can see all users at any site where this user has pi role |
| 264 | from core.models.site import SitePrivilege |
| 265 | site_privs = SitePrivilege.objects.filter(user=user) |
| 266 | sites = [sp.site for sp in site_privs if sp.role.role == 'pi'] |
| 267 | # get site privs of users at these sites |
| 268 | site_privs = SitePrivilege.objects.filter(site__in=sites) |
Scott Baker | a36d77e | 2014-08-29 11:43:23 -0700 | [diff] [blame] | 269 | user_ids = [sp.user.id for sp in site_privs] + [user.id] |
Tony Mack | 5b06147 | 2014-02-04 07:57:10 -0500 | [diff] [blame] | 270 | qs = User.objects.filter(Q(site__in=sites) | Q(id__in=user_ids)) |
Scott Baker | a36d77e | 2014-08-29 11:43:23 -0700 | [diff] [blame] | 271 | return qs |
Tony Mack | 5b06147 | 2014-02-04 07:57:10 -0500 | [diff] [blame] | 272 | |
Scott Baker | cbfb600 | 2014-10-03 00:32:37 -0700 | [diff] [blame] | 273 | def save_by_user(self, user, *args, **kwds): |
| 274 | if not self.can_update(user): |
Scott Baker | 0119c15 | 2014-10-06 22:58:48 -0700 | [diff] [blame] | 275 | if getattr(self, "_cant_update_fieldName", None) is not None: |
| 276 | raise PermissionDenied("You do not have permission to update field %s on object %s" % (self._cant_update_fieldName, self.__class__.__name__)) |
| 277 | else: |
| 278 | raise PermissionDenied("You do not have permission to update %s objects" % self.__class__.__name__) |
Scott Baker | cbfb600 | 2014-10-03 00:32:37 -0700 | [diff] [blame] | 279 | |
| 280 | self.save(*args, **kwds) |
| 281 | |
| 282 | def delete_by_user(self, user, *args, **kwds): |
| 283 | if not self.can_update(user): |
| 284 | raise PermissionDenied("You do not have permission to delete %s objects" % self.__class__.__name__) |
| 285 | self.delete(*args, **kwds) |
| 286 | |
Scott Baker | 2c3cb64 | 2014-05-19 17:55:56 -0700 | [diff] [blame] | 287 | class UserDashboardView(PlCoreBase): |
Sapan Bhatia | 13d2db9 | 2014-11-11 21:47:45 -0500 | [diff] [blame] | 288 | user = models.ForeignKey(User, related_name='userdashboardviews') |
| 289 | dashboardView = models.ForeignKey(DashboardView, related_name='userdashboardviews') |
Scott Baker | 2c3cb64 | 2014-05-19 17:55:56 -0700 | [diff] [blame] | 290 | order = models.IntegerField(default=0) |