Add hierarchical zip renderer and adjust test

Author: Johnetordoff

mfr/extensions/zip/render.py

@@ -1,7 +1,6 @@
 import os
 import zipfile
 
-import markupsafe
 from mako.lookup import TemplateLookup
 
 from mfr.core import extension
@@ -17,15 +16,55 @@ class ZipRenderer(extension.BaseRenderer):
 
     def render(self):
         zip_file = zipfile.ZipFile(self.file_path, 'r')
+        files = [file for file in zip_file.filelist if not file.filename.startswith('__MACOSX')]
 
-        filelist = [{'name': markupsafe.escape(file.filename),
-                     'size': sizeof_fmt(int(file.file_size)),
-                     'date': "%d-%02d-%02d %02d:%02d:%02d" % file.date_time[:6]} for file in zip_file.filelist
-                    if not file.filename.startswith('__MACOSX')]
+        data = self.filelist_to_tree(files)
 
-        message = '' if filelist else 'This zip file is empty.'
+        return self.TEMPLATE.render(data=data, base=self.assets_url)
 
-        return self.TEMPLATE.render(zipped_filenames=filelist, message=message)
+    def filelist_to_tree(self, files):
+
+        self.icons_url = self.assets_url + '/img'
+
+        tree_data = [{
+            'text': self.metadata.name + self.metadata.ext,
+            'icon': self.icons_url + '/file_extension_zip.png',
+            'children': []
+        }]
+
+        for file in files:
+            node_path = tree_data[0]
+            paths = [path for path in file.filename.split('/') if path]
+            for path in paths:
+                if not len(node_path['children']) or node_path['children'][-1]['text'] != path:
+                    # Add a child
+                    new_node = {'text': path, 'children': []}
+
+                    if new_node['text']:  # If not a placeholder/"root" directory.
+                        date = '%d-%02d-%02d %02d:%02d:%02d' % file.date_time[:6]
+                        size = sizeof_fmt(int(file.file_size)) if file.file_size else ''
+
+                        # create new node
+                        new_node['data'] = {'date': date, 'size': size}
+
+                        if file.filename[-1] == '/':
+                            new_node['icon'] = self.icons_url + '/folder.png'
+                        else:
+                            ext = os.path.splitext(file.filename)[1].lstrip('.')
+                            if check_icon_ext(ext):
+                                new_node['icon'] = \
+                                    self.icons_url + '/file_extension_{}.png'.format(ext)
+                            else:
+                                new_node['icon'] = self.icons_url + '/generic-file.png'
+
+                        node_path['children'].append(new_node)
+
+                    node_path = new_node
+                else:
+                    # "go deeper" to get children of children.
+                    node_path = node_path['children'][-1]
+
+        return tree_data
 
     @property
     def file_required(self):
@@ -34,3 +73,7 @@ def file_required(self):
     @property
     def cache_result(self):
         return True
+
+def check_icon_ext(ext):
+    return os.path.isfile(os.path.join(os.path.dirname(__file__), 'static', 'img', 'icons',
+                                'file_extension_{}.png'.format(ext)))

mfr/extensions/zip/templates/viewer.mako

@@ -1,31 +1,43 @@
-<link href="https://fonts.googleapis.com/css?family=Open+Sans:400,600,300,700" rel="stylesheet" type="text/css">
-<link rel="stylesheet" href="static/css/bootstrap.min.css">
 <link rel="stylesheet" href="static/css/default.css">
-<div style="word-wrap: break-word;" class="mfrViewer">
-    <h1>
-        Zip File:
-    </h1>
-    <p>
-        Download the .zip file to view the contents.
-    </p>
-    ${message}
-    <table class="table table-hover">
-        <thead>
-            <th>File Name</th>
-            <th>Modified</th>
-            <th>Size</th>
-        </thead>
-        <tbody>
-            % for file in zipped_filenames:
-                <tr>
-                    <td>${file['name']}</td>
-                    <td>${file['date']}</td>
-                    <td>${file['size']}<td>
-                </tr>
-            % endfor
-        </tbody>
-    </table>
+<link rel="stylesheet" href="${base}/jstree-theme/style.css"/>
+
+<script src="/static/js/jquery-1.11.3.min.js"></script>
+<script src="/static/js/bootstrap.min.js"></script>
+
+<script src="${base}/js/jstree.min.js"></script>
+<script src="${base}/js/jstreetable.js"></script>
+
+<div style="height: 500px;" class="mfrViewer">
+    <input id="ziptree_search" class="form-control" style="margin-bottom: 10px;" type="text"  placeholder="Search...">
+    <div id="ziptree"></div>
 </div>
 
+<script>
+    $('#ziptree').jstree({
+        "core" : {
+            "data" : ${data},
+        },
+        "plugins" : [
+            "table",
+            "search"
+        ],
+        'table': {
+		    'columns': [
+		        {'header': "Name", 'width': '100%'}, // these widths are strange but work.
+                {'header': "Size", 'width': 80, 'value': "size"},
+                {'header': "Date", 'width': 150, 'value': "date"}
+            ],
+        }
+    });
+    var to = false;
+    $('#ziptree_search').keyup(function () {
+        if(to) { clearTimeout(to); }
+        to = setTimeout(function () {
+            var v = $('#ziptree_search').val();
+            $('#ziptree').jstree(true).search(v);
+        }, 250);
+    });
+</script>
+
 <script src="/static/js/mfr.js"></script>
 <script src="/static/js/mfr.child.js"></script>

tests/extensions/zip/test_renderer.py

@@ -1,9 +1,9 @@
 import os
 import re
+import json
 from zipfile import ZipFile
 
 import pytest
-from bs4 import BeautifulSoup
 
 from mfr.core.provider import ProviderMetadata
 from mfr.extensions.zip import ZipRenderer
@@ -24,6 +24,10 @@ def metadata():
 def zip_file():
     return ZipFile(os.path.join(BASE, 'files', 'test.zip'), 'r')
 
+@pytest.fixture
+def zip_file_tree():
+    return ZipFile(os.path.join(BASE, 'files', 'test-tree.zip'), 'r')
+
 
 @pytest.fixture
 def zip_empty_file():
@@ -55,36 +59,21 @@ def renderer(metadata, test_file_path, url, assets_url, export_url):
     return ZipRenderer(metadata, test_file_path, url, assets_url, export_url)
 
 
-
-def remove_whitespace(str):
-    str = re.sub('\n*', '', str)
-    return re.sub(r'\ {2,}', '', str)
+@pytest.fixture
+def file_tree():
+    with open(os.path.join(os.path.dirname(__file__), 'fixtures/fixtures.json'), 'r') as fp:
+        return json.load(fp)['file_tree']
 
 
 class TestZipRenderer:
 
     def test_render(self, renderer):
         body = renderer.render()
-        parsed_html = BeautifulSoup(body)
-        rows = parsed_html.findChildren('table')[0].findChildren(['tr'])
-
-        name = rows[2].findChildren('td')[0].get_text().strip()
-        assert 'test/test 1' == name
-
-        date_modified = rows[2].findChildren('td')[1].get_text().strip()
-        assert '2017-03-02 16:22:14' == date_modified
-
-        size = rows[2].findChildren('td')[2].get_text().strip()
-        assert '15B' == size
 
-        # non-expanded zip file should have no children
-        name = rows[4].findChildren('td')[0].get_text().strip()
-        assert 'test/zip file which is not expanded.zip' == name
-        assert body.count('zip file which is not expanded.zip') == 1
+    def test_filelist_to_tree(self, renderer, zip_file_tree, file_tree):
 
-        size = rows[4].findChildren('td')[2].get_text().strip()
-        assert '1.8KB' == size  # formatting of larger byte sizes
+        files = [file for file in zip_file_tree.filelist if not file.filename.startswith('__MACOSX')]
 
-        # hidden files should be hidden
-        assert body.count('__MACOSX') == 0
+        actual = renderer.filelist_to_tree(files)
+        assert actual == file_tree