Serve WebUI handlers and update-bundled-web-ui script, Ref: #1362

This commit is contained in:
ziajka 2018-06-26 12:09:08 +02:00
parent 6dc2ae8641
commit 0e1f2e26d0
7 changed files with 98 additions and 10 deletions

View File

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

View File

@ -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 %}

View File

@ -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'))

View File

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

65
scripts/update-bundled-web-ui.sh Normal file → Executable file
View File

@ -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 <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"

View File

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