Changeset 1523

Timestamp:

12/11/06 16:16:56

Author:

fumanchu

Message:

2.x backport of [1330] (new cptools.referer) and [1422] (new cptools.accept(media)). See test_misc_tools.py for usage.

Files:

• branches/cherrypy-2.x/cherrypy/lib/cptools.py (modified) (2 diffs)
• branches/cherrypy-2.x/cherrypy/test/test.py (modified) (1 diff)
• branches/cherrypy-2.x/cherrypy/test/test_misc_tools.py (added)

branches/cherrypy-2.x/cherrypy/lib/cptools.py

@@ -9 +9 @@
-
-import os
+import re
-import stat as _stat
-import sys
@@ -434 +435 @@
-    return Builder().build(getObj(s))
-
+
+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)
+
+def accept(media=None):
+    """Return the client's preferred media-type (from the given Content-Types).
+    
+    If 'media' is None (the default), no test will be performed.
+    
+    If 'media' is provided, it should be the Content-Type value (as a string)
+    or values (as a list or tuple of strings) which the current request
+    can emit. The client's acceptable media ranges (as declared in the
+    Accept request header) will be matched in order to these Content-Type
+    values; the first such string is returned. That is, the return value
+    will always be one of the strings provided in the 'media' arg (or None
+    if 'media' is None).
+    
+    If no match is found, then HTTPError 406 (Not Acceptable) is raised.
+    Note that most web browsers send */* as a (low-quality) acceptable
+    media range, which should match any Content-Type. In addition, "...if
+    no Accept header field is present, then it is assumed that the client
+    accepts all media types."
+    
+    Matching types are checked in order of client preference first,
+    and then in the order of the given 'media' values.
+    
+    Note that this function does not honor accept-params (other than "q").
+    """
+    if not media:
+        return
+    if isinstance(media, basestring):
+        media = [media]
+    
+    # Parse the Accept request header, and try to match one
+    # of the requested media-ranges (in order of preference).
+    ranges = cherrypy.request.headers.elements('Accept')
+    if not ranges:
+        # Any media type is acceptable.
+        return media[0]
+    else:
+        # Note that 'ranges' is sorted in order of preference
+        for element in ranges:
+            if element.qvalue > 0:
+                if element.value == "*/*":
+                    # Matches any type or subtype
+                    return media[0]
+                elif element.value.endswith("/*"):
+                    # Matches any subtype
+                    mtype = element.value[:-1]  # Keep the slash
+                    for m in media:
+                        if m.startswith(mtype):
+                            return m
+                else:
+                    # Matches exact value
+                    if element.value in media:
+                        return element.value
+    
+    # No suitable media-range found.
+    ah = cherrypy.request.headers.get('Accept')
+    if ah is None:
+        msg = "Your client did not send an Accept header."
+    else:
+        msg = "Your client sent this Accept header: %s." % ah
+    msg += (" But this resource only emits these media types: %s." %
+            ", ".join(media))
+    raise cherrypy.HTTPError(406, msg)
+

branches/cherrypy-2.x/cherrypy/test/test.py

@@ -300 +300 @@
-        'test_gzip_filter',
-        'test_logdebuginfo_filter',
+        'test_misc_tools',
-        'test_objectmapping',
-        'test_response_headers_filter',