1
0
mirror of https://github.com/GNS3/gns3-server synced 2024-12-04 22:28:12 +00:00
gns3-server/gns3server/api/routes/controller/nodes.py

468 lines
15 KiB
Python
Raw Normal View History

2020-10-02 06:37:50 +00:00
#
# Copyright (C) 2020 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 routes for nodes.
2020-10-02 06:37:50 +00:00
"""
import aiohttp
2020-10-02 06:37:50 +00:00
import asyncio
from fastapi import APIRouter, Depends, WebSocket, WebSocketDisconnect, Request, Response, status
2020-10-02 06:37:50 +00:00
from fastapi.encoders import jsonable_encoder
from fastapi.routing import APIRoute
from typing import List, Callable
from uuid import UUID
from gns3server.controller import Controller
from gns3server.controller.node import Node
from gns3server.controller.project import Project
2020-10-02 06:37:50 +00:00
from gns3server.utils import force_unix_path
from gns3server.utils.http_client import HTTPClient
from gns3server.controller.controller_error import ControllerForbiddenError, ControllerBadRequestError
2020-10-31 05:32:21 +00:00
from gns3server import schemas
2020-10-02 06:37:50 +00:00
import logging
2021-04-13 09:16:50 +00:00
log = logging.getLogger(__name__)
2020-10-02 06:37:50 +00:00
node_locks = {}
class NodeConcurrency(APIRoute):
"""
To avoid strange effects, we prevent concurrency
2020-10-02 06:37:50 +00:00
between the same instance of the node
(excepting when streaming a PCAP file and for WebSocket consoles).
2020-10-02 06:37:50 +00:00
"""
def get_route_handler(self) -> Callable:
original_route_handler = super().get_route_handler()
async def custom_route_handler(request: Request) -> Response:
node_id = request.path_params.get("node_id")
project_id = request.path_params.get("project_id")
if node_id and "pcap" not in request.url.path and not request.url.path.endswith("console/ws"):
2021-04-13 09:07:58 +00:00
lock_key = f"{project_id}:{node_id}"
2020-10-02 06:37:50 +00:00
node_locks.setdefault(lock_key, {"lock": asyncio.Lock(), "concurrency": 0})
node_locks[lock_key]["concurrency"] += 1
async with node_locks[lock_key]["lock"]:
response = await original_route_handler(request)
node_locks[lock_key]["concurrency"] -= 1
if node_locks[lock_key]["concurrency"] <= 0:
del node_locks[lock_key]
else:
response = await original_route_handler(request)
return response
return custom_route_handler
2021-04-13 09:16:50 +00:00
responses = {404: {"model": schemas.ErrorMessage, "description": "Could not find project or node"}}
2021-04-13 06:49:56 +00:00
router = APIRouter(route_class=NodeConcurrency, responses=responses)
async def dep_project(project_id: UUID) -> Project:
"""
Dependency to retrieve a project.
"""
project = await Controller.instance().get_loaded_project(str(project_id))
return project
2020-10-02 06:37:50 +00:00
async def dep_node(node_id: UUID, project: Project = Depends(dep_project)) -> None:
"""
Dependency to retrieve a node.
"""
node = project.get_node(str(node_id))
return node
2021-04-13 09:16:50 +00:00
@router.post(
"",
status_code=status.HTTP_201_CREATED,
response_model=schemas.Node,
responses={
404: {"model": schemas.ErrorMessage, "description": "Could not find project"},
409: {"model": schemas.ErrorMessage, "description": "Could not create node"},
},
)
async def create_node(node_data: schemas.NodeCreate, project: Project = Depends(dep_project)) -> schemas.Node:
"""
Create a new node.
"""
2020-10-02 06:37:50 +00:00
controller = Controller.instance()
compute = controller.get_compute(str(node_data.compute_id))
node_data = jsonable_encoder(node_data, exclude_unset=True)
2021-04-13 09:16:50 +00:00
node = await project.add_node(compute, node_data.pop("name"), node_data.pop("node_id", None), **node_data)
2021-04-17 14:04:28 +00:00
return node.asdict()
2020-10-02 06:37:50 +00:00
2021-04-13 09:16:50 +00:00
@router.get("", response_model=List[schemas.Node], response_model_exclude_unset=True)
async def get_nodes(project: Project = Depends(dep_project)) -> List[schemas.Node]:
"""
Return all nodes belonging to a given project.
"""
2020-10-02 06:37:50 +00:00
2021-04-17 14:04:28 +00:00
return [v.asdict() for v in project.nodes.values()]
2020-10-02 06:37:50 +00:00
2021-04-13 09:16:50 +00:00
@router.post("/start", status_code=status.HTTP_204_NO_CONTENT)
async def start_all_nodes(project: Project = Depends(dep_project)) -> Response:
2020-10-02 06:37:50 +00:00
"""
Start all nodes belonging to a given project.
2020-10-02 06:37:50 +00:00
"""
await project.start_all()
return Response(status_code=status.HTTP_204_NO_CONTENT)
2020-10-02 06:37:50 +00:00
2021-04-13 09:16:50 +00:00
@router.post("/stop", status_code=status.HTTP_204_NO_CONTENT)
async def stop_all_nodes(project: Project = Depends(dep_project)) -> Response:
2020-10-02 06:37:50 +00:00
"""
Stop all nodes belonging to a given project.
2020-10-02 06:37:50 +00:00
"""
await project.stop_all()
return Response(status_code=status.HTTP_204_NO_CONTENT)
2020-10-02 06:37:50 +00:00
2021-04-13 09:16:50 +00:00
@router.post("/suspend", status_code=status.HTTP_204_NO_CONTENT)
async def suspend_all_nodes(project: Project = Depends(dep_project)) -> Response:
2020-10-02 06:37:50 +00:00
"""
Suspend all nodes belonging to a given project.
2020-10-02 06:37:50 +00:00
"""
await project.suspend_all()
return Response(status_code=status.HTTP_204_NO_CONTENT)
2020-10-02 06:37:50 +00:00
2021-04-13 09:16:50 +00:00
@router.post("/reload", status_code=status.HTTP_204_NO_CONTENT)
async def reload_all_nodes(project: Project = Depends(dep_project)) -> Response:
2020-10-02 06:37:50 +00:00
"""
Reload all nodes belonging to a given project.
2020-10-02 06:37:50 +00:00
"""
await project.stop_all()
await project.start_all()
return Response(status_code=status.HTTP_204_NO_CONTENT)
2020-10-02 06:37:50 +00:00
2021-04-13 09:16:50 +00:00
@router.get("/{node_id}", response_model=schemas.Node)
def get_node(node: Node = Depends(dep_node)) -> schemas.Node:
"""
Return a node from a given project.
"""
2020-10-02 06:37:50 +00:00
2021-04-17 14:04:28 +00:00
return node.asdict()
2020-10-02 06:37:50 +00:00
2021-04-13 09:16:50 +00:00
@router.put("/{node_id}", response_model=schemas.Node, response_model_exclude_unset=True)
async def update_node(node_data: schemas.NodeUpdate, node: Node = Depends(dep_node)) -> schemas.Node:
"""
Update a node.
"""
2020-10-02 06:37:50 +00:00
node_data = jsonable_encoder(node_data, exclude_unset=True)
# Ignore these because we only use them when creating a node
node_data.pop("node_id", None)
node_data.pop("node_type", None)
node_data.pop("compute_id", None)
await node.update(**node_data)
2021-04-17 14:04:28 +00:00
return node.asdict()
2020-10-02 06:37:50 +00:00
2021-04-13 09:16:50 +00:00
@router.delete(
"/{node_id}",
status_code=status.HTTP_204_NO_CONTENT,
responses={**responses, 409: {"model": schemas.ErrorMessage, "description": "Cannot delete node"}},
)
async def delete_node(node_id: UUID, project: Project = Depends(dep_project)) -> Response:
"""
Delete a node from a project.
"""
2020-10-02 06:37:50 +00:00
await project.delete_node(str(node_id))
return Response(status_code=status.HTTP_204_NO_CONTENT)
2020-10-02 06:37:50 +00:00
2021-04-13 09:16:50 +00:00
@router.post("/{node_id}/duplicate", response_model=schemas.Node, status_code=status.HTTP_201_CREATED)
async def duplicate_node(duplicate_data: schemas.NodeDuplicate, node: Node = Depends(dep_node)) -> schemas.Node:
"""
Duplicate a node.
"""
2020-10-02 06:37:50 +00:00
2021-04-13 09:16:50 +00:00
new_node = await node.project.duplicate_node(node, duplicate_data.x, duplicate_data.y, duplicate_data.z)
2021-04-17 14:04:28 +00:00
return new_node.asdict()
2020-10-02 06:37:50 +00:00
2021-04-13 09:16:50 +00:00
@router.post("/{node_id}/start", status_code=status.HTTP_204_NO_CONTENT)
async def start_node(start_data: dict, node: Node = Depends(dep_node)) -> Response:
"""
Start a node.
"""
2020-10-02 06:37:50 +00:00
await node.start(data=start_data)
return Response(status_code=status.HTTP_204_NO_CONTENT)
2020-10-02 06:37:50 +00:00
2021-04-13 09:16:50 +00:00
@router.post("/{node_id}/stop", status_code=status.HTTP_204_NO_CONTENT)
async def stop_node(node: Node = Depends(dep_node)) -> Response:
"""
Stop a node.
"""
2020-10-02 06:37:50 +00:00
await node.stop()
return Response(status_code=status.HTTP_204_NO_CONTENT)
2020-10-02 06:37:50 +00:00
2021-04-13 09:16:50 +00:00
@router.post("/{node_id}/suspend", status_code=status.HTTP_204_NO_CONTENT)
async def suspend_node(node: Node = Depends(dep_node)) -> Response:
"""
Suspend a node.
"""
2020-10-02 06:37:50 +00:00
await node.suspend()
return Response(status_code=status.HTTP_204_NO_CONTENT)
2020-10-02 06:37:50 +00:00
2021-04-13 09:16:50 +00:00
@router.post("/{node_id}/reload", status_code=status.HTTP_204_NO_CONTENT)
async def reload_node(node: Node = Depends(dep_node)) -> Response:
"""
Reload a node.
"""
2020-10-02 06:37:50 +00:00
await node.reload()
return Response(status_code=status.HTTP_204_NO_CONTENT)
@router.post("/{node_id}/isolate", status_code=status.HTTP_204_NO_CONTENT)
async def isolate_node(node: Node = Depends(dep_node)) -> Response:
"""
Isolate a node (suspend all attached links).
"""
for link in node.links:
await link.update_suspend(True)
return Response(status_code=status.HTTP_204_NO_CONTENT)
@router.post("/{node_id}/unisolate", status_code=status.HTTP_204_NO_CONTENT)
async def unisolate_node(node: Node = Depends(dep_node)) -> Response:
"""
Un-isolate a node (resume all attached suspended links).
"""
for link in node.links:
await link.update_suspend(False)
return Response(status_code=status.HTTP_204_NO_CONTENT)
2020-10-02 06:37:50 +00:00
2021-04-13 09:16:50 +00:00
@router.get("/{node_id}/links", response_model=List[schemas.Link], response_model_exclude_unset=True)
async def get_node_links(node: Node = Depends(dep_node)) -> List[schemas.Link]:
2020-10-02 06:37:50 +00:00
"""
Return all the links connected to a node.
2020-10-02 06:37:50 +00:00
"""
links = []
for link in node.links:
2021-04-17 14:04:28 +00:00
links.append(link.asdict())
2020-10-02 06:37:50 +00:00
return links
2021-04-13 06:49:56 +00:00
@router.get("/{node_id}/dynamips/auto_idlepc")
async def auto_idlepc(node: Node = Depends(dep_node)) -> str:
2020-10-02 06:37:50 +00:00
"""
Compute an Idle-PC value for a Dynamips node
"""
if node.node_type != "dynamips":
raise ControllerBadRequestError("Auto Idle-PC is only supported on a Dynamips node")
2020-10-02 06:37:50 +00:00
return await node.dynamips_auto_idlepc()
2021-04-13 06:49:56 +00:00
@router.get("/{node_id}/dynamips/idlepc_proposals")
async def idlepc_proposals(node: Node = Depends(dep_node)) -> List[str]:
2020-10-02 06:37:50 +00:00
"""
Compute a list of potential idle-pc values for a Dynamips node
"""
if node.node_type != "dynamips":
raise ControllerBadRequestError("Idle-PC proposals is only supported on a Dynamips node")
2020-10-02 06:37:50 +00:00
return await node.dynamips_idlepc_proposals()
@router.post("/{node_id}/qemu/disk_image/{disk_name}", status_code=status.HTTP_204_NO_CONTENT)
async def create_disk_image(
disk_name: str,
disk_data: schemas.QemuDiskImageCreate,
node: Node = Depends(dep_node)
) -> Response:
"""
Create a Qemu disk image.
"""
if node.node_type != "qemu":
raise ControllerBadRequestError("Creating a disk image is only supported on a Qemu node")
await node.post(f"/disk_image/{disk_name}", data=disk_data.dict(exclude_unset=True))
return Response(status_code=status.HTTP_204_NO_CONTENT)
@router.put("/{node_id}/qemu/disk_image/{disk_name}", status_code=status.HTTP_204_NO_CONTENT)
async def update_disk_image(
disk_name: str,
disk_data: schemas.QemuDiskImageUpdate,
node: Node = Depends(dep_node)
) -> Response:
"""
Update a Qemu disk image.
"""
if node.node_type != "qemu":
raise ControllerBadRequestError("Updating a disk image is only supported on a Qemu node")
await node.put(f"/disk_image/{disk_name}", data=disk_data.dict(exclude_unset=True))
return Response(status_code=status.HTTP_204_NO_CONTENT)
2020-10-02 06:37:50 +00:00
@router.delete("/{node_id}/qemu/disk_image/{disk_name}", status_code=status.HTTP_204_NO_CONTENT)
async def delete_disk_image(
disk_name: str,
node: Node = Depends(dep_node)
) -> Response:
"""
Delete a Qemu disk image.
"""
if node.node_type != "qemu":
raise ControllerBadRequestError("Deleting a disk image is only supported on a Qemu node")
await node.delete(f"/disk_image/{disk_name}")
return Response(status_code=status.HTTP_204_NO_CONTENT)
2021-04-13 06:49:56 +00:00
@router.get("/{node_id}/files/{file_path:path}")
async def get_file(file_path: str, node: Node = Depends(dep_node)) -> Response:
"""
Return a file in the node directory
"""
2020-10-02 06:37:50 +00:00
path = force_unix_path(file_path)
# Raise error if user try to escape
if path[0] == ".":
raise ControllerForbiddenError("It is forbidden to get a file outside the project directory")
node_type = node.node_type
2021-04-13 09:07:58 +00:00
path = f"/project-files/{node_type}/{node.id}/{path}"
2020-10-02 06:37:50 +00:00
2021-04-13 09:07:58 +00:00
res = await node.compute.http_query("GET", f"/projects/{node.project.id}/files{path}", timeout=None, raw=True)
return Response(res.body, media_type="application/octet-stream", status_code=res.status)
2020-10-02 06:37:50 +00:00
2021-04-13 09:16:50 +00:00
@router.post("/{node_id}/files/{file_path:path}", status_code=status.HTTP_201_CREATED)
async def post_file(file_path: str, request: Request, node: Node = Depends(dep_node)):
"""
Write a file in the node directory.
"""
2020-10-02 06:37:50 +00:00
path = force_unix_path(file_path)
# Raise error if user try to escape
if path[0] == ".":
raise ControllerForbiddenError("Cannot write outside the node directory")
node_type = node.node_type
2021-04-13 09:07:58 +00:00
path = f"/project-files/{node_type}/{node.id}/{path}"
2020-10-02 06:37:50 +00:00
2021-04-13 09:16:50 +00:00
data = await request.body() # FIXME: are we handling timeout or large files correctly?
2021-04-13 09:07:58 +00:00
await node.compute.http_query("POST", f"/projects/{node.project.id}/files{path}", data=data, timeout=None, raw=True)
# FIXME: response with correct status code (from compute)
2020-10-02 06:37:50 +00:00
@router.websocket("/{node_id}/console/ws")
async def ws_console(websocket: WebSocket, node: Node = Depends(dep_node)) -> None:
"""
WebSocket console.
"""
compute = node.compute
await websocket.accept()
2021-04-13 09:16:50 +00:00
log.info(
f"New client {websocket.client.host}:{websocket.client.port} has connected to controller console WebSocket"
)
ws_console_compute_url = (
f"ws://{compute.host}:{compute.port}/v3/compute/projects/"
f"{node.project.id}/{node.node_type}/nodes/{node.id}/console/ws"
)
async def ws_receive(ws_console_compute):
"""
Receive WebSocket data from client and forward to compute console WebSocket.
"""
try:
while True:
data = await websocket.receive_text()
if data:
await ws_console_compute.send_str(data)
except WebSocketDisconnect:
await ws_console_compute.close()
2021-04-13 09:16:50 +00:00
log.info(
f"Client {websocket.client.host}:{websocket.client.port} has disconnected from controller"
f" console WebSocket"
)
try:
# receive WebSocket data from compute console WebSocket and forward to client.
async with HTTPClient.get_client().ws_connect(ws_console_compute_url) as ws_console_compute:
asyncio.ensure_future(ws_receive(ws_console_compute))
async for msg in ws_console_compute:
if msg.type == aiohttp.WSMsgType.TEXT:
await websocket.send_text(msg.data)
elif msg.type == aiohttp.WSMsgType.BINARY:
await websocket.send_bytes(msg.data)
elif msg.type == aiohttp.WSMsgType.ERROR:
break
except aiohttp.ClientError as e:
log.error(f"Client error received when forwarding to compute console WebSocket: {e}")
2020-10-02 06:37:50 +00:00
2021-04-13 09:16:50 +00:00
@router.post("/console/reset", status_code=status.HTTP_204_NO_CONTENT)
async def reset_console_all_nodes(project: Project = Depends(dep_project)) -> Response:
2020-10-02 06:37:50 +00:00
"""
Reset console for all nodes belonging to the project.
"""
await project.reset_console_all()
return Response(status_code=status.HTTP_204_NO_CONTENT)
2020-10-02 06:37:50 +00:00
2021-04-13 09:16:50 +00:00
@router.post("/{node_id}/console/reset", status_code=status.HTTP_204_NO_CONTENT)
async def console_reset(node: Node = Depends(dep_node)) -> Response:
2020-10-02 06:37:50 +00:00
await node.post("/console/reset")
return Response(status_code=status.HTTP_204_NO_CONTENT)