blob: 42ea652bab0a6f2e0a20bb0d3515d76984a04122 [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
Siobhan Tully30fd4292013-05-10 08:59:56 -04007from django.contrib.auth.models import AbstractBaseUser, BaseUserManager
Scott Baker9266e6b2013-05-19 15:54:48 -07008from timezones.fields import TimeZoneField
Scott Baker2c3cb642014-05-19 17:55:56 -07009from operator import itemgetter, attrgetter
Scott Bakera36d77e2014-08-29 11:43:23 -070010from django.core.mail import EmailMultiAlternatives
11from core.middleware import get_request
Sapan Bhatia39097192014-09-04 00:39:19 -040012import model_policy
Scott Baker1a6a3902014-10-03 00:32:37 -070013from django.core.exceptions import PermissionDenied
Siobhan Tully53437282013-04-26 19:30:27 -040014
Scott Bakerd29431b2014-10-09 16:16:02 -070015# ------ from plcorebase.py ------
16try:
17 # This is a no-op if observer_disabled is set to 1 in the config file
18 from observer import *
19except:
20 print >> sys.stderr, "import of observer failed! printing traceback and disabling observer:"
21 import traceback
22 traceback.print_exc()
23
24 # guard against something failing
25 def notify_observer(*args, **kwargs):
26 pass
27# ------ ------
28
Siobhan Tully53437282013-04-26 19:30:27 -040029# Create your models here.
Siobhan Tully30fd4292013-05-10 08:59:56 -040030class UserManager(BaseUserManager):
Siobhan Tully53437282013-04-26 19:30:27 -040031 def create_user(self, email, firstname, lastname, password=None):
32 """
33 Creates and saves a User with the given email, date of
34 birth and password.
35 """
36 if not email:
37 raise ValueError('Users must have an email address')
38
39 user = self.model(
Siobhan Tully30fd4292013-05-10 08:59:56 -040040 email=UserManager.normalize_email(email),
Siobhan Tully53437282013-04-26 19:30:27 -040041 firstname=firstname,
Siobhan Tully30fd4292013-05-10 08:59:56 -040042 lastname=lastname,
43 password=password
Siobhan Tully53437282013-04-26 19:30:27 -040044 )
Siobhan Tully30fd4292013-05-10 08:59:56 -040045 #user.set_password(password)
Siobhan Tully53437282013-04-26 19:30:27 -040046 user.is_admin = True
47 user.save(using=self._db)
48 return user
49
50 def create_superuser(self, email, firstname, lastname, password):
51 """
52 Creates and saves a superuser with the given email, date of
53 birth and password.
54 """
55 user = self.create_user(email,
56 password=password,
57 firstname=firstname,
58 lastname=lastname
59 )
60 user.is_admin = True
61 user.save(using=self._db)
62 return user
63
Scott Bakerf22e73a2014-10-17 18:45:00 -070064 def get_queryset(self):
65 parent=super(UserManager, self)
66 if hasattr(parent, "get_queryset"):
67 return parent.get_queryset().filter(deleted=False)
68 else:
69 return parent.get_query_set().filter(deleted=False)
70
71 # deprecated in django 1.7 in favor of get_queryset().
72 def get_query_set(self):
73 return self.get_queryset()
74
Sapan Bhatia5d605ff2014-07-21 20:08:04 -040075class DeletedUserManager(UserManager):
Scott Baker92f14222014-09-12 12:57:27 -070076 def get_queryset(self):
Sapan Bhatia5d605ff2014-07-21 20:08:04 -040077 return super(UserManager, self).get_query_set().filter(deleted=True)
Siobhan Tully53437282013-04-26 19:30:27 -040078
Scott Baker92f14222014-09-12 12:57:27 -070079 # deprecated in django 1.7 in favor of get_queryset()
80 def get_query_set(self):
81 return self.get_queryset()
82
Scott Baker1a6a3902014-10-03 00:32:37 -070083class User(AbstractBaseUser, DiffModelMixIn):
Siobhan Tully53437282013-04-26 19:30:27 -040084
85 class Meta:
86 app_label = "core"
87
88 email = models.EmailField(
89 verbose_name='email address',
90 max_length=255,
91 unique=True,
92 db_index=True,
93 )
Siobhan Tullyfece0d52013-09-06 12:57:05 -040094
95 username = models.CharField(max_length=255, default="Something" )
96
Siobhan Tully53437282013-04-26 19:30:27 -040097 firstname = models.CharField(help_text="person's given name", max_length=200)
98 lastname = models.CharField(help_text="person's surname", max_length=200)
99
100 phone = models.CharField(null=True, blank=True, help_text="phone number contact", max_length=100)
101 user_url = models.URLField(null=True, blank=True)
Siobhan Tullybfd11dc2013-09-03 12:59:24 -0400102 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 -0400103 public_key = models.TextField(null=True, blank=True, max_length=1024, help_text="Public key string")
Siobhan Tully53437282013-04-26 19:30:27 -0400104
105 is_active = models.BooleanField(default=True)
106 is_admin = models.BooleanField(default=True)
107 is_staff = models.BooleanField(default=True)
Siobhan Tullycf04fb62014-01-11 11:25:57 -0500108 is_readonly = models.BooleanField(default=False)
Siobhan Tully53437282013-04-26 19:30:27 -0400109
Tony Mack0553f282013-06-10 22:54:50 -0400110 created = models.DateTimeField(auto_now_add=True)
111 updated = models.DateTimeField(auto_now=True)
112 enacted = models.DateTimeField(null=True, default=None)
Sapan Bhatia47b9bf22014-04-28 21:09:53 -0400113 backend_status = models.CharField(max_length=140,
Sapan Bhatiad507f432014-04-29 00:41:39 -0400114 default="Provisioning in progress")
Sapan Bhatiabcc18992014-04-29 10:32:14 -0400115 deleted = models.BooleanField(default=False)
Tony Mack0553f282013-06-10 22:54:50 -0400116
Scott Baker9266e6b2013-05-19 15:54:48 -0700117 timezone = TimeZoneField()
118
Scott Baker2c3cb642014-05-19 17:55:56 -0700119 dashboards = models.ManyToManyField('DashboardView', through='UserDashboardView', blank=True)
120
Siobhan Tully30fd4292013-05-10 08:59:56 -0400121 objects = UserManager()
Sapan Bhatia5d605ff2014-07-21 20:08:04 -0400122 deleted_objects = DeletedUserManager()
Siobhan Tully53437282013-04-26 19:30:27 -0400123
124 USERNAME_FIELD = 'email'
125 REQUIRED_FIELDS = ['firstname', 'lastname']
126
Scott Baker1bffe942014-10-06 22:58:48 -0700127 PI_FORBIDDEN_FIELDS = ["is_admin", "site", "is_staff"]
128 USER_FORBIDDEN_FIELDS = ["is_admin", "is_active", "site", "is_staff", "is_readonly"]
129
Scott Baker1a6a3902014-10-03 00:32:37 -0700130 def __init__(self, *args, **kwargs):
131 super(User, self).__init__(*args, **kwargs)
132 self._initial = self._dict # for DiffModelMixIn
133
Siobhan Tullycf04fb62014-01-11 11:25:57 -0500134 def isReadOnlyUser(self):
135 return self.is_readonly
136
Siobhan Tully53437282013-04-26 19:30:27 -0400137 def get_full_name(self):
138 # The user is identified by their email address
139 return self.email
140
141 def get_short_name(self):
142 # The user is identified by their email address
143 return self.email
144
Sapan Bhatia5d605ff2014-07-21 20:08:04 -0400145 def delete(self, *args, **kwds):
146 # so we have something to give the observer
147 purge = kwds.get('purge',False)
Scott Baker3d2d3e42014-10-09 16:22:00 -0700148 if purge:
149 del kwds['purge']
Sapan Bhatia5d605ff2014-07-21 20:08:04 -0400150 try:
151 purge = purge or observer_disabled
152 except NameError:
153 pass
154
155 if (purge):
156 super(User, self).delete(*args, **kwds)
157 else:
158 self.deleted = True
159 self.enacted=None
160 self.save(update_fields=['enacted','deleted'])
161
Tony Mackb0d97422013-06-10 09:57:45 -0400162 @property
163 def keyname(self):
164 return self.email[:self.email.find('@')]
165
Siobhan Tully53437282013-04-26 19:30:27 -0400166 def __unicode__(self):
167 return self.email
168
169 def has_perm(self, perm, obj=None):
170 "Does the user have a specific permission?"
171 # Simplest possible answer: Yes, always
172 return True
173
174 def has_module_perms(self, app_label):
175 "Does the user have permissions to view the app `app_label`?"
176 # Simplest possible answer: Yes, always
177 return True
178
Siobhan Tullybfd11dc2013-09-03 12:59:24 -0400179 def is_superuser(self):
180 return False
Siobhan Tully53437282013-04-26 19:30:27 -0400181
Scott Baker2c3cb642014-05-19 17:55:56 -0700182 def get_dashboards(self):
183 DEFAULT_DASHBOARDS=["Tenant"]
184
Sapan Bhatia6bfa2ca2014-11-11 21:47:45 -0500185 dashboards = sorted(list(self.userdashboardviews.all()), key=attrgetter('order'))
Scott Baker2c3cb642014-05-19 17:55:56 -0700186 dashboards = [x.dashboardView for x in dashboards]
187
188 if not dashboards:
189 for dashboardName in DEFAULT_DASHBOARDS:
190 dbv = DashboardView.objects.filter(name=dashboardName)
191 if dbv:
192 dashboards.append(dbv[0])
193
194 return dashboards
195
Siobhan Tullybfd11dc2013-09-03 12:59:24 -0400196# def get_roles(self):
197# from core.models.site import SitePrivilege
198# from core.models.slice import SliceMembership
199#
200# site_privileges = SitePrivilege.objects.filter(user=self)
201# slice_memberships = SliceMembership.objects.filter(user=self)
202# roles = defaultdict(list)
203# for site_privilege in site_privileges:
204# roles[site_privilege.role.role_type].append(site_privilege.site.login_base)
205# for slice_membership in slice_memberships:
206# roles[slice_membership.role.role_type].append(slice_membership.slice.name)
207# return roles
Siobhan Tully53437282013-04-26 19:30:27 -0400208
Tony Mack53106f32013-04-27 16:43:01 -0400209 def save(self, *args, **kwds):
Siobhan Tully30fd4292013-05-10 08:59:56 -0400210 if not self.id:
Scott Bakera36d77e2014-08-29 11:43:23 -0700211 self.set_password(self.password)
212 if self.is_active:
213 if self.password=="!":
214 self.send_temporary_password()
215
Siobhan Tullyfece0d52013-09-06 12:57:05 -0400216 self.username = self.email
Scott Bakera36d77e2014-08-29 11:43:23 -0700217 super(User, self).save(*args, **kwds)
218
Scott Baker1a6a3902014-10-03 00:32:37 -0700219 self._initial = self._dict
220
Scott Bakera36d77e2014-08-29 11:43:23 -0700221 def send_temporary_password(self):
222 password = User.objects.make_random_password()
223 self.set_password(password)
224 subject, from_email, to = 'OpenCloud Account Credentials', 'support@opencloud.us', str(self.email)
225 text_content = 'This is an important message.'
Scott Baker51e7d402014-08-29 12:32:46 -0700226 userUrl="http://%s/" % get_request().get_host()
Scott Bakera36d77e2014-08-29 11:43:23 -0700227 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>"""
228 msg = EmailMultiAlternatives(subject,text_content, from_email, [to])
229 msg.attach_alternative(html_content, "text/html")
230 msg.send()
Tony Mack5b061472014-02-04 07:57:10 -0500231
Scott Baker1a6a3902014-10-03 00:32:37 -0700232 def can_update(self, user):
233 from core.models import SitePrivilege
Scott Baker1bffe942014-10-06 22:58:48 -0700234 _cant_update_fieldName = None
Scott Baker1a6a3902014-10-03 00:32:37 -0700235 if user.is_readonly:
236 return False
237 if user.is_admin:
238 return True
Scott Baker1a6a3902014-10-03 00:32:37 -0700239 # site pis can update
240 site_privs = SitePrivilege.objects.filter(user=user, site=self.site)
241 for site_priv in site_privs:
242 if site_priv.role.role == 'pi':
Scott Baker1bffe942014-10-06 22:58:48 -0700243 for fieldName in self.diff.keys():
244 if fieldName in self.PI_FORBIDDEN_FIELDS:
245 _cant_update_fieldName = fieldName
246 return False
Scott Baker1a6a3902014-10-03 00:32:37 -0700247 return True
Scott Baker1bffe942014-10-06 22:58:48 -0700248 if (user.id == self.id):
249 for fieldName in self.diff.keys():
250 if fieldName in self.USER_FORBIDDEN_FIELDS:
251 _cant_update_fieldName = fieldName
252 return False
253 return True
Scott Baker1a6a3902014-10-03 00:32:37 -0700254
255 return False
256
Tony Mack5b061472014-02-04 07:57:10 -0500257 @staticmethod
258 def select_by_user(user):
259 if user.is_admin:
260 qs = User.objects.all()
261 else:
262 # can see all users at any site where this user has pi role
263 from core.models.site import SitePrivilege
264 site_privs = SitePrivilege.objects.filter(user=user)
265 sites = [sp.site for sp in site_privs if sp.role.role == 'pi']
266 # get site privs of users at these sites
267 site_privs = SitePrivilege.objects.filter(site__in=sites)
Scott Bakera36d77e2014-08-29 11:43:23 -0700268 user_ids = [sp.user.id for sp in site_privs] + [user.id]
Tony Mack5b061472014-02-04 07:57:10 -0500269 qs = User.objects.filter(Q(site__in=sites) | Q(id__in=user_ids))
Scott Bakera36d77e2014-08-29 11:43:23 -0700270 return qs
Tony Mack5b061472014-02-04 07:57:10 -0500271
Scott Baker1a6a3902014-10-03 00:32:37 -0700272 def save_by_user(self, user, *args, **kwds):
273 if not self.can_update(user):
Scott Baker1bffe942014-10-06 22:58:48 -0700274 if getattr(self, "_cant_update_fieldName", None) is not None:
275 raise PermissionDenied("You do not have permission to update field %s on object %s" % (self._cant_update_fieldName, self.__class__.__name__))
276 else:
277 raise PermissionDenied("You do not have permission to update %s objects" % self.__class__.__name__)
Scott Baker1a6a3902014-10-03 00:32:37 -0700278
279 self.save(*args, **kwds)
280
281 def delete_by_user(self, user, *args, **kwds):
282 if not self.can_update(user):
283 raise PermissionDenied("You do not have permission to delete %s objects" % self.__class__.__name__)
284 self.delete(*args, **kwds)
285
Scott Baker2c3cb642014-05-19 17:55:56 -0700286class UserDashboardView(PlCoreBase):
Sapan Bhatia6bfa2ca2014-11-11 21:47:45 -0500287 user = models.ForeignKey(User, related_name='userdashboardviews')
288 dashboardView = models.ForeignKey(DashboardView, related_name='userdashboardviews')
Scott Baker2c3cb642014-05-19 17:55:56 -0700289 order = models.IntegerField(default=0)