session.py 1.7 KB

12345678910111213141516171819202122232425262728293031323334353637383940414243444546
  1. import json
  2. from django.contrib.messages.storage.base import BaseStorage
  3. from django.contrib.messages.storage.cookie import MessageEncoder, MessageDecoder
  4. from django.utils import six
  5. class SessionStorage(BaseStorage):
  6. """
  7. Stores messages in the session (that is, django.contrib.sessions).
  8. """
  9. session_key = '_messages'
  10. def __init__(self, request, *args, **kwargs):
  11. assert hasattr(request, 'session'), "The session-based temporary "\
  12. "message storage requires session middleware to be installed, "\
  13. "and come before the message middleware in the "\
  14. "MIDDLEWARE_CLASSES list."
  15. super(SessionStorage, self).__init__(request, *args, **kwargs)
  16. def _get(self, *args, **kwargs):
  17. """
  18. Retrieves a list of messages from the request's session. This storage
  19. always stores everything it is given, so return True for the
  20. all_retrieved flag.
  21. """
  22. return self.deserialize_messages(self.request.session.get(self.session_key)), True
  23. def _store(self, messages, response, *args, **kwargs):
  24. """
  25. Stores a list of messages to the request's session.
  26. """
  27. if messages:
  28. self.request.session[self.session_key] = self.serialize_messages(messages)
  29. else:
  30. self.request.session.pop(self.session_key, None)
  31. return []
  32. def serialize_messages(self, messages):
  33. encoder = MessageEncoder(separators=(',', ':'))
  34. return encoder.encode(messages)
  35. def deserialize_messages(self, data):
  36. if data and isinstance(data, six.string_types):
  37. return json.loads(data, cls=MessageDecoder)
  38. return data