"""Session store in memory."""
from MiscUtils import NoDefault
from SessionStore import SessionStore
from SessionFileStore import SessionFileStore
class SessionMemoryStore(SessionStore):
"""Stores the session in memory as a dictionary.
This is fast and secure when you have one, persistent app server.
"""
def __init__(self, app, restoreFiles=True):
"""Initialize the session memory store.
If restoreFiles is true, and sessions have been saved to file,
the store will be initialized from these files.
"""
SessionStore.__init__(self, app)
self._store = {}
if restoreFiles:
filestore = SessionFileStore(app)
for key in filestore:
try:
self[key] = filestore[key]
except Exception:
app.handleException()
filestore.clear()
def __len__(self):
"""Return the number of sessions in the store."""
return len(self._store)
def __getitem__(self, key):
"""Get a session item from the store."""
return self._store[key]
def __setitem__(self, key, value):
"""Set a session item, saving it to the store."""
value.setDirty(False)
self._store[key] = value
def __delitem__(self, key):
"""Delete a session item from the store."""
session = self[key]
if not session.isExpired():
session.expiring()
del self._store[key]
def __contains__(self, key):
"""Check whether the session store has a given key."""
return key in self._store
def __iter__(self):
"""Return an iterator over the stored session keys."""
return iter(self._store)
def keys(self):
"""Return a list with the keys of all the stored sessions."""
return self._store.keys()
def clear(self):
"""Clear the session store, removing all of its items."""
self._store.clear()
def setdefault(self, key, default=None):
"""Return value if key available, else default (also setting it)."""
return self._store.setdefault(key, default)
def pop(self, key, default=NoDefault):
"""Return value if key available, else default (also remove key)."""
if default is NoDefault:
return self._store.pop(key)
else:
return self._store.pop(key, default)
def storeSession(self, session):
"""Save already potentially changed session in the store."""
if self._alwaysSave or session.isDirty():
key = session.identifier()
if key not in self or self[key] is not session:
self[key] = session
def storeAllSessions(self):
"""Permanently save all sessions in the store."""
filestore = SessionFileStore(self._app)
for key in self:
filestore[key] = self[key]