code.grnet.gr Git - astakos/blob - snf-astakos-app/astakos/im/util.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 datetime
  36 import time
  37
  38 from urllib import quote
  39 from urlparse import urlsplit, urlunsplit
  40
  41 from datetime import tzinfo, timedelta
  42 from django.http import HttpResponse, HttpResponseBadRequest, urlencode
  43 from django.template import RequestContext
  44 from django.utils.translation import ugettext as _
  45 from django.contrib.auth import authenticate
  46 from django.core.urlresolvers import reverse
  47 from django.core.exceptions import ValidationError
  48
  49 from astakos.im.models import AstakosUser, Invitation, ApprovalTerms
  50 from astakos.im.settings import INVITATIONS_PER_LEVEL, COOKIE_NAME, \
  51     COOKIE_DOMAIN, COOKIE_SECURE, FORCE_PROFILE_UPDATE, LOGGING_LEVEL
  52 from astakos.im.functions import login
  53
  54 logger = logging.getLogger(__name__)
  55
  56 class UTC(tzinfo):
  57    def utcoffset(self, dt):
  58        return timedelta(0)
  59
  60    def tzname(self, dt):
  61        return 'UTC'
  62
  63    def dst(self, dt):
  64        return timedelta(0)
  65
  66 def isoformat(d):
  67    """Return an ISO8601 date string that includes a timezone."""
  68
  69    return d.replace(tzinfo=UTC()).isoformat()
  70
  71 def epoch(datetime):
  72     return int(time.mktime(datetime.timetuple())*1000)
  73
  74 def get_context(request, extra_context={}, **kwargs):
  75     if not extra_context:
  76         extra_context = {}
  77     extra_context.update(kwargs)
  78     return RequestContext(request, extra_context)
  79
  80 def get_invitation(request):
  81     """
  82     Returns the invitation identified by the ``code``.
  83
  84     Raises ValueError if the invitation is consumed or there is another account
  85     associated with this email.
  86     """
  87     code = request.GET.get('code')
  88     if request.method == 'POST':
  89         code = request.POST.get('code')
  90     if not code:
  91         return
  92     invitation = Invitation.objects.get(code = code)
  93     if invitation.is_consumed:
  94         raise ValueError(_('Invitation is used'))
  95     if reserved_email(invitation.username):
  96         raise ValueError(_('Email: %s is reserved' % invitation.username))
  97     return invitation
  98
  99 def prepare_response(request, user, next='', renew=False):
 100     """Return the unique username and the token
 101        as 'X-Auth-User' and 'X-Auth-Token' headers,
 102        or redirect to the URL provided in 'next'
 103        with the 'user' and 'token' as parameters.
 104
 105        Reissue the token even if it has not yet
 106        expired, if the 'renew' parameter is present
 107        or user has not a valid token.
 108     """
 109     renew = renew or (not user.auth_token)
 110     renew = renew or (user.auth_token_expires and user.auth_token_expires < datetime.datetime.now())
 111     if renew:
 112         user.renew_token()
 113         try:
 114             user.save()
 115         except ValidationError, e:
 116             return HttpResponseBadRequest(e)
 117
 118     if FORCE_PROFILE_UPDATE and not user.is_verified and not user.is_superuser:
 119         params = ''
 120         if next:
 121             params = '?' + urlencode({'next': next})
 122         next = reverse('astakos.im.views.edit_profile') + params
 123
 124     response = HttpResponse()
 125
 126     # authenticate before login
 127     user = authenticate(email=user.email, auth_token=user.auth_token)
 128     login(request, user)
 129     set_cookie(response, user)
 130     request.session.set_expiry(user.auth_token_expires)
 131
 132     if not next:
 133         next = reverse('astakos.im.views.index')
 134
 135     response['Location'] = next
 136     response.status_code = 302
 137     return response
 138
 139 def set_cookie(response, user):
 140     expire_fmt = user.auth_token_expires.strftime('%a, %d-%b-%Y %H:%M:%S %Z')
 141     cookie_value = quote(user.email + '|' + user.auth_token)
 142     response.set_cookie(COOKIE_NAME, value=cookie_value,
 143                         expires=expire_fmt, path='/',
 144                         domain=COOKIE_DOMAIN, secure=COOKIE_SECURE)
 145     msg = 'Cookie [expiring %s] set for %s' % (user.auth_token_expires, user.email)
 146     logger._log(LOGGING_LEVEL, msg, [])
 147
 148 class lazy_string(object):
 149     def __init__(self, function, *args, **kwargs):
 150         self.function=function
 151         self.args=args
 152         self.kwargs=kwargs
 153
 154     def __str__(self):
 155         if not hasattr(self, 'str'):
 156             self.str=self.function(*self.args, **self.kwargs)
 157         return self.str
 158
 159 def reverse_lazy(*args, **kwargs):
 160     return lazy_string(reverse, *args, **kwargs)
 161
 162 def reserved_email(email):
 163     return AstakosUser.objects.filter(email = email).count() != 0
 164
 165 def get_query(request):
 166     return request.__getattribute__(request.method)