blob: 6e7eef6662c679b0e8466442119519318dd1d07a [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
Tony Macke4be32f2014-03-11 20:45:25 -04007from core.models.deployment 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
47
Siobhan Tully30fd4292013-05-10 08:59:56 -040048class User(AbstractBaseUser):
Siobhan Tully53437282013-04-26 19:30:27 -040049
50 class Meta:
51 app_label = "core"
52
53 email = models.EmailField(
54 verbose_name='email address',
55 max_length=255,
56 unique=True,
57 db_index=True,
58 )
Siobhan Tullyfece0d52013-09-06 12:57:05 -040059
60 username = models.CharField(max_length=255, default="Something" )
61
Siobhan Tully53437282013-04-26 19:30:27 -040062 firstname = models.CharField(help_text="person's given name", max_length=200)
63 lastname = models.CharField(help_text="person's surname", max_length=200)
64
65 phone = models.CharField(null=True, blank=True, help_text="phone number contact", max_length=100)
66 user_url = models.URLField(null=True, blank=True)
Siobhan Tullybfd11dc2013-09-03 12:59:24 -040067 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 -040068 public_key = models.TextField(null=True, blank=True, max_length=1024, help_text="Public key string")
Siobhan Tully53437282013-04-26 19:30:27 -040069
70 is_active = models.BooleanField(default=True)
71 is_admin = models.BooleanField(default=True)
72 is_staff = models.BooleanField(default=True)
Siobhan Tullycf04fb62014-01-11 11:25:57 -050073 is_readonly = models.BooleanField(default=False)
Siobhan Tully53437282013-04-26 19:30:27 -040074
Tony Mack0553f282013-06-10 22:54:50 -040075 created = models.DateTimeField(auto_now_add=True)
76 updated = models.DateTimeField(auto_now=True)
77 enacted = models.DateTimeField(null=True, default=None)
78
Scott Baker9266e6b2013-05-19 15:54:48 -070079 timezone = TimeZoneField()
80
Scott Baker2c3cb642014-05-19 17:55:56 -070081 dashboards = models.ManyToManyField('DashboardView', through='UserDashboardView', blank=True)
82
Siobhan Tully30fd4292013-05-10 08:59:56 -040083 objects = UserManager()
Siobhan Tully53437282013-04-26 19:30:27 -040084
85 USERNAME_FIELD = 'email'
86 REQUIRED_FIELDS = ['firstname', 'lastname']
87
Siobhan Tullycf04fb62014-01-11 11:25:57 -050088 def isReadOnlyUser(self):
89 return self.is_readonly
90
Siobhan Tully53437282013-04-26 19:30:27 -040091 def get_full_name(self):
92 # The user is identified by their email address
93 return self.email
94
95 def get_short_name(self):
96 # The user is identified by their email address
97 return self.email
98
Tony Mackb0d97422013-06-10 09:57:45 -040099 @property
100 def keyname(self):
101 return self.email[:self.email.find('@')]
102
Siobhan Tully53437282013-04-26 19:30:27 -0400103 def __unicode__(self):
104 return self.email
105
106 def has_perm(self, perm, obj=None):
107 "Does the user have a specific permission?"
108 # Simplest possible answer: Yes, always
109 return True
110
111 def has_module_perms(self, app_label):
112 "Does the user have permissions to view the app `app_label`?"
113 # Simplest possible answer: Yes, always
114 return True
115
Siobhan Tullybfd11dc2013-09-03 12:59:24 -0400116 def is_superuser(self):
117 return False
Siobhan Tully53437282013-04-26 19:30:27 -0400118
Scott Baker2c3cb642014-05-19 17:55:56 -0700119 def get_dashboards(self):
120 DEFAULT_DASHBOARDS=["Tenant"]
121
122 dashboards = sorted(list(self.dashboardViews.all()), key=attrgetter('order'))
123 dashboards = [x.dashboardView for x in dashboards]
124
125 if not dashboards:
126 for dashboardName in DEFAULT_DASHBOARDS:
127 dbv = DashboardView.objects.filter(name=dashboardName)
128 if dbv:
129 dashboards.append(dbv[0])
130
131 return dashboards
132
Siobhan Tullybfd11dc2013-09-03 12:59:24 -0400133# def get_roles(self):
134# from core.models.site import SitePrivilege
135# from core.models.slice import SliceMembership
136#
137# site_privileges = SitePrivilege.objects.filter(user=self)
138# slice_memberships = SliceMembership.objects.filter(user=self)
139# roles = defaultdict(list)
140# for site_privilege in site_privileges:
141# roles[site_privilege.role.role_type].append(site_privilege.site.login_base)
142# for slice_membership in slice_memberships:
143# roles[slice_membership.role.role_type].append(slice_membership.slice.name)
144# return roles
Siobhan Tully53437282013-04-26 19:30:27 -0400145
Tony Mack53106f32013-04-27 16:43:01 -0400146 def save(self, *args, **kwds):
Siobhan Tully30fd4292013-05-10 08:59:56 -0400147 if not self.id:
148 self.set_password(self.password)
Siobhan Tullyfece0d52013-09-06 12:57:05 -0400149 self.username = self.email
Tony Mack5b061472014-02-04 07:57:10 -0500150 super(User, self).save(*args, **kwds)
151
152 @staticmethod
153 def select_by_user(user):
154 if user.is_admin:
155 qs = User.objects.all()
156 else:
157 # can see all users at any site where this user has pi role
158 from core.models.site import SitePrivilege
159 site_privs = SitePrivilege.objects.filter(user=user)
160 sites = [sp.site for sp in site_privs if sp.role.role == 'pi']
161 # get site privs of users at these sites
162 site_privs = SitePrivilege.objects.filter(site__in=sites)
163 user_ids = [sp.user.id for sp in site_privs] + [user.id]
164 qs = User.objects.filter(Q(site__in=sites) | Q(id__in=user_ids))
165 return qs
166
167
Tony Macke4be32f2014-03-11 20:45:25 -0400168
169class UserDeployments(PlCoreBase):
170 user = models.ForeignKey(User)
171 deployment = models.ForeignKey(Deployment)
172 kuser_id = models.CharField(null=True, blank=True, max_length=200, help_text="Keystone user id")
173
Tony Mack69f1bc32014-03-12 13:20:34 -0400174 def __unicode__(self): return u'%s %s' % (self.user, self.deployment.name)
Tony Macke4be32f2014-03-11 20:45:25 -0400175
176 @staticmethod
177 def select_by_user(user):
178 if user.is_admin:
179 qs = UserDeployments.objects.all()
180 else:
181 users = Users.select_by_user(user)
182 qs = Usereployments.objects.filter(user__in=slices)
Scott Baker2c3cb642014-05-19 17:55:56 -0700183 return qs
184
185class UserDashboardView(PlCoreBase):
186 user = models.ForeignKey(User, related_name="dashboardViews")
187 dashboardView = models.ForeignKey(DashboardView, related_name="dashboardViews")
188 order = models.IntegerField(default=0)