Ticket #3228: smartslash-3.diff

django/middleware/common.py

@@ -5 +5 @@
-from django import http
-from django.core.mail import mail_managers
-from django.utils.http import urlquote
+from django.core import urlresolvers
-
-class CommonMiddleware(object):
-    """
@@ -16 +17 @@
-          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.
@@ -33 +40 @@
-                if user_agent_regex.search(request.META['HTTP_USER_AGENT']):
-                    return http.HttpResponseForbidden('<h1>Forbidden</h1>')
-
-
+
+
-        host = request.get_host()
-        old_url = [host, request.path]
-        new_url = old_url[:]
-
+
+
+
-            new_url[0] = 'www.' + old_url[0]
-
-
-
-
-
-
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
-        if new_url != old_url:
-
-
-
+
+
+
+
+
-            else:
-
-
-
-
+
+
+
+
+
+
+
+
+
-
-        return None
-

tests/regressiontests/middleware/tests.py

@@ +1 @@
+# -*- coding: utf-8 -*-
+
+import unittest
+
+from django.test import TestCase 
+from django.http import HttpRequest
+from django.middleware.common import CommonMiddleware
+from django.conf import settings
+
+class CommonMiddlewareTest(TestCase):
+    def _get_request(self, path):
+        request = HttpRequest()
+        request.META = {
+            'SERVER_NAME': 'testserver',
+            'SERVER_PORT': 80,
+        }
+        request.path = "/middleware/%s" % path
+        return request
+
+    def test_append_slash_have_slash(self):
+        """
+        tests that urls with slashes go unmolested
+        """
+        settings.APPEND_SLASH = True
+        request = self._get_request('slash/')
+        self.assertEquals(CommonMiddleware().process_request(request), None)
+
+    def test_append_slash_slashless_resource(self):
+        """
+        tests that matches to explicit slashless urls go unmolested
+        """
+        settings.APPEND_SLASH = True
+        request = self._get_request('noslash')
+        self.assertEquals(CommonMiddleware().process_request(request), None)
+
+    def test_append_slash_slashless_unknown(self):
+        """
+        tests that APPEND_SLASH doesn't redirect to unknown resources
+        """
+        settings.APPEND_SLASH = True
+        request = self._get_request('unknown')
+        self.assertEquals(CommonMiddleware().process_request(request), None)
+
+    def test_append_slash_redirect(self):
+        """
+        tests that APPEND_SLASH redirects slashless urls to a valid pattern
+        """
+        settings.APPEND_SLASH = True
+        request = self._get_request('slash')
+        r = CommonMiddleware().process_request(request)
+        self.assertEquals(r.status_code, 301)
+        self.assertEquals(r['Location'], 'http://testserver/middleware/slash/')
+
+    def test_append_slash_no_redirect_on_POST_in_DEBUG(self):
+        """
+        tests that while in debug mode, an exception is raised with a warning
+        when a failed attempt is made to POST to an url which would normally be
+        redirected to a slashed version
+        """
+        settings.APPEND_SLASH = True
+        settings.DEBUG = True
+        request = self._get_request('slash')
+        request.method = 'POST'
+        self.assertRaises(
+            RuntimeError,
+            CommonMiddleware().process_request,
+            request)
+        try:
+            CommonMiddleware().process_request(request)
+        except RuntimeError, e:
+            self.assertTrue('end in a slash' in str(e))
+
+    def test_append_slash_disabled(self):
+        """
+        tests disabling append slash functionality
+        """
+        settings.APPEND_SLASH = False
+        request = self._get_request('slash')
+        self.assertEquals(CommonMiddleware().process_request(request), None)
+
+    def test_append_slash_quoted(self):
+        """
+        tests that urls which require quoting are redirected to their slash
+        version ok
+        """
+        settings.APPEND_SLASH = True
+        request = self._get_request('needsquoting#')
+        r = CommonMiddleware().process_request(request)
+        self.assertEquals(r.status_code, 301)
+        self.assertEquals(
+            r['Location'],
+            'http://testserver/middleware/needsquoting%23/')
+

tests/regressiontests/middleware/urls.py

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

tests/urls.py

@@ -14 +14 @@
-    
-    # django built-in views
-    (r'^views/', include('regressiontests.views.urls')),
+
+    # test urlconf for middleware tests
+    (r'^middleware/', include('regressiontests.middleware.urls')),
-)

docs/middleware.txt

@@ -58 +58 @@
-  which should be a list of strings.
-
-* Performs URL rewriting based on the ``APPEND_SLASH`` and ``PREPEND_WWW``
-
-
-
-
-
+
-
+  **New in Django development version:** If ``APPEND_SLASH`` is ``True`` 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. 
+
+  So ``foo.com/bar`` is will be redirected to ``foo.com/bar/`` if you do not
+  have a valid urlpattern for ``foo.com/bar``, and do have a valid urlpattern
+  for ``foo.com/bar/``.
+  
-  If ``PREPEND_WWW`` is ``True``, URLs that lack a leading "www." will be
-  redirected to the same URL with a leading "www."
-