From ce590531bed11fdb34cbde23fb7e34202d5e5cdf Mon Sep 17 00:00:00 2001
From: Matt Westcott <matt@west.co.tt>
Date: Mon, 1 Jun 2015 18:18:56 +0100
Subject: [PATCH 1/4] Make RawHTMLBlock consistently use SafeText as its native
 value

---
 wagtail/wagtailcore/blocks/field_block.py | 19 +++++-
 wagtail/wagtailcore/tests/test_blocks.py  | 72 +++++++++++++++++++++++
 2 files changed, 89 insertions(+), 2 deletions(-)

diff --git a/wagtail/wagtailcore/blocks/field_block.py b/wagtail/wagtailcore/blocks/field_block.py
index ddc740a21..4e953702b 100644
--- a/wagtail/wagtailcore/blocks/field_block.py
+++ b/wagtail/wagtailcore/blocks/field_block.py
@@ -261,8 +261,23 @@ class RawHTMLBlock(FieldBlock):
             widget=forms.Textarea)
         super(RawHTMLBlock, self).__init__(**kwargs)
 
-    def render_basic(self, value):
-        return mark_safe(value)  # if it isn't safe, that's the site admin's problem for allowing raw HTML blocks in the first place...
+    def get_default(self):
+        return mark_safe(self.meta.default or '')
+
+    def to_python(self, value):
+        return mark_safe(value)
+
+    def get_prep_value(self, value):
+        # explicitly convert to a plain string, just in case we're using some serialisation method
+        # that doesn't cope with SafeText values correctly
+        return str(value)
+
+    def value_for_form(self, value):
+        # need to explicitly mark as unsafe, or it'll output unescaped HTML in the textarea
+        return str(value)
+
+    def value_from_form(self, value):
+        return mark_safe(value)
 
     class Meta:
         icon = 'code'
diff --git a/wagtail/wagtailcore/tests/test_blocks.py b/wagtail/wagtailcore/tests/test_blocks.py
index a4d38ce2e..7f4524d95 100644
--- a/wagtail/wagtailcore/tests/test_blocks.py
+++ b/wagtail/wagtailcore/tests/test_blocks.py
@@ -4,6 +4,7 @@ from django import forms
 from django.forms.utils import ErrorList
 from django.core.exceptions import ValidationError
 from django.test import TestCase
+from django.utils.safestring import mark_safe, SafeText
 
 from wagtail.wagtailcore import blocks
 from wagtail.wagtailcore.models import Page
@@ -267,6 +268,77 @@ class TestChoiceBlock(unittest.TestCase):
         )
 
 
+class TestRawHTMLBlock(unittest.TestCase):
+    def test_get_default_with_fallback_value(self):
+        default_value = blocks.RawHTMLBlock().get_default()
+        self.assertEqual(default_value, '')
+        self.assertTrue(isinstance(default_value, SafeText))
+
+    def test_get_default_with_none(self):
+        default_value = blocks.RawHTMLBlock(default=None).get_default()
+        self.assertEqual(default_value, '')
+        self.assertTrue(isinstance(default_value, SafeText))
+
+    def test_get_default_with_empty_string(self):
+        default_value = blocks.RawHTMLBlock(default='').get_default()
+        self.assertEqual(default_value, '')
+        self.assertTrue(isinstance(default_value, SafeText))
+
+    def test_get_default_with_nonempty_string(self):
+        default_value = blocks.RawHTMLBlock(default='<blink>BOOM</blink>').get_default()
+        self.assertEqual(default_value, '<blink>BOOM</blink>')
+        self.assertTrue(isinstance(default_value, SafeText))
+
+    def test_serialize(self):
+        block = blocks.RawHTMLBlock()
+        result = block.get_prep_value(mark_safe('<blink>BOOM</blink>'))
+        self.assertEqual(result, '<blink>BOOM</blink>')
+
+    def test_deserialize(self):
+        block = blocks.RawHTMLBlock()
+        result = block.to_python('<blink>BOOM</blink>')
+        self.assertEqual(result, '<blink>BOOM</blink>')
+        self.assertTrue(isinstance(result, SafeText))
+
+    def test_render(self):
+        block = blocks.RawHTMLBlock()
+        result = block.render(mark_safe('<blink>BOOM</blink>'))
+        self.assertEqual(result, '<blink>BOOM</blink>')
+        self.assertTrue(isinstance(result, SafeText))
+
+    def test_render_form(self):
+        block = blocks.RawHTMLBlock()
+        result = block.render_form(mark_safe('<blink>BOOM</blink>'), prefix='rawhtml')
+        self.assertIn('<textarea ', result)
+        self.assertIn('name="rawhtml"', result)
+        self.assertIn('&lt;blink&gt;BOOM&lt;/blink&gt;', result)
+
+    def test_form_response(self):
+        block = blocks.RawHTMLBlock()
+        result = block.value_from_datadict({'rawhtml': '<blink>BOOM</blink>'}, {}, prefix='rawhtml')
+        self.assertEqual(result, '<blink>BOOM</blink>')
+        self.assertTrue(isinstance(result, SafeText))
+
+    def test_clean_required_field(self):
+        block = blocks.RawHTMLBlock()
+        result = block.clean(mark_safe('<blink>BOOM</blink>'))
+        self.assertEqual(result, '<blink>BOOM</blink>')
+        self.assertTrue(isinstance(result, SafeText))
+
+        with self.assertRaises(ValidationError):
+            block.clean(mark_safe(''))
+
+    def test_clean_nonrequired_field(self):
+        block = blocks.RawHTMLBlock(required=False)
+        result = block.clean(mark_safe('<blink>BOOM</blink>'))
+        self.assertEqual(result, '<blink>BOOM</blink>')
+        self.assertTrue(isinstance(result, SafeText))
+
+        result = block.clean(mark_safe(''))
+        self.assertEqual(result, '')
+        self.assertTrue(isinstance(result, SafeText))
+
+
 class TestMeta(unittest.TestCase):
     def test_set_template_with_meta(self):
         class HeadingBlock(blocks.CharBlock):

From db59fb5bc6ff51144c8a366b96249f21e1414957 Mon Sep 17 00:00:00 2001
From: Matt Westcott <matt@west.co.tt>
Date: Mon, 1 Jun 2015 18:43:23 +0100
Subject: [PATCH 2/4] test SafeData rather than SafeText for py2 compatibility
 (and use assertIsInstance)

---
 wagtail/wagtailcore/tests/test_blocks.py | 22 +++++++++++-----------
 1 file changed, 11 insertions(+), 11 deletions(-)

diff --git a/wagtail/wagtailcore/tests/test_blocks.py b/wagtail/wagtailcore/tests/test_blocks.py
index 7f4524d95..ced727dad 100644
--- a/wagtail/wagtailcore/tests/test_blocks.py
+++ b/wagtail/wagtailcore/tests/test_blocks.py
@@ -4,7 +4,7 @@ from django import forms
 from django.forms.utils import ErrorList
 from django.core.exceptions import ValidationError
 from django.test import TestCase
-from django.utils.safestring import mark_safe, SafeText
+from django.utils.safestring import mark_safe, SafeData
 
 from wagtail.wagtailcore import blocks
 from wagtail.wagtailcore.models import Page
@@ -272,22 +272,22 @@ class TestRawHTMLBlock(unittest.TestCase):
     def test_get_default_with_fallback_value(self):
         default_value = blocks.RawHTMLBlock().get_default()
         self.assertEqual(default_value, '')
-        self.assertTrue(isinstance(default_value, SafeText))
+        self.assertIsInstance(default_value, SafeData)
 
     def test_get_default_with_none(self):
         default_value = blocks.RawHTMLBlock(default=None).get_default()
         self.assertEqual(default_value, '')
-        self.assertTrue(isinstance(default_value, SafeText))
+        self.assertIsInstance(default_value, SafeData)
 
     def test_get_default_with_empty_string(self):
         default_value = blocks.RawHTMLBlock(default='').get_default()
         self.assertEqual(default_value, '')
-        self.assertTrue(isinstance(default_value, SafeText))
+        self.assertIsInstance(default_value, SafeData)
 
     def test_get_default_with_nonempty_string(self):
         default_value = blocks.RawHTMLBlock(default='<blink>BOOM</blink>').get_default()
         self.assertEqual(default_value, '<blink>BOOM</blink>')
-        self.assertTrue(isinstance(default_value, SafeText))
+        self.assertIsInstance(default_value, SafeData)
 
     def test_serialize(self):
         block = blocks.RawHTMLBlock()
@@ -298,13 +298,13 @@ class TestRawHTMLBlock(unittest.TestCase):
         block = blocks.RawHTMLBlock()
         result = block.to_python('<blink>BOOM</blink>')
         self.assertEqual(result, '<blink>BOOM</blink>')
-        self.assertTrue(isinstance(result, SafeText))
+        self.assertIsInstance(result, SafeData)
 
     def test_render(self):
         block = blocks.RawHTMLBlock()
         result = block.render(mark_safe('<blink>BOOM</blink>'))
         self.assertEqual(result, '<blink>BOOM</blink>')
-        self.assertTrue(isinstance(result, SafeText))
+        self.assertIsInstance(result, SafeData)
 
     def test_render_form(self):
         block = blocks.RawHTMLBlock()
@@ -317,13 +317,13 @@ class TestRawHTMLBlock(unittest.TestCase):
         block = blocks.RawHTMLBlock()
         result = block.value_from_datadict({'rawhtml': '<blink>BOOM</blink>'}, {}, prefix='rawhtml')
         self.assertEqual(result, '<blink>BOOM</blink>')
-        self.assertTrue(isinstance(result, SafeText))
+        self.assertIsInstance(result, SafeData)
 
     def test_clean_required_field(self):
         block = blocks.RawHTMLBlock()
         result = block.clean(mark_safe('<blink>BOOM</blink>'))
         self.assertEqual(result, '<blink>BOOM</blink>')
-        self.assertTrue(isinstance(result, SafeText))
+        self.assertIsInstance(result, SafeData)
 
         with self.assertRaises(ValidationError):
             block.clean(mark_safe(''))
@@ -332,11 +332,11 @@ class TestRawHTMLBlock(unittest.TestCase):
         block = blocks.RawHTMLBlock(required=False)
         result = block.clean(mark_safe('<blink>BOOM</blink>'))
         self.assertEqual(result, '<blink>BOOM</blink>')
-        self.assertTrue(isinstance(result, SafeText))
+        self.assertIsInstance(result, SafeData)
 
         result = block.clean(mark_safe(''))
         self.assertEqual(result, '')
-        self.assertTrue(isinstance(result, SafeText))
+        self.assertIsInstance(result, SafeData)
 
 
 class TestMeta(unittest.TestCase):

From fb2850403f5b7435fa07ea36237fdac4bf38d9dd Mon Sep 17 00:00:00 2001
From: Matt Westcott <matt@west.co.tt>
Date: Mon, 1 Jun 2015 18:45:26 +0100
Subject: [PATCH 3/4] Test that serialized value of RawHTMLBlock is not
 SafeData

---
 wagtail/wagtailcore/tests/test_blocks.py | 1 +
 1 file changed, 1 insertion(+)

diff --git a/wagtail/wagtailcore/tests/test_blocks.py b/wagtail/wagtailcore/tests/test_blocks.py
index ced727dad..acd7c7050 100644
--- a/wagtail/wagtailcore/tests/test_blocks.py
+++ b/wagtail/wagtailcore/tests/test_blocks.py
@@ -293,6 +293,7 @@ class TestRawHTMLBlock(unittest.TestCase):
         block = blocks.RawHTMLBlock()
         result = block.get_prep_value(mark_safe('<blink>BOOM</blink>'))
         self.assertEqual(result, '<blink>BOOM</blink>')
+        self.assertNotIsInstance(result, SafeData)
 
     def test_deserialize(self):
         block = blocks.RawHTMLBlock()

From 60bafb3d2b26e45975333c0f2097fb99bb1117c1 Mon Sep 17 00:00:00 2001
From: Matt Westcott <matt@west.co.tt>
Date: Tue, 2 Jun 2015 12:42:28 +0100
Subject: [PATCH 4/4] Use six.text_type with RawHTMLBlock to fix unicode on Py2

---
 wagtail/wagtailcore/blocks/field_block.py |  5 ++--
 wagtail/wagtailcore/tests/test_blocks.py  | 35 ++++++++++++-----------
 2 files changed, 22 insertions(+), 18 deletions(-)

diff --git a/wagtail/wagtailcore/blocks/field_block.py b/wagtail/wagtailcore/blocks/field_block.py
index 4e953702b..c2d2c4478 100644
--- a/wagtail/wagtailcore/blocks/field_block.py
+++ b/wagtail/wagtailcore/blocks/field_block.py
@@ -1,6 +1,7 @@
 from __future__ import absolute_import, unicode_literals
 
 import datetime
+import six
 
 from django import forms
 from django.db.models.fields import BLANK_CHOICE_DASH
@@ -270,11 +271,11 @@ class RawHTMLBlock(FieldBlock):
     def get_prep_value(self, value):
         # explicitly convert to a plain string, just in case we're using some serialisation method
         # that doesn't cope with SafeText values correctly
-        return str(value)
+        return six.text_type(value)
 
     def value_for_form(self, value):
         # need to explicitly mark as unsafe, or it'll output unescaped HTML in the textarea
-        return str(value)
+        return six.text_type(value)
 
     def value_from_form(self, value):
         return mark_safe(value)
diff --git a/wagtail/wagtailcore/tests/test_blocks.py b/wagtail/wagtailcore/tests/test_blocks.py
index acd7c7050..d7171f598 100644
--- a/wagtail/wagtailcore/tests/test_blocks.py
+++ b/wagtail/wagtailcore/tests/test_blocks.py
@@ -1,3 +1,6 @@
+# -*- coding: utf-8 -*
+from __future__ import unicode_literals
+
 import unittest
 
 from django import forms
@@ -285,45 +288,45 @@ class TestRawHTMLBlock(unittest.TestCase):
         self.assertIsInstance(default_value, SafeData)
 
     def test_get_default_with_nonempty_string(self):
-        default_value = blocks.RawHTMLBlock(default='<blink>BOOM</blink>').get_default()
-        self.assertEqual(default_value, '<blink>BOOM</blink>')
+        default_value = blocks.RawHTMLBlock(default='<blink>BÖÖM</blink>').get_default()
+        self.assertEqual(default_value, '<blink>BÖÖM</blink>')
         self.assertIsInstance(default_value, SafeData)
 
     def test_serialize(self):
         block = blocks.RawHTMLBlock()
-        result = block.get_prep_value(mark_safe('<blink>BOOM</blink>'))
-        self.assertEqual(result, '<blink>BOOM</blink>')
+        result = block.get_prep_value(mark_safe('<blink>BÖÖM</blink>'))
+        self.assertEqual(result, '<blink>BÖÖM</blink>')
         self.assertNotIsInstance(result, SafeData)
 
     def test_deserialize(self):
         block = blocks.RawHTMLBlock()
-        result = block.to_python('<blink>BOOM</blink>')
-        self.assertEqual(result, '<blink>BOOM</blink>')
+        result = block.to_python('<blink>BÖÖM</blink>')
+        self.assertEqual(result, '<blink>BÖÖM</blink>')
         self.assertIsInstance(result, SafeData)
 
     def test_render(self):
         block = blocks.RawHTMLBlock()
-        result = block.render(mark_safe('<blink>BOOM</blink>'))
-        self.assertEqual(result, '<blink>BOOM</blink>')
+        result = block.render(mark_safe('<blink>BÖÖM</blink>'))
+        self.assertEqual(result, '<blink>BÖÖM</blink>')
         self.assertIsInstance(result, SafeData)
 
     def test_render_form(self):
         block = blocks.RawHTMLBlock()
-        result = block.render_form(mark_safe('<blink>BOOM</blink>'), prefix='rawhtml')
+        result = block.render_form(mark_safe('<blink>BÖÖM</blink>'), prefix='rawhtml')
         self.assertIn('<textarea ', result)
         self.assertIn('name="rawhtml"', result)
-        self.assertIn('&lt;blink&gt;BOOM&lt;/blink&gt;', result)
+        self.assertIn('&lt;blink&gt;BÖÖM&lt;/blink&gt;', result)
 
     def test_form_response(self):
         block = blocks.RawHTMLBlock()
-        result = block.value_from_datadict({'rawhtml': '<blink>BOOM</blink>'}, {}, prefix='rawhtml')
-        self.assertEqual(result, '<blink>BOOM</blink>')
+        result = block.value_from_datadict({'rawhtml': '<blink>BÖÖM</blink>'}, {}, prefix='rawhtml')
+        self.assertEqual(result, '<blink>BÖÖM</blink>')
         self.assertIsInstance(result, SafeData)
 
     def test_clean_required_field(self):
         block = blocks.RawHTMLBlock()
-        result = block.clean(mark_safe('<blink>BOOM</blink>'))
-        self.assertEqual(result, '<blink>BOOM</blink>')
+        result = block.clean(mark_safe('<blink>BÖÖM</blink>'))
+        self.assertEqual(result, '<blink>BÖÖM</blink>')
         self.assertIsInstance(result, SafeData)
 
         with self.assertRaises(ValidationError):
@@ -331,8 +334,8 @@ class TestRawHTMLBlock(unittest.TestCase):
 
     def test_clean_nonrequired_field(self):
         block = blocks.RawHTMLBlock(required=False)
-        result = block.clean(mark_safe('<blink>BOOM</blink>'))
-        self.assertEqual(result, '<blink>BOOM</blink>')
+        result = block.clean(mark_safe('<blink>BÖÖM</blink>'))
+        self.assertEqual(result, '<blink>BÖÖM</blink>')
         self.assertIsInstance(result, SafeData)
 
         result = block.clean(mark_safe(''))