Files
AstrBot/astrbot/dashboard/api/files.py
Weilong Liao 0d8e8682db refactor(core): migrate backend backbone from Quart to FastAPI and introduce more OpenAPI (#8688)
* refactor: migrate to fastapi

* structure refactor

* fix: pyright fix

* refactor: improve error handling and public messages in plugin services

* feat(api): refactor API client integration and enhance request handling

- Updated API client configuration to use a dedicated HTTP client.
- Introduced utility functions for generating options, queries, and form data for API requests.
- Refactored multiple API methods to utilize the new utility functions for improved consistency and readability.
- Renamed types for clarity and updated import statements accordingly.

feat(docs): add script to update OpenAPI JSON from YAML spec

- Created a Python script to convert OpenAPI YAML specification to JSON format.
- The script supports customizable input and output paths.
- Ensured the script handles directory creation for output paths and validates the YAML structure.

* fix

* feat(auth): implement rate limiting for v1 login endpoint and enhance request handling

* Refactor dashboard API routers to use legacy_router for backward compatibility

- Changed all instances of dashboard_router to legacy_router across multiple API modules including platform, plugins, providers, sessions, skills, stats, subagents, t2i, tools, updates, and asgi_runtime.
- Updated route definitions to ensure existing endpoints remain functional under the new router structure.
- Introduced support for Quart request context in asgi_runtime to enhance compatibility with existing Quart-based plugins.
- Added a test case to validate the functionality of the new Quart request context handling in plugin extensions.

* chore: remove cli test

* fix: update dashboard tests for fastapi migration

* chore: satisfy ruff checks

* fix: update openapi api key scopes

* fix: sync config scope chip selection

* fix: restore quart dependency

* docs: clarify quart plugin api compatibility

* docs: update openapi scope documentation

* fix: use singular skill openapi scope

* fix: hide update service exception details

* fix: address fastapi review comments

* fix: address dashboard review findings

* docs: revert unrelated package deployment changes

* docs: update agent api generation guidance

* feat: add plugin page web api helpers

* docs: add plugin page bridge demo

* fix: type plugin upload files

* fix: stabilize plugin page uploads

* fix: type plugin web request proxy

* docs: remove plugin page docs example

* fix: authenticate plugin page SSE bridge
2026-06-14 15:03:26 +08:00

120 lines
3.7 KiB
Python

from __future__ import annotations
from fastapi import APIRouter, Depends, File, HTTPException, Query, Request, UploadFile
from fastapi.responses import FileResponse
from astrbot.dashboard.async_utils import run_maybe_async
from astrbot.dashboard.responses import error, ok
from astrbot.dashboard.services.chat_service import ChatService, ChatServiceError
from astrbot.dashboard.services.file_service import FileService, FileServiceError
from .auth import AuthContext, require_scope
from .multipart import UploadFileAdapter
router = APIRouter(tags=["Files"])
legacy_router = APIRouter(prefix="/api", include_in_schema=False)
def get_service(request: Request) -> FileService:
return request.app.state.services.files
def get_chat_service(request: Request) -> ChatService:
return request.app.state.services.chat
async def require_file_scope(request: Request) -> AuthContext:
return await require_scope(request, "file")
async def _serve_token_file(file_token: str, service: FileService):
try:
return FileResponse(await service.resolve_token_file(file_token))
except FileServiceError as exc:
raise HTTPException(status_code=404) from exc
def _file_response(file_path: str, mimetype: str | None = None) -> FileResponse:
if mimetype:
return FileResponse(file_path, media_type=mimetype)
return FileResponse(file_path)
async def _run_file(operation, *, error_message: str = "File access error"):
try:
result = await run_maybe_async(operation)
return result
except ChatServiceError as exc:
return error(str(exc))
except (FileNotFoundError, OSError):
return error(error_message)
async def _upload_file(file: UploadFile, service: ChatService):
result = await _run_file(
lambda: service.save_uploaded_file(UploadFileAdapter(file))
)
if isinstance(result, dict) and result.get("status") == "error":
return result
return ok(result)
@router.get("/files/tokens/{file_token}")
async def get_token_file(
file_token: str,
service: FileService = Depends(get_service),
):
return await _serve_token_file(file_token, service)
@router.post("/files")
async def upload_file(
file: UploadFile = File(...),
_auth: AuthContext = Depends(require_file_scope),
service: ChatService = Depends(get_chat_service),
):
return await _upload_file(file, service)
@router.get("/files/content")
async def get_file_by_name(
filename: str | None = Query(default=None),
_auth: AuthContext = Depends(require_file_scope),
service: ChatService = Depends(get_chat_service),
):
result = await _run_file(lambda: service.resolve_webchat_file(filename))
if isinstance(result, dict) and result.get("status") == "error":
return result
file_path, mimetype = result
return _file_response(file_path, mimetype)
@router.get("/files/{attachment_id}")
@router.get("/files/{attachment_id}/content")
async def get_file(
attachment_id: str,
_auth: AuthContext = Depends(require_file_scope),
service: ChatService = Depends(get_chat_service),
):
result = await _run_file(lambda: service.resolve_attachment_file(attachment_id))
if isinstance(result, dict) and result.get("status") == "error":
return result
file_path, mimetype = result
return _file_response(file_path, mimetype)
@router.delete("/files/{attachment_id}")
async def delete_file(
attachment_id: str,
_auth: AuthContext = Depends(require_file_scope),
):
return ok({"attachment_id": attachment_id})
@legacy_router.get("/file/{file_token}")
async def get_dashboard_token_file(
file_token: str,
service: FileService = Depends(get_service),
):
return await _serve_token_file(file_token, service)