Ticket #14976: messages.patch

django/contrib/messages/api.py

@@ -13 +13 @@
     pass
 
 
-def add_message(request, level, message, extra_tags='', fail_silently=False):
+def add_message(request, level, message, extra_tags='', fail_silently=False, is_html=False):
     """
     Attempts to add a message to the request using the 'messages' app, falling
     back to the user's message_set if MessageMiddleware hasn't been enabled.
     """
     if hasattr(request, '_messages'):
-        return request._messages.add(level, message, extra_tags)
+        return request._messages.add(level, message, extra_tags, is_html)
     if hasattr(request, 'user') and request.user.is_authenticated():
         return request.user.message_set.create(message=message)
     if not fail_silently:
@@ -74 +74 @@
     return True
 
 
-def debug(request, message, extra_tags='', fail_silently=False):
+def debug(request, message, extra_tags='', fail_silently=False, is_html=False):
     """
     Adds a message with the ``DEBUG`` level.
     """
     add_message(request, constants.DEBUG, message, extra_tags=extra_tags,
-                fail_silently=fail_silently)
+                fail_silently=fail_silently, is_html=is_html)
 
 
-def info(request, message, extra_tags='', fail_silently=False):
+def info(request, message, extra_tags='', fail_silently=False, is_html=False):
     """
     Adds a message with the ``INFO`` level.
     """
     add_message(request, constants.INFO, message, extra_tags=extra_tags,
-                fail_silently=fail_silently)
+                fail_silently=fail_silently, is_html=is_html)
 
 
-def success(request, message, extra_tags='', fail_silently=False):
+def success(request, message, extra_tags='', fail_silently=False, is_html=False):
     """
     Adds a message with the ``SUCCESS`` level.
     """
     add_message(request, constants.SUCCESS, message, extra_tags=extra_tags,
-                fail_silently=fail_silently)
+                fail_silently=fail_silently, is_html=is_html)
 
 
-def warning(request, message, extra_tags='', fail_silently=False):
+def warning(request, message, extra_tags='', fail_silently=False, is_html=False):
     """
     Adds a message with the ``WARNING`` level.
     """
     add_message(request, constants.WARNING, message, extra_tags=extra_tags,
-                fail_silently=fail_silently)
+                fail_silently=fail_silently, is_html=is_html)
 
 
-def error(request, message, extra_tags='', fail_silently=False):
+def error(request, message, extra_tags='', fail_silently=False, is_html=False):
     """
     Adds a message with the ``ERROR`` level.
     """
     add_message(request, constants.ERROR, message, extra_tags=extra_tags,
-                fail_silently=fail_silently)
+                fail_silently=fail_silently, is_html=is_html)

django/contrib/messages/storage/base.py

@@ -13 +13 @@
     or template.
     """
 
-    def __init__(self, level, message, extra_tags=None):
+    def __init__(self, level, message, extra_tags=None, is_html=False):
         self.level = int(level)
         self.message = message
         self.extra_tags = extra_tags
+        self.is_html = is_html
 
     def _prepare(self):
         """
@@ -137 +138 @@
             messages = self._loaded_messages + self._queued_messages
             return self._store(messages, response)
 
-    def add(self, level, message, extra_tags=''):
+    def add(self, level, message, extra_tags='', is_html=False):
         """
         Queues a message to be stored.
 
@@ -152 +153 @@
             return
         # Add the message.
         self.added_new = True
-        message = Message(level, message, extra_tags=extra_tags)
+        message = Message(level, message, extra_tags=extra_tags, is_html=is_html)
         self._queued_messages.append(message)
 
     def _get_level(self):

django/contrib/messages/storage/cookie.py

@@ -15 +15 @@
     def default(self, obj):
         if isinstance(obj, Message):
             message = [self.message_key, obj.level, obj.message]
+            # If no tags, stores a blank string
             if obj.extra_tags:
                 message.append(obj.extra_tags)
+            else:
+                message.append("")
+            # Stores is_html flag as a 1 or 0
+            if obj.is_html:
+                message.append(1)
+            else:
+                message.append(0)
             return message
         return super(MessageEncoder, self).default(obj)
 
@@ -29 +37 @@
     def process_messages(self, obj):
         if isinstance(obj, list) and obj:
             if obj[0] == MessageEncoder.message_key:
+                if len(obj) == 5:
+                    # Legacy messages are len 3 or 4
+                    # Translates is_html from 1,0 to True,False
+                    # Translates a blank extra tags from "" to None
+                    if obj[4] == 1: 
+                        obj[4] = True
+                    else:
+                        obj[4] = False
+                    if obj[3] == "":
+                        obj[3] = None
                 return Message(*obj[1:])
             return [self.process_messages(item) for item in obj]
         if isinstance(obj, dict):

django/contrib/messages/storage/session.py

@@ -1 @@
-from django.contrib.messages.storage.base import BaseStorage
+from django.contrib.messages.storage.base import BaseStorage, Message
 
 
 class SessionStorage(BaseStorage):
@@ -20 +20 @@
         always stores everything it is given, so return True for the
         all_retrieved flag.
         """
-        return self.request.session.get(self.session_key), True
+        messages = self.request.session.get(self.session_key)
+        if messages:  # Either list or none
+            for message in messages:
+                # Ensures legacy messages get an is_html property
+                if isinstance(message, Message) and not hasattr(message, "is_html"):
+                    message.is_html = False
+        return messages, True
 
     def _store(self, messages, response, *args, **kwargs):
         """

django/contrib/messages/tests/base.py

@@ -207 +207 @@
         """
         settings.MESSAGE_LEVEL = constants.DEBUG
         data = {
-            'messages': ['Test message %d' % x for x in xrange(10)],
+            'messages': ['Test message %d' % x for x in xrange(9)],
         }
         show_url = reverse('django.contrib.messages.tests.urls.show')
         messages = []