Fix leakage contents

Author: trungleduc

tests/app/contents_handler_test.py

@@ -0,0 +1,49 @@
+import json
+import pytest
+import tornado
+
+
+@pytest.fixture
+def preheat_mode():
+    return False
+
+
+@pytest.fixture
+def contents_prefix(base_url):
+    return base_url + "voila/api/contents"
+
+
+@pytest.fixture
+def voila_args(notebook_directory, voila_args_extra):
+    return ["--VoilaTest.root_dir=%r" % notebook_directory, *voila_args_extra]
+
+
+@pytest.fixture
+def voila_args_extra():
+    return ['--VoilaConfiguration.extension_language_mapping={".py": "python"}']
+
+
+async def test_contents_endpoint(http_server_client, contents_prefix):
+    response = await http_server_client.fetch(contents_prefix)
+    html_json = json.loads(response.body.decode("utf-8"))
+    assert "content" in html_json
+    assert len(html_json["content"]) > 0
+
+
+async def test_get_notebook(http_server_client, contents_prefix):
+    response = await http_server_client.fetch(contents_prefix + "/autokill.ipynb")
+    html_json = json.loads(response.body.decode("utf-8"))
+    assert html_json["name"] == "autokill.ipynb"
+    assert html_json["content"] is None
+
+
+async def test_get_not_allowed_file(http_server_client, contents_prefix):
+    with pytest.raises(tornado.httpclient.HTTPClientError):
+        await http_server_client.fetch(contents_prefix + "/print.xcpp")
+
+
+async def test_get_allowed_file(http_server_client, contents_prefix):
+    response = await http_server_client.fetch(contents_prefix + "/print.py")
+    html_json = json.loads(response.body.decode("utf-8"))
+    assert html_json["name"] == "print.py"
+    assert html_json["content"] is None

voila/app.py

@@ -680,13 +680,6 @@ def init_handlers(self) -> List:
                         "no_cache_paths": ["/"],
                     },
                 ),
-                (
-                    url_path_join(
-                        self.server_url, r"/voila/api/contents%s" % path_regex
-                    ),
-                    VoilaContentsHandler,
-                    tree_handler_conf,
-                ),
                 (
                     url_path_join(self.server_url, r"/voila/api/shutdown/(.*)"),
                     VoilaShutdownKernelHandler,
@@ -762,6 +755,14 @@ def init_handlers(self) -> List:
                             "prelaunch_hook": self.prelaunch_hook,
                         },
                     ),
+                    # On serving a directory, expose the content handler.
+                    (
+                        url_path_join(
+                            self.server_url, r"/voila/api/contents%s" % path_regex
+                        ),
+                        VoilaContentsHandler,
+                        tree_handler_conf,
+                    ),
                 ]
             )
         return handlers

voila/tornado/contentshandler.py

@@ -32,11 +32,6 @@ async def get(self, path=""):
         path = path or ""
         cm = self.contents_manager
 
-        type = self.get_query_argument("type", default=None)
-        if type not in {None, "directory", "file", "notebook"}:
-            # fall back to file if unknown type
-            type = "file"
-
         format = self.get_query_argument("format", default=None)
         if format not in {None, "text", "base64"}:
             raise web.HTTPError(400, "Format %r is invalid" % format)
@@ -51,23 +46,29 @@ async def get(self, path=""):
         model = await ensure_async(
             self.contents_manager.get(
                 path=path,
-                type=type,
+                type=None,
                 format=format,
                 content=content,
             )
         )
 
         validate_model(model, expect_content=content)
-        if type is None or type == "directory":
 
-            def allowed_content(content):
-                if content["type"] in ["directory", "notebook"]:
-                    return True
-                __, ext = os.path.splitext(content.get("path"))
-                return ext in self.allowed_extensions
+        def allowed_content(content):
+            if content["type"] in ["directory", "notebook"]:
+                return True
+            __, ext = os.path.splitext(content.get("path"))
+            return ext in self.allowed_extensions
+
+        if not allowed_content(model):
+            raise web.HTTPError(404, f"file or directory {path!r} does not exist")
 
-            model["content"] = sorted(model["content"], key=lambda i: i["name"])
-            model["content"] = list(filter(allowed_content, model["content"]))
+        if model["type"] == "directory":
+            try:
+                model["content"] = sorted(model["content"], key=lambda i: i["name"])
+                model["content"] = list(filter(allowed_content, model["content"]))
+            except Exception:
+                model["content"] = None
         else:
             # Make sure we don't leak the file content.
             model["content"] = None