Merge pull request #1100 from edx/bfiller/linkify-submission

WL-1452 | add support for linkifying submissions

Author: Bill Filler

openassessment/templates/openassessmentblock/oa_submission_answer.html

@@ -1,5 +1,6 @@
 {% spaceless %}
 {% load i18n %}
+{% load oa_extras %}
 <ol class="submission__answer__display__content">
     {% for part in answer.parts %}
         <li class="submission__answer__part">
@@ -19,7 +20,7 @@ <h5 class="submission__answer__part__text__title">{% trans "The question for thi
             <div class="submission__answer__part__text">
                 <h5 class="submission__answer__part__text__title">{{ answer_text_label }}</h5>
                 <div class="submission__answer__part__text__value">
-                    {{ part.text|linebreaks }}
+                    {{ part.text|escape|link_and_linebreak }}
                 </div>
             </div>
             {% endif %}

openassessment/templatetags/__init__.py

@@ -0,0 +1,24 @@
+from django import template
+from django.template.defaultfilters import linebreaks, stringfilter
+from django.utils.safestring import mark_safe
+from django.utils.html import conditional_escape
+from bleach import callbacks
+
+import bleach
+
+register = template.Library()
+
+
+@register.filter()
+@stringfilter
+def link_and_linebreak(text):
+    """
+    Converts URLs in text into clickable links with their target attribute set to `_blank`.
+    It wraps givent tags into <p> tags and converts line breaks(\n) to <br> tags.
+    Args:
+        text: (str) Text having URLs to be converted
+    Returns: (str) Text with URLs convert to links
+    """
+    if text:
+        escaped_text = conditional_escape(text)
+        return mark_safe(linebreaks(bleach.linkify(escaped_text, callbacks=[callbacks.target_blank])))

openassessment/templatetags/oa_extras.py

@@ -0,0 +1,41 @@
+import ddt
+from django.template import Context, Template
+import unittest
+
+
+@ddt.ddt
+class OAExtrasTests(unittest.TestCase):
+
+    template = Template(
+        "{% load oa_extras %}"
+        "{{ text|link_and_linebreak }}"
+    )
+
+    @ddt.data(
+        ("", ""),
+        ('check this https://dummy-url.com', 'https://dummy-url.com'),
+        ('Visit this URL http://dummy-url.com', 'http://dummy-url.com'),
+        ('dummy-text http://dummy-url.org', 'http://dummy-url.org'),
+        ('dummy-url.com dummy-text', 'dummy-url.com')
+    )
+    @ddt.unpack
+    def test_link_and_linebreak(self, text, link_text):
+        rendered_template = self.template.render(Context({'text': text}))
+        self.assertIn(link_text, rendered_template)
+        if text:
+            self.assertRegexpMatches(
+                rendered_template,
+                r'<a.*target="_blank".*>{link_text}</a>'.format(link_text=link_text),
+            )
+
+    @ddt.data(
+        ("hello <script></script>", "script"),
+        ("http://dummy-url.com <applet></applet>", "applet"),
+        ("<iframe></iframe>", "iframe"),
+        ("<link></link>", "link"),
+    )
+    @ddt.unpack
+    def test_html_tags(self, text, tag):
+        rendered_template = self.template.render(Context({'text': text}))
+        escaped_tag = "&lt;{tag}&gt;".format(tag=tag)
+        self.assertIn(escaped_tag, rendered_template)

openassessment/tests/test_templatetags.py

@@ -5,6 +5,8 @@ git+https://github.com/edx/[email protected]#egg=XBlock==1.0.1
 git+https://github.com/edx/[email protected]#egg=xblock-sdk==0.1.4
 
 # Third Party Requirements
+bleach==1.4
+html5lib==0.999
 boto>=2.39.0,<3.0.0
 python-swiftclient>=3.1.0,<4.0.0
 defusedxml>=0.4.1,<1.0.0