Merge pull request #1364 from GNS3/bundled-web-ui

Serve WebUI handlers and update-bundled-web-ui script

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 <http://www.gnu.org/licenses/>.
 
+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,33 @@ class IndexHandler:
         response.template("project.html",
                           project=controller.get_project(request.match_info["project_id"]))
 
+    @Route.get(
+        r"/static/web-ui/{filename:.+}",
+        parameters={
+            "filename": "Static filename"
+        },
+        status_codes={
+            200: "Static file returned",
+            404: "Static cannot be found",
+        },
+        raw=True,
+        description="Get static resource")
+    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] == ".":
+            raise aiohttp.web.HTTPForbidden()
+
+        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(
         r"/v1/version",
         description="Old 1.0 API"

gns3server/templates/index.html

@@ -6,6 +6,7 @@
 <ul>
     <li><a href="https://gns3.com">Website</a></li>
     <li><a href="http://docs.gns3.com">Documentation</a></li>
+    <li><a href="/static/web-ui/local">WebUI - local</a></li>
 </ul>
 <p>If you are looking for uploading the IOU. You can since 1.4 upload them directly from the client see: <a href="http://docs.gns3.com/1PKfYwR78QP_Z3jqxBQ1pdy6SsqM27qhvdCvSmIizRh4">this documentation</a>.</p>
 {% endblock %}

gns3server/utils/static.py

@@ -0,0 +1,38 @@
+#!/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 <http://www.gnu.org/licenses/>.
+
+import os
+
+
+def get_static_path(filename):
+    """
+    Returns full static path for given filename
+    :param filename: relative filename
+    :return: absolute path
+    """
+
+    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'))

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'

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()

scripts/update-bundled-web-ui.sh

@@ -0,0 +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 <http://www.gnu.org/licenses/>.
+
+#
+# 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"

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 <http://www.gnu.org/licenses/>.
 
-
-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,21 @@ def test_project(http_root, async_run):
     assert response.status == 200
 
 
+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/web-ui/testing.txt')
+    assert response.status == 200
+    os.remove(tmpfile)
+
+
+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):
     """
     The old api v1 raise a 429

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):

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 <http://www.gnu.org/licenses/>.
+
+from gns3server.utils.static import get_static_path
+
+
+def test_get_static_path():
+    assert get_static_path('test').endswith('gns3server/static/test')

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 <http://www.gnu.org/licenses/>.
+
+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)))