Merge branch 'release/0.18.0'

Author: felliott

CHANGELOG

@@ -2,6 +2,14 @@
 ChangeLog
 *********
 
+0.18.0 (2016-10-31)
+===================
+- HALLOWEEN RELEASE!
+- Feature: Add configurable size limit to text renderer to avoid dumping 100s of MB of text into
+the user's browser. (thanks, @TomBaxter!)
+- Fix: Pad MFR 404 errors to >512 bytes.  IE discards 404 messages smaller than that and
+substitutes its own 404 page. (thanks, @alexschiller!)
+
 0.17.0 (2016-10-11)
 ===================
 - Feature: WaterButler accepts configuration from the environment, overriding any file-based

mfr/__init__.py

@@ -1,2 +1,2 @@
-__version__ = '0.17.1'
+__version__ = '0.18.0'
 __import__('pkg_resources').declare_namespace(__name__)

mfr/core/exceptions.py

@@ -10,6 +10,8 @@ def as_html(self):
         return '''
             <link rel="stylesheet" href="/static/css/bootstrap.min.css">
             <div class="alert alert-warning" role="alert">{}</div>
+            <div style="display: none;">This text and the text below is only presented because IE consumes error messages below 512 bytes</div>
+            <div style="display: none;">Want to help save science? Want to get paid to develop free, open source software? Check out our openings!</div>
             '''.format(self.message)
 
 

mfr/extensions/codepygments/exceptions.py

@@ -0,0 +1,6 @@
+from mfr.core.exceptions import RendererError
+
+
+class FileTooLargeException(RendererError):
+    def __init__(self, *args, **kwargs):
+        super().__init__(code=400, *args, **kwargs)

mfr/extensions/codepygments/render.py

@@ -1,6 +1,7 @@
 import os
 
 import chardet
+from humanfriendly import format_size
 import pygments
 import pygments.lexers
 import pygments.lexers.special
@@ -9,6 +10,8 @@
 from mako.lookup import TemplateLookup
 
 from mfr.core import extension, exceptions
+from mfr.extensions.codepygments import settings
+from mfr.extensions.codepygments import exceptions as cp_exceptions
 
 
 class CodePygmentsRenderer(extension.BaseRenderer):
@@ -25,6 +28,13 @@ def __init__(self, *args, **kwargs):
         self.metrics.add('pygments_version', pygments.__version__)
 
     def render(self):
+        file_size = os.path.getsize(self.file_path)
+        if file_size > settings.MAX_SIZE:
+            raise cp_exceptions.FileTooLargeException(
+                'Text files larger than {} are not rendered. Please download the file to '
+                'view.'.format(format_size(settings.MAX_SIZE, binary=True))
+            )
+
         with open(self.file_path, 'rb') as fp:
             body = self._render_html(fp, self.metadata.ext)
             return self.TEMPLATE.render(base=self.assets_url, body=body)

mfr/extensions/codepygments/settings.py

@@ -0,0 +1,5 @@
+from mfr import settings
+
+config = settings.child('CODEPYGMENTS_EXTENSION_CONFIG')
+
+MAX_SIZE = int(config.get('MAX_SIZE', 65536))

requirements.txt

@@ -1,6 +1,7 @@
 aiohttp==0.18.4
 chardet==2.3.0
 furl==0.4.2
+humanfriendly==2.1
 invoke==0.11.1
 mako==1.0.1
 raven==5.27.0

tests/extensions/codepygments/test_renderer.py

@@ -1,10 +1,12 @@
 import os
 import pytest
+from tempfile import NamedTemporaryFile
 
 from mfr.core.exceptions import RendererError
 from mfr.core.provider import ProviderMetadata
 
-from mfr.extensions.codepygments import CodePygmentsRenderer
+from mfr.extensions.codepygments import settings, CodePygmentsRenderer
+from mfr.extensions.codepygments.exceptions import FileTooLargeException
 
 
 @pytest.fixture
@@ -16,6 +18,29 @@ def metadata():
 def test_file_path():
         return os.path.join(os.path.dirname(os.path.abspath(__file__)), 'files', 'test.xml')
 
+@pytest.fixture
+def max_size_file_path():
+    dir_path = os.path.join(os.path.dirname(os.path.abspath(__file__)),
+                            'files')
+    with NamedTemporaryFile(mode='w+b', suffix='.txt', dir=dir_path,
+                            delete=False) as temp_file:
+        temp_file_path = temp_file.name
+        file_size = settings.MAX_SIZE
+        temp_file.seek(file_size -1)
+        temp_file.write(b'0')
+    return temp_file_path
+
+@pytest.fixture
+def over_size_file_path():
+    dir_path = os.path.join(os.path.dirname(os.path.abspath(__file__)),
+                            'files')
+    with NamedTemporaryFile(mode='w+b', suffix='.txt', dir=dir_path,
+                            delete=False) as temp_file:
+        temp_file_path = temp_file.name
+        file_size = settings.MAX_SIZE
+        temp_file.seek(file_size)
+        temp_file.write(b'0')
+    return temp_file_path
 
 @pytest.fixture
 def invalid_file_path():
@@ -58,6 +83,23 @@ def test_render_codepygments_invalid(self, metadata, invalid_file_path, url, ass
         with pytest.raises(RendererError):
             renderer.render()
 
+    def test_render_codepygments_max_size(self, metadata, max_size_file_path, url, assets_url, export_url):
+        try:
+            renderer = CodePygmentsRenderer(metadata, max_size_file_path, url, assets_url, export_url)
+            body = renderer.render()
+            assert '<div style="word-wrap: break-word;" class="mfrViewer">' in body
+        finally:
+            os.remove(max_size_file_path)
+
+    def test_render_codepygments_over_size(self, metadata, over_size_file_path, url, assets_url, export_url):
+        with pytest.raises(FileTooLargeException):
+            try:
+                renderer = CodePygmentsRenderer(metadata, over_size_file_path,
+                                                url, assets_url, export_url)
+                renderer.render()
+            finally:
+                os.remove(over_size_file_path)
+
     def test_render_codepygments_file_required(self, renderer):
         assert renderer.file_required is True