blob: 8dc87b332ed172a2e1b6f166392d22d3231a5612 [file] [log] [blame]
Siobhan Tully53437282013-04-26 19:30:27 -04001import os
2import datetime
Tony Mackc14de8f2013-05-09 21:44:17 -04003from collections import defaultdict
Siobhan Tully53437282013-04-26 19:30:27 -04004from django.db import models
Tony Mack5b061472014-02-04 07:57:10 -05005from django.db.models import F, Q
Scott Baker1a6a3902014-10-03 00:32:37 -07006from core.models import PlCoreBase,Site, DashboardView, DiffModelMixIn
Sapan Bhatiaf7b29d22014-06-11 17:10:11 -04007from core.models.site import Deployment
Siobhan Tully30fd4292013-05-10 08:59:56 -04008from django.contrib.auth.models import AbstractBaseUser, BaseUserManager
Scott Baker9266e6b2013-05-19 15:54:48 -07009from timezones.fields import TimeZoneField
Scott Baker2c3cb642014-05-19 17:55:56 -070010from operator import itemgetter, attrgetter
Scott Bakera36d77e2014-08-29 11:43:23 -070011from django.core.mail import EmailMultiAlternatives
12from core.middleware import get_request
Sapan Bhatia39097192014-09-04 00:39:19 -040013import model_policy
Scott Baker1a6a3902014-10-03 00:32:37 -070014from django.core.exceptions import PermissionDenied
Siobhan Tully53437282013-04-26 19:30:27 -040015
Scott Bakerd29431b2014-10-09 16:16:02 -070016# ------ from plcorebase.py ------
17try:
18 # This is a no-op if observer_disabled is set to 1 in the config file
19 from observer import *
20except:
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 Tully53437282013-04-26 19:30:27 -040030# Create your models here.
Siobhan Tully30fd4292013-05-10 08:59:56 -040031class UserManager(BaseUserManager):
Siobhan Tully53437282013-04-26 19:30:27 -040032 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 Tully30fd4292013-05-10 08:59:56 -040041 email=UserManager.normalize_email(email),
Siobhan Tully53437282013-04-26 19:30:27 -040042 firstname=firstname,
Siobhan Tully30fd4292013-05-10 08:59:56 -040043 lastname=lastname,
44 password=password
Siobhan Tully53437282013-04-26 19:30:27 -040045 )
Siobhan Tully30fd4292013-05-10 08:59:56 -040046 #user.set_password(password)
Siobhan Tully53437282013-04-26 19:30:27 -040047 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
Sapan Bhatia5d605ff2014-07-21 20:08:04 -040065class DeletedUserManager(UserManager):
Scott Baker92f14222014-09-12 12:57:27 -070066 def get_queryset(self):
Sapan Bhatia5d605ff2014-07-21 20:08:04 -040067 return super(UserManager, self).get_query_set().filter(deleted=True)
Siobhan Tully53437282013-04-26 19:30:27 -040068
Scott Baker92f14222014-09-12 12:57:27 -070069 # deprecated in django 1.7 in favor of get_queryset()
70 def get_query_set(self):
71 return self.get_queryset()
72
Scott Baker1a6a3902014-10-03 00:32:37 -070073class User(AbstractBaseUser, DiffModelMixIn):
Siobhan Tully53437282013-04-26 19:30:27 -040074
75 class Meta:
76 app_label = "core"
77
78 email = models.EmailField(
79 verbose_name='email address',
80 max_length=255,
81 unique=True,
82 db_index=True,
83 )
Siobhan Tullyfece0d52013-09-06 12:57:05 -040084
85 username = models.CharField(max_length=255, default="Something" )
86
Siobhan Tully53437282013-04-26 19:30:27 -040087 firstname = models.CharField(help_text="person's given name", max_length=200)
88 lastname = models.CharField(help_text="person's surname", max_length=200)
89
90 phone = models.CharField(null=True, blank=True, help_text="phone number contact", max_length=100)
91 user_url = models.URLField(null=True, blank=True)
Siobhan Tullybfd11dc2013-09-03 12:59:24 -040092 site = models.ForeignKey(Site, related_name='users', help_text="Site this user will be homed too", null=True)
Tony Mack5cbadf82013-06-10 13:56:07 -040093 public_key = models.TextField(null=True, blank=True, max_length=1024, help_text="Public key string")
Siobhan Tully53437282013-04-26 19:30:27 -040094
95 is_active = models.BooleanField(default=True)
96 is_admin = models.BooleanField(default=True)
97 is_staff = models.BooleanField(default=True)
Siobhan Tullycf04fb62014-01-11 11:25:57 -050098 is_readonly = models.BooleanField(default=False)
Siobhan Tully53437282013-04-26 19:30:27 -040099
Tony Mack0553f282013-06-10 22:54:50 -0400100 created = models.DateTimeField(auto_now_add=True)
101 updated = models.DateTimeField(auto_now=True)
102 enacted = models.DateTimeField(null=True, default=None)
Sapan Bhatia47b9bf22014-04-28 21:09:53 -0400103 backend_status = models.CharField(max_length=140,
Sapan Bhatiad507f432014-04-29 00:41:39 -0400104 default="Provisioning in progress")
Sapan Bhatiabcc18992014-04-29 10:32:14 -0400105 deleted = models.BooleanField(default=False)
Tony Mack0553f282013-06-10 22:54:50 -0400106
Scott Baker9266e6b2013-05-19 15:54:48 -0700107 timezone = TimeZoneField()
108
Scott Baker2c3cb642014-05-19 17:55:56 -0700109 dashboards = models.ManyToManyField('DashboardView', through='UserDashboardView', blank=True)
110
Siobhan Tully30fd4292013-05-10 08:59:56 -0400111 objects = UserManager()
Sapan Bhatia5d605ff2014-07-21 20:08:04 -0400112 deleted_objects = DeletedUserManager()
Siobhan Tully53437282013-04-26 19:30:27 -0400113
114 USERNAME_FIELD = 'email'
115 REQUIRED_FIELDS = ['firstname', 'lastname']
116
Scott Baker1bffe942014-10-06 22:58:48 -0700117 PI_FORBIDDEN_FIELDS = ["is_admin", "site", "is_staff"]
118 USER_FORBIDDEN_FIELDS = ["is_admin", "is_active", "site", "is_staff", "is_readonly"]
119
Scott Baker1a6a3902014-10-03 00:32:37 -0700120 def __init__(self, *args, **kwargs):
121 super(User, self).__init__(*args, **kwargs)
122 self._initial = self._dict # for DiffModelMixIn
123
Siobhan Tullycf04fb62014-01-11 11:25:57 -0500124 def isReadOnlyUser(self):
125 return self.is_readonly
126
Siobhan Tully53437282013-04-26 19:30:27 -0400127 def get_full_name(self):
128 # The user is identified by their email address
129 return self.email
130
131 def get_short_name(self):
132 # The user is identified by their email address
133 return self.email
134
Sapan Bhatia5d605ff2014-07-21 20:08:04 -0400135 def delete(self, *args, **kwds):
136 # so we have something to give the observer
137 purge = kwds.get('purge',False)
Scott Baker3d2d3e42014-10-09 16:22:00 -0700138 if purge:
139 del kwds['purge']
Sapan Bhatia5d605ff2014-07-21 20:08:04 -0400140 try:
141 purge = purge or observer_disabled
142 except NameError:
143 pass
144
145 if (purge):
146 super(User, self).delete(*args, **kwds)
147 else:
148 self.deleted = True
149 self.enacted=None
150 self.save(update_fields=['enacted','deleted'])
151
Tony Mackb0d97422013-06-10 09:57:45 -0400152 @property
153 def keyname(self):
154 return self.email[:self.email.find('@')]
155
Siobhan Tully53437282013-04-26 19:30:27 -0400156 def __unicode__(self):
157 return self.email
158
159 def has_perm(self, perm, obj=None):
160 "Does the user have a specific permission?"
161 # Simplest possible answer: Yes, always
162 return True
163
164 def has_module_perms(self, app_label):
165 "Does the user have permissions to view the app `app_label`?"
166 # Simplest possible answer: Yes, always
167 return True
168
Siobhan Tullybfd11dc2013-09-03 12:59:24 -0400169 def is_superuser(self):
170 return False
Siobhan Tully53437282013-04-26 19:30:27 -0400171
Scott Baker2c3cb642014-05-19 17:55:56 -0700172 def get_dashboards(self):
173 DEFAULT_DASHBOARDS=["Tenant"]
174
175 dashboards = sorted(list(self.dashboardViews.all()), key=attrgetter('order'))
176 dashboards = [x.dashboardView for x in dashboards]
177
178 if not dashboards:
179 for dashboardName in DEFAULT_DASHBOARDS:
180 dbv = DashboardView.objects.filter(name=dashboardName)
181 if dbv:
182 dashboards.append(dbv[0])
183
184 return dashboards
185
Siobhan Tullybfd11dc2013-09-03 12:59:24 -0400186# def get_roles(self):
187# from core.models.site import SitePrivilege
188# from core.models.slice import SliceMembership
189#
190# site_privileges = SitePrivilege.objects.filter(user=self)
191# slice_memberships = SliceMembership.objects.filter(user=self)
192# roles = defaultdict(list)
193# for site_privilege in site_privileges:
194# roles[site_privilege.role.role_type].append(site_privilege.site.login_base)
195# for slice_membership in slice_memberships:
196# roles[slice_membership.role.role_type].append(slice_membership.slice.name)
197# return roles
Siobhan Tully53437282013-04-26 19:30:27 -0400198
Tony Mack53106f32013-04-27 16:43:01 -0400199 def save(self, *args, **kwds):
Siobhan Tully30fd4292013-05-10 08:59:56 -0400200 if not self.id:
Scott Bakera36d77e2014-08-29 11:43:23 -0700201 self.set_password(self.password)
202 if self.is_active:
203 if self.password=="!":
204 self.send_temporary_password()
205
Siobhan Tullyfece0d52013-09-06 12:57:05 -0400206 self.username = self.email
Scott Bakera36d77e2014-08-29 11:43:23 -0700207 super(User, self).save(*args, **kwds)
208
Scott Baker1a6a3902014-10-03 00:32:37 -0700209 self._initial = self._dict
210
Scott Bakera36d77e2014-08-29 11:43:23 -0700211 def send_temporary_password(self):
212 password = User.objects.make_random_password()
213 self.set_password(password)
214 subject, from_email, to = 'OpenCloud Account Credentials', 'support@opencloud.us', str(self.email)
215 text_content = 'This is an important message.'
Scott Baker51e7d402014-08-29 12:32:46 -0700216 userUrl="http://%s/" % get_request().get_host()
Scott Bakera36d77e2014-08-29 11:43:23 -0700217 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>"""
218 msg = EmailMultiAlternatives(subject,text_content, from_email, [to])
219 msg.attach_alternative(html_content, "text/html")
220 msg.send()
Tony Mack5b061472014-02-04 07:57:10 -0500221
Scott Baker1a6a3902014-10-03 00:32:37 -0700222 def can_update(self, user):
223 from core.models import SitePrivilege
Scott Baker1bffe942014-10-06 22:58:48 -0700224 _cant_update_fieldName = None
Scott Baker1a6a3902014-10-03 00:32:37 -0700225 if user.is_readonly:
226 return False
227 if user.is_admin:
228 return True
Scott Baker1a6a3902014-10-03 00:32:37 -0700229 # site pis can update
230 site_privs = SitePrivilege.objects.filter(user=user, site=self.site)
231 for site_priv in site_privs:
232 if site_priv.role.role == 'pi':
Scott Baker1bffe942014-10-06 22:58:48 -0700233 for fieldName in self.diff.keys():
234 if fieldName in self.PI_FORBIDDEN_FIELDS:
235 _cant_update_fieldName = fieldName
236 return False
Scott Baker1a6a3902014-10-03 00:32:37 -0700237 return True
Scott Baker1bffe942014-10-06 22:58:48 -0700238 if (user.id == self.id):
239 for fieldName in self.diff.keys():
240 if fieldName in self.USER_FORBIDDEN_FIELDS:
241 _cant_update_fieldName = fieldName
242 return False
243 return True
Scott Baker1a6a3902014-10-03 00:32:37 -0700244
245 return False
246
Tony Mack5b061472014-02-04 07:57:10 -0500247 @staticmethod
248 def select_by_user(user):
249 if user.is_admin:
250 qs = User.objects.all()
251 else:
252 # can see all users at any site where this user has pi role
253 from core.models.site import SitePrivilege
254 site_privs = SitePrivilege.objects.filter(user=user)
255 sites = [sp.site for sp in site_privs if sp.role.role == 'pi']
256 # get site privs of users at these sites
257 site_privs = SitePrivilege.objects.filter(site__in=sites)
Scott Bakera36d77e2014-08-29 11:43:23 -0700258 user_ids = [sp.user.id for sp in site_privs] + [user.id]
Tony Mack5b061472014-02-04 07:57:10 -0500259 qs = User.objects.filter(Q(site__in=sites) | Q(id__in=user_ids))
Scott Bakera36d77e2014-08-29 11:43:23 -0700260 return qs
Tony Mack5b061472014-02-04 07:57:10 -0500261
Scott Baker1a6a3902014-10-03 00:32:37 -0700262 def save_by_user(self, user, *args, **kwds):
263 if not self.can_update(user):
Scott Baker1bffe942014-10-06 22:58:48 -0700264 if getattr(self, "_cant_update_fieldName", None) is not None:
265 raise PermissionDenied("You do not have permission to update field %s on object %s" % (self._cant_update_fieldName, self.__class__.__name__))
266 else:
267 raise PermissionDenied("You do not have permission to update %s objects" % self.__class__.__name__)
Scott Baker1a6a3902014-10-03 00:32:37 -0700268
269 self.save(*args, **kwds)
270
271 def delete_by_user(self, user, *args, **kwds):
272 if not self.can_update(user):
273 raise PermissionDenied("You do not have permission to delete %s objects" % self.__class__.__name__)
274 self.delete(*args, **kwds)
275
Scott Baker2c3cb642014-05-19 17:55:56 -0700276class UserDashboardView(PlCoreBase):
277 user = models.ForeignKey(User, related_name="dashboardViews")
278 dashboardView = models.ForeignKey(DashboardView, related_name="dashboardViews")
279 order = models.IntegerField(default=0)