Change formatting.
[pithos] / pithos / im / target / util.py
1 # Copyright 2011 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
37 from urlparse import urlsplit, urlunsplit
38 from urllib import quote
39
40 from django.conf import settings
41 from django.http import HttpResponse
42 from django.utils.http import urlencode
43
44 from pithos.im.models import User
45
46
47 def get_or_create_user(uniq, realname, affiliation, level):
48     """Find or register a user into the internal database
49        and issue a token for subsequent requests.
50     """
51     
52     user, created = User.objects.get_or_create(uniq=uniq,
53         defaults={
54             'realname': realname,
55             'affiliation': affiliation,
56             'level': level,
57             'invitations': settings.INVITATIONS_PER_LEVEL[level]
58         })
59     if created:
60         user.renew_token()
61         user.save()
62         logging.info('Created user %s', user)
63     
64     return user
65
66 def prepare_response(request, user, next='', renew=False):
67     """Return the unique username and the token
68        as 'X-Auth-User' and 'X-Auth-Token' headers,
69        or redirect to the URL provided in 'next'
70        with the 'user' and 'token' as parameters.
71        
72        Reissue the token even if it has not yet
73        expired, if the 'renew' parameter is present.
74     """
75     
76     if renew or user.auth_token_expires < datetime.datetime.now():
77         user.renew_token()
78         user.save()
79     if next:
80         # TODO: Avoid redirect loops.
81         parts = list(urlsplit(next))
82         # Do not pass on user and token if we are on the same server.
83         if parts[1] and request.get_host() != parts[1]:
84             parts[3] = urlencode({'user': user.uniq, 'token': user.auth_token})
85             next = urlunsplit(parts)
86     
87     response = HttpResponse()
88     expire_fmt = user.auth_token_expires.strftime('%a, %d-%b-%Y %H:%M:%S %Z')
89     cookie_value = quote(user.uniq + '|' + user.auth_token)
90     response.set_cookie('_pithos2_a', value=cookie_value, expires=expire_fmt, path='/')
91
92     if not next:
93         response['X-Auth-User'] = user.uniq
94         response['X-Auth-Token'] = user.auth_token
95         response.content = user.uniq + '\n' + user.auth_token + '\n'
96         response.status_code = 200
97     else:
98         response['Location'] = next
99         response.status_code = 302
100     return response