mirror of
https://github.com/rommapp/romm.git
synced 2026-02-19 07:50:57 +01:00
166 lines
4.3 KiB
Python
166 lines
4.3 KiB
Python
from typing import Annotated, Any, Final, NotRequired, TypedDict
|
|
|
|
from pydantic import BaseModel, BeforeValidator, Field, field_validator
|
|
|
|
from handler.metadata.base_handler import UniversalPlatformSlug as UPS
|
|
from tasks.scheduled.update_switch_titledb import TITLEDB_REGION_LIST
|
|
from utils.database import safe_int
|
|
|
|
WEBRCADE_SUPPORTED_PLATFORM_SLUGS = frozenset(
|
|
(
|
|
UPS._3DO,
|
|
UPS.ARCADE,
|
|
UPS.ATARI2600,
|
|
UPS.ATARI5200,
|
|
UPS.ATARI7800,
|
|
UPS.C64,
|
|
UPS.COLECOVISION,
|
|
UPS.DOS,
|
|
UPS.GAMEGEAR,
|
|
UPS.GB,
|
|
UPS.GBA,
|
|
UPS.GBC,
|
|
UPS.GENESIS,
|
|
UPS.LYNX,
|
|
UPS.N64,
|
|
UPS.NEO_GEO_CD,
|
|
UPS.NEO_GEO_POCKET,
|
|
UPS.NEO_GEO_POCKET_COLOR,
|
|
UPS.NEOGEOAES,
|
|
UPS.NEOGEOMVS,
|
|
UPS.NES,
|
|
UPS.PC_FX,
|
|
UPS.PSX,
|
|
UPS.SEGACD,
|
|
UPS.SG1000,
|
|
UPS.SMS,
|
|
UPS.SNES,
|
|
UPS.SUPERGRAFX,
|
|
UPS.TURBOGRAFX_CD,
|
|
UPS.TG16,
|
|
UPS.VIRTUALBOY,
|
|
UPS.WONDERSWAN,
|
|
UPS.WONDERSWAN_COLOR,
|
|
)
|
|
)
|
|
|
|
WEBRCADE_SLUG_TO_TYPE_MAP = {
|
|
UPS.ATARI2600: "2600",
|
|
UPS.ATARI5200: "5200",
|
|
UPS.ATARI7800: "7800",
|
|
UPS.C64: "commodore-c64",
|
|
UPS.LYNX: "lnx",
|
|
UPS.TG16: "pce",
|
|
UPS.TURBOGRAFX_CD: "pce",
|
|
UPS.SUPERGRAFX: "sgx",
|
|
UPS.PC_FX: "pcfx",
|
|
UPS.VIRTUALBOY: "vb",
|
|
UPS.GAMEGEAR: "gg",
|
|
UPS.NEOGEOAES: "neogeo",
|
|
UPS.NEOGEOMVS: "neogeo",
|
|
UPS.NEO_GEO_CD: "neogeocd",
|
|
UPS.NEO_GEO_POCKET: "ngp",
|
|
UPS.NEO_GEO_POCKET_COLOR: "ngc",
|
|
}
|
|
|
|
|
|
# Webrcade feed format
|
|
# Source: https://docs.webrcade.com/feeds/format/
|
|
class WebrcadeFeedItemPropsSchema(TypedDict):
|
|
rom: str
|
|
|
|
|
|
class WebrcadeFeedItemSchema(TypedDict):
|
|
title: str
|
|
longTitle: NotRequired[str]
|
|
description: NotRequired[str]
|
|
type: str
|
|
thumbnail: NotRequired[str]
|
|
background: NotRequired[str]
|
|
props: WebrcadeFeedItemPropsSchema
|
|
|
|
|
|
class WebrcadeFeedCategorySchema(TypedDict):
|
|
title: str
|
|
longTitle: NotRequired[str]
|
|
background: NotRequired[str]
|
|
thumbnail: NotRequired[str]
|
|
description: NotRequired[str]
|
|
items: list[WebrcadeFeedItemSchema]
|
|
|
|
|
|
class WebrcadeFeedSchema(TypedDict):
|
|
title: str
|
|
longTitle: NotRequired[str]
|
|
description: NotRequired[str]
|
|
thumbnail: NotRequired[str]
|
|
background: NotRequired[str]
|
|
categories: list[WebrcadeFeedCategorySchema]
|
|
|
|
|
|
# Tinfoil feed format
|
|
# Source: https://blawar.github.io/tinfoil/custom_index/
|
|
|
|
UNIX_EPOCH_START_DATE: Final = 19700101
|
|
|
|
|
|
def coerce_to_string(value: Any) -> str:
|
|
"""Coerce value to string, returning empty string for None."""
|
|
return "" if value is None else str(value)
|
|
|
|
|
|
def coerce_to_int(value: Any) -> int:
|
|
"""Coerce value to int, returning 0 for None/empty values."""
|
|
return safe_int(value, default=0)
|
|
|
|
|
|
# Annotated types for cleaner field definitions
|
|
StringField = Annotated[str, BeforeValidator(coerce_to_string)]
|
|
IntField = Annotated[int, BeforeValidator(coerce_to_int)]
|
|
|
|
|
|
class TinfoilFeedFileSchema(TypedDict):
|
|
url: str
|
|
size: int
|
|
|
|
|
|
class TinfoilFeedTitleDBSchema(BaseModel):
|
|
"""Schema for Tinfoil feed title database entries.
|
|
|
|
This schema handles the conversion and validation of game metadata
|
|
for the Tinfoil custom index format.
|
|
"""
|
|
|
|
id: StringField = Field(default="")
|
|
name: StringField = Field(default="")
|
|
description: StringField = Field(default="")
|
|
region: StringField = Field(default="US")
|
|
publisher: StringField = Field(default="")
|
|
size: IntField = Field(default=0, ge=0)
|
|
version: IntField = Field(default=0, ge=0)
|
|
releaseDate: IntField = Field(
|
|
default=UNIX_EPOCH_START_DATE, ge=UNIX_EPOCH_START_DATE
|
|
)
|
|
rating: IntField = Field(default=0, ge=0, le=100)
|
|
rank: IntField = Field(default=0, ge=0)
|
|
|
|
@field_validator("region")
|
|
def validate_region(cls, v: str) -> str:
|
|
if v not in TITLEDB_REGION_LIST:
|
|
return "US"
|
|
return v
|
|
|
|
@field_validator("releaseDate")
|
|
def validate_release_date(cls, v: int) -> int:
|
|
if v < UNIX_EPOCH_START_DATE:
|
|
return UNIX_EPOCH_START_DATE
|
|
return v
|
|
|
|
|
|
class TinfoilFeedSchema(TypedDict):
|
|
files: list[TinfoilFeedFileSchema]
|
|
directories: list[str]
|
|
titledb: NotRequired[dict[str, dict]] # dict after .model_dump()
|
|
success: NotRequired[str]
|
|
error: NotRequired[str]
|