Changeset 1506

Timestamp:

12/10/06 16:48:58

Author:

fumanchu

Message:

2.x backport of [1202], [1203] (new expires function, plus Response.time attribute).

Files:

• branches/cherrypy-2.x/cherrypy/_cphttptools.py (modified) (3 diffs)
• branches/cherrypy-2.x/cherrypy/filters/cachefilter.py (modified) (2 diffs)
• branches/cherrypy-2.x/cherrypy/test/test_cache_filter.py (modified) (3 diffs)

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

@@ -4 +4 @@
-import os
-import sys
+import time
-import types
-
@@ -365 +366 @@
-        self.header_list = None
-        self.body = None
+        self.time = time.time()
-        
-        self.headers = httptools.HeaderMap()
@@ -372 +374 @@
-            "Content-Type": content_type,
-            "Server": "CherryPy/" + cherrypy.__version__,
-
+time.gmtime(self.time)
-            "Set-Cookie": [],
-            "Content-Length": None

branches/cherrypy-2.x/cherrypy/filters/cachefilter.py

@@ -1 @@
-
+
+
-import threading
-import Queue
-import time
-
-import cherrypy
+from cherrypy.lib import httptools
-import basefilter
-
@@ -212 +213 @@
-        yield "Total non-modified content: %d\n" % cache.totNonModified
-    index.exposed = True
+
+
+def expires(secs=0, force=False):
+    """Tool for influencing cache mechanisms using the 'Expires' header.
+    
+    'secs' must be either an int or a datetime.timedelta, and indicates the
+    number of seconds between response.time and when the response should
+    expire. The 'Expires' header will be set to (response.time + secs).
+    
+    If 'secs' is zero, the following "cache prevention" headers are also set:
+       'Pragma': 'no-cache'
+       'Cache-Control': 'no-cache'
+    
+    If 'force' is False (the default), the following headers are checked:
+    'Etag', 'Last-Modified', 'Age', 'Expires'. If any are already present,
+    none of the above response headers are set.
+    """
+    
+    response = cherrypy.response
+    
+    cacheable = False
+    if not force:
+        # some header names that indicate that the response can be cached
+        for indicator in ('Etag', 'Last-Modified', 'Age', 'Expires'):
+            if indicator in response.headers:
+                cacheable = True
+                break
+    
+    if not cacheable:
+        if isinstance(secs, datetime.timedelta):
+            secs = (86400 * secs.days) + secs.seconds
+        
+        if secs == 0:
+            if force or ("Pragma" not in response.headers):
+                response.headers["Pragma"] = "no-cache"
+            if cherrypy.response.version >= "1.1":
+                if force or ("Cache-Control" not in response.headers):
+                    response.headers["Cache-Control"] = "no-cache"
+        
+        expiry = httptools.HTTPDate(time.gmtime(response.time + secs))
+        if force or ("Expires" not in response.headers):
+            response.headers["Expires"] = expiry

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

@@ -3 +3 @@
-
-import cherrypy
-
+
-
-
@@ -16 +16 @@
-            return msg
-        index.exposed = True
-
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
-    cherrypy.root = Root()
+    cherrypy.root.expires = UnCached()
-    cherrypy.config.update({
-
-
-
+
+
+
+
+
-    })
-
@@ -51 +81 @@
-        self.getPage("/", method="GET")
-        self.assertBody('visit #5')
+    
+    def testExpiresTool(self):
+        
+        # test setting an expires header
+        self.getPage("/expires/specific")
+        self.assertStatus("200 OK")
+        self.assertHeader("Expires")
+        
+        # dynamic content that sets indicators should not have
+        # "cache prevention" headers
+        self.getPage("/expires/cacheable")
+        self.assertStatus("200 OK")
+        self.assertNoHeader("Pragma")
+        self.assertNoHeader("Cache-Control")
+        
+        self.getPage('/expires/dynamic')
+        self.assertBody("D-d-d-dynamic!")
+        # the Cache-Control header should be untouched
+        self.assertHeader("Cache-Control", "private")
+        
+        # configure the tool to ignore indicators and replace existing headers
+        self.getPage("/expires/force")
+        self.assertStatus("200 OK")
+        # This also gives us a chance to test 0 expiry with no other headers
+        self.assertHeader("Pragma", "no-cache")
+        conf = cherrypy.config.get
+        if conf('server.protocol_version', '') == "HTTP/1.1":
+            self.assertHeader("Cache-Control", "no-cache")
+        d = self.assertHeader("Date")
+        self.assertHeader("Expires", d)
+        
+        # the cacheable handler should now have "cache prevention" headers
+        self.getPage("/expires/cacheable")
+        self.assertStatus("200 OK")
+        self.assertHeader("Pragma", "no-cache")
+        if conf('server.protocol_version', '') == "HTTP/1.1":
+            self.assertHeader("Cache-Control", "no-cache")
+        d = self.assertHeader("Date")
+        self.assertHeader("Expires", d)
+        
+        self.getPage('/expires/dynamic')
+        self.assertBody("D-d-d-dynamic!")
+        # dynamic sets Cache-Control to private but it should  be
+        # overwritten here ...
+        self.assertHeader("Pragma", "no-cache")
+        if conf('server.protocol_version', '') == "HTTP/1.1":
+            self.assertHeader("Cache-Control", "no-cache")
+        d = self.assertHeader("Date")
+        self.assertHeader("Expires", d)
-
-