2024-01-09 18:41:32 +01:00
|
|
|
from typing import Dict, List, Tuple, Any
|
|
|
|
import json
|
2023-02-16 06:06:42 +01:00
|
|
|
import logging, coloredlogs
|
|
|
|
from logging.handlers import TimedRotatingFileHandler
|
2024-01-09 09:07:04 +01:00
|
|
|
from starlette.requests import Request
|
|
|
|
from starlette.responses import Response
|
|
|
|
from starlette.routing import Route
|
2023-02-16 06:06:42 +01:00
|
|
|
|
|
|
|
from core.config import CoreConfig
|
|
|
|
from core.data import Data
|
2023-02-16 23:13:41 +01:00
|
|
|
from core.utils import Utils
|
2023-02-16 06:06:42 +01:00
|
|
|
|
2024-01-09 18:41:32 +01:00
|
|
|
class JSONResponseNoASCII(Response):
|
|
|
|
media_type = "application/json"
|
|
|
|
|
|
|
|
def render(self, content: Any) -> bytes:
|
|
|
|
return json.dumps(
|
|
|
|
content,
|
|
|
|
ensure_ascii=False,
|
|
|
|
).encode("utf-8")
|
|
|
|
|
2023-11-09 03:17:48 +01:00
|
|
|
class BaseServlet:
|
|
|
|
def __init__(self, core_cfg: CoreConfig, cfg_dir: str) -> None:
|
|
|
|
self.core_cfg = core_cfg
|
|
|
|
self.game_cfg = None
|
|
|
|
self.logger = logging.getLogger("title")
|
|
|
|
|
|
|
|
@classmethod
|
|
|
|
def is_game_enabled(cls, game_code: str, core_cfg: CoreConfig, cfg_dir: str) -> bool:
|
|
|
|
"""Called during boot to check if a specific game code should load.
|
|
|
|
|
|
|
|
Args:
|
|
|
|
game_code (str): 4 character game code
|
|
|
|
core_cfg (CoreConfig): CoreConfig class
|
|
|
|
cfg_dir (str): Config directory
|
|
|
|
|
|
|
|
Returns:
|
|
|
|
bool: True if the game is enabled and set to run, False otherwise
|
|
|
|
|
|
|
|
"""
|
|
|
|
return False
|
|
|
|
|
2024-01-09 09:07:04 +01:00
|
|
|
def get_routes(self) -> List[Route]:
|
2023-11-09 03:17:48 +01:00
|
|
|
"""Called during boot to get all matcher endpoints this title servlet handles
|
|
|
|
|
|
|
|
Returns:
|
2024-01-09 09:07:04 +01:00
|
|
|
List[Route]: A list of Routes, WebSocketRoutes, or similar classes
|
2023-11-09 03:17:48 +01:00
|
|
|
"""
|
2024-01-09 09:07:04 +01:00
|
|
|
return [
|
|
|
|
Route("/{game}/{version}/{endpoint}", self.render_POST, methods=["POST"]),
|
|
|
|
Route("/{game}/{version}/{endpoint}", self.render_GET, methods=["GET"]),
|
|
|
|
]
|
2023-11-09 03:17:48 +01:00
|
|
|
|
|
|
|
def setup(self) -> None:
|
|
|
|
"""Called once during boot, should contain any additional setup the handler must do, such as starting any sub-services
|
|
|
|
"""
|
|
|
|
pass
|
|
|
|
|
|
|
|
def get_allnet_info(self, game_code: str, game_ver: int, keychip: str) -> Tuple[str, str]:
|
|
|
|
"""Called any time a request to PowerOn is made to retrieve the url/host strings to be sent back to the game
|
|
|
|
|
|
|
|
Args:
|
|
|
|
game_code (str): 4 character game code
|
|
|
|
game_ver (int): version, expressed as an integer by multiplying by 100 (1.10 -> 110)
|
|
|
|
keychip (str): Keychip serial of the requesting machine, can be used to deliver specific URIs to different machines
|
|
|
|
|
|
|
|
Returns:
|
|
|
|
Tuple[str, str]: A tuple where offset 0 is the allnet uri field, and offset 1 is the allnet host field
|
|
|
|
"""
|
|
|
|
if not self.core_cfg.server.is_using_proxy and Utils.get_title_port(self.core_cfg) != 80:
|
2024-01-09 09:07:04 +01:00
|
|
|
return (f"http://{self.core_cfg.server.hostname}:{Utils.get_title_port(self.core_cfg)}/{game_code}/{game_ver}/", "")
|
2023-11-09 03:17:48 +01:00
|
|
|
|
2024-01-09 09:07:04 +01:00
|
|
|
return (f"http://{self.core_cfg.server.hostname}/{game_code}/{game_ver}/", "")
|
2023-11-09 03:17:48 +01:00
|
|
|
|
2024-01-09 09:07:04 +01:00
|
|
|
def get_mucha_info(self, core_cfg: CoreConfig, cfg_dir: str) -> Tuple[bool, List[str], List[str]]:
|
2023-11-09 03:17:48 +01:00
|
|
|
"""Called once during boot to check if this game is a mucha game
|
|
|
|
|
|
|
|
Args:
|
|
|
|
core_cfg (CoreConfig): CoreConfig class
|
|
|
|
cfg_dir (str): Config directory
|
|
|
|
|
|
|
|
Returns:
|
2024-05-20 03:40:02 +02:00
|
|
|
Tuple[bool, List[str], List[str]]: Tuple where offset 0 is true if the game is enabled, false otherwise, and offset 1 is the game CDs handled
|
|
|
|
by this servlette, and offset 2 is mucha netID prefixes that should be used for each game CD.
|
2023-11-09 03:17:48 +01:00
|
|
|
"""
|
2024-01-09 09:07:04 +01:00
|
|
|
return (False, [], [])
|
2023-11-09 03:17:48 +01:00
|
|
|
|
2024-01-09 09:07:04 +01:00
|
|
|
async def render_POST(self, request: Request) -> bytes:
|
|
|
|
self.logger.warn(f"Game Does not dispatch POST")
|
|
|
|
return Response()
|
2023-11-09 03:17:48 +01:00
|
|
|
|
2024-01-09 09:07:04 +01:00
|
|
|
async def render_GET(self, request: Request) -> bytes:
|
|
|
|
self.logger.warn(f"Game Does not dispatch GET")
|
|
|
|
return Response()
|
2023-03-09 17:38:58 +01:00
|
|
|
|
|
|
|
class TitleServlet:
|
2023-11-09 03:17:48 +01:00
|
|
|
title_registry: Dict[str, BaseServlet] = {}
|
2023-03-09 17:38:58 +01:00
|
|
|
def __init__(self, core_cfg: CoreConfig, cfg_folder: str):
|
2023-02-16 06:06:42 +01:00
|
|
|
super().__init__()
|
|
|
|
self.config = core_cfg
|
|
|
|
self.config_folder = cfg_folder
|
2023-02-16 23:13:41 +01:00
|
|
|
self.data = Data(core_cfg)
|
|
|
|
|
|
|
|
self.logger = logging.getLogger("title")
|
|
|
|
if not hasattr(self.logger, "initialized"):
|
|
|
|
log_fmt_str = "[%(asctime)s] Title | %(levelname)s | %(message)s"
|
2023-03-09 17:38:58 +01:00
|
|
|
log_fmt = logging.Formatter(log_fmt_str)
|
2023-02-16 23:13:41 +01:00
|
|
|
|
2023-03-09 17:38:58 +01:00
|
|
|
fileHandler = TimedRotatingFileHandler(
|
|
|
|
"{0}/{1}.log".format(self.config.server.log_dir, "title"),
|
|
|
|
when="d",
|
|
|
|
backupCount=10,
|
|
|
|
)
|
2023-02-16 23:13:41 +01:00
|
|
|
fileHandler.setFormatter(log_fmt)
|
2023-03-09 17:38:58 +01:00
|
|
|
|
2023-02-16 23:13:41 +01:00
|
|
|
consoleHandler = logging.StreamHandler()
|
|
|
|
consoleHandler.setFormatter(log_fmt)
|
|
|
|
|
|
|
|
self.logger.addHandler(fileHandler)
|
|
|
|
self.logger.addHandler(consoleHandler)
|
2023-03-09 17:38:58 +01:00
|
|
|
|
2023-02-16 23:13:41 +01:00
|
|
|
self.logger.setLevel(core_cfg.title.loglevel)
|
2023-03-09 17:38:58 +01:00
|
|
|
coloredlogs.install(
|
|
|
|
level=core_cfg.title.loglevel, logger=self.logger, fmt=log_fmt_str
|
|
|
|
)
|
2023-02-16 23:13:41 +01:00
|
|
|
self.logger.initialized = True
|
2023-03-09 17:38:58 +01:00
|
|
|
|
2023-02-18 06:00:30 +01:00
|
|
|
plugins = Utils.get_all_titles()
|
2023-03-09 17:38:58 +01:00
|
|
|
|
2023-02-18 06:00:30 +01:00
|
|
|
for folder, mod in plugins.items():
|
2023-11-09 03:17:48 +01:00
|
|
|
if hasattr(mod, "game_codes") and hasattr(mod, "index") and hasattr(mod.index, "is_game_enabled"):
|
2023-03-05 03:27:52 +01:00
|
|
|
should_call_setup = True
|
2023-11-09 03:17:48 +01:00
|
|
|
game_servlet: BaseServlet = mod.index
|
|
|
|
game_codes: List[str] = mod.game_codes
|
|
|
|
|
|
|
|
for code in game_codes:
|
|
|
|
if game_servlet.is_game_enabled(code, self.config, self.config_folder):
|
|
|
|
handler_cls = game_servlet(self.config, self.config_folder)
|
2023-03-09 17:38:58 +01:00
|
|
|
|
2023-11-09 03:17:48 +01:00
|
|
|
if hasattr(handler_cls, "setup") and should_call_setup:
|
|
|
|
handler_cls.setup()
|
|
|
|
should_call_setup = False
|
2023-03-09 17:38:58 +01:00
|
|
|
|
2023-11-09 03:17:48 +01:00
|
|
|
self.title_registry[code] = handler_cls
|
2023-03-09 17:38:58 +01:00
|
|
|
|
2023-02-17 07:02:21 +01:00
|
|
|
else:
|
2023-11-09 03:17:48 +01:00
|
|
|
self.logger.error(f"{folder} missing game_code or index in __init__.py, or is_game_enabled in index")
|
2023-03-05 03:27:52 +01:00
|
|
|
|
2023-03-09 17:38:58 +01:00
|
|
|
self.logger.info(
|
2024-01-09 09:07:04 +01:00
|
|
|
f"Serving {len(self.title_registry)} game codes {'on port ' + str(core_cfg.server.port) if core_cfg.server.port > 0 else ''}"
|
2023-03-09 17:38:58 +01:00
|
|
|
)
|
2023-02-17 07:02:21 +01:00
|
|
|
|
|
|
|
def render_GET(self, request: Request, endpoints: dict) -> bytes:
|
2023-11-09 03:17:48 +01:00
|
|
|
code = endpoints["title"]
|
|
|
|
subaction = endpoints['subaction']
|
|
|
|
|
2023-02-17 07:37:59 +01:00
|
|
|
if code not in self.title_registry:
|
2023-08-08 16:17:56 +02:00
|
|
|
self.logger.warning(f"Unknown game code {code}")
|
2023-03-02 06:14:13 +01:00
|
|
|
request.setResponseCode(404)
|
|
|
|
return b""
|
2023-03-09 17:38:58 +01:00
|
|
|
|
2023-02-17 07:37:59 +01:00
|
|
|
index = self.title_registry[code]
|
2023-11-09 03:17:48 +01:00
|
|
|
handler = getattr(index, f"{subaction}", None)
|
|
|
|
if handler is None:
|
|
|
|
self.logger.error(f"{code} does not have handler for GET subaction {subaction}")
|
|
|
|
request.setResponseCode(500)
|
2023-02-17 07:37:59 +01:00
|
|
|
return b""
|
|
|
|
|
2023-11-09 03:17:48 +01:00
|
|
|
return handler(request, code, endpoints)
|
2023-03-09 17:38:58 +01:00
|
|
|
|
2023-02-17 07:02:21 +01:00
|
|
|
def render_POST(self, request: Request, endpoints: dict) -> bytes:
|
2023-11-09 03:17:48 +01:00
|
|
|
code = endpoints["title"]
|
|
|
|
subaction = endpoints['subaction']
|
|
|
|
|
2023-02-17 07:02:21 +01:00
|
|
|
if code not in self.title_registry:
|
2023-08-08 16:17:56 +02:00
|
|
|
self.logger.warning(f"Unknown game code {code}")
|
2023-03-02 06:14:13 +01:00
|
|
|
request.setResponseCode(404)
|
|
|
|
return b""
|
2023-03-09 17:38:58 +01:00
|
|
|
|
2023-02-17 07:02:21 +01:00
|
|
|
index = self.title_registry[code]
|
2023-11-09 03:17:48 +01:00
|
|
|
handler = getattr(index, f"{subaction}", None)
|
|
|
|
if handler is None:
|
|
|
|
self.logger.error(f"{code} does not have handler for POST subaction {subaction}")
|
|
|
|
request.setResponseCode(500)
|
2023-02-17 07:37:59 +01:00
|
|
|
return b""
|
2023-02-17 07:02:21 +01:00
|
|
|
|
2023-11-09 03:17:48 +01:00
|
|
|
endpoints.pop("title")
|
|
|
|
endpoints.pop("subaction")
|
|
|
|
return handler(request, code, endpoints)
|