Changeset 1330

Timestamp:

09/04/06 01:19:27

Author:

fumanchu

Message:

New tools.referer, and moved test_response_headers into new test_misc_tools.

Files:

• trunk/cherrypy/_cptools.py (modified) (2 diffs)
• trunk/cherrypy/lib/cptools.py (modified) (2 diffs)
• trunk/cherrypy/test/test.py (modified) (1 diff)
• trunk/cherrypy/test/test_misc_tools.py (moved) (moved from trunk/cherrypy/test/test_response_headers.py) (2 diffs)

trunk/cherrypy/_cptools.py

@@ -269 +269 @@
-        else:
-            # Note the devious technique here of adding hooks on the fly
-
+
+
+
-    
-    def _setup(self):
@@ -314 +316 @@
-default_toolbox.nsgmls = Tool('before_finalize', tidy.nsgmls)
-default_toolbox.ignore_headers = Tool('before_request_body', cptools.ignore_headers)
+default_toolbox.referer = Tool('before_request_body', cptools.referer)
-
-

trunk/cherrypy/lib/cptools.py

@@ -1 +1 @@
-"""Functions for builtin CherryPy tools."""
+
+import re
-
-import cherrypy
@@ -141 +143 @@
-        cherrypy.response.headers[name] = value
-response_headers.failsafe = True
+
+
+def referer(pattern, accept=True, accept_missing=False, error=403,
+            message='Forbidden Referer header.'):
+    """Raise HTTPError if Referer header does not pass our test.
+    
+    pattern: a regular expression pattern to test against the Referer.
+    accept: if True, the Referer must match the pattern; if False,
+        the Referer must NOT match the pattern.
+    accept_missing: if True, permit requests with no Referer header.
+    error: the HTTP error code to return to the client on failure.
+    message: a string to include in the response body on failure.
+    """
+    try:
+        match = bool(re.match(pattern, cherrypy.request.headers['Referer']))
+        if accept == match:
+            return
+    except KeyError:
+        if accept_missing:
+            return
+    
+    raise cherrypy.HTTPError(error, message)
-
-

trunk/cherrypy/test/test.py

@@ -314 +314 @@
-        'test_gzip',
-        'test_objectmapping',
-response_header
+misc_tool
-        'test_static',
-        'test_tutorials',

trunk/cherrypy/test/test_misc_tools.py

@@ -23 +23 @@
-            }
-    
-
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
-    cherrypy.config.update({'environment': 'test_suite'})
-
@@ -41 +57 @@
-        self.assertHeader('Content-Type', 'text/plain')
-
+
+class RefererTest(helper.CPWebCase):
+    
+    def testReferer(self):
+        self.getPage('/referer/accept')
+        self.assertErrorPage(403, 'Forbidden Referer header.')
+        
+        self.getPage('/referer/accept',
+                     headers=[('Referer', 'http://www.thisdomain.com/')])
+        self.assertStatus(200)
+        self.assertBody('Accepted!')
+        
+        # Reject
+        self.getPage('/referer/reject')
+        self.assertStatus(200)
+        self.assertBody('Accepted!')
+        
+        self.getPage('/referer/reject',
+                     headers=[('Referer', 'http://www.thisdomain.com/')])
+        self.assertErrorPage(403, 'Forbidden Referer header.')
+
+
-if __name__ == "__main__":
-    setup_server()