Commit 616a4d38 authored by Tim Graham's avatar Tim Graham
Browse files

[1.5.x] Fixed #20922 -- Allowed customizing the serializer used by contrib.sessions 

Added settings.SESSION_SERIALIZER which is the import path of a serializer
to use for sessions.

Thanks apollo13, carljm, shaib, akaariai, charettes, and dstufft for reviews.

Backport of b0ce6fe6 from master
parent 1b236048

django/conf/global_settings.py

+1 −0
Original line number Diff line number Diff line
@@ -467,6 +467,7 @@ SESSION_SAVE_EVERY_REQUEST = False # Whether to save the se 
SESSION_EXPIRE_AT_BROWSER_CLOSE = False                 # Whether a user's session cookie expires when the Web browser is closed.

SESSION_ENGINE = 'django.contrib.sessions.backends.db'  # The module to store session data

SESSION_FILE_PATH = None                                # Directory to store session files if using the file session module. If None, the backend will use a sensible default.

SESSION_SERIALIZER = 'django.contrib.sessions.serializers.PickleSerializer'  # class to serialize session data



#########

# CACHE #

django/conf/project_template/project_name/settings.py

+2 −0
Original line number Diff line number Diff line
@@ -126,6 +126,8 @@ INSTALLED_APPS = ( 
    # 'django.contrib.admindocs',

)



SESSION_SERIALIZER = 'django.contrib.sessions.serializers.JSONSerializer'



# A sample logging configuration. The only tangible logging

# performed by this configuration is to send an email to

# the site admins on every HTTP 500 error when DEBUG=False.

django/contrib/messages/storage/session.py

+15 −2
Original line number Diff line number Diff line 
import json



from django.contrib.messages.storage.base import BaseStorage

from django.contrib.messages.storage.cookie import MessageEncoder, MessageDecoder

from django.utils import six





class SessionStorage(BaseStorage):
@@ -20,14 +24,23 @@ class SessionStorage(BaseStorage): 
        always stores everything it is given, so return True for the

        all_retrieved flag.

        """

        return self.request.session.get(self.session_key), True

        return self.deserialize_messages(self.request.session.get(self.session_key)), True



    def _store(self, messages, response, *args, **kwargs):

        """

        Stores a list of messages to the request's session.

        """

        if messages:

            self.request.session[self.session_key] = messages

            self.request.session[self.session_key] = self.serialize_messages(messages)

        else:

            self.request.session.pop(self.session_key, None)

        return []



    def serialize_messages(self, messages):

        encoder = MessageEncoder(separators=(',', ':'))

        return encoder.encode(messages)



    def deserialize_messages(self, data):

        if data and isinstance(data, six.string_types):

            return json.loads(data, cls=MessageDecoder)

        return data

django/contrib/messages/tests/base.py

+1 −0
Original line number Diff line number Diff line
@@ -61,6 +61,7 @@ class BaseTest(TestCase): 
            MESSAGE_TAGS    = '',

            MESSAGE_STORAGE = '%s.%s' % (self.storage_class.__module__,

                                         self.storage_class.__name__),

            SESSION_SERIALIZER = 'django.contrib.sessions.serializers.JSONSerializer',

        )

        self.settings_override.enable()

django/contrib/messages/tests/session.py

+2 −2
Original line number Diff line number Diff line
@@ -10,13 +10,13 @@ def set_session_data(storage, messages): 
    Sets the messages into the backend request's session and remove the

    backend's loaded data cache.

    """

    storage.request.session[storage.session_key] = messages

    storage.request.session[storage.session_key] = storage.serialize_messages(messages)

    if hasattr(storage, '_loaded_data'):

        del storage._loaded_data





def stored_session_messages_count(storage):

    data = storage.request.session.get(storage.session_key, [])

    data = storage.deserialize_messages(storage.request.session.get(storage.session_key, []))

    return len(data)