Statistics
| Branch: | Tag: | Revision:

root / snf-astakos-app / astakos / im / util.py @ 18ffbee1

History | View | Annotate | Download (6.7 kB)

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 datetime
36
import time
37

    
38
from urllib import quote
39
from urlparse import urlsplit, urlunsplit
40
from functools import wraps
41

    
42
from datetime import tzinfo, timedelta
43
from django.http import HttpResponse, urlencode
44
from django.template import RequestContext
45
from django.contrib.sites.models import Site
46
from django.utils.translation import ugettext as _
47
from django.contrib.auth import login, authenticate
48
from django.core.urlresolvers import reverse
49

    
50
from astakos.im.models import AstakosUser, Invitation, ApprovalTerms
51
from astakos.im.settings import INVITATIONS_PER_LEVEL, COOKIE_NAME, COOKIE_DOMAIN, COOKIE_SECURE, FORCE_PROFILE_UPDATE
52

    
53
logger = logging.getLogger(__name__)
54

    
55
class UTC(tzinfo):
56
   def utcoffset(self, dt):
57
       return timedelta(0)
58

    
59
   def tzname(self, dt):
60
       return 'UTC'
61

    
62
   def dst(self, dt):
63
       return timedelta(0)
64

    
65
def isoformat(d):
66
   """Return an ISO8601 date string that includes a timezone."""
67

    
68
   return d.replace(tzinfo=UTC()).isoformat()
69

    
70
def epoch(datetime):
71
    return int(time.mktime(datetime.timetuple())*1000)
72

    
73
def get_or_create_user(email, realname='', first_name='', last_name='', affiliation='', level=0, provider='local', password=''):
74
    """Find or register a user into the internal database
75
       and issue a token for subsequent requests.
76
    """
77
    user, created = AstakosUser.objects.get_or_create(email=email,
78
        defaults={
79
            'password':password,
80
            'affiliation':affiliation,
81
            'level':level,
82
            'invitations':INVITATIONS_PER_LEVEL.get(level, 0),
83
            'provider':provider,
84
            'realname':realname,
85
            'first_name':first_name,
86
            'last_name':last_name
87
        })
88
    if created:
89
        user.renew_token()
90
        user.save()
91
        logger.info('Created user %s', user)
92
    
93
    return user
94

    
95
def get_context(request, extra_context={}, **kwargs):
96
    if not extra_context:
97
        extra_context = {}
98
    extra_context.update(kwargs)
99
    return RequestContext(request, extra_context)
100

    
101
def get_invitation(request):
102
    """
103
    Returns the invitation identified by the ``code``.
104
    
105
    Raises Invitation.DoesNotExist and Exception if the invitation is consumed
106
    """
107
    code = request.GET.get('code')
108
    if request.method == 'POST':
109
        code = request.POST.get('code')
110
    #if not code:
111
    #    if 'invitation_code' in request.session:
112
    #        code = request.session.pop('invitation_code')
113
    if not code:
114
        return
115
    invitation = Invitation.objects.get(code = code)
116
    print '>>>', invitation
117
    if invitation.is_consumed:
118
        raise ValueError(_('Invitation is used'))
119
    try:
120
        AstakosUser.objects.get(email = invitation.username)
121
        raise ValueError(_('Email: %s is reserved' % invitation.username))
122
    except AstakosUser.DoesNotExist:
123
        pass
124
    return invitation
125

    
126
def prepare_response(request, user, next='', renew=False):
127
    """Return the unique username and the token
128
       as 'X-Auth-User' and 'X-Auth-Token' headers,
129
       or redirect to the URL provided in 'next'
130
       with the 'user' and 'token' as parameters.
131
       
132
       Reissue the token even if it has not yet
133
       expired, if the 'renew' parameter is present
134
       or user has not a valid token.
135
    """
136
    renew = renew or (not user.auth_token)
137
    renew = renew or (user.auth_token_expires and user.auth_token_expires < datetime.datetime.now())
138
    if renew:
139
        user.renew_token()
140
        user.save()
141
    
142
    if FORCE_PROFILE_UPDATE and not user.is_verified and not user.is_superuser:
143
        params = ''
144
        if next:
145
            params = '?' + urlencode({'next': next})
146
        next = reverse('astakos.im.views.edit_profile') + params
147
    
148
    response = HttpResponse()
149
    
150
    # authenticate before login
151
    user = authenticate(email=user.email, auth_token=user.auth_token)
152
    login(request, user)
153
    set_cookie(response, user)
154
    
155
    if not next:
156
        next = reverse('astakos.im.views.index')
157
    
158
    response['Location'] = next
159
    response.status_code = 302
160
    return response
161

    
162
def set_cookie(response, user):
163
    expire_fmt = user.auth_token_expires.strftime('%a, %d-%b-%Y %H:%M:%S %Z')
164
    cookie_value = quote(user.email + '|' + user.auth_token)
165
    response.set_cookie(COOKIE_NAME, value=cookie_value,
166
                        expires=expire_fmt, path='/',
167
                        domain=COOKIE_DOMAIN, secure=COOKIE_SECURE)
168

    
169
class lazy_string(object):
170
    def __init__(self, function, *args, **kwargs):
171
        self.function=function
172
        self.args=args
173
        self.kwargs=kwargs
174
        
175
    def __str__(self):
176
        if not hasattr(self, 'str'):
177
            self.str=self.function(*self.args, **self.kwargs)
178
        return self.str
179

    
180
def reverse_lazy(*args, **kwargs):
181
    return lazy_string(reverse, *args, **kwargs)
182

    
183
def get_latest_terms():
184
    try:
185
        term = ApprovalTerms.objects.order_by('-id')[0]
186
        return term
187
    except IndexError:
188
        pass
189
    return None
190

    
191
def has_signed_terms(user):
192
    term = get_latest_terms()
193
    if not term:
194
        return True
195
    if not user.has_signed_terms:
196
        return False
197
    if not user.date_signed_terms:
198
        return False
199
    if user.date_signed_terms < term.date:
200
        user.has_signed_terms = False
201
        user.save()
202
        return False
203
    return True