Ticket #1927: visit-from-params.diff

turbogears/identity/tests/test_visit.py

@@ -14 +14 @@
 
     @expose()
     def index(self):
-        new = None
-        if visit.current():
-            new = visit.current().is_new
+        new = visit_key = None
+        cur_visit = visit.current()
+        if cur_visit:
+            new = cur_visit.is_new
+            key = cur_visit.key
         visit_on = config.get('visit.on')
-        return dict(new=new, visit_on=visit_on)
+        return dict(new=new, key=key, visit_on=visit_on)
 
 
 class TestVisit(TestCase):
@@ -26 +28 @@
     def setUp(self):
         testutil.stop_server(tg_only = True)
         self._visit_on = config.get('visit.on', False)
+        self._visit_source = config.get('visit.source', 'cookie')
         config.update({'visit.on': True})
         self._visit_timeout = config.get('visit.timeout', 20)
         config.update({'visit.timeout': 50})
         self.cookie_name = config.get("visit.cookie.name", 'tg-visit')
+        self._visit_key_param = config.get("visit.param.visit_key", 'tg_visit')
         self.app = testutil.make_app(VisitRoot)
         testutil.start_server()
 
@@ -53 +57 @@
         response = self.app.get("/")
         # first visit's cookie
         print "Headers", response.headers
-        print "Config", config.get('visit.on')
+        print "Visit on", config.get('visit.on')
         morsel = response.cookies_set[self.cookie_name]
         response = self.app.get("/", headers=cookie_header(response))
         assert not response.raw['new']
 
+    def test_visit_from_params(self):
+        """Test if the visit key is retrieved from the request params."""
+        _app = self.app
+        try:
+            testutil.stop_server(tg_only = True)
+            config.update({'visit.source': 'cookie,param'})
+            self.app = testutil.make_app(VisitRoot)
+            testutil.start_server()
+            response = self.app.get("/")
+            # first visit's cookie
+            first_key = response.raw.get('key')
+            # give the visit extension time to set up its model tables
+            time.sleep(2)
+            self.app.cookies = {}
+            response = self.app.get("/",
+                params={self._visit_key_param: first_key})
+        finally:
+            config.update({'visit.source': self._visit_source})
+            self.app = _app
+        assert first_key == response.raw['key']
+
     def test_cookie_expires(self):
         """Test if the visit timeout mechanism works."""
         timeout = config.get('visit.timeout', 50)
@@ -107 +132 @@
             '%a, %d-%b-%Y %H:%M:%S GMT')[:8] + (0,))
         should_expire = time.mktime(time.gmtime()) + int(morsel['max-age'])
         assert abs(should_expire - expires) < 3, (should_expire, expires, should_expire - expires)
-

turbogears/visit/api.py

@@ -174 +174 @@
     def __init__(self):
         log.info("Visit filter initialised")
         get = config.get
+        # Where to look for the session key in the reqeust and in which order
+        self.source = [s.strip().lower() for s in
+            get("visit.source", "cookie").split(',')]
         # Get the name to use for the identity cookie.
         self.cookie_name = get("visit.cookie.name", "tg-visit")
+        self.visit_key_param = get("visit.param.visit_key", 'tg_visit')
+        if set(self.source).difference(('cookie', 'param')):
+            log.warning("Unsupported 'visit.source' '%s' in configuration.")
         # TODO: The path should probably default to whatever
         # the root is masquerading as in the event of a
         # virtual path filter.
@@ -196 +202 @@
             set_current(None)
             return
         visit = current()
-        cookies = cherrypy.request.simple_cookie
         if not visit:
-            if self.cookie_name in cookies:
-                # Process visit based on cookie
-                visit_key = cookies[self.cookie_name].value
+            visit_key = None
+            for source in self.source:
+                if source == 'cookie':
+                    cookies = cherrypy.request.simple_cookie
+                    if self.cookie_name in cookies:
+                        # Get visit key from cookie
+                        visit_key = cookies[self.cookie_name].value
+                        break
+                elif source == 'param':
+                    # Get visit key from request parameters (GET _or_ POST)
+                    try:
+                        visit_key = cherrypy.request.params[self.visit_key_param]
+                        del cherrypy.request.params[self.visit_key_param]
+                    except KeyError:
+                        pass
+                    break
+            if visit_key:
                 visit = _manager.visit_for_key(visit_key)
             if not visit:
                 visit_key = self._generate_key()

turbogears/qstemplates/quickstart/+package+/config/app.cfg_tmpl

@@ -92 +92 @@
 # Number of minutes a visit may be idle before it expires.
 # visit.timeout=20
 
+# Where to look for the key of an existing visit in the request and in which
+# order. Comma-separated list of possible values: 'cookie', 'param'.
+# By default only use visit key in session cookie
+# visit.source="cookie"
+
 # The name of the cookie to transmit to the visitor's browser.
 # visit.cookie.name="tg-visit"
 
+# The name of the request parameter with the session key (for when
+# 'visit.source' includes 'param'). Name MUST NOT contain dashes or dots!
+# visit.param.visit_key="tg_visit"
+
 # Domain name to specify when setting the cookie (must begin with . according to
 # RFC 2109). The default (None) should work for most cases and will default to
 # the machine to which the request was made. NOTE: localhost is NEVER a valid