cache.py 2.4 KB

1234567891011121314151617181920212223242526272829303132333435363738394041424344454647484950515253545556575859606162636465666768697071727374
  1. from django.conf import settings
  2. from django.contrib.sessions.backends.base import SessionBase, CreateError
  3. from django.core.cache import caches
  4. from django.utils.six.moves import xrange
  5. KEY_PREFIX = "django.contrib.sessions.cache"
  6. class SessionStore(SessionBase):
  7. """
  8. A cache-based session store.
  9. """
  10. def __init__(self, session_key=None):
  11. self._cache = caches[settings.SESSION_CACHE_ALIAS]
  12. super(SessionStore, self).__init__(session_key)
  13. @property
  14. def cache_key(self):
  15. return KEY_PREFIX + self._get_or_create_session_key()
  16. def load(self):
  17. try:
  18. session_data = self._cache.get(self.cache_key, None)
  19. except Exception:
  20. # Some backends (e.g. memcache) raise an exception on invalid
  21. # cache keys. If this happens, reset the session. See #17810.
  22. session_data = None
  23. if session_data is not None:
  24. return session_data
  25. self.create()
  26. return {}
  27. def create(self):
  28. # Because a cache can fail silently (e.g. memcache), we don't know if
  29. # we are failing to create a new session because of a key collision or
  30. # because the cache is missing. So we try for a (large) number of times
  31. # and then raise an exception. That's the risk you shoulder if using
  32. # cache backing.
  33. for i in xrange(10000):
  34. self._session_key = self._get_new_session_key()
  35. try:
  36. self.save(must_create=True)
  37. except CreateError:
  38. continue
  39. self.modified = True
  40. return
  41. raise RuntimeError(
  42. "Unable to create a new session key. "
  43. "It is likely that the cache is unavailable.")
  44. def save(self, must_create=False):
  45. if must_create:
  46. func = self._cache.add
  47. else:
  48. func = self._cache.set
  49. result = func(self.cache_key,
  50. self._get_session(no_load=must_create),
  51. self.get_expiry_age())
  52. if must_create and not result:
  53. raise CreateError
  54. def exists(self, session_key):
  55. return (KEY_PREFIX + session_key) in self._cache
  56. def delete(self, session_key=None):
  57. if session_key is None:
  58. if self.session_key is None:
  59. return
  60. session_key = self.session_key
  61. self._cache.delete(KEY_PREFIX + session_key)
  62. @classmethod
  63. def clear_expired(cls):
  64. pass