| 1 |
""" |
| 2 |
Cached, database-backed sessions. |
| 3 |
""" |
| 4 |
|
| 5 |
import logging |
| 6 |
|
| 7 |
from django.conf import settings |
| 8 |
from django.contrib.sessions.backends.db import SessionStore as DBStore |
| 9 |
from django.core.cache import caches |
| 10 |
|
| 11 |
KEY_PREFIX = "django.contrib.sessions.cached_db" |
| 12 |
|
| 13 |
logger = logging.getLogger("django.contrib.sessions") |
| 14 |
|
| 15 |
|
| 16 |
class SessionStore(DBStore): |
| 17 |
""" |
| 18 |
Implement cached, database backed sessions. |
| 19 |
""" |
| 20 |
|
| 21 |
cache_key_prefix = KEY_PREFIX |
| 22 |
|
| 23 |
def __init__(self, session_key=None): |
| 24 |
self._cache = caches[settings.SESSION_CACHE_ALIAS] |
| 25 |
super().__init__(session_key) |
| 26 |
|
| 27 |
@property |
| 28 |
def cache_key(self): |
| 29 |
return self.cache_key_prefix + self._get_or_create_session_key() |
| 30 |
|
| 31 |
async def acache_key(self): |
| 32 |
return self.cache_key_prefix + await self._aget_or_create_session_key() |
| 33 |
|
| 34 |
def load(self): |
| 35 |
try: |
| 36 |
data = self._cache.get(self.cache_key) |
| 37 |
except Exception: |
| 38 |
# Some backends (e.g. memcache) raise an exception on invalid |
| 39 |
# cache keys. If this happens, reset the session. See #17810. |
| 40 |
data = None |
| 41 |
|
| 42 |
if data is None: |
| 43 |
s = self._get_session_from_db() |
| 44 |
if s: |
| 45 |
data = self.decode(s.session_data) |
| 46 |
self._cache.set( |
| 47 |
self.cache_key, data, self.get_expiry_age(expiry=s.expire_date) |
| 48 |
) |
| 49 |
else: |
| 50 |
data = {} |
| 51 |
return data |
| 52 |
|
| 53 |
async def aload(self): |
| 54 |
try: |
| 55 |
data = await self._cache.aget(await self.acache_key()) |
| 56 |
except Exception: |
| 57 |
# Some backends (e.g. memcache) raise an exception on invalid |
| 58 |
# cache keys. If this happens, reset the session. See #17810. |
| 59 |
data = None |
| 60 |
|
| 61 |
if data is None: |
| 62 |
s = await self._aget_session_from_db() |
| 63 |
if s: |
| 64 |
data = self.decode(s.session_data) |
| 65 |
await self._cache.aset( |
| 66 |
await self.acache_key(), |
| 67 |
data, |
| 68 |
await self.aget_expiry_age(expiry=s.expire_date), |
| 69 |
) |
| 70 |
else: |
| 71 |
data = {} |
| 72 |
return data |
| 73 |
|
| 74 |
def exists(self, session_key): |
| 75 |
return ( |
| 76 |
session_key |
| 77 |
and (self.cache_key_prefix + session_key) in self._cache |
| 78 |
or super().exists(session_key) |
| 79 |
) |
| 80 |
|
| 81 |
async def aexists(self, session_key): |
| 82 |
return ( |
| 83 |
session_key |
| 84 |
and (self.cache_key_prefix + session_key) in self._cache |
| 85 |
or await super().aexists(session_key) |
| 86 |
) |
| 87 |
|
| 88 |
def save(self, must_create=False): |
| 89 |
super().save(must_create) |
| 90 |
try: |
| 91 |
self._cache.set(self.cache_key, self._session, self.get_expiry_age()) |
| 92 |
except Exception: |
| 93 |
logger.exception("Error saving to cache (%s)", self._cache) |
| 94 |
|
| 95 |
async def asave(self, must_create=False): |
| 96 |
await super().asave(must_create) |
| 97 |
try: |
| 98 |
await self._cache.aset( |
| 99 |
await self.acache_key(), |
| 100 |
self._session, |
| 101 |
await self.aget_expiry_age(), |
| 102 |
) |
| 103 |
except Exception: |
| 104 |
logger.exception("Error saving to cache (%s)", self._cache) |
| 105 |
|
| 106 |
def delete(self, session_key=None): |
| 107 |
super().delete(session_key) |
| 108 |
if session_key is None: |
| 109 |
if self.session_key is None: |
| 110 |
return |
| 111 |
session_key = self.session_key |
| 112 |
self._cache.delete(self.cache_key_prefix + session_key) |
| 113 |
|
| 114 |
async def adelete(self, session_key=None): |
| 115 |
await super().adelete(session_key) |
| 116 |
if session_key is None: |
| 117 |
if self.session_key is None: |
| 118 |
return |
| 119 |
session_key = self.session_key |
| 120 |
await self._cache.adelete(self.cache_key_prefix + session_key) |
| 121 |
|
| 122 |
def flush(self): |
| 123 |
""" |
| 124 |
Remove the current session data from the database and regenerate the |
| 125 |
key. |
| 126 |
""" |
| 127 |
self.clear() |
| 128 |
self.delete(self.session_key) |
| 129 |
self._session_key = None |
| 130 |
|
| 131 |
async def aflush(self): |
| 132 |
"""See flush().""" |
| 133 |
self.clear() |
| 134 |
await self.adelete(self.session_key) |
| 135 |
self._session_key = None |