Compatibility up to Django 2.1, dropped < 1.8. Removed unused code, fixed tests.

[django-cas-provider.git] / cas_provider / views.py

diff --git a/cas_provider/views.py b/cas_provider/views.py
index 6cc322a..ccf84a2 100644 (file)
--- a/cas_provider/views.py
+++ b/cas_provider/views.py
@@ -1,12 +1,19 @@
+from __future__ import unicode_literals
+

 import logging
 logger = logging.getLogger('cas_provider.views')
 import logging
 logger = logging.getLogger('cas_provider.views')

-import urllib

 
 

-from urllib import urlencode
-import urllib2
-import urlparse
+try:
+    from urllib.error import HTTPError, URLError
+    from urllib.parse import parse_qsl, urlencode, urlparse, urlsplit, urlunsplit
+    from urllib.request import urlopen
+except ImportError:
+    from urllib import urlencode
+    from urllib2 import HTTPError, URLError, urlopen
+    from urlparse import parse_qsl, urlparse, urlsplit, urlunsplit

 from functools import wraps
 
 from functools import wraps
 

+from django import VERSION

 from django.utils.decorators import available_attrs
 from django.views.decorators.debug import sensitive_post_parameters
 from django.views.decorators.cache import cache_control
 from django.utils.decorators import available_attrs
 from django.views.decorators.debug import sensitive_post_parameters
 from django.views.decorators.cache import cache_control


@@ -16,12 +23,12 @@ from django.views.decorators.csrf import csrf_protect
 from django.http import HttpResponse, HttpResponseRedirect
 from django.conf import settings
 from django.contrib.auth import login as auth_login, logout as auth_logout
 from django.http import HttpResponse, HttpResponseRedirect
 from django.conf import settings
 from django.contrib.auth import login as auth_login, logout as auth_logout

-from django.core.urlresolvers import get_callable
-from django.shortcuts import render_to_response
+
+from django.shortcuts import render

 from django.utils.translation import ugettext as _
 from django.template import RequestContext
 from django.contrib.auth import authenticate
 from django.utils.translation import ugettext as _
 from django.template import RequestContext
 from django.contrib.auth import authenticate

-from django.core.urlresolvers import reverse
+from django.utils.translation import ugettext as _

 
 from lxml import etree
 from cas_provider.attribute_formatters import NSMAP, CAS
 
 from lxml import etree
 from cas_provider.attribute_formatters import NSMAP, CAS


@@ -32,6 +39,13 @@ from cas_provider.forms import LoginForm, MergeLoginForm
 
 from . import signals
 
 
 from . import signals
 

+if VERSION >= (1, 10):
+    from django.urls import get_callable, reverse
+    user_is_authenticated = lambda user: user.is_authenticated
+else:
+    from django.core.urlresolvers import get_callable, reverse
+    user_is_authenticated = lambda user: user.is_authenticated()
+

 __all__ = ['login', 'validate', 'logout', 'service_validate']
 
 INVALID_TICKET = 'INVALID_TICKET'
 __all__ = ['login', 'validate', 'logout', 'service_validate']
 
 INVALID_TICKET = 'INVALID_TICKET'


@@ -40,10 +54,10 @@ INVALID_REQUEST = 'INVALID_REQUEST'
 INTERNAL_ERROR = 'INTERNAL_ERROR'
 
 ERROR_MESSAGES = (
 INTERNAL_ERROR = 'INTERNAL_ERROR'
 
 ERROR_MESSAGES = (

-    (INVALID_TICKET, u'The provided ticket is invalid.'),
-    (INVALID_SERVICE, u'Service is invalid'),
-    (INVALID_REQUEST, u'Not all required parameters were sent.'),
-    (INTERNAL_ERROR, u'An internal error occurred during ticket validation'),
+    (INVALID_TICKET, 'The provided ticket is invalid.'),
+    (INVALID_SERVICE, 'Service is invalid'),
+    (INVALID_REQUEST, 'Not all required parameters were sent.'),
+    (INTERNAL_ERROR, 'An internal error occurred during ticket validation'),

     )
 
 
     )
 
 


@@ -118,7 +132,7 @@ def login(request, template_name='cas/login.html',
                         )
                     if service is not None:
                         args['service'] = service
                         )
                     if service is not None:
                         args['service'] = service

-                    args = urllib.urlencode(args)
+                    args = urlencode(args)

 
                     url = '%s?%s' % (base_url, args)
                     logging.debug('Redirecting to %s', url)
 
                     url = '%s?%s' % (base_url, args)
                     logging.debug('Redirecting to %s', url)


@@ -136,7 +150,7 @@ def login(request, template_name='cas/login.html',
         else:
             form = LoginForm(initial={'service': service})
 
         else:
             form = LoginForm(initial={'service': service})
 

-    if user is not None and user.is_authenticated():
+    if user is not None and user_is_authenticated(user):

         # We have an authenticated user.
         if not user.is_active:
             errors.append(_('This account is disabled. Please contact us if you feel it should be enabled again.'))
         # We have an authenticated user.
         if not user.is_active:
             errors.append(_('This account is disabled. Please contact us if you feel it should be enabled again.'))


@@ -159,10 +173,10 @@ def login(request, template_name='cas/login.html',
                 return HttpResponseRedirect(success_redirect)
             else:
                 if request.GET.get('warn', False):
                 return HttpResponseRedirect(success_redirect)
             else:
                 if request.GET.get('warn', False):

-                    return render_to_response(warn_template_name, {
+                    return render(request, warn_template_name, {

                         'service': service,
                         'warn': False
                         'service': service,
                         'warn': False

-                    }, context_instance=RequestContext(request))
+                    })

 
                 # Create a service ticket and redirect to the service.
                 ticket = ServiceTicket.objects.create(service=service, user=user)
 
                 # Create a service ticket and redirect to the service.
                 ticket = ServiceTicket.objects.create(service=service, user=user)


@@ -175,7 +189,7 @@ def login(request, template_name='cas/login.html',
                 return HttpResponseRedirect(url)
 
     logging.debug('Rendering response on %s, merge is %s', template_name, merge)
                 return HttpResponseRedirect(url)
 
     logging.debug('Rendering response on %s, merge is %s', template_name, merge)

-    return render_to_response(template_name, {'form': form, 'errors': errors}, context_instance=RequestContext(request))
+    return render(request, template_name, {'form': form, 'errors': errors})

 
 
 @never_cache
 
 
 @never_cache


@@ -213,14 +227,13 @@ def validate(request):
 def logout(request, template_name='cas/logout.html',
            auto_redirect=settings.CAS_AUTO_REDIRECT_AFTER_LOGOUT):
     url = request.GET.get('url', None)
 def logout(request, template_name='cas/logout.html',
            auto_redirect=settings.CAS_AUTO_REDIRECT_AFTER_LOGOUT):
     url = request.GET.get('url', None)

-    if request.user.is_authenticated():
+    if user_is_authenticated(request.user):

         for ticket in ServiceTicket.objects.filter(user=request.user):
             ticket.delete()
         auth_logout(request)
         if url and auto_redirect:
             return HttpResponseRedirect(url)
         for ticket in ServiceTicket.objects.filter(user=request.user):
             ticket.delete()
         auth_logout(request)
         if url and auto_redirect:
             return HttpResponseRedirect(url)

-    return render_to_response(template_name, {'url': url},
-        context_instance=RequestContext(request))
+    return render(request, template_name, {'url': url})

 
 
 @never_cache
 
 
 @never_cache


@@ -234,7 +247,7 @@ def proxy(request):
         return _cas2_error_response(INVALID_TICKET)
 
     pt = ProxyTicket.objects.create(proxyGrantingTicket=proxyGrantingTicket,
         return _cas2_error_response(INVALID_TICKET)
 
     pt = ProxyTicket.objects.create(proxyGrantingTicket=proxyGrantingTicket,

-        user=proxyGrantingTicket.serviceTicket.user,
+        user=proxyGrantingTicket.user,

         service=targetService)
     return _cas2_proxy_success(pt.ticket)
 
         service=targetService)
     return _cas2_proxy_success(pt.ticket)
 


@@ -255,8 +268,8 @@ def ticket_validate(service, ticket_string, pgtUrl):
     except ServiceTicket.DoesNotExist:
         return _cas2_error_response(INVALID_TICKET)
 
     except ServiceTicket.DoesNotExist:
         return _cas2_error_response(INVALID_TICKET)
 

-    ticketUrl = urlparse.urlparse(ticket.service)
-    serviceUrl = urlparse.urlparse(service)
+    ticketUrl = urlparse(ticket.service)
+    serviceUrl = urlparse(service)

 
     if not(ticketUrl.hostname == serviceUrl.hostname and ticketUrl.path == serviceUrl.path and ticketUrl.port == serviceUrl.port):
         return _cas2_error_response(INVALID_SERVICE)
 
     if not(ticketUrl.hostname == serviceUrl.hostname and ticketUrl.path == serviceUrl.path and ticketUrl.port == serviceUrl.port):
         return _cas2_error_response(INVALID_SERVICE)


@@ -268,16 +281,16 @@ def ticket_validate(service, ticket_string, pgtUrl):
         if pgt:
             pgtIouId = pgt.pgtiou
 
         if pgt:
             pgtIouId = pgt.pgtiou
 

-    if hasattr(ticket, 'proxyticket'):
-        pgt = ticket.proxyticket.proxyGrantingTicket
+    try:
+        proxyTicket = ticket.proxyticket
+    except ProxyTicket.DoesNotExist:
+        pass
+    else:
+        pgt = proxyTicket.proxyGrantingTicket

         # I am issued by this proxy granting ticket
         # I am issued by this proxy granting ticket

-        if hasattr(pgt.serviceTicket, 'proxyticket'):
-            while pgt:
-                if hasattr(pgt.serviceTicket, 'proxyticket'):
-                    proxies += (pgt.serviceTicket.service,)
-                    pgt = pgt.serviceTicket.proxyticket.proxyGrantingTicket
-                else:
-                    pgt = None
+        while pgt.pgt is not None:
+            proxies += (pgt.service,)
+            pgt = pgt.pgt

 
     user = ticket.user
     ticket.delete()
 
     user = ticket.user
     ticket.delete()


@@ -307,31 +320,29 @@ def proxy_validate(request):
 
 def generate_proxy_granting_ticket(pgt_url, ticket):
     proxy_callback_good_status = (200, 202, 301, 302, 304)
 
 def generate_proxy_granting_ticket(pgt_url, ticket):
     proxy_callback_good_status = (200, 202, 301, 302, 304)

-    uri = list(urlparse.urlsplit(pgt_url))
+    uri = list(urlsplit(pgt_url))

 
     pgt = ProxyGrantingTicket()
 
     pgt = ProxyGrantingTicket()

-    pgt.serviceTicket = ticket
-    pgt.targetService = pgt_url
-
-    if hasattr(ticket, 'proxyGrantingTicket'):
-        # here we got a proxy ticket! tata!
-        pgt.pgt = ticket.proxyGrantingTicket
+    pgt.user = ticket.user
+    pgt.service = ticket.service
+    # Remember if it's a chained PGT.
+    pgt.pgt = getattr(ticket, 'proxyGrantingTicket', None)

 
     params = {'pgtId': pgt.ticket, 'pgtIou': pgt.pgtiou}
 
 
     params = {'pgtId': pgt.ticket, 'pgtIou': pgt.pgtiou}
 

-    query = dict(urlparse.parse_qsl(uri[4]))
+    query = dict(parse_qsl(uri[4]))

     query.update(params)
 
     uri[3] = urlencode(query)
 
     try:
     query.update(params)
 
     uri[3] = urlencode(query)
 
     try:

-        urllib2.urlopen(urlparse.urlunsplit(uri))
-    except urllib2.HTTPError as e:
+        urlopen(urlunsplit(uri))
+    except HTTPError as e:

         if not e.code in proxy_callback_good_status:
         if not e.code in proxy_callback_good_status:

-            logger.debug('Checking Proxy Callback URL {} returned {}. Not issuing PGT.'.format(uri, e.code))
+            logger.debug('Checking Proxy Callback URL {0} returned {1}. Not issuing PGT.'.format(uri, e.code))

             return
             return

-    except urllib2.URLError as e:
-        logger.debug('Checking Proxy Callback URL {} raised URLError. Not issuing PGT.'.format(uri))
+    except URLError as e:
+        logger.debug('Checking Proxy Callback URL {0} raised URLError. Not issuing PGT.'.format(uri))

         return
 
     pgt.save()
         return
 
     pgt.save()


@@ -343,18 +354,18 @@ def _cas2_proxy_success(pt):
 
 
 def _cas2_sucess_response(user, pgt=None, proxies=None):
 
 
 def _cas2_sucess_response(user, pgt=None, proxies=None):

-    return HttpResponse(auth_success_response(user, pgt, proxies), mimetype='text/xml')
+    return HttpResponse(auth_success_response(user, pgt, proxies), content_type='text/xml')

 
 
 def _cas2_error_response(code, message=None):
 
 
 def _cas2_error_response(code, message=None):

-    return HttpResponse(u'''<cas:serviceResponse xmlns:cas="http://www.yale.edu/tp/cas">
+    return HttpResponse('''<cas:serviceResponse xmlns:cas="http://www.yale.edu/tp/cas">

             <cas:authenticationFailure code="%(code)s">
                 %(message)s
             </cas:authenticationFailure>
         </cas:serviceResponse>''' % {
         'code': code,
         'message': message if message else dict(ERROR_MESSAGES).get(code)
             <cas:authenticationFailure code="%(code)s">
                 %(message)s
             </cas:authenticationFailure>
         </cas:serviceResponse>''' % {
         'code': code,
         'message': message if message else dict(ERROR_MESSAGES).get(code)

-    }, mimetype='text/xml')
+    }, content_type='text/xml')

 
 
 def proxy_success(pt):
 
 
 def proxy_success(pt):


@@ -362,7 +373,7 @@ def proxy_success(pt):
     proxySuccess = etree.SubElement(response, CAS + 'proxySuccess')
     proxyTicket = etree.SubElement(proxySuccess, CAS + 'proxyTicket')
     proxyTicket.text = pt
     proxySuccess = etree.SubElement(response, CAS + 'proxySuccess')
     proxyTicket = etree.SubElement(proxySuccess, CAS + 'proxyTicket')
     proxyTicket.text = pt

-    return unicode(etree.tostring(response, encoding='utf-8'), 'utf-8')
+    return etree.tostring(response, encoding='unicode')

 
 
 def auth_success_response(user, pgt, proxies):
 
 
 def auth_success_response(user, pgt, proxies):


@@ -397,4 +408,4 @@ def auth_success_response(user, pgt, proxies):
             proxyElement = etree.SubElement(proxiesElement, CAS + "proxy")
             proxyElement.text = proxy
 
             proxyElement = etree.SubElement(proxiesElement, CAS + "proxy")
             proxyElement.text = proxy
 

-    return unicode(etree.tostring(response, encoding='utf-8'), 'utf-8')
+    return etree.tostring(response, encoding='unicode')