Ticket #3228: smartslash-2.diff

django/middleware/common.py

@@ -1 +1 @@
 from django.conf import settings
 from django import http
 from django.core.mail import mail_managers
+from django.core import urlresolvers 
 import md5
 import re
 
@@ -14 +15 @@
           this middleware appends missing slashes and/or prepends missing
           "www."s.
 
+            - If APPEND_SLASH is set and the initial URL doesn't end with a
+              slash, and it is not found in urlpatterns, a new URL is formed by
+              appending a slash at the end. If this new URL is found in
+              urlpatterns, then an HTTP-redirect is returned to this new URL;
+              otherwise the initial URL is processed as usual. 
+
         - ETags: If the USE_ETAGS setting is set, ETags will be calculated from
           the entire page content and Not Modified responses will be returned
           appropriately.
@@ -31 +38 @@
                 if user_agent_regex.search(request.META['HTTP_USER_AGENT']):
                     return http.HttpResponseForbidden('<h1>Forbidden</h1>')
 
-        # Check for a redirect based on settings.APPEND_SLASH and settings.PREPEND_WWW
+        # Check for a redirect based on settings.APPEND_SLASH
+        # and settings.PREPEND_WWW
         host = http.get_host(request)
         old_url = [host, request.path]
         new_url = old_url[:]
-        if settings.PREPEND_WWW and old_url[0] and not old_url[0].startswith('www.'):
+
+        if (settings.PREPEND_WWW and old_url[0] and
+                not old_url[0].startswith('www.')):
             new_url[0] = 'www.' + old_url[0]
-        # Append a slash if append_slash is set and the URL doesn't have a
-        # trailing slash or a file extension.
-        if settings.APPEND_SLASH and (not old_url[1].endswith('/')) and ('.' not in old_url[1].split('/')[-1]):
-            new_url[1] = new_url[1] + '/'
-            if settings.DEBUG and request.method == 'POST':
-                raise RuntimeError, "You called this URL via POST, but the URL doesn't end in a slash and you have APPEND_SLASH set. Django can't redirect to the slash URL while maintaining POST data. Change your form to point to %s%s (note the trailing slash), or set APPEND_SLASH=False in your Django settings." % (new_url[0], new_url[1])
+
+        # Append a slash if APPEND_SLASH is set and the URL doesn't have a
+        # trailing slash and there is no pattern for the current path
+        if settings.APPEND_SLASH and (not old_url[1].endswith('/')):
+            try:
+                urlresolvers.resolve(request.path)
+            except urlresolvers.Resolver404:
+                new_url[1] = new_url[1] + '/'
+                if settings.DEBUG and request.method == 'POST':
+                    raise RuntimeError, ""
+                    "You called this URL via POST, but the URL doesn't end"
+                    "in a slash and you have APPEND_SLASH set. Django can't"
+                    "redirect to the slash URL while maintaining POST data."
+                    "Change your form to point to %s%s (note the trailing"
+                    "slash), or set APPEND_SLASH=False in your Django"
+                    "settings." % (new_url[0], new_url[1])
+
         if new_url != old_url:
-            # Redirect
-            if new_url[0]:
-                newurl = "%s://%s%s" % (request.is_secure() and 'https' or 'http', new_url[0], new_url[1])
+            # Redirect if the target url exists
+            try:
+                urlresolvers.resolve(new_url[1])
+            except urlresolvers.Resolver404:
+                pass
             else:
-                newurl = new_url[1]
-            if request.GET:
-                newurl += '?' + request.GET.urlencode()
-            return http.HttpResponsePermanentRedirect(newurl)
+                if new_url[0]:
+                    newurl = "%s://%s%s" % (
+                        request.is_secure() and 'https' or 'http',
+                        new_url[0], new_url[1])
+                else:
+                    newurl = new_url[1]
+                if request.GET:
+                    newurl += '?' + request.GET.urlencode()
+                return http.HttpResponsePermanentRedirect(newurl)
 
         return None
 

tests/regressiontests/middleware/tests.py

@@ +1 @@
+# -*- coding: utf-8 -*-
+
+import unittest
+
+from django.http import HttpRequest
+from django.middleware.common import CommonMiddleware
+from django.conf import settings
+
+class CommonMiddlewareTest(unittest.TestCase):
+    def setUp(self):
+        # blow cached urls from previous test cases
+        # django settings and urls are factored pretty badly for unit testing
+        from django.core import urlresolvers
+        keys = urlresolvers._resolver_cache.keys()
+        for key in keys:
+            del urlresolvers._resolver_cache[key] 
+        settings.ROOT_URLCONF = 'regressiontests.middleware.urls'
+        
+    def test_append_slash_have_slash(self):
+        # test that urls with slashes go unmolested
+        settings.APPEND_SLASH = True
+        request = HttpRequest()
+        request.path = '/slash/'
+        self.assertEquals(CommonMiddleware().process_request(request), None)
+
+    def test_append_slash_slashless_resource(self):
+        # test that matches to explicit slashless urls go unmolested
+        settings.APPEND_SLASH = True
+        request = HttpRequest()
+        request.path = '/noslash'
+        self.assertEquals(CommonMiddleware().process_request(request), None)
+
+    def test_append_slash_slashless_unknown(self):
+        # test that APPEND_SLASH doesn't redirect to unknown resources
+        settings.APPEND_SLASH = True
+        request = HttpRequest()
+        request.path = '/unknown'
+        self.assertEquals(CommonMiddleware().process_request(request), None)
+
+    def test_append_slash_redirect(self):
+        # test that APPEND_SLASH redirects slashless urls to a valid pattern
+        settings.APPEND_SLASH = True
+        request = HttpRequest()
+        request.path = '/slash'
+        r = CommonMiddleware().process_request(request)
+        self.assertEquals(r.status_code, 301)
+        self.assertEquals(r.headers['Location'], '/slash/')
+
+    def test_append_slash_no_redirect_on_POST_in_DEBUG(self):
+        settings.APPEND_SLASH = True
+        settings.DEBUG = True
+        request = HttpRequest()
+        request.path = '/slash'
+        request.method = 'POST'
+        self.assertRaises(RuntimeError, CommonMiddleware().process_request,
+            request)
+
+    def test_append_slash_disabled(self):
+        settings.APPEND_SLASH = False
+        request = HttpRequest()
+        request.path = '/slash'
+        self.assertEquals(CommonMiddleware().process_request(request), None)

tests/regressiontests/middleware/urls.py

@@ +1 @@
+from django.conf.urls.defaults import patterns
+
+urlpatterns = patterns('',
+    (r'^noslash$', 'view'),
+    (r'^slash/$', 'view'),
+)