Just another blog

import re
 
from django.conf import settings
from django.contrib.auth.decorators import login_required
 
class RequireLoginMiddleware(object):
    """
    Middleware component that wraps the login_required decorator around 
    matching URL patterns. To use, add the class to MIDDLEWARE_CLASSES and 
    define LOGIN_REQUIRED_URLS and LOGIN_REQUIRED_URLS_EXCEPTIONS in your 
    settings.py. For example:
    ------
    LOGIN_REQUIRED_URLS = (
        r'/topsecret/(.*)$',
    )
    LOGIN_REQUIRED_URLS_EXCEPTIONS = (
        r'/topsecret/login(.*)$', 
        r'/topsecret/logout(.*)$',
    )
    ------                 
    LOGIN_REQUIRED_URLS is where you define URL patterns; each pattern must 
    be a valid regex.     
 
    LOGIN_REQUIRED_URLS_EXCEPTIONS is, conversely, where you explicitly 
    define any exceptions (like login and logout URLs).
    """
    def __init__(self):
        self.required = tuple([re.compile(url) for url in settings.LOGIN_REQUIRED_URLS])
        self.exceptions = tuple([re.compile(url) for url in settings.LOGIN_REQUIRED_URLS_EXCEPTIONS])
 
    def process_view(self, request, view_func, view_args, view_kwargs):
        # No need to process URLs if user already logged in
        if request.user.is_authenticated(): return None
        # An exception match should immediately return None
        for url in self.exceptions:
            if url.match(request.path): return None
        # Requests matching a restricted URL pattern are returned 
        # wrapped with the login_required decorator
        for url in self.required:
            if url.match(request.path): return login_required(view_func)(request, *view_args, **view_kwargs)
        # Explicitly return None for all non-matching requests
        return None

from django.test import TestCase
from django.test.client import RequestFactory
 
class RequireLoginMiddlewareTest(TestCase):
    def test_url_is_not_in_login_required(self):
        rf = RequestFactory()
        request = rf.get('/abc/test')

    def setUp(self):
        self.old_settings_required_urls = settings.LOGIN_REQUIRED_URLS
        self.old_settings_exceptions_urls = settings.LOGIN_REQUIRED_URLS_EXCEPTIONS
        settings.LOGIN_REQUIRED_URLS = (
            r'/test/(.*)$',
        )
        settings.LOGIN_REQUIRED_URLS_EXCEPTIONS = (
            r'/test/exc1(.*)$',
            r'/test/exc2(.*)$',
        )
        self.middleware = RequireLoginMiddleware()
 
    def tearDown(self):
        settings.LOGIN_REQUIRED_URLS = self.old_settings_required_urls
        settings.LOGIN_REQUIRED_URLS_EXCEPTIONS = self.old_settings_exceptions_urls

    def test_url_is_not_in_login_required(self):
        rf = RequestFactory()
        request = rf.get('/abc/test')
        request.session = {}
        response = self.middleware.process_view(request, lambda x: x, [], {})
        self.assertIsNone(response)
 
    def test_access_excluded_from_login_required_urls(self):
        rf = RequestFactory()
        request = rf.get('/test/exc1/foo')
        request.session = {}
        response = self.middleware.process_view(request, lambda x: x, [], {})
        self.assertIsNone(response)
 
    def test_redirect_guests(self):
        rf = RequestFactory()
        request = rf.get('/test/something/')
        request.session = {}
        response = self.middleware.process_view(request, lambda x: x, [], {})
        self.assertIsInstance(response, HttpResponseRedirect)
        self.assertEqual(reverse('auth_login') + '?next=/test/something/', response['Location'])
        self.assertEqual(response.status_code, 302)

    def test_logged_user_access(self):
        rf = RequestFactory()
        request = rf.get('/test/something/')
        request.session = {}
        request.user.is_authenticated = Mock(return_value=True)
        response = self.middleware.process_view(request, lambda x: x, [], {})
        self.assertIsNone(response)