Files
g0v0-server/app/router/lio.py
咕谷酱 97dcc86d4d Add endpoint to ensure beatmap presence and cache
Introduces a new /beatmaps/ensure API endpoint to verify and cache beatmap metadata and raw files. Updates Playlist model to use auto-incrementing primary key and improves playlist DB insertion logic. Minor formatting and import changes in room and lio modules.
2025-08-26 13:18:11 +08:00

696 lines
24 KiB
Python

"""LIO (Legacy IO) router for osu-server-spectator compatibility."""
from __future__ import annotations
import json
from typing import Any, Dict, List
from fastapi import APIRouter, HTTPException, Request, status, Query, Depends
from pydantic import BaseModel
from sqlmodel import col, select, desc
from sqlalchemy import update
from redis.asyncio import Redis
from app.database.lazer_user import User
from app.database.playlists import Playlist as DBPlaylist
from app.database.room import Room
from app.database.room_participated_user import RoomParticipatedUser
from app.dependencies.database import Database, get_redis
from app.dependencies.fetcher import get_fetcher
from app.fetcher import Fetcher
from app.models.multiplayer_hub import PlaylistItem as HubPlaylistItem
from app.models.room import MatchType, QueueMode, RoomStatus
from app.utils import utcnow
router = APIRouter(prefix="/_lio", tags=["LIO"])
class RoomCreateRequest(BaseModel):
"""Request model for creating a multiplayer room."""
name: str
user_id: int
password: str | None = None
match_type: str = "HeadToHead"
queue_mode: str = "HostOnly"
initial_playlist: List[Dict[str, Any]] = []
playlist: List[Dict[str, Any]] = []
def verify_request_signature(request: Request, timestamp: str, body: bytes) -> bool:
"""
Verify HMAC signature for shared interop requests.
Args:
request: FastAPI request object
timestamp: Request timestamp
body: Request body bytes
Returns:
bool: True if signature is valid
Note:
Currently skips verification in development.
In production, implement proper HMAC verification.
"""
# TODO: Implement proper HMAC verification for production
return True
async def _validate_user_exists(db: Database, user_id: int) -> User:
"""Validate that a user exists in the database."""
user_result = await db.execute(select(User).where(User.id == user_id))
user = user_result.scalar_one_or_none()
if not user:
raise HTTPException(
status_code=status.HTTP_404_NOT_FOUND,
detail=f"User with ID {user_id} not found"
)
return user
def _parse_room_enums(match_type: str, queue_mode: str) -> tuple[MatchType, QueueMode]:
"""Parse and validate room type enums."""
try:
match_type_enum = MatchType(match_type.lower())
except ValueError:
match_type_enum = MatchType.HEAD_TO_HEAD
try:
queue_mode_enum = QueueMode(queue_mode.lower())
except ValueError:
queue_mode_enum = QueueMode.HOST_ONLY
return match_type_enum, queue_mode_enum
def _coerce_playlist_item(item_data: Dict[str, Any], default_order: int, host_user_id: int) -> Dict[str, Any]:
"""
Normalize playlist item data with default values.
Args:
item_data: Raw playlist item data
default_order: Default playlist order
host_user_id: Host user ID for default owner
Returns:
Dict with normalized playlist item data
"""
# Use host_user_id if owner_id is 0 or not provided
owner_id = item_data.get("owner_id", host_user_id)
if owner_id == 0:
owner_id = host_user_id
return {
"owner_id": owner_id,
"ruleset_id": item_data.get("ruleset_id", 0),
"beatmap_id": item_data.get("beatmap_id"),
"required_mods": item_data.get("required_mods", []),
"allowed_mods": item_data.get("allowed_mods", []),
"expired": bool(item_data.get("expired", False)),
"playlist_order": item_data.get("playlist_order", default_order),
"played_at": item_data.get("played_at", None),
"freestyle": bool(item_data.get("freestyle", True)),
"beatmap_checksum": item_data.get("beatmap_checksum", ""),
"star_rating": item_data.get("star_rating", 0.0),
}
def _validate_playlist_items(items: List[Dict[str, Any]]) -> None:
"""Validate playlist items data."""
if not items:
raise HTTPException(
status_code=status.HTTP_400_BAD_REQUEST,
detail="At least one playlist item is required to create a room"
)
for idx, item in enumerate(items):
if item["beatmap_id"] is None:
raise HTTPException(
status_code=status.HTTP_400_BAD_REQUEST,
detail=f"Playlist item at index {idx} missing beatmap_id"
)
ruleset_id = item["ruleset_id"]
if not isinstance(ruleset_id, int) or not (0 <= ruleset_id <= 3):
raise HTTPException(
status_code=status.HTTP_400_BAD_REQUEST,
detail=f"Playlist item at index {idx} has invalid ruleset_id {ruleset_id}"
)
async def _create_room(db: Database, room_data: Dict[str, Any]) -> tuple[Room, int]:
"""Create a new multiplayer room."""
host_user_id = room_data.get("user_id")
room_name = room_data.get("name", "Unnamed Room")
password = room_data.get("password")
match_type = room_data.get("match_type", "HeadToHead")
queue_mode = room_data.get("queue_mode", "HostOnly")
if not host_user_id or not isinstance(host_user_id, int):
raise HTTPException(
status_code=status.HTTP_400_BAD_REQUEST,
detail="Missing or invalid user_id"
)
# Validate host user exists
await _validate_user_exists(db, host_user_id)
# Parse room type enums
match_type_enum, queue_mode_enum = _parse_room_enums(match_type, queue_mode)
# Create room
room = Room(
name=room_name,
host_id=host_user_id,
password=password if password else None,
type=match_type_enum,
queue_mode=queue_mode_enum,
status=RoomStatus.IDLE,
participant_count=1,
auto_skip=False,
auto_start_duration=0,
)
db.add(room)
await db.commit()
await db.refresh(room)
return room, host_user_id
async def _add_playlist_items(db: Database, room_id: int, room_data: Dict[str, Any], host_user_id: int) -> None:
"""Add playlist items to the room."""
initial_playlist = room_data.get("initial_playlist", [])
legacy_playlist = room_data.get("playlist", [])
items_raw: List[Dict[str, Any]] = []
# Process initial playlist
for i, item in enumerate(initial_playlist):
if hasattr(item, "dict"):
item = item.dict()
items_raw.append(_coerce_playlist_item(item, i, host_user_id))
# Process legacy playlist
start_index = len(items_raw)
for j, item in enumerate(legacy_playlist, start=start_index):
items_raw.append(_coerce_playlist_item(item, j, host_user_id))
# Validate playlist items
_validate_playlist_items(items_raw)
# Insert playlist items
for item_data in items_raw:
hub_item = HubPlaylistItem(
id=-1, # Placeholder, will be assigned by add_to_db
owner_id=item_data["owner_id"],
ruleset_id=item_data["ruleset_id"],
expired=item_data["expired"],
playlist_order=item_data["playlist_order"],
played_at=item_data["played_at"],
allowed_mods=item_data["allowed_mods"],
required_mods=item_data["required_mods"],
beatmap_id=item_data["beatmap_id"],
freestyle=item_data["freestyle"],
beatmap_checksum=item_data["beatmap_checksum"],
star_rating=item_data["star_rating"],
)
await DBPlaylist.add_to_db(hub_item, room_id=room_id, session=db)
async def _add_host_as_participant(db: Database, room_id: int, host_user_id: int) -> None:
"""Add the host as a room participant and update participant count."""
participant = RoomParticipatedUser(room_id=room_id, user_id=host_user_id)
db.add(participant)
await _update_room_participant_count(db, room_id)
async def _verify_room_password(db: Database, room_id: int, provided_password: str | None) -> None:
"""Verify room password if required."""
room_result = await db.execute(
select(Room).where(col(Room.id) == room_id)
)
room = room_result.scalar_one_or_none()
if room is None:
print(f"Room {room_id} not found")
raise HTTPException(
status_code=status.HTTP_404_NOT_FOUND,
detail="Room not found"
)
print(f"Room {room_id} has password: {bool(room.password)}, provided: {bool(provided_password)}")
# If room has password but none provided
if room.password and not provided_password:
print(f"Room {room_id} requires password but none provided")
raise HTTPException(
status_code=status.HTTP_403_FORBIDDEN,
detail="Password required"
)
# If room has password and provided password doesn't match
if room.password and provided_password and provided_password != room.password:
print(f"Room {room_id} password mismatch")
raise HTTPException(
status_code=status.HTTP_403_FORBIDDEN,
detail="Invalid password"
)
print(f"Room {room_id} password verification passed")
async def _add_or_update_participant(db: Database, room_id: int, user_id: int) -> None:
"""添加用户为参与者或更新现有参与记录。"""
# 检查用户是否已有活跃的参与记录
existing_result = await db.execute(
select(RoomParticipatedUser.id).where(
RoomParticipatedUser.room_id == room_id,
RoomParticipatedUser.user_id == user_id,
col(RoomParticipatedUser.left_at).is_(None)
)
)
existing_ids = existing_result.scalars().all() # 获取所有匹配的ID
if existing_ids:
# 如果存在多条记录,清理重复项,只保留最新的一条
if len(existing_ids) > 1:
print(f"警告:用户 {user_id} 在房间 {room_id} 中发现 {len(existing_ids)} 条活跃参与记录")
# 将除第一条外的所有记录标记为已离开(清理重复记录)
for extra_id in existing_ids[1:]:
await db.execute(
update(RoomParticipatedUser)
.where(col(RoomParticipatedUser.id) == extra_id)
.values(left_at=utcnow())
)
# 更新剩余的活跃参与记录(刷新加入时间)
await db.execute(
update(RoomParticipatedUser)
.where(col(RoomParticipatedUser.id) == existing_ids[0])
.values(joined_at=utcnow())
)
else:
# 创建新的参与记录
participant = RoomParticipatedUser(room_id=room_id, user_id=user_id)
db.add(participant)
class BeatmapEnsureRequest(BaseModel):
"""Request model for ensuring beatmap exists."""
beatmap_id: int
async def _ensure_beatmap_exists(db: Database, fetcher, redis, beatmap_id: int) -> Dict[str, Any]:
"""
确保谱面存在(包括元数据和原始文件缓存)。
Args:
db: 数据库会话
fetcher: API获取器
redis: Redis连接
beatmap_id: 谱面ID
Returns:
Dict: 包含状态信息的响应
"""
try:
# 1. 确保谱面元数据存在于数据库中
from app.database.beatmap import Beatmap
beatmap = await Beatmap.get_or_fetch(db, fetcher, bid=beatmap_id)
if not beatmap:
return {
"success": False,
"error": f"Beatmap {beatmap_id} not found",
"beatmap_id": beatmap_id
}
# 2. 预缓存谱面原始文件
cache_key = f"beatmap:{beatmap_id}:raw"
cached = await redis.exists(cache_key)
if not cached:
# 异步预加载原始文件到缓存
try:
await fetcher.get_or_fetch_beatmap_raw(redis, beatmap_id)
print(f"Successfully cached raw beatmap file for {beatmap_id}")
except Exception as e:
print(f"Warning: Failed to cache raw beatmap {beatmap_id}: {e}")
# 即使原始文件缓存失败,也认为确保操作成功(因为元数据已存在)
return {
"success": True,
"beatmap_id": beatmap_id,
"metadata_cached": True,
"raw_file_cached": await redis.exists(cache_key),
"beatmap_title": f"{beatmap.beatmapset.artist} - {beatmap.beatmapset.title} [{beatmap.version}]"
}
except Exception as e:
print(f"Error ensuring beatmap {beatmap_id}: {e}")
return {
"success": False,
"error": str(e),
"beatmap_id": beatmap_id
}
# ===== API ENDPOINTS =====
@router.post("/multiplayer/rooms")
async def create_multiplayer_room(
request: Request,
room_data: Dict[str, Any],
db: Database,
timestamp: str = "",
) -> int:
"""Create a new multiplayer room with initial playlist."""
#try:
# Verify request signature
body = await request.body()
if not verify_request_signature(request, str(timestamp), body):
raise HTTPException(
status_code=status.HTTP_401_UNAUTHORIZED,
detail="Invalid request signature"
)
# Parse room data if string
if isinstance(room_data, str):
room_data = json.loads(room_data)
print(f"Creating room with data: {room_data}")
# Create room
room, host_user_id = await _create_room(db, room_data)
room_id = room.id
try:
# Add playlist items
await _add_playlist_items(db, room_id, room_data, host_user_id)
# Add host as participant
#await _add_host_as_participant(db, room_id, host_user_id)
await db.commit()
return room_id
except HTTPException:
# Clean up room if playlist creation fails
await db.delete(room)
await db.commit()
raise
""" except json.JSONDecodeError as e:
raise HTTPException(
status_code=status.HTTP_400_BAD_REQUEST,
detail=f"Invalid JSON: {str(e)}"
)
except HTTPException:
raise
except Exception as e:
raise HTTPException(
status_code=status.HTTP_500_INTERNAL_SERVER_ERROR,
detail=f"Failed to create room: {str(e)}"
) """
async def _update_room_participant_count(db: Database, room_id: int) -> int:
"""更新房间参与者数量并返回当前数量。"""
# 统计活跃参与者
active_participants_result = await db.execute(
select(RoomParticipatedUser.user_id).where(
RoomParticipatedUser.room_id == room_id,
col(RoomParticipatedUser.left_at).is_(None)
)
)
active_participants = active_participants_result.all()
count = len(active_participants)
# 更新房间参与者数量
await db.execute(
update(Room)
.where(col(Room.id) == room_id)
.values(participant_count=count)
)
return count
async def _end_room_if_empty(db: Database, room_id: int) -> bool:
"""如果房间为空,则标记房间结束。返回是否结束了房间。"""
# 检查房间是否还有活跃参与者
participant_count = await _update_room_participant_count(db, room_id)
if participant_count == 0:
# 房间为空,标记结束
now = utcnow()
await db.execute(
update(Room)
.where(col(Room.id) == room_id)
.values(
ends_at=now,
status=RoomStatus.IDLE, # 或者使用 RoomStatus.ENDED 如果有这个状态
participant_count=0
)
)
print(f"Room {room_id} ended automatically (no participants remaining)")
return True
return False
async def _transfer_ownership_or_end_room(db: Database, room_id: int, leaving_user_id: int) -> bool:
"""处理房主离开的逻辑:转让房主权限或结束房间。返回是否结束了房间。"""
# 查找其他活跃参与者来转让房主权限
remaining_result = await db.execute(
select(RoomParticipatedUser.user_id)
.where(
col(RoomParticipatedUser.room_id) == room_id,
col(RoomParticipatedUser.user_id) != leaving_user_id,
col(RoomParticipatedUser.left_at).is_(None)
)
.order_by(col(RoomParticipatedUser.joined_at)) # 按加入时间排序
)
remaining_participants = remaining_result.all()
if remaining_participants:
# 将房主权限转让给最早加入的用户
new_owner_id = remaining_participants[0][0] # 获取 user_id
await db.execute(
update(Room)
.where(col(Room.id) == room_id)
.values(host_id=new_owner_id)
)
print(f"Room {room_id} ownership transferred from {leaving_user_id} to {new_owner_id}")
return False # 房间继续存在
else:
# 没有其他参与者,结束房间
return await _end_room_if_empty(db, room_id)
@router.delete("/multiplayer/rooms/{room_id}/users/{user_id}")
async def remove_user_from_room(
request: Request,
room_id: int,
user_id: int,
db: Database,
timestamp: int = Query(..., description="Unix 时间戳(秒)", ge=0),
) -> Dict[str, Any]:
"""Remove a user from a multiplayer room."""
try:
# Verify request signature
body = await request.body()
now = utcnow()
if not verify_request_signature(request, str(timestamp), body):
raise HTTPException(
status_code=status.HTTP_401_UNAUTHORIZED,
detail="Invalid request signature"
)
# 检查房间是否存在
room_result = await db.execute(
select(Room.host_id, Room.status, Room.participant_count, Room.ends_at)
.where(col(Room.id) == room_id)
)
room_query = room_result.first()
if not room_query:
raise HTTPException(
status_code=status.HTTP_404_NOT_FOUND,
detail="Room not found"
)
room_owner_id, room_status, current_participant_count, ends_at = room_query
# 如果房间已经结束,直接返回
if ends_at is not None:
print(f"Room {room_id} is already ended")
return {"success": True, "room_ended": True}
# 检查用户是否在房间中
participant_result = await db.execute(
select(RoomParticipatedUser.id)
.where(
col(RoomParticipatedUser.room_id) == room_id,
col(RoomParticipatedUser.user_id) == user_id,
col(RoomParticipatedUser.left_at).is_(None)
)
)
participant_query = participant_result.first()
if not participant_query:
# 用户不在房间中,检查房间是否需要结束(幂等操作)
room_ended = await _end_room_if_empty(db, room_id)
await db.commit()
return {"success": True, "room_ended": room_ended}
# 标记用户离开房间
await db.execute(
update(RoomParticipatedUser)
.where(
col(RoomParticipatedUser.room_id) == room_id,
col(RoomParticipatedUser.user_id) == user_id,
col(RoomParticipatedUser.left_at).is_(None)
)
.values(left_at=now)
)
room_ended = False
# 检查是否是房主离开
if user_id == room_owner_id:
print(f"Host {user_id} is leaving room {room_id}")
room_ended = await _transfer_ownership_or_end_room(db, room_id, user_id)
else:
# 不是房主离开,只需检查房间是否为空
room_ended = await _end_room_if_empty(db, room_id)
await db.commit()
print(f"Successfully removed user {user_id} from room {room_id}, room_ended: {room_ended}")
return {"success": True, "room_ended": room_ended}
except HTTPException:
raise
except Exception as e:
await db.rollback()
print(f"Error removing user from room: {str(e)}")
raise HTTPException(
status_code=status.HTTP_500_INTERNAL_SERVER_ERROR,
detail=f"Failed to remove user from room: {str(e)}"
)
@router.put("/multiplayer/rooms/{room_id}/users/{user_id}")
async def add_user_to_room(
request: Request,
room_id: int,
user_id: int,
db: Database,
timestamp: str = "",
) -> Dict[str, Any]:
"""Add a user to a multiplayer room."""
print(f"Adding user {user_id} to room {room_id}")
# Get request body and parse user_data
body = await request.body()
user_data = None
if body:
try:
user_data = json.loads(body.decode('utf-8'))
print(f"Parsed user_data: {user_data}")
except json.JSONDecodeError:
print("Failed to parse user_data from request body")
user_data = None
# Verify request signature
if not verify_request_signature(request, timestamp, body):
raise HTTPException(
status_code=status.HTTP_401_UNAUTHORIZED,
detail="Invalid request signature"
)
# 检查房间是否已结束
room_result = await db.execute(
select(Room.id, Room.ends_at)
.where(col(Room.id) == room_id)
)
room_query = room_result.first()
if not room_query:
raise HTTPException(
status_code=status.HTTP_404_NOT_FOUND,
detail="Room not found"
)
if room_query[1] is not None: # ends_at is not None
print(f"User {user_id} attempted to join ended room {room_id}")
raise HTTPException(
status_code=status.HTTP_410_GONE,
detail="Room has ended and cannot accept new participants"
)
# Verify room exists and check password
provided_password = user_data.get("password") if user_data else None
print(f"Verifying room {room_id} with password: {provided_password}")
await _verify_room_password(db, room_id, provided_password)
# Add or update participant
await _add_or_update_participant(db, room_id, user_id)
# Update participant count
await _update_room_participant_count(db, room_id)
await db.commit()
print(f"Successfully added user {user_id} to room {room_id}")
return {"success": True}
@router.post("/beatmaps/ensure")
async def ensure_beatmap_present(
request: Request,
beatmap_data: BeatmapEnsureRequest,
db: Database,
redis: Redis = Depends(get_redis),
fetcher: Fetcher = Depends(get_fetcher),
timestamp: str = "",
) -> Dict[str, Any]:
"""
确保谱面在服务器中存在(包括元数据和原始文件缓存)。
这个接口用于 osu-server-spectator 确保谱面文件在服务器端可用,
避免在需要时才获取导致的延迟。
"""
try:
# Verify request signature
body = await request.body()
if not verify_request_signature(request, timestamp, body):
raise HTTPException(
status_code=status.HTTP_401_UNAUTHORIZED,
detail="Invalid request signature"
)
beatmap_id = beatmap_data.beatmap_id
print(f"Ensuring beatmap {beatmap_id} is present")
# 确保谱面存在
result = await _ensure_beatmap_exists(db, fetcher, redis, beatmap_id)
# 提交数据库更改
await db.commit()
print(f"Ensure beatmap {beatmap_id} result: {result}")
return result
except HTTPException:
raise
except Exception as e:
await db.rollback()
print(f"Error ensuring beatmap: {str(e)}")
raise HTTPException(
status_code=status.HTTP_500_INTERNAL_SERVER_ERROR,
detail=f"Failed to ensure beatmap: {str(e)}"
)