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