Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Enable support for SESSION_REFRESH_EACH_REQUEST #46

Open
wants to merge 6 commits into
base: master
Choose a base branch
from
Open

Enable support for SESSION_REFRESH_EACH_REQUEST #46

Changes from all commits
Commits
Show all changes
6 commits
Select commit Hold shift + click to select a range
e439d2c
Store expiration date in backend.
Jun 19, 2018
4824bc0
Revert "Store expiration date in backend."
Jun 19, 2018
9116aa9
Added logging.
Jun 19, 2018
e4bcdd1
Implemented storing expiration date in backend.
Jun 19, 2018
f25f267
More logging
Jun 19, 2018
a99aea2
Reformatted code
Jun 19, 2018
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
53 changes: 49 additions & 4 deletions flask_kvsession/__init__.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -9,6 +9,7 @@
except ImportError:
import pickle
from datetime import datetime
import logging
from random import SystemRandom
import re

Expand Down Expand Up @@ -102,6 +103,7 @@ def destroy(self):

self.modified = False
self.new = False
logging.getLogger("KVSession").debug("Session destroyed")

def regenerate(self):
"""Generate a new session id for this session.
Expand All @@ -122,6 +124,7 @@ def regenerate(self):
self.modified = True

# save_session() will take care of saving the session now
logging.getLogger("KVSession").debug("Session regenerated")


class KVSessionInterface(SessionInterface):
Expand All @@ -145,24 +148,51 @@ def open_session(self, app, request):
session_cookie).decode('ascii')
sid = SessionID.unserialize(sid_s)

if sid.has_expired(app.permanent_session_lifetime):
refresh = app.config["SESSION_REFRESH_EACH_REQUEST"]

if not refresh and sid.has_expired(
app.permanent_session_lifetime):
# we reach this point if a "non-permanent" session has
# expired, but is made permanent. silently ignore the
# error with a new session
logging.getLogger("KVSession").debug(
"Session expired (checked against session id)")
raise KeyError

# retrieve from store
s = self.session_class(self.serialization_method.loads(
current_app.kvsession_store.get(sid_s)))
s.sid_s = sid_s
try:
s = self.session_class(self.serialization_method.loads(
current_app.kvsession_store.get(sid_s)))
s.sid_s = sid_s
except:
logging.getLogger("KVSession").debug(
"Session not found in store")
raise KeyError

logging.getLogger("KVSession").debug("Session loaded")
if "t_expire" in s:
if (refresh
and s.permanent
and datetime.now() > s["t_expire"]):
logging.getLogger("KVSession").debug(
"Session expired "
"(checked against stored datetime)")
raise KeyError
logging.getLogger("KVSession").debug(
"Session will expire "
"at: {0}".format(s["t_expires"]))
except (BadSignature, KeyError):
# either the cookie was manipulated or we did not find the
# session in the backend.
logging.getLogger("KVSession").debug("No valid session")
pass
else:
logging.getLogger("KVSession").debug("No session cookie found")

if s is None:
s = self.session_class() # create an empty session
s.new = True
logging.getLogger("KVSession").debug("Empty session created")

return s

Expand All @@ -175,6 +205,15 @@ def save_session(self, app, session, response):
session.sid_s = SessionID(
current_app.config['SESSION_RANDOM_SOURCE'].getrandbits(
app.config['SESSION_KEY_BITS'])).serialize()
# store expiration date
session["t_expires"] = (datetime.now()
+ app.config["PERMANENT_SESSION_LIFETIME"])

# if SESSION_REFRESH_EACH_REQUEST is True for a permanent session,
# update expiration date
if app.config["SESSION_REFRESH_EACH_REQUEST"] and session.permanent:
session["t_expires"] = (datetime.now()
+ app.config["PERMANENT_SESSION_LIFETIME"])

# save the session, now its no longer new (or modified)
data = self.serialization_method.dumps(dict(session))
Expand All @@ -187,6 +226,11 @@ def save_session(self, app, session, response):
else:
store.put(session.sid_s, data)

logging.getLogger("KVSession").debug("Session saved")
if "t_expires" in session:
logging.getLogger("KVSession").debug(
"Session will expire at: {0}".format(session["t_expires"]))

session.new = False
session.modified = False

Expand Down Expand Up @@ -248,6 +292,7 @@ def cleanup_sessions(self, app=None):
# remove if expired
if sid.has_expired(app.permanent_session_lifetime, now):
app.kvsession_store.delete(key)
logging.getLogger("KVSession").debug("Session store cleaned up")

def init_app(self, app, session_kvstore=None):
"""Initialize application and KVSession.
Expand Down