Changeset 1369

Timestamp:

09/16/06 15:08:31

Author:

fumanchu

Message:

Fix for #562 (Redirect for slash doesn't use tools.proxy.base). Moved slash checking into new tools.trailing_slash(missing=True, extra=False), which is on by default. The core now sets request.is_index to allow such tools to work. In addition, if that tool is off, mismatched slashes will be corrected in cherrypy.url.

Files:

• trunk/cherrypy/__init__.py (modified) (1 diff)
• trunk/cherrypy/_cpconfig.py (modified) (1 diff)
• trunk/cherrypy/_cprequest.py (modified) (4 diffs)
• trunk/cherrypy/_cptools.py (modified) (1 diff)
• trunk/cherrypy/lib/cptools.py (modified) (1 diff)
• trunk/cherrypy/test/test_core.py (modified) (4 diffs)
• trunk/cherrypy/test/test_objectmapping.py (modified) (1 diff)
• trunk/cherrypy/test/test_proxy.py (modified) (2 diffs)

trunk/cherrypy/__init__.py

@@ -172 +172 @@
-    
-    if request.app:
-
-
-
-
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
-        if script_name is None:
-            script_name = request.app.script_name

trunk/cherrypy/_cpconfig.py

@@ -121 +121 @@
-        'tools.log_tracebacks.on': True,
-        'tools.log_headers.on': True,
+        'tools.trailing_slash.on': True,
-        }
-    

trunk/cherrypy/_cprequest.py

@@ -201 +201 @@
-                    object_trail.insert(i+1, ("default", defhandler, conf, curpath))
-                    request.config = set_conf()
+                    request.is_index = False
-                    return defhandler, names[i:-1]
-            
@@ -210 +211 @@
-                request.config = set_conf()
-                if i == num_candidates:
-Check that path_info
-has a trailing slash (otherwise, do a redirect)
-self.check_missing_slash()
+Mark request so tools
+can redirect if path_info has no trailing slash
+request.is_index = True
-                else:
-
-
-
+
+
+
+
+
-                return candidate, names[i:-1]
-        
@@ -222 +225 @@
-        request.config = set_conf()
-        return None, []
-    
-    def check_missing_slash(self):
-        """Redirect if path_info has no trailing slash (if configured)."""
-        request = cherrypy.request
-        pi = request.path_info
-        
-        # Must use config here because configure probably hasn't run yet.
-        if request.config.get("request.redirect_on_missing_slash",
-                              request.redirect_on_missing_slash):
-            if pi[-1:] != '/':
-                new_url = cherrypy.url(pi + '/', request.query_string)
-                raise cherrypy.HTTPRedirect(new_url)
-    
-    def check_extra_slash(self):
-        """Redirect if path_info has trailing slash (if configured)."""
-        request = cherrypy.request
-        pi = request.path_info
-        
-        # Must use config here because configure hasn't run yet.
-        if request.config.get("request.redirect_on_extra_slash",
-                              request.redirect_on_extra_slash):
-            # If pi == '/', don't redirect to ''!
-            if pi[-1:] == '/' and pi != '/':
-                new_url = cherrypy.url(pi[:-1], request.query_string)
-                raise cherrypy.HTTPRedirect(new_url)
-
-
@@ -357 +335 @@
-    config = None
-    recursive_redirect = False
-
-
+
-    
-    hookpoints = ['on_start_resource', 'before_request_body',

trunk/cherrypy/_cptools.py

@@ -319 +319 @@
-default_toolbox.basicauth = Tool('on_start_resource', auth.basic_auth)
-default_toolbox.digestauth = Tool('on_start_resource', auth.digest_auth)
-
+
-
-del cptools, encoding, auth, static, tidy

trunk/cherrypy/lib/cptools.py

@@ -308 +308 @@
-    else:
-        raise cherrypy.HTTPRedirect(url)
+
+def trailing_slash(missing=True, extra=False):
+    """Redirect if path_info has (missing|extra) trailing slash."""
+    request = cherrypy.request
+    pi = request.path_info
+    
+    if request.is_index is True:
+        if missing:
+            if pi[-1:] != '/':
+                new_url = cherrypy.url(pi + '/', request.query_string)
+                raise cherrypy.HTTPRedirect(new_url)
+    elif request.is_index is False:
+        if extra:
+            # If pi == '/', don't redirect to ''!
+            if pi[-1:] == '/' and pi != '/':
+                new_url = cherrypy.url(pi[:-1], request.query_string)
+                raise cherrypy.HTTPRedirect(new_url)
+

trunk/cherrypy/test/test_core.py

@@ -70 +70 @@
-    class URL(Test):
-        
+        _cp_config = {'tools.trailing_slash.on': False}
+        
-        def index(self, path_info, relative=None):
-            return cherrypy.url(path_info, relative=bool(relative))
@@ -134 +136 @@
-        def by_code(self, code):
-            raise cherrypy.HTTPRedirect("somewhere else", code)
+        by_code._cp_config = {'tools.trailing_slash.extra': True}
-        
-        def nomodify(self):
@@ -512 +515 @@
-            ignore.pop()
-    
-
-
-
-
-
+
-        # Test that requests for index methods without a trailing slash
-        # get redirected to the same URI path with a trailing slash.
@@ -532 +531 @@
-            self.assertInBody("<a href='%s/'>%s/</a>" %
-                              (self.base(), self.base()))
+        
+        # Test that requests for NON-index methods WITH a trailing slash
+        # get redirected to the same URI path WITHOUT a trailing slash.
+        # Make sure GET params are preserved.
+        self.getPage("/redirect/by_code/?code=307")
+        self.assertStatus(('302 Found', '303 See Other'))
+        self.assertInBody("<a href='%s/redirect/by_code?code=307'>"
+                          "%s/redirect/by_code?code=307</a>"
+                          % (self.base(), self.base()))
+        
+        # If the trailing_slash tool is off, CP should just continue
+        # as if the slashes were correct. But it needs some help
+        # inside cherrypy.url to form correct output.
+        self.getPage('/url?path_info=page1')
+        self.assertBody('%s/url/page1' % self.base())
+        self.getPage('/url/leaf/?path_info=page1')
+        self.assertBody('%s/url/page1' % self.base())
+    
+    def testRedirect(self):
+        self.getPage("/redirect/")
+        self.assertBody('child')
+        self.assertStatus(200)
-        
-        self.getPage("/redirect/by_code?code=300")

trunk/cherrypy/test/test_objectmapping.py

@@ -65 +65 @@
-            return "myMethod from dir1, path_info is:" + repr(cherrypy.request.path_info)
-        myMethod.exposed = True
-request.redirect_on_extra_slash
+tools.trailing_slash.extra
-        
-        def default(self, *params):

trunk/cherrypy/test/test_proxy.py

@@ -19 +19 @@
-            raise cherrypy.HTTPRedirect('blah')
-        xhost.exposed = True
-
+
+
+
-        
-        def base(self):
@@ -92 +94 @@
-                             "%s://%s%s%s/this/new/page"
-                             % (self.scheme, self.HOST, port, sn))
+        
+        # Test trailing slash (see http://www.cherrypy.org/ticket/562).
+        self.getPage("/xhost/", headers=[('X-Host', 'www.yetanother.com')])
+        self.assertHeader('Location', "%s://www.yetanother.com/xhost"
+                          % self.scheme)
-
-