blob: 0272661d50fa936b93d546c1fecda6c8ac1fb69b [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):
Sapan Bhatia3a6811e2014-04-29 14:41:23 -040014 def get_query_set(self):
15 return super(UserManager, self).get_query_set().filter(deleted=False)
16
Siobhan Tully53437282013-04-26 19:30:27 -040017 def create_user(self, email, firstname, lastname, password=None):
18 """
19 Creates and saves a User with the given email, date of
20 birth and password.
21 """
22 if not email:
23 raise ValueError('Users must have an email address')
24
25 user = self.model(
Siobhan Tully30fd4292013-05-10 08:59:56 -040026 email=UserManager.normalize_email(email),
Siobhan Tully53437282013-04-26 19:30:27 -040027 firstname=firstname,
Siobhan Tully30fd4292013-05-10 08:59:56 -040028 lastname=lastname,
29 password=password
Siobhan Tully53437282013-04-26 19:30:27 -040030 )
Siobhan Tully30fd4292013-05-10 08:59:56 -040031 #user.set_password(password)
Siobhan Tully53437282013-04-26 19:30:27 -040032 user.is_admin = True
33 user.save(using=self._db)
34 return user
35
36 def create_superuser(self, email, firstname, lastname, password):
37 """
38 Creates and saves a superuser with the given email, date of
39 birth and password.
40 """
41 user = self.create_user(email,
42 password=password,
43 firstname=firstname,
44 lastname=lastname
45 )
46 user.is_admin = True
47 user.save(using=self._db)
48 return user
49
50
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()
Siobhan Tully53437282013-04-26 19:30:27 -040090
91 USERNAME_FIELD = 'email'
92 REQUIRED_FIELDS = ['firstname', 'lastname']
93
Siobhan Tullycf04fb62014-01-11 11:25:57 -050094 def isReadOnlyUser(self):
95 return self.is_readonly
96
Siobhan Tully53437282013-04-26 19:30:27 -040097 def get_full_name(self):
98 # The user is identified by their email address
99 return self.email
100
101 def get_short_name(self):
102 # The user is identified by their email address
103 return self.email
104
Tony Mackb0d97422013-06-10 09:57:45 -0400105 @property
106 def keyname(self):
107 return self.email[:self.email.find('@')]
108
Siobhan Tully53437282013-04-26 19:30:27 -0400109 def __unicode__(self):
110 return self.email
111
112 def has_perm(self, perm, obj=None):
113 "Does the user have a specific permission?"
114 # Simplest possible answer: Yes, always
115 return True
116
117 def has_module_perms(self, app_label):
118 "Does the user have permissions to view the app `app_label`?"
119 # Simplest possible answer: Yes, always
120 return True
121
Siobhan Tullybfd11dc2013-09-03 12:59:24 -0400122 def is_superuser(self):
123 return False
Siobhan Tully53437282013-04-26 19:30:27 -0400124
Scott Baker2c3cb642014-05-19 17:55:56 -0700125 def get_dashboards(self):
126 DEFAULT_DASHBOARDS=["Tenant"]
127
128 dashboards = sorted(list(self.dashboardViews.all()), key=attrgetter('order'))
129 dashboards = [x.dashboardView for x in dashboards]
130
131 if not dashboards:
132 for dashboardName in DEFAULT_DASHBOARDS:
133 dbv = DashboardView.objects.filter(name=dashboardName)
134 if dbv:
135 dashboards.append(dbv[0])
136
137 return dashboards
138
Siobhan Tullybfd11dc2013-09-03 12:59:24 -0400139# def get_roles(self):
140# from core.models.site import SitePrivilege
141# from core.models.slice import SliceMembership
142#
143# site_privileges = SitePrivilege.objects.filter(user=self)
144# slice_memberships = SliceMembership.objects.filter(user=self)
145# roles = defaultdict(list)
146# for site_privilege in site_privileges:
147# roles[site_privilege.role.role_type].append(site_privilege.site.login_base)
148# for slice_membership in slice_memberships:
149# roles[slice_membership.role.role_type].append(slice_membership.slice.name)
150# return roles
Siobhan Tully53437282013-04-26 19:30:27 -0400151
Tony Mack53106f32013-04-27 16:43:01 -0400152 def save(self, *args, **kwds):
Siobhan Tully30fd4292013-05-10 08:59:56 -0400153 if not self.id:
154 self.set_password(self.password)
Siobhan Tullyfece0d52013-09-06 12:57:05 -0400155 self.username = self.email
Tony Mack5b061472014-02-04 07:57:10 -0500156 super(User, self).save(*args, **kwds)
157
158 @staticmethod
159 def select_by_user(user):
160 if user.is_admin:
161 qs = User.objects.all()
162 else:
163 # can see all users at any site where this user has pi role
164 from core.models.site import SitePrivilege
165 site_privs = SitePrivilege.objects.filter(user=user)
166 sites = [sp.site for sp in site_privs if sp.role.role == 'pi']
167 # get site privs of users at these sites
168 site_privs = SitePrivilege.objects.filter(site__in=sites)
169 user_ids = [sp.user.id for sp in site_privs] + [user.id]
170 qs = User.objects.filter(Q(site__in=sites) | Q(id__in=user_ids))
171 return qs
172
Scott Baker2c3cb642014-05-19 17:55:56 -0700173class UserDashboardView(PlCoreBase):
174 user = models.ForeignKey(User, related_name="dashboardViews")
175 dashboardView = models.ForeignKey(DashboardView, related_name="dashboardViews")
176 order = models.IntegerField(default=0)