move UserDeployments to a separate file to resolve circular reference
[plstackapi.git] / planetstack / core / models / user.py
1 import os
2 import datetime
3 from collections import defaultdict
4 from django.db import models
5 from django.db.models import F, Q
6 from core.models import PlCoreBase,Site, DashboardView
7 from django.contrib.auth.models import AbstractBaseUser, BaseUserManager
8 from timezones.fields import TimeZoneField
9 from operator import itemgetter, attrgetter
10
11 # Create your models here.
12 class UserManager(BaseUserManager):
13     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(
22             email=UserManager.normalize_email(email),
23             firstname=firstname,
24             lastname=lastname,
25             password=password
26         )
27         #user.set_password(password)
28         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
47 class User(AbstractBaseUser):
48
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     )
58
59     username = models.CharField(max_length=255, default="Something" )
60
61     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)
66     site = models.ForeignKey(Site, related_name='users', help_text="Site this user will be homed too", null=True)
67     public_key = models.TextField(null=True, blank=True, max_length=1024, help_text="Public key string")
68
69     is_active = models.BooleanField(default=True)
70     is_admin = models.BooleanField(default=True)
71     is_staff = models.BooleanField(default=True)
72     is_readonly = models.BooleanField(default=False)
73
74     created = models.DateTimeField(auto_now_add=True)
75     updated = models.DateTimeField(auto_now=True)
76     enacted = models.DateTimeField(null=True, default=None)
77
78     timezone = TimeZoneField()
79
80     dashboards = models.ManyToManyField('DashboardView', through='UserDashboardView', blank=True)
81
82     objects = UserManager()
83
84     USERNAME_FIELD = 'email'
85     REQUIRED_FIELDS = ['firstname', 'lastname']
86
87     def isReadOnlyUser(self):
88         return self.is_readonly
89
90     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
98     @property
99     def keyname(self):
100         return self.email[:self.email.find('@')]
101
102     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
115     def is_superuser(self):
116         return False
117
118     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
132 #    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   
144
145     def save(self, *args, **kwds):
146         if not self.id:
147             self.set_password(self.password)    
148         self.username = self.email
149         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
166 class UserDashboardView(PlCoreBase):
167      user = models.ForeignKey(User, related_name="dashboardViews")
168      dashboardView = models.ForeignKey(DashboardView, related_name="dashboardViews")
169      order = models.IntegerField(default=0)