Merge branch 'feature/hypothesis-for-pdfs' into develop

[SVCS-645] Closes: #316
CenterForOpenScience · Apr 12, 2018 · fc0d556 · fc0d556
2 parents a9a381c + e3681cd
commit fc0d556
Show file tree

Hide file tree

Showing 7 changed files with 63 additions and 5 deletions.
diff --git a/.gitignore b/.gitignore
@@ -88,4 +88,4 @@ node_modules/
 
 # Asynchronous HTTP
 ######################
-/src/
+/src/
diff --git a/mfr/extensions/pdf/render.py b/mfr/extensions/pdf/render.py
@@ -23,7 +23,11 @@ def render(self):
         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=download_url.geturl(),
+                enable_hypothesis=settings.ENABLE_HYPOTHESIS
+            )
 
         logger.debug('Extension found in supported list!')
         exported_url = furl.furl(self.export_url)
@@ -35,9 +39,17 @@ def render(self):
                 exported_url.args['format'] = settings.EXPORT_TYPE
 
             self.metrics.add('needs_export', True)
-            return self.TEMPLATE.render(base=self.assets_url, url=exported_url.url)
-
-        return self.TEMPLATE.render(base=self.assets_url, url=download_url.geturl())
+            return self.TEMPLATE.render(
+                base=self.assets_url,
+                url=exported_url.url,
+                enable_hypothesis=settings.ENABLE_HYPOTHESIS
+            )
+
+        return self.TEMPLATE.render(
+            base=self.assets_url,
+            url=download_url.geturl(),
+            enable_hypothesis=settings.ENABLE_HYPOTHESIS
+        )
 
     @property
     def file_required(self):

diff --git a/mfr/extensions/pdf/settings.py b/mfr/extensions/pdf/settings.py
@@ -6,6 +6,8 @@
 EXPORT_TYPE = config.get('EXPORT_TYPE', 'pdf')
 EXPORT_MAXIMUM_SIZE = config.get('EXPORT_MAXIMUM_SIZE', '1200x1200')
 
+ENABLE_HYPOTHESIS = config.get_bool('ENABLE_HYPOTHESIS', False)
+
 # supports multiple files in the form of a space separated string
 EXPORT_SUPPORTED = config.get('EXPORT_SUPPORTED', '.tiff .tif').split(' ')
 EXPORT_MAX_PAGES = int(config.get('EXPORT_MAX_PAGES', 40))
diff --git a/mfr/extensions/pdf/templates/viewer.mako b/mfr/extensions/pdf/templates/viewer.mako
@@ -37,6 +37,16 @@ http://sourceforge.net/adobe/cmap/wiki/License/
 
     <script src="debugger.js"></script>
     <script src="viewer.js"></script>
+
+    % if enable_hypothesis:
+    <style>
+      body.show-hypothesis #toolbarViewer {
+        position: relative;
+        margin-right: 36px;
+      }
+    </style>
+    % endif
+
   </head>
 
   <body tabindex="1" class="loadingInProgress">
@@ -413,6 +423,9 @@ http://sourceforge.net/adobe/cmap/wiki/License/
         var DEFAULT_URL = '${url}';
         window.pymChild.sendMessage('embed', 'embed-responsive-pdf');
     </script>
+    % if enable_hypothesis:
+    <script src="/static/js/mfr.child.hypothesis.js"></script>
+    % endif
   </body>
 </html>
 
diff --git a/mfr/server/static/js/mfr.child.hypothesis.js b/mfr/server/static/js/mfr.child.hypothesis.js
@@ -0,0 +1,26 @@
+;(function() {
+    'use strict';
+
+    var hypothesisLoaded = false;
+
+    window.pymChild.onMessage('startHypothesis', startHypothesis);
+
+    window.addEventListener('message', function(event) {
+        if (event.data === 'startHypothesis') {
+            startHypothesis(event);
+        }
+    });
+
+    function startHypothesis(event) {
+        if (hypothesisLoaded) {
+            return;
+        }
+
+        var script = window.document.createElement('script');
+        script.type = 'text/javascript';
+        script.src = 'https://hypothes.is/embed.js';
+        window.document.head.appendChild(script);
+        window.document.body.classList.add('show-hypothesis');
+        hypothesisLoaded = true;
+    };
+})();
diff --git a/mfr/server/static/js/mfr.child.js b/mfr/server/static/js/mfr.child.js
@@ -1,5 +1,6 @@
 ;(function() {
     'use strict';
+
     window.pymChild = new pym.Child();
 
     window.addEventListener('load', function () {

diff --git a/mfr/server/static/js/mfr.js b/mfr/server/static/js/mfr.js
@@ -111,6 +111,10 @@
             self.pymParent.sendMessage('resize', 'x');
         };
 
+        self.startHypothesis = function() {
+            self.pymParent.sendMessage('startHypothesis');
+        };
+
         return self;
     };