[SVCS-86] Add Papaya Renderer for Dicom and NifTi Files

mfr/core/utils.py

@@ -1,6 +1,10 @@
+from time import time
+from os.path import getctime
+
 from stevedore import driver
 
 from mfr.core import exceptions
+from mfr.extensions import settings as ext_settings
 
 
 def make_provider(name, request, url):
@@ -97,6 +101,7 @@ def make_renderer(name, metadata, file_path, url, assets_url, export_url):
             }
         )
 
+
 def sizeof_fmt(num, suffix='B'):
     if abs(num) < 1000:
         return '%3.0f%s' % (num, suffix)
@@ -106,3 +111,33 @@ def sizeof_fmt(num, suffix='B'):
             return '%3.1f%s%s' % (num, unit, suffix)
         num /= 1000.0
     return '%.1f%s%s' % (num, 'Y', suffix)
+
+
+def file_expired(path: str, ttl: int) -> bool:
+    """Helper method that checks if a file's last change time has expired ttl.
+
+    :param path: the path of the file
+    :param ttl: the expiration time in seconds
+    :return: True if expired, False otherwise
+    """
+
+    if (time() - getctime(path)) >= ttl:
+        return True
+    return False
+
+
+def get_full_file_ext(file_ext: str, file_name: str) -> str:
+    """Helper method that checks if a secondary extension exists for a file
+    with a compressed extension as primary. If so, returns the full extension.
+
+    :param metadata_ext: the file's primary extension
+    :param metadata_name: the file name that may contain a secondary extension
+    :return: the file's full extension
+    """
+
+    compressed_ext = ext_settings.COMPRESSED_EXT
+    if file_ext in compressed_ext.keys():
+        secondary_ext = '.{}'.format(file_name.split('.')[-1])
+        if secondary_ext in compressed_ext[file_ext]:
+            return secondary_ext + file_ext
+    return file_ext

mfr/extensions/papaya/__init__.py

@@ -0,0 +1 @@
+from .render import PapayaRenderer  # noqa

mfr/extensions/papaya/render.py

@@ -0,0 +1,43 @@
+import os
+import shutil
+
+from mako.lookup import TemplateLookup
+
+from mfr.core import utils
+from mfr.core import extension
+from mfr.extensions import settings as ext_settings
+from mfr.extensions.papaya import settings as papaya_settings
+
+
+class PapayaRenderer(extension.BaseRenderer):
+
+    data_dir = papaya_settings.DATA_DIR
+    data_ttl = papaya_settings.DATA_TTL
+    comp_ext = ext_settings.COMPRESSED_EXT
+
+    TEMPLATE = TemplateLookup(
+        directories=[
+            os.path.join(os.path.dirname(__file__), 'templates')
+        ]).get_template('viewer.mako')
+
+    def render(self):
+        self.remove_old_files()
+        file_name = os.path.basename(self.file_path)
+        file_ext = utils.get_full_file_ext(self.metadata.ext, self.metadata.name)
+        file_name = file_name + file_ext
+        shutil.copyfile(self.file_path, self.data_dir + file_name)
+        return self.TEMPLATE.render(base=self.assets_url, file_name=file_name)
+
+    def remove_old_files(self):
+
+        for data_file in os.listdir(self.data_dir):
+            if utils.file_expired(self.data_dir + data_file, self.data_ttl):
+                os.unlink(self.data_dir + data_file)
+
+    @property
+    def file_required(self):
+        return True
+
+    @property
+    def cache_result(self):
+        return True

mfr/extensions/papaya/settings.py

@@ -0,0 +1,8 @@
+from mfr import settings
+
+config = settings.child('PAPAYA_EXTENSION_CONFIG')
+
+# Directory to temporarily store papaya image files
+DATA_DIR = 'mfr/extensions/papaya/static/data/'
+# Files older then this many seconds will be deleted from DATA_DIR at the beginning of each render.
+DATA_TTL = 300

mfr/extensions/papaya/static/README-papaya.txt

@@ -0,0 +1,7 @@
+Currently using a custom built papaya.js with option to remove the ability to open new files from the users desktop.
+
+https://github.com/TomBaxter/Papaya/tree/feature/noNewFiles
+
+I have sent them a PR, hopefully they bite.
+
+https://github.com/rii-mango/Papaya/pull/101