added markdown rendering support using either markdown2 or markdown

Author: cmeerw

.travis.yml

@@ -94,6 +94,7 @@ install:
   - pip install gpg pytz whoosh pyjwt
   - pip install pytest-cov codecov
   - if [[ $TRAVIS_PYTHON_VERSION != "3.4"* ]]; then pip install docutils; fi
+  - pip install markdown2
 
 before_script:
   # set up mysql database

CHANGES.txt

@@ -58,6 +58,8 @@ Features:
   property 'messages.author' is not allowed (because 'messages' is a
   multilink). A multilink at the end (e.g. messages in the example) is
   fine.
+- Added markdown rendering using either markdown or markdown2.
+  (Christof Meerwald)
 
 Fixed:
 

doc/installation.txt

@@ -116,6 +116,14 @@ pyjwt
   To use jwt tokens for login (experimental), install pyjwt. If you
   don't have it installed, jwt tokens are not supported.
 
+docutils
+  To use ReStructuredText rendering you need to have the docutils
+  package installed.
+
+markdown or markdown2
+  To use markdown rendering you need to either have the markdown or
+  markdown2 package installed.
+
 Windows Service
   You can run Roundup as a Windows service if pywin32_ is installed.
   Otherwise it must be started manually.
@@ -128,6 +136,9 @@ Windows Service
 .. _gpg: https://www.gnupg.org/software/gpgme/index.html
 .. _pywin32: https://pypi.org/project/pywin32/
 .. _jinja2: http://jinja.pocoo.org/
+.. _docutils: https://docutils.sourceforge.io/
+.. _markdown: https://python-markdown.github.io/
+.. _markdown2: https://github.com/trentm/python-markdown2
 
 
 Getting Roundup

roundup/cgi/templating.py

@@ -53,6 +53,13 @@
     from docutils.core import publish_parts as ReStructuredText
 except ImportError:
     ReStructuredText = None
+try:
+    from markdown2 import markdown
+except ImportError:
+    try:
+        from markdown import markdown
+    except ImportError:
+        markdown = None
 try:
     from itertools import zip_longest
 except ImportError:
@@ -1514,6 +1521,19 @@ def _hyper_repl_rst(self, match):
             # just return the matched text
             return match.group(0)
 
+    def _hyper_repl_markdown(self, match):
+        if match.group('url'):
+            s = match.group('url')
+            return '[%s](%s)'%(s, s)
+        elif match.group('email'):
+            s = match.group('email')
+            return '[%s](mailto:%s)'%(s, s)
+        elif len(match.group('id')) < 10:
+            return self._hyper_repl_item(match,'[%(item)s](%(cls)s%(id)s)')
+        else:
+            # just return the matched text
+            return match.group(0)
+
     def url_quote(self):
         """ Return the string in plain format but escaped for use in a url """
         return urllib_.quote(self.plain())
@@ -1601,6 +1621,21 @@ def rst(self, hyperlink=1):
             s = self.hyper_re.sub(self._hyper_repl_rst, s)
         return u2s(ReStructuredText(s, writer_name="html")["html_body"])
 
+    def markdown(self, hyperlink=1):
+        """ Render the value of the property as markdown.
+
+            This requires markdown2 or markdown to be installed separately.
+        """
+        if not self.is_view_ok():
+            return self._('[hidden]')
+
+        if not markdown:
+            return self.plain(escape=0, hyperlink=hyperlink)
+        s = self.plain(escape=0, hyperlink=0)
+        if hyperlink:
+            s = self.hyper_re.sub(self._hyper_repl_markdown, s)
+        return u2s(markdown(s2u(s)))
+
     def field(self, **kwargs):
         """ Render the property as a field in HTML.
 

test/test_templating.py

@@ -29,6 +29,17 @@
         skip_stext = mark_class(pytest.mark.skip(
                 reason='StructuredText not available'))
 
+try:
+    skip_markdown = lambda func, *args, **kwargs: func
+    from markdown2 import markdown
+except ImportError:
+    try:
+        from markdown import markdown
+    except ImportError:
+        markdown = None
+        skip_markdown = mark_class(pytest.mark.skip(
+                reason='markdown not available'))
+
 from roundup.anypy.strings import u2s, s2u
 
 class MockDatabase(MockNull):
@@ -236,7 +247,21 @@ def test_string_plain_or_hyperlinked(self):
 
         self.assertEqual(p.hyperlinked(), 'A string &lt;b&gt; with <a href="mailto:[email protected]">[email protected]</a> embedded &amp;lt; html&lt;/b&gt;')
 
+    @skip_markdown
+    def test_string_markdown_installed(self):
+        pass # just so we have a record of a skipped test
+
+    def test_string_markdown(self):
+        p = StringHTMLProperty(self.client, 'test', '1', None, 'test', u2s(u'A string http://localhost with [email protected] *embedded* \u00df'))
+        if markdown:
+            self.assertEqual(p.markdown().strip(), u2s(u'<p>A string <a href="http://localhost">http://localhost</a> with <a href="mailto:[email protected]">[email protected]</a> <em>embedded</em> \u00df</p>'))
+        else:
+            self.assertEqual(p.markdown(), u2s(u'A string <a href="http://localhost" rel="nofollow noopener">http://localhost</a> with <a href="mailto:[email protected]">[email protected]</a> *embedded* \u00df'))
+
     @skip_rst
+    def test_string_rst_installed(self):
+        pass # just so we have a record of a skipped test
+
     def test_string_rst(self):
         p = StringHTMLProperty(self.client, 'test', '1', None, 'test', u2s(u'A string with [email protected] *embedded* \u00df'))
         if ReStructuredText:
@@ -245,6 +270,9 @@ def test_string_rst(self):
             self.assertEqual(p.rst(), u2s(u'A string with <a href="mailto:[email protected]">[email protected]</a> *embedded* \u00df'))
 
     @skip_stext
+    def test_string_stext_installed(self):
+        pass # just so we have a record of a skipped test
+
     def test_string_stext(self):
         p = StringHTMLProperty(self.client, 'test', '1', None, 'test', u2s(u'A string with [email protected] *embedded* \u00df'))
         if StructuredText: