Changeset 1067

Timestamp:

04/24/06 19:08:29

Author:

fumanchu

Message:

Fixed session module for the new tool API.

Files:

• trunk/cherrypy/__init__.py (modified) (1 diff)
• trunk/cherrypy/lib/sessions.py (modified) (18 diffs)
• trunk/cherrypy/test/test_session_filter.py (modified) (2 diffs)
• trunk/cherrypy/tools.py (modified) (2 diffs)

trunk/cherrypy/__init__.py

@@ -59 +59 @@
-thread_data = local()
-
-### Create variables needed for session (see lib/sessionfilter.py for more info)
-##from filters import sessionfilter
-##session = sessionfilter.SessionWrapper()
-##_session_data_holder = {} # Needed for RAM sessions only
-##_session_lock_dict = {} # Needed for RAM sessions only
-##_session_last_clean_up_time = datetime.datetime.now()
-
-def expose(func=None, alias=None):
-    """Expose the function, optionally providing an alias or set of aliases."""

trunk/cherrypy/lib/sessions.py

@@ -7 +7 @@
-
-Global variables (RAM backend only):
-cherrypy.
-cherrypy.
+
+
-
-"""
@@ -27 +27 @@
-import cherrypy
-
+_session_last_clean_up_time = datetime.datetime.now()
+_session_data_holder = {} # Needed for RAM sessions only
+_session_lock_dict = {} # Needed for RAM sessions only
+
-
-def generate_id():
@@ -32 +36 @@
-    return sha.new('%s' % random.random()).hexdigest()
-
+
+def noop(data): pass
-
-class Session:
@@ -44 +50 @@
-    """
-    
+    timeout = 60
+    locking = 'explicit'
+    deadlock_timeout = 30
+    clean_up_delay = 5
+    storage_type = 'Ram'
+    storage_class = None
+    cookie_name = 'session_id'
+    cookie_domain = None
+    cookie_secure = False
+    cookie_path = None
+    cookie_path_from_header = None
+    
-    def __init__(self):
-        conf = cherrypy.config.get
-        
-        self.storage = None
-        self.locked = False
-
-
-
-
-
-
-
-
-
-
-
-
-
-
+
+
+
+
+
+
+
+
+
+
-        
-        # People can set their own custom class
-
-
-
-
-
+
+
+
+
-        
-        now = datetime.datetime.now()
-        # Check if we need to clean up old sessions
-
-
+
+
+
-            # Run clean_up in other thread to avoid blocking this request
-            thread.start_new_thread(self.storage.clean_up, (self,))
@@ -80 +92 @@
-        self.data = {}
-        
+        if self.cookie_path is None:
+            if self.cookie_path_from_header is not None:
+                geth = cherrypy.request.headers.get
+                self.cookie_path = geth(self.cookie_path_from_header, None)
+            if self.cookie_path is None:
+                self.cookie_path = '/'
+        
-        # Check if request came with a session ID
-
-
-
-
-
-
-
-
-
-
-
+
-            # It did: we mark the data as needing to be loaded
-
+self.
-            
-            # If using implicit locking, acquire lock
@@ -101 +110 @@
-        else:
-            # No id yet
-gen
+self.generate
-            self.data['_id'] =  self.id
-            self.on_create(self.data)
@@ -107 +116 @@
-        # Set response cookie
-        cookie = cherrypy.response.simple_cookie
-
-cookie_name]['path'] = 
+self.
+self.cookie_name]['path'] = self.
-        # We'd like to use the "max-age" param as
-        #   http://www.faqs.org/rfcs/rfc2109.html indicates but IE doesn't
@@ -116 +125 @@
-        #cookie[cookie_name]['max-age'] = self.timeout * 60
-        gmt_expiration_time = time.gmtime(time.time() + (self.timeout * 60))
-
+self.
-                "%a, %d-%b-%Y %H:%M:%S GMT", gmt_expiration_time)
-
-cookie_name]['domain'] = 
-
-
+self.
+self.cookie_name]['domain'] = self.
+self.
+self.
-    
-    def save(self):
@@ -135 +144 @@
-            # Always release the lock if the user didn't release it
-            self.storage.release_lock()
+        
+        self.saved = True
-
-
@@ -143 +154 @@
-
-class SessionNotEnabledError(Exception):
-session_filter
+tools.sessions
-    pass
-
-NotConfigured
+
-    """User set storage_type to file but forgot to set the storage_path"""
-    pass
-
-
-class SessionFilter(basefilter.BaseFilter):
-    
-    def before_request_body(self):
-        if cherrypy.config.get('session_filter.on', False):
-            cherrypy.request._session = Session()
-    
-    def before_finalize(self):
-        sess = getattr(cherrypy.request, "_session", None)
-        if sess:
-            # Make a wrapper around the body in order to save the session
-            #   either before or after the body is returned
-            def save_session_data(body, sess):
-                if isinstance(body, types.GeneratorType):
-                    for line in body:
-                        yield line
-                    sess.save()
-                else:
-                    sess.save()
-                    for line in body:
-                        yield line
-            cherrypy.response.body = save_session_data(cherrypy.response.body, sess)
-    
-    def on_end_request(self):
-        sess = getattr(cherrypy.request, "_session", None)
-        if sess:
-            if sess.locked:
-                # If the session is still locked we release the lock
-                sess.storage.release_lock()
-            if sess.storage:
-                sess.storage = None
-
-
-class RamStorage:
-    """ Implementation of the RAM backend for sessions """
-    
-    def load(self, id):
-cherrypy.
+
-    
-    def save(self, id, data, expiration_time):
-cherrypy.
+
-    
-    def acquire_lock(self):
-        sess = cherrypy.request._session
-        id = cherrypy.session.id
-cherrypy.
+
-        if lock is None:
-            lock = threading.Lock()
-cherrypy.
+
-        startTime = time.time()
-        while True:
@@ -209 +188 @@
-    
-    def release_lock(self):
-
-
-
-
+
+
-    
-    def clean_up(self, sess):
-        to_be_deleted = []
-        now = datetime.datetime.now()
-cherrypy.
+
-            if expiration_time < now:
-                to_be_deleted.append(id)
-        for id in to_be_deleted:
-            try:
-cherrypy.
-cherrypy.
+
+
-                sess.on_delete(deleted_session)
-            except KeyError:
@@ -254 +231 @@
-    
-    def acquire_lock(self):
-        sess = cherrypy.request._session
-        file_path = self._get_file_path(cherrypy.session.id)
-
-
-
+
+
-    
-    def release_lock(self):
-        sess = cherrypy.request._session
-        file_path = self._get_file_path(cherrypy.session.id)
-
-
-
+
+
-    
-    def clean_up(self, sess):
-cherrypy.config.get('session_filter.storage_path'
+getattr(sess, "storage_path"
-        if storage_path is None:
-            return
@@ -294 +267 @@
-    
-    def _get_file_path(self, id):
-cherrypy.config.get('session_filter.storage_path'
+getattr(cherrypy.request._session, "storage_path"
-        if storage_path is None:
-NotConfigured
+
-        fileName = self.SESSION_PREFIX + id
-        file_path = os.path.join(storage_path, fileName)
@@ -302 +275 @@
-    
-    def _lock_file(self, path):
-sess = cherrypy.request._session
+timeout = cherrypy.request._session.deadlock_timeout
-        startTime = time.time()
-        while True:
@@ -308 +281 @@
-                lockfd = os.open(path, os.O_CREAT|os.O_WRONLY|os.O_EXCL)
-            except OSError:
-sess.deadlock_
+
-                    raise SessionDeadlockError()
-                time.sleep(0.5)
@@ -331 +304 @@
-    
-    def __init__(self):
-config.get('session_filter.get_db')
+request._session.get_db
-        self.cursor = self.db.cursor()
-    
@@ -407 +380 @@
-        elif name == 'id':
-            return sess.id
-
+
-        if not sess.loaded:
-            data = sess.storage.load(sess.id)
@@ -423 +396 @@
-        return getattr(sess.data, name)
-
+
+# The actual hook functions
+
+def save():
+    # Save the session either before or after the body is returned
+    if not isinstance(cherrypy.response.body, types.GeneratorType):
+        cherrypy.request._session.save()
+
+def cleanup():
+    sess = cherrypy.request._session
+    if not sess.saved:
+        sess.save()
+    
+    if sess.locked:
+        # If the session is still locked we release the lock
+        sess.storage.release_lock()
+    if sess.storage:
+        sess.storage = None
+
+def wrap(*args, **kwargs):
+    """Make a decorator for this tool."""
+    def deco(f):
+        def wrapper(*a, **kw):
+            return f(*a, **kw)
+            save(*args, **kwargs)
+            cherrypy.request.hooks.attach('on_end_request', cleanup)
+        return wrapper
+    return deco
+
+def setup(conf):
+    """Hook this tool into cherrypy.request using the given conf.
+    
+    The standard CherryPy request object will automatically call this
+    method when the tool is "turned on" in config.
+    """
+    def wrapper():
+        s = cherrypy.request._session = Session()
+        for k, v in conf.iteritems():
+            setattr(s, str(k), v)
+        s.load()
+        
+        if not hasattr(cherrypy, "session"):
+            cherrypy.session = SessionWrapper()
+    
+    cherrypy.request.hooks.attach('before_request_body', wrapper)
+    cherrypy.request.hooks.attach('before_finalize', save)
+    cherrypy.request.hooks.attach('on_end_request', cleanup)

trunk/cherrypy/test/test_session_filter.py

@@ -20 +20 @@
-        
-        def setsessiontype(self, newtype):
-session_filter
+tools.sessions
-        setsessiontype.exposed = True
-        
@@ -27 +27 @@
-            'server.log_to_screen': False,
-            'server.environment': 'production',
-session_filter
-session_filter
-session_filter
+tools.sessions
+tools.sessions
+tools.sessions
-    })
-

trunk/cherrypy/tools.py

@@ -126 +126 @@
-
-from cherrypy.lib import cptools
+session_auth = MainTool(cptools.session_auth)
-base_url = Tool('before_request_body', cptools.base_url)
-response_headers = Tool('before_finalize', cptools.response_headers)
@@ -153 +154 @@
-
-# These modules are themselves Tools
-
+sessions,