mirror of
https://github.com/rommapp/romm.git
synced 2026-07-01 08:16:21 +00:00
8abbae4c02
According to multiple FastAPI discussions [1], FastAPI only includes a built-in mechanism to redirect requests including a trailing slash, to its variation without slash, using a `307` status code. This can be an issue when certain clients do not send the same headers on the redirected request. This change adds a custom FastAPI `APIRouter`, that registers both route path variations (with and without trailing slash), while only marking the path without slash for being included in the OpenAPI schema. [1] https://github.com/fastapi/fastapi/discussions/7298
152 lines
4.3 KiB
Python
152 lines
4.3 KiB
Python
from datetime import datetime
|
|
|
|
from decorators.auth import protected_route
|
|
from endpoints.responses import MessageResponse
|
|
from endpoints.responses.platform import PlatformSchema
|
|
from exceptions.endpoint_exceptions import PlatformNotFoundInDatabaseException
|
|
from exceptions.fs_exceptions import PlatformAlreadyExistsException
|
|
from fastapi import Request
|
|
from handler.database import db_platform_handler
|
|
from handler.filesystem import fs_platform_handler
|
|
from handler.metadata.igdb_handler import IGDB_PLATFORM_LIST
|
|
from handler.scan_handler import scan_platform
|
|
from logger.logger import log
|
|
from models.platform import Platform
|
|
from utils.router import APIRouter
|
|
|
|
router = APIRouter()
|
|
|
|
|
|
@protected_route(router.post, "/platforms", ["platforms.write"])
|
|
async def add_platforms(request: Request) -> PlatformSchema:
|
|
"""Create platform endpoint
|
|
|
|
Args:
|
|
request (Request): Fastapi Request object
|
|
|
|
Returns:
|
|
PlatformSchema: Just created platform
|
|
"""
|
|
|
|
data = await request.json()
|
|
fs_slug = data["fs_slug"]
|
|
try:
|
|
fs_platform_handler.add_platforms(fs_slug=fs_slug)
|
|
except PlatformAlreadyExistsException:
|
|
log.info(f"Detected platform: {fs_slug}")
|
|
scanned_platform = await scan_platform(fs_slug, [fs_slug])
|
|
return db_platform_handler.add_platform(scanned_platform)
|
|
|
|
|
|
@protected_route(router.get, "/platforms", ["platforms.read"])
|
|
def get_platforms(request: Request) -> list[PlatformSchema]:
|
|
"""Get platforms endpoint
|
|
|
|
Args:
|
|
request (Request): Fastapi Request object
|
|
id (int, optional): Platform id. Defaults to None.
|
|
|
|
Returns:
|
|
list[PlatformSchema]: List of platforms
|
|
"""
|
|
|
|
return db_platform_handler.get_platforms()
|
|
|
|
|
|
@protected_route(router.get, "/platforms/supported", ["platforms.read"])
|
|
def get_supported_platforms(request: Request) -> list[PlatformSchema]:
|
|
"""Get list of supported platforms endpoint
|
|
|
|
Args:
|
|
request (Request): Fastapi Request object
|
|
|
|
Returns:
|
|
list[PlatformSchema]: List of supported platforms
|
|
"""
|
|
|
|
supported_platforms = []
|
|
db_platforms: list[Platform] = db_platform_handler.get_platforms()
|
|
db_platforms_map = {p.name: p.id for p in db_platforms}
|
|
|
|
for platform in IGDB_PLATFORM_LIST:
|
|
sup_plat = {
|
|
"id": -1,
|
|
"name": platform["name"],
|
|
"fs_slug": platform["slug"],
|
|
"slug": platform["slug"],
|
|
"logo_path": "",
|
|
"roms": [],
|
|
"rom_count": 0,
|
|
"created_at": datetime.now(),
|
|
"updated_at": datetime.now(),
|
|
}
|
|
|
|
if platform["name"] in db_platforms_map:
|
|
sup_plat["id"] = db_platforms_map[platform["name"]]
|
|
|
|
supported_platforms.append(PlatformSchema.model_validate(sup_plat).model_dump())
|
|
|
|
return supported_platforms
|
|
|
|
|
|
@protected_route(router.get, "/platforms/{id}", ["platforms.read"])
|
|
def get_platform(request: Request, id: int) -> PlatformSchema:
|
|
"""Get platforms endpoint
|
|
|
|
Args:
|
|
request (Request): Fastapi Request object
|
|
id (int, optional): Platform id. Defaults to None.
|
|
|
|
Returns:
|
|
PlatformSchema: Platform
|
|
"""
|
|
|
|
platform = db_platform_handler.get_platform(id)
|
|
|
|
if not platform:
|
|
raise PlatformNotFoundInDatabaseException(id)
|
|
|
|
return platform
|
|
|
|
|
|
@protected_route(router.put, "/platforms/{id}", ["platforms.write"])
|
|
async def update_platform(request: Request) -> MessageResponse:
|
|
"""Update platform endpoint
|
|
|
|
Args:
|
|
request (Request): Fastapi Request object
|
|
|
|
Returns:
|
|
MessageResponse: Standard message response
|
|
"""
|
|
|
|
return {"msg": "Enpoint not available yet"}
|
|
|
|
|
|
@protected_route(router.delete, "/platforms/{id}", ["platforms.write"])
|
|
async def delete_platforms(request: Request, id: int) -> MessageResponse:
|
|
"""Delete platforms endpoint
|
|
|
|
Args:
|
|
request (Request): Fastapi Request object
|
|
{
|
|
"platforms": List of rom's ids to delete
|
|
}
|
|
|
|
Raises:
|
|
HTTPException: Platform not found
|
|
|
|
Returns:
|
|
MessageResponse: Standard message response
|
|
"""
|
|
|
|
platform = db_platform_handler.get_platform(id)
|
|
|
|
if not platform:
|
|
raise PlatformNotFoundInDatabaseException(id)
|
|
|
|
log.info(f"Deleting {platform.name} [{platform.fs_slug}] from database")
|
|
db_platform_handler.delete_platform(id)
|
|
|
|
return {"msg": f"{platform.name} - [{platform.fs_slug}] deleted successfully!"}
|