mirror of
https://github.com/GNS3/gns3-server
synced 2024-12-11 01:28:09 +00:00
239 lines
7.6 KiB
Python
239 lines
7.6 KiB
Python
# -*- coding: utf-8 -*-
|
|
#
|
|
# Copyright (C) 2015 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/>.
|
|
|
|
"""
|
|
API endpoints for projects.
|
|
"""
|
|
|
|
import os
|
|
|
|
import logging
|
|
log = logging.getLogger()
|
|
|
|
from fastapi import APIRouter, Depends, HTTPException, Request, status
|
|
from fastapi.encoders import jsonable_encoder
|
|
from fastapi.responses import FileResponse
|
|
from typing import List
|
|
from uuid import UUID
|
|
|
|
from gns3server.compute.project_manager import ProjectManager
|
|
from gns3server.compute.project import Project
|
|
from gns3server.endpoints import schemas
|
|
|
|
|
|
router = APIRouter()
|
|
|
|
# How many clients have subscribed to notifications
|
|
_notifications_listening = {}
|
|
|
|
|
|
def dep_project(project_id: UUID):
|
|
"""
|
|
Dependency to retrieve a project.
|
|
"""
|
|
|
|
pm = ProjectManager.instance()
|
|
project = pm.get_project(str(project_id))
|
|
return project
|
|
|
|
|
|
@router.get("/projects", response_model=List[schemas.Project])
|
|
def get_projects():
|
|
"""
|
|
Get all projects opened on the compute.
|
|
"""
|
|
|
|
pm = ProjectManager.instance()
|
|
return [p.__json__() for p in pm.projects]
|
|
|
|
|
|
@router.post("/projects",
|
|
status_code=status.HTTP_201_CREATED,
|
|
response_model=schemas.Project)
|
|
def create_project(project_data: schemas.ProjectCreate):
|
|
"""
|
|
Create a new project on the compute.
|
|
"""
|
|
|
|
pm = ProjectManager.instance()
|
|
project_data = jsonable_encoder(project_data, exclude_unset=True)
|
|
project = pm.create_project(name=project_data.get("name"),
|
|
path=project_data.get("path"),
|
|
project_id=project_data.get("project_id"),
|
|
variables=project_data.get("variables", None))
|
|
return project.__json__()
|
|
|
|
|
|
@router.put("/projects/{project_id}",
|
|
response_model=schemas.Project)
|
|
async def update_project(project_data: schemas.ProjectUpdate, project: Project = Depends(dep_project)):
|
|
"""
|
|
Update project on the compute.
|
|
"""
|
|
|
|
await project.update(variables=project_data.variables)
|
|
return project.__json__()
|
|
|
|
|
|
@router.get("/projects/{project_id}",
|
|
response_model=schemas.Project)
|
|
def get_project(project: Project = Depends(dep_project)):
|
|
"""
|
|
Return a project from the compute.
|
|
"""
|
|
|
|
return project.__json__()
|
|
|
|
|
|
@router.post("/projects/{project_id}/close",
|
|
status_code=status.HTTP_204_NO_CONTENT)
|
|
async def close_project(project: Project = Depends(dep_project)):
|
|
"""
|
|
Close a project on the compute.
|
|
"""
|
|
|
|
# FIXME
|
|
if _notifications_listening.setdefault(project.id, 0) <= 1:
|
|
await project.close()
|
|
ProjectManager.instance().remove_project(project.id)
|
|
try:
|
|
del _notifications_listening[project.id]
|
|
except KeyError:
|
|
pass
|
|
else:
|
|
log.warning("Skip project closing, another client is listening for project notifications")
|
|
|
|
|
|
@router.delete("/projects/{project_id}",
|
|
status_code=status.HTTP_204_NO_CONTENT)
|
|
async def delete_project(project: Project = Depends(dep_project)):
|
|
"""
|
|
Delete project from the compute.
|
|
"""
|
|
|
|
await project.delete()
|
|
ProjectManager.instance().remove_project(project.id)
|
|
|
|
# @Route.get(
|
|
# r"/projects/{project_id}/notifications",
|
|
# description="Receive notifications about the project",
|
|
# parameters={
|
|
# "project_id": "Project UUID",
|
|
# },
|
|
# status_codes={
|
|
# 200: "End of stream",
|
|
# 404: "The project doesn't exist"
|
|
# })
|
|
# async def notification(request, response):
|
|
#
|
|
# pm = ProjectManager.instance()
|
|
# project = pm.get_project(request.match_info["project_id"])
|
|
#
|
|
# response.content_type = "application/json"
|
|
# response.set_status(200)
|
|
# response.enable_chunked_encoding()
|
|
#
|
|
# response.start(request)
|
|
# queue = project.get_listen_queue()
|
|
# ProjectHandler._notifications_listening.setdefault(project.id, 0)
|
|
# ProjectHandler._notifications_listening[project.id] += 1
|
|
# await response.write("{}\n".format(json.dumps(ProjectHandler._getPingMessage())).encode("utf-8"))
|
|
# while True:
|
|
# try:
|
|
# (action, msg) = await asyncio.wait_for(queue.get(), 5)
|
|
# if hasattr(msg, "__json__"):
|
|
# msg = json.dumps({"action": action, "event": msg.__json__()}, sort_keys=True)
|
|
# else:
|
|
# msg = json.dumps({"action": action, "event": msg}, sort_keys=True)
|
|
# log.debug("Send notification: %s", msg)
|
|
# await response.write(("{}\n".format(msg)).encode("utf-8"))
|
|
# except asyncio.TimeoutError:
|
|
# await response.write("{}\n".format(json.dumps(ProjectHandler._getPingMessage())).encode("utf-8"))
|
|
# project.stop_listen_queue(queue)
|
|
# if project.id in ProjectHandler._notifications_listening:
|
|
# ProjectHandler._notifications_listening[project.id] -= 1
|
|
|
|
# def _getPingMessage(cls):
|
|
# """
|
|
# Ping messages are regularly sent to the client to
|
|
# keep the connection open. We send with it some information about server load.
|
|
#
|
|
# :returns: hash
|
|
# """
|
|
# stats = {}
|
|
# # Non blocking call in order to get cpu usage. First call will return 0
|
|
# stats["cpu_usage_percent"] = CpuPercent.get(interval=None)
|
|
# stats["memory_usage_percent"] = psutil.virtual_memory().percent
|
|
# stats["disk_usage_percent"] = psutil.disk_usage(get_default_project_directory()).percent
|
|
# return {"action": "ping", "event": stats}
|
|
|
|
|
|
@router.get("/projects/{project_id}/files",
|
|
response_model=List[schemas.ProjectFile])
|
|
async def get_project_files(project: Project = Depends(dep_project)):
|
|
"""
|
|
Return files belonging to a project.
|
|
"""
|
|
|
|
return await project.list_files()
|
|
|
|
|
|
@router.get("/projects/{project_id}/files/{file_path:path}")
|
|
async def get_file(file_path: str, project: Project = Depends(dep_project)):
|
|
"""
|
|
Get a file from a project.
|
|
"""
|
|
|
|
path = os.path.normpath(file_path)
|
|
|
|
# Raise error if user try to escape
|
|
if path[0] == ".":
|
|
raise HTTPException(status_code=status.HTTP_403_FORBIDDEN)
|
|
|
|
path = os.path.join(project.path, path)
|
|
if not os.path.exists(path):
|
|
raise HTTPException(status_code=status.HTTP_404_NOT_FOUND)
|
|
|
|
return FileResponse(path, media_type="application/octet-stream")
|
|
|
|
|
|
@router.post("/projects/{project_id}/files/{file_path:path}",
|
|
status_code=status.HTTP_204_NO_CONTENT)
|
|
async def write_file(file_path: str, request: Request, project: Project = Depends(dep_project)):
|
|
|
|
path = os.path.normpath(file_path)
|
|
|
|
# Raise error if user try to escape
|
|
if path[0] == ".":
|
|
raise HTTPException(status_code=status.HTTP_403_FORBIDDEN)
|
|
|
|
path = os.path.join(project.path, path)
|
|
try:
|
|
os.makedirs(os.path.dirname(path), exist_ok=True)
|
|
|
|
try:
|
|
with open(path, "wb+") as f:
|
|
async for chunk in request.stream():
|
|
f.write(chunk)
|
|
except (UnicodeEncodeError, OSError) as e:
|
|
pass # FIXME
|
|
|
|
except FileNotFoundError:
|
|
raise HTTPException(status_code=status.HTTP_404_NOT_FOUND)
|
|
except PermissionError:
|
|
raise HTTPException(status_code=status.HTTP_403_FORBIDDEN)
|