blob: 44e3f145c82521f055c12f18403290700a8bfbcc [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 Baker2c3cb642014-05-19 17:55:56 -07006from core.models import PlCoreBase,Site, DashboardView
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
Siobhan Tully53437282013-04-26 19:30:27 -040011
12# Create your models here.
Siobhan Tully30fd4292013-05-10 08:59:56 -040013class UserManager(BaseUserManager):
Siobhan Tully53437282013-04-26 19:30:27 -040014 def create_user(self, email, firstname, lastname, password=None):
15 """
16 Creates and saves a User with the given email, date of
17 birth and password.
18 """
19 if not email:
20 raise ValueError('Users must have an email address')
21
22 user = self.model(
Siobhan Tully30fd4292013-05-10 08:59:56 -040023 email=UserManager.normalize_email(email),
Siobhan Tully53437282013-04-26 19:30:27 -040024 firstname=firstname,
Siobhan Tully30fd4292013-05-10 08:59:56 -040025 lastname=lastname,
26 password=password
Siobhan Tully53437282013-04-26 19:30:27 -040027 )
Siobhan Tully30fd4292013-05-10 08:59:56 -040028 #user.set_password(password)
Siobhan Tully53437282013-04-26 19:30:27 -040029 user.is_admin = True
30 user.save(using=self._db)
31 return user
32
33 def create_superuser(self, email, firstname, lastname, password):
34 """
35 Creates and saves a superuser with the given email, date of
36 birth and password.
37 """
38 user = self.create_user(email,
39 password=password,
40 firstname=firstname,
41 lastname=lastname
42 )
43 user.is_admin = True
44 user.save(using=self._db)
45 return user
46
Sapan Bhatia5d605ff2014-07-21 20:08:04 -040047class DeletedUserManager(UserManager):
48 def get_query_set(self):
49 return super(UserManager, self).get_query_set().filter(deleted=True)
Siobhan Tully53437282013-04-26 19:30:27 -040050
Siobhan Tully30fd4292013-05-10 08:59:56 -040051class User(AbstractBaseUser):
Siobhan Tully53437282013-04-26 19:30:27 -040052
53 class Meta:
54 app_label = "core"
55
56 email = models.EmailField(
57 verbose_name='email address',
58 max_length=255,
59 unique=True,
60 db_index=True,
61 )
Siobhan Tullyfece0d52013-09-06 12:57:05 -040062
63 username = models.CharField(max_length=255, default="Something" )
64
Siobhan Tully53437282013-04-26 19:30:27 -040065 firstname = models.CharField(help_text="person's given name", max_length=200)
66 lastname = models.CharField(help_text="person's surname", max_length=200)
67
68 phone = models.CharField(null=True, blank=True, help_text="phone number contact", max_length=100)
69 user_url = models.URLField(null=True, blank=True)
Siobhan Tullybfd11dc2013-09-03 12:59:24 -040070 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 -040071 public_key = models.TextField(null=True, blank=True, max_length=1024, help_text="Public key string")
Siobhan Tully53437282013-04-26 19:30:27 -040072
73 is_active = models.BooleanField(default=True)
74 is_admin = models.BooleanField(default=True)
75 is_staff = models.BooleanField(default=True)
Siobhan Tullycf04fb62014-01-11 11:25:57 -050076 is_readonly = models.BooleanField(default=False)
Siobhan Tully53437282013-04-26 19:30:27 -040077
Tony Mack0553f282013-06-10 22:54:50 -040078 created = models.DateTimeField(auto_now_add=True)
79 updated = models.DateTimeField(auto_now=True)
80 enacted = models.DateTimeField(null=True, default=None)
Sapan Bhatia47b9bf22014-04-28 21:09:53 -040081 backend_status = models.CharField(max_length=140,
Sapan Bhatiad507f432014-04-29 00:41:39 -040082 default="Provisioning in progress")
Sapan Bhatiabcc18992014-04-29 10:32:14 -040083 deleted = models.BooleanField(default=False)
Tony Mack0553f282013-06-10 22:54:50 -040084
Scott Baker9266e6b2013-05-19 15:54:48 -070085 timezone = TimeZoneField()
86
Scott Baker2c3cb642014-05-19 17:55:56 -070087 dashboards = models.ManyToManyField('DashboardView', through='UserDashboardView', blank=True)
88
Siobhan Tully30fd4292013-05-10 08:59:56 -040089 objects = UserManager()
Sapan Bhatia5d605ff2014-07-21 20:08:04 -040090 deleted_objects = DeletedUserManager()
Siobhan Tully53437282013-04-26 19:30:27 -040091
92 USERNAME_FIELD = 'email'
93 REQUIRED_FIELDS = ['firstname', 'lastname']
94
Siobhan Tullycf04fb62014-01-11 11:25:57 -050095 def isReadOnlyUser(self):
96 return self.is_readonly
97
Siobhan Tully53437282013-04-26 19:30:27 -040098 def get_full_name(self):
99 # The user is identified by their email address
100 return self.email
101
102 def get_short_name(self):
103 # The user is identified by their email address
104 return self.email
105
Sapan Bhatia5d605ff2014-07-21 20:08:04 -0400106 def delete(self, *args, **kwds):
107 # so we have something to give the observer
108 purge = kwds.get('purge',False)
109 try:
110 purge = purge or observer_disabled
111 except NameError:
112 pass
113
114 if (purge):
115 super(User, self).delete(*args, **kwds)
116 else:
117 self.deleted = True
118 self.enacted=None
119 self.save(update_fields=['enacted','deleted'])
120
Tony Mackb0d97422013-06-10 09:57:45 -0400121 @property
122 def keyname(self):
123 return self.email[:self.email.find('@')]
124
Siobhan Tully53437282013-04-26 19:30:27 -0400125 def __unicode__(self):
126 return self.email
127
128 def has_perm(self, perm, obj=None):
129 "Does the user have a specific permission?"
130 # Simplest possible answer: Yes, always
131 return True
132
133 def has_module_perms(self, app_label):
134 "Does the user have permissions to view the app `app_label`?"
135 # Simplest possible answer: Yes, always
136 return True
137
Siobhan Tullybfd11dc2013-09-03 12:59:24 -0400138 def is_superuser(self):
139 return False
Siobhan Tully53437282013-04-26 19:30:27 -0400140
Scott Baker2c3cb642014-05-19 17:55:56 -0700141 def get_dashboards(self):
142 DEFAULT_DASHBOARDS=["Tenant"]
143
144 dashboards = sorted(list(self.dashboardViews.all()), key=attrgetter('order'))
145 dashboards = [x.dashboardView for x in dashboards]
146
147 if not dashboards:
148 for dashboardName in DEFAULT_DASHBOARDS:
149 dbv = DashboardView.objects.filter(name=dashboardName)
150 if dbv:
151 dashboards.append(dbv[0])
152
153 return dashboards
154
Siobhan Tullybfd11dc2013-09-03 12:59:24 -0400155# def get_roles(self):
156# from core.models.site import SitePrivilege
157# from core.models.slice import SliceMembership
158#
159# site_privileges = SitePrivilege.objects.filter(user=self)
160# slice_memberships = SliceMembership.objects.filter(user=self)
161# roles = defaultdict(list)
162# for site_privilege in site_privileges:
163# roles[site_privilege.role.role_type].append(site_privilege.site.login_base)
164# for slice_membership in slice_memberships:
165# roles[slice_membership.role.role_type].append(slice_membership.slice.name)
166# return roles
Siobhan Tully53437282013-04-26 19:30:27 -0400167
Tony Mack53106f32013-04-27 16:43:01 -0400168 def save(self, *args, **kwds):
Siobhan Tully30fd4292013-05-10 08:59:56 -0400169 if not self.id:
170 self.set_password(self.password)
Siobhan Tullyfece0d52013-09-06 12:57:05 -0400171 self.username = self.email
Tony Mack5b061472014-02-04 07:57:10 -0500172 super(User, self).save(*args, **kwds)
173
174 @staticmethod
175 def select_by_user(user):
176 if user.is_admin:
177 qs = User.objects.all()
178 else:
179 # can see all users at any site where this user has pi role
180 from core.models.site import SitePrivilege
181 site_privs = SitePrivilege.objects.filter(user=user)
182 sites = [sp.site for sp in site_privs if sp.role.role == 'pi']
183 # get site privs of users at these sites
184 site_privs = SitePrivilege.objects.filter(site__in=sites)
185 user_ids = [sp.user.id for sp in site_privs] + [user.id]
186 qs = User.objects.filter(Q(site__in=sites) | Q(id__in=user_ids))
187 return qs
188
Scott Baker2c3cb642014-05-19 17:55:56 -0700189class UserDashboardView(PlCoreBase):
190 user = models.ForeignKey(User, related_name="dashboardViews")
191 dashboardView = models.ForeignKey(DashboardView, related_name="dashboardViews")
192 order = models.IntegerField(default=0)