Fix a bug that single quote in file names breaks docx

[skip ci]

Author: NyanHelsing

mfr/extensions/pdf/render.py

@@ -1,5 +1,6 @@
 import logging
 import os
+import re
 
 import furl
 from mako.lookup import TemplateLookup
@@ -20,10 +21,14 @@ class PdfRenderer(extension.BaseRenderer):
 
     def render(self):
         download_url = munge_url_for_localdev(self.metadata.download_url)
-        logger.debug('extension::{}  supported-list::{}'.format(self.metadata.ext, settings.EXPORT_SUPPORTED))
+        logger.debug('extension::{}  supported-list::{}'.format(self.metadata.ext,
+                                                                settings.EXPORT_SUPPORTED))
         if self.metadata.ext not in settings.EXPORT_SUPPORTED:
             logger.debug('Extension not found in supported list!')
-            return self.TEMPLATE.render(base=self.assets_url, url=download_url.geturl())
+            return self.TEMPLATE.render(
+                base=self.assets_url,
+                url=re.sub(r'\'', '\\\'', download_url.geturl())
+            )
 
         logger.debug('Extension found in supported list!')
         exported_url = furl.furl(self.export_url)

tests/extensions/pdf/test_renderer.py

@@ -1,5 +1,6 @@
 import furl
 import pytest
+import re
 
 from mfr.extensions.pdf import (settings,
                                 PdfRenderer)
@@ -16,6 +17,16 @@ def tif_metadata():
     return ProviderMetadata('test', '.tif', 'text/plain', '1234',
                             'http://wb.osf.io/file/test.tif?token=1234')
 
+@pytest.fixture
+def docx_metadata():
+    return ProviderMetadata(
+        'te\'st',
+        '.docx',
+        'text/plain',
+        '1234',
+        'http://mfr.osf.io/export?url=http://osf.io/file/te\'st.pdf'
+    )
+
 @pytest.fixture
 def file_path():
     return '/tmp/test.pdf'
@@ -24,15 +35,24 @@ def file_path():
 def tif_file_path():
     return '/tmp/test.tif'
 
+@pytest.fixture
+def docx_file_path():
+    return '/tmp/te\'st.docx'
+
 
 @pytest.fixture
 def url():
-    return 'http://osf.io/file/test.pdf'
+    return 'http://osf.io/file/te\'st.pdf'
 
 
 @pytest.fixture
 def tif_url():
-    return 'http://osf.io/file/test.tif'
+    return 'http://osf.io/file/te\'st.tif'
+
+
+@pytest.fixture
+def docx_url():
+    return 'http://osf.io/file/te\'st.tif'
 
 
 @pytest.fixture
@@ -42,18 +62,42 @@ def assets_url():
 
 @pytest.fixture
 def export_url():
-    return 'http://mfr.osf.io/export?url=' + url()
+    return 'http://mfr.osf.io/export?url=http://osf.io/file/te\'st.pdf'
 
 
 @pytest.fixture
 def renderer(metadata, file_path, url, assets_url, export_url):
     return PdfRenderer(metadata, file_path, url, assets_url, export_url)
 
+
 @pytest.fixture
-def tif_renderer(tif_metadata, tif_file_path, tif_url, assets_url, export_url):
+def tif_renderer(
+    tif_metadata,
+    tif_file_path,
+    tif_url,
+    assets_url,
+    export_url
+):
     return PdfRenderer(tif_metadata, tif_file_path, tif_url, assets_url, export_url)
 
 
+@pytest.fixture
+def docx_renderer(
+    docx_metadata,
+    docx_file_path,
+    docx_url,
+    assets_url,
+    export_url
+):
+    return PdfRenderer(
+        docx_metadata,
+        docx_file_path,
+        docx_url,
+        assets_url,
+        export_url
+    )
+
+
 class TestPdfRenderer:
 
     def test_render_pdf(self, renderer, metadata, assets_url):
@@ -71,3 +115,12 @@ def test_render_tif(self, tif_renderer, assets_url):
         assert '<base href="{}/{}/web/" target="_blank">'.format(assets_url, 'pdf') in body
         assert '<div id="viewer" class="pdfViewer"></div>' in body
         assert 'DEFAULT_URL = \'{}\''.format(exported_url.url) in body
+
+    def test_render_docx(self, docx_renderer, assets_url):
+        exported_url = furl.furl(docx_renderer.export_url)
+
+        body = docx_renderer.render()
+        assert '<base href="{}/{}/web/" target="_blank">'.format(assets_url, 'pdf') in body
+        assert '<div id="viewer" class="pdfViewer"></div>' in body
+        assert 'DEFAULT_URL = \'{}\''.format(re.sub(r'\'', '\\\'', exported_url.url)) in body
+