blob: fba2a7eb8c63782d8d9e28698f8883f0dc786946 [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
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
Siobhan Tully53437282013-04-26 19:30:27 -040010
11# Create your models here.
Siobhan Tully30fd4292013-05-10 08:59:56 -040012class UserManager(BaseUserManager):
Siobhan Tully53437282013-04-26 19:30:27 -040013 def create_user(self, email, firstname, lastname, password=None):
14 """
15 Creates and saves a User with the given email, date of
16 birth and password.
17 """
18 if not email:
19 raise ValueError('Users must have an email address')
20
21 user = self.model(
Siobhan Tully30fd4292013-05-10 08:59:56 -040022 email=UserManager.normalize_email(email),
Siobhan Tully53437282013-04-26 19:30:27 -040023 firstname=firstname,
Siobhan Tully30fd4292013-05-10 08:59:56 -040024 lastname=lastname,
25 password=password
Siobhan Tully53437282013-04-26 19:30:27 -040026 )
Siobhan Tully30fd4292013-05-10 08:59:56 -040027 #user.set_password(password)
Siobhan Tully53437282013-04-26 19:30:27 -040028 user.is_admin = True
29 user.save(using=self._db)
30 return user
31
32 def create_superuser(self, email, firstname, lastname, password):
33 """
34 Creates and saves a superuser with the given email, date of
35 birth and password.
36 """
37 user = self.create_user(email,
38 password=password,
39 firstname=firstname,
40 lastname=lastname
41 )
42 user.is_admin = True
43 user.save(using=self._db)
44 return user
45
46
Siobhan Tully30fd4292013-05-10 08:59:56 -040047class User(AbstractBaseUser):
Siobhan Tully53437282013-04-26 19:30:27 -040048
49 class Meta:
50 app_label = "core"
51
52 email = models.EmailField(
53 verbose_name='email address',
54 max_length=255,
55 unique=True,
56 db_index=True,
57 )
Siobhan Tullyfece0d52013-09-06 12:57:05 -040058
59 username = models.CharField(max_length=255, default="Something" )
60
Siobhan Tully53437282013-04-26 19:30:27 -040061 firstname = models.CharField(help_text="person's given name", max_length=200)
62 lastname = models.CharField(help_text="person's surname", max_length=200)
63
64 phone = models.CharField(null=True, blank=True, help_text="phone number contact", max_length=100)
65 user_url = models.URLField(null=True, blank=True)
Siobhan Tullybfd11dc2013-09-03 12:59:24 -040066 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 -040067 public_key = models.TextField(null=True, blank=True, max_length=1024, help_text="Public key string")
Siobhan Tully53437282013-04-26 19:30:27 -040068
69 is_active = models.BooleanField(default=True)
70 is_admin = models.BooleanField(default=True)
71 is_staff = models.BooleanField(default=True)
Siobhan Tullycf04fb62014-01-11 11:25:57 -050072 is_readonly = models.BooleanField(default=False)
Siobhan Tully53437282013-04-26 19:30:27 -040073
Tony Mack0553f282013-06-10 22:54:50 -040074 created = models.DateTimeField(auto_now_add=True)
75 updated = models.DateTimeField(auto_now=True)
76 enacted = models.DateTimeField(null=True, default=None)
77
Scott Baker9266e6b2013-05-19 15:54:48 -070078 timezone = TimeZoneField()
79
Scott Baker2c3cb642014-05-19 17:55:56 -070080 dashboards = models.ManyToManyField('DashboardView', through='UserDashboardView', blank=True)
81
Siobhan Tully30fd4292013-05-10 08:59:56 -040082 objects = UserManager()
Siobhan Tully53437282013-04-26 19:30:27 -040083
84 USERNAME_FIELD = 'email'
85 REQUIRED_FIELDS = ['firstname', 'lastname']
86
Siobhan Tullycf04fb62014-01-11 11:25:57 -050087 def isReadOnlyUser(self):
88 return self.is_readonly
89
Siobhan Tully53437282013-04-26 19:30:27 -040090 def get_full_name(self):
91 # The user is identified by their email address
92 return self.email
93
94 def get_short_name(self):
95 # The user is identified by their email address
96 return self.email
97
Tony Mackb0d97422013-06-10 09:57:45 -040098 @property
99 def keyname(self):
100 return self.email[:self.email.find('@')]
101
Siobhan Tully53437282013-04-26 19:30:27 -0400102 def __unicode__(self):
103 return self.email
104
105 def has_perm(self, perm, obj=None):
106 "Does the user have a specific permission?"
107 # Simplest possible answer: Yes, always
108 return True
109
110 def has_module_perms(self, app_label):
111 "Does the user have permissions to view the app `app_label`?"
112 # Simplest possible answer: Yes, always
113 return True
114
Siobhan Tullybfd11dc2013-09-03 12:59:24 -0400115 def is_superuser(self):
116 return False
Siobhan Tully53437282013-04-26 19:30:27 -0400117
Scott Baker2c3cb642014-05-19 17:55:56 -0700118 def get_dashboards(self):
119 DEFAULT_DASHBOARDS=["Tenant"]
120
121 dashboards = sorted(list(self.dashboardViews.all()), key=attrgetter('order'))
122 dashboards = [x.dashboardView for x in dashboards]
123
124 if not dashboards:
125 for dashboardName in DEFAULT_DASHBOARDS:
126 dbv = DashboardView.objects.filter(name=dashboardName)
127 if dbv:
128 dashboards.append(dbv[0])
129
130 return dashboards
131
Siobhan Tullybfd11dc2013-09-03 12:59:24 -0400132# def get_roles(self):
133# from core.models.site import SitePrivilege
134# from core.models.slice import SliceMembership
135#
136# site_privileges = SitePrivilege.objects.filter(user=self)
137# slice_memberships = SliceMembership.objects.filter(user=self)
138# roles = defaultdict(list)
139# for site_privilege in site_privileges:
140# roles[site_privilege.role.role_type].append(site_privilege.site.login_base)
141# for slice_membership in slice_memberships:
142# roles[slice_membership.role.role_type].append(slice_membership.slice.name)
143# return roles
Siobhan Tully53437282013-04-26 19:30:27 -0400144
Tony Mack53106f32013-04-27 16:43:01 -0400145 def save(self, *args, **kwds):
Siobhan Tully30fd4292013-05-10 08:59:56 -0400146 if not self.id:
147 self.set_password(self.password)
Siobhan Tullyfece0d52013-09-06 12:57:05 -0400148 self.username = self.email
Tony Mack5b061472014-02-04 07:57:10 -0500149 super(User, self).save(*args, **kwds)
150
151 @staticmethod
152 def select_by_user(user):
153 if user.is_admin:
154 qs = User.objects.all()
155 else:
156 # can see all users at any site where this user has pi role
157 from core.models.site import SitePrivilege
158 site_privs = SitePrivilege.objects.filter(user=user)
159 sites = [sp.site for sp in site_privs if sp.role.role == 'pi']
160 # get site privs of users at these sites
161 site_privs = SitePrivilege.objects.filter(site__in=sites)
162 user_ids = [sp.user.id for sp in site_privs] + [user.id]
163 qs = User.objects.filter(Q(site__in=sites) | Q(id__in=user_ids))
164 return qs
165
Scott Baker2c3cb642014-05-19 17:55:56 -0700166class UserDashboardView(PlCoreBase):
167 user = models.ForeignKey(User, related_name="dashboardViews")
168 dashboardView = models.ForeignKey(DashboardView, related_name="dashboardViews")
169 order = models.IntegerField(default=0)