blob: fb0d2321a9d2389d7b831c84a2d65ba7e92d25bc [file] [log] [blame]
Siobhan Tully53437282013-04-26 19:30:27 -04001import os
2import datetime
Scott Baker83f5b622014-12-19 13:02:31 -08003import sys
Tony Mack2040f5d2015-01-03 14:26:15 -05004import hashlib
Tony Mackc14de8f2013-05-09 21:44:17 -04005from collections import defaultdict
Scott Bakerc1057712014-12-19 12:22:51 -08006from django.forms.models import model_to_dict
Siobhan Tully53437282013-04-26 19:30:27 -04007from django.db import models
Tony Mack5b061472014-02-04 07:57:10 -05008from django.db.models import F, Q
Scott Baker1a6a3902014-10-03 00:32:37 -07009from core.models import PlCoreBase,Site, DashboardView, DiffModelMixIn
Siobhan Tully30fd4292013-05-10 08:59:56 -040010from django.contrib.auth.models import AbstractBaseUser, BaseUserManager
Scott Baker9266e6b2013-05-19 15:54:48 -070011from timezones.fields import TimeZoneField
Scott Baker2c3cb642014-05-19 17:55:56 -070012from operator import itemgetter, attrgetter
Scott Bakera36d77e2014-08-29 11:43:23 -070013from django.core.mail import EmailMultiAlternatives
14from core.middleware import get_request
Sapan Bhatia39097192014-09-04 00:39:19 -040015import model_policy
Scott Baker1a6a3902014-10-03 00:32:37 -070016from django.core.exceptions import PermissionDenied
Siobhan Tully53437282013-04-26 19:30:27 -040017
Scott Bakerd29431b2014-10-09 16:16:02 -070018# ------ from plcorebase.py ------
19try:
20 # This is a no-op if observer_disabled is set to 1 in the config file
21 from observer import *
22except:
23 print >> sys.stderr, "import of observer failed! printing traceback and disabling observer:"
24 import traceback
25 traceback.print_exc()
26
27 # guard against something failing
28 def notify_observer(*args, **kwargs):
29 pass
30# ------ ------
31
Siobhan Tully53437282013-04-26 19:30:27 -040032# Create your models here.
Siobhan Tully30fd4292013-05-10 08:59:56 -040033class UserManager(BaseUserManager):
Siobhan Tully53437282013-04-26 19:30:27 -040034 def create_user(self, email, firstname, lastname, password=None):
35 """
36 Creates and saves a User with the given email, date of
37 birth and password.
38 """
39 if not email:
40 raise ValueError('Users must have an email address')
41
42 user = self.model(
Siobhan Tully30fd4292013-05-10 08:59:56 -040043 email=UserManager.normalize_email(email),
Siobhan Tully53437282013-04-26 19:30:27 -040044 firstname=firstname,
Siobhan Tully30fd4292013-05-10 08:59:56 -040045 lastname=lastname,
46 password=password
Siobhan Tully53437282013-04-26 19:30:27 -040047 )
Siobhan Tully30fd4292013-05-10 08:59:56 -040048 #user.set_password(password)
Siobhan Tully53437282013-04-26 19:30:27 -040049 user.is_admin = True
50 user.save(using=self._db)
51 return user
52
53 def create_superuser(self, email, firstname, lastname, password):
54 """
55 Creates and saves a superuser with the given email, date of
56 birth and password.
57 """
58 user = self.create_user(email,
59 password=password,
60 firstname=firstname,
61 lastname=lastname
62 )
63 user.is_admin = True
64 user.save(using=self._db)
65 return user
66
Scott Bakerf22e73a2014-10-17 18:45:00 -070067 def get_queryset(self):
68 parent=super(UserManager, self)
69 if hasattr(parent, "get_queryset"):
70 return parent.get_queryset().filter(deleted=False)
71 else:
72 return parent.get_query_set().filter(deleted=False)
73
74 # deprecated in django 1.7 in favor of get_queryset().
75 def get_query_set(self):
76 return self.get_queryset()
77
Sapan Bhatia5d605ff2014-07-21 20:08:04 -040078class DeletedUserManager(UserManager):
Scott Baker92f14222014-09-12 12:57:27 -070079 def get_queryset(self):
Sapan Bhatia5d605ff2014-07-21 20:08:04 -040080 return super(UserManager, self).get_query_set().filter(deleted=True)
Siobhan Tully53437282013-04-26 19:30:27 -040081
Scott Baker92f14222014-09-12 12:57:27 -070082 # deprecated in django 1.7 in favor of get_queryset()
83 def get_query_set(self):
84 return self.get_queryset()
85
Scott Bakerc1057712014-12-19 12:22:51 -080086class User(AbstractBaseUser): #, DiffModelMixIn):
87
88 # ---- copy stuff from DiffModelMixin ----
89
90 @property
91 def _dict(self):
92 return model_to_dict(self, fields=[field.name for field in
93 self._meta.fields])
94
95 @property
96 def diff(self):
97 d1 = self._initial
98 d2 = self._dict
99 diffs = [(k, (v, d2[k])) for k, v in d1.items() if v != d2[k]]
100 return dict(diffs)
101
102 @property
103 def has_changed(self):
104 return bool(self.diff)
105
106 @property
107 def changed_fields(self):
108 return self.diff.keys()
109
110 def has_field_changed(self, field_name):
111 return field_name in self.diff.keys()
112
113 def get_field_diff(self, field_name):
114 return self.diff.get(field_name, None)
115 # ---- end copy stuff from DiffModelMixin ----
Siobhan Tully53437282013-04-26 19:30:27 -0400116
Tony Mack2040f5d2015-01-03 14:26:15 -0500117 @property
118 def remote_password(self):
119 return hashlib.md5(self.password).hexdigest()[:12]
120
Siobhan Tully53437282013-04-26 19:30:27 -0400121 class Meta:
122 app_label = "core"
123
124 email = models.EmailField(
125 verbose_name='email address',
126 max_length=255,
127 unique=True,
128 db_index=True,
129 )
Siobhan Tullyfece0d52013-09-06 12:57:05 -0400130
131 username = models.CharField(max_length=255, default="Something" )
132
Siobhan Tully53437282013-04-26 19:30:27 -0400133 firstname = models.CharField(help_text="person's given name", max_length=200)
134 lastname = models.CharField(help_text="person's surname", max_length=200)
135
136 phone = models.CharField(null=True, blank=True, help_text="phone number contact", max_length=100)
137 user_url = models.URLField(null=True, blank=True)
Siobhan Tullybfd11dc2013-09-03 12:59:24 -0400138 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 -0400139 public_key = models.TextField(null=True, blank=True, max_length=1024, help_text="Public key string")
Siobhan Tully53437282013-04-26 19:30:27 -0400140
141 is_active = models.BooleanField(default=True)
142 is_admin = models.BooleanField(default=True)
143 is_staff = models.BooleanField(default=True)
Siobhan Tullycf04fb62014-01-11 11:25:57 -0500144 is_readonly = models.BooleanField(default=False)
Siobhan Tully53437282013-04-26 19:30:27 -0400145
Tony Mack0553f282013-06-10 22:54:50 -0400146 created = models.DateTimeField(auto_now_add=True)
147 updated = models.DateTimeField(auto_now=True)
148 enacted = models.DateTimeField(null=True, default=None)
Sapan Bhatia47b9bf22014-04-28 21:09:53 -0400149 backend_status = models.CharField(max_length=140,
Sapan Bhatiad507f432014-04-29 00:41:39 -0400150 default="Provisioning in progress")
Sapan Bhatiabcc18992014-04-29 10:32:14 -0400151 deleted = models.BooleanField(default=False)
Tony Mack0553f282013-06-10 22:54:50 -0400152
Scott Baker9266e6b2013-05-19 15:54:48 -0700153 timezone = TimeZoneField()
154
Scott Baker2c3cb642014-05-19 17:55:56 -0700155 dashboards = models.ManyToManyField('DashboardView', through='UserDashboardView', blank=True)
156
Siobhan Tully30fd4292013-05-10 08:59:56 -0400157 objects = UserManager()
Sapan Bhatia5d605ff2014-07-21 20:08:04 -0400158 deleted_objects = DeletedUserManager()
Siobhan Tully53437282013-04-26 19:30:27 -0400159
160 USERNAME_FIELD = 'email'
161 REQUIRED_FIELDS = ['firstname', 'lastname']
162
Scott Baker1bffe942014-10-06 22:58:48 -0700163 PI_FORBIDDEN_FIELDS = ["is_admin", "site", "is_staff"]
164 USER_FORBIDDEN_FIELDS = ["is_admin", "is_active", "site", "is_staff", "is_readonly"]
165
Scott Baker1a6a3902014-10-03 00:32:37 -0700166 def __init__(self, *args, **kwargs):
167 super(User, self).__init__(*args, **kwargs)
168 self._initial = self._dict # for DiffModelMixIn
169
Siobhan Tullycf04fb62014-01-11 11:25:57 -0500170 def isReadOnlyUser(self):
171 return self.is_readonly
172
Siobhan Tully53437282013-04-26 19:30:27 -0400173 def get_full_name(self):
174 # The user is identified by their email address
175 return self.email
176
177 def get_short_name(self):
178 # The user is identified by their email address
179 return self.email
180
Sapan Bhatia5d605ff2014-07-21 20:08:04 -0400181 def delete(self, *args, **kwds):
182 # so we have something to give the observer
183 purge = kwds.get('purge',False)
Scott Baker3d2d3e42014-10-09 16:22:00 -0700184 if purge:
185 del kwds['purge']
Sapan Bhatia5d605ff2014-07-21 20:08:04 -0400186 try:
187 purge = purge or observer_disabled
188 except NameError:
189 pass
190
191 if (purge):
192 super(User, self).delete(*args, **kwds)
193 else:
194 self.deleted = True
195 self.enacted=None
196 self.save(update_fields=['enacted','deleted'])
197
Tony Mackb0d97422013-06-10 09:57:45 -0400198 @property
199 def keyname(self):
200 return self.email[:self.email.find('@')]
201
Siobhan Tully53437282013-04-26 19:30:27 -0400202 def __unicode__(self):
203 return self.email
204
205 def has_perm(self, perm, obj=None):
206 "Does the user have a specific permission?"
207 # Simplest possible answer: Yes, always
208 return True
209
210 def has_module_perms(self, app_label):
211 "Does the user have permissions to view the app `app_label`?"
212 # Simplest possible answer: Yes, always
213 return True
214
Siobhan Tullybfd11dc2013-09-03 12:59:24 -0400215 def is_superuser(self):
216 return False
Siobhan Tully53437282013-04-26 19:30:27 -0400217
Scott Baker2c3cb642014-05-19 17:55:56 -0700218 def get_dashboards(self):
219 DEFAULT_DASHBOARDS=["Tenant"]
220
Sapan Bhatia6bfa2ca2014-11-11 21:47:45 -0500221 dashboards = sorted(list(self.userdashboardviews.all()), key=attrgetter('order'))
Scott Baker2c3cb642014-05-19 17:55:56 -0700222 dashboards = [x.dashboardView for x in dashboards]
223
224 if not dashboards:
225 for dashboardName in DEFAULT_DASHBOARDS:
226 dbv = DashboardView.objects.filter(name=dashboardName)
227 if dbv:
228 dashboards.append(dbv[0])
229
230 return dashboards
231
Siobhan Tullybfd11dc2013-09-03 12:59:24 -0400232# def get_roles(self):
233# from core.models.site import SitePrivilege
234# from core.models.slice import SliceMembership
235#
236# site_privileges = SitePrivilege.objects.filter(user=self)
237# slice_memberships = SliceMembership.objects.filter(user=self)
238# roles = defaultdict(list)
239# for site_privilege in site_privileges:
240# roles[site_privilege.role.role_type].append(site_privilege.site.login_base)
241# for slice_membership in slice_memberships:
242# roles[slice_membership.role.role_type].append(slice_membership.slice.name)
243# return roles
Siobhan Tully53437282013-04-26 19:30:27 -0400244
Tony Mack53106f32013-04-27 16:43:01 -0400245 def save(self, *args, **kwds):
Siobhan Tully30fd4292013-05-10 08:59:56 -0400246 if not self.id:
Scott Bakera36d77e2014-08-29 11:43:23 -0700247 self.set_password(self.password)
248 if self.is_active:
249 if self.password=="!":
250 self.send_temporary_password()
251
Siobhan Tullyfece0d52013-09-06 12:57:05 -0400252 self.username = self.email
Scott Bakera36d77e2014-08-29 11:43:23 -0700253 super(User, self).save(*args, **kwds)
254
Scott Baker1a6a3902014-10-03 00:32:37 -0700255 self._initial = self._dict
256
Scott Bakera36d77e2014-08-29 11:43:23 -0700257 def send_temporary_password(self):
258 password = User.objects.make_random_password()
259 self.set_password(password)
260 subject, from_email, to = 'OpenCloud Account Credentials', 'support@opencloud.us', str(self.email)
261 text_content = 'This is an important message.'
Scott Baker51e7d402014-08-29 12:32:46 -0700262 userUrl="http://%s/" % get_request().get_host()
Scott Bakera36d77e2014-08-29 11:43:23 -0700263 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>"""
264 msg = EmailMultiAlternatives(subject,text_content, from_email, [to])
265 msg.attach_alternative(html_content, "text/html")
266 msg.send()
Tony Mack5b061472014-02-04 07:57:10 -0500267
Scott Baker1a6a3902014-10-03 00:32:37 -0700268 def can_update(self, user):
269 from core.models import SitePrivilege
Scott Baker1bffe942014-10-06 22:58:48 -0700270 _cant_update_fieldName = None
Scott Baker1a6a3902014-10-03 00:32:37 -0700271 if user.is_readonly:
272 return False
273 if user.is_admin:
274 return True
Scott Baker1a6a3902014-10-03 00:32:37 -0700275 # site pis can update
276 site_privs = SitePrivilege.objects.filter(user=user, site=self.site)
277 for site_priv in site_privs:
278 if site_priv.role.role == 'pi':
Scott Baker1bffe942014-10-06 22:58:48 -0700279 for fieldName in self.diff.keys():
280 if fieldName in self.PI_FORBIDDEN_FIELDS:
281 _cant_update_fieldName = fieldName
282 return False
Scott Baker1a6a3902014-10-03 00:32:37 -0700283 return True
Scott Baker1bffe942014-10-06 22:58:48 -0700284 if (user.id == self.id):
285 for fieldName in self.diff.keys():
286 if fieldName in self.USER_FORBIDDEN_FIELDS:
287 _cant_update_fieldName = fieldName
288 return False
289 return True
Scott Baker1a6a3902014-10-03 00:32:37 -0700290
291 return False
292
Tony Mack5b061472014-02-04 07:57:10 -0500293 @staticmethod
294 def select_by_user(user):
295 if user.is_admin:
296 qs = User.objects.all()
297 else:
298 # can see all users at any site where this user has pi role
299 from core.models.site import SitePrivilege
300 site_privs = SitePrivilege.objects.filter(user=user)
301 sites = [sp.site for sp in site_privs if sp.role.role == 'pi']
302 # get site privs of users at these sites
303 site_privs = SitePrivilege.objects.filter(site__in=sites)
Scott Bakera36d77e2014-08-29 11:43:23 -0700304 user_ids = [sp.user.id for sp in site_privs] + [user.id]
Tony Mack5b061472014-02-04 07:57:10 -0500305 qs = User.objects.filter(Q(site__in=sites) | Q(id__in=user_ids))
Scott Bakera36d77e2014-08-29 11:43:23 -0700306 return qs
Tony Mack5b061472014-02-04 07:57:10 -0500307
Scott Baker1a6a3902014-10-03 00:32:37 -0700308 def save_by_user(self, user, *args, **kwds):
309 if not self.can_update(user):
Scott Baker1bffe942014-10-06 22:58:48 -0700310 if getattr(self, "_cant_update_fieldName", None) is not None:
311 raise PermissionDenied("You do not have permission to update field %s on object %s" % (self._cant_update_fieldName, self.__class__.__name__))
312 else:
313 raise PermissionDenied("You do not have permission to update %s objects" % self.__class__.__name__)
Scott Baker1a6a3902014-10-03 00:32:37 -0700314
315 self.save(*args, **kwds)
316
317 def delete_by_user(self, user, *args, **kwds):
318 if not self.can_update(user):
319 raise PermissionDenied("You do not have permission to delete %s objects" % self.__class__.__name__)
320 self.delete(*args, **kwds)
321
Scott Baker2c3cb642014-05-19 17:55:56 -0700322class UserDashboardView(PlCoreBase):
Sapan Bhatia6bfa2ca2014-11-11 21:47:45 -0500323 user = models.ForeignKey(User, related_name='userdashboardviews')
324 dashboardView = models.ForeignKey(DashboardView, related_name='userdashboardviews')
Scott Baker2c3cb642014-05-19 17:55:56 -0700325 order = models.IntegerField(default=0)