- use email to login & authenticate users
[astakos] / astakos / im / models.py
1 # Copyright 2011-2012 GRNET S.A. All rights reserved.
2
3 # Redistribution and use in source and binary forms, with or
4 # without modification, are permitted provided that the following
5 # conditions are met:
6
7 #   1. Redistributions of source code must retain the above
8 #      copyright notice, this list of conditions and the following
9 #      disclaimer.
10
11 #   2. Redistributions in binary form must reproduce the above
12 #      copyright notice, this list of conditions and the following
13 #      disclaimer in the documentation and/or other materials
14 #      provided with the distribution.
15
16 # THIS SOFTWARE IS PROVIDED BY GRNET S.A. ``AS IS'' AND ANY EXPRESS
17 # OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
18 # WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
19 # PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL GRNET S.A OR
20 # CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
21 # SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
22 # LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF
23 # USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED
24 # AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
25 # LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN
26 # ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
27 # POSSIBILITY OF SUCH DAMAGE.
28
29 # The views and conclusions contained in the software and
30 # documentation are those of the authors and should not be
31 # interpreted as representing official policies, either expressed
32 # or implied, of GRNET S.A.
33
34 import logging
35 import hashlib
36
37 from time import asctime
38 from datetime import datetime, timedelta
39 from base64 import b64encode
40
41 from django.conf import settings
42 from django.db import models
43 from django.contrib.auth.models import User, UserManager
44 from django.utils.translation import ugettext_lazy as _
45
46 from astakos.im.interface import get_quota, set_quota
47
48 class AstakosUser(User):
49     """
50     Extends ``django.contrib.auth.models.User`` by defining additional fields.
51     """
52     # Use UserManager to get the create_user method, etc.
53     objects = UserManager()
54     
55     affiliation = models.CharField('Affiliation', max_length=255, blank=True)
56     provider = models.CharField('Provider', max_length=255, blank=True)
57     
58     #for invitations
59     level = models.IntegerField('Inviter level', default=4)
60     invitations = models.IntegerField('Invitations left', default=0)
61     
62     auth_token = models.CharField('Authentication Token', max_length=32,
63                                   null=True, blank=True)
64     auth_token_created = models.DateTimeField('Token creation date', null=True)
65     auth_token_expires = models.DateTimeField('Token expiration date', null=True)
66     
67     updated = models.DateTimeField('Update date')
68     is_verified = models.BooleanField('Is verified?', default=False)
69     
70     @property
71     def realname(self):
72         return '%s %s' %(self.first_name, self.last_name)
73     
74     @realname.setter
75     def realname(self, value):
76         parts = value.split(' ')
77         if len(parts) == 2:
78             self.first_name = parts[0]
79             self.last_name = parts[1]
80         else:
81             self.last_name = parts[0]
82     
83     @property
84     def quota(self):
85         return get_quota(self.username)
86
87     @quota.setter
88     def quota(self, value):
89         set_quota(self.username, value)
90     
91     @property
92     def invitation(self):
93         try:
94             return Invitation.objects.get(username=self.username)
95         except Invitation.DoesNotExist:
96             return None
97     
98     def save(self, update_timestamps=True, **kwargs):
99         if update_timestamps:
100             if not self.id:
101                 self.date_joined = datetime.now()
102             self.updated = datetime.now()
103         
104         super(AstakosUser, self).save(**kwargs)
105         
106         #invitation consume
107         if self.invitation and not self.invitation.is_consumed:
108             self.invitation.consume()
109     
110     def renew_token(self):
111         md5 = hashlib.md5()
112         md5.update(self.username)
113         md5.update(self.realname.encode('ascii', 'ignore'))
114         md5.update(asctime())
115         
116         self.auth_token = b64encode(md5.digest())
117         self.auth_token_created = datetime.now()
118         self.auth_token_expires = self.auth_token_created + \
119                                   timedelta(hours=settings.AUTH_TOKEN_DURATION)
120     
121     def __unicode__(self):
122         return self.username
123
124 class Invitation(models.Model):
125     """
126     Model for registring invitations
127     """
128     inviter = models.ForeignKey(AstakosUser, related_name='invitations_sent',
129                                 null=True)
130     realname = models.CharField('Real name', max_length=255)
131     username = models.CharField('Unique ID', max_length=255)
132     code = models.BigIntegerField('Invitation code', db_index=True)
133     #obsolete: we keep it just for transfering the data
134     is_accepted = models.BooleanField('Accepted?', default=False)
135     is_consumed = models.BooleanField('Consumed?', default=False)
136     created = models.DateTimeField('Creation date', auto_now_add=True)
137     #obsolete: we keep it just for transfering the data
138     accepted = models.DateTimeField('Acceptance date', null=True, blank=True)
139     consumed = models.DateTimeField('Consumption date', null=True, blank=True)
140     
141     def consume(self):
142         self.is_consumed = True
143         self.consumed = datetime.now()
144         self.save()
145         
146     def __unicode__(self):
147         return '%s -> %s [%d]' % (self.inviter, self.username, self.code)