From 867e997b746fc0b9f75971d85db479f93be661c2 Mon Sep 17 00:00:00 2001 From: ziajka Date: Fri, 22 Jun 2018 15:29:47 +0200 Subject: [PATCH 1/3] Support /static/ files serving, Ref: #1362 --- gns3server/handlers/index_handler.py | 26 ++++++++++++++++ gns3server/static/.gitkeep | 0 gns3server/static/nested/nested.txt | 0 gns3server/utils/static.py | 29 ++++++++++++++++++ gns3server/web/response.py | 3 ++ scripts/update-bundled-web-ui.sh | 11 +++++++ tests/handlers/test_index.py | 19 ++++++++++-- tests/utils/test_path.py | 1 - tests/utils/test_static.py | 22 ++++++++++++++ tests/web/test_response.py | 44 ++++++++++++++++++++++++++++ 10 files changed, 151 insertions(+), 4 deletions(-) create mode 100644 gns3server/static/.gitkeep create mode 100644 gns3server/static/nested/nested.txt create mode 100644 gns3server/utils/static.py create mode 100644 scripts/update-bundled-web-ui.sh create mode 100644 tests/utils/test_static.py create mode 100644 tests/web/test_response.py diff --git a/gns3server/handlers/index_handler.py b/gns3server/handlers/index_handler.py index 082e13ba..7c674cef 100644 --- a/gns3server/handlers/index_handler.py +++ b/gns3server/handlers/index_handler.py @@ -14,12 +14,15 @@ # You should have received a copy of the GNU General Public License # along with this program. If not, see . +import os +import aiohttp from gns3server.web.route import Route from gns3server.controller import Controller from gns3server.compute.port_manager import PortManager from gns3server.compute.project_manager import ProjectManager from gns3server.version import __version__ +from gns3server.utils.static import get_static_path class IndexHandler: @@ -64,6 +67,29 @@ class IndexHandler: response.template("project.html", project=controller.get_project(request.match_info["project_id"])) + @Route.get( + r"/static/{filename:.+}", + parameters={ + "filename": "Static filename" + }, + status_codes={ + 200: "Static file returned", + 404: "Static cannot be found", + }, + raw=True, + description="Get static resource") + def static(request, response): + filename = request.match_info["filename"] + filename = os.path.normpath(filename).strip("/") + + # Raise error if user try to escape + if filename[0] == ".": + raise aiohttp.web.HTTPForbidden() + + static = get_static_path(filename) + + yield from response.file(static) + @Route.get( r"/v1/version", description="Old 1.0 API" diff --git a/gns3server/static/.gitkeep b/gns3server/static/.gitkeep new file mode 100644 index 00000000..e69de29b diff --git a/gns3server/static/nested/nested.txt b/gns3server/static/nested/nested.txt new file mode 100644 index 00000000..e69de29b diff --git a/gns3server/utils/static.py b/gns3server/utils/static.py new file mode 100644 index 00000000..83e1bc40 --- /dev/null +++ b/gns3server/utils/static.py @@ -0,0 +1,29 @@ +#!/usr/bin/env python +# +# Copyright (C) 2018 GNS3 Technologies Inc. +# +# This program is free software: you can redistribute it and/or modify +# it under the terms of the GNU General Public License as published by +# the Free Software Foundation, either version 3 of the License, or +# (at your option) any later version. +# +# This program is distributed in the hope that it will be useful, +# but WITHOUT ANY WARRANTY; without even the implied warranty of +# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the +# GNU General Public License for more details. +# +# You should have received a copy of the GNU General Public License +# along with this program. If not, see . + +import os + + +def get_static_path(filename): + """ + Returns full static path for given filename + :param filename: relative filename + :return: absolute path + """ + current_dir = os.path.dirname(os.path.abspath(__file__)) + static_directory = os.path.abspath(os.path.join(current_dir, '..', 'static')) + return os.path.join(static_directory, filename) diff --git a/gns3server/web/response.py b/gns3server/web/response.py index f2a77529..0367c60b 100644 --- a/gns3server/web/response.py +++ b/gns3server/web/response.py @@ -117,6 +117,9 @@ class Response(aiohttp.web.Response): """ Return a file as a response """ + if not os.path.exists(path): + raise aiohttp.web.HTTPNotFound() + ct, encoding = mimetypes.guess_type(path) if not ct: ct = 'application/octet-stream' diff --git a/scripts/update-bundled-web-ui.sh b/scripts/update-bundled-web-ui.sh new file mode 100644 index 00000000..2a7f5467 --- /dev/null +++ b/scripts/update-bundled-web-ui.sh @@ -0,0 +1,11 @@ +#!/usr/bin/env bash + +rm gns3server/appliances/* +rmdir gns3server/appliances +rm -Rf /tmp/gns3-registry + +git clone https://github.com/GNS3/gns3-registry.git /tmp/gns3-registry +mv /tmp/gns3-registry/appliances gns3server/appliances + +git add . +git commit -m "Sync appliances" \ No newline at end of file diff --git a/tests/handlers/test_index.py b/tests/handlers/test_index.py index 385940f0..9f42a8c6 100644 --- a/tests/handlers/test_index.py +++ b/tests/handlers/test_index.py @@ -15,13 +15,12 @@ # You should have received a copy of the GNU General Public License # along with this program. If not, see . - -import aiohttp import os -from unittest.mock import patch + from gns3server.version import __version__ from gns3server.controller import Controller +from gns3server.utils.static import get_static_path def test_index(http_root): @@ -50,6 +49,20 @@ def test_project(http_root, async_run): assert response.status == 200 +def test_static(http_root, tmpdir): + tmpfile = get_static_path('testing.txt') + with open(tmpfile, 'w+') as f: + f.write('world') + response = http_root.get('/static/testing.txt') + assert response.status == 200 + os.remove(tmpfile) + + +def test_static_not_found(http_root, tmpdir): + response = http_root.get('/static/not-found.txt') + assert response.status == 404 + + def test_v1(http_root): """ The old api v1 raise a 429 diff --git a/tests/utils/test_path.py b/tests/utils/test_path.py index c0b1c3c3..8cf6ce57 100644 --- a/tests/utils/test_path.py +++ b/tests/utils/test_path.py @@ -21,7 +21,6 @@ import aiohttp from gns3server.utils.path import check_path_allowed, get_default_project_directory -from gns3server.utils import force_unix_path def test_check_path_allowed(config, tmpdir): diff --git a/tests/utils/test_static.py b/tests/utils/test_static.py new file mode 100644 index 00000000..0174275c --- /dev/null +++ b/tests/utils/test_static.py @@ -0,0 +1,22 @@ +#!/usr/bin/env python +# +# Copyright (C) 2018 GNS3 Technologies Inc. +# +# This program is free software: you can redistribute it and/or modify +# it under the terms of the GNU General Public License as published by +# the Free Software Foundation, either version 3 of the License, or +# (at your option) any later version. +# +# This program is distributed in the hope that it will be useful, +# but WITHOUT ANY WARRANTY; without even the implied warranty of +# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the +# GNU General Public License for more details. +# +# You should have received a copy of the GNU General Public License +# along with this program. If not, see . + +from gns3server.utils.static import get_static_path + + +def test_get_static_path(): + assert get_static_path('test').endswith('gns3server/static/test') diff --git a/tests/web/test_response.py b/tests/web/test_response.py new file mode 100644 index 00000000..ad3c2361 --- /dev/null +++ b/tests/web/test_response.py @@ -0,0 +1,44 @@ +# -*- coding: utf-8 -*- +# +# Copyright (C) 2018 GNS3 Technologies Inc. +# +# This program is free software: you can redistribute it and/or modify +# it under the terms of the GNU General Public License as published by +# the Free Software Foundation, either version 3 of the License, or +# (at your option) any later version. +# +# This program is distributed in the hope that it will be useful, +# but WITHOUT ANY WARRANTY; without even the implied warranty of +# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the +# GNU General Public License for more details. +# +# You should have received a copy of the GNU General Public License +# along with this program. If not, see . + +import pytest + +from unittest.mock import MagicMock +from aiohttp.web import HTTPNotFound + +from gns3server.web.response import Response + + +@pytest.fixture() +def response(): + request = MagicMock() + return Response(request=request) + + +def test_response_file(async_run, tmpdir, response): + filename = str(tmpdir / 'hello') + with open(filename, 'w+') as f: + f.write('world') + + async_run(response.file(filename)) + assert response.status == 200 + + +def test_response_file_not_found(async_run, tmpdir, response): + filename = str(tmpdir / 'hello-not-found') + + pytest.raises(HTTPNotFound, lambda: async_run(response.file(filename))) From 6dc2ae86419d7db72403771a6a7b7eda105aabc3 Mon Sep 17 00:00:00 2001 From: ziajka Date: Fri, 22 Jun 2018 15:30:24 +0200 Subject: [PATCH 2/3] Clear script --- scripts/update-bundled-web-ui.sh | 9 --------- 1 file changed, 9 deletions(-) diff --git a/scripts/update-bundled-web-ui.sh b/scripts/update-bundled-web-ui.sh index 2a7f5467..20d602bd 100644 --- a/scripts/update-bundled-web-ui.sh +++ b/scripts/update-bundled-web-ui.sh @@ -1,11 +1,2 @@ #!/usr/bin/env bash -rm gns3server/appliances/* -rmdir gns3server/appliances -rm -Rf /tmp/gns3-registry - -git clone https://github.com/GNS3/gns3-registry.git /tmp/gns3-registry -mv /tmp/gns3-registry/appliances gns3server/appliances - -git add . -git commit -m "Sync appliances" \ No newline at end of file From 0e1f2e26d0c28f812f95afbc17843caad98b81ea Mon Sep 17 00:00:00 2001 From: ziajka Date: Tue, 26 Jun 2018 12:09:08 +0200 Subject: [PATCH 3/3] Serve WebUI handlers and update-bundled-web-ui script, Ref: #1362 --- gns3server/handlers/index_handler.py | 8 +++- gns3server/static/nested/nested.txt | 0 gns3server/templates/index.html | 1 + gns3server/utils/static.py | 13 +++++- gns3server/web/web_server.py | 8 ++++ scripts/update-bundled-web-ui.sh | 65 ++++++++++++++++++++++++++++ tests/handlers/test_index.py | 13 +++--- 7 files changed, 98 insertions(+), 10 deletions(-) delete mode 100644 gns3server/static/nested/nested.txt mode change 100644 => 100755 scripts/update-bundled-web-ui.sh diff --git a/gns3server/handlers/index_handler.py b/gns3server/handlers/index_handler.py index 7c674cef..6dfd6c15 100644 --- a/gns3server/handlers/index_handler.py +++ b/gns3server/handlers/index_handler.py @@ -68,7 +68,7 @@ class IndexHandler: project=controller.get_project(request.match_info["project_id"])) @Route.get( - r"/static/{filename:.+}", + r"/static/web-ui/{filename:.+}", parameters={ "filename": "Static filename" }, @@ -78,9 +78,10 @@ class IndexHandler: }, raw=True, description="Get static resource") - def static(request, response): + def webui(request, response): filename = request.match_info["filename"] filename = os.path.normpath(filename).strip("/") + filename = os.path.join('web-ui', filename) # Raise error if user try to escape if filename[0] == ".": @@ -88,6 +89,9 @@ class IndexHandler: static = get_static_path(filename) + if not os.path.exists(static): + static = get_static_path('web-ui/index.html') + yield from response.file(static) @Route.get( diff --git a/gns3server/static/nested/nested.txt b/gns3server/static/nested/nested.txt deleted file mode 100644 index e69de29b..00000000 diff --git a/gns3server/templates/index.html b/gns3server/templates/index.html index e013d37d..1aef0dad 100644 --- a/gns3server/templates/index.html +++ b/gns3server/templates/index.html @@ -6,6 +6,7 @@

If you are looking for uploading the IOU. You can since 1.4 upload them directly from the client see: this documentation.

{% endblock %} diff --git a/gns3server/utils/static.py b/gns3server/utils/static.py index 83e1bc40..004794ef 100644 --- a/gns3server/utils/static.py +++ b/gns3server/utils/static.py @@ -24,6 +24,15 @@ def get_static_path(filename): :param filename: relative filename :return: absolute path """ - current_dir = os.path.dirname(os.path.abspath(__file__)) - static_directory = os.path.abspath(os.path.join(current_dir, '..', 'static')) + + static_directory = get_static_dir() return os.path.join(static_directory, filename) + + +def get_static_dir(): + """ + Returns location of static directory + :return: absolute path + """ + current_dir = os.path.dirname(os.path.abspath(__file__)) + return os.path.abspath(os.path.join(current_dir, '..', 'static')) \ No newline at end of file diff --git a/gns3server/web/web_server.py b/gns3server/web/web_server.py index 7cad075b..5c9b3248 100644 --- a/gns3server/web/web_server.py +++ b/gns3server/web/web_server.py @@ -29,6 +29,7 @@ import functools import time import atexit +from gns3server.utils.static import get_static_dir from .route import Route from ..config import Config from ..compute import MODULES @@ -274,6 +275,13 @@ class WebServer: m = module.instance() m.port_manager = PortManager.instance() + # adding static route + self._app.router.add_static( + '/static/', + path=get_static_dir(), + name='static' + ) + log.info("Starting server on {}:{}".format(self._host, self._port)) self._handler = self._app.make_handler() diff --git a/scripts/update-bundled-web-ui.sh b/scripts/update-bundled-web-ui.sh old mode 100644 new mode 100755 index 20d602bd..e48e45d6 --- a/scripts/update-bundled-web-ui.sh +++ b/scripts/update-bundled-web-ui.sh @@ -1,2 +1,67 @@ #!/usr/bin/env bash +# +# Copyright (C) 2018 GNS3 Technologies Inc. +# +# This program is free software: you can redistribute it and/or modify +# it under the terms of the GNU General Public License as published by +# the Free Software Foundation, either version 3 of the License, or +# (at your option) any later version. +# +# This program is distributed in the hope that it will be useful, +# but WITHOUT ANY WARRANTY; without even the implied warranty of +# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the +# GNU General Public License for more details. +# +# You should have received a copy of the GNU General Public License +# along with this program. If not, see . + +# +# Syncs WebUI with gns3server +# +# For updating with fresh latest repo just type: +# $ sh update-bundled-web-ui.sh +# +# It's also possible to update with custom repo and branch by: +# $ sh update-bundled-web-ui.sh ../my-custom-web-ui-repo/ +# + +CURRENT_DIR="$( cd "$( dirname "${BASH_SOURCE[0]}" )" && pwd )" +GNS3SERVER_DIR=$(realpath "$CURRENT_DIR/..") +REPO_DIR="/tmp/gns3-web-ui" +CUSTOM_REPO=false + +if [ $# -eq 1 ]; then + PARAM="$1" + CUSTOM_REPO=true + REPO_DIR=$(realpath "$PWD/${PARAM%/}") + echo "Custom repo dir: $REPO_DIR" +fi + +echo "Removing: $GNS3SERVER_DIR/gns3server/static/web-ui/*" + +rm -rf $GNS3SERVER_DIR/gns3server/static/web-ui/* + +echo "Re-create: $GNS3SERVER_DIR/gns3server/static/web-ui" + +mkdir -p "$GNS3SERVER_DIR/gns3server/static/web-ui/" + +if [ "$CUSTOM_REPO" = false ] ; then + if [ ! -d /tmp/gns3-web-ui ]; then + git clone https://github.com/GNS3/gns3-web-ui.git "$REPO_DIR" + fi +fi + +echo "Current working dir $REPO_DIR" + +cd "$REPO_DIR" + +yarn install +yarn ng build -e prod --base-href /static/web-ui/ + +cp -R $REPO_DIR/dist/* "$GNS3SERVER_DIR/gns3server/static/web-ui/" + +cd "$GNS3SERVER_DIR" + +#git add . +#git commit -m "Sync WebUI" diff --git a/tests/handlers/test_index.py b/tests/handlers/test_index.py index 9f42a8c6..7aec57d3 100644 --- a/tests/handlers/test_index.py +++ b/tests/handlers/test_index.py @@ -49,18 +49,19 @@ def test_project(http_root, async_run): assert response.status == 200 -def test_static(http_root, tmpdir): - tmpfile = get_static_path('testing.txt') +def test_web_ui(http_root, tmpdir): + tmpfile = get_static_path('web-ui/testing.txt') with open(tmpfile, 'w+') as f: f.write('world') - response = http_root.get('/static/testing.txt') + response = http_root.get('/static/web-ui/testing.txt') assert response.status == 200 os.remove(tmpfile) -def test_static_not_found(http_root, tmpdir): - response = http_root.get('/static/not-found.txt') - assert response.status == 404 +def test_web_ui_not_found(http_root, tmpdir): + response = http_root.get('/static/web-ui/not-found.txt') + # should serve web-ui/index.html + assert response.status == 200 def test_v1(http_root):