jens/docker-dosbox-novnc
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

Drive games from per-game JSON manifests instead of raw zip scanning

Browse Source 
Games are no longer discovered from *.zip files on the SMB share; each
game now has its own <name>.json manifest (name/title/zip/start_cmd)
living next to its zip, discovered dynamically via smbclient. Nothing
about a game's identity or how to install/start it is hardcoded in the
image anymore. The setup page also grew Start/Stop/Uninstall buttons,
backed by real process tracking (Popen + terminate/kill).

Piloted on stuntcar only (manifest already uploaded to the share); t7g
has no manifest yet so it won't appear until one's added. The old
game.sh/start_game.sh docker-exec launch path is left as-is for now and
overlaps with the new Start button - noted in TODO.md for later cleanup.

Co-Authored-By: Claude Sonnet 5 <noreply@anthropic.com>
Claude-Session: https://claude.ai/code/session_01NiNnj78HGx1KWyCCo39HSz
This commit is contained in:
jens
2026-07-28 10:27:33 +02:00
co-authored by Claude Sonnet 5
parent 973a12ae65
commit 827f03f087
3 changed files with 171 additions and 60 deletions
Download Patch File Download Diff File Expand all files Collapse all files
scripts/setup_server.py
+146 -54
View File
@@ -1,9 +1,25 @@
#!/usr/bin/env python3
"""HTML setup routine: lets the user browse games available on the SMB
share and install them into GAMES_HOME on demand, instead of the image
auto-downloading everything at container startup."""
"""HTML setup routine for DOSBox games.
Nothing about which games exist is hardcoded here: available games are
discovered by listing *.json manifests on the SMB share, one per game,
each describing how to install/uninstall/start/stop that game. Drop a new
<name>.json (and matching zip) on the share and it shows up here with no
image changes needed.
Manifest schema (all fields required):
{
"name": "stuntcar", # must match the manifest's own filename
"title": "Stuntcar Racer",
"zip": "stuntcar.zip", # filename under SMB_DIR to fetch on install
"start_cmd": ["dosbox", "run.bat", "-conf", "dosbox-0.74-3.conf"]
}
Uninstall is implicit (remove GAMES_HOME/<name>); stop is implicit (terminate
the process tracked from the last start_cmd).
"""
import html
import json
import os
import re
import subprocess
@@ -17,33 +33,60 @@ SMB_DIR = r"Games\dosbox"
GAMES_HOME = os.environ["GAMES_HOME"]
SETUP_PORT = int(os.environ.get("SETUP_PORT", "8080"))
state_lock = threading.Lock()
install_state = {} # name -> "downloading" | "extracting" | "done" | "error: ..."
state_lock = threading.RLock()
install_state = {} # name -> "downloading" | "extracting" | "done" | "error: ..."
running_procs = {} # name -> subprocess.Popen
def list_remote_games():
def smb_run(*commands):
result = subprocess.run(
["smbclient", "-N", f"//{SMB_SERVER}/{SMB_SHARE}", "-c", f"ls {SMB_DIR}\\*.zip"],
["smbclient", "-N", f"//{SMB_SERVER}/{SMB_SHARE}", "-c", ";".join(commands)],
capture_output=True, text=True, timeout=15,
)
games = []
for line in result.stdout.splitlines():
m = re.match(r"\s*(\S+)\.zip\s+A\s+(\d+)", line)
if m:
games.append((m.group(1), int(m.group(2))))
return sorted(games)
return result.stdout
def list_installed_games():
if not os.path.isdir(GAMES_HOME):
return set()
return {
name for name in os.listdir(GAMES_HOME)
if os.path.isdir(os.path.join(GAMES_HOME, name)) and os.listdir(os.path.join(GAMES_HOME, name))
}
def discover_games():
"""Returns {name: manifest} for every *.json manifest found on the share."""
listing = smb_run(f"ls {SMB_DIR}\\*.json")
names = [m.group(1) for m in re.finditer(r"\s*(\S+)\.json\s+A\s+\d+", listing)]
if not names:
return {}
tmpdir = "/tmp/manifests"
os.makedirs(tmpdir, exist_ok=True)
gets = [f"get {SMB_DIR}\\{name}.json {tmpdir}/{name}.json" for name in names]
smb_run(*gets)
games = {}
for name in names:
try:
with open(f"{tmpdir}/{name}.json") as f:
manifest = json.load(f)
if manifest.get("name") == name:
games[name] = manifest
except (OSError, json.JSONDecodeError):
continue
return games
def install_game(name):
def is_installed(name):
path = os.path.join(GAMES_HOME, name)
return os.path.isdir(path) and os.listdir(path)
def is_running(name):
with state_lock:
proc = running_procs.get(name)
if proc is None:
return False
if proc.poll() is None:
return True
del running_procs[name]
return False
def install_game(name, manifest):
with state_lock:
if install_state.get(name) in ("downloading", "extracting"):
return
@@ -52,11 +95,12 @@ def install_game(name):
tmpdir = f"/tmp/setup-{name}"
try:
os.makedirs(tmpdir, exist_ok=True)
zip_path = os.path.join(tmpdir, f"{name}.zip")
zip_name = manifest["zip"]
zip_path = os.path.join(tmpdir, zip_name)
# smbget's -a (guest) can't be combined with -o (output file), so let it save
# under the default name in tmpdir instead, same as the original build-time fetch.
# under its default name in tmpdir instead.
subprocess.run(
["smbget", "-au", f"smb://{SMB_SERVER}/{SMB_SHARE}/Games/dosbox/{name}.zip"],
["smbget", "-au", f"smb://{SMB_SERVER}/{SMB_SHARE}/Games/dosbox/{zip_name}"],
check=True, timeout=1800, cwd=tmpdir,
)
with state_lock:
@@ -72,37 +116,73 @@ def install_game(name):
subprocess.run(["rm", "-rf", tmpdir], check=False)
def uninstall_game(name):
with state_lock:
if is_running(name):
return
subprocess.run(["rm", "-rf", os.path.join(GAMES_HOME, name)], check=False)
install_state.pop(name, None)
def start_game(name, manifest):
with state_lock:
if is_running(name):
return
proc = subprocess.Popen(manifest["start_cmd"], cwd=os.path.join(GAMES_HOME, name))
running_procs[name] = proc
def stop_game(name):
with state_lock:
proc = running_procs.get(name)
if proc is None:
return
proc.terminate()
try:
proc.wait(timeout=5)
except subprocess.TimeoutExpired:
proc.kill()
proc.wait()
with state_lock:
running_procs.pop(name, None)
def render_page():
remote = list_remote_games()
installed = list_installed_games()
games = discover_games()
with state_lock:
pending = dict(install_state)
any_pending = any(v in ("downloading", "extracting") for v in pending.values())
refresh_tag = '<meta http-equiv="refresh" content="3">' if any_pending else ""
rows = []
for name, size in remote:
status = pending.get(name)
if name in installed and status not in ("downloading", "extracting"):
action = '<span class="status ok">Installed</span>'
elif status in ("downloading", "extracting"):
action = f'<span class="status busy">{status}...</span>'
elif status and status.startswith("error"):
action = (
f'<span class="status err">{html.escape(status)}</span>'
f'<form method="post" action="/install"><input type="hidden" name="name" value="{html.escape(name)}">'
f'<button type="submit">Retry</button></form>'
)
else:
action = (
f'<form method="post" action="/install"><input type="hidden" name="name" value="{html.escape(name)}">'
f'<button type="submit">Install</button></form>'
)
rows.append(
f"<tr><td>{html.escape(name)}</td><td>{size / 1_000_000:.1f} MB</td><td>{action}</td></tr>"
def button(action, name, label):
return (
f'<form method="post" action="/{action}">'
f'<input type="hidden" name="name" value="{html.escape(name)}">'
f'<button type="submit">{label}</button></form>'
)
rows = []
for name, manifest in sorted(games.items()):
title = html.escape(manifest.get("title", name))
status = pending.get(name)
if is_running(name):
status_html = '<span class="status busy">Running</span>'
actions = button("stop", name, "Stop")
elif status in ("downloading", "extracting"):
status_html = f'<span class="status busy">{status}...</span>'
actions = ""
elif status and status.startswith("error"):
status_html = f'<span class="status err">{html.escape(status)}</span>'
actions = button("install", name, "Retry")
elif is_installed(name):
status_html = '<span class="status ok">Installed</span>'
actions = button("start", name, "Start") + button("uninstall", name, "Uninstall")
else:
status_html = "Not installed"
actions = button("install", name, "Install")
rows.append(f"<tr><td>{title}</td><td>{status_html}</td><td>{actions}</td></tr>")
return f"""<!doctype html>
<html>
<head>
@@ -112,8 +192,8 @@ def render_page():
body {{ font-family: sans-serif; margin: 2em; }}
table {{ border-collapse: collapse; width: 100%; max-width: 640px; }}
th, td {{ text-align: left; padding: 0.5em 1em; border-bottom: 1px solid #ccc; }}
form {{ margin: 0; }}
button {{ padding: 0.3em 0.8em; }}
form {{ margin: 0; display: inline; }}
button {{ padding: 0.3em 0.8em; margin-right: 0.3em; }}
.status.ok {{ color: #2a2; font-weight: bold; }}
.status.busy {{ color: #a70; font-weight: bold; }}
.status.err {{ color: #c22; }}
@@ -122,8 +202,8 @@ button {{ padding: 0.3em 0.8em; }}
<body>
<h1>DOSBox games</h1>
<table>
<tr><th>Game</th><th>Size</th><th>Status / Action</th></tr>
{''.join(rows) if rows else '<tr><td colspan="3">No games found on the share</td></tr>'}
<tr><th>Game</th><th>Status</th><th>Actions</th></tr>
{''.join(rows) if rows else '<tr><td colspan="3">No game manifests found on the share</td></tr>'}
</table>
</body>
</html>"""
@@ -148,15 +228,27 @@ class Handler(BaseHTTPRequestHandler):
self._send_html("Not found", status=404)
def do_POST(self):
if urlparse(self.path).path != "/install":
action = urlparse(self.path).path.lstrip("/")
if action not in ("install", "uninstall", "start", "stop"):
self._send_html("Not found", status=404)
return
length = int(self.headers.get("Content-Length", 0))
body = self.rfile.read(length).decode("utf-8")
name = parse_qs(body).get("name", [""])[0]
valid_names = {n for n, _ in list_remote_games()}
if name in valid_names:
threading.Thread(target=install_game, args=(name,), daemon=True).start()
games = discover_games()
if name in games:
manifest = games[name]
if action == "install":
threading.Thread(target=install_game, args=(name, manifest), daemon=True).start()
elif action == "uninstall":
threading.Thread(target=uninstall_game, args=(name,), daemon=True).start()
elif action == "start":
threading.Thread(target=start_game, args=(name, manifest), daemon=True).start()
elif action == "stop":
threading.Thread(target=stop_game, args=(name,), daemon=True).start()
self.send_response(303)
self.send_header("Location", "/")
self.end_headers()