add support for fine-grained field permissions for user model
[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, DiffModelMixIn
7 from core.models.site import Deployment
8 from django.contrib.auth.models import AbstractBaseUser, BaseUserManager
9 from timezones.fields import TimeZoneField
10 from operator import itemgetter, attrgetter
11 from django.core.mail import EmailMultiAlternatives
12 from core.middleware import get_request
13 import model_policy
14 from django.core.exceptions import PermissionDenied
15
16 # Create your models here.
17 class UserManager(BaseUserManager):
18     def create_user(self, email, firstname, lastname, password=None):
19         """
20         Creates and saves a User with the given email, date of
21         birth and password.
22         """
23         if not email:
24             raise ValueError('Users must have an email address')
25
26         user = self.model(
27             email=UserManager.normalize_email(email),
28             firstname=firstname,
29             lastname=lastname,
30             password=password
31         )
32         #user.set_password(password)
33         user.is_admin = True
34         user.save(using=self._db)
35         return user
36
37     def create_superuser(self, email, firstname, lastname, password):
38         """
39         Creates and saves a superuser with the given email, date of
40         birth and password.
41         """
42         user = self.create_user(email,
43             password=password,
44             firstname=firstname,
45             lastname=lastname
46         )
47         user.is_admin = True
48         user.save(using=self._db)
49         return user
50
51 class DeletedUserManager(UserManager):
52     def get_queryset(self):
53         return super(UserManager, self).get_query_set().filter(deleted=True)
54
55     # deprecated in django 1.7 in favor of get_queryset()
56     def get_query_set(self):
57         return self.get_queryset()
58
59 class User(AbstractBaseUser, DiffModelMixIn):
60
61     class Meta:
62         app_label = "core"
63
64     email = models.EmailField(
65         verbose_name='email address',
66         max_length=255,
67         unique=True,
68         db_index=True,
69     )
70
71     username = models.CharField(max_length=255, default="Something" )
72
73     firstname = models.CharField(help_text="person's given name", max_length=200)
74     lastname = models.CharField(help_text="person's surname", max_length=200)
75
76     phone = models.CharField(null=True, blank=True, help_text="phone number contact", max_length=100)
77     user_url = models.URLField(null=True, blank=True)
78     site = models.ForeignKey(Site, related_name='users', help_text="Site this user will be homed too", null=True)
79     public_key = models.TextField(null=True, blank=True, max_length=1024, help_text="Public key string")
80
81     is_active = models.BooleanField(default=True)
82     is_admin = models.BooleanField(default=True)
83     is_staff = models.BooleanField(default=True)
84     is_readonly = models.BooleanField(default=False)
85
86     created = models.DateTimeField(auto_now_add=True)
87     updated = models.DateTimeField(auto_now=True)
88     enacted = models.DateTimeField(null=True, default=None)
89     backend_status = models.CharField(max_length=140,
90                                       default="Provisioning in progress")
91     deleted = models.BooleanField(default=False)
92
93     timezone = TimeZoneField()
94
95     dashboards = models.ManyToManyField('DashboardView', through='UserDashboardView', blank=True)
96
97     objects = UserManager()
98     deleted_objects = DeletedUserManager()
99
100     USERNAME_FIELD = 'email'
101     REQUIRED_FIELDS = ['firstname', 'lastname']
102
103     def __init__(self, *args, **kwargs):
104         super(User, self).__init__(*args, **kwargs)
105         self._initial = self._dict # for DiffModelMixIn
106
107     def isReadOnlyUser(self):
108         return self.is_readonly
109
110     def get_full_name(self):
111         # The user is identified by their email address
112         return self.email
113
114     def get_short_name(self):
115         # The user is identified by their email address
116         return self.email
117
118     def delete(self, *args, **kwds):
119         # so we have something to give the observer
120         purge = kwds.get('purge',False)
121         try:
122             purge = purge or observer_disabled
123         except NameError:
124             pass
125             
126         if (purge):
127             super(User, self).delete(*args, **kwds)
128         else:
129             self.deleted = True
130             self.enacted=None
131             self.save(update_fields=['enacted','deleted'])
132
133     @property
134     def keyname(self):
135         return self.email[:self.email.find('@')]
136
137     def __unicode__(self):
138         return self.email
139
140     def has_perm(self, perm, obj=None):
141         "Does the user have a specific permission?"
142         # Simplest possible answer: Yes, always
143         return True
144
145     def has_module_perms(self, app_label):
146         "Does the user have permissions to view the app `app_label`?"
147         # Simplest possible answer: Yes, always
148         return True
149
150     def is_superuser(self):
151         return False
152
153     def get_dashboards(self):
154         DEFAULT_DASHBOARDS=["Tenant"]
155
156         dashboards = sorted(list(self.dashboardViews.all()), key=attrgetter('order'))
157         dashboards = [x.dashboardView for x in dashboards]
158
159         if not dashboards:
160             for dashboardName in DEFAULT_DASHBOARDS:
161                 dbv = DashboardView.objects.filter(name=dashboardName)
162                 if dbv:
163                     dashboards.append(dbv[0])
164
165         return dashboards
166
167 #    def get_roles(self):
168 #        from core.models.site import SitePrivilege
169 #        from core.models.slice import SliceMembership
170 #
171 #        site_privileges = SitePrivilege.objects.filter(user=self)
172 #        slice_memberships = SliceMembership.objects.filter(user=self)
173 #        roles = defaultdict(list)
174 #        for site_privilege in site_privileges:
175 #            roles[site_privilege.role.role_type].append(site_privilege.site.login_base)
176 #        for slice_membership in slice_memberships:
177 #            roles[slice_membership.role.role_type].append(slice_membership.slice.name)
178 #        return roles   
179
180     def save(self, *args, **kwds):
181         if not self.id:
182             self.set_password(self.password)
183         if self.is_active:
184             if self.password=="!":\r
185                 self.send_temporary_password()\r
186 \r
187         self.username = self.email
188         super(User, self).save(*args, **kwds)
189
190         self._initial = self._dict
191
192     def send_temporary_password(self):
193         password = User.objects.make_random_password()
194         self.set_password(password)\r
195         subject, from_email, to = 'OpenCloud Account Credentials', 'support@opencloud.us', str(self.email)\r
196         text_content = 'This is an important message.'\r
197         userUrl="http://%s/" % get_request().get_host()\r
198         html_content = """<p>Your account has been created on OpenCloud. Please log in <a href="""+userUrl+""">here</a> to activate your account<br><br>Username: """+self.email+"""<br>Temporary Password: """+password+"""<br>Please change your password once you successully login into the site.</p>"""\r
199         msg = EmailMultiAlternatives(subject,text_content, from_email, [to])\r
200         msg.attach_alternative(html_content, "text/html")\r
201         msg.send()
202
203     def can_update_field(self, user, fieldName):
204         from core.models import SitePrivilege
205         if (user.is_admin):
206             # admin can update anything
207             return True
208
209         # fields that a site PI can update
210         if fieldName in ["is_active", "is_readonly"]:
211             site_privs = SitePrivilege.objects.filter(user=user, site=self.site)
212             for site_priv in site_privs:
213                 if site_priv.role.role == 'pi':
214                     return True
215
216         # fields that a user cannot update in his/her own record
217         if fieldName in ["is_admin", "is_active", "site", "is_staff", "is_readonly"]:
218             return False
219
220         return True
221
222     def can_update(self, user):
223         from core.models import SitePrivilege
224         if user.is_readonly:
225             return False
226         if user.is_admin:
227             return True
228         if (user.id == self.id):
229             return True
230         # site pis can update
231         site_privs = SitePrivilege.objects.filter(user=user, site=self.site)
232         for site_priv in site_privs:
233             if site_priv.role.role == 'pi':
234                 return True
235
236         return False
237
238     @staticmethod
239     def select_by_user(user):
240         if user.is_admin:
241             qs = User.objects.all()
242         else:
243             # can see all users at any site where this user has pi role
244             from core.models.site import SitePrivilege
245             site_privs = SitePrivilege.objects.filter(user=user)
246             sites = [sp.site for sp in site_privs if sp.role.role == 'pi']
247             # get site privs of users at these sites
248             site_privs = SitePrivilege.objects.filter(site__in=sites)
249             user_ids = [sp.user.id for sp in site_privs] + [user.id]
250             qs = User.objects.filter(Q(site__in=sites) | Q(id__in=user_ids))
251         return qs
252
253     def save_by_user(self, user, *args, **kwds):
254         if not self.can_update(user):
255             raise PermissionDenied("You do not have permission to update %s objects" % self.__class__.__name__)
256
257         for fieldName in self.changed_fields:
258             if not self.can_update_field(user, fieldName):
259                 raise PermissionDenied("You do not have permission to update field %s in object %s" % (fieldName, self.__class__.__name__))
260
261         self.save(*args, **kwds)
262
263     def delete_by_user(self, user, *args, **kwds):
264         if not self.can_update(user):
265             raise PermissionDenied("You do not have permission to delete %s objects" % self.__class__.__name__)
266         self.delete(*args, **kwds)
267
268 class UserDashboardView(PlCoreBase):
269      user = models.ForeignKey(User, related_name="dashboardViews")
270      dashboardView = models.ForeignKey(DashboardView, related_name="dashboardViews")
271      order = models.IntegerField(default=0)