blob: 5a73ad77719a0bbba7bf6cbf3b047e5e0813f9fd [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 Bakercbfb6002014-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 Bhatiabad67742014-09-04 00:39:19 -040013import model_policy
Scott Bakercbfb6002014-10-03 00:32:37 -070014from django.core.exceptions import PermissionDenied
Siobhan Tully53437282013-04-26 19:30:27 -040015
16# Create your models here.
Siobhan Tully30fd4292013-05-10 08:59:56 -040017class UserManager(BaseUserManager):
Siobhan Tully53437282013-04-26 19:30:27 -040018 def create_user(self, email, firstname, lastname, password=None):
19 """
20 Creates and saves a User with the given email, date of
21 birth and password.
22 """
23 if not email:
24 raise ValueError('Users must have an email address')
25
26 user = self.model(
Siobhan Tully30fd4292013-05-10 08:59:56 -040027 email=UserManager.normalize_email(email),
Siobhan Tully53437282013-04-26 19:30:27 -040028 firstname=firstname,
Siobhan Tully30fd4292013-05-10 08:59:56 -040029 lastname=lastname,
30 password=password
Siobhan Tully53437282013-04-26 19:30:27 -040031 )
Siobhan Tully30fd4292013-05-10 08:59:56 -040032 #user.set_password(password)
Siobhan Tully53437282013-04-26 19:30:27 -040033 user.is_admin = True
34 user.save(using=self._db)
35 return user
36
37 def create_superuser(self, email, firstname, lastname, password):
38 """
39 Creates and saves a superuser with the given email, date of
40 birth and password.
41 """
42 user = self.create_user(email,
43 password=password,
44 firstname=firstname,
45 lastname=lastname
46 )
47 user.is_admin = True
48 user.save(using=self._db)
49 return user
50
Sapan Bhatia5d605ff2014-07-21 20:08:04 -040051class DeletedUserManager(UserManager):
Scott Bakerb08d6562014-09-12 12:57:27 -070052 def get_queryset(self):
Sapan Bhatia5d605ff2014-07-21 20:08:04 -040053 return super(UserManager, self).get_query_set().filter(deleted=True)
Siobhan Tully53437282013-04-26 19:30:27 -040054
Scott Bakerb08d6562014-09-12 12:57:27 -070055 # deprecated in django 1.7 in favor of get_queryset()
56 def get_query_set(self):
57 return self.get_queryset()
58
Scott Bakercbfb6002014-10-03 00:32:37 -070059class User(AbstractBaseUser, DiffModelMixIn):
Siobhan Tully53437282013-04-26 19:30:27 -040060
61 class Meta:
62 app_label = "core"
63
64 email = models.EmailField(
65 verbose_name='email address',
66 max_length=255,
67 unique=True,
68 db_index=True,
69 )
Siobhan Tullyfece0d52013-09-06 12:57:05 -040070
71 username = models.CharField(max_length=255, default="Something" )
72
Siobhan Tully53437282013-04-26 19:30:27 -040073 firstname = models.CharField(help_text="person's given name", max_length=200)
74 lastname = models.CharField(help_text="person's surname", max_length=200)
75
76 phone = models.CharField(null=True, blank=True, help_text="phone number contact", max_length=100)
77 user_url = models.URLField(null=True, blank=True)
Siobhan Tullybfd11dc2013-09-03 12:59:24 -040078 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 -040079 public_key = models.TextField(null=True, blank=True, max_length=1024, help_text="Public key string")
Siobhan Tully53437282013-04-26 19:30:27 -040080
81 is_active = models.BooleanField(default=True)
82 is_admin = models.BooleanField(default=True)
83 is_staff = models.BooleanField(default=True)
Siobhan Tullycf04fb62014-01-11 11:25:57 -050084 is_readonly = models.BooleanField(default=False)
Siobhan Tully53437282013-04-26 19:30:27 -040085
Tony Mack0553f282013-06-10 22:54:50 -040086 created = models.DateTimeField(auto_now_add=True)
87 updated = models.DateTimeField(auto_now=True)
88 enacted = models.DateTimeField(null=True, default=None)
Sapan Bhatia47b9bf22014-04-28 21:09:53 -040089 backend_status = models.CharField(max_length=140,
Sapan Bhatiad507f432014-04-29 00:41:39 -040090 default="Provisioning in progress")
Sapan Bhatiabcc18992014-04-29 10:32:14 -040091 deleted = models.BooleanField(default=False)
Tony Mack0553f282013-06-10 22:54:50 -040092
Scott Baker9266e6b2013-05-19 15:54:48 -070093 timezone = TimeZoneField()
94
Scott Baker2c3cb642014-05-19 17:55:56 -070095 dashboards = models.ManyToManyField('DashboardView', through='UserDashboardView', blank=True)
96
Siobhan Tully30fd4292013-05-10 08:59:56 -040097 objects = UserManager()
Sapan Bhatia5d605ff2014-07-21 20:08:04 -040098 deleted_objects = DeletedUserManager()
Siobhan Tully53437282013-04-26 19:30:27 -040099
100 USERNAME_FIELD = 'email'
101 REQUIRED_FIELDS = ['firstname', 'lastname']
102
Scott Baker0119c152014-10-06 22:58:48 -0700103 PI_FORBIDDEN_FIELDS = ["is_admin", "site", "is_staff"]
104 USER_FORBIDDEN_FIELDS = ["is_admin", "is_active", "site", "is_staff", "is_readonly"]
105
Scott Bakercbfb6002014-10-03 00:32:37 -0700106 def __init__(self, *args, **kwargs):
107 super(User, self).__init__(*args, **kwargs)
108 self._initial = self._dict # for DiffModelMixIn
109
Siobhan Tullycf04fb62014-01-11 11:25:57 -0500110 def isReadOnlyUser(self):
111 return self.is_readonly
112
Siobhan Tully53437282013-04-26 19:30:27 -0400113 def get_full_name(self):
114 # The user is identified by their email address
115 return self.email
116
117 def get_short_name(self):
118 # The user is identified by their email address
119 return self.email
120
Sapan Bhatia5d605ff2014-07-21 20:08:04 -0400121 def delete(self, *args, **kwds):
122 # so we have something to give the observer
123 purge = kwds.get('purge',False)
124 try:
125 purge = purge or observer_disabled
126 except NameError:
127 pass
128
129 if (purge):
130 super(User, self).delete(*args, **kwds)
131 else:
132 self.deleted = True
133 self.enacted=None
134 self.save(update_fields=['enacted','deleted'])
135
Tony Mackb0d97422013-06-10 09:57:45 -0400136 @property
137 def keyname(self):
138 return self.email[:self.email.find('@')]
139
Siobhan Tully53437282013-04-26 19:30:27 -0400140 def __unicode__(self):
141 return self.email
142
143 def has_perm(self, perm, obj=None):
144 "Does the user have a specific permission?"
145 # Simplest possible answer: Yes, always
146 return True
147
148 def has_module_perms(self, app_label):
149 "Does the user have permissions to view the app `app_label`?"
150 # Simplest possible answer: Yes, always
151 return True
152
Siobhan Tullybfd11dc2013-09-03 12:59:24 -0400153 def is_superuser(self):
154 return False
Siobhan Tully53437282013-04-26 19:30:27 -0400155
Scott Baker2c3cb642014-05-19 17:55:56 -0700156 def get_dashboards(self):
157 DEFAULT_DASHBOARDS=["Tenant"]
158
159 dashboards = sorted(list(self.dashboardViews.all()), key=attrgetter('order'))
160 dashboards = [x.dashboardView for x in dashboards]
161
162 if not dashboards:
163 for dashboardName in DEFAULT_DASHBOARDS:
164 dbv = DashboardView.objects.filter(name=dashboardName)
165 if dbv:
166 dashboards.append(dbv[0])
167
168 return dashboards
169
Siobhan Tullybfd11dc2013-09-03 12:59:24 -0400170# def get_roles(self):
171# from core.models.site import SitePrivilege
172# from core.models.slice import SliceMembership
173#
174# site_privileges = SitePrivilege.objects.filter(user=self)
175# slice_memberships = SliceMembership.objects.filter(user=self)
176# roles = defaultdict(list)
177# for site_privilege in site_privileges:
178# roles[site_privilege.role.role_type].append(site_privilege.site.login_base)
179# for slice_membership in slice_memberships:
180# roles[slice_membership.role.role_type].append(slice_membership.slice.name)
181# return roles
Siobhan Tully53437282013-04-26 19:30:27 -0400182
Tony Mack53106f32013-04-27 16:43:01 -0400183 def save(self, *args, **kwds):
Siobhan Tully30fd4292013-05-10 08:59:56 -0400184 if not self.id:
Scott Bakera36d77e2014-08-29 11:43:23 -0700185 self.set_password(self.password)
186 if self.is_active:
187 if self.password=="!":
188 self.send_temporary_password()
189
Siobhan Tullyfece0d52013-09-06 12:57:05 -0400190 self.username = self.email
Scott Bakera36d77e2014-08-29 11:43:23 -0700191 super(User, self).save(*args, **kwds)
192
Scott Bakercbfb6002014-10-03 00:32:37 -0700193 self._initial = self._dict
194
Scott Bakera36d77e2014-08-29 11:43:23 -0700195 def send_temporary_password(self):
196 password = User.objects.make_random_password()
197 self.set_password(password)
198 subject, from_email, to = 'OpenCloud Account Credentials', 'support@opencloud.us', str(self.email)
199 text_content = 'This is an important message.'
Scott Baker51e7d402014-08-29 12:32:46 -0700200 userUrl="http://%s/" % get_request().get_host()
Scott Bakera36d77e2014-08-29 11:43:23 -0700201 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>"""
202 msg = EmailMultiAlternatives(subject,text_content, from_email, [to])
203 msg.attach_alternative(html_content, "text/html")
204 msg.send()
Tony Mack5b061472014-02-04 07:57:10 -0500205
Scott Bakercbfb6002014-10-03 00:32:37 -0700206 def can_update(self, user):
207 from core.models import SitePrivilege
Scott Baker0119c152014-10-06 22:58:48 -0700208 _cant_update_fieldName = None
Scott Bakercbfb6002014-10-03 00:32:37 -0700209 if user.is_readonly:
210 return False
211 if user.is_admin:
212 return True
Scott Bakercbfb6002014-10-03 00:32:37 -0700213 # site pis can update
214 site_privs = SitePrivilege.objects.filter(user=user, site=self.site)
215 for site_priv in site_privs:
216 if site_priv.role.role == 'pi':
Scott Baker0119c152014-10-06 22:58:48 -0700217 for fieldName in self.diff.keys():
218 if fieldName in self.PI_FORBIDDEN_FIELDS:
219 _cant_update_fieldName = fieldName
220 return False
Scott Bakercbfb6002014-10-03 00:32:37 -0700221 return True
Scott Baker0119c152014-10-06 22:58:48 -0700222 if (user.id == self.id):
223 for fieldName in self.diff.keys():
224 if fieldName in self.USER_FORBIDDEN_FIELDS:
225 _cant_update_fieldName = fieldName
226 return False
227 return True
Scott Bakercbfb6002014-10-03 00:32:37 -0700228
229 return False
230
Tony Mack5b061472014-02-04 07:57:10 -0500231 @staticmethod
232 def select_by_user(user):
233 if user.is_admin:
234 qs = User.objects.all()
235 else:
236 # can see all users at any site where this user has pi role
237 from core.models.site import SitePrivilege
238 site_privs = SitePrivilege.objects.filter(user=user)
239 sites = [sp.site for sp in site_privs if sp.role.role == 'pi']
240 # get site privs of users at these sites
241 site_privs = SitePrivilege.objects.filter(site__in=sites)
Scott Bakera36d77e2014-08-29 11:43:23 -0700242 user_ids = [sp.user.id for sp in site_privs] + [user.id]
Tony Mack5b061472014-02-04 07:57:10 -0500243 qs = User.objects.filter(Q(site__in=sites) | Q(id__in=user_ids))
Scott Bakera36d77e2014-08-29 11:43:23 -0700244 return qs
Tony Mack5b061472014-02-04 07:57:10 -0500245
Scott Bakercbfb6002014-10-03 00:32:37 -0700246 def save_by_user(self, user, *args, **kwds):
247 if not self.can_update(user):
Scott Baker0119c152014-10-06 22:58:48 -0700248 if getattr(self, "_cant_update_fieldName", None) is not None:
249 raise PermissionDenied("You do not have permission to update field %s on object %s" % (self._cant_update_fieldName, self.__class__.__name__))
250 else:
251 raise PermissionDenied("You do not have permission to update %s objects" % self.__class__.__name__)
Scott Bakercbfb6002014-10-03 00:32:37 -0700252
253 self.save(*args, **kwds)
254
255 def delete_by_user(self, user, *args, **kwds):
256 if not self.can_update(user):
257 raise PermissionDenied("You do not have permission to delete %s objects" % self.__class__.__name__)
258 self.delete(*args, **kwds)
259
Scott Baker2c3cb642014-05-19 17:55:56 -0700260class UserDashboardView(PlCoreBase):
261 user = models.ForeignKey(User, related_name="dashboardViews")
262 dashboardView = models.ForeignKey(DashboardView, related_name="dashboardViews")
263 order = models.IntegerField(default=0)