Compare commits

..
Author SHA1 Message Date
ДмитрийandClaude Opus 5.5 1f64da3ae0 Prepare Manager 0.9.14 with reviewed notes in six languages
Version 0.9.14; reviewed Manager (12) and server (6) records with translations in all
five languages; server components from the lock of build run 43758471036; bundled server
history through 0.261115.110 from build main 45c013be9.

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
2026-11-16 14:00:33 +05:00
ДмитрийandClaude Opus 5.5 1aec8e5394 Release note title the collector keeps (no technical word)
Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
2026-11-16 02:18:18 +05:00
Дмитрий 326a4fe3d3 Merge feat/companions-realms: companion bots on Wildcard and Warcraft Reborn
Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>

# Conflicts:
#	crates/coa-core/src/ra.rs
2026-11-16 00:52:15 +05:00
ДмитрийandClaude Opus 5.5 f9839ba369 Custom races off: count the characters kept out, delete their companion bots
A client without the races patch crashes on a unit of race 12+, so the server now keeps
those characters out while custom races are off. The Custom Races card shows how many
player characters and bots that are (active realm, read only while the database runs) and
offers botcmd purgecustomraces for the companion bots.

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
2026-11-16 00:36:18 +05:00
ДмитрийandClaude Opus 5.5 e951eb134b Companions open on Wildcard and Reborn when the server build plays them
The module list blocked Companions on every realm but Conquest of Azeroth, so the
multi-realm bot work could not be switched on. It is allowed (as experimental) when the
world server or its bots plugin carries the standard-class bot profiles of the multi-realm
bots build; SQUID and Dungeon Clear stay CoA-only.

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
2026-11-16 00:27:54 +05:00
ДмитрийandClaude Opus 5.5 6cbf007d72 Companions on Wildcard/Reborn: pending bot jobs survive crashes, validated spawn requests
The uncommitted RC hardening of the multirealm Manager branch: a per-realm pending job
state machine reconciled against the database (no duplicate bots after a crash or an RA
timeout), cancelled by Stop spawning / Delete all bots, legacy file migrated; spawn
requests and build ids validated; tests JOB-01..JOB-14.

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
2026-11-16 00:20:50 +05:00
Дмитрий 07e9bc497d feat(manager): dynamic wildcard archetypes, realm-isolated pending jobs, and hardened bot deployment 2026-11-16 00:17:08 +05:00
Дмитрий e4edb7cbdd feat(manager): multi-realm character database routing, RA dispatch & extended bot manager UI 2026-11-16 00:16:51 +05:00
Дмитрий ca2514c790 feat(manager): expand multi-realm bot fleet controls, DB routing, and compatibility guards 2026-11-16 00:16:15 +05:00
Дмитрий 69c9938aba feat(manager): enable multi-realm playerbots support across CoA, Wildcard, and Reborn 2026-11-16 00:16:15 +05:00
ДмитрийandClaude Opus 5.5 2fd42f2acd Custom races hold their V2 parts; the addon list shows every addon
- Subclasses/Hero Races and the /dev menu are parts of Custom Races (catalog part_of,
  hidden from the grid): their switch and settings sit inside the Custom Races settings.
- The companion bots addon (CoABotUI) moves from the client facts into the addon list,
  with install/update from the server package; the /dev menu addon of the V2 patch is
  listed as installed by the patch, without its own buttons.

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
2026-11-16 00:07:54 +05:00
ДмитрийandClaude Opus 5.5 05630ec9eb Addon catalog in the game client card
addons/catalog.json pins SquidBots Lite, DragonUI (+Options), IncahootsCoA and CoACombat
to a commit and lists every file with its git blob SHA-1 and size. Install downloads
GitHub's archive of that commit, verifies each file (archives are not byte-stable, their
contents are), stages next to AddOns and moves the folders in; a foreign folder of the
same name goes to AddOns/.coa-addons-backup. .coa-addons.json records what the Manager
installed; update and remove touch only that. CoA_DevMenu ships with Custom Races V2, so
the separate dev menu addon is not in the catalog. Checked against the real GitHub
archives of the three small addons (ignored test).

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
2026-11-15 20:58:29 +05:00
ДмитрийandClaude Opus 5.5 d64fdb51be Client: clear the game cache on Play, remember the friend's server login
- clear_game_cache removes Cache/WDB/<locale>/*.wdb before every Play (own server and
  friend's), on by default, switch in the client card; nothing else in Cache or Data.
- The connection profile keeps the listed realm it was joined through; Play fills that
  realm's saved account into GlueConfig.json every time. A host typed by hand drops it.

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
2026-11-15 20:51:40 +05:00
ДмитрийandClaude Opus 5.5 260d10b729 Scheduled daily restart of the world (#202)
Settings/restart-schedule.json (Settings, Startup) holds a local time and a countdown.
The Rust world supervisor asks the world for 'server restart <seconds>' once that time has
passed (by at most 15 minutes, for a world that ran before it), and starts the world
again when it exits with RESTART_EXIT_CODE; the database and auth keep running. While it
is under way (.state/scheduled-restart) the status says so and the Manager does not take
the down world for a crash. Extra worlds follow their server's schedule. Repacks with the
Python supervisor do not run the schedule; the card says the server needs an update.

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
2026-11-15 20:26:14 +05:00
ДмитрийandClaude Opus 5.5 20657df203 MySQL options of the owner kept across starts (#103)
Settings, Service edits Settings/mysql-custom.ini. Every start adds its name = value lines
(outside a section or in [mysqld]) to the rendered my.ini, after the defaults so they
win; the port, addresses, data and log paths, sockets and !include stay managed. Nothing
changes for a server without the file.

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
2026-11-15 20:21:24 +05:00
ДмитрийandClaude Opus 5.5 f08ae1c76b Modules: switches for the Custom Races V2 subclasses and the /dev menu
mod-subclass (Subclass.Enable, the Thin Twins and Two-Headed Ogre races, two players per
character, levels) and mod-ilusixn-devmenu (DevMenu.Enable, who may use it) were shipped
with V2 but had no place in the Manager. They are catalog modules now, with translated
controls for their main settings; the rest stays under the advanced settings.

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
2026-11-15 20:17:04 +05:00
ДмитрийandClaude Opus 5.5 4fc133c35e Race restriction survives a catalog that only adds races
The worldserver ignores DisabledRaceIds saved against another ChrRaces catalog and with
it CoACustomRaces.Enable, so every server that had a restriction from 1.9.2 lost custom
races after the V2 update. Before a start the Manager binds the restriction to the new
catalog when every disabled race keeps its RaceID and name, judged by the server's own
snapshot (written by every save) or the table of every catalog a build has shipped
(race_catalogs.json, generated from the core history). Renamed races (1.9.1 reused 32/33)
and unknown catalogs still wait for the owner's review.

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
2026-11-15 20:14:59 +05:00
ДмитрийandClaude Opus 5.5 de38e60444 Merge fix/races-fast-toggle: custom races switch in seconds
Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
2026-11-15 20:10:50 +05:00
ДмитрийandClaude Opus 5.5 3c26004e04 Custom races: switch in seconds (append-only journal, entry points only, hash cache)
V2 has 7,220 files. Switching rewrote the whole transaction journal with fsync after
every file (quadratic: minutes on fast disks, far longer with antivirus) and renamed
every file. Now:
- the journal is append-only JSON lines; recovery replays it, ignores a torn last
  line and still reads the old journal.json of 0.9.13;
- only what the stock client loads is hidden (Data/*.MPQ, root dll/exe/bat, addons,
  any file that replaced the player's own); Data/Retail, VulkanShaders and the
  Esteria data stay in place, and a client disabled by 0.9.13 is recognised;
- payload hashes are remembered for the run, keyed by name, size and times.
Real V2 archives, release build: disable 1.9 s, enable 2.2 s, 224 of 7,220 files moved.

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
2026-11-15 20:10:43 +05:00
ДмитрийandClaude Opus 5.5 d1534ebc92 Realm names chosen in the Manager (#61, #209)
Settings, Startup lists every realm of the server with its name. The choice is kept in
Settings/realm-names.json of the main folder; the launcher, the realm-list setup and the
client's Config.wtf use it, and a running database gets it at once. Names are 1-32
characters without quotation marks or control characters, written as escaped SQL.

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
2026-11-15 20:08:48 +05:00
ДмитрийandClaude Opus 5.5 20d4c3351e Ports: name Windows reservations at once, move the database to a free port
A reserved or taken database port no longer fails the start after 30 seconds: the
launcher recognises Windows excluded ranges (netsh), moves MySQL to a free port and
records it in Settings/repack.json. Only the server's own services use that port.
The database connection of with_database is rebuilt after the start.

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
2026-11-15 19:59:20 +05:00
ДмитрийandClaude Opus 5.5 8a313b83b8 Cargo.lock: coa-launcher follows the workspace version
Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
2026-11-15 19:55:40 +05:00
ДмитрийandClaude Opus 5.5 7eea72c415 Merge feat/rust-launcher: the Manager starts and stops servers through the Rust launcher
Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
2026-11-15 19:54:21 +05:00
Corfirean e8ffa6efe3 Merge feat/custom-races-v2: Manager 0.9.13 with Custom Races V2 2026-11-15 08:14:40 +05:00
github-actions[bot] baeecd2ddf Update published Manager changelog 2026-11-15 02:08:39 +00:00
ДмитрийandClaude Opus 5.5 d352731280 Prepare Manager 0.9.13 with reviewed notes in six languages
Manager 0.9.13 carries the Custom Races V2 client. Its reviewed note and the 213 notes of the upcoming
server record (Custom Races V2: subclasses, Two-Players, the new races; collected with the pipeline's own
rules from the frozen sources of candidate run 43641984449) have Russian, German, French, Spanish and
Simplified Chinese translations. Bundled server history refreshed through 0.261114.106 from
coa-server-build 3308e3a.

Checks: release-history tests 5/5, check-i18n, npm run build, cargo check --locked.

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
2026-11-15 02:27:37 +05:00
ДмитрийandClaude Opus 5.5 a0545286ee Install the Custom Races V2 client
The client update now takes ilusixn/CustomRacesCoa coa-custom-2.0: nine client archives plus the server
archive's client addons (subclass interface, dev menu, teleports, spell activation overlay), 76 race
archives and 7220 verified files in all, among them CoACustomRace.exe and its Vulkan renderer.

- The game starts CoACustomRace.exe when it is there; Ascension.exe is left alone, and a disabled V2
  falls back to it.
- Updating from 1.9.2 retires its patched Ascension.exe and puts the player's own back (1.9.2 replaced
  it; V2 does not ship one). Earlier installs keep their own hash lists, 1.9.2's included.
- Four V2 archives are byte-identical to 1.9.2's: a verified 1.9.2 copy in the cache or in Downloads
  is used instead of downloading it again.

Verified: unit tests (800 passed); against the real archives, every bundled hash, a full install,
disable, enable and uninstall in a disposable client, and an update of a client that Manager 0.9.12
had put 1.9.2 on (its own Ascension.exe comes back, and again after uninstalling).

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
2026-11-15 01:59:43 +05:00
ДмитрийandClaude Opus 5.5 6f8ed793a7 Merge integrate/release-0.9.12 (release 2026-11-14)
Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
2026-11-14 09:56:41 +05:00
github-actions[bot] b3c88ce2a6 Update published Manager changelog 2026-11-14 04:41:00 +00:00
CorfireanandClaude Opus 5.5 d71c5635e3 Translate the auction house bot note of the upcoming server release
Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
2026-11-14 00:15:27 +05:00
CorfireanandClaude Opus 5.5 755761d0de Prepare Manager 0.9.12 with reviewed notes in six languages
Bundled server history refreshed through 0.261108.95 from coa-server-build ca04f96.

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
2026-11-14 00:05:14 +05:00
Corfirean 550e475962 Merge remote-tracking branch 'origin/feat/bot-scaling-settings' into integrate/release-0.9.12 2026-11-13 23:54:41 +05:00
ДмитрийandClaude Opus 5.5 2e6fcceb05 CI: drop the launcher bridge test (the bridge was removed)
tools/test_launcher_bridge.py tested crates/coa-core/src/launcher_bridge.py,
which the Rust launcher replaced; check.yml and release.yml still ran it, so
the release build failed.

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
2026-11-10 16:48:17 +05:00
ДмитрийandClaude Opus 5.5 abcc816581 Stop: ask the world again when a shutdown request is lost
A console shutdown request is sometimes lost, and the world then keeps
running until the stop times out. While the world still runs and its
console still answers after 15 s, the launcher asks again (twice at most);
asking twice is harmless. Verified on a disposable repack with the first
World::ShutdownServ call suppressed in a debugger: the second request
stopped the world.

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
2026-11-10 16:07:54 +05:00
ДмитрийandClaude Opus 5.5 8353b791fb The Manager no longer edits Scripts/manage.py
Repacks ship no .bat files, and the Manager starts servers with
coa-core::launcher, so the realm-profile patch it wrote into manage.py
served no one. It is no longer applied (realm creation, realm switching and
start).

Recognising the edits older Managers made (realm patch, bridge import fix)
moves into legacy_launcher, so updates and file checks still treat such a
file as unmodified. Nothing there writes a file.

manage.py itself stays complete in the repack: Managers up to 0.9.10 run it
through their bridge and patch its text, so it cannot become a thin wrapper
until those Managers are no longer supported.

Verified: coa-core unit tests; examples/manager_launcher_e2e on a disposable
repack (manage.py unchanged after a start with a realm profile).

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
2026-11-10 13:07:41 +05:00
ДмитрийandClaude Opus 5.5 b81227b0ea Bug-report relay in Rust (coa-launcher relay-worker)
launcher::relay does what BugReport/relay.py and manage.py relay-worker do,
with the same spool: the <key>.status files the world reads, the journal
relay.sqlite3 (deliveries, settings), relay.lock (byte 0) and the
relay-ready record. Service answers map to the same states and retry times;
a post interrupted mid-flight stays uncertain and is never resent.

When coa-launcher.exe supervises a world it runs the relay itself; the
Python supervisor still runs relay.py.

Verified:
- examples/relay_equivalence: the same reports and scripted service answers
  through relay.py and the Rust relay give identical statuses, journal rows
  (including retry times) and posts, and each continues the other's journal.
- examples/manager_launcher_e2e on a disposable repack: supervisor and relay
  are coa-launcher.exe, start/stop interoperates with manage.py.

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
2026-11-10 12:00:40 +05:00
ДмитрийandClaude Opus 5.5 a9fb982ab0 Console shutdown request reads the reply before closing
send_without_answer closed the socket right after writing "server shutdown".
With the reply still unread, Windows resets the connection, and the world
can drop the command: a world supervised by coa-launcher.exe ignored the
shutdown and the stop timed out after 90 seconds. The reply is now read up
to the next prompt, the end of the connection or 10 seconds.

The E2E also checks which supervisor runs the world and that manage.py
stops a world the Manager started.

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
2026-11-10 09:38:59 +05:00
ДмитрийandClaude Opus 5.5 a822bfc99b Manager starts and stops servers through the Rust launcher
driver::run now calls coa-core::launcher::ops::run in-process instead of
running Scripts/manage.py through launcher_bridge.py. Failures carry a typed
code (Error::Service) instead of being guessed from stderr text.

Moved into the launcher: realm profiles (realm id, name and databases from
Settings/realm-profile.json), extra worlds sharing the main database,
the shared world startup deadline and console readiness check, the owned-world
check on shutdown, force-stop-all, and an environment block without
AC_REALM_SERVER_PORT for update validation.

The world supervisor is Scripts/coa-launcher.exe when the repack ships it,
otherwise manage.py watch-world. Extra worlds get an unmodified manage.py.
The realm patch of manage.py stays for the repack's own .bat files.

Verified with examples/manager_launcher_e2e on a disposable repack.

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
2026-11-10 08:45:08 +05:00
ДмитрийandClaude Opus 5.5 1211de5a77 launcher (Rust): services inherit only their log and NUL; MySQL errors carry the server's text
std::process::Command lets a Windows child inherit every inheritable handle of the parent: a
MySQL started by the launcher kept the caller's files and pipes open (found by the SQUID test,
whose log stayed locked). Services now start through CreateProcessW with
PROC_THREAD_ATTRIBUTE_HANDLE_LIST = [log, NUL], as Python's subprocess does. The MySQL client's
outputs are read while it runs (a full pipe stopped it) and its last error line is reported.

E2E on a disposable repack: launcher_e2e PASS again; squid_equivalence PASS: Rust and
squid_playerbots.py leave identical journals, acore_playerbots tables (row counts) and
playerbots.conf (4106 lines), and a second run of either changes nothing.

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
2026-11-10 07:48:04 +05:00
ДмитрийandClaude Opus 5.5 ee36692db7 launcher (Rust): services, world supervisor, SQUID provisioning, coa-launcher.exe
- services: exclusive-bind port check, readiness by listener row or the server side of a
  loopback connection, MySQL client, start MySQL/auth, stop-all (world through its console,
  database last), status.
- world: start-world through a supervisor process (coa-launcher watch-world) that keeps the
  bug-report relay (still BugReport/relay.py via the repack's Python) alive; detailed logging.
- squid: squid_playerbots.py in Rust with the same journals (coa_squid_migrations,
  coa_squid_pending, coa_bots_installed).
- coa-launcher.exe: the manage.py commands and error texts (the Manager reads them).
- Services no longer inherit the launcher's stdin/stdout/stderr: a server holding the
  output pipe kept whoever read the launcher's output waiting.

E2E (examples/launcher_e2e, disposable stable repack on free ports): coa-launcher start-all ->
manage.py sees and stops it; manage.py start-all -> coa-launcher sees and stops it; a second
Rust-only cycle leaves nothing running.

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
2026-11-10 07:29:55 +05:00
ДмитрийandClaude Opus 5.5 ee43522019 launcher (Rust): settings, state records, control lock, prepare
First part of moving Scripts/manage.py into coa-core (plan §17, PY-1). Same formats on disk as
manage.py so both can run on one server: .state records, the byte-0 control lock msvcrt.locking
takes, configuration.json. prepare renders byte-for-byte what manage.py renders (checked against
the real script, COA_MANAGE_PY). State files are flushed to disk before they replace the old ones,
and a damaged record counts as no process instead of failing every later start.

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
2026-11-10 06:58:16 +05:00
github-actions[bot] b4dc30b84a Update published Manager changelog 2026-11-08 10:21:07 +00:00
Дмитрий 73a6cca753 Integrate the qualified November release sources [skip ci] 2026-11-08 15:09:20 +05:00
Corfirean 705bee7d56 Merge verified Custom Races download recovery [skip ci]
Recover interrupted Custom Races patch downloads
2026-11-08 01:44:09 +05:00
Corfirean 5aa9b32283 Merge release cold-cache preparation fix [skip ci]
release: build the frontend before the tests
2026-11-08 01:44:05 +05:00
Дмитрий 711f378ae8 Bind translated release notes to the exact candidate sources [skip ci] 2026-11-08 01:23:56 +05:00
Corfirean c29d56e2b3 Register local installer preparation workflow [skip ci] 2026-11-08 01:21:16 +05:00
Дмитрий d63e85bb18 Prepare Manager 0.9.10 with reviewed notes and signing of local installers [skip ci] 2026-11-08 01:20:32 +05:00
Дмитрий c513649beb Merge remote-tracking branch 'origin/fix/recover-client-patch-downloads' into release/20261108-manager 2026-11-08 01:09:43 +05:00
ДмитрийandClaude Sonnet 5.5 d2e6fef188 feat(bots): settings for bot strength scaling in dungeons and raids
Adds the CoaBots.Scaling.* keys (Enable, Dungeons, Raids, Battlegrounds,
World, DamageDone, HealingDone, DamageTaken, TankThreat, BossTuning) to the
bots schema under Combat, with defaults that change nothing (all multipliers 1,
boss tuning off), translations in five languages and a changelog fragment.

Co-Authored-By: Claude Sonnet 5.5 <noreply@anthropic.com>
2026-11-07 16:22:47 +05:00
ДмитрийandClaude Opus 5.5 2224afd2ea release: build the frontend before the tests
tauri::generate_context! needs ../dist. The tests run before tauri-action builds the frontend, so a
run without a warm target cache cannot compile the app (seen on preview/modules-v2, run 42224568581).

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
2026-11-06 19:47:11 +05:00
Дмитрий 1a1976d9ad Recover interrupted Custom Races patch downloads 2026-10-31 07:55:15 +05:00
160 changed files with 27875 additions and 19585 deletions

No files matched your search

-1
View File
@@ -26,5 +26,4 @@ jobs:
- run: node tools/check-i18n.mjs
- run: npm run build
- run: node --experimental-strip-types --test tools/*.test.mjs
- run: python -B -m unittest discover -s tools -p test_launcher_bridge.py
- run: cargo test --workspace --locked
-1
View File
@@ -74,7 +74,6 @@ jobs:
- name: Tests
run: cargo test --workspace --locked -- --test-threads=1
- run: node --experimental-strip-types --test tools/*.test.mjs
- run: python -B -m unittest discover -s tools -p test_launcher_bridge.py
- name: Build and sign (publish only when requested)
id: tauri
uses: tauri-apps/tauri-action@v0
@@ -0,0 +1,72 @@
name: sign-local-installer
on:
push:
branches: [release/20261108-manager]
workflow_dispatch:
inputs:
build_run_id:
description: Successful manager-local run in coa-server-build
required: true
permissions:
contents: read
actions: read
jobs:
sign:
if: github.event_name == 'workflow_dispatch'
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v7
- uses: actions/setup-node@v4
with:
node-version: 22
- name: Verify local build provenance
env:
GH_TOKEN: ${{ github.token }}
BUILD_RUN: ${{ inputs.build_run_id }}
run: |
python3 - <<'PY'
import json, os, subprocess
run = os.environ['BUILD_RUN']
if not run.isdigit():
raise RuntimeError('Invalid build run')
data = json.loads(subprocess.check_output(['gh', 'api', f'repos/Corfirean/coa-server-build/actions/runs/{run}']))
if data['conclusion'] != 'success' or data['path'] != '.github/workflows/manager-local.yml':
raise RuntimeError('Not a successful local Manager build')
subprocess.run(['gh', 'run', 'download', run, '-R', 'Corfirean/coa-server-build', '-n', 'unsigned-manager-windows', '-D', '_prepared-manager'], check=True)
from pathlib import Path
import hashlib
root = Path('_prepared-manager')
meta = json.loads((root / 'prepared-source.json').read_text())
version = json.loads(Path('package.json').read_text())['version']
name = meta['installer']
if Path(name).name != name or meta['source'] != os.environ['GITHUB_SHA'] or meta['version'] != version or str(meta['run']) != run:
raise RuntimeError('Installer identity differs')
if hashlib.sha256((root / name).read_bytes()).hexdigest() != meta['sha256']:
raise RuntimeError('Installer hash differs')
PY
- run: npm ci
- name: Sign exact locally compiled bytes
env:
TAURI_SIGNING_PRIVATE_KEY: ${{ secrets.TAURI_SIGNING_PRIVATE_KEY }}
TAURI_SIGNING_PRIVATE_KEY_PASSWORD: ${{ secrets.TAURI_SIGNING_PRIVATE_KEY_PASSWORD }}
run: |
node --input-type=module <<'JS'
import { readFileSync, writeFileSync } from 'node:fs';
import { execFileSync } from 'node:child_process';
import { createHash } from 'node:crypto';
const root = '_prepared-manager/';
const meta = JSON.parse(readFileSync(root + 'prepared-source.json'));
execFileSync('node_modules/.bin/tauri', ['signer', 'sign', '--app-version', meta.version, root + meta.installer], {stdio: 'inherit'});
if (createHash('sha256').update(readFileSync(root + meta.installer)).digest('hex') !== meta.sha256) throw new Error('Signed bytes changed');
const signature = readFileSync(root + meta.installer + '.sig', 'utf8').trim();
const url = `https://github.com/Corfirean/coa-server-manager/releases/download/v${meta.version}/${encodeURIComponent(meta.installer)}`;
writeFileSync(root + 'latest.json', JSON.stringify({version: meta.version, notes: 'See the release notes.', pub_date: new Date().toISOString(), platforms: {'windows-x86_64': {signature, url}}}, null, 2) + '\n');
meta.signingRun = process.env.GITHUB_RUN_ID;
writeFileSync(root + 'prepared-source.json', JSON.stringify(meta, null, 2) + '\n');
JS
- uses: actions/upload-artifact@v4
with:
name: prepared-manager-windows
path: _prepared-manager/*
retention-days: 14
if-no-files-found: error
-2
View File
@@ -9,5 +9,3 @@ src-tauri/gen
services/*/target/
# Disposable database fixtures and private recovery data
.cache/
release-preview/
+18
View File
@@ -8,6 +8,24 @@ Published releases and previews. Pre-release entries do not change the stable up
Dates follow GitHub publication (UTC); legacy records retain their archived dates. Newest releases first.
## 0.9.13 — 2026-11-15
- The custom races client is updated to Custom Races V2.
[Release](https://github.com/Corfirean/coa-server-manager/releases/tag/v0.9.13) · [Source changes](https://github.com/Corfirean/coa-server-manager/compare/v0.9.12...v0.9.13)
## 0.9.12 — 2026-11-14
- Settings for how much help bots get in dungeons and raids.
[Release](https://github.com/Corfirean/coa-server-manager/releases/tag/v0.9.12) · [Source changes](https://github.com/Corfirean/coa-server-manager/compare/v0.9.10...v0.9.12)
## 0.9.10 — 2026-11-08
- Custom Races patch installation recovers from interrupted downloads.
[Release](https://github.com/Corfirean/coa-server-manager/releases/tag/v0.9.10) · [Source changes](https://github.com/Corfirean/coa-server-manager/compare/v0.9.9...v0.9.10)
## 0.9.9 — 2026-11-04
- Update and recovery checks use the temporary login port even with a Windows override.
Generated
+32 -21
View File
@@ -586,7 +586,7 @@ dependencies = [
[[package]]
name = "coa-core"
version = "0.9.9"
version = "0.9.14"
dependencies = [
"base64 0.22.1",
"chrono",
@@ -606,6 +606,7 @@ dependencies = [
"serde_json",
"sha1",
"sha2",
"socket2",
"tar",
"tempfile",
"thiserror 2.0.21",
@@ -618,6 +619,15 @@ dependencies = [
"zstd",
]
[[package]]
name = "coa-launcher"
version = "0.9.14"
dependencies = [
"coa-core",
"serde_json",
"windows-sys 0.60.2",
]
[[package]]
name = "coa-registry-proto"
version = "0.1.0"
@@ -634,13 +644,33 @@ dependencies = [
[[package]]
name = "coa-release"
version = "0.9.9"
version = "0.9.14"
dependencies = [
"chrono",
"coa-core",
"serde_json",
]
[[package]]
name = "coa-server-manager"
version = "0.9.14"
dependencies = [
"coa-control-proto",
"coa-core",
"coa-registry-proto",
"serde",
"serde_json",
"tauri",
"tauri-build",
"tauri-plugin-dialog",
"tauri-plugin-opener",
"tauri-plugin-process",
"tauri-plugin-single-instance",
"tauri-plugin-updater",
"tracing",
"uuid",
]
[[package]]
name = "combine"
version = "4.6.8"
@@ -770,25 +800,6 @@ dependencies = [
"typenum",
]
[[package]]
name = "csm-modules-preview"
version = "0.9.9"
dependencies = [
"coa-control-proto",
"coa-core",
"coa-registry-proto",
"serde",
"serde_json",
"tauri",
"tauri-build",
"tauri-plugin-dialog",
"tauri-plugin-opener",
"tauri-plugin-process",
"tauri-plugin-single-instance",
"tauri-plugin-updater",
"tracing",
]
[[package]]
name = "cssparser"
version = "0.37.0"
+2 -2
View File
@@ -1,10 +1,10 @@
[workspace]
resolver = "2"
members = ["crates/coa-core", "crates/coa-release", "crates/coa-registry-proto", "crates/coa-control-proto", "src-tauri"]
members = ["crates/coa-core", "crates/coa-launcher", "crates/coa-release", "crates/coa-registry-proto", "crates/coa-control-proto", "src-tauri"]
exclude = ["services/coa-registry", "services/coa-registry-e2e", "services/coa-coordinator", "services/coa-relay"]
[workspace.package]
version = "0.9.9"
version = "0.9.14"
edition = "2021"
license = "AGPL-3.0-only"
-141
View File
@@ -1,141 +0,0 @@
# Отчёт о реализации платформы модулей CoA и автономной редакции CSM Modules Preview
**Дата:** 2 ноября 2026 г.
**Ветка:** `preview/modules`
**Коммит:** `2c37c4e`
**Исполняемый файл Preview:** `C:\games\coa-server-manager-preview\target\release\csm-modules-preview.exe` (32.6 МБ, PE x64)
**Портативный дистрибутив:** `C:\games\coa-server-manager-preview\dist\CSM-Modules-Preview-Portable.zip` (22.7 МБ)
**Стабильная версия CSM:** `C:\games\coa-server-manager` (ветка `feat/multiruleset-realms-portable`, чистая, без изменений)
---
## 1. Итоговая матрица соответствия критериям (Acceptance Criteria)
| Ключ критерия | Статус | Подтверждение и параметры |
|---|---|---|
| `READY_FOR_USER_MANUAL_TESTING` | **YES** | Полный цикл: выбор реалма → анализ → сборка → проверка → установка → настройки → переключение |
| `CSM_MODULES_PREVIEW_BUILT` | **PASS** | Исполняемый файл скомпилирован в режиме release (PE x64, 32,652,288 байт) |
| `STABLE_CSM_UNCHANGED` | **YES** | `git status --porcelain` пуст; рабочее дерево стабильной CSM полностью сохранено |
| `APP_DATA_ISOLATED` | **PASS** | Изоляция в `%LOCALAPPDATA%\CSMModulesPreview` (`github_cache`, `staging`, настройки) |
| `PREVIEW_REALM_READY` | **PASS** | Тестовый реалм `C:\games\coa-work\plugin-spike\server-v03` с ABI `2f82013def4698d3f75fa24e5f70ffa504a7782d366b5edb78c7adc3c1ee0883` |
| `GITHUB_INSTALL_FLOW_IMPLEMENTED` | **PASS** | Полный реальный конвейер без фиктивных кнопок: инспектирование, DDL/DML проверка, сборка MSVC, установка |
| `CONTROLLED_BUILD_ENGINE_READY` | **PASS** | Изолированная среда сборки MSVC x64 + CMake + Ninja, исключены флаги `/Zi`, CP866/CP1251 декодирование |
| `ADAPTER_GENERATOR_INTEGRATED` | **PASS** | Автоматическая генерация `IPlugin`-адаптера и `CoaPluginQuery` для мастер-лоадеров AzerothCore |
| `DLL_QUALIFICATION_PASS` | **PASS** | Когорта T01–T04 + AH Bot скомпилированы и валидированы PE x64 с манифестами `plugin.json` |
| `TRANSACTIONAL_INSTALL_PASS` | **PASS** | Stop-Gate защита, атомарная установка в `.manager/plugin-store`, обновление `.manager/plugins.json` |
| `SQL_REVIEW_GATE_PASS` | **PASS** | Анализ схемы БД, модальное окно подтверждения миграций, запрет деструктивного DROP при удалении плагина |
| `T01_INSTALL_TEST` (Congrats On Level) | **PASS** | `congrats-on-level.dll` квалифицирована (L0–L4 PASS, L6 PASS) |
| `T02_INSTALL_TEST` (NPC Buffer) | **PASS** | `npc-buffer.dll` квалифицирована (L0–L4 PASS, L6 PASS) |
| `T03_INSTALL_TEST` (NPC Enchanter) | **PASS** | `npc-enchanter.dll` квалифицирована (L0–L4 PASS, L6 PASS) |
| `T04_INSTALL_TEST` (Reward Played Time) | **PASS** | `reward-played-time.dll` квалифицирована (L0–L4 PASS, L6 PASS) |
| `AH_BOT_BUILD_PASS` (Auction House Bot) | **PASS** | Сборка и связывание успешны за 11.7с на SDK v0.3.2 (устранены неразрешённые внешние символы) |
| `GUILDHOUSE_TIER3_CLASSIFICATION_PASS` | **PASS** | Анализатор автоматически детектирует обращение к ядру жизненного цикла и блокирует сборку DLL |
| `DIAGNOSTICS_EXPORT_READY` | **PASS** | Экспорт очищенного диагностического отчёта о среде сборки, ABI и активных плагинах |
| `PORTABLE_PACKAGE_CREATED` | **PASS** | Автономный zip-архив `CSM-Modules-Preview-Portable.zip` готов к запуску пользователем |
---
## 2. Разрешение проблемы с Auction House Bot (AH Bot Link Failure)
### Причина сбоя
При попытке сборки `mod-ah-bot` возникали 3 ошибки компоновщика MSVC `LNK2019`:
1. `??1Player@@UEAA@XZ` — вызов деструктора `Player::~Player()`. В методе `AuctionHouseBot::Update()` модуль создаёт локальный экземпляр `Player _AHBplayer(&_session)` на стеке. Конструктор `Player::Player` был экспортирован в `coa_plugin_exports.def`, а деструктор отсутствовал в таблице экспорта.
2. `?OnAuctionSuccessful@ScriptMgr@@...` — метод обратного вызова при успешном аукционе.
3. `?GetAuctionHouseEntryFromHouse@AuctionHouseMgr@@...` — метод поиска записи дома аукциона.
### Внесённые изменения
1. **Экспорт символов в ядре AzerothCore Host:**
В файл `C:\games\coa-work\plugin-spike\core\src\server\apps\worldserver\Plugins\coa_plugin_exports.def` добавлены:
- `??1Player@@UEAA@XZ`
- `?OnAuctionSuccessful@ScriptMgr@@QEAAXPEAVAuctionHouseObject@@PEAUAuctionEntry@@@Z`
- `?GetAuctionHouseEntryFromHouse@AuctionHouseMgr@@SAPEBUAuctionHouseEntry@@W4AuctionHouseId@@@Z`
2. **Перекомпиляция ядра Host:**
Выполнена сборка `worldserver.exe` и `worldserver.lib` с помощью Ninja в `C:\games\coa-work\plugin-spike\build-spike`.
3. **Обновление SDK v0.3.2:**
Экспортирован SDK в `C:\games\coa-work\plugin-spike\sdk-v03` (ABI fingerprint: `2f82013def4698d3f75fa24e5f70ffa504a7782d366b5edb78c7adc3c1ee0883`).
4. **Обновление тестового реалма:**
Файлы `worldserver.exe` и `worldserver.pdb` скопированы в `C:\games\coa-work\plugin-spike\server-v03`.
5. **Верификация сборки:**
Тест `test_controlled_build_ah_bot` в `build_engine.rs` выполнен успешно за 11.71 с. AH Bot компилируется и компонуется в валидную DLL без неразрешённых символов.
---
## 3. Классификация и диагностика Guildhouse (Tier 3 Core-Integrated)
### Анализ 26 ошибок компоновки
Модуль `mod-guildhouse` содержит вызовы:
- `WorldObject::AddObjectToRemoveList()`
- `Unit::GetPhaseByAuras()`
- `new GameObject()` / `delete gobject`
- `GameObject::SaveToDB()` / `GameObject::DeleteFromDB()` / `GameObject::LoadGameObjectFromDB()`
- `new Creature()` / `delete creature`
- `Creature::SaveToDB()` / `Creature::DeleteFromDB()` / `Creature::LoadCreatureFromDB()`
Данные методы представляют собой низкоуровневое управление жизненным циклом сущностей и распределением памяти в куче игрового ядра. Прямое создание и уничтожение сущностей через границу DLL в отдельном модуле без абстрагирующего сервиса (`GameObjectServices`) нарушает инварианты аллокатора памяти ядра и приводит к сбоям сервера.
### Реализация в Compatibility Analyzer
В `crates/coa-core/src/analyzer.rs`:
- Добавлено правило `RULE_OBJECT_LIFECYCLE_CORE_DEPENDENCY` (Severity: Critical, Confidence: High).
- Анализатор сканирует исходный код на наличие прямого создания сущностей и вызовов `SaveToDB`, `DeleteFromDB`, `AddObjectToRemoveList` без завязки на имя репозитория.
- При обнаружении модуль классифицируется как `CorePatchRequired` (`Tier 3: Core-Integrated Compatibility Required`).
- Статус сборки автоматически устанавливается в `BLOCKED`, статус рантайма — `BLOCKED`.
- В пользовательском интерфейсе кнопка сборки и установки отключается, а пользователю выводится понятное объяснение: *«Модуль обращается к внутренним структурам управления сущностями ядра. Требуется сборка в составе ядра (in-tree build)»*.
---
## 4. Устранение дефектов сборщика и интерфейса
1. **Разрешение идентификатора модуля вместо Git SHA:**
- Intake-кэш клонирует репозитории в `github_cache/github/<owner>/<repo>/<sha>`. Ранее `build_module_from_source` использовал имя конечной папки (SHA).
- Реализована функция `resolve_module_identity(source_dir)`, которая анализирует путь к репозиторию и извлекает канонический идентификатор (например, `npc-buffer`), человекочитаемое имя (`NPC Buffer`) и сохраняет Git-коммит в метаданных.
- В `preview.rs` добавлена автомиграция ранее установленных плагинов с 40-значными SHA в читаемые имена.
2. **Устранение иероглифов (mojibake) в логах MSVC:**
- Компилятор MSVC на русскоязычных Windows выводит сообщения в кодировках CP866/CP1251.
- В `build_engine.rs` добавлена функция `decode_msvc_output`, выполняющая декодирование с валидацией UTF-8 и откатом на CP866/CP1251.
- В скрипт сборщика `run_build.bat` добавлены директивы `set VSLANG=1033` и `chcp 65001`.
3. **Устранение предупреждения компилятора D9025 (`/Zi` vs `/Z7`):**
- Флаг `/Zi` конфликтовал с изолированным флагом `/Z7`.
- В конфигурации CMake `build_engine.rs` флаг `/Zi` автоматически удаляется из `CMAKE_CXX_FLAGS_RELWITHDEBINFO`, обеспечивая чистый вывод сборки.
---
## 5. Обновлённый интерфейс модулей (UI Architecture)
Интерфейс `ModulesPage.tsx` объединяет проверенный дизайн CSM и модульную платформу Preview:
1. **Вкладка «Официальные модули» (Official Modules):**
- Полная сетка встроенных модулей (CoA Companions, Content Scaling, TBC, WotLK, Auction House Bot, NPC Enchanter, SQUID's Playerbots, Custom Races, TimeIsTime).
- Переключатели с защитой взаимного исключения (активация CoA Companions автоматически отключает SQUID's Playerbots и наоборот).
- Управление патчем клиента Custom Races (статус MPQ, кнопки «Установить патч», «Восстановить патч», «Удалить патч», шкала прогресса).
- Выдвижные панели настроек `ModuleSettings` со строкой поиска, чекбоксом расширенных настроек и специализированным редактором `AuctionTypes`.
2. **Вкладка «Каталог модулей» (Verified Catalog):**
- Каталог из 10 проверенных модулей с фильтрами («Все», «Проверенные DLL», «Конфликты», «Требуют ядро») и поиском.
- Честные бейджи уровней квалификации:
- `INSTALL_VERIFIED` (`L0–L4 PASS, L6 PASS`): NPC Buffer, Congrats On Level, NPC Enchanter, Reward Played Time.
- `LINK_VERIFIED` (`L0–L3 PASS`): Auction House Bot (SDK v0.3.2).
- `BUILT` (`L0–L2 PASS`): Transmogrification.
- `POTENTIAL_CONFLICT` (`L0–L2 PASS`): Solocraft (требуется калибровка параметров).
- `CONFLICT_DETECTED` (`L0 PASS`): AutoBalance (прямой конфликт полномочий с Content Scaling).
- `CORE_INTEGRATED_REQUIRED` (`Tier 3`): Guildhouse (прямое управление жизненным циклом сущностей).
- `DEPENDENCY_MISSING` (`Tier 4`): ALE (отсутствует рантайм LuaJIT).
- Модальное окно «Подробнее» с полным описанием архитектурных ограничений и кнопкой быстрого перехода к сборке.
3. **Вкладка «Установка с GitHub» (Install from GitHub):**
- Ввод URL, быстрый выбор популярных модулей, многомерный статус (Сборка, Рантайм, Геймплей, БД, Безопасность), список находок аудита, управляемая сборка MSVC и установка в реалм с подтверждением SQL-миграций.
4. **Вкладка «Установленные плагины» (Installed Plugins):**
- Список установленных DLL с отображением понятных имён, версии, хэша коммита, переключателем включения/выключения и кнопкой безопасного удаления (без сброса таблиц БД).
5. **Вкладка «Сборка & логи MSVC» (Builds & MSVC Logs):**
- Результат последней сборки, расшифрованные ошибки MSVC с рекомендациями по устранению и терминал вывода в реальном времени.
6. **Вкладка «Среда сборки & SDK» (Toolchain & Environment):**
- Статус готовности MSVC x64, CMake, Ninja, SDK v0.3.2, слепок ABI хоста и текущий путь к реалму.
---
## 6. Пути к ключевым файлам и дистрибутивам
- **Автономный архив Preview:** `C:\games\coa-server-manager-preview\dist\CSM-Modules-Preview-Portable.zip`
- **Исполняемый файл Preview:** `C:\games\coa-server-manager-preview\dist\CSM-Modules-Preview-Portable\CSM Modules Preview.exe`
- **Бинарный файл сборки:** `C:\games\coa-server-manager-preview\target\release\csm-modules-preview.exe`
- **Тестовый реалм со сборкой v0.3.2:** `C:\games\coa-work\plugin-spike\server-v03`
- **Экспортированный SDK v0.3.2:** `C:\games\coa-work\plugin-spike\sdk-v03`
- **Отчёт о квалификации:** `C:\games\coa-work\plugin-spike\report\sdk-v032\csm-modules-preview-qualification.json`
- **Стабильная рабочая копия CSM (без изменений):** `C:\games\coa-server-manager`
-178
View File
@@ -1,178 +0,0 @@
# Отчёт об интеграции публичного каталога AzerothCore в Modules V2
**Проект:** CoA Server Manager (CSM)
**Ветка:** `preview/modules-v2`
**Рабочая директория:** `C:\games\coa-server-manager-preview`
**Дата реализации:** Ноябрь 2026 г.
---
## 1. Резюме выполненных работ
В существующую архитектуру системы **Modules V2** успешно интегрирован официальный публичный каталог модулей AzerothCore (`azerothcore.org/data/catalogue.json`).
Реализация строго следует принципу **непереизобретения колеса**:
- Полностью сохранён существующий конвейер Modules V2:
- GitHub Intake & Source Cache (`analyzer.rs`)
- Compatibility Analyzer (`analyze_github_module_for_realm`)
- Controlled DLL Builder на базе MSVC, CMake, Ninja и `IPlugin` (`build_engine.rs`)
- Transactional Installer (`preview.rs`)
- Plugin Registry & Manifest Storage (`plugins.rs`)
- Server Stop-Gate и SQL Review Gate
- Главное UX-требование выполнено:
- **Группа A (Recommended for CoA)** всегда отображается на самом верху каталога. Все существующие проверенные модули (включая официальные компоненты ядра и динамические DLL) сохранены в полном объёме с их текущими действиями.
- **Группа B (AzerothCore Community Modules)** отображается ниже и предоставляет доступ к 500+ модулям сообщества с информацией о звёздах, форках, тегах, статусе совместимости CoA и кнопкой установки, передающей URL репозитория в готовый конвейер `runAnalysis(url)`.
- Блокировка несовместимых модулей (например, `azerothcore/mod-ahbot`) защищена на трёх уровнях: в UI, в анализаторе AST/исходного кода и в сборочном движке (невозможно обойти даже прямой вставкой URL в инпут).
---
## 2. Архитектура и источники данных
### 2.1 Источник каталога
В ходе исследования было установлено, что файл `catalogue.json` в репозитории `azerothcore.github.io` является устаревшим статическим срезом (185 модулей). Реальным актуальным источником каталога AzerothCore является:
- **URL:** `https://www.azerothcore.org/data/catalogue.json`
- **Количество модулей:** 545+ репозиториев
- **Периодичность обновления:** каждые 30 минут через GitHub Actions на Cloudflare Pages CDN
- **Машиночитаемый формат:** JSON-объект с полями `categories` и `repos` (`id`, `name`, `owner`, `html_url`, `stargazers_count`, `forks_count`, `topics`, `category`, `license`, `pushed_at`).
### 2.2 Кэширование, ETag и автономный режим
Реализован движок в `crates/coa-core/src/catalogue.rs`:
1. **HTTP Conditional Requests:** При сетевом запросе отправляется заголовок `If-None-Match: <etag>`. При получении ответа `304 Not Modified` парсинг сетевого тела не производится, обновляется лишь метка времени кэша.
2. **TTL (12 часов):** Если локальный файл кэша свежее 12 часов и пользователь не нажал кнопку принудительного обновления, каталог отдаётся из локального дискового кэша мгновенно без блокирующих сетевых задержек.
3. **Атомарная запись:** Сохранение на диск осуществляется через `fsx::atomic_write_json` в `%LOCALAPPDATA%/coa-manager/catalogue/catalogue_cache.json`.
4. **Offline Fallback:** В случае отсутствия интернета, сбоя DNS или недоступности CDN сервер возвращает последнюю сохранённую копию кэша с флагом `is_offline = true`. В интерфейсе появляется информационная плашка с датой кэша и кнопкой повтора.
### 2.3 Нормализация и дедупликация
Функция `normalize_repo_slug` корректно приводит к единому виду `owner/repo`:
- URL с протоколом: `https://github.com/azerothcore/mod-npc-buffer.git` → `azerothcore/mod-npc-buffer`
- SSH-ссылки: `git@github.com:azerothcore/mod-npc-buffer.git` → `azerothcore/mod-npc-buffer`
- Ссылки на поддиректории: `https://github.com/Corfirean/azerothcore-wotlk-coa/tree/coa-bots/...`
---
## 3. Кураторский оверлей CoA (CoA Modules Overlay)
В `crates/coa-core/src/coa-modules-overlay.json` создан структурированный оверлей совместимости с ядром Conquest of Azeroth.
### 3.1 Статусы совместимости
1. `Recommended` — модуль оптимизирован для CoA и проверен на практике.
2. `Verified` — динамический плагин DLL компилируется и функционирует штатно.
3. `RequiresAdapter` — требует генерации адаптера точки входа `IPlugin`.
4. `Unverified` — сторонний модуль сообщества (по умолчанию).
5. `Incompatible` — содержит известные конфликты с механизмами CoA.
6. `Blocked` — модуль категорически запрещён к установке из-за разрушения специфики CoA (например, конфликтующие боты аукциона или параллельные реализации companion AI).
### 3.2 Защита на уровне движка
В `crates/coa-core/src/analyzer.rs` и `crates/coa-core/src/build_engine.rs` добавлена проверка `catalogue::is_blocked_repo`:
- Анализатор немедленно фиксирует критическое замечание (`CRITICAL`) с причиной блокировки и присваивает статус `SourceIncompatible`.
- Сборочный движок `build_engine::build_module_from_source` прерывает сборку до вызова MSVC/CMake с понятной ошибкой: `Module '...' is blocked for Conquest of Azeroth: ...`.
---
## 4. Tauri IPC и клиентский API
1. **Команда Tauri (`src-tauri/src/lib.rs`):**
```rust
#[tauri::command]
async fn get_public_module_catalog(
force_refresh: Option<bool>,
) -> std::result::Result<coa_core::catalogue::PublicCatalogueResponse, UiError> {
let cache_dir = data_dir().join("catalogue");
let force = force_refresh.unwrap_or(false);
blocking(move || {
coa_core::catalogue::fetch_or_load_catalogue(&cache_dir, force)
})
.await
}
```
Команда зарегистрирована в `invoke_handler!`.
2. **Клиентский API (`src/lib/api.ts`):**
- Добавлены TypeScript-интерфейсы `PublicCatalogueItem`, `PublicCatalogueResponse`, `CoaCompatibilityStatus`.
- Экспортирован типизированный метод:
```typescript
getPublicModuleCatalog: (forceRefresh = false) =>
invoke<PublicCatalogueResponse>("get_public_module_catalog", { forceRefresh }),
```
---
## 5. Пользовательский интерфейс (`ModulesPage.tsx`)
### 5.1 Иерархия отображения
1. **Группа A — Рекомендовано для CoA:**
- 13 модулей `VERIFIED_CATALOG` отображаются в самом начале.
- Имеют золотой бейдж `★ CoA Recommended` / `CoA Verified`.
- Сохраняют все быстрые действия: для официальных — включение/выключение в ядре, для динамических DLL — прямая сборка и установка.
2. **Группа B — Каталог сообщества AzerothCore:**
- Все остальные модули каталога azerothcore.org (за вычетом модулей из группы A во избежание дублирования).
- Информативная карточка: название, автор, описание, звёзды GitHub, форки, категория, лицензия SPDX, теги topics.
- Бейдж статуса CoA (`CoaStatusBadge`):
- `Recommended` (золотой)
- `Verified` (зелёный)
- `RequiresAdapter` (голубой)
- `Community AC` (нейтральный)
- `Incompatible` (янтарный с предупреждением)
- `Blocked` (красный с причиной блокировки)
3. **Действия с модулями сообщества:**
- Для уже установленных: индикатор `✓ Установлен` и кнопка `Настроить`.
- Для заблокированных: заблокированная кнопка `⛔ Заблокирован` с подсказкой причины.
- Для доступных модулей: кнопка `Собрать и установить`, которая устанавливает `githubUrl`, запускает `runAnalysis(url)` и переводит пользователя на контролируемую сборку `startControlledBuild(url)`.
- Кнопка `Подробнее`: открывает модальное окно с полным набором метаданных репозитория, лицензией, веткой, историей обновлений и инженерными комментариями.
### 5.2 Поиск, фильтры и сортировка
- **Поиск:** фильтрация по названию, репозиторию, автору, описанию и тегам.
- **Фильтры:**
- `Все` (сумма групп A и B)
- `Рекомендовано CoA`
- `Официальные ядра`
- `Проверенные DLL`
- `Сообщество AC`
- `Несовместимые / Блок`
- **Сортировка модулей сообщества:**
- `★ По звёздам` (по умолчанию)
- `🕒 По дате обновления`
- `🔤 По имени (A-Z)`
- **Пагинация (Load More):** отображение порциями по 24 модуля с кнопкой `Показать ещё (+24)` и счётчиком показанных элементов.
- **Счётчик вкладки:** бейдж на вкладке «Каталог модулей» отображает общее число доступных модулей (`publicCatalog.total_count` ~ 545).
---
## 6. Тестирование и верификация
### 6.1 Модульные тесты бэкенда (`coa-core`)
Успешно пройдены все тесты каталога и смежных подсистем:
- `catalogue::tests::test_slug_normalization` — проверка нормализации URL, SSH-алиасов и суффиксов `.git`
- `catalogue::tests::test_overlay_loading_and_blocked_detection` — корректность загрузки оверлея и выявление блокированных модулей (`azerothcore/mod-ahbot`)
- `catalogue::tests::test_official_json_parsing_and_normalization` — парсинг структуры `catalogue.json` и применение оверлея
- `catalogue::tests::test_disk_caching_and_offline_fallback` — проверка ETag, TTL и возврата из автономного кэша
- `analyzer::tests::*` (17 тестов) — отсутствие регрессий в AST-анализаторе
- `build_engine::tests::test_controlled_build_cohort_t01_t04` и `test_controlled_build_ah_bot` — успешная проверка сборочного движка
### 6.2 Проверка фронтенда
- `tsc --project tsconfig.json --noEmit` — **0 ошибок, полная типизация**.
- `vite build` — **успешная сборка production-бандла** клиента за 4.12 сек.
- `cargo check` — **чистая компиляция Tauri бэкенда** без предупреждений.
---
## 7. Локальные коммиты в ветке `preview/modules-v2`
Все изменения закоммичены локально в рабочей ветке `preview/modules-v2` четырьмя атомарными коммитами:
1. `4e661e6` — `feat(core): implement AzerothCore module catalogue engine, overlay and caching`
- Создан `crates/coa-core/src/catalogue.rs`
- Создан `crates/coa-core/src/coa-modules-overlay.json`
- Зарегистрирован модуль в `crates/coa-core/src/lib.rs`
- Добавлен план интеграции `MODULE_CATALOG_V2_INTEGRATION_PLAN.md`
2. `6bbdef1` — `feat(analyzer): enforce CoA module blocklist in analyzer and build engine`
- Добавлена блокировка в `crates/coa-core/src/analyzer.rs`
- Добавлена проверка безопасности в `crates/coa-core/src/build_engine.rs`
3. `c53fc64` — `feat(ipc): expose public module catalogue Tauri command and API client`
- Зарегистрирована Tauri команда `get_public_module_catalog` в `src-tauri/src/lib.rs`
- Экспортированы типы и API-метод в `src/lib/api.ts`
4. `d0c57f9` — `feat(ui): integrate dual-group public AzerothCore catalogue into ModulesPage`
- Реализованы две группы (Группа A: Рекомендовано для CoA, Группа B: Сообщество AzerothCore)
- Добавлены бейджи статусов, поиск, фильтры, сортировка, пагинация, модальное окно деталей, плашка офлайн-режима и вызов `runAnalysis`
**Внимание:** В соответствии с инструкцией слияние в `master`, создание PR и push во внешний репозиторий **не выполнялись**. Все изменения готовы к локальному тестированию и ревью.
-477
View File
@@ -1,477 +0,0 @@
# План интеграции публичного каталога AzerothCore в систему Modules V2 (CSM)
**Документ:** `MODULE_CATALOG_V2_INTEGRATION_PLAN.md`
**Дата аудита:** Ноябрь 2026 г.
**Проект:** [CoA Server Manager (CSM)](https://github.com/Corfirean/coa-server-manager)
**Исследуемая целевая ветка:** `preview/modules-v2`
**Рабочее дерево Preview:** `C:\games\coa-server-manager-preview`
**Статус:** Исследование и планирование архитектуры (без модификации рабочих компонентов)
---
## Содержание
1. [Фактическая архитектура Modules V2](#1-фактическая-архитектура-modules-v2)
2. [Карта существующих компонентов с путями и функциями](#2-карта-существующих-компонентов-с-путями-и-функциями)
3. [Точки интеграции каталога](#3-точки-интеграции-каталога)
4. [Перечень уже реализованных возможностей](#4-перечень-уже-реализованных-возможностей)
5. [Перечень отсутствующих компонентов](#5-перечень-отсутствующих-компонентов)
6. [Предлагаемые минимальные изменения Backend](#6-предлагаемые-минимальные-изменения-backend)
7. [Предлагаемые изменения Frontend](#7-предлагаемые-изменения-frontend)
8. [Схема потоков данных](#8-схема-потоков-данных)
9. [Модель кэширования и обновления](#9-модель-кэширования-и-обновления)
10. [Интеграция с анализатором совместимости](#10-интеграция-с-анализатором-совместимости)
11. [План тестирования (Интеграционная матрица)](#11-план-тестирования-интеграционная-матрица)
12. [Риски и потенциальные регрессии](#12-риски-и-потенциальные-регрессии)
13. [План реализации небольшими независимыми этапами](#13-план-реализации-небольшими-независимыми-этапами)
14. [Сводная таблица компонентов](#14-сводная-таблица-компонентов)
15. [Анализ различий веток: `master` vs `preview/modules-v2`](#15-анализ-различий-веток-master-vs-previewmodules-v2)
16. [Главный вопрос и итоговый вердикт](#16-главный-вопрос-и-итоговый-вердикт)
---
## 1. Фактическая архитектура Modules V2
В ветке `preview/modules-v2` (развернута в рабочем дереве `C:\games\coa-server-manager-preview`) реализована полноценная платформа динамических модулей и плагинов для Conquest of Azeroth.
### 1.1. Классификация компонентов (Authoritative Inventory)
В отличие от старой архитектуры, где наличие `.conf` в папке считалось признаком установки, в Modules V2 введена строгая модель типов компонентов ([PREVIEW_DISTRIBUTION_ARCHITECTURE.md](file:///C:/games/coa-server-manager-preview/docs/PREVIEW_DISTRIBUTION_ARCHITECTURE.md)):
- `DYNAMIC_DLL`: динамически загружаемые C++ библиотеки, компилируемые под CoA Plugin SDK v0.3.2. Хранятся в `.manager/plugin-store/<id>/<version>/` и линкуются в `plugins/`. Поддерживают полный динамический жизненный цикл (`can_remove = true`).
- `CORE_EMBEDDED`: легаси C++ модули, монолитно вкомпилированные в `worldserver.exe`. Не могут быть удалены на лету (`can_remove = false`).
- `CONTENT_PACK`: пакеты контента (DBC, карты, спавны), неизменяемые в рантайме.
- `CLIENT_PATCH`: клиентские MPQ-патчи (`patch-Z.mpq`).
- `LOGICAL_FEATURE`: логические переключатели ядра (`client-compat`).
### 1.2. Конвейер сборки DLL и границы совместимости
Modules V2 содержит изолированный сборочный движок ([crates/coa-core/src/build_engine.rs](file:///C:/games/coa-server-manager-preview/crates/coa-core/src/build_engine.rs)):
- **Тулчейн:** автоматическое обнаружение MSVC x64 (`vcvars64.bat`), CMake, Ninja и дерева экспортированного SDK (`C:\games\coa-work\plugin-spike\sdk-v03`).
- **Генератор адаптера (`generate_adapter`):** лексически анализирует исходники модуля, находит функцию входа `Add...Scripts()`, генерирует файл `adapter.cpp`, реализующий интерфейс `IPlugin` и функцию запроса контракта `CoaPluginQuery`.
- **Границы совместимости DLL:**
1. *Поддерживаются:* модули, написанные на чистом C++ с использованием хуков ScriptMgr (`PlayerScript`, `WorldScript`, `CreatureScript`, `ItemScript` и т.д.), не модифицирующие ядро.
2. *Не поддерживаются:* модули, требующие изменений ядра (`CorePatchRequired` — патчи `Player.cpp`, DBC-структур), модули с внешними нелинкуемыми библиотеками (`ALE` без LuaJIT рантайма), или модули с отсутствующими экспортами ядра (`SdkExportMissing`).
3. *ABI-контроль:* сборка возможна только при совпадении хэша ABI хоста (`realm_sdk_fingerprint`) со слепком SDK.
### 1.3. Транзакционная установка и ворота безопасности
Установка модулей управляется через [crates/coa-core/src/preview.rs](file:///C:/games/coa-server-manager-preview/crates/coa-core/src/preview.rs) и [plugins.rs](file:///C:/games/coa-server-manager-preview/crates/coa-core/src/plugins.rs):
- **Stop-Gate (`require_server_stopped`):** установка, удаление или обновление DLL строго блокируются, если процесс `worldserver.exe` активен.
- **SQL Review Gate (`plan_sql_review`):** статический парсер SQL выявляет наличие DDL-мутаций (`CREATE/ALTER TABLE`) и требует явного подтверждения пользователя.
- **Реестр:** состояние фиксируется в `.manager/plugins.json` со слепками SHA-256 файлов, версиями и путями к конфигам.
---
## 2. Карта существующих компонентов с путями и функциями
```mermaid
graph TD
UI["ModulesPage.tsx (React/Tailwind)"] -->|IPC Invoke| Tauri["src-tauri/src/lib.rs"]
Tauri --> Analyzer["analyzer.rs (Intake & L0 Static Audit)"]
Tauri --> Builder["build_engine.rs (MSVC / CMake / Adapter Gen)"]
Tauri --> Preview["preview.rs (Stop-Gate / SQL Gate / Orchestration)"]
Preview --> Plugins["plugins.rs (Store & .manager/plugins.json)"]
```
| Уровень / Назначение | Путь к файлу | Ключевые функции / Точки входа |
|---|---|---|
| **Intake & Static Audit** | `crates/coa-core/src/analyzer.rs` | `analyze_github_module_for_realm(&url, &realm_root, cache_dir)`<br>`analyze_github_repository(&url, cache_dir)`<br>`parse_and_validate_github_url(&url)` |
| **Controlled Build Engine** | `crates/coa-core/src/build_engine.rs` | `detect_toolchain()`<br>`build_module_from_source(&source_dir, &realm_root, ...)`<br>`generate_adapter(&module_dir)` |
| **Lifecycle & Orchestration** | `crates/coa-core/src/preview.rs` | `install_qualified_module(&realm_root, &id, &ver, apply_sql, ...)`<br>`list_installed_preview_plugins(&realm_root)`<br>`toggle_preview_module(&realm_root, &id, enable)`<br>`remove_preview_module(&realm_root, &id)`<br>`plan_sql_review(&module_id, &report)` |
| **Plugin Store & Registry** | `crates/coa-core/src/plugins.rs` | `load_registry(&root)` / `save_registry(&root, &reg)`<br>`install(...)` / `remove(...)`<br>`require_server_stopped(&root)` |
| **Tauri IPC Bridge** | `src-tauri/src/lib.rs` | `analyze_github_module(url, realm_id)` (L2800)<br>`preview_build_module(realm_id, source)` (L2849)<br>`preview_install_module(realm_id, id, ver, sql)` (L2895)<br>`preview_toggle_module(realm_id, id, enable)` (L2919)<br>`preview_remove_module(realm_id, id)` (L2934)<br>`preview_list_installed_plugins(realm_id)` (L2948) |
| **Frontend API Layer** | `src/lib/api.ts` | `api.analyzeGithubModule(url, realmId)` (L733)<br>`api.previewBuildModule(realmId, source)`<br>`api.previewInstallModule(...)`<br>`api.previewToggleModule(...)` |
| **Modules V2 UI View** | `src/screens/ModulesPage.tsx` | Вкладка `installed` (L2151)<br>Вкладка `catalog` (L2813)<br>Вкладка `builds` (L3431)<br>Вкладка `toolchain` (L3500)<br>Функция интейка: `runAnalysis(url)` (L1328)<br>Функция сборки: `startControlledBuild(url)` (L1365) |
---
## 3. Точки интеграции каталога
Существующая архитектура Modules V2 **полностью готова к приёму URL репозиториев**.
Точкой интеграции на стороне Frontend является функция:
```typescript
// src/screens/ModulesPage.tsx, строки 1328–1362
async function runAnalysis(urlToAnalyze?: string) {
const targetUrl = (urlToAnalyze || githubUrl).trim();
if (!targetUrl) return;
setGithubUrl(targetUrl);
setAnalyzing(true);
// ...
const rep = await api.analyzeGithubModule(targetUrl, serverId);
setReport(rep);
}
```
### Принцип бесшовной стыковки:
1. Каталог модулей отображает карточки доступных репозиториев.
2. При нажатии на карточке кнопки **«Анализировать и подготовить к установке»** вызывается:
```typescript
runAnalysis(module.html_url);
```
3. CSM автоматически переключает контекст на анализ репозитория, скачивает исходники в кэш, выполняет L0-аудит и отображает модальное окно совместимости.
4. Пользователь нажимает **«Собрать DLL»** (`startControlledBuild()`), после чего срабатывает `previewInstallModule()`.
**Результат:** Не требуется создавать второй установщик, дублировать сборщик или менять логику реестра `.manager/plugins.json`.
---
## 4. Перечень уже реализованных возможностей
В ветке `preview/modules-v2` уже полностью реализованы и протестированы:
1. Загрузка исходных кодов с GitHub с кэшированием в `%LOCALAPPDATA%\CSMModulesPreview\github_cache` и дедупликацией по SHA дерева коммита.
2. Статический анализатор совместимости (L0 Static Analysis) с проверкой сигнатур функций `Add...Scripts()`, детекцией core patches, парсингом SQL-миграций и проверкой лицензий.
3. Автоматический генератор C++ адаптеров `IPlugin` под CoA Plugin SDK.
4. Сборочный движок MSVC x64 + Ninja + CMake с захватом логов компиляции в реальном времени.
5. Stop-Gate валидация (защита от изменения DLL и баз данных работающего сервера).
6. SQL Review Gate (анализ рисков DDL/DML перед наложением на базу данных).
7. Установка DLL в хранилище `.manager/plugin-store/`, создание символических ссылок в `plugins/` и фиксация в `.manager/plugins.json`.
8. Полный жизненный цикл установленных плагинов: включение, отключение, безопасное удаление (с сохранением пользовательских таблиц БД).
9. Пользовательский интерфейс с вкладками «Установленные плагины», «Сборка & логи MSVC» и «Среда сборки & SDK».
---
## 5. Перечень отсутствующих компонентов
Для полноценной работы каталога в Modules V2 отсутствуют исключительно компоненты **обнаружения и доставки метаданных**:
1. **Сетевой загрузчик официального JSON (`PublicCatalogueFetcher`):** сервис в `crates/coa-core`, скачивающий `https://www.azerothcore.org/data/catalogue.json` с поддержкой ETag и сохранением на диск.
2. **Локальный дисковый кэш каталога:** файл кэша в `%LOCALAPPDATA%\CSMModulesPreview\catalogue_cache.json` с оффлайн-фоллбэком.
3. **Парсер и фильтр категории `azerothcore-module`:** извлечение 545 репозиториев, нормализация данных, отсеивание заведомо нерелевантных проектов (чистые Lua/SQL).
4. **Кураторский оверлей CoA (`coa-modules-overlay.json`):** встроенный или подгружаемый файл, содержащий экспертные вердикты для ядра CoA (`Verified`, `Incompatible`, `RequiresAdapter`).
5. **Tauri IPC команда `get_public_module_catalog`:** эндпоинт передачи каталога во фронтенд.
6. **Динамический каталог в UI (`ModulesPage.tsx`):** расширение вкладки `catalog`, заменяющее жестко закодированный массив `VERIFIED_CATALOG` на динамический список с поиском, сортировкой и карточкой деталей.
---
## 6. Предлагаемые минимальные изменения Backend
### 6.1. Новый модуль `crates/coa-core/src/catalogue.rs`
Добавляется один изолированный файл со структурами и логикой:
```rust
// crates/coa-core/src/catalogue.rs
use std::collections::BTreeMap;
use std::fs;
use std::path::{Path, PathBuf};
use serde::{Deserialize, Serialize};
use crate::error::{Error, Result};
pub const OFFICIAL_CATALOGUE_URL: &str = "https://www.azerothcore.org/data/catalogue.json";
#[derive(Debug, Clone, Serialize, Deserialize)]
pub struct RawRepoEntry {
pub id: u64,
pub name: String,
pub full_name: String,
pub description: Option<String>,
pub stargazers_count: u32,
pub default_branch: String,
pub html_url: String,
pub forks_count: u32,
pub watchers_count: u32,
#[serde(default)]
pub pushed_at: Option<String>,
#[serde(default)]
pub updated_at: Option<String>,
#[serde(default)]
pub license: Option<RawLicense>,
#[serde(default)]
pub topics: Vec<String>,
}
#[derive(Debug, Clone, Serialize, Deserialize)]
pub struct RawLicense {
pub spdx_id: Option<String>,
}
#[derive(Debug, Clone, Serialize, Deserialize)]
pub struct RawCatalogue {
pub global_search: bool,
pub organizations: BTreeMap<String, BTreeMap<String, Vec<RawRepoEntry>>>,
}
#[derive(Debug, Clone, Serialize, Deserialize)]
pub struct PublicModuleCard {
pub id: u64,
pub name: String,
pub full_name: String,
pub description: String,
pub stars: u32,
pub html_url: String,
pub default_branch: String,
pub last_pushed: String,
pub license: String,
pub topics: Vec<String>,
pub coa_status: String, // "verified", "unverified", "incompatible", "blocked"
pub coa_note: Option<String>,
}
#[derive(Debug, Clone, Serialize, Deserialize)]
pub struct CatalogueResponse {
pub modules: Vec<PublicModuleCard>,
pub cached_at: String,
pub is_offline: bool,
}
pub fn get_catalogue(cache_dir: &Path, force_refresh: bool) -> Result<CatalogueResponse> {
let cache_file = cache_dir.join("catalogue_cache.json");
let etag_file = cache_dir.join("catalogue_etag.txt");
// 1. Проверка необходимости обновления и загрузка с ETag через reqwest
// 2. Слияние с coa-modules-overlay.json
// 3. Возврат нормализованного списка
// ...
}
```
### 6.2. Регистрация в `crates/coa-core/src/lib.rs`
Добавить строку:
```rust
pub mod catalogue;
```
### 6.3. Экспорт команды в `src-tauri/src/lib.rs`
Добавить одну команду:
```rust
#[tauri::command]
async fn get_public_module_catalog(
state: State<'_, AppState>,
force_refresh: bool,
) -> std::result::Result<coa_core::catalogue::CatalogueResponse, UiError> {
let cache_dir = data_dir().join("catalogue");
blocking(move || {
coa_core::catalogue::get_catalogue(&cache_dir, force_refresh)
.map_err(Into::into)
}).await
}
```
И зарегистрировать её в `generate_handler!`.
---
## 7. Предлагаемые изменения Frontend
### 7.1. Расширение `src/lib/api.ts`
Добавить один метод:
```typescript
getPublicModuleCatalog: (forceRefresh = false) =>
invoke<CatalogueResponse>("get_public_module_catalog", { forceRefresh }),
```
### 7.2. Минимальные изменения в `src/screens/ModulesPage.tsx`
В существующей вкладке `catalog` (строки 2813–3100):
1. **Загрузка данных:** При открытии вкладки `catalog` вызывать `api.getPublicModuleCatalog()`.
2. **Панель фильтров и поиска:**
- Поле поиска: фильтрация списка по `name`, `description`, `topics`.
- Сортировка: «По звёздам (популярные)», «По дате обновления (свежие)».
- Фильтр категорий: «Все» (545), «Проверенные CoA», «Геймплей», «Утилиты».
3. **Карточка модуля:**
- Название, автор, описание, бейдж звёзд и лицензии.
- Бейдж совместимости с CoA:
- Зелёный: `Verified CoA` (из оверлея).
- Серый: `Unverified Public` (из официального каталога).
- Красный: `Incompatible with CoA` (известный конфликт).
- Кнопка действия:
- Если модуль уже установлен (совпадает `repo` с установленными в `installedPlugins`): отображать бейдж `Установлен` с версией.
- Если не установлен: кнопка **«Анализировать и установить»**.
4. **Обработчик кнопки установки:**
```typescript
onClick={() => {
runAnalysis(module.html_url);
}}
```
*Больше ничего не требуется:* клик переключает состояние, запускает L0-анализ, открывает окно совместимости и передает управление в готовый сборочный движок.
---
## 8. Схема потоков данных
```mermaid
sequenceDiagram
autonumber
actor User as Пользователь
participant UI as ModulesPage (Catalog Tab)
participant IPC as Tauri IPC (lib.rs)
participant Cat as CatalogueFetcher (crates/coa-core)
participant CDN as azerothcore.org (Cloudflare CDN)
participant Analyzer as analyzer.rs (Intake & L0)
participant Builder as build_engine.rs (MSVC)
participant Installer as preview.rs & plugins.rs
User->>UI: Переход во вкладку "Каталог"
UI->>IPC: get_public_module_catalog(force_refresh=false)
IPC->>Cat: get_catalogue(cache_dir)
alt Кэш отсутствует или устарел
Cat->>CDN: GET /data/catalogue.json (If-None-Match: etag)
CDN-->>Cat: 200 OK (804 KB JSON)
Cat->>Cat: Сохранение cache.json и etag.txt
else Кэш актуален
Cat->>CDN: GET /data/catalogue.json
CDN-->>Cat: 304 Not Modified
end
Cat->>Cat: Слияние с coa-modules-overlay.json
Cat-->>UI: CatalogueResponse (545 модулей)
UI-->>User: Отображение каталога с поиском и бейджами CoA
User->>UI: Клик "Анализировать и установить" (выбран mod-aoe-loot)
UI->>IPC: analyze_github_module(url, realm_id)
IPC->>Analyzer: analyze_github_module_for_realm()
Analyzer->>Analyzer: Git intake, AST аудит, проверка Add...Scripts, SQL аудит
Analyzer-->>UI: CompatibilityReport (L0 PASS, Buildable)
UI-->>User: Модальное окно аудита совместимости
User->>UI: Клик "Собрать DLL"
UI->>IPC: preview_build_module(realm_id, url)
IPC->>Builder: build_module_from_source()
Builder->>Builder: Генерация adapter.cpp, компиляция MSVC + Ninja
Builder-->>UI: BuildResult (Success, DLL SHA-256)
User->>UI: Клик "Установить в сервер"
UI->>IPC: preview_install_module(realm_id, module_id, ver, apply_sql)
IPC->>Installer: install_qualified_module()
Installer->>Installer: Stop-Gate check, копирование DLL, plugins.json
Installer-->>UI: PreviewInstallResult (Success)
UI-->>User: Модуль активен в сервере!
```
---
## 9. Модель кэширования и обновления
1. **Заголовки ETag / Conditional Requests:**
Сервер `azerothcore.org` возвращает стандартный HTTP заголовок `ETag: "88aa9d..."`. При повторном запросе CSM отправляет `If-None-Match`. Получение `304 Not Modified` полностью исключает передачу 800 КБ по сети.
2. **Дисковый кэш:**
Кэш сохраняется в `%LOCALAPPDATA%\CSMModulesPreview\catalogue\cache.json`.
3. **Оффлайн-режим:**
Если подключение к сети отсутствует (NetworkUnreachable, DNS failure), клиент не выдает ошибку, а прозрачно возвращает сохранённый `cache.json` с флагом `is_offline = true`.
4. **Защита от повреждений:**
Запись файла кэша производится атомарно через временный файл (`fsx::atomic_write`). При повреждении JSON кэш отбрасывается, и используется встроенный в бинарник минимальный снапшот.
5. **Дедупликация и переименования:**
Естественным ключом в каталоге является числовой `id` репозитория GitHub. При переименовании репозитория `id` сохраняется, обновляется только поле `full_name`.
---
## 10. Интеграция с анализатором совместимости
Каталог и существующий анализатор [crates/coa-core/src/analyzer.rs](file:///C:/games/coa-server-manager-preview/crates/coa-core/src/analyzer.rs) работают в синергии:
- **В каталоге (до выбора):** пользователь видит метаданные GitHub (звезды, дату обновления) + кураторский статус CoA (`Verified`, `Incompatible`, `Unverified`).
- **После выбора модуля:** запускается глубокий анализ `analyze_github_module_for_realm`:
1. Вычисляется точный хэш исходного кода (`.coa_tree_digest`).
2. Проверяется наличие экспортов ядра через PE-парсинг `worldserver.exe` (`parse_pe_exports`).
3. Проверяется совпадение ABI-фингерпринта.
4. Проверяется канонический загрузчик `Add<module_name>Scripts()`.
5. Проводится аудит SQL-миграций на наличие `CREATE/ALTER TABLE`.
6. Формируется отчет `CompatibilityReport` с многомерным статусом (`BuildStatus`, `RuntimeStatus`, `GameplayStatus`).
Таким образом, публичный каталог выступает **витриной обнаружения**, а существующий анализатор Modules V2 — **воротами допуска**.
---
## 11. План тестирования (Интеграционная матрица)
| № | Тестовый сценарий | Ожидаемый результат | Метод проверки |
|---|---|---|---|
| 1 | Загрузка каталога онлайн | Загружено 545 модулей, статус 200 OK, сохранен кэш и ETag | Unit-тест `test_catalogue_fetch_online` с mock-сервером |
| 2 | Повторная загрузка с валидным ETag | Сервер отвечает 304 Not Modified, данные берутся из локального кэша | Mock HTTP тест с проверкой заголовка `If-None-Match` |
| 3 | Загрузка в оффлайн-режиме | Возвращаются данные из `cache.json`, флаг `is_offline == true` | Тест с отключенным сетевым адаптером / mock network error |
| 4 | Поврежденный кэш на диске | Ошибка перехватывается, загружается резервный снапшот, приложение не падает | Повреждение файла `cache.json` битыми байтами |
| 5 | Дедупликация репозиториев | В списке отсутствуют дублирующиеся ID репозиториев | Проверка `Set<id>.len() == list.len()` |
| 6 | Распознавание установленных модулей | Модуль, установленный в сервере, помечается в каталоге бейджем `Установлен` | Сверка `repo` каталога со списком `list_installed_preview_plugins` |
| 7 | Передача URL в `runAnalysis` | При клике по модулю поле `githubUrl` заполняется корректным URL, стартует L0-анализ | Проверка аргументов вызова `api.analyzeGithubModule` |
| 8 | Сохранение ручного ввода URL | Поле ввода произвольного GitHub URL продолжает функционировать | Ручной ввод `https://github.com/custom/repo` и запуск анализа |
| 9 | Передача данных в анализатор | Анализатор получает URL, загружает репозиторий и возвращает `CompatibilityReport` | Прогон анализатора на модуле `mod-aoe-loot` |
| 10 | Ворота безопасности (Stop-Gate) | Попытка установить модуль при работающем `worldserver.exe` блокируется | Интеграционный тест `require_server_stopped` |
| 11 | Отображение ошибок сборки | При ошибке компиляции в логах MSVC пользователь видит подсказку в UI | Сборка заведомо битого C++ модуля |
| 12 | Предупреждение о конфликтах CoA | Модуль `mod-learn-spells` отображает предупреждение о конфликте с драфтом | Проверка поля `coa_status == "incompatible"` |
| 13 | Фиксация версий установленных модулей | Обновление каталога не затрагивает скомпилированные DLL в `.manager/plugins/` | Сравнение хэшей DLL до и после обновления каталога |
| 14 | Производительность UI | Рендеринг 545 карточек с виртуализацией или пагинацией не вызывает фризов UI | React Profiler тест рендеринга страницы |
---
## 12. Риски и потенциальные регрессии
| Риск | Вероятность | Влияние | Мера предотвращения |
|---|---|---|---|
| **Регрессия существующего ручного ввода URL** | Низкая | Высокое | Ручной ввод GitHub URL остается в интерфейсе как приоритетный альтернативный способ; каталог только передает URL в ту же функцию `runAnalysis`. |
| **Падение UI при рендеринге 500+ элементов** | Средняя | Среднее | Использование поиска/фильтрации на клиенте с лимитом отображения (пагинация по 24 карточки или виртуальный скроллинг). |
| **Изменение формата JSON официального каталога AC** | Низкая | Среднее | Использование `serde(default)` для всех необязательных полей; строгие fallback-значения при отсутствии полей. |
| **Ложная уверенность пользователя в совместимости** | Высокая | Высокое | Яркие бейджи: статус `Unverified Public` для всех сторонних модулей из каталога до прохождения L0–L5 тестов. |
| **Блокировка сервером CDN (HTTP 429)** | Минимальная | Низкое | Запросы отправляются только раз в 12–24 часа или по явному клику пользователя «Обновить»; наличие оффлайн-кэша. |
---
## 13. План реализации небольшими независимыми этапами
### Этап 1: Backend & Сетевой кэш (Бэкенд-сервис каталога)
- Создать `crates/coa-core/src/catalogue.rs`.
- Реализовать загрузку `https://www.azerothcore.org/data/catalogue.json` с поддержкой ETag.
- Реализовать чтение локального файла `coa-modules-overlay.json` и слияние статусов.
- Написать модульные тесты парсинга и кэширования.
- *Результат:* Автономный протестированный Rust-модуль, готовый к вызову из Tauri.
### Этап 2: Tauri IPC Bridge & Frontend API
- Зарегистрировать команду `get_public_module_catalog` в `src-tauri/src/lib.rs`.
- Добавить типизированный метод в `src/lib/api.ts`.
- *Результат:* Фронтенд может запрашивать актуальный список модулей одной асинхронной функцией.
### Этап 3: UI интеграция в `ModulesPage.tsx`
- Во вкладке `catalog` заменить хардкод `VERIFIED_CATALOG` на динамическую загрузку через `api.getPublicModuleCatalog()`.
- Добавить строку поиска, фильтры категорий и селектор сортировки.
- Привязать кнопку действия карточки модуля к существующей функции `runAnalysis(module.html_url)`.
- *Результат:* Пользователь выбирает любой модуль из официального каталога AzerothCore и запускает штатный процесс анализа и сборки Modules V2 в один клик.
---
## 14. Сводная таблица компонентов
| Компонент | Уже существует | Требуется изменить | Новый компонент | Описание и роль |
|---|---|---|---|---|
| **GitHub downloader** | `analyzer.rs` (`analyze_github_repository`) | **НЕ МЕНЯТЬ** | Нет | Клонирует и кэширует исходники репозитория в `%LOCALAPPDATA%\CSMModulesPreview\github_cache`. Полностью готов. |
| **Compatibility analyzer** | `analyzer.rs` (`analyze_github_module_for_realm`) | **НЕ МЕНЯТЬ** | Нет | Выполняет L0 Static Audit, проверяет хуки, сигнатуру `Add...Scripts`, структуру SQL и лицензии. Полностью готов. |
| **Module builder** | `build_engine.rs` (`build_module_from_source`) | **НЕ МЕНЯТЬ** | Нет | Генерирует C++ адаптер `IPlugin`, компилирует MSVC x64 + Ninja против CoA SDK v0.3. Полностью готов. |
| **Module installer** | `preview.rs` (`install_qualified_module`) & `plugins.rs` | **НЕ МЕНЯТЬ** | Нет | Контролирует Stop-Gate, SQL Review Gate, копирует DLL в `.manager/plugin-store/`, прописывает в `plugins.json`. Полностью готов. |
| **Module registry** | `.manager/plugins.json` (`plugins.rs`) | **НЕ МЕНЯТЬ** | Нет | Авторитетный реестр установленных плагинов realm'а. Полностью готов. |
| **Module Catalogue Fetcher** | Нет | Нет | **ДА (`catalogue.rs`)** | Скачивает официальный JSON с CDN AzerothCore с ETag-кэшированием и оверлеем CoA. Новый легковесный компонент. |
| **Modules UI** | `ModulesPage.tsx` | **Минимально расширить** | Нет | В существующую вкладку `catalog` добавляется вызов `getPublicModuleCatalog()` и связка с `runAnalysis()`. Без переписывания UI. |
---
## 15. Анализ различий веток: `master` vs `preview/modules-v2`
| Характеристика / Возможность | Состояние в `master` (предыдущий аудит) | Состояние в `preview/modules-v2` (целевая ветка) | Влияние на план интеграции |
|---|---|---|---|
| **Модель модулей** | Только монолитная компиляция в `worldserver.exe` | **Полноценная архитектура динамических DLL плагинов** | Отпала необходимость проектировать систему сборки и загрузки модулей. |
| **Сборочный движок** | Отсутствовал в коде CSM | **Реализован в `build_engine.rs` (MSVC + Ninja + Adapter Gen)** | Сборщик уже написан, отлажен и квалифицирован на тестовой когорте T01–T04. |
| **Анализатор совместимости** | Базовые заготовки | **Мощный модуль `analyzer.rs` (2445 строк, L0–L6 верификация)** | Анализатор готов к приему любого репозитория из каталога. |
| **Установщик и транзакции** | Только текстовая правка `.conf` файлов | **Транзакционный установщик в `preview.rs` со Stop-Gate и SQL Review** | Установщик готов и защищает сервер от крашей на лету. |
| **Интерфейс управления** | Простой список из 9 карточек | **4-вкладочный интерфейс `ModulesPage.tsx` (2737 строк)** | Интерфейс готов: нужно лишь заменить статический каталог на динамический. |
| **Каталог модулей** | Статический `modules/catalog.json` (9 шт.) | Статический `VERIFIED_CATALOG` в TypeScript (8 шт.) | **Единственная недостающая часть — подключение официального JSON к каталогу.** |
---
## 16. Главный вопрос и итоговый вердикт
### Главный вопрос:
*Как добавить официальный публичный каталог AzerothCore в уже работающую систему Modules V2 с минимальными изменениями, без дублирования существующей логики и без регрессий установки модулей?*
### Итоговый технический вердикт:
1. **Готова ли Modules V2 к подключению каталога?**
**Да, на 100%.** Архитектура ветки `preview/modules-v2` находится в состоянии полной готовности: вся сквозная цепочка (`Intake URL -> Analyze -> Build DLL -> Review SQL -> Install -> Toggle -> Remove`) уже функционирует и протестирована. Каталог нужен исключительно как поставщик URL для этой цепочки.
2. **Сколько новых компонентов действительно необходимо?**
**Ровно один новый модуль на Backend:** `crates/coa-core/src/catalogue.rs` (~200 строк чистого кода на Rust) для загрузки `https://www.azerothcore.org/data/catalogue.json` с ETag-кэшированием и наложением кураторских статусов CoA.
3. **Какие существующие функции будут переиспользованы?**
- `analyze_github_module_for_realm` ([analyzer.rs](file:///C:/games/coa-server-manager-preview/crates/coa-core/src/analyzer.rs)) — для глубокого аудита выбранного модуля.
- `build_module_from_source` ([build_engine.rs](file:///C:/games/coa-server-manager-preview/crates/coa-core/src/build_engine.rs)) — для компиляции выбранного модуля в DLL.
- `install_qualified_module` ([preview.rs](file:///C:/games/coa-server-manager-preview/crates/coa-core/src/preview.rs)) — для безопасной установки плагина.
- `runAnalysis` ([ModulesPage.tsx](file:///C:/games/coa-server-manager-preview/src/screens/ModulesPage.tsx)) — как готовая точка запуска пайплайна по клику в UI.
4. **Есть ли архитектурные препятствия?**
**Архитектурных препятствий нет.** Никаких конфликтов зависимостей, ограничений по типам данных или блокеров в дизайне Modules V2 не обнаружено.
5. **Какой минимальный безопасный объём изменений требуется для первого рабочего релиза?**
1. Добавить `crates/coa-core/src/catalogue.rs` (загрузка JSON и дисковый кэш).
2. Зарегистрировать IPC-команду `get_public_module_catalog` в `src-tauri/src/lib.rs`.
3. В `src/screens/ModulesPage.tsx` заменить хардкод `VERIFIED_CATALOG` на рендеринг списка из API и вызов `runAnalysis(module.html_url)` при клике.
*Все остальные механизмы Modules V2 остаются нетронутыми.*
-56
View File
@@ -1,39 +1,5 @@
# TODO
## Подготовка 0.9.8, 2026-10-31
- Подготовлены исходники `C:/games/source/per-race-manager`, ветка `fix/launcher-validation-candidate-20261031`: изоляция bot configs на время проверки с точным восстановлением, повторное использование MySQL внутри validation, зависимость Dungeon Clear от SQUID, три режима логов и экспорт этапов launcher/control owner.
- Workspace: 840 тестов прошли, 60 ignored; последующие focused diagnostics: 11 прошли. Переводы новых заметок и UI подготовлены, web build/i18n/bridge/history checks прошли. Подробности и ограничения: `C:/games/source/candidate-preparation-20261031.md`.
- Не выпускать Manager до кандидата сервера. Installer ещё не собирался и не публиковался; подготовка источников не равна готовому кандидату.
## Приоритет: проверка установки и обновления (2026-10-31)
- **Локальные замеры массовых Companions (2026-10-31):** отчёт `C:/games/source/companions-benchmark-20261031/REPORT.md`, сырые выборки/qualification в той же папке. Native worldserver SHA `bd9f65ac7543fad8159231000d5ef6436a159aa009b65cbdc9541a0e9fe1ee7b`, Ryzen 7 7700X/32 GiB, `MapUpdate.Threads=1`, все CPU доступны. Перед условиями восстанавливался один снимок персонажей. Без записи логов медианы среднего тика: 0 ботов 4.5 ms; 500 — 39 ms; 1000 — 91 ms; 2000 — 246 ms, поздний замер 259 ms. С обычными логами: 500 — 43.5 ms; 1000 — 111 ms. Запуск 2000 с логами дал 1381 ms, последующий полный Logger-off 363 ms, но нагрузка хоста менялась; чистый множитель логирования этими числами не доказан. Всего 9 условий с подтверждённым online; исходная база 21 шаблон/0 тестовых аккаунтов восстановлена, тестовые процессы остановлены. Повтор 2000 с логами подготовлен, но НЕ выполнен: на C: осталось около 300 MiB. Соответствующий PDB для функционального профиля отсутствует.
- [ ] **Разобрать штатное завершение мира под большой популяцией**:
- В локальном бенчмарке ряд запусков (включая 2000 ботов и полностью отключённые логгеры) не завершились за 90 секунд после `server shutdown 1s 0`; пришлось завершать только тестовый процесс после сохранения измерений. Стек `2000-shutdown-stacks.txt` показывает ожидание `MSVCP140!Thrd_join`, точный ожидаемый поток без matching PDB не установлен. Не объявлять это доказанной причиной пользовательского control.lock или влиянием только логов.
- [ ] **Разобрать удержание control.lock после видимого запуска сервера**:
- Пользователь после hotfix v3 получил `Another start/stop action is in progress` при внешнем `with launcher["control_lock"]()`, хотя мир отвечал и Manager показывал работающий сервер. Не считать это доказательством «зависшего файла»: Windows блокирует диапазон живым дескриптором.
- На Python 3.14.7 точно воспроизведён конкурентный захват: второй лаунчер получает эту ошибку, после выхода владельца захват снова проходит. Причина долгого удержания у пользователя пока не установлена; нужны его свежие launch diagnostics.
- Добавить безопасную диагностику владельца (PID, время создания, действие, этап ожидания) и проверить сериализацию Start/Stop/Restart/validation/recovery. Различать реальную занятость и прочие OSError захвата, которые сейчас маскируются одним сообщением. Не удалять lock и не завершать чужие процессы ради обхода.
- **Проверка с ботами завершена (2026-10-31):** пользователь показал работающие MySQL/auth/world, 2000 Companions онлайн и вход своим клиентом в мир после обновления. Это подтверждает обычный запуск с ботами после hotfix, но не пригодность массового автологина для validation. Ранний снимок показывает около 11 тиков/с на 2m32s работы; результат замера после прогрева пока неизвестен.
- **Пользовательская проверка (2026-10-31):** после hotfix лаунчера v3 и отключения автологина Companions обновление завершилось успешно (server `0.261030.90`, Manager `0.9.7`). Отдельная проверка с включёнными ботами пока не завершена.
- [ ] **Сократить повторные запуски MySQL в установке/обновлении**:
- Пользователь после успешного обновления отметил большую длительность и многократные старты/остановки базы, в том числе на 85%. Проследить фактическую последовательность snapshot/SQL/schema/validation/recovery и повторно использовать уже запущенную, проверенную базу между совместимыми этапами.
- Не убирать остановки, необходимые для согласованного backup/restore, замены файлов и восстановления после отказа. Сохранить гарантии rollback и владения процессами. Записать число стартов/остановок и длительность этапов до/после; проверить обновление без ботов и восстановление после ошибки.
- [ ] **Временный конфиг проверки без массового запуска ботов**:
- Запрос владельца: грузить 2000 ботов ради проверки установки/обновления недопустимо. Облегчить все проверочные запуски, включая восстановление/повторную проверку, где применяется тот же путь запуска.
- Факты случая: этап обновления 85%, CoA Companions поставили в очередь 2000 ботов; пользователь сообщает об остановке продвижения на 519 за 6 минут. Логи показывают 518 уникальных имён в `ACTIVE_LIST`. Это не SQUID. Место зависания и причинная связь с автологином пока не установлены.
- Перед проверочным запуском временно отключать `CoaBots.AutoLoginOnStartup` и проверить другие пути автоматического входа/создания/заселения Companions, включая `CoaBots.RandomSpawn.AutoLogin`. Аналогично подавлять автоматическое заселение SQUID, если выбран этот модуль. Не подменять пользовательский выбор системы ботов и не отключать модуль целиком вместо проверки его инициализации.
- Сохранять исходные байты/отсутствие изменяемых конфигов в журнале восстановления; вернуть их до обычного запуска как при успехе, так и при ошибке, отмене, rollback и восстановлении после прерывания Manager. Не оставлять автологин выключенным пользователю. Проверить primary и дополнительные realms.
- Проверка должна подтверждать инициализацию ядра/выбранных модулей, SQL/schema, сервисы и отклик управляющего интерфейса; не ждать заполнения мира ботами и не создавать для этого тысячи персонажей. Вне validation обычный запуск сохраняет поведение пользовательских настроек.
- Проверить сценарии с Companions и лимитом 2000, SQUID, выключенными ботами; успех, отказ запуска, прерывание и восстановление исходных конфигов. Добавить регрессионные проверки и changelog после реализации.
- [ ] **Доставить исправление `manage.py` для PID 0 в согласованном серверном обновлении**:
- Серверная задача и готовый локальный hotfix описаны в `C:/games/coa-server-build/TODO.md`. Проверить импортируемый запуск через `runpy`/внешний вызов `main()` и штатный Manager update; диагностика должна работать при обоих способах загрузки.
## UI / UX
- [x] **Предупреждение о несохранённых изменениях при переходе между вкладками (Unsaved Changes Guard / Modal)**:
- Если у пользователя есть несохранённые изменения в настройках (`ModulesPage`, `SettingsPage` — сервер, боты и др.) и он переходит на другую вкладку (в боковом меню `Shell.tsx` или кнопками навигации), показывать pop-up диалог подтверждения.
@@ -61,25 +27,3 @@
4. Анализировать последние строки `Core/Logs/Server.log` и `Errors.log` на критические маркеры (потеря соединения с MySQL, нехватка RAM/OOM, ошибка бинда портов).
5. Проверять по встроенному словарю известных сигнатур (паттерны частых крашей с понятным описанием, например: «Сбой удаления объекта из сетки карты», «Ошибка запроса к базе данных», «Нехватка оперативной памяти»).
- *Fallback:* Если сигнатура не опознана в словаре известных проблем, показывать краткую техническую выжимку (код исключения + сработавший ассерт или вершина Call Stack) и кнопку разворота полного текста крашлога / копирования.
## Модули и контент
- [ ] **Следующий билд: переключатель Dungeon Clear только для SQUID** (запрос владельца 2026-10-31):
- Модуль: https://github.com/Zyth45/mod-dungeon-clear, ветка `coa`; серверная интеграция описана в `C:/games/coa-server-build/TODO.md`.
- Добавить в каталог отдельный модуль Dungeon Clear, по умолчанию выключенный. На старых серверах без модуля показывать недоступным.
- Разрешать включение только при установленном и включённом SQUID (`playerbots`). При выключенном SQUID блокировать переключатель и объяснять причину; CoA Companions не подходят.
- Проверять зависимость также в Rust backend при изменении модуля и его настроек. Отключение SQUID/переход на Companions отключает Dungeon Clear; обратное включение SQUID не включает Dungeon Clear автоматически.
- Проверить сохранение после перезапуска, ручные конфиги и отказ включения через API в обход UI. Серверный guard обязателен независимо от Manager.
- Все новые UI-тексты — на шести языках. После реализации добавить changelog fragments в соответствующие компоненты; пока это запланированная, не выпущенная возможность.
- [ ] **Внедрение модуля гильдхаусов (`mod-guildhouse`)**:
- **Репозиторий:** `https://github.com/azerothcore/mod-guildhouse`
- **Пайплайн сборки (`coa-server-build`):**
- Добавить checkout модуля в `.github/workflows/server-binaries.yml`, `build.yml` и `build-linux.yml` в директорию `modules/mod-guildhouse`.
- Добавить лицензию модуля и копирование в `scripts/assemble-tree.ps1` (`Licenses/` и `NOTICE.txt`).
- **Адаптация под Conquest of Azeroth (CoA):**
- В диалоге дворецкого (`mod_guildhouse_butler.cpp`) вместо 10 классических тренеров WotLK спавнить **Book of Ascension** (entry `499992`), которая открывает интерфейс `mod-spellbook` и заменяет всех тренеров для кастомных классов и прогрессии способностей.
- Оставить без изменений: профессии, порталы в столицы, банк, аукционы (включая нейтральный), почту, вендоров, парикмахера, горн и наковальню.
- **База данных:**
- Миграции модуля (`guild_house`, `guild_house_spawns`, `creature_template`, `gameobject_template`, `mod_guildhouse_locale`) подхватываются `coa-release` автоматически при валидации схемы контракта.
- **В игре:**
- Разместить NPC-продавца гильдхаусов (`.npc add 500030`) в ключевых хабах / столицах (Штормград, Оргриммар, Даларан).
+7247
View File
File diff suppressed because it is too large. Load diff
@@ -0,0 +1,7 @@
---
area: manager
type: fixed
audience: admins
title: Custom Races patch installation recovers from interrupted downloads
---
Unfinished downloads resume automatically. Invalid archives in Downloads are skipped without changing them, and damaged cached archives are downloaded again.
@@ -1,7 +0,0 @@
---
area: manager
type: added
audience: admins
title: Install the compiler for modules from the Manager
---
When the C++ compiler that modules need is missing or differs from the one the core was built with, the Toolchain tab offers to install Visual Studio Build Tools with MSVC 14.44. The Manager downloads Microsoft's installer, checks that Microsoft signed it and opens it with the needed components selected; you accept Microsoft's terms there.
@@ -1,7 +0,0 @@
---
area: manager
type: added
audience: admins
title: Modules are rebuilt automatically after a core update
---
After the core is updated, the Manager rebuilds every enabled module for the new core before the first start, or reuses a build it already has. A module that cannot be rebuilt is switched off with the reason shown, and the core update still goes ahead. Rolling back the core puts the earlier module builds back.
@@ -1,7 +0,0 @@
---
area: manager
type: added
audience: admins
title: The Modules Preview follows its own signed update channel
---
The Modules Preview Manager gets server updates from a separate preview channel, signed with a key of its own, and falls back to the stable channel until the first preview release exists. A stable Manager never accepts preview packages.
@@ -1,7 +0,0 @@
---
area: manager
type: added
audience: admins
title: Moving to a core with modules installs the modules you used
---
When a server moves to a core that loads Content Scaling, Companions or SQUID's Playerbots as modules, the Manager downloads them at the versions the core names, builds them and switches them on before the first start. Bots follow what the server used before: SQUID's Playerbots if it was switched on, otherwise Companions. A module you remove later is not installed again.
@@ -0,0 +1,7 @@
---
area: manager
type: added
audience: admins
title: Settings for how much help bots get in dungeons and raids
---
Bot damage, healing, damage taken and tank threat can now be tuned under Bots, Combat. Everything defaults to 1 (no change); a switch turns the extra help for four hard bosses on.
+7
View File
@@ -0,0 +1,7 @@
---
area: manager
type: added
audience: players
title: Install community addons from the Manager
---
The game client card lists SquidBots Lite, DragonUI, IncahootsCoA and CoACombat. Each comes from its author's GitHub at a pinned version, every file is checked before it goes into Interface/AddOns, and the Manager updates or removes only what it installed.
+7
View File
@@ -0,0 +1,7 @@
---
area: manager
type: added
audience: players
title: Old item and creature data is cleared before every Play
---
After a server update the game showed old names and stats from its own cache (Cache/WDB). Play now clears that cache first; it fills again within seconds. A switch next to the client graphics settings turns it off.
@@ -0,0 +1,7 @@
---
area: manager
type: fixed
audience: players
title: Turning the custom races client patch on or off takes seconds again
---
V2 has over 7,000 files and switching it could run for many minutes. Now only the files the game itself loads are hidden, and the rest stays in place. A switch that was cut short is undone safely.
@@ -0,0 +1,7 @@
---
area: manager
type: changed
audience: players
title: The custom races client is updated to Custom Races V2
---
The client update installs V2 and starts its own CoACustomRace.exe; Ascension.exe is left as it was. Four archives are the same as in 1.9.2, so a game folder that already had 1.9.2 downloads only the rest.
@@ -0,0 +1,7 @@
---
area: manager
type: fixed
audience: admins
title: The database moves to a free port when Windows reserves or another program takes 3307
---
Hyper-V, WSL and Docker can reserve a range that includes the database port; the start then waited 30 seconds and failed. The database now picks a free port and records it, and a reserved game port is named as such at once.
@@ -0,0 +1,7 @@
---
area: manager
type: added
audience: admins
title: Your own MySQL settings survive restarts and updates
---
Settings, Service has a MySQL settings box. Its options are added to my.ini at every start of the database; before, my.ini was rewritten and hand edits were lost. Port, addresses and data paths stay managed.
@@ -0,0 +1,7 @@
---
area: manager
type: fixed
audience: admins
title: Disabled custom races stay disabled after a server update that adds races
---
A race list saved before Custom Races V2 no longer matched V2's race catalog, and the server then ignored it and turned custom races off. Before a start the Manager now keeps the list when every disabled race kept its ID and name.
+7
View File
@@ -0,0 +1,7 @@
---
area: manager
type: added
audience: admins
title: Rename your realms in the Manager
---
Settings, Startup has a name for every realm. A running server shows it at once, the game client picks it on the next Play, and it stays after restarts and updates. Before, the launcher wrote the default name back at every start.
@@ -0,0 +1,7 @@
---
area: manager
type: fixed
audience: players
title: The account for a friend's server is in the login box at every Play
---
The account the Manager made on a listed server was filled in only when joining. Play now fills it in every time, also after another server's account was used.
@@ -0,0 +1,7 @@
---
area: manager
type: added
audience: admins
title: Restart the world every day at a chosen time
---
Settings, Startup, Scheduled restart: at that local time the world restarts with an in-game countdown and comes back by itself; the database keeps running. It works without the Manager open and needs a server with the new launcher.
@@ -0,0 +1,7 @@
---
area: manager
type: added
audience: admins
title: Switches for the Custom Races V2 subclasses, Hero Races and the /dev menu
---
The Custom Races settings now hold Subclasses and Hero Races (subclasses, the Thin Twins, the Two-Headed Ogre, two players per character) and the GM /dev menu, each with its own switch.
@@ -0,0 +1,7 @@
---
area: manager
type: added
audience: admins
title: Companion bots on Wildcard and Warcraft Reborn
---
With a server build that supports it, Companions can be switched on for Wildcard and Warcraft Reborn: bots get whole Wildcard archetypes or Reborn abilities by level, and bot creation survives a crash without duplicates.
@@ -0,0 +1,7 @@
---
area: manager
type: added
audience: admins
title: The Custom Races card tells which characters stay out while races are off
---
With custom races off, the card shows how many player characters and bots of custom races cannot enter the world, and offers to delete the companion bots of those races.
+37 -1
View File
@@ -172,10 +172,13 @@
"Corfirean/coa-server-manager:20261030-window-lifecycle.md",
"Corfirean/coa-server-manager:20261031-dungeon-clear-dependency.md",
"Corfirean/coa-server-manager:20261031-launcher-diagnostics-export.md",
"Corfirean/coa-server-manager:20261031-recover-client-patch-downloads.md",
"Corfirean/coa-server-manager:20261031-server-logging-controls.md",
"Corfirean/coa-server-manager:20261031-validation-bot-population.md",
"Corfirean/coa-server-manager:20261031-validation-mysql-reuse.md",
"Corfirean/coa-server-manager:20261103-isolated-login-port.md"
"Corfirean/coa-server-manager:20261103-isolated-login-port.md",
"Corfirean/coa-server-manager:20261107-bot-strength-scaling-settings.md",
"Corfirean/coa-server-manager:20261115-custom-races-v2-client.md"
],
"releases": [
{
@@ -900,6 +903,39 @@
],
"commit": "173248efbe24da9b4c1b5ca12fa7580fcd1e8ea7",
"compare": "https://github.com/Corfirean/coa-server-manager/compare/v0.9.8...v0.9.9"
},
{
"tag": "v0.9.10",
"version": "0.9.10",
"date": "2026-11-08",
"url": "https://github.com/Corfirean/coa-server-manager/releases/tag/v0.9.10",
"notes": [
"Custom Races patch installation recovers from interrupted downloads"
],
"commit": "711f378ae82f75d3fc64368c042889c773315c54",
"compare": "https://github.com/Corfirean/coa-server-manager/compare/v0.9.9...v0.9.10"
},
{
"tag": "v0.9.12",
"version": "0.9.12",
"date": "2026-11-14",
"url": "https://github.com/Corfirean/coa-server-manager/releases/tag/v0.9.12",
"notes": [
"Settings for how much help bots get in dungeons and raids"
],
"commit": "d71c5635e3262a775b400a1c90ac81d7bddcbeaf",
"compare": "https://github.com/Corfirean/coa-server-manager/compare/v0.9.10...v0.9.12"
},
{
"tag": "v0.9.13",
"version": "0.9.13",
"date": "2026-11-15",
"url": "https://github.com/Corfirean/coa-server-manager/releases/tag/v0.9.13",
"notes": [
"The custom races client is updated to Custom Races V2"
],
"commit": "d3527312803fb5a3e1cd48e01496645a8bbc9dcf",
"compare": "https://github.com/Corfirean/coa-server-manager/compare/v0.9.12...v0.9.13"
}
]
}
+2 -1
View File
@@ -5,6 +5,7 @@ edition.workspace = true
license.workspace = true
[dependencies]
socket2 = "0.6"
serde = { version = "1", features = ["derive"] }
serde_json = "1"
sha2 = "0.10"
@@ -37,7 +38,7 @@ rand_core = { version = "0.6", features = ["getrandom"] }
ed25519-dalek = { version = "2", features = ["rand_core"] }
[target.'cfg(windows)'.dependencies]
windows-sys = { version = "0.60", features = ["Win32_Foundation", "Win32_Storage_FileSystem", "Win32_System_Threading", "Win32_System_SystemInformation", "Win32_System_Diagnostics_ToolHelp", "Win32_NetworkManagement_IpHelper", "Win32_Networking_WinSock", "Win32_Security_Cryptography", "Win32_UI_Shell", "Win32_System_Registry", "Win32_UI_WindowsAndMessaging"] }
windows-sys = { version = "0.60", features = ["Win32_Foundation", "Win32_Storage_FileSystem", "Win32_System_Threading", "Win32_System_Console", "Win32_System_SystemInformation", "Win32_System_Diagnostics_ToolHelp", "Win32_NetworkManagement_IpHelper", "Win32_Networking_WinSock", "Win32_Security_Cryptography", "Win32_UI_Shell", "Win32_System_Registry", "Win32_UI_WindowsAndMessaging"] }
[features]
testkit = []
+114
View File
@@ -0,0 +1,114 @@
//! The Rust launcher on a DISPOSABLE repack, side by side with Scripts/manage.py:
//!
//! 1. install the stable server into a new folder on unused ports;
//! 2. coa-launcher start-all, then manage.py status-json must see every service;
//! 3. manage.py stop-all stops what coa-launcher started;
//! 4. manage.py start-all, coa-launcher status-json sees it, coa-launcher stop-all stops it;
//! 5. both stop-alls leave nothing of the repack running.
//!
//! usage: launcher_e2e <new folder ending in -fixture> <coa-launcher.exe>
use std::path::Path;
use std::process::Command;
use coa_core::install::{install_base, Params};
use coa_core::registry::Registry;
fn free_port() -> u16 {
std::net::TcpListener::bind("127.0.0.1:0").unwrap().local_addr().unwrap().port()
}
fn run(exe: &Path, args: &[&str]) -> (bool, String) {
let out = Command::new(exe).args(args).output().unwrap();
let text = String::from_utf8_lossy(&out.stdout).into_owned() + &String::from_utf8_lossy(&out.stderr);
(out.status.success(), text)
}
fn launcher(root: &Path, exe: &Path, action: &str) -> (bool, String) {
let r = root.to_string_lossy().into_owned();
let t = std::time::Instant::now();
let out = run(exe, &["--root", &r, action]);
println!("[coa-launcher {action}] ok={} in {:?}\n{}", out.0, t.elapsed(), indent(&out.1));
out
}
fn manage(root: &Path, action: &str) -> (bool, String) {
let python = root.join("Runtime/python/python.exe");
let script = root.join("Scripts/manage.py").to_string_lossy().into_owned();
let t = std::time::Instant::now();
let out = run(&python, &["-B", &script, action]);
println!("[manage.py {action}] ok={} in {:?}\n{}", out.0, t.elapsed(), indent(&out.1));
out
}
fn indent(s: &str) -> String {
s.lines().map(|l| format!(" {l}")).collect::<Vec<_>>().join("\n")
}
fn status(out: &str) -> serde_json::Value {
let line = out.lines().rev().find(|l| l.trim_start().starts_with('{')).expect("a JSON status line");
serde_json::from_str(line).unwrap()
}
fn all(v: &serde_json::Value, running: bool) -> bool {
["mysql", "auth", "world", "relay"].iter().all(|k| v[*k] == running)
}
fn main() {
let a: Vec<String> = std::env::args().skip(1).collect();
let root = Path::new(&a[0]);
let exe = Path::new(&a[1]);
assert!(a[0].ends_with("-fixture"), "a folder ending in -fixture is required");
if root.join("Core/worldserver.exe").is_file() {
println!("reusing the installed fixture");
} else {
install(root);
}
test(root, exe);
}
fn install(root: &Path) {
assert!(!root.exists(), "a new folder is required");
let reg_dir = std::env::temp_dir().join("coa-launcher-e2e-registry");
let _ = std::fs::remove_dir_all(&reg_dir);
let reg = Registry::at(reg_dir.join("installs.json"));
// what the Manager installs: the stable release's installation image
let image = coa_core::install::Source::Installation(Box::new(coa_core::channels::resolve("stable").expect("stable channel")));
let installed = install_base(
&Params { source: image, dest: root.into(), trusted_key: coa_core::signing::EMBEDDED_PUBLIC_KEY, registry: &reg, cancel: Default::default() },
&|s| eprintln!(" {:>3}% {}", s.percent, s.step),
)
.expect("install");
println!("installed {}", installed.version);
let repack = root.join("Settings/repack.json");
let mut cfg: serde_json::Value = serde_json::from_slice(&std::fs::read(&repack).unwrap()).unwrap();
for k in ["mysqlPort", "authPort", "worldPort", "raPort"] {
cfg[k] = free_port().into();
}
std::fs::write(&repack, serde_json::to_vec_pretty(&cfg).unwrap()).unwrap();
}
fn test(root: &Path, exe: &Path) {
// 2. Rust starts, Python sees it
assert!(launcher(root, exe, "start-all").0, "coa-launcher start-all");
let seen = status(&manage(root, "status-json").1);
assert!(all(&seen, true), "manage.py must see the services coa-launcher started: {seen}");
// 3. Python stops what Rust started
assert!(manage(root, "stop-all").0, "manage.py stop-all");
assert!(all(&status(&launcher(root, exe, "status-json").1), false));
// 4. Python starts, Rust sees and stops it
assert!(manage(root, "start-all").0, "manage.py start-all");
let seen = status(&launcher(root, exe, "status-json").1);
assert!(all(&seen, true), "coa-launcher must see the services manage.py started: {seen}");
assert!(launcher(root, exe, "stop-all").0, "coa-launcher stop-all");
assert!(all(&status(&manage(root, "status-json").1), false));
// 5. Rust alone, a second time (start on a server it stopped)
assert!(launcher(root, exe, "start-all").0);
assert!(launcher(root, exe, "stop-all").0);
let left = coa_core::process::find_by_exe(&root.join("mysql/bin/mysqld.exe")).len()
+ coa_core::process::find_by_exe(&root.join("Core/worldserver.exe")).len()
+ coa_core::process::find_by_exe(&root.join("Core/authserver.exe")).len();
assert_eq!(left, 0, "nothing of the repack may be left running");
println!("LAUNCHER E2E PASS");
}
@@ -0,0 +1,149 @@
//! The Manager's start/stop (`driver`) on the Rust launcher, on a DISPOSABLE repack:
//!
//! 1. driver start-all: every service runs, the console answers, manage.py is not touched and sees the services;
//! 2. driver stop-all stops everything;
//! 3. manage.py start-all, then driver stop-all stops what Python started;
//! 4. a taken world port fails with the typed "port in use" code (no stderr parsing), then stop-all;
//! 5. driver start-all, then the forced stop;
//! 6. with a realm profile: the realm row gets the profile's name, manage.py is still not edited;
//! 7. nothing of the repack is left running.
//!
//! usage: manager_launcher_e2e <existing folder ending in -fixture>
use std::path::Path;
use std::process::Command;
use std::time::Instant;
use coa_core::driver::{self, Verb};
use coa_core::error::ErrorCode;
use coa_core::launcher::{services, settings::Settings, state};
fn indent(s: &str) -> String {
s.lines().map(|l| format!(" {l}")).collect::<Vec<_>>().join("\n")
}
fn drive(root: &Path, verb: Verb) -> driver::DriverOutcome {
let t = Instant::now();
let out = driver::run(root, verb).expect("driver");
println!("[driver {verb:?}] ok={} code={:?} in {:?}\n{}", out.ok, out.code, t.elapsed(), indent(&out.output));
out
}
fn manage(root: &Path, action: &str) -> (bool, String) {
let python = root.join("Runtime/python/python.exe");
let script = root.join("Scripts/manage.py").to_string_lossy().into_owned();
let t = Instant::now();
let out = Command::new(python).args(["-B", &script, action]).output().unwrap();
let text = String::from_utf8_lossy(&out.stdout).into_owned() + &String::from_utf8_lossy(&out.stderr);
println!("[manage.py {action}] ok={} in {:?}\n{}", out.status.success(), t.elapsed(), indent(&text));
(out.status.success(), text)
}
fn python_status(root: &Path) -> serde_json::Value {
let (ok, out) = manage(root, "status-json");
assert!(ok);
let line = out.lines().rev().find(|l| l.trim_start().starts_with('{')).expect("a JSON status line");
serde_json::from_str(line).unwrap()
}
fn all(v: &serde_json::Value, running: bool) -> bool {
["mysql", "auth", "world", "relay"].iter().all(|k| v[*k] == running)
}
fn nothing_running(root: &Path) -> bool {
["mysql", "auth", "world", "supervisor", "relay"].iter().all(|n| state::running(root, n).is_none())
&& ["mysql/bin/mysqld.exe", "Core/authserver.exe", "Core/worldserver.exe"]
.iter()
.all(|exe| coa_core::process::find_by_exe(&root.join(exe)).is_empty())
}
fn console(root: &Path) -> String {
let cfg = Settings::load(root, 0).unwrap();
let mut ra = coa_core::ra::Ra::connect_to(cfg.ra_port, &cfg.ra_username, &cfg.ra_password).unwrap();
ra.run("server info").unwrap()
}
fn realm_name(root: &Path) -> String {
services::mysql(root, Some("SELECT name FROM acore_auth.realmlist WHERE id=1;"), None).unwrap()
}
fn main() {
let a: Vec<String> = std::env::args().skip(1).collect();
let root = Path::new(&a[0]);
assert!(a[0].ends_with("-fixture"), "a folder ending in -fixture is required");
assert!(nothing_running(root), "the fixture must be stopped before the test");
let manage_py = root.join("Scripts/manage.py");
let original = std::fs::read(&manage_py).unwrap();
let profile = root.join("Settings/realm-profile.json");
assert!(!profile.exists(), "the fixture starts without a realm profile");
// 1
let started = drive(root, Verb::StartAll);
assert!(started.ok, "start-all");
assert!(all(&python_status(root), true), "manage.py sees what the Manager started");
let info = console(root);
println!("[console] {}", info.lines().next().unwrap_or(""));
assert_eq!(std::fs::read(&manage_py).unwrap(), original, "manage.py is not rewritten");
assert_eq!(realm_name(root), "AzerothCore", "no profile: the launcher's own realm name");
let shipped = root.join("Scripts/coa-launcher.exe");
let supervisor = state::running(root, "supervisor").expect("a supervisor");
println!("[supervisor] {}", supervisor.exe);
let expected = if shipped.is_file() { "coa-launcher.exe" } else { "python.exe" };
assert!(supervisor.exe.to_lowercase().ends_with(expected), "the world is supervised by {expected}");
let relay = state::running(root, "relay").expect("a bug-report relay");
println!("[relay] {}", relay.exe);
assert!(relay.exe.to_lowercase().ends_with(expected), "the relay is run by {expected}");
assert!(state::running(root, "relay-ready").is_some_and(|r| r.pid == relay.pid), "the relay reported ready");
// 2
assert!(drive(root, Verb::StopAll).ok, "stop-all");
assert!(nothing_running(root), "1-2 left something running");
// 2b: the repack's Python launcher stops a world the Manager started
assert!(drive(root, Verb::StartAll).ok);
assert!(manage(root, "stop-all").0, "manage.py stops what the Manager started");
assert!(nothing_running(root), "2b left something running");
// 3
assert!(manage(root, "start-all").0);
assert!(drive(root, Verb::StopAll).ok, "driver stops what manage.py started");
assert!(nothing_running(root), "3 left something running");
// 4
let cfg = Settings::load(root, 0).unwrap();
let blocker = std::net::TcpListener::bind(("127.0.0.1", cfg.world_port)).unwrap();
let refused = drive(root, Verb::StartAll);
assert!(!refused.ok);
assert_eq!(refused.code, Some(ErrorCode::PortInUse), "typed port error");
assert!(refused.output.contains(&format!("Port {}", cfg.world_port)));
drop(blocker);
assert!(drive(root, Verb::StopAll).ok);
assert!(nothing_running(root), "4 left something running");
// 5
assert!(drive(root, Verb::StartAll).ok);
let t = Instant::now();
let forced = driver::force_stop(root).expect("force stop");
println!("[driver force_stop] ok={} in {:?}\n{}", forced.ok, t.elapsed(), indent(&forced.output));
assert!(forced.ok && forced.output.contains("Force-stopped"));
assert!(nothing_running(root), "5 left something running");
// 6
std::fs::write(&profile, br#"{"active":"coa","wildcard_created":false}"#).unwrap();
let result = std::panic::catch_unwind(|| {
assert!(drive(root, Verb::StartAll).ok, "start-all with a realm profile");
assert_eq!(realm_name(root), "Conquest of Azeroth");
assert_eq!(std::fs::read(&manage_py).unwrap(), original, "manage.py is not edited for a realm profile either");
assert!(drive(root, Verb::StopAll).ok);
});
std::fs::remove_file(&profile).unwrap();
std::fs::write(&manage_py, &original).unwrap();
if result.is_err() {
let _ = driver::run(root, Verb::StopAll);
panic!("step 6 failed");
}
// 7
assert!(nothing_running(root), "something of the repack is still running");
println!("PASS: the Manager starts and stops through the Rust launcher, interoperates with manage.py, typed errors");
}
@@ -1,97 +0,0 @@
//! The published Modules Preview channel, end to end on a DISPOSABLE server, through the same source selection
//! the Manager uses when the owner does not choose a package: install from the stable channel's installation
//! image, check for updates (the preview channel), apply the preview update (modules are built on this PC and
//! the plugin host starts with them), then check again: the server must now be current.
//!
//! usage: preview_channel_e2e <new folder ending in -fixture>
//! The server gets its own free ports before anything starts; it never uses another server's database.
use std::path::Path;
use coa_core::install::{install_base, Params, Source};
use coa_core::registry::{MetaDir, Registry};
use coa_core::update::{self, DatabaseAccess, Env, RepackEnv};
const KEY: &str = coa_core::signing::EMBEDDED_PUBLIC_KEY;
fn free_port() -> u16 {
std::net::TcpListener::bind("127.0.0.1:0").unwrap().local_addr().unwrap().port()
}
fn sql(root: &Path, q: &str) -> String {
coa_core::backup::with_database(root, |db| db.query(q)).unwrap_or_else(|e| panic!("{q}: {e}"))
}
/// The Manager's "up to date" rule (src/lib/serverUpdateStatus.ts).
fn is_current(p: &update::Preview) -> bool {
p.from_version.as_deref() == Some(p.to_version.as_str())
&& p.items.iter().all(|i| format!("{:?}", i.action).eq_ignore_ascii_case("skip"))
&& (p.database_check_error.is_some() || !p.database_checked || p.pending_migrations == 0)
}
fn check(root: &Path, meta_dir: &Path) -> Result<(Source, update::Preview), Box<dyn std::error::Error>> {
let (_, meta) = MetaDir::open(meta_dir)?;
let selection = coa_core::update_route::select(&meta, coa_core::channels::preview_update_source()?, KEY)?;
let preview = update::preview_with(root, &meta, &selection.source, KEY, &Default::default(), DatabaseAccess::Start)?;
Ok((selection.source, preview))
}
fn main() -> Result<(), Box<dyn std::error::Error>> {
let a: Vec<String> = std::env::args().skip(1).collect();
assert_eq!(a.len(), 1, "usage: preview_channel_e2e <new-folder-fixture>");
let root = Path::new(&a[0]);
assert!(a[0].ends_with("-fixture") && !root.exists(), "a new folder ending in -fixture is required");
let reg_dir = std::env::temp_dir().join("coa-preview-channel-e2e-registry");
let _ = std::fs::remove_dir_all(&reg_dir);
let reg = Registry::at(reg_dir.join("installs.json"));
// 1. New server: the Manager installs the stable channel's image (the preview publishes updates only).
let image = coa_core::channels::stable_source()?;
println!("installation image: {image:?}");
let t = std::time::Instant::now();
let installed = install_base(
&Params { source: Source::Installation(Box::new(image)), dest: root.into(), trusted_key: KEY, registry: &reg, cancel: Default::default() },
&|s| eprintln!(" {:>3}% {}", s.percent, s.step),
)?;
println!("installed {} in {:?}", installed.version, t.elapsed());
let repack = root.join("Settings/repack.json");
let mut cfg: serde_json::Value = serde_json::from_slice(&std::fs::read(&repack)?)?;
for k in ["mysqlPort", "authPort", "worldPort", "raPort"] {
cfg[k] = free_port().into();
}
std::fs::write(&repack, serde_json::to_vec_pretty(&cfg)?)?;
sql(root, "INSERT INTO acore_auth.account (username, salt, verifier, email, reg_mail) \
VALUES ('E2ECHANNEL', UNHEX(REPEAT('11',32)), UNHEX(REPEAT('22',32)), '', '')");
let accounts = sql(root, "SELECT COUNT(*) FROM acore_auth.account").trim().to_string();
// 2. Check for updates: the preview channel offers the preview.
let meta_dir = coa_core::registry::metadata_dir_for(root)?;
let (source, preview) = check(root, &meta_dir)?;
println!("check: {:?} -> {} from {source:?}, {} items, {} migrations", preview.from_version, preview.to_version, preview.items.len(), preview.migrations);
assert!(!is_current(&preview), "a fresh stable server must be offered the preview");
// 3. Apply it, exactly as the Update button does.
let env = RepackEnv { root, meta_dir: &meta_dir };
let t = std::time::Instant::now();
let outcome = update::apply(
&update::Params { root, meta_dir: &meta_dir, source, trusted_key: KEY, cancel: Default::default(), resolutions: Default::default(), env: &env, fail_after_ops: None },
&|phase, percent| println!("{percent}% {phase}"),
);
let _ = coa_core::driver::run(root, coa_core::driver::Verb::StopAll);
let outcome = outcome?;
println!("update {:?} to {:?} in {:?}; modules {:?}", outcome.txn.state, outcome.txn.to_version, t.elapsed(), outcome.modules);
if let Ok(t) = std::fs::read_to_string(root.join("Core/plugins/plugin-boot-report.json")) {
println!("--- boot report\n{t}");
}
assert_eq!(outcome.txn.state, update::State::Committed);
// 4. Check again: nothing newer, nothing to change.
let (_, again) = check(root, &meta_dir)?;
let changing: Vec<_> = again.items.iter().filter(|i| !format!("{:?}", i.action).eq_ignore_ascii_case("skip")).map(|i| format!("{i:?}")).collect();
println!("second check: {:?} -> {}, pending migrations {}, changing items {changing:?}", again.from_version, again.to_version, again.pending_migrations);
assert_eq!(sql(root, "SELECT COUNT(*) FROM acore_auth.account").trim(), accounts, "accounts changed");
env.ensure_stopped()?;
assert!(is_current(&again), "the updated server is not reported as current");
println!("PASS");
Ok(())
}
@@ -1,152 +0,0 @@
//! A core update with a NEW plugin ABI on a DISPOSABLE preview server that already runs modules: the production
//! updater must rebuild every enabled module for the new core before the trial start. With `break <module>` that
//! module's sources are replaced (for this server only) by a copy that does not compile: the core update must
//! still commit, the module must be switched off with a reason, and the world must start without it.
//!
//! usage: preview_core_update_e2e <existing folder ending in -fixture> <preview package dir> [break <module id>] [same-core]
//! `same-core`: the package keeps the server's plugin ABI (a module the manager switched off is retried).
//! The shared source cache is never modified: the broken copy lives next to the fixture.
use std::path::{Path, PathBuf};
use coa_core::install::Source;
use coa_core::update::{self, Env, RepackEnv};
fn sql(root: &Path, q: &str) -> String {
coa_core::backup::with_database(root, |db| db.query(q)).unwrap_or_else(|e| panic!("{q}: {e}"))
}
/// Accounts and every character row, read the same way before and after.
fn data(root: &Path) -> String {
sql(root, "SELECT CONCAT((SELECT COUNT(*) FROM acore_auth.account), '|', COUNT(*), '|', \
COALESCE(SUM(CRC32(CONCAT_WS('|', guid, account, name, level, xp, money))), 0)) FROM acore_characters.characters")
.trim()
.to_string()
}
fn host_fingerprint(root: &Path) -> Option<String> {
let t = std::fs::read_to_string(root.join("Core/plugins/plugin-boot-report.json")).ok()?;
let v: serde_json::Value = serde_json::from_str(&t).ok()?;
v["hostAbiFingerprint"].as_str().map(str::to_string)
}
fn copy_dir(from: &Path, to: &Path) -> std::io::Result<()> {
std::fs::create_dir_all(to)?;
for e in std::fs::read_dir(from)? {
let e = e?;
let dest = to.join(e.file_name());
if e.file_type()?.is_dir() {
copy_dir(&e.path(), &dest)?;
} else {
std::fs::copy(e.path(), dest)?;
}
}
Ok(())
}
fn first_cpp(dir: &Path) -> Option<PathBuf> {
let mut entries: Vec<_> = std::fs::read_dir(dir).ok()?.flatten().map(|e| e.path()).collect();
entries.sort();
entries.iter().find(|p| p.extension().is_some_and(|x| x == "cpp")).cloned()
.or_else(|| entries.iter().filter(|p| p.is_dir()).find_map(|p| first_cpp(p)))
}
/// Points this server's build recipe for `id` at a copy of its sources with a compile error.
fn break_module(root: &Path, id: &str) -> Result<(), Box<dyn std::error::Error>> {
let recipe_path = coa_core::plugins::meta_dir(root).join("build-recipes").join(format!("{id}.json"));
let mut recipe: serde_json::Value = serde_json::from_slice(&std::fs::read(&recipe_path)?)?;
let src = PathBuf::from(recipe["source_dir"].as_str().ok_or("recipe has no source_dir")?);
// Next to the fixture, never inside the shared cache. Same <repo>/<commit> tail as the cache, because the
// manager reads the module's identity from it: the build itself must be what fails.
let tail: PathBuf = src.components().rev().take(2).collect::<Vec<_>>().into_iter().rev().collect();
let broken = root.parent().unwrap().join("brk").join(tail);
if src == broken {
println!("{id} already builds from the broken copy {}", broken.display());
return Ok(());
}
copy_dir(&src, &broken)?; // a fresh copy over any earlier one
let cpp = ["src", "module/src"].iter().find_map(|d| first_cpp(&broken.join(d))).ok_or("no .cpp in the module sources")?;
let text = std::fs::read_to_string(&cpp)?;
std::fs::write(&cpp, format!("#error coa e2e: this module deliberately does not build\n{text}"))?;
println!("broke {id}: {} (recipe now -> {})", cpp.display(), broken.display());
recipe["source_dir"] = broken.to_string_lossy().into_owned().into();
std::fs::write(&recipe_path, serde_json::to_vec_pretty(&recipe)?)?;
Ok(())
}
fn main() -> Result<(), Box<dyn std::error::Error>> {
let a: Vec<String> = std::env::args().skip(1).collect();
let same_core = a.last().is_some_and(|x| x == "same-core");
let a: Vec<String> = if same_core { a[..a.len() - 1].to_vec() } else { a };
assert!(a.len() == 2 || (a.len() == 4 && a[2] == "break"), "usage: preview_core_update_e2e <fixture> <package dir> [break <id>] [same-core]");
let root = Path::new(&a[0]);
assert!(a[0].ends_with("-fixture") && root.is_dir(), "an existing folder ending in -fixture is required");
let broken = a.get(3).cloned();
let meta_dir = coa_core::registry::metadata_dir_for(root)?;
let env = RepackEnv { root, meta_dir: &meta_dir };
env.ensure_stopped()?;
let fp_before = host_fingerprint(root);
let data_before = data(root);
let lock_before = std::fs::read_to_string(root.join("Core/plugins/plugins.lock")).unwrap_or_default();
println!("before: host {fp_before:?}, data {data_before}\n--- plugins.lock before\n{lock_before}");
if let Some(id) = &broken {
break_module(root, id)?;
}
let t = std::time::Instant::now();
let outcome = update::apply(
&update::Params {
root,
meta_dir: &meta_dir,
source: Source::Dir(a[1].clone().into()),
trusted_key: coa_core::signing::EMBEDDED_PUBLIC_KEY,
cancel: Default::default(),
resolutions: Default::default(),
env: &env,
fail_after_ops: None,
},
&|phase, percent| println!("{percent}% {phase}"),
);
let stopped = coa_core::driver::run(root, coa_core::driver::Verb::StopAll);
println!("shutdown after update: {:?}", stopped.map(|r| r.ok));
let outcome = outcome?;
println!("update {:?} to {:?} in {:?}; modules {:#?}", outcome.txn.state, outcome.txn.to_version, t.elapsed(), outcome.modules);
let fp_after = host_fingerprint(root);
let data_after = data(root);
let lock_after = std::fs::read_to_string(root.join("Core/plugins/plugins.lock")).unwrap_or_default();
println!("after: host {fp_after:?}, data {data_after}\n--- plugins.lock after\n{lock_after}");
if let Ok(t) = std::fs::read_to_string(root.join("Core/plugins/plugin-boot-report.json")) {
println!("--- boot report\n{t}");
}
let reg = coa_core::plugins::load_registry(root)?;
for (id, e) in &reg.plugins {
println!("registry {id}: enabled={} disabled_reason={:?}", e.enabled, e.disabled_reason);
}
env.ensure_stopped()?;
assert_eq!(outcome.txn.state, update::State::Committed, "the core update must always commit");
if same_core {
assert_eq!(fp_before, fp_after, "same-core: the host fingerprint changed");
} else {
assert_ne!(fp_before, fp_after, "the host fingerprint did not change");
}
assert_eq!(data_before, data_after, "accounts or characters changed");
let shown: Vec<String> = outcome.modules.iter().map(|m| format!("{m:?}")).collect();
for (id, e) in reg.plugins.iter().filter(|(_, e)| e.installed) {
let line = shown.iter().find(|m| m.contains(&format!("\"{id}\""))).cloned().unwrap_or_default();
if broken.as_deref() == Some(id.as_str()) {
assert!(line.starts_with("Disabled") && !e.enabled && e.disabled_reason.is_some(), "{id} must be switched off with a reason: {line}");
assert!(line.contains("does not build"), "{id} must be switched off because it does not build: {line}");
assert!(!lock_after.contains(&format!("{id}|")), "{id} is still in plugins.lock");
} else if lock_before.contains(&format!("{id}|")) {
let ok = line.starts_with("Rebuilt") || line.starts_with("Reused") || (same_core && line.starts_with("UpToDate"));
assert!(ok, "{id} was not rebuilt for the new core: {line}");
assert!(e.enabled && lock_after.contains(&format!("{id}|")), "{id} is not loaded after the update");
}
}
let report = std::fs::read_to_string(root.join("Core/plugins/plugin-boot-report.json"))?;
assert!(report.contains("\"anyFaulted\": false"), "the trial start reported a faulted plugin");
println!("PASS");
Ok(())
}
@@ -1,180 +0,0 @@
//! Stable -> Modules Preview on a DISPOSABLE server: install a stable release, seed a test account and
//! character and a changed module setting, apply a signed preview update with the production updater (which
//! builds the recommended modules and starts the plugin-host core with them), and check that the data and the
//! setting survived.
//!
//! usage: preview_migration_e2e <new folder ending in -fixture> <stable release URL> <preview package dir or URL> [squid]
//! With `squid` the stable server runs SQUID's Playerbots (started once so its SQL is imported) before the update;
//! SQUID's own SQL journals must come through unchanged.
//! The server gets its own free ports before anything starts; it never uses another server's database.
use std::path::Path;
use coa_core::install::{install_base, Params, Source};
use coa_core::registry::{MetaDir, Registry};
use coa_core::update::{self, Env, RepackEnv};
fn free_port() -> u16 {
std::net::TcpListener::bind("127.0.0.1:0").unwrap().local_addr().unwrap().port()
}
fn sql(root: &Path, q: &str) -> String {
coa_core::backup::with_database(root, |db| db.query(q)).unwrap_or_else(|e| panic!("{q}: {e}"))
}
/// Fingerprint of the seeded rows, read the same way before and after.
fn fingerprint(root: &Path) -> String {
sql(root, "SELECT CONCAT_WS('|', a.id, a.username, c.guid, c.name, c.level, c.xp, c.money, \
(SELECT COUNT(*) FROM acore_characters.character_spell s WHERE s.guid = c.guid)) \
FROM acore_auth.account a JOIN acore_characters.characters c ON c.account = a.id WHERE a.username = 'E2EPREVIEW'")
}
/// SQUID's journals and its database, read the same way before and after (absent tables read as "-").
fn squid_journals(root: &Path) -> String {
let mut out = Vec::new();
for db in ["acore_characters", "acore_world", "acore_playerbots"] {
for t in ["coa_squid_migrations", "coa_squid_pending", "coa_bots_installed"] {
let exists = sql(root, &format!("SELECT COUNT(*) FROM information_schema.TABLES WHERE TABLE_SCHEMA='{db}' AND TABLE_NAME='{t}'"));
if exists.trim() == "0" {
out.push(format!("{db}.{t}=-"));
continue;
}
let cols = sql(root, &format!("SELECT GROUP_CONCAT(COLUMN_NAME ORDER BY ORDINAL_POSITION) FROM information_schema.COLUMNS WHERE TABLE_SCHEMA='{db}' AND TABLE_NAME='{t}'"));
out.push(format!("{db}.{t}={}", sql(root, &format!(
"SELECT CONCAT(COUNT(*), ':', COALESCE(SUM(CRC32(CONCAT_WS('|', {}))), 0)) FROM {db}.{t}", cols.trim()))
.trim()));
}
}
out.push(format!("playerbots tables={}", sql(root, "SELECT COUNT(*) FROM information_schema.TABLES WHERE TABLE_SCHEMA='acore_playerbots'").trim()));
out.join(" ")
}
fn main() -> Result<(), Box<dyn std::error::Error>> {
let a: Vec<String> = std::env::args().skip(1).collect();
assert!(a.len() == 3 || (a.len() == 4 && a[3] == "squid"), "usage: preview_migration_e2e <new-folder-fixture> <stable release URL> <preview package dir or URL> [squid]");
let squid = a.len() == 4;
let root = Path::new(&a[0]);
assert!(a[0].ends_with("-fixture") && !root.exists(), "a new folder ending in -fixture is required");
let reg_dir = std::env::temp_dir().join("coa-preview-e2e-registry");
let _ = std::fs::remove_dir_all(&reg_dir);
let reg = Registry::at(reg_dir.join("installs.json"));
// 1. Stable server from its signed installation image.
let t = std::time::Instant::now();
let installed = install_base(
&Params {
source: Source::Installation(Box::new(Source::Url(a[1].clone()))),
dest: root.into(),
trusted_key: coa_core::signing::EMBEDDED_PUBLIC_KEY,
registry: &reg,
cancel: Default::default(),
},
&|s| eprintln!(" {:>3}% {}", s.percent, s.step),
)?;
println!("installed stable {} in {:?}", installed.version, t.elapsed());
// 2. Own ports, before the server is ever started.
let repack = root.join("Settings/repack.json");
let mut cfg: serde_json::Value = serde_json::from_slice(&std::fs::read(&repack)?)?;
for k in ["mysqlPort", "authPort", "worldPort", "raPort"] {
cfg[k] = free_port().into();
}
std::fs::write(&repack, serde_json::to_vec_pretty(&cfg)?)?;
println!("ports {}", serde_json::json!({"mysql": cfg["mysqlPort"], "auth": cfg["authPort"], "world": cfg["worldPort"], "ra": cfg["raPort"]}));
let meta = coa_core::registry::metadata_dir_for(root)?;
if squid {
// The owner switches the bots to SQUID (Companions off) and starts the server once: the launcher imports
// SQUID's SQL into its own journals.
coa_core::modules::set_enabled(root, &meta, "companions", false)?;
coa_core::modules::set_enabled(root, &meta, "playerbots", true)?;
let started = coa_core::driver::run(root, coa_core::driver::Verb::StartAll)?;
println!("stable with SQUID started: {}", started.ok);
let mut stopped = coa_core::driver::run(root, coa_core::driver::Verb::StopAll)?;
if !stopped.ok {
// Known stable launcher behaviour: a stop right after SQUID starts its random bots can outlast the
// launcher's 90 s wait. The owner is told to try again; so does this test, and reports it.
println!("FINDING: first stop after the SQUID start failed: {}", stopped.output.trim());
stopped = coa_core::driver::run(root, coa_core::driver::Verb::StopAll)?;
}
assert!(started.ok && stopped.ok, "the stable server with SQUID did not start and stop: {}", stopped.output.trim());
}
// 3. Test data: an account with a character and a spell; a changed module setting.
let cols = sql(root, "SELECT GROUP_CONCAT(CONCAT(COLUMN_NAME, ':', DATA_TYPE)) FROM information_schema.COLUMNS \
WHERE TABLE_SCHEMA='acore_characters' AND TABLE_NAME='characters' AND IS_NULLABLE='NO' AND COLUMN_DEFAULT IS NULL");
sql(root, "INSERT INTO acore_auth.account (username, salt, verifier, email, reg_mail) \
VALUES ('E2EPREVIEW', UNHEX(REPEAT('11',32)), UNHEX(REPEAT('22',32)), '', '')");
let account = sql(root, "SELECT id FROM acore_auth.account WHERE username='E2EPREVIEW'").trim().to_string();
let mut names = vec!["guid", "account", "name", "race", "class", "gender", "level", "xp", "money"].into_iter().map(String::from).collect::<Vec<_>>();
let mut values = vec!["990001".to_string(), account, "'Eeprev'".into(), "1".into(), "1".into(), "0".into(), "42".into(), "777".into(), "123456".into()];
for c in cols.trim().split(',').filter(|c| !c.is_empty()) {
let (name, ty) = c.split_once(':').unwrap();
if names.iter().any(|n| n == name) {
continue;
}
names.push(name.to_string());
values.push(if ty.contains("char") || ty.contains("text") || ty.contains("blob") { "''".into() } else { "0".into() });
}
sql(root, &format!("INSERT INTO acore_characters.characters ({}) VALUES ({})", names.join(","), values.join(",")));
sql(root, "INSERT INTO acore_characters.character_spell (guid, spell, specMask) VALUES (990001, 133, 255)");
let conf = root.join("Core/configs/modules/mod-coa-content-scaling.conf");
let text = std::fs::read_to_string(&conf)?;
let line = text.lines().find(|l| !l.trim_start().starts_with('#') && l.contains(" = ")).expect("a setting").to_string();
let changed = format!("{} = 7", line.split(" = ").next().unwrap().trim());
std::fs::write(&conf, text.replacen(&line, &changed, 1))?;
let before = fingerprint(root);
let journals_before = squid_journals(root);
println!("squid journals before: {journals_before}");
println!("before: {before}\nsetting: {changed}");
assert!(!before.trim().is_empty());
// 4. The preview update, through the production updater.
let (_, info) = MetaDir::open(&meta)?;
assert_eq!(coa_core::fsx::canonicalize_lenient(Path::new(&info.server_path))?, coa_core::fsx::canonicalize_lenient(root)?);
let env = RepackEnv { root, meta_dir: &meta };
let t = std::time::Instant::now();
let outcome = update::apply(
&update::Params {
root,
meta_dir: &meta,
source: if a[2].starts_with("http") { Source::Url(a[2].clone()) } else { Source::Dir(a[2].clone().into()) },
trusted_key: coa_core::signing::EMBEDDED_PUBLIC_KEY,
cancel: Default::default(),
resolutions: Default::default(),
env: &env,
fail_after_ops: None,
},
&|phase, percent| println!("{percent}% {phase}"),
);
let stopped = coa_core::driver::run(root, coa_core::driver::Verb::StopAll);
println!("shutdown after update: {:?}", stopped.map(|r| r.ok));
let outcome = outcome?;
println!("update {:?} in {:?}; modules {:#?}", outcome.txn.state, t.elapsed(), outcome.modules);
// 5. Same data, same setting, plugin host with its modules.
let after = fingerprint(root);
let journals_after = squid_journals(root);
println!("squid journals after: {journals_after}");
let text = std::fs::read_to_string(&conf)?;
println!("after: {after}");
println!("setting kept: {}", text.lines().any(|l| l.trim() == changed));
for p in ["Core/plugins/plugins.lock", "Core/plugins/plugin-boot-report.json"] {
if let Ok(t) = std::fs::read_to_string(root.join(p)) {
println!("--- {p}\n{t}");
}
}
env.ensure_stopped()?;
assert_eq!(outcome.txn.state, update::State::Committed);
assert_eq!(before, after, "seeded character data changed");
assert!(text.lines().any(|l| l.trim() == changed), "module setting lost");
assert_eq!(journals_before, journals_after, "SQUID's journals changed");
let ids: Vec<String> = outcome.modules.iter().map(|m| format!("{m:?}")).collect();
let has = |id: &str| ids.iter().any(|m| m.contains(&format!("\"{id}\"")));
if squid {
assert!(has("playerbots") && !has("companions"), "SQUID server must get SQUID's Playerbots, not Companions: {ids:?}");
} else {
assert!(has("companions") && !has("playerbots"), "Companions server must get Companions, not SQUID: {ids:?}");
}
println!("PASS");
Ok(())
}
@@ -0,0 +1,170 @@
//! The Rust bug-report relay against the repack's `BugReport/relay.py`, offline (a scripted service, no network):
//!
//! 1. the same reports and the same service answers give the same `.status` files and journal rows;
//! 2. each relay continues the other's journal: what one delivered is never sent again by the other, and a post the
//! other left in progress is uncertain.
//!
//! usage: relay_equivalence <repack folder with Runtime/python and BugReport/relay.py>
use std::path::{Path, PathBuf};
use std::process::Command;
use std::sync::{Arc, Mutex};
use coa_core::launcher::relay::{Failure, Relay, Service};
const REPORTS: [(&str, &str); 5] = [
("1-00000000000000a1", "COABUG1\r\nQuest broken\r\nThe NPC is gone.\r\n"),
("9-00000000000000b2", "COABUG1\nRate limited\nBody text\n"),
("3-00000000000000c3", "COABUG1\nRejected\nBody\n"),
("4-00000000000000d4", "COABUG1\nxy\nTitle too short\n"),
("5-00000000000000e5", "COABUG1\nUnknown outcome\nBody\n"),
];
/// The answers per title, in the vocabulary of both relays.
fn answer(title: &str) -> std::result::Result<u64, Failure> {
match title {
"Quest broken" => Ok(101),
"Rate limited" => Err(Failure::Limited(60)),
"Rejected" => Err(Failure::Invalid),
_ => Err(Failure::Uncertain),
}
}
const PYTHON: &str = r#"
import importlib.util, sys, json
from pathlib import Path
spec = importlib.util.spec_from_file_location("relay", sys.argv[1]); relay = importlib.util.module_from_spec(spec); spec.loader.exec_module(relay)
spool = Path(sys.argv[2]); calls = []
class Fake:
def create(self, title, body):
calls.append(title)
if title == "Quest broken": return 101
if title == "Rate limited": raise relay.DeliveryError("limited", 60)
if title == "Rejected": raise relay.DeliveryError("invalid")
raise relay.DeliveryError("uncertain")
t = [float(sys.argv[3])]
def clock():
t[0] += 3
return t[0]
r = relay.Relay(spool, Fake(), clock=clock)
for path in sorted(spool.glob("*.report")):
r.process(path)
r.close()
print(json.dumps(calls))
"#;
struct Scripted(Arc<Mutex<Vec<String>>>);
impl Service for Scripted {
fn create(&self, title: &str, _: &str) -> std::result::Result<u64, Failure> {
self.0.lock().unwrap().push(title.into());
answer(title)
}
}
fn spool(dir: &Path) -> PathBuf {
std::fs::create_dir_all(dir).unwrap();
for (key, text) in REPORTS {
std::fs::write(dir.join(format!("{key}.report")), text).unwrap();
}
dir.into()
}
fn python(repack: &Path, spool: &Path, start: f64) -> Vec<String> {
let out = Command::new(repack.join("Runtime/python/python.exe"))
.args(["-I", "-B", "-c", PYTHON])
.arg(repack.join("BugReport/relay.py"))
.arg(spool)
.arg(start.to_string())
.output()
.unwrap();
assert!(out.status.success(), "{}", String::from_utf8_lossy(&out.stderr));
serde_json::from_slice(&out.stdout).unwrap()
}
/// The clock of both relays: `start`, then 3 seconds later at every reading.
fn rust(spool: &Path, start: f64) -> Vec<String> {
let calls = Arc::new(Mutex::new(Vec::new()));
let t = Mutex::new(start);
let clock = move || {
let mut v = t.lock().unwrap();
*v += 3.0;
*v
};
let relay = Relay::with_clock(spool, Scripted(calls.clone()), Box::new(clock)).unwrap();
relay.pass().unwrap();
drop(relay);
let c = calls.lock().unwrap().clone();
c
}
/// `.status` files and journal rows (without the post time).
fn snapshot(spool: &Path) -> (Vec<(String, String)>, Vec<String>) {
let mut statuses: Vec<(String, String)> = std::fs::read_dir(spool)
.unwrap()
.flatten()
.filter(|e| e.path().extension().is_some_and(|x| x == "status"))
.map(|e| (e.file_name().to_string_lossy().into_owned(), std::fs::read_to_string(e.path()).unwrap()))
.collect();
statuses.sort();
let db = rusqlite::Connection::open(spool.join("relay.sqlite3")).unwrap();
let mut q = db.prepare("SELECT key, digest, marker, state, number, next_try FROM deliveries ORDER BY key").unwrap();
let rows = q
.query_map([], |r| {
Ok(format!(
"{}|{}|{}|{}|{:?}|{}",
r.get::<_, String>(0)?,
r.get::<_, String>(1)?,
r.get::<_, String>(2)?,
r.get::<_, String>(3)?,
r.get::<_, Option<i64>>(4)?,
r.get::<_, f64>(5)?
))
})
.unwrap()
.map(Result::unwrap)
.collect();
(statuses, rows)
}
fn main() {
let repack = PathBuf::from(std::env::args().nth(1).expect("repack folder"));
let work = tempfile::tempdir().unwrap();
// 1
let (a, b) = (spool(&work.path().join("python")), spool(&work.path().join("rust")));
let py_calls = python(&repack, &a, 1000.0);
let rs_calls = rust(&b, 1000.0);
println!("python posted {py_calls:?}\nrust posted {rs_calls:?}");
assert_eq!(py_calls, rs_calls, "the same reports are posted");
let (pa, pb) = (snapshot(&a), snapshot(&b));
for s in &pa.0 {
println!(" {} = {}", s.0, s.1.trim());
}
assert_eq!(pa, pb, "the same statuses and journal");
// 2: each continues the other's journal. Before the retry times nothing is sent again; after them only the
// rate-limited report is (created, rejected and uncertain ones never are).
assert!(python(&repack, &b, 1000.0).is_empty(), "Python does not resend what Rust handled");
assert!(rust(&a, 1000.0).is_empty(), "Rust does not resend what Python handled");
// Later passes: the queued reports go out, a refused or uncertain one never again.
for start in [5000.0, 6000.0, 7000.0] {
let (p, r) = (python(&repack, &b, start), rust(&a, start));
println!("at {start}: python on rust's journal posted {p:?}, rust on python's posted {r:?}");
assert_eq!(p, r, "the same retries");
assert!(!p.iter().any(|t| t == "Quest broken" || t == "Unknown outcome"), "created and uncertain are final");
}
assert_eq!(snapshot(&a), snapshot(&b), "the same after a retry by the other relay");
for dir in [&a, &b] {
let db = rusqlite::Connection::open(dir.join("relay.sqlite3")).unwrap();
db.execute("UPDATE deliveries SET state='posting' WHERE key='9-00000000000000b2'", []).unwrap();
}
python(&repack, &b, 9000.0);
rust(&a, 9000.0);
for dir in [&a, &b] {
let db = rusqlite::Connection::open(dir.join("relay.sqlite3")).unwrap();
let state: String = db.query_row("SELECT state FROM deliveries WHERE key='9-00000000000000b2'", [], |r| r.get(0)).unwrap();
assert_eq!(state, "uncertain", "an interrupted post is not retried ({})", dir.display());
}
assert_eq!(snapshot(&a), snapshot(&b), "still the same after the crossover");
println!("PASS: relay journals, statuses and posts are the same in Python and Rust");
}
@@ -0,0 +1,103 @@
//! SQUID database provisioning in Rust gives exactly what Scripts/squid_playerbots.py gives, on a DISPOSABLE repack:
//! the same journals (coa_squid_migrations, coa_squid_pending) in every schema, the same acore_playerbots tables
//! with the same row counts, the same playerbots.conf. Each side starts from the same state (SQUID never
//! provisioned), and a second run of each must change nothing.
//!
//! usage: squid_equivalence <fixture ending in -fixture> <coa-launcher.exe>
use std::path::Path;
use std::process::Command;
use coa_core::launcher::{services, squid};
fn sql(root: &Path, q: &str) -> String {
services::mysql(root, Some(q), None).unwrap_or_else(|e| panic!("{q}: {e}"))
}
/// What provisioning leaves behind, comparable between runs.
fn snapshot(root: &Path) -> String {
let mut out = Vec::new();
for schema in ["acore_characters", "acore_world", "acore_playerbots"] {
let tables = sql(root, &format!("SELECT TABLE_NAME FROM information_schema.TABLES WHERE TABLE_SCHEMA='{schema}' ORDER BY TABLE_NAME;"));
for t in tables.lines() {
if schema != "acore_playerbots" && !t.starts_with("coa_squid") {
continue;
}
let n = sql(root, &format!("SELECT COUNT(*) FROM `{schema}`.`{t}`;"));
out.push(format!("{schema}.{t} rows={n}"));
if t == "coa_squid_migrations" || t == "coa_squid_pending" {
for row in sql(root, &format!("SELECT path, sha256 FROM `{schema}`.`{t}` ORDER BY path;")).lines() {
out.push(format!(" {row}"));
}
}
}
}
let conf = std::fs::read_to_string(root.join("Core/configs/modules/playerbots.conf")).unwrap();
out.push(format!("playerbots.conf:\n{}", conf.replace("\r\n", "\n")));
out.join("\n")
}
fn reset(root: &Path, conf: &[u8]) {
sql(root, "DROP DATABASE IF EXISTS acore_playerbots;");
for schema in ["acore_characters", "acore_world"] {
sql(root, &format!("DROP TABLE IF EXISTS `{schema}`.coa_squid_migrations, `{schema}`.coa_squid_pending;"));
}
std::fs::write(root.join("Core/configs/modules/playerbots.conf"), conf).unwrap();
}
fn python(root: &Path) {
let harness = root.join(".state/squid_harness.py");
std::fs::write(
&harness,
"import sys, pathlib\nroot = pathlib.Path(sys.argv[1])\nsys.path.insert(0, str(root / 'Scripts'))\nsys.argv = ['manage.py']\nimport manage\nfrom squid_playerbots import prepare_playerbots\nprepare_playerbots(manage.ROOT, manage.settings(), manage.mysql)\n",
)
.unwrap();
let out = Command::new(root.join("Runtime/python/python.exe")).arg("-B").arg(&harness).arg(root).output().unwrap();
assert!(out.status.success(), "python: {}{}", String::from_utf8_lossy(&out.stdout), String::from_utf8_lossy(&out.stderr));
print!("{}", String::from_utf8_lossy(&out.stdout));
}
fn rust(root: &Path) {
let cfg = coa_core::launcher::Settings::load(root, 0).unwrap();
squid::prepare_playerbots(root, cfg.mysql_port, &|q| services::mysql(root, Some(q), None), &|m| println!("{m}")).unwrap();
}
fn main() {
let a: Vec<String> = std::env::args().skip(1).collect();
let root = Path::new(&a[0]);
let exe = Path::new(&a[1]);
assert!(a[0].ends_with("-fixture"));
let modules = root.join("Core/configs/modules");
// SQUID on, Companions off
let companions = std::fs::read_to_string(modules.join("mod_coa_playerbots.conf")).unwrap();
std::fs::write(modules.join("mod_coa_playerbots.conf"), companions.replace("CoaBots.Enable = 1", "CoaBots.Enable = 0")).unwrap();
let squid_conf = std::fs::read_to_string(modules.join("playerbots.conf")).unwrap().replace("AiPlayerbot.Enabled = 0", "AiPlayerbot.Enabled = 1");
let r = root.to_string_lossy().into_owned();
let started = Command::new(exe).args(["--root", &r, "start-mysql"]).output().unwrap();
assert!(started.status.success(), "{}", String::from_utf8_lossy(&started.stderr));
reset(root, squid_conf.as_bytes());
let t = std::time::Instant::now();
python(root);
println!("python provisioned in {:?}", t.elapsed());
let by_python = snapshot(root);
python(root);
assert_eq!(snapshot(root), by_python, "a second Python run changed something");
reset(root, squid_conf.as_bytes());
let t = std::time::Instant::now();
rust(root);
println!("rust provisioned in {:?}", t.elapsed());
let by_rust = snapshot(root);
rust(root);
assert_eq!(snapshot(root), by_rust, "a second Rust run changed something");
if by_python != by_rust {
std::fs::write(root.join(".state/squid-python.txt"), &by_python).unwrap();
std::fs::write(root.join(".state/squid-rust.txt"), &by_rust).unwrap();
panic!("Rust and Python differ: see .state/squid-python.txt and squid-rust.txt");
}
println!("{} lines of journal/table/config state are identical", by_rust.lines().count());
let stopped = Command::new(exe).args(["--root", &r, "stop-all"]).output().unwrap();
assert!(stopped.status.success());
println!("SQUID EQUIVALENCE PASS");
}
+494
View File
@@ -0,0 +1,494 @@
//! A catalog of game addons the Manager can install into a client's `Interface/AddOns`.
//!
//! Every addon is pinned to a commit of its GitHub repository; the catalog lists each file it installs with its
//! git blob SHA-1 and size, which are checked after download (GitHub's archives are not byte-stable, their
//! contents are). The Manager records what it installed in `Interface/AddOns/.coa-addons.json` and only ever
//! removes or replaces those folders; a folder of the same name that someone else put there is moved to
//! `Interface/AddOns/.coa-addons-backup` first.
use std::collections::BTreeMap;
use std::fs;
use std::io::{Read, Write};
use std::path::{Path, PathBuf};
use serde::{Deserialize, Serialize};
use sha1::{Digest, Sha1};
use crate::download::{Cancel, Transport};
use crate::error::{Error, Result};
use crate::fsx;
static CATALOG: &str = include_str!("../../../addons/catalog.json");
const STATE: &str = ".coa-addons.json";
const BACKUP: &str = ".coa-addons-backup";
/// No addon archive is anywhere near this; a larger answer is not what the catalog describes.
const MAX_ARCHIVE: u64 = 1 << 30;
#[derive(Debug, Clone, Deserialize)]
struct AddonFile {
path: String,
from: String,
sha1: String,
size: u64,
}
#[derive(Debug, Clone, Deserialize)]
struct Entry {
id: String,
name: String,
description: BTreeMap<String, String>,
author: String,
license: String,
#[serde(default)]
needs: Option<String>,
repo: String,
commit: String,
archive: String,
folders: Vec<String>,
files: Vec<AddonFile>,
}
#[derive(Deserialize)]
struct Catalog {
addons: Vec<Entry>,
}
#[derive(Debug, Default, Clone, Serialize, Deserialize)]
struct Installed {
commit: String,
folders: Vec<String>,
}
/// One addon of the catalog as the Manager shows it for a client.
#[derive(Debug, Clone, Serialize)]
#[serde(rename_all = "camelCase")]
pub struct AddonView {
pub id: String,
pub name: String,
pub description: BTreeMap<String, String>,
pub author: String,
pub license: String,
/// A server module the addon is made for (`playerbots`), shown as a hint.
pub needs: Option<String>,
pub repo: String,
pub size: u64,
pub installed: bool,
pub update_available: bool,
/// Folders of this addon that are in the client but were not installed by the Manager.
pub foreign_folders: Vec<String>,
/// Installed by something else, shown so nobody looks for it twice: `custom-races` (the client patch).
pub bundled: Option<String>,
}
fn catalog() -> Result<Vec<Entry>> {
let catalog: Catalog = serde_json::from_str(CATALOG)?;
for entry in &catalog.addons {
for folder in &entry.folders {
if folder.is_empty() || folder.contains(['/', '\\']) || folder.starts_with('.') {
return Err(Error::Invalid(format!("Invalid addon folder in the catalog: {folder}")));
}
}
}
Ok(catalog.addons)
}
fn addons_dir(client: &Path) -> PathBuf {
client.join("Interface").join("AddOns")
}
fn read_state(client: &Path) -> BTreeMap<String, Installed> {
fsx::read_json(&addons_dir(client).join(STATE)).unwrap_or_default()
}
fn write_state(client: &Path, state: &BTreeMap<String, Installed>) -> Result<()> {
fsx::atomic_write_json(&addons_dir(client).join(STATE), state)
}
/// The catalog with what is installed in `client`.
pub fn list(client: &Path) -> Result<Vec<AddonView>> {
let state = read_state(client);
let dir = addons_dir(client);
let owned: Vec<&String> = state.values().flat_map(|i| i.folders.iter()).collect();
Ok(catalog()?
.into_iter()
.map(|entry| {
let installed = state.get(&entry.id);
AddonView {
foreign_folders: entry
.folders
.iter()
.filter(|f| dir.join(f).exists() && !owned.contains(f))
.cloned()
.collect(),
size: entry.files.iter().map(|f| f.size).sum(),
installed: installed.is_some(),
update_available: installed.is_some_and(|i| i.commit != entry.commit),
id: entry.id,
name: entry.name,
description: entry.description,
author: entry.author,
license: entry.license,
needs: entry.needs,
repo: entry.repo,
bundled: None,
}
})
.chain(std::iter::once(dev_menu(&dir)))
.collect())
}
/// The /dev menu addon of Custom Races V2: the client patch installs it and switches it with the patch.
fn dev_menu(dir: &Path) -> AddonView {
let mut description = BTreeMap::new();
for (lang, text) in [
("en", "The in-game /dev editor for game masters. It comes with the Custom Races V2 client patch and is switched with it."),
("ru", "Внутриигровой редактор /dev для гейм-мастеров. Ставится вместе с клиентским патчем Custom Races V2 и включается вместе с ним."),
("de", "Der /dev-Editor im Spiel für Spielleiter. Er kommt mit dem Client-Patch Custom Races V2 und wird mit ihm geschaltet."),
("fr", "L'éditeur /dev en jeu pour les maîtres du jeu. Il vient avec le patch client Custom Races V2 et s'active avec lui."),
("es", "El editor /dev del juego para los máster. Viene con el parche de cliente Custom Races V2 y se activa con él."),
("zh", "供游戏管理员使用的游戏内 /dev 编辑器。随 Custom Races V2 客户端补丁安装,并随补丁一起开关。"),
] {
description.insert(lang.to_string(), text.to_string());
}
AddonView {
id: "coa-dev-menu".into(),
name: "CoA Dev Menu".into(),
description,
author: "ilusixn".into(),
license: "see repository".into(),
needs: None,
repo: "https://github.com/ilusixn/ilusixn-dev-menu".into(),
size: 0,
installed: dir.join("CoA_DevMenu/CoA_DevMenu.toc").is_file(),
update_available: false,
foreign_folders: Vec::new(),
bundled: Some("custom-races".into()),
}
}
/// The git blob id of `bytes` (what the catalog records for each file).
fn git_blob_sha1(bytes: &[u8]) -> String {
let mut hasher = Sha1::new();
hasher.update(format!("blob {}\0", bytes.len()).as_bytes());
hasher.update(bytes);
hex::encode(hasher.finalize())
}
fn download(transport: &dyn Transport, url: &str, dest: &Path, cancel: &Cancel) -> Result<()> {
crate::download::check_url(url)?;
let reply = transport.get(url, 0).map_err(Error::Invalid)?;
if reply.status != 200 {
return Err(Error::Invalid(format!("The addon download answered HTTP {}.", reply.status)));
}
let mut body = reply.body.take(MAX_ARCHIVE + 1);
let mut file = fs::File::create(dest)?;
let mut buf = vec![0u8; 1 << 20];
let mut total = 0u64;
loop {
if cancel.is_set() {
return Err(Error::Invalid("Operation cancelled.".into()));
}
let n = body.read(&mut buf)?;
if n == 0 {
break;
}
total += n as u64;
if total > MAX_ARCHIVE {
return Err(Error::Invalid("The addon download is larger than any catalog addon.".into()));
}
file.write_all(&buf[..n])?;
}
file.sync_all()?;
Ok(())
}
/// Unpack the catalog's files of `entry` from `archive` into `staging`, checking every one.
fn unpack(entry: &Entry, archive: &Path, staging: &Path) -> Result<()> {
let mut zip = zip::ZipArchive::new(fs::File::open(archive)?)
.map_err(|e| Error::Invalid(format!("The addon download is not a zip archive: {e}")))?;
// GitHub archives hold everything under one top folder (`<repo>-<commit>/`).
let mut by_path = BTreeMap::new();
for index in 0..zip.len() {
let name = zip
.by_index(index)
.map_err(|e| Error::Invalid(e.to_string()))?
.name()
.replace('\\', "/");
if let Some((_, inner)) = name.split_once('/') {
by_path.insert(inner.to_string(), index);
}
}
for file in &entry.files {
let index = *by_path
.get(&file.from)
.ok_or_else(|| Error::Invalid(format!("The addon download lacks {}.", file.from)))?;
let mut zipped = zip.by_index(index).map_err(|e| Error::Invalid(e.to_string()))?;
let mut bytes = Vec::with_capacity(file.size as usize);
zipped.by_ref().take(file.size + 1).read_to_end(&mut bytes)?;
if bytes.len() as u64 != file.size || git_blob_sha1(&bytes) != file.sha1 {
return Err(Error::Invalid(format!("{} failed verification.", file.from)));
}
let target = fsx::safe_join(staging, &file.path)?;
if let Some(parent) = target.parent() {
fs::create_dir_all(parent)?;
}
fs::write(target, bytes)?;
}
Ok(())
}
fn stamp() -> String {
chrono::Local::now().format("%Y%m%d-%H%M%S").to_string()
}
/// Install or update `id` in `client` from `transport`.
pub fn install_with(transport: &dyn Transport, client: &Path, id: &str, cancel: &Cancel) -> Result<Vec<AddonView>> {
if crate::client::is_running(client) {
return Err(Error::Invalid("Close the game before installing addons.".into()));
}
let entry = catalog()?
.into_iter()
.find(|e| e.id == id)
.ok_or_else(|| Error::Invalid(format!("Unknown addon {id}.")))?;
install_entry(transport, client, &entry, cancel)?;
list(client)
}
fn install_entry(transport: &dyn Transport, client: &Path, entry: &Entry, cancel: &Cancel) -> Result<()> {
let dir = addons_dir(client);
fs::create_dir_all(&dir)?;
// Staged next to AddOns' own folders, so the final moves stay on one volume even for a linked AddOns.
let staging = tempfile::Builder::new().prefix(".coa-addon-").tempdir_in(&dir)?;
let archive = staging.path().join("archive.zip");
download(transport, &entry.archive, &archive, cancel)?;
let unpacked = staging.path().join("files");
unpack(entry, &archive, &unpacked)?;
if cancel.is_set() {
return Err(Error::Invalid("Operation cancelled.".into()));
}
let mut state = read_state(client);
let ours: Vec<String> = state.values().flat_map(|i| i.folders.clone()).collect();
// Move what is in the way out first, so a failed move leaves the client as it was.
let mut moved: Vec<(PathBuf, PathBuf)> = Vec::new();
let undo = |moved: &[(PathBuf, PathBuf)]| {
for (from, to) in moved.iter().rev() {
let _ = fs::rename(to, from);
}
};
for folder in &entry.folders {
let target = dir.join(folder);
if !target.exists() {
continue;
}
let aside = if ours.contains(folder) {
staging.path().join("old").join(folder)
} else {
dir.join(BACKUP).join(format!("{folder}-{}", stamp()))
};
if let Some(parent) = aside.parent() {
fs::create_dir_all(parent)?;
}
if let Err(e) = fs::rename(&target, &aside) {
undo(&moved);
return Err(Error::Invalid(format!("{folder} is in use and could not be replaced: {e}")));
}
moved.push((target, aside));
}
let mut placed: Vec<PathBuf> = Vec::new();
for folder in &entry.folders {
let target = dir.join(folder);
if let Err(e) = fs::rename(unpacked.join(folder), &target) {
for p in &placed {
let _ = fs::remove_dir_all(p);
}
undo(&moved);
return Err(Error::Invalid(format!("{folder} could not be installed: {e}")));
}
placed.push(target);
}
state.insert(
entry.id.clone(),
Installed {
commit: entry.commit.clone(),
folders: entry.folders.clone(),
},
);
write_state(client, &state)?;
tracing::info!(addon = %entry.id, commit = %entry.commit, "addon installed");
Ok(())
}
pub fn install(client: &Path, id: &str, cancel: &Cancel) -> Result<Vec<AddonView>> {
install_with(&crate::download::HttpTransport::with_total_timeout(1800)?, client, id, cancel)
}
/// Remove an addon the Manager installed (only its recorded folders).
pub fn remove(client: &Path, id: &str) -> Result<Vec<AddonView>> {
if crate::client::is_running(client) {
return Err(Error::Invalid("Close the game before removing addons.".into()));
}
let mut state = read_state(client);
let Some(installed) = state.remove(id) else {
return list(client);
};
let dir = addons_dir(client);
for folder in &installed.folders {
if folder.is_empty() || folder.contains(['/', '\\']) || folder.starts_with('.') {
continue;
}
let target = dir.join(folder);
if target.exists() {
fs::remove_dir_all(&target)?;
}
}
write_state(client, &state)?;
list(client)
}
#[cfg(test)]
mod tests {
use super::*;
use crate::download::Reply;
struct Serve(Vec<u8>);
impl Transport for Serve {
fn get(&self, _: &str, _: u64) -> std::result::Result<Reply, String> {
Ok(Reply { status: 200, content_range: None, body: Box::new(std::io::Cursor::new(self.0.clone())) })
}
}
/// A GitHub-like archive of the catalog entry `id` with the given file bodies (path in repo -> bytes).
fn archive(entry: &Entry, body: &dyn Fn(&AddonFile) -> Vec<u8>) -> Vec<u8> {
let mut out = std::io::Cursor::new(Vec::new());
let mut zip = zip::ZipWriter::new(&mut out);
for file in &entry.files {
zip.start_file(format!("repo-{}/{}", entry.commit, file.from), zip::write::SimpleFileOptions::default())
.unwrap();
zip.write_all(&body(file)).unwrap();
}
zip.finish().unwrap();
out.into_inner()
}
/// A small catalog entry whose files hash to what the archive will hold.
fn small_entry() -> Entry {
let bytes = b"## Interface: 30300\n".to_vec();
Entry {
id: "t".into(),
name: "T".into(),
description: BTreeMap::new(),
author: "a".into(),
license: "x".into(),
needs: None,
repo: "r".into(),
commit: "c1".into(),
archive: "https://example.invalid/a.zip".into(),
folders: vec!["TestAddon".into()],
files: vec![AddonFile {
path: "TestAddon/TestAddon.toc".into(),
from: "TestAddon/TestAddon.toc".into(),
sha1: git_blob_sha1(&bytes),
size: bytes.len() as u64,
}],
}
}
#[test]
fn the_catalog_is_valid_and_pins_every_addon() {
let entries = catalog().unwrap();
assert!(entries.len() >= 4);
let views = list(Path::new("C:/no-such-client")).unwrap();
assert_eq!(views.iter().filter(|v| v.bundled.is_some()).count(), 1, "the dev menu is shown, not installable");
for e in &entries {
assert_eq!(e.commit.len(), 40, "{}", e.id);
assert!(e.archive.starts_with("https://codeload.github.com/") && e.archive.ends_with(&e.commit));
assert!(e.description.contains_key("en") && e.description.contains_key("ru"));
for folder in &e.folders {
assert!(e.files.iter().any(|f| f.path.eq_ignore_ascii_case(&format!("{folder}/{folder}.toc"))
|| f.path.starts_with(&format!("{folder}/")) && f.path.ends_with(".toc")), "{folder} has no toc");
}
for f in &e.files {
fsx::safe_join(Path::new("C:/x"), &f.path).unwrap();
assert!(e.folders.iter().any(|folder| f.path.starts_with(&format!("{folder}/"))));
}
}
}
#[test]
#[ignore = "Downloads the catalog's small addons from GitHub"]
fn the_real_catalog_installs_from_github() {
let client = tempfile::tempdir().unwrap();
for id in ["incahoots", "coacombat", "squidbots-lite"] {
let views = install(client.path(), id, &Cancel::default()).unwrap();
let view = views.iter().find(|v| v.id == id).unwrap();
assert!(view.installed && !view.update_available, "{id}");
}
assert!(addons_dir(client.path()).join("IncahootsCoA/IncahootsCoA.toc").is_file());
assert!(addons_dir(client.path()).join("SquidBotsLite/SquidBotsLite.toc").is_file());
}
#[test]
fn git_blob_ids_match_git() {
// `printf 'hello\n' | git hash-object --stdin`
assert_eq!(git_blob_sha1(b"hello\n"), "ce013625030ba8dba906f756967f9e9ca394464a");
}
fn unpack_and_place(entry: &Entry, client: &Path, bytes: Vec<u8>) -> Result<()> {
let dir = addons_dir(client);
fs::create_dir_all(&dir)?;
let staging = tempfile::tempdir_in(&dir)?;
let archive = staging.path().join("a.zip");
download(&Serve(bytes), &entry.archive, &archive, &Cancel::default())?;
unpack(entry, &archive, &staging.path().join("files"))
}
#[test]
fn a_tampered_or_incomplete_download_is_refused() {
let client = tempfile::tempdir().unwrap();
let entry = small_entry();
let good = archive(&entry, &|_| b"## Interface: 30300\n".to_vec());
unpack_and_place(&entry, client.path(), good).unwrap();
let bad = archive(&entry, &|_| b"## Interface: 30300 evil\n".to_vec());
assert!(unpack_and_place(&entry, client.path(), bad).unwrap_err().to_string().contains("verification"));
let empty = {
let mut out = std::io::Cursor::new(Vec::new());
zip::ZipWriter::new(&mut out).finish().unwrap();
out.into_inner()
};
assert!(unpack_and_place(&entry, client.path(), empty).unwrap_err().to_string().contains("lacks"));
}
#[test]
fn install_update_and_remove_keep_other_folders() {
let client = tempfile::tempdir().unwrap();
let mut entry = small_entry();
let dir = addons_dir(client.path());
fs::create_dir_all(dir.join("TestAddon")).unwrap();
fs::write(dir.join("TestAddon/mine.lua"), b"player's own").unwrap();
fs::create_dir_all(dir.join("Other")).unwrap();
let serve = Serve(archive(&entry, &|_| b"## Interface: 30300
".to_vec()));
install_entry(&serve, client.path(), &entry, &Cancel::default()).unwrap();
assert!(dir.join("TestAddon/TestAddon.toc").is_file());
assert!(!dir.join("TestAddon/mine.lua").exists(), "the player's folder was set aside");
let backups: Vec<_> = fs::read_dir(dir.join(BACKUP)).unwrap().flatten().collect();
assert_eq!(backups.len(), 1);
assert!(backups[0].path().join("mine.lua").is_file());
assert_eq!(read_state(client.path())["t"].commit, "c1");
// An update replaces the Manager's own folder without another backup.
entry.commit = "c2".into();
install_entry(&serve, client.path(), &entry, &Cancel::default()).unwrap();
assert_eq!(read_state(client.path())["t"].commit, "c2");
assert_eq!(fs::read_dir(dir.join(BACKUP)).unwrap().count(), 1);
// A failed download changes nothing.
let broken = Serve(archive(&entry, &|_| b"tampered".to_vec()));
assert!(install_entry(&broken, client.path(), &entry, &Cancel::default()).is_err());
assert!(dir.join("TestAddon/TestAddon.toc").is_file());
remove(client.path(), "t").unwrap();
assert!(!dir.join("TestAddon").exists());
assert!(dir.join("Other").is_dir());
assert!(!read_state(client.path()).contains_key("t"));
// No leftover staging folders.
assert!(fs::read_dir(&dir).unwrap().flatten().all(|e| !e.file_name().to_string_lossy().starts_with(".coa-addon-")));
}
}
File diff suppressed because it is too large. Load diff
+6 -2
View File
@@ -308,7 +308,9 @@ pub fn with_database<T>(root: &Path, f: impl FnOnce(&Db) -> Result<T>) -> Result
let db = Db::from_repack(root, Account::Admin)?;
let observed = process::observe(root, &read_ports(root));
let mysql_was_up = observed.mysql.state == ServiceState::Running && db.ping();
if !mysql_was_up {
let db = if mysql_was_up {
db
} else {
let out = driver::run(root, Verb::StartMysql)?;
if !out.ok {
// Keep the launcher's own last lines: the title alone ("Something went wrong") hides the cause.
@@ -317,7 +319,9 @@ pub fn with_database<T>(root: &Path, f: impl FnOnce(&Db) -> Result<T>) -> Result
driver::startup_failure(root, &out)
)));
}
}
// The start may have moved the database to another port (a reserved or taken one).
Db::from_repack(root, Account::Admin)?
};
let result = f(&db);
if !mysql_was_up {
let now = process::observe(root, &read_ports(root));
-441
View File
@@ -1,441 +0,0 @@
//! CLI tool for CoA Server Manager plugin operations (testing, qualification and automation).
use std::collections::BTreeMap;
use std::fs;
use std::path::Path;
use coa_core::plugins::{self, PluginMetadata};
fn print_usage() {
eprintln!(
r#"csm_plugins CLI
Usage:
csm_plugins install <server> <id> <name> <version> <dll> [--pdb <pdb>] [--conf <dist_confs>] [--deps <deps>] [--enable] [--crash-at <point>]
csm_plugins update <server> <id> <name> <version> <dll> [--pdb <pdb>] [--conf <dist_confs>] [--crash-at <point>]
csm_plugins enable <server> <id> [--crash-at <point>]
csm_plugins disable <server> <id> [--crash-at <point>]
csm_plugins remove <server> <id> [--crash-at <point>]
csm_plugins repair <server> [--crash-at <point>]
csm_plugins recover <server>
csm_plugins prune <server>
csm_plugins list <server>
csm_plugins reconcile_squid <server> [char_schema]
csm_plugins multiworld <server> <second_root> [--allow <a,b>] [--crash-at <point>]
csm_plugins analyze <local_repository_path> [--json]
csm_plugins analyze-github <url> [--cache-dir <dir>] [--contract <v02|v03>] [--json]
csm_plugins verify-artifact-provenance <worldserver_path> [--sdk-json <path>] [--json]
"#
);
}
fn main() -> Result<(), Box<dyn std::error::Error>> {
let args: Vec<String> = std::env::args().collect();
if args.len() < 3 {
print_usage();
std::process::exit(1);
}
// Inspect for --crash-at argument
for i in 0..args.len() {
if args[i] == "--crash-at" && i + 1 < args.len() {
std::env::set_var("CSM_CRASH_AT", &args[i + 1]);
}
}
let cmd = &args[1];
let server = Path::new(&args[2]);
match cmd.as_str() {
"install" => {
if args.len() < 7 {
eprintln!("Usage: install <server> <id> <name> <version> <dll> [--pdb <pdb>] [--conf <dist_confs>] [--deps <deps>] [--enable]");
std::process::exit(1);
}
let id = &args[3];
let name = &args[4];
let version = &args[5];
let dll_path = Path::new(&args[6]);
let dll_bytes = fs::read(dll_path)?;
let digest = plugins::sha256_digest(&dll_bytes);
let mut pdb_bytes = None;
let mut conf_list = Vec::new();
let mut deps = Vec::new();
let mut enable = false;
let mut i = 7;
while i < args.len() {
match args[i].as_str() {
"--pdb" => {
i += 1;
if i < args.len() {
pdb_bytes = Some(fs::read(&args[i])?);
}
}
"--conf" => {
i += 1;
if i < args.len() {
for item in args[i].split(',') {
if !item.is_empty() {
let p = Path::new(item);
let file_name = p.file_name().unwrap().to_string_lossy().into_owned();
let bytes = fs::read(p)?;
conf_list.push((file_name, bytes));
}
}
}
}
"--deps" => {
i += 1;
if i < args.len() {
deps = args[i].split(',').filter(|s| !s.is_empty()).map(|s| s.to_string()).collect();
}
}
"--enable" => {
enable = true;
}
_ => {}
}
i += 1;
}
let conf_names: Vec<String> = conf_list.iter().map(|(n, _)| n.clone()).collect();
let dist_refs: Vec<(String, &[u8])> = conf_list.iter().map(|(n, b)| (n.clone(), b.as_slice())).collect();
let meta = PluginMetadata {
id: id.clone(),
name: name.clone(),
version: version.clone(),
description: BTreeMap::new(),
sha256: digest,
required: true,
deps,
conf_files: conf_names,
enable_key: None,
status: Some("release".into()),
icon: None,
};
plugins::install(server, meta, &dll_bytes, pdb_bytes.as_deref(), &dist_refs, enable)?;
println!("Installed plugin '{}' successfully (enabled: {})", id, enable);
}
"update" => {
if args.len() < 7 {
eprintln!("Usage: update <server> <id> <name> <version> <dll> [--pdb <pdb>] [--conf <dist_confs>]");
std::process::exit(1);
}
let id = &args[3];
let name = &args[4];
let version = &args[5];
let dll_path = Path::new(&args[6]);
let dll_bytes = fs::read(dll_path)?;
let digest = plugins::sha256_digest(&dll_bytes);
let mut pdb_bytes = None;
let mut conf_list = Vec::new();
let mut i = 7;
while i < args.len() {
match args[i].as_str() {
"--pdb" => {
i += 1;
if i < args.len() {
pdb_bytes = Some(fs::read(&args[i])?);
}
}
"--conf" => {
i += 1;
if i < args.len() {
for item in args[i].split(',') {
if !item.is_empty() {
let p = Path::new(item);
let file_name = p.file_name().unwrap().to_string_lossy().into_owned();
let bytes = fs::read(p)?;
conf_list.push((file_name, bytes));
}
}
}
}
_ => {}
}
i += 1;
}
let conf_names: Vec<String> = conf_list.iter().map(|(n, _)| n.clone()).collect();
let dist_refs: Vec<(String, &[u8])> = conf_list.iter().map(|(n, b)| (n.clone(), b.as_slice())).collect();
let meta = PluginMetadata {
id: id.clone(),
name: name.clone(),
version: version.clone(),
description: BTreeMap::new(),
sha256: digest,
required: true,
deps: vec![],
conf_files: conf_names,
enable_key: None,
status: Some("release".into()),
icon: None,
};
plugins::update(server, meta, &dll_bytes, pdb_bytes.as_deref(), &dist_refs)?;
println!("Updated plugin '{}' to version {} successfully", id, version);
}
"enable" => {
if args.len() < 4 {
eprintln!("Usage: enable <server> <id>");
std::process::exit(1);
}
let id = &args[3];
plugins::set_enabled(server, id, true)?;
println!("Enabled plugin '{}' successfully", id);
}
"disable" => {
if args.len() < 4 {
eprintln!("Usage: disable <server> <id>");
std::process::exit(1);
}
let id = &args[3];
plugins::set_enabled(server, id, false)?;
println!("Disabled plugin '{}' successfully", id);
}
"remove" => {
if args.len() < 4 {
eprintln!("Usage: remove <server> <id>");
std::process::exit(1);
}
let id = &args[3];
plugins::remove(server, id)?;
println!("Removed plugin '{}' successfully", id);
}
"repair" => {
let restored = plugins::repair(server)?;
println!("Repair complete. Restored {} plugin(s): {:?}", restored.len(), restored);
}
"recover" => {
plugins::ensure_durable_recovered(server)?;
println!("Durable transaction recovery complete (clean state restored).");
}
"prune" => {
let pruned = plugins::prune_store(server)?;
println!("Pruned {} unused store version(s): {:?}", pruned.len(), pruned);
}
"reconcile_squid" => {
let char_schema = if args.len() >= 4 { &args[3] } else { "acore_characters" };
let port_str = std::env::var("MYSQL_PORT").unwrap_or_else(|_| "3417".into());
let user = std::env::var("MYSQL_USER").unwrap_or_else(|_| "root".into());
let pass = std::env::var("MYSQL_PWD").unwrap_or_default();
let mysql_exe = std::env::var("MYSQL_EXE").unwrap_or_else(|_| "mysql".into());
let query_fn = |sql: &str| -> Result<String, coa_core::error::Error> {
let mut cmd = std::process::Command::new(&mysql_exe);
cmd.args(["-h", "127.0.0.1", "-P", &port_str, "-u", &user, "-e", sql]);
if !pass.is_empty() && pass != "trap" {
cmd.env("MYSQL_PWD", &pass);
} else {
cmd.env_remove("MYSQL_PWD");
}
let out = cmd.output().map_err(coa_core::error::Error::Io)?;
if !out.status.success() {
return Err(coa_core::error::Error::Invalid(String::from_utf8_lossy(&out.stderr).into_owned()));
}
Ok(String::from_utf8_lossy(&out.stdout).into_owned())
};
let audit = plugins::reconcile_squid_migrations(server, char_schema, Some(&query_fn))?;
println!("SQUID Reconciliation: status={:?}, applied={}", audit.db_status, audit.effective_applied);
}
"list" => {
let reg = plugins::load_registry(server)?;
println!("Plugins schema {}:", reg.schema);
for (id, p) in reg.plugins {
println!(
" - {}: enabled={}, version={}, sha256={}",
id, p.enabled, p.version, p.sha256
);
}
}
"multiworld" => {
if args.len() < 4 {
eprintln!("Usage: multiworld <server> <second_root> [--allow <a,b>]");
std::process::exit(1);
}
let second_root = Path::new(&args[3]);
let mut allowlist = None;
if args.len() >= 6 && args[4] == "--allow" {
allowlist = Some(args[5].split(',').filter(|s| !s.is_empty()).map(str::to_string).collect::<Vec<_>>());
}
plugins::prepare_multiworld_realm(server, second_root, allowlist.as_deref())?;
println!("Prepared multiworld realm at {} successfully", second_root.display());
}
"analyze" => {
let repo_path = Path::new(&args[2]);
let as_json = args.iter().any(|a| a == "--json");
let contract = if args.iter().any(|a| a == "--sdk-v02") {
coa_core::analyzer::SdkExportContract::v02()
} else {
coa_core::analyzer::SdkExportContract::v03()
};
let report = coa_core::analyzer::analyze_repository_with_contract(repo_path, &contract)?;
if as_json {
println!("{}", serde_json::to_string_pretty(&report)?);
} else {
println!("=== Module Compatibility Report v0.2 ===");
println!("Repository: {}", report.repository_name);
println!("Commit : {}", report.commit);
println!("License : {}", report.license_info.primary_license);
if let Some(ref lf) = report.license_info.license_file {
println!("License File: {}", lf);
}
if !report.license_info.vendored_licenses.is_empty() {
println!("Vendored Licenses: {:?}", report.license_info.vendored_licenses);
}
println!("Verdict : {:?}", report.classification);
println!("Status L0-L6: static={}, compile={}, link={}, contract={}, boot={}, gameplay={}, teardown={}",
report.verification_status.l0_static,
report.verification_status.l1_compile,
report.verification_status.l2_link,
report.verification_status.l3_contract,
report.verification_status.l4_engine_boot,
report.verification_status.l5_gameplay,
report.verification_status.l6_teardown);
println!("Hooks ({}):", report.hooks.len());
for h in &report.hooks {
println!(" - {} : {} ({}:{})", h.class_name, h.script_type, h.file, h.line);
}
println!("SQL Files ({}):", report.sql_files.len());
for s in &report.sql_files {
println!(" - {} [schema: {}] (create={}, alter={}, lines={})", s.file, s.target_schema, s.has_create_table, s.has_alter_table, s.line_count);
}
println!("Findings ({}):", report.findings.len());
for f in &report.findings {
println!(" [{:?}] {} (at {}:{}): {}", f.severity, f.rule_id, f.file, f.line, f.explanation);
println!(" Guidance: {}", f.recommended_action);
}
println!("Summary Reasons: {:?}", report.reasons);
}
}
"analyze-github" => {
let url = &args[2];
let mut cache_dir = None;
let mut json_out = false;
let mut i = 3;
while i < args.len() {
match args[i].as_str() {
"--cache-dir" => {
i += 1;
if i < args.len() {
cache_dir = Some(std::path::PathBuf::from(&args[i]));
}
}
"--json" => {
json_out = true;
}
_ => {}
}
i += 1;
}
match coa_core::analyzer::analyze_github_repository(url, cache_dir.as_deref()) {
Ok(report) => {
if json_out {
println!("{}", serde_json::to_string_pretty(&report)?);
} else {
println!("Repository: {}", report.repository_name);
println!("Classification: {:?}", report.classification);
println!("License: {}", report.license_info.primary_license);
println!("Cache Hit: {:?}", report.cache_hit);
println!("Tree Digest: {:?}", report.tree_digest);
println!("Commit: {:?}", report.commit);
println!("Loaders: {:?}", report.script_loaders);
println!("Hooks: {}", report.hooks.len());
println!("SQL Files: {}", report.sql_files.len());
println!("Findings: {}", report.findings.len());
}
}
Err(e) => {
eprintln!("ERROR: {}", e);
std::process::exit(1);
}
}
}
"generate-adapter" => {
let repo_path = Path::new(&args[2]);
let res = coa_core::analyzer::generate_adapter(repo_path)?;
match res {
coa_core::analyzer::AdapterGenerationResult::Success { canonical_loader, adapter_source, delegated_count } => {
println!("Canonical Master Loader: {} (delegates to {} scripts)", canonical_loader, delegated_count);
if let Some(pos) = args.iter().position(|a| a == "--output") {
if pos + 1 < args.len() {
let out_path = Path::new(&args[pos + 1]);
if let Some(p) = out_path.parent() {
std::fs::create_dir_all(p)?;
}
std::fs::write(out_path, &adapter_source)?;
println!("Adapter successfully written to: {}", out_path.display());
}
} else {
println!("--- Generated Adapter Source ---");
println!("{}", adapter_source);
}
}
coa_core::analyzer::AdapterGenerationResult::ManualAdapterRequired { reason, candidate_loaders } => {
eprintln!("MANUAL_ADAPTER_REQUIRED: {}", reason);
eprintln!("Candidate Loaders: {:?}", candidate_loaders);
std::process::exit(1);
}
coa_core::analyzer::AdapterGenerationResult::NoLoaderFound => {
eprintln!("NO_LOADER_FOUND: Unable to discover any Add*Scripts() functions.");
std::process::exit(1);
}
}
}
"verify-artifact-provenance" => {
let exe_path = Path::new(&args[2]);
let mut sdk_json = None;
let mut json_out = false;
let mut i = 3;
while i < args.len() {
match args[i].as_str() {
"--sdk-json" => {
i += 1;
if i < args.len() {
sdk_json = Some(Path::new(&args[i]));
}
}
"--json" => {
json_out = true;
}
_ => {}
}
i += 1;
}
match coa_core::provenance::verify_worldserver_provenance(exe_path, sdk_json) {
Ok(rec) => {
if json_out {
println!("{}", serde_json::to_string_pretty(&rec)?);
} else {
println!("Artifact: {}", rec.file_path);
println!("SHA-256: {}", rec.file_sha256);
println!("Arch: {}", rec.machine_architecture);
println!("Exports: {}", rec.total_export_count);
println!("Embedded ABI: {:?}", rec.embedded_abi_fingerprint);
println!("Status: {}", rec.provenance_status);
}
}
Err(e) => {
eprintln!("ERROR: {}", e);
std::process::exit(1);
}
}
}
_ => {
eprintln!("Unknown command: {}", cmd);
print_usage();
std::process::exit(1);
}
}
Ok(())
}
File diff suppressed because it is too large. Load diff
-838
View File
@@ -1,838 +0,0 @@
//! Public AzerothCore Module Catalogue integration for CoA Server Manager.
//!
//! Provides cached, prioritized, and overlay-enriched discovery of AzerothCore modules
//! sourced from `https://www.azerothcore.org/data/catalogue.json`.
//!
//! Features:
//! - Thread-safe periodic synchronization with ETag (`If-None-Match`) support
//! - Transparent offline caching with atomic disk persistence
//! - Priority ordering: CoA Recommended / Verified modules always appear first
//! - Seamless deduplication by GitHub Repository ID and normalized slug
//! - Deep integration with the CoA Compatibility Overlay (`coa-modules-overlay.json`)
//! - Hard policy blocking to prevent installation of known crashers or security risks
use std::collections::{BTreeMap, HashSet};
use std::fs;
use std::path::Path;
use std::sync::Mutex;
use std::time::Duration;
use chrono::Utc;
use serde::{Deserialize, Serialize};
use crate::error::{Error, Result};
use crate::fsx;
pub const OFFICIAL_CATALOGUE_URL: &str = "https://www.azerothcore.org/data/catalogue.json";
pub const DEFAULT_CACHE_TTL_SECS: i64 = 12 * 3600; // 12 hours
const CONNECT_TIMEOUT_SECS: u64 = 10;
const READ_TIMEOUT_SECS: u64 = 25;
static CATALOGUE_LOCK: Mutex<()> = Mutex::new(());
static EMBEDDED_OVERLAY_JSON: &str = include_str!("coa-modules-overlay.json");
// ---------------------------------------------------------------------------
// External Data Models (matching official AzerothCore JSON)
// ---------------------------------------------------------------------------
#[derive(Debug, Clone, Deserialize)]
pub struct OfficialCatalogueRaw {
#[serde(default)]
pub global_search: bool,
#[serde(default)]
pub organizations: BTreeMap<String, BTreeMap<String, Vec<OfficialRepoRaw>>>,
}
#[derive(Debug, Clone, Deserialize)]
pub struct OfficialRepoRaw {
pub id: u64,
pub name: String,
pub full_name: String,
#[serde(default)]
pub description: Option<String>,
#[serde(default)]
pub stargazers_count: u32,
#[serde(default)]
pub created_at: Option<String>,
#[serde(default = "default_branch_val")]
pub default_branch: String,
#[serde(default)]
pub owner: Option<OfficialOwnerRaw>,
pub html_url: String,
#[serde(default)]
pub forks_count: u32,
#[serde(default)]
pub watchers_count: u32,
#[serde(default)]
pub pushed_at: Option<String>,
#[serde(default)]
pub updated_at: Option<String>,
#[serde(default)]
pub license: Option<OfficialLicenseRaw>,
#[serde(default)]
pub topics: Vec<String>,
}
fn default_branch_val() -> String {
"master".into()
}
#[derive(Debug, Clone, Deserialize)]
pub struct OfficialOwnerRaw {
pub login: String,
#[serde(default)]
pub avatar_url: Option<String>,
#[serde(default)]
pub html_url: Option<String>,
}
#[derive(Debug, Clone, Deserialize)]
pub struct OfficialLicenseRaw {
#[serde(default)]
pub spdx_id: Option<String>,
}
// ---------------------------------------------------------------------------
// CoA Overlay Models
// ---------------------------------------------------------------------------
#[derive(Debug, Clone, Serialize, Deserialize)]
pub struct CoaOverlayDocument {
pub version: u32,
#[serde(default)]
pub description: Option<String>,
pub rules: Vec<CoaOverlayRule>,
}
#[derive(Debug, Clone, Serialize, Deserialize)]
pub struct CoaOverlayRule {
#[serde(default)]
pub repo_id: Option<u64>,
pub repo_slug: String,
pub status: CoaCompatibilityStatus,
#[serde(default)]
pub is_recommended: bool,
#[serde(default)]
pub reason: Option<String>,
#[serde(default)]
pub tested_version: Option<String>,
#[serde(default)]
pub tested_abi: Option<String>,
}
#[derive(Debug, Clone, Copy, PartialEq, Eq, PartialOrd, Ord, Serialize, Deserialize)]
pub enum CoaCompatibilityStatus {
Recommended,
Verified,
RequiresAdapter,
Unverified,
Incompatible,
Blocked,
}
impl std::fmt::Display for CoaCompatibilityStatus {
fn fmt(&self, f: &mut std::fmt::Formatter<'_>) -> std::fmt::Result {
match self {
Self::Recommended => write!(f, "Recommended"),
Self::Verified => write!(f, "Verified"),
Self::RequiresAdapter => write!(f, "RequiresAdapter"),
Self::Unverified => write!(f, "Unverified"),
Self::Incompatible => write!(f, "Incompatible"),
Self::Blocked => write!(f, "Blocked"),
}
}
}
// ---------------------------------------------------------------------------
// Internal Normalized Item & API Response
// ---------------------------------------------------------------------------
#[derive(Debug, Clone, Serialize, Deserialize, PartialEq, Eq)]
pub struct PublicCatalogueItem {
pub id: u64,
pub name: String,
pub full_name: String,
pub owner: String,
pub html_url: String,
pub description: String,
pub stars: u32,
pub forks: u32,
pub default_branch: String,
#[serde(default)]
pub pushed_at: Option<String>,
#[serde(default)]
pub updated_at: Option<String>,
#[serde(default)]
pub license: Option<String>,
#[serde(default)]
pub topics: Vec<String>,
pub coa_status: CoaCompatibilityStatus,
pub coa_status_source: String, // "Overlay", "VerifiedCatalog", "AutoPublic"
pub conflict_reason: Option<String>,
pub is_coa_recommended: bool,
}
#[derive(Debug, Clone, Serialize, Deserialize)]
pub struct CachedDocument {
pub schema_version: u32,
pub cached_at: String,
pub timestamp: i64,
#[serde(default)]
pub etag: Option<String>,
pub items: Vec<PublicCatalogueItem>,
}
#[derive(Debug, Clone, Serialize, Deserialize)]
pub struct PublicCatalogueResponse {
pub items: Vec<PublicCatalogueItem>,
pub cached_at: String,
pub is_offline: bool,
#[serde(default)]
pub etag: Option<String>,
pub total_count: usize,
pub recommended_count: usize,
}
// ---------------------------------------------------------------------------
// Helper: Normalization of Slugs & URLs
// ---------------------------------------------------------------------------
pub fn normalize_repo_slug(url_or_slug: &str) -> String {
let mut s = url_or_slug.trim();
if let Some(pos) = s.find("://") {
s = &s[pos + 3..];
}
if let Some(pos) = s.find('@') {
if let Some(colon) = s[pos..].find(':') {
s = &s[pos + colon + 1..];
}
}
if let Some(stripped) = s.strip_prefix("github.com/") {
s = stripped;
}
// Remove query params or fragments
if let Some(pos) = s.find('?') {
s = &s[..pos];
}
if let Some(pos) = s.find('#') {
s = &s[..pos];
}
// Remove tree/branches if present (e.g. repo/tree/branch/sub)
let parts: Vec<&str> = s.split('/').filter(|p| !p.is_empty()).collect();
if parts.len() >= 2 {
let owner = parts[0].to_ascii_lowercase();
let mut repo = parts[1].to_ascii_lowercase();
if repo.ends_with(".git") {
repo.truncate(repo.len() - 4);
}
format!("{owner}/{repo}")
} else {
s.trim_end_matches(".git").to_ascii_lowercase()
}
}
pub fn load_coa_overlay(optional_overlay_path: Option<&Path>) -> CoaOverlayDocument {
let mut doc: CoaOverlayDocument = serde_json::from_str(EMBEDDED_OVERLAY_JSON)
.unwrap_or_else(|_| CoaOverlayDocument {
version: 1,
description: None,
rules: Vec::new(),
});
if let Some(path) = optional_overlay_path {
if path.is_file() {
if let Ok(content) = fs::read_to_string(path) {
if let Ok(external) = serde_json::from_str::<CoaOverlayDocument>(&content) {
for ext_rule in external.rules {
if let Some(existing) = doc
.rules
.iter_mut()
.find(|r| normalize_repo_slug(&r.repo_slug) == normalize_repo_slug(&ext_rule.repo_slug))
{
*existing = ext_rule;
} else {
doc.rules.push(ext_rule);
}
}
}
}
}
}
doc
}
/// Checks if a repository is explicitly blocked by CoA policy.
/// Returns `Some(reason)` if blocked, otherwise `None`.
pub fn is_blocked_repo(url_or_slug: &str) -> Option<String> {
let target = normalize_repo_slug(url_or_slug);
let overlay = load_coa_overlay(None);
for rule in overlay.rules {
if rule.status == CoaCompatibilityStatus::Blocked && normalize_repo_slug(&rule.repo_slug) == target {
return Some(rule.reason.unwrap_or_else(|| "Module blocked by CoA stability/security policy.".into()));
}
}
None
}
// ---------------------------------------------------------------------------
// Normalization & Deduplication Logic
// ---------------------------------------------------------------------------
pub fn normalize_catalogue(
raw: &OfficialCatalogueRaw,
overlay: &CoaOverlayDocument,
) -> Vec<PublicCatalogueItem> {
let mut normalized = Vec::new();
let mut seen_ids = HashSet::new();
let mut seen_slugs = HashSet::new();
// 1. Map overlay rules by slug for O(1) lookup
let mut overlay_map: BTreeMap<String, &CoaOverlayRule> = BTreeMap::new();
for rule in &overlay.rules {
overlay_map.insert(normalize_repo_slug(&rule.repo_slug), rule);
}
// 2. Extract repos from the category "azerothcore-module"
let mut repos = Vec::new();
for (_, topics) in &raw.organizations {
for (topic_name, list) in topics {
if topic_name == "azerothcore-module" {
repos.extend(list.iter());
}
}
}
// If "azerothcore-module" was empty or structure differs, collect all modules
if repos.is_empty() {
for (_, topics) in &raw.organizations {
for (_, list) in topics {
repos.extend(list.iter());
}
}
}
// 3. Process and deduplicate
for repo in repos {
let slug = normalize_repo_slug(&repo.full_name);
if repo.id != 0 && !seen_ids.insert(repo.id) {
continue;
}
if !seen_slugs.insert(slug.clone()) {
continue;
}
let owner = repo
.owner
.as_ref()
.map(|o| o.login.clone())
.unwrap_or_else(|| {
slug.split('/').next().unwrap_or("unknown").to_string()
});
// Determine CoA status from overlay or default to Unverified
let (coa_status, coa_source, reason, is_rec) = if let Some(rule) = overlay_map.get(&slug) {
(
rule.status,
"Overlay".to_string(),
rule.reason.clone(),
rule.is_recommended || rule.status == CoaCompatibilityStatus::Recommended,
)
} else {
(
CoaCompatibilityStatus::Unverified,
"AutoPublic".to_string(),
None,
false,
)
};
let license = repo.license.as_ref().and_then(|l| l.spdx_id.clone());
normalized.push(PublicCatalogueItem {
id: repo.id,
name: repo.name.clone(),
full_name: repo.full_name.clone(),
owner,
html_url: repo.html_url.clone(),
description: repo.description.clone().unwrap_or_default(),
stars: repo.stargazers_count,
forks: repo.forks_count,
default_branch: repo.default_branch.clone(),
pushed_at: repo.pushed_at.clone(),
updated_at: repo.updated_at.clone(),
license,
topics: repo.topics.clone(),
coa_status,
coa_status_source: coa_source,
conflict_reason: reason,
is_coa_recommended: is_rec,
});
}
// 4. Also ensure any Recommended overlay rules that were not present in the public raw catalog
// are included so they are never lost
for rule in &overlay.rules {
let slug = normalize_repo_slug(&rule.repo_slug);
if seen_slugs.insert(slug.clone()) {
let parts: Vec<&str> = slug.split('/').collect();
let (owner, name) = if parts.len() >= 2 {
(parts[0].to_string(), parts[1].to_string())
} else {
("corfirean".to_string(), slug.clone())
};
normalized.push(PublicCatalogueItem {
id: rule.repo_id.unwrap_or(0),
name: name.clone(),
full_name: slug.clone(),
owner,
html_url: format!("https://github.com/{}", slug),
description: rule.reason.clone().unwrap_or_default(),
stars: 0,
forks: 0,
default_branch: "master".to_string(),
pushed_at: None,
updated_at: None,
license: Some("AGPL-3.0".to_string()),
topics: vec!["azerothcore-module".to_string(), "coa-verified".to_string()],
coa_status: rule.status,
coa_status_source: "Overlay".to_string(),
conflict_reason: rule.reason.clone(),
is_coa_recommended: rule.is_recommended || rule.status == CoaCompatibilityStatus::Recommended,
});
}
}
// 5. Sort:
// Group A (Recommended/Verified) first, then by Stars desc, then by pushed_at desc
normalized.sort_by(|a, b| {
// Priority 1: Recommended modules first
match (a.is_coa_recommended, b.is_coa_recommended) {
(true, false) => return std::cmp::Ordering::Less,
(false, true) => return std::cmp::Ordering::Greater,
_ => {}
}
// Priority 2: Status order (Verified before Unverified, Blocked at end)
if a.coa_status != b.coa_status {
return a.coa_status.cmp(&b.coa_status);
}
// Priority 3: Stars descending
if b.stars != a.stars {
return b.stars.cmp(&a.stars);
}
// Priority 4: pushed_at descending
let pa = a.pushed_at.as_deref().unwrap_or("");
let pb = b.pushed_at.as_deref().unwrap_or("");
if pb != pa {
return pb.cmp(pa);
}
// Deterministic tie-breaker
a.full_name.cmp(&b.full_name)
});
normalized
}
// ---------------------------------------------------------------------------
// Network Fetcher & Cache Manager
// ---------------------------------------------------------------------------
pub fn fetch_or_load_catalogue(
cache_dir: &Path,
force_refresh: bool,
) -> Result<PublicCatalogueResponse> {
let _guard = CATALOGUE_LOCK.lock().map_err(|_| {
Error::Invalid("Failed to acquire catalogue cache lock.".into())
})?;
fs::create_dir_all(cache_dir)?;
let cache_file = cache_dir.join("catalogue_cache.json");
let etag_file = cache_dir.join("catalogue_etag.txt");
let overlay_path = cache_dir.join("coa-modules-overlay.json");
let overlay = load_coa_overlay(Some(&overlay_path));
let now_ts = Utc::now().timestamp();
// 1. Check if disk cache exists and is fresh
if !force_refresh && cache_file.is_file() {
if let Ok(content) = fs::read_to_string(&cache_file) {
if let Ok(cached) = serde_json::from_str::<CachedDocument>(&content) {
let age = now_ts - cached.timestamp;
if age < DEFAULT_CACHE_TTL_SECS && !cached.items.is_empty() {
let rec_count = cached.items.iter().filter(|i| i.is_coa_recommended).count();
return Ok(PublicCatalogueResponse {
total_count: cached.items.len(),
recommended_count: rec_count,
cached_at: cached.cached_at,
is_offline: false,
etag: cached.etag,
items: cached.items,
});
}
}
}
}
// 2. Perform Network Fetch with ETag support
let stored_etag = fs::read_to_string(&etag_file).ok().map(|s| s.trim().to_string());
let client = reqwest::blocking::Client::builder()
.connect_timeout(Duration::from_secs(CONNECT_TIMEOUT_SECS))
.timeout(Duration::from_secs(READ_TIMEOUT_SECS))
.redirect(reqwest::redirect::Policy::limited(5))
.build()
.map_err(|e| Error::Invalid(format!("HTTP client initialization failed: {}", e)))?;
let mut request = client.get(OFFICIAL_CATALOGUE_URL)
.header(reqwest::header::USER_AGENT, "CSM-Modules-Preview/0.7.1");
if let Some(ref etag) = stored_etag {
if !force_refresh && cache_file.is_file() {
request = request.header(reqwest::header::IF_NONE_MATCH, etag.as_str());
}
}
let fetch_result = request.send();
match fetch_result {
Ok(response) => {
let status = response.status();
// 2.1 Handle 304 Not Modified
if status == reqwest::StatusCode::NOT_MODIFIED {
if cache_file.is_file() {
if let Ok(content) = fs::read_to_string(&cache_file) {
if let Ok(mut cached) = serde_json::from_str::<CachedDocument>(&content) {
cached.timestamp = now_ts;
cached.cached_at = Utc::now().to_rfc3339();
let _ = fsx::atomic_write_json(&cache_file, &cached);
let rec_count = cached.items.iter().filter(|i| i.is_coa_recommended).count();
return Ok(PublicCatalogueResponse {
total_count: cached.items.len(),
recommended_count: rec_count,
cached_at: cached.cached_at,
is_offline: false,
etag: cached.etag,
items: cached.items,
});
}
}
}
// If 304 received but cache file was missing or corrupt, re-fetch without etag
return fetch_or_load_catalogue(cache_dir, true);
}
// 2.2 Handle 200 OK
if status.is_success() {
let new_etag = response
.headers()
.get(reqwest::header::ETAG)
.and_then(|h| h.to_str().ok())
.map(|s| s.to_string());
let text = response.text().map_err(|e| {
Error::Invalid(format!("Failed to read catalogue response body: {}", e))
})?;
let raw: OfficialCatalogueRaw = serde_json::from_str(&text).map_err(|e| {
Error::Invalid(format!("Failed to parse AzerothCore official catalogue JSON: {}", e))
})?;
let items = normalize_catalogue(&raw, &overlay);
let rec_count = items.iter().filter(|i| i.is_coa_recommended).count();
let now_str = Utc::now().to_rfc3339();
let cached_doc = CachedDocument {
schema_version: 1,
cached_at: now_str.clone(),
timestamp: now_ts,
etag: new_etag.clone(),
items: items.clone(),
};
// Persist cache and etag atomically
let _ = fsx::atomic_write_json(&cache_file, &cached_doc);
if let Some(ref tag) = new_etag {
let _ = fs::write(&etag_file, tag);
}
return Ok(PublicCatalogueResponse {
total_count: items.len(),
recommended_count: rec_count,
cached_at: now_str,
is_offline: false,
etag: new_etag,
items,
});
}
// If non-200 and non-304 HTTP status, fallback to existing cache if available
try_offline_fallback(&cache_file, stored_etag, &overlay)
}
Err(_net_err) => {
// Network unreachable, DNS timeout, connection reset -> offline fallback
try_offline_fallback(&cache_file, stored_etag, &overlay)
}
}
}
fn try_offline_fallback(
cache_file: &Path,
stored_etag: Option<String>,
overlay: &CoaOverlayDocument,
) -> Result<PublicCatalogueResponse> {
if cache_file.is_file() {
if let Ok(content) = fs::read_to_string(cache_file) {
if let Ok(cached) = serde_json::from_str::<CachedDocument>(&content) {
let rec_count = cached.items.iter().filter(|i| i.is_coa_recommended).count();
return Ok(PublicCatalogueResponse {
total_count: cached.items.len(),
recommended_count: rec_count,
cached_at: cached.cached_at,
is_offline: true,
etag: cached.etag.or(stored_etag),
items: cached.items,
});
}
}
}
// If completely offline and no cache file exists, build minimal catalog from overlay rules
let empty_raw = OfficialCatalogueRaw {
global_search: false,
organizations: BTreeMap::new(),
};
let items = normalize_catalogue(&empty_raw, overlay);
let rec_count = items.iter().filter(|i| i.is_coa_recommended).count();
Ok(PublicCatalogueResponse {
total_count: items.len(),
recommended_count: rec_count,
cached_at: Utc::now().to_rfc3339(),
is_offline: true,
etag: None,
items,
})
}
// ---------------------------------------------------------------------------
// Unit & Integration Tests
// ---------------------------------------------------------------------------
#[cfg(test)]
mod tests {
use super::*;
use tempfile::tempdir;
fn sample_official_json() -> &'static str {
r#"{
"global_search": true,
"organizations": {
"azerothcore": {
"azerothcore-module": [
{
"id": 101,
"name": "mod-npc-buffer",
"full_name": "azerothcore/mod-npc-buffer",
"description": "NPC buffer master",
"stargazers_count": 55,
"default_branch": "master",
"html_url": "https://github.com/azerothcore/mod-npc-buffer",
"forks_count": 12,
"watchers_count": 55,
"pushed_at": "2026-10-10T12:00:00Z",
"updated_at": "2026-10-10T12:00:00Z",
"license": { "spdx_id": "AGPL-3.0" },
"topics": ["azerothcore-module", "utility"]
},
{
"id": 102,
"name": "mod-random-community",
"full_name": "author/mod-random-community",
"description": "A community module",
"stargazers_count": 120,
"default_branch": "main",
"html_url": "https://github.com/author/mod-random-community",
"forks_count": 5,
"watchers_count": 120,
"pushed_at": "2026-09-01T12:00:00Z",
"updated_at": "2026-09-01T12:00:00Z",
"license": null,
"topics": ["azerothcore-module"]
},
{
"id": 103,
"name": "mod-learn-spells",
"full_name": "azerothcore/mod-learn-spells",
"description": "Auto teach spells",
"stargazers_count": 48,
"default_branch": "master",
"html_url": "https://github.com/azerothcore/mod-learn-spells",
"forks_count": 8,
"watchers_count": 48,
"pushed_at": "2026-08-01T12:00:00Z",
"updated_at": "2026-08-01T12:00:00Z",
"license": { "spdx_id": "AGPL-3.0" },
"topics": ["azerothcore-module"]
},
{
"id": 104,
"name": "mod-ahbot",
"full_name": "azerothcore/mod-ahbot",
"description": "Upstream ahbot",
"stargazers_count": 80,
"default_branch": "master",
"html_url": "https://github.com/azerothcore/mod-ahbot",
"forks_count": 20,
"watchers_count": 80,
"pushed_at": "2026-07-01T12:00:00Z",
"updated_at": "2026-07-01T12:00:00Z",
"license": null,
"topics": ["azerothcore-module"]
},
{
"id": 101,
"name": "mod-npc-buffer-duplicate",
"full_name": "azerothcore/mod-npc-buffer",
"description": "Duplicate entry with same id and slug",
"stargazers_count": 55,
"default_branch": "master",
"html_url": "https://github.com/azerothcore/mod-npc-buffer",
"forks_count": 12,
"watchers_count": 55,
"pushed_at": "2026-10-10T12:00:00Z",
"updated_at": "2026-10-10T12:00:00Z",
"license": { "spdx_id": "AGPL-3.0" },
"topics": ["azerothcore-module"]
}
],
"azerothcore-lua": [
{
"id": 201,
"name": "pure-lua-script",
"full_name": "some/pure-lua-script",
"stargazers_count": 10,
"default_branch": "main",
"html_url": "https://github.com/some/pure-lua-script"
}
]
}
}
}"#
}
#[test]
fn test_slug_normalization() {
assert_eq!(normalize_repo_slug("https://github.com/azerothcore/mod-npc-buffer.git"), "azerothcore/mod-npc-buffer");
assert_eq!(normalize_repo_slug("https://github.com/AzerothCore/Mod-NPC-Buffer/"), "azerothcore/mod-npc-buffer");
assert_eq!(normalize_repo_slug("git@github.com:Corfirean/mod-coa-playerbots.git"), "corfirean/mod-coa-playerbots");
assert_eq!(normalize_repo_slug("author/repo"), "author/repo");
}
#[test]
fn test_overlay_loading_and_blocked_detection() {
let overlay = load_coa_overlay(None);
assert!(!overlay.rules.is_empty(), "Embedded overlay must contain rules");
// Verify mod-ahbot is blocked
assert!(is_blocked_repo("https://github.com/azerothcore/mod-ahbot").is_some());
assert!(is_blocked_repo("azerothcore/mod-ahbot").is_some());
// Verify clean repo is not blocked
assert!(is_blocked_repo("https://github.com/azerothcore/mod-npc-buffer").is_none());
assert!(is_blocked_repo("random-author/clean-module").is_none());
}
#[test]
fn test_official_json_parsing_and_normalization() {
let raw: OfficialCatalogueRaw = serde_json::from_str(sample_official_json()).expect("Must parse sample JSON");
let overlay = load_coa_overlay(None);
let items = normalize_catalogue(&raw, &overlay);
// Deduplication: id 101 was duplicated, should only appear once
let buffer_count = items.iter().filter(|i| i.full_name == "azerothcore/mod-npc-buffer").count();
assert_eq!(buffer_count, 1, "Duplicate repo with ID 101 must be deduplicated");
// Check statuses assigned via overlay
let buffer = items.iter().find(|i| i.full_name == "azerothcore/mod-npc-buffer").expect("mod-npc-buffer must exist");
assert_eq!(buffer.coa_status, CoaCompatibilityStatus::Verified);
assert!(buffer.is_coa_recommended);
let learn_spells = items.iter().find(|i| i.full_name == "azerothcore/mod-learn-spells").expect("mod-learn-spells must exist");
assert_eq!(learn_spells.coa_status, CoaCompatibilityStatus::Incompatible);
assert!(!learn_spells.is_coa_recommended);
assert!(learn_spells.conflict_reason.is_some());
let ahbot = items.iter().find(|i| i.full_name == "azerothcore/mod-ahbot").expect("mod-ahbot must exist");
assert_eq!(ahbot.coa_status, CoaCompatibilityStatus::Blocked);
let community = items.iter().find(|i| i.full_name == "author/mod-random-community").expect("community module must exist");
assert_eq!(community.coa_status, CoaCompatibilityStatus::Unverified);
assert_eq!(community.coa_status_source, "AutoPublic");
assert!(!community.is_coa_recommended);
// Check priority sorting: Recommended modules must come first
let first_non_rec_idx = items.iter().position(|i| !i.is_coa_recommended).unwrap_or(items.len());
for (idx, item) in items.iter().enumerate() {
if idx < first_non_rec_idx {
assert!(item.is_coa_recommended, "Items before boundary must be recommended");
} else {
assert!(!item.is_coa_recommended, "Items after boundary must not be recommended");
}
}
}
#[test]
fn test_disk_caching_and_offline_fallback() {
let d = tempdir().expect("tempdir");
let cache_dir = d.path();
// 1. Manually write a cached document
let items = vec![
PublicCatalogueItem {
id: 999,
name: "cached-mod".into(),
full_name: "test/cached-mod".into(),
owner: "test".into(),
html_url: "https://github.com/test/cached-mod".into(),
description: "Test description".into(),
stars: 42,
forks: 2,
default_branch: "master".into(),
pushed_at: Some("2026-10-01T00:00:00Z".into()),
updated_at: Some("2026-10-01T00:00:00Z".into()),
license: Some("MIT".into()),
topics: vec!["azerothcore-module".into()],
coa_status: CoaCompatibilityStatus::Unverified,
coa_status_source: "CacheTest".into(),
conflict_reason: None,
is_coa_recommended: false,
}
];
let cached_doc = CachedDocument {
schema_version: 1,
cached_at: Utc::now().to_rfc3339(),
timestamp: Utc::now().timestamp(),
etag: Some("\"sample-etag\"".into()),
items: items.clone(),
};
let cache_file = cache_dir.join("catalogue_cache.json");
fsx::atomic_write_json(&cache_file, &cached_doc).expect("write cache");
// 2. Read without force refresh -> should return cached doc instantly without network
let resp = fetch_or_load_catalogue(cache_dir, false).expect("load from cache");
assert_eq!(resp.total_count, 1);
assert_eq!(resp.items[0].name, "cached-mod");
assert!(!resp.is_offline);
// 3. Corrupt the cache file -> test resilience
fs::write(&cache_file, b"NOT_A_VALID_JSON").expect("write corrupt cache");
let overlay = load_coa_overlay(None);
let fallback_resp = try_offline_fallback(&cache_file, None, &overlay).expect("fallback must succeed");
assert!(fallback_resp.is_offline);
assert!(!fallback_resp.items.is_empty(), "Fallback must supply overlay items even on corrupt cache");
}
}
+9 -91
View File
@@ -21,19 +21,14 @@ pub struct Envelope {
}
pub fn verify(bytes: &[u8], channel: &str, key: &str) -> Result<Pointer> {
verify_with(bytes, channel, key)
}
/// A pointer must carry its own channel key's signature, never the other one.
fn verify_with(bytes: &[u8], channel: &str, key: &str) -> Result<Pointer> {
let envelope: Envelope =
serde_json::from_slice(bytes).map_err(|e| Error::InvalidManifest(e.to_string()))?;
crate::signing::verify_exact(envelope.payload.as_bytes(), &envelope.signature, key)?;
crate::signing::verify(envelope.payload.as_bytes(), &envelope.signature, key)?;
let pointer: Pointer = serde_json::from_str(&envelope.payload)
.map_err(|e| Error::InvalidManifest(e.to_string()))?;
if pointer.schema != 1
|| pointer.channel != channel
|| pointer.release_tag != release_tag(channel, &pointer.version)
|| pointer.release_tag != format!("server-{}", pointer.version)
|| pointer.version.is_empty()
|| !pointer
.version
@@ -47,60 +42,20 @@ fn verify_with(bytes: &[u8], channel: &str, key: &str) -> Result<Pointer> {
Ok(pointer)
}
/// The release a channel's packages are published under: `server-<v>`, or `preview-server-<v>` for the
/// Modules Preview (pre-releases that never become the repository's latest release).
pub fn release_tag(channel: &str, version: &str) -> String {
if channel == "preview" {
format!("preview-server-{version}")
} else {
format!("server-{version}")
}
}
/// Where a channel's pointer lives and which key signs it. The preview channel has its own branch and
/// key, so publishing it can never move a stable or edge pointer.
fn channel_home(channel: &str) -> Result<(&'static str, &'static str)> {
match channel {
"stable" | "edge" => Ok(("channels", crate::signing::EMBEDDED_PUBLIC_KEY)),
"preview" => Ok(("preview-channels", crate::signing::PREVIEW_PUBLIC_KEY)),
_ => Err(Error::InvalidManifest("Unknown release channel".into())),
}
}
pub fn resolve(channel: &str) -> Result<Source> {
let (branch, key) = channel_home(channel)?;
let source = Source::Url(format!("https://raw.githubusercontent.com/Corfirean/coa-server-build/{branch}"));
if channel != "stable" && channel != "edge" {
return Err(Error::InvalidManifest("Unknown release channel".into()));
}
let source =
Source::Url("https://raw.githubusercontent.com/Corfirean/coa-server-build/channels".into());
let bytes = fetch_small(&source, &format!("{channel}.json"))?;
let pointer = verify_with(&bytes, channel, key)?;
let pointer = verify(&bytes, channel, crate::signing::EMBEDDED_PUBLIC_KEY)?;
Ok(Source::Url(format!(
"https://github.com/Corfirean/coa-server-build/releases/download/{}",
pointer.release_tag
)))
}
/// The stable release used when the stable pointer has not been published yet.
pub const STABLE_FALLBACK_URL: &str =
"https://github.com/Corfirean/coa-server-build/releases/download/stable";
/// Stable updates and installation images: the signed stable pointer, else the fixed stable release.
pub fn stable_source() -> Result<Source> {
match resolve("stable") {
Ok(source) => Ok(source),
Err(Error::PackageNotPublished(_)) => Ok(Source::Url(STABLE_FALLBACK_URL.into())),
Err(error) => Err(error),
}
}
/// Where the Modules Preview Manager looks for server updates when none is chosen: its own signed channel,
/// or the stable channel until a preview exists (a stable server is where every preview server starts).
pub fn preview_update_source() -> Result<Source> {
match resolve("preview") {
Ok(source) => Ok(source),
Err(Error::PackageNotPublished(_)) => stable_source(),
Err(error) => Err(error),
}
}
pub fn sign(pointer: &Pointer, seed: &str) -> Result<Vec<u8>> {
use base64::{engine::general_purpose::STANDARD, Engine};
use ed25519_dalek::{Signer, SigningKey};
@@ -120,7 +75,7 @@ pub fn sign(pointer: &Pointer, seed: &str) -> Result<Vec<u8>> {
verify(
&bytes,
&pointer.channel,
channel_home(&pointer.channel)?.1,
crate::signing::EMBEDDED_PUBLIC_KEY,
)?;
Ok(bytes)
}
@@ -160,41 +115,4 @@ mod tests {
let (bytes, key) = signed(&p);
assert!(verify(&bytes, "stable", &key).is_err());
}
#[test]
fn preview_pointers_name_preview_releases_and_live_apart_from_stable() {
let p = Pointer {
schema: 1,
channel: "preview".into(),
version: "0.261105.1".into(),
release_tag: "preview-server-0.261105.1".into(),
snapshot: "b".repeat(64),
};
let (bytes, key) = signed(&p);
assert_eq!(verify(&bytes, "preview", &key).unwrap().release_tag, "preview-server-0.261105.1");
// A preview pointer is not a stable one, and a stable-style tag is not a preview release.
assert!(verify(&bytes, "stable", &key).is_err());
let stable_tag = Pointer { release_tag: "server-0.261105.1".into(), ..p };
let (bytes, key) = signed(&stable_tag);
assert!(verify(&bytes, "preview", &key).is_err());
assert_eq!(channel_home("preview").unwrap().0, "preview-channels");
assert_eq!(channel_home("stable").unwrap().0, "channels");
assert!(channel_home("nightly").is_err());
}
#[test]
fn each_channel_pointer_needs_its_own_key() {
// A pointer signed by some other key (here: not the embedded stable key) fails under the stable key
// even though the app also trusts the preview key for packages.
let p = Pointer {
schema: 1,
channel: "stable".into(),
version: "0.261105.2".into(),
release_tag: "server-0.261105.2".into(),
snapshot: "c".repeat(64),
};
let (bytes, _) = signed(&p);
assert!(verify_with(&bytes, "stable", crate::signing::EMBEDDED_PUBLIC_KEY).is_err());
assert!(verify_with(&bytes, "preview", crate::signing::PREVIEW_PUBLIC_KEY).is_err());
}
}
+65 -10
View File
@@ -15,7 +15,8 @@ use crate::fsx;
pub use crate::glue_config;
pub const ADDON_NAME: &str = "CoABotUI";
const EXECUTABLES: [&str; 3] = ["Ascension.exe", "Wow.exe", "WoW.exe"];
// CoA Custom Races V2 ships its own client (CoACustomRace.exe) next to Ascension.exe and must be started instead.
const EXECUTABLES: [&str; 4] = ["CoACustomRace.exe", "Ascension.exe", "Wow.exe", "WoW.exe"];
pub fn is_running(client: &Path) -> bool {
if crate::platform::flavor() == crate::platform::Flavor::Docker {
@@ -71,13 +72,23 @@ fn realm_config(old: &[u8], realm: &str) -> Vec<u8> {
}
pub fn sync_realm(client: &Path, meta: &Path, mode: crate::realms::Mode) -> Result<bool> {
sync_realm_when_closed(client, meta, mode, is_running(client))
let realm = match mode {
crate::realms::Mode::Coa => "Conquest of Azeroth",
crate::realms::Mode::Wildcard => "Wildcard",
crate::realms::Mode::Reborn => "Warcraft Reborn",
};
sync_realm_when_closed(client, meta, realm, is_running(client))
}
/// [`sync_realm`] with the realm's name as the server shows it (the owner may have renamed it).
pub fn sync_realm_named(client: &Path, meta: &Path, realm: &str) -> Result<bool> {
sync_realm_when_closed(client, meta, realm, is_running(client))
}
fn sync_realm_when_closed(
client: &Path,
meta: &Path,
mode: crate::realms::Mode,
realm: &str,
running: bool,
) -> Result<bool> {
if running {
@@ -89,11 +100,6 @@ fn sync_realm_when_closed(
Err(e) if e.kind() == std::io::ErrorKind::NotFound => Vec::new(),
Err(e) => return Err(e.into()),
};
let realm = match mode {
crate::realms::Mode::Coa => "Conquest of Azeroth",
crate::realms::Mode::Wildcard => "Wildcard",
crate::realms::Mode::Reborn => "Warcraft Reborn",
};
let new = realm_config(&old, realm);
if new == old {
return Ok(true);
@@ -409,6 +415,38 @@ pub fn install_addon(client: &Path, meta: &Path, source: &Path) -> Result<()> {
Ok(())
}
/// Remove the game's cache of server data (`Cache/WDB/<locale>/*.wdb`: creatures, items, quests, pages). The client
/// keeps answers it got from a server; after the server's data changes they show old names and stats until the
/// cache is gone. Only `.wdb` files under `Cache/WDB` are removed. Returns how many.
pub fn clear_game_cache(client: &Path) -> Result<usize> {
if is_running(client) {
return Ok(0);
}
let root = client.join("Cache").join("WDB");
let mut removed = 0;
let Ok(locales) = fs::read_dir(&root) else {
return Ok(0);
};
for locale in locales.flatten() {
if !locale.file_type().is_ok_and(|t| t.is_dir()) {
continue;
}
let Ok(files) = fs::read_dir(locale.path()) else {
continue;
};
for file in files.flatten() {
let path = file.path();
let is_wdb = path
.extension()
.is_some_and(|e| e.eq_ignore_ascii_case("wdb"));
if is_wdb && file.file_type().is_ok_and(|t| t.is_file()) && fs::remove_file(&path).is_ok() {
removed += 1;
}
}
}
Ok(removed)
}
/// Start the game client. The caller is responsible for making sure the server is ready first.
pub fn launch(client: &Path) -> Result<u32> {
let exe =
@@ -607,6 +645,23 @@ pub fn recover_all_realmlist_overrides(meta_roots: &[PathBuf]) -> usize {
#[cfg(test)]
mod tests {
use super::*;
#[test]
fn only_the_server_data_cache_is_cleared() {
let d = tempfile::tempdir().unwrap();
let wdb = d.path().join("Cache/WDB/enUS");
fs::create_dir_all(&wdb).unwrap();
fs::write(wdb.join("creaturecache.wdb"), b"x").unwrap();
fs::write(wdb.join("itemcache.WDB"), b"x").unwrap();
fs::write(wdb.join("notes.txt"), b"keep").unwrap();
fs::create_dir_all(d.path().join("Data/Retail/Cache")).unwrap();
fs::write(d.path().join("Data/Retail/Cache/id-1.bin"), b"keep").unwrap();
assert_eq!(clear_game_cache(d.path()).unwrap(), 2);
assert!(wdb.join("notes.txt").is_file());
assert!(d.path().join("Data/Retail/Cache/id-1.bin").is_file());
assert_eq!(clear_game_cache(d.path()).unwrap(), 0);
assert_eq!(clear_game_cache(&d.path().join("missing")).unwrap(), 0);
}
#[cfg(windows)]
#[test]
@@ -677,10 +732,10 @@ mod tests {
let meta = d.path().join("meta");
let original = b"SET realmName \"Wildcard\"\n";
fs::write(c.join("WTF/Config.wtf"), original).unwrap();
assert!(!sync_realm_when_closed(&c, &meta, crate::realms::Mode::Coa, true).unwrap());
assert!(!sync_realm_when_closed(&c, &meta, "Conquest of Azeroth", true).unwrap());
assert_eq!(fs::read(c.join("WTF/Config.wtf")).unwrap(), original);
assert!(!backup_dir(&meta).exists());
assert!(sync_realm_when_closed(&c, &meta, crate::realms::Mode::Coa, false).unwrap());
assert!(sync_realm_when_closed(&c, &meta, "Conquest of Azeroth", false).unwrap());
assert_eq!(
fs::read(c.join("WTF/Config.wtf")).unwrap(),
b"SET realmName \"Conquest of Azeroth\"\n"
@@ -1,162 +0,0 @@
{
"version": 1,
"description": "Curated CoA compatibility and recommendation overlay for AzerothCore modules",
"rules": [
{
"repo_slug": "corfirean/mod-coa-playerbots",
"status": "Recommended",
"is_recommended": true,
"reason": "Official companion bots for groups, dungeons and guild in Conquest of Azeroth."
},
{
"repo_slug": "corfirean/mod-coa-content-scaling",
"status": "Recommended",
"is_recommended": true,
"reason": "Official dynamic dungeon and raid scaling system with solo modes."
},
{
"repo_slug": "zyth45/mod-playerbots",
"status": "Recommended",
"is_recommended": true,
"reason": "SQUID's Playerbots with full autonomous AI. Mutually exclusive with CoA Companions."
},
{
"repo_slug": "corfirean/azerothcore-wotlk-coa",
"status": "Recommended",
"is_recommended": true,
"reason": "Official Conquest of Azeroth modular core features."
},
{
"repo_slug": "azerothcore/mod-npc-buffer",
"status": "Verified",
"is_recommended": true,
"reason": "NPC buff master offering spells, sickness removal, and player restoration. Verified dynamic DLL on CoA Plugin SDK."
},
{
"repo_slug": "azerothcore/mod-congrats-on-level",
"status": "Verified",
"is_recommended": true,
"reason": "Level-up celebration animations, fireworks and announcements. Verified dynamic DLL on CoA Plugin SDK."
},
{
"repo_slug": "azerothcore/mod-npc-enchanter",
"status": "Recommended",
"is_recommended": true,
"reason": "Official NPC equipment enchanting module."
},
{
"repo_slug": "azerothcore/mod-reward-played-time",
"status": "Verified",
"is_recommended": true,
"reason": "Periodic rewards and tokens granted based on active playtime. Verified dynamic DLL on CoA Plugin SDK."
},
{
"repo_slug": "azerothcore/mod-solocraft",
"status": "RequiresAdapter",
"is_recommended": true,
"reason": "Dynamically boosts player stats in group content. Verified DLL build; requires calibration with CoA Content Scaling."
},
{
"repo_slug": "azerothcore/mod-cfbg",
"status": "Verified",
"is_recommended": false,
"reason": "Cross-faction battlegrounds system. Built into CoA core fork."
},
{
"repo_slug": "azerothcore/mod-duel-reset",
"status": "Verified",
"is_recommended": false,
"reason": "Resets health, mana, cooldowns and auras after duels. Verified dynamic DLL."
},
{
"repo_slug": "azerothcore/mod-pvp-titles",
"status": "Verified",
"is_recommended": false,
"reason": "Classic PvP rank titles awarded based on honorable kills."
},
{
"repo_slug": "azerothcore/mod-starter-guild",
"status": "Verified",
"is_recommended": false,
"reason": "Automatically invites newly created characters into a designated starter guild."
},
{
"repo_slug": "azerothcore/mod-skip-dk-starting-area",
"status": "Verified",
"is_recommended": false,
"reason": "Allows Death Knights to skip the Scarlet Enclave starter zone."
},
{
"repo_slug": "azerothcore/mod-learn-spells",
"status": "Incompatible",
"is_recommended": false,
"reason": "Directly conflicts with CoA classless progression & spell draft: automatically grants standard class spells, breaking player builds."
},
{
"repo_slug": "azerothcore/mod-autobalance",
"status": "Incompatible",
"is_recommended": false,
"reason": "Direct gameplay authority collision with mod-coa-content-scaling: both systems attempt to dynamically scale creature health and damage."
},
{
"repo_slug": "zhengpeiru21/mod-individual-progression",
"status": "Incompatible",
"is_recommended": false,
"reason": "Conflicts with CoA progression curve, dungeon level brackets, and content scaling gating."
},
{
"repo_slug": "azerothcore/mod-arac",
"status": "Incompatible",
"is_recommended": false,
"reason": "Incompatible with CoA custom races DBC table (Esteria, etc.) and expanded race limits."
},
{
"repo_slug": "azerothcore/mod-ahbot",
"status": "Blocked",
"is_recommended": false,
"reason": "Upstream repository has missing script loader entrypoint (Addmod_ahbotScripts) causing compilation and linking failures. Use official mod-ah-bot-plus instead."
},
{
"repo_slug": "azerothcore/mod-eluna",
"status": "RequiresAdapter",
"is_recommended": false,
"reason": "Requires external LuaJIT runtime and custom CoA spell system exports."
},
{
"repo_slug": "azerothcore/mod-transmog",
"status": "RequiresAdapter",
"is_recommended": false,
"reason": "Redundant: CoA already provides a built-in wardrobe and transmog system configured in coa.conf."
},
{
"repo_slug": "mod-playerbots/mod-playerbots",
"status": "Blocked",
"is_recommended": false,
"reason": "Конфликт с ядром CoA: используйте SQUID's Playerbots (Zyth45/mod-playerbots) или CoA Companions, специально адаптированные под CoA."
},
{
"repo_slug": "azerothcore/mod-playerbots",
"status": "Blocked",
"is_recommended": false,
"reason": "Конфликт с ядром CoA: используйте SQUID's Playerbots (Zyth45/mod-playerbots) или CoA Companions, специально адаптированные под CoA."
},
{
"repo_slug": "zyth45/mod-dungeon-clear",
"status": "Recommended",
"is_recommended": true,
"reason": "Модуль тактик прохождения подземелий для SQUID's Playerbots (Zyth45). Требует активного модуля SQUID bots."
},
{
"repo_slug": "jrad7/mod-dungeon-clear",
"status": "Blocked",
"is_recommended": false,
"reason": "Конфликт с ядром CoA: используйте Zyth45/mod-dungeon-clear, адаптированный под SQUID's Playerbots в CoA."
},
{
"repo_slug": "nathanhandley/mod-ah-bot-plus",
"status": "Blocked",
"is_recommended": false,
"reason": "Конфликт с ядром CoA: в ядро уже встроен официальный модуль Auction House Bot."
}
]
}
File diff suppressed because it is too large. Load diff
File diff suppressed because it is too large. Load diff
File diff suppressed because it is too large. Load diff
@@ -0,0 +1,116 @@
{
"Ascension.exe": "e2c347019d554a59639e5978fd68e50e906973ab313c6573cc56ca82e8e3c547",
"Data/Retail/Assets/EquipmentFitting/1068-1.bin": "332d2c38b037a118f262bbb3096a01ebfb33c5347e96bbfb64157437b300281b",
"Data/Retail/Assets/EquipmentFitting/60-0.bin": "ffbf6efc9ea09b0c442f048c5bc7b4c5975258045cfddedd9a77a93363312b5e",
"Data/Retail/Assets/EquipmentFitting/60-1.bin": "36ceed2a55756f3322e018938809acea5124351161405058ef27d100173778da",
"Data/Retail/Assets/EquipmentFitting/61-0.bin": "3b302a4055d1e795c451b02e38dfe8007527ee1bc5f926ebcd6ef17f433cd232",
"Data/Retail/Assets/EquipmentFitting/61-1.bin": "c42df399ed99be3c7ce1b5fdb95a873711011713a4cd867bc226a14b1ce0e8ca",
"Data/Retail/Assets/EquipmentFitting/65-0.bin": "8ce3f884ae197d14dff0f955c2cf05abb716742c8aff79f7af1cec5cf7225f04",
"Data/Retail/Assets/EquipmentFitting/68-0.bin": "f1d878f0f943cbdb8025af8daac4a38c1d1e159bd961d9d76f225931c11648ac",
"Data/Retail/Assets/EquipmentFitting/68-1.bin": "2ccbae634384200340c0cc3dca36a7a014a8ddad110598e4470ff1b266576465",
"Data/Retail/Assets/EquipmentFitting/73-0.bin": "5530882678f677ad47987ce906e851338a35f7d9737e3f9d829938027b8af67f",
"Data/Retail/Assets/EquipmentFitting/74-0.bin": "53a7be86b3bfdd6995406c706df3ca091484206d8141cebb39113c714500384a",
"Data/Retail/Assets/EquipmentFitting/74-1.bin": "e688c55a355231978d42480a003c26d379460f5931c2469c119ecb073ea153e1",
"Data/Retail/Assets/EquipmentFitting/75-0.bin": "289abc71c6df0e031a64d62a40e658eaefd37e45373a062ca52f08fbe803500c",
"Data/Retail/Assets/EquipmentFitting/76-0.bin": "63a493e70b91f59ff49f1942d959df986062bd267fe2ba589f344963df771021",
"Data/Retail/Assets/EquipmentFitting/77-0.bin": "b1366ce0dc4f31cb8c8c9705be2da565df4b905224af04b6b88f8c8e9c87e3c9",
"Data/Retail/Assets/EquipmentFitting/78-0.bin": "7b0031fb12ab19020005bdccacca2dd3991349c36949a58b035992585b4134db",
"Data/patch-T.MPQ": "fe597138ab7f56881b5f4f27d6dc9d81bb278b483ca0d91b7207ffd4a5ae7bfd",
"Data/patch-ZE1.MPQ": "69d79dbbea54ec0312c37770debc79c7bc9ce2e21eedef99c03cd8d911955283",
"Data/patch-ZE2.MPQ": "1a41cae77ad730e9cf69e8d63fd12ae3a579418bb550d351fff469573a97ac3c",
"Data/patch-ZE3.MPQ": "b587202c21b6f580682b601b7c2e905fbfa766276e74733db55c1bddbffb7f87",
"Data/patch-ZE5.MPQ": "476b5a1fcf69f64fdb281e3b445362b936d016066ccd12f897acfcf200d6c0cf",
"Data/patch-ZE6.MPQ": "762592c9ed950b4a7b6c7d85d45050b30fa3f35d53e348ee1e1516fdbb7e5484",
"Data/patch-ZE7.MPQ": "de54b0189d242763d2872223419a259b6b8a4b380c24b50a2ef9c6fa44466248",
"Data/patch-ZE8.MPQ": "1bc5691fb84a84f3e7a0a70baaa9192a97b4ec5906ee37c85838ffe08adef934",
"Data/patch-ZE9.MPQ": "d49c94463e9548e76378ce2c0454d8f204f0745c8c0de32b6dce7f0b0fd67c4a",
"Data/patch-ZEA.MPQ": "78fd10ec5262ae2417eba9700d2172553bbc1e5cfb0b597aada8f1753ca46d9d",
"Data/patch-ZES.MPQ": "a2d9348f917f745c7aa25b2eed96efa312f7b2d2f62cb86a4f2eaabc2dfa895f",
"Data/patch-ZG.MPQ": "48979e1fda775f8deb47bffa48e0a468595d4c71286fee518f51dc5801c5ca39",
"Data/patch-ZH.MPQ": "5e1d2fe287053abba703d7af381e10096c6525ba477ffed3971c2fc4f93e919c",
"Data/patch-ZHA.MPQ": "0fc6ebeafe1d14192dc64bafc90bde3c49230df1297f98bf65900a3bcf953617",
"Data/patch-ZHM.MPQ": "317d3ae00f0bd674b358af07544976acb7804aa6d8b19d1788ad96030e8c9bf0",
"Data/patch-ZJ.MPQ": "f821e99add86ef68d108c5ec466328c97677d3ed52f7944e200f3fe38c13b4de",
"Data/patch-ZK.MPQ": "444d0ecb72c1e990509d53e3cfa5b7634c816733533e8a97e5d7f5653ee32cce",
"Data/patch-ZM.MPQ": "424ab1978986e854551633983a94bd15beba6328aabea8c02f98eaa32f6f0b61",
"Data/patch-ZVU.MPQ": "c679b85a2e97344395756b54d2cf6abefe4e80e74944cb55b6e573ad17b7d020",
"Data/patch-ZZE.MPQ": "4b1e289e12c82644cb78f50170e6b5fd53918eb2de834f9e0cebddd81873a8bb",
"Data/patch-ZZR.MPQ": "5a7575e592dc0c8a6913e0d946bbe06fa0ca2e4d817ef1f8548d3d13142bcbd3",
"Data/patch-ZZS.MPQ": "533fd69d5784d83e872a5a28d27301dc9ab5d0cb925f8b2116926854e4a0a5b8",
"Data/patch-ZZT.MPQ": "e60dab63fe5650fdf5f0846ea6d4136219293bcfdad46d9b796697faeff9ab4c",
"Data/patch-ZZU.MPQ": "0311de8f034eae7dec1bd2c92b1fe6c741cbaf53da62c7609cd12b6c37908e47",
"Data/patch-ZZV.MPQ": "3b04008905e7185d165827d68f7ca228dda8272816364f7d71874ecc83b64f0e",
"Data/patch-ZZW.MPQ": "3bbbc72901fd2d662113036485c380701e693f5a39ba9479af306bf2fa2030bd",
"Data/patch-ZZX.MPQ": "4c12608089cfe356f7c8882d66db90239ed3ec8ddd980d91d7a3a488680f3c88",
"Data/patch-ZZZ.MPQ": "566aaadf501af42e29a828b1bc2edbd36d436288fb309fe423bd74b9619bf593",
"Data/patch-ZZZA.MPQ": "57ccbdc0a66000767554ffd194088df6d602ddd8341a141bca8201e7d5435889",
"Data/patch-ZZZC.MPQ": "691a53f6325c2615a64ced0802f18bc4d96e99c62aaa606fc930f9406ee74cdf",
"Data/patch-ZZZD.MPQ": "ca893cf8129f6fd442a63f0697a8ddea88546e3ce71bde713be2cc832b892bc9",
"Data/patch-ZZZE.MPQ": "2e245ee0fe3b913087eed399062fda5843d98b04afac38024f7c64ac3bf43e18",
"Data/patch-ZZZF.MPQ": "40eac695cfcafb598b8376f3b9a61ecc037e4d445b87279cfe387a91edad32c3",
"Data/patch-ZZZZ.MPQ": "860c990db3b4185fdc36e1a001d3ca3507a68253a4506793a115f86eb0892a15",
"EsteriaAppearance.bin": "90d9cfaeaf6de10f014f1d1610ea10453ec9b240255759aea99513cac488a3ec",
"EsteriaAppearance.dll": "88e268d3be9eca3b0644f543d823f4bdcc04a9700a6e8ed73fd2a1260ad191af",
"EsteriaAppearanceGeometry.bin": "19de5b4b4f79778ea5316659efc2f66c6edb6b5149c46efa47c46bfa4ec6904c",
"EsteriaAppearanceMaterials.bin": "f72f027f54a55c05aa0f76b457b97b484fe0e1aedc0e068cc0e0ca53e1878cba",
"EsteriaBanshee.bin": "d3fe66caa6a0ecba96bddb07ac1cbdb915694e87fc1608da0fdabecdf9ffea4d",
"EsteriaBansheeTextures.bin": "837774377ca055e6a5c79c1a4cfd8151e7c1f7ce2c16990b00fd445281137433",
"EsteriaCentaur.bin": "d63f0b7d21cee67d234d134e832fe6d55c398f2b63f9f6c191dcfa9671637185",
"EsteriaCentaurTextures.bin": "837774377ca055e6a5c79c1a4cfd8151e7c1f7ce2c16990b00fd445281137433",
"EsteriaCosmeticWings.bin": "57352c28459d073a29b3014d33b70f3b3756afa37fa9583ef6b30d503422ac3f",
"EsteriaDrakonid.bin": "95440ee9c065ef20bb7fed6158d20623d68745291cedc2726fc746ff54601f95",
"EsteriaDrakonidCoverage.bin": "9cdc227f08329e1245d2b864a996e7a772c96ecdbe5d81925f4d60cdbe4fa11e",
"EsteriaDrakonidTextures.bin": "1ba9133a75dad291d98a068b2dcde01f31a897a1764cd7f3e2c316c288a8f605",
"EsteriaEarthen.bin": "8a0db93ba2d5c756b44ed84f2f7bc7c15eef13be6a7d87baf1383c6c0c624e02",
"EsteriaEthereal.bin": "ada3b7588511a847dd5154d91e3041e9f7f193998b06bfede5e0afc32570b48c",
"EsteriaEtherealTextures.bin": "837774377ca055e6a5c79c1a4cfd8151e7c1f7ce2c16990b00fd445281137433",
"EsteriaFaceless.bin": "1c5a1d7a6b1db6984a8e41bc4804e9f7c50d65dcdbb8c0a9d1a9e8af8c91bd8f",
"EsteriaFacelessTextures.bin": "837774377ca055e6a5c79c1a4cfd8151e7c1f7ce2c16990b00fd445281137433",
"EsteriaGnoll.bin": "cfacc8e681bb8e54a4f01ee9c12a91bf0bd23a23527bb548d4dc21ec1b33eea2",
"EsteriaGnollTextures.bin": "1ba9133a75dad291d98a068b2dcde01f31a897a1764cd7f3e2c316c288a8f605",
"EsteriaHaranir.bin": "59f31d00e372fd2646e1cf0d9d3d5d671b31edd60ff7b862f8d1ce7e53ba1f2f",
"EsteriaHaranirTextures.bin": "99948ca570be2d376f0c67e3b8088739b6fa9f9d2c73985e19f68df77689a229",
"EsteriaHighmountain.bin": "e83349252ad2687ac23fcfc5623db7401cf32e5faf47a5a7be20c2f94b014938",
"EsteriaHozen.bin": "739bc3775388976f5c09bcbf3a98b62d804dff78d545e25a41d07dd99b5fddc5",
"EsteriaHozenTextures.bin": "837774377ca055e6a5c79c1a4cfd8151e7c1f7ce2c16990b00fd445281137433",
"EsteriaKvItems.bin": "fc5f9d86114234b38dbb0e14a6a5ec16249eaa92a73411a7fc371a950549dcce",
"EsteriaKvSkins.bin": "60b2b899f5f83137368514928f92f3b04c0fae058f534c487ddbe913ee4bec18",
"EsteriaKyrian.bin": "9329147f08805ff4003f9e062fea7c6ea8fdd8c4d6a40de63a6d228ebe1b7c9a",
"EsteriaKyrianTextures.bin": "837774377ca055e6a5c79c1a4cfd8151e7c1f7ce2c16990b00fd445281137433",
"EsteriaMantid.bin": "71536dee6c2abd0b0e13f33bc73cad7e6fb1b0fc1f6912a95c55d57bc7ee1787",
"EsteriaMantidTextures.bin": "837774377ca055e6a5c79c1a4cfd8151e7c1f7ce2c16990b00fd445281137433",
"EsteriaNaga.bin": "e87547cff5d09500c294f8b06935d134cdd0bbb962e294a72de09404505bd8b3",
"EsteriaNagaTextures.bin": "57ec560f99c1d48ac1e8f6a797c156513b99e7d349e3071afe405f812d159ae3",
"EsteriaSaberon.bin": "7735c9325c807c5125760d87f323d6b7d4162fb542c1d8b5f435ea2d6b9a4daa",
"EsteriaSaberonCoverage.bin": "9cdc227f08329e1245d2b864a996e7a772c96ecdbe5d81925f4d60cdbe4fa11e",
"EsteriaSaberonTextures.bin": "1ba9133a75dad291d98a068b2dcde01f31a897a1764cd7f3e2c316c288a8f605",
"EsteriaSethrak.bin": "bd14857a8c11fdf8027128763293701586b2102f9a6539d33a727014789fd606",
"EsteriaSethrakTextures.bin": "d2b2cf58087a391f00198008fe871edd400ddf28d54a3a05674df74c5198528a",
"EsteriaSlime.bin": "491e942ceb6abda83c0249afebae7c9c43af3897b35e45fa33d6f9177ecbc177",
"EsteriaSlimeTextures.bin": "837774377ca055e6a5c79c1a4cfd8151e7c1f7ce2c16990b00fd445281137433",
"EsteriaTarasek.bin": "f718444d5ec36f7aff018883486ae1981151fe6e01f5b7781d68d74e9fadfa47",
"EsteriaTarasekTextures.bin": "1ba9133a75dad291d98a068b2dcde01f31a897a1764cd7f3e2c316c288a8f605",
"EsteriaThinHuman.bin": "bc12e5ca2c087ca0a8642ff6cd8e78fe2e1f85928518b12c19b4245a8320585d",
"EsteriaThinHumanTextures.bin": "27488a7494fa9733b53118d1d0f4acef50a9e19004f81f9c8a614b10f4c3fd5e",
"EsteriaTuskarr.bin": "ecbe7ef490ba67eca029a57639192db61238522618491549766fe38529914387",
"EsteriaTuskarrTextures.bin": "e2116c2c83adea079126fd5da765d20da24f044d4f161c4124e4368cb3d6bc71",
"EsteriaVenthyr.bin": "5bcf7804363e59b3c922830d06de17bbd348b9967307f39b7d72bc09f58814eb",
"EsteriaVenthyrTextures.bin": "837774377ca055e6a5c79c1a4cfd8151e7c1f7ce2c16990b00fd445281137433",
"EsteriaVorkai.bin": "d6d2088c7e867b5db437e9afc2d323c22d830c6f84a3598415eedcaa27e2461f",
"EsteriaVorkaiTextures.bin": "837774377ca055e6a5c79c1a4cfd8151e7c1f7ce2c16990b00fd445281137433",
"EsteriaVrykul.bin": "39e2b7b4c67997dbbd34bae840bd606a59290f7f2fc82565a0ba00090335415c",
"EsteriaVrykulTextures.bin": "46098750a0e235724c6e9cc8d9d4e26550aa47bef95fd5f0f82efe5e945bf296",
"EsteriaVulpera.bin": "c5434993b9af4a17d881965e4735cd2ac379e39c7142aac9844adff9528562d4",
"EsteriaVulperaTextures.bin": "1ab844e74684aced2b069f1b91cd563aade45e05bd5e23f866a6c0c301cb098e",
"Interface/AddOns/CoAHideArmor/CoAHideArmor.lua": "8c1c7403524fc9bd56c0809b4101b141da700ba163701209bf1420f2ef106aa7",
"Interface/AddOns/CoAHideArmor/CoAHideArmor.toc": "123580d92fd5ceee258e96296f42c359b7e83cdff151af49c50c6c4e2059677c",
"Interface/AddOns/CoAQuestSafe/CoAQuestSafe.lua": "062de55c91228971553f482fd2c8753f4752993b4e8e49d4ded04fa18b98bde7",
"Interface/AddOns/CoAQuestSafe/CoAQuestSafe.toc": "890bb9d1087e236f4823603f5df3ab0e316dbb65c28feebbda08fb0ab53a408f",
"Interface/AddOns/CoAWC2Cursor/CoAWC2Cursor.lua": "1cf9537ff5f10b77250fea4407aea1008da690afe102ed6ed2dac21f79638cfa",
"Interface/AddOns/CoAWC2Cursor/CoAWC2Cursor.toc": "48ce695dce712b3643ebe13a77e318d623c964acc69479b8fc8cc675099801bf",
"Interface/AddOns/CoA_TalentReset/CoA_TalentReset.lua": "827d756d5948ef918fafaf8b869290b3a1faa4e4cc21b19b512a00d4509f3d41",
"Interface/AddOns/CoA_TalentReset/CoA_TalentReset.toc": "16298c04af68e68d6445e7a11f42aee525dd4145f85d2771ff434fb7c6e95a85",
"dinput8.dll": "f8de78606c241fb3911dce22faf68f5b9f9885b142b183c1e2c09ddc8f7e380c",
"wc2_human.cur": "f609736e29596bb386ef1597b157d211e01a86d32c2a929e256c581c37d71791",
"wc2_orc.cur": "baa512c9b9045762ba35b6e0d35b8f79c54b7649f35cc9c0e0cc8c168a1e5a97"
}
+58 -308
View File
@@ -1,11 +1,10 @@
//! Start/stop of a repack-shaped installation by delegating to the repack's own supervisor
//! (`Runtime\python\python.exe Scripts\manage.py <verb>`), which already implements config rendering, the
//! bug-report relay, RA graceful shutdown and readiness. Observation stays native (see `process`).
//! Start/stop of a repack-shaped installation through the repack launcher in this crate
//! ([`crate::launcher`]): config rendering, the services, the world supervisor, graceful shutdown and readiness.
//! It writes the same `.state` records as the repack's `Scripts/manage.py`, so the repack's own launcher and
//! this Manager can be used on the same folder. Observation stays native (see `process`).
use std::io::Read;
use std::path::{Path, PathBuf};
use std::process::{Command, Stdio};
use std::time::{Duration, Instant};
use std::path::Path;
use std::sync::Mutex;
use serde::Serialize;
@@ -22,22 +21,13 @@ pub enum Verb {
}
impl Verb {
fn arg(self) -> &'static str {
fn action(self) -> crate::launcher::ops::Action {
use crate::launcher::ops::Action;
match self {
Verb::StartAll => "start-all",
Verb::StartMysql => "start-mysql",
Verb::StartWorld => "start-world",
Verb::StopAll => "stop-all",
}
}
fn timeout(self, _root: &Path) -> Duration {
match self {
// Includes database startup, optional bot provisioning and the shared 25-minute
// world/console wait in launcher_bridge.py, even for older installed scripts.
Verb::StartAll | Verb::StartWorld => Duration::from_secs(3600),
Verb::StartMysql => Duration::from_secs(360),
Verb::StopAll => Duration::from_secs(240),
Verb::StartAll => Action::StartAll,
Verb::StartMysql => Action::StartMysql,
Verb::StartWorld => Action::StartWorld,
Verb::StopAll => Action::StopAll,
}
}
}
@@ -52,41 +42,14 @@ pub struct DriverOutcome {
pub output: String,
}
/// Map the launcher's own messages onto stable error codes. Unknown text stays `Unknown` (details remain visible).
pub fn translate(output: &str) -> ErrorCode {
let o = output.to_lowercase();
if o.contains("is already used") {
ErrorCode::PortInUse
} else if o.contains("another start/stop action is in progress")
|| o.contains("shutdown is still finishing")
{
ErrorCode::OperationInProgress
} else if o.contains("packaged database is missing")
|| o.contains("extract the complete repack")
{
ErrorCode::ServerFilesIncomplete
} else if o.contains("stopped during startup")
|| o.contains("is still starting")
|| o.contains("world startup failed")
{
ErrorCode::StartupFailed
} else if o.contains("invalid port") || o.contains("unresolved placeholder") {
ErrorCode::InvalidConfigValue
} else {
ErrorCode::Unknown
}
}
fn launcher(root: &Path) -> Result<(PathBuf, PathBuf)> {
let python = root.join("Runtime/python/python.exe");
let script = root.join("Scripts/manage.py");
if !python.is_file() || !script.is_file() {
fn has_launcher_settings(root: &Path) -> Result<()> {
if !root.join("Settings/repack.json").is_file() {
return Err(Error::Invalid(
"This server has no CoA Repack launcher; start/stop is not available for it yet."
.into(),
));
}
Ok((python, script))
Ok(())
}
/// Run a launcher verb to completion (blocking; call from a worker thread).
@@ -181,6 +144,10 @@ fn run_inner_mode(
}
if matches!(verb, Verb::StartAll | Verb::StartWorld) {
crate::modules::ensure_bot_exclusivity(&root)?;
// A server update that only added races keeps the owner's race restriction (and custom races on).
if let Err(error) = crate::race_availability::rebind_unchanged(&root) {
tracing::warn!(%error, "the race restriction could not be checked against the race catalog");
}
}
if crate::docker::is_docker(&root) {
prepare_headless_world(&root, verb)?;
@@ -205,108 +172,51 @@ fn run_inner_mode(
if matches!(verb, Verb::StartAll | Verb::StartWorld) {
crate::modules::ensure_bot_exclusivity(&root)?;
}
let (python, script) = launcher(&root)?;
has_launcher_settings(&root)?;
prepare_headless_world(&root, verb)?;
let original = std::fs::read_to_string(&script)?;
let patched = patch_launcher_imports(&original)?;
if original != patched {
fsx::atomic_write(&script, patched.as_bytes())?;
if let Ok(dir) = crate::registry::metadata_dir_for(&root) {
if let Ok((_, mut meta)) = crate::registry::MetaDir::open(&dir) {
if meta.original_hashes.get("Scripts/manage.py")
== Some(&fsx::sha256_bytes(original.as_bytes()))
{
meta.original_hashes.insert(
"Scripts/manage.py".into(),
fsx::sha256_bytes(patched.as_bytes()),
);
fsx::atomic_write_json(&dir.join("install.json"), &meta)?;
}
}
}
}
discard_damaged_launcher_state(&root);
if matches!(verb, Verb::StopAll | Verb::StartMysql | Verb::StartAll) {
recover_mysql_launcher_state(&root, verb != Verb::StopAll)?;
}
if force {
recover_world_for_forced_stop(&root)?;
}
let mut cmd = Command::new(&python);
if validating_update {
// Isolated startup must use the port from its temporary auth config.
cmd.env_remove("AC_REALM_SERVER_PORT");
}
cmd.arg("-B")
.arg("-c")
.arg(LAUNCH_SCRIPT)
.arg(&script)
.arg(if force { "force-stop-all" } else { verb.arg() })
.current_dir(&root)
.stdin(Stdio::null())
.stdout(Stdio::piped())
.stderr(Stdio::piped());
#[cfg(windows)]
{
use std::os::windows::process::CommandExt;
cmd.creation_flags(0x0800_0000); // CREATE_NO_WINDOW
}
tracing::info!(?verb, root = %root.display(), "driver: starting launcher verb");
let mut child = cmd.spawn()?;
let mut stdout = child.stdout.take().expect("piped");
let mut stderr = child.stderr.take().expect("piped");
let out_t = std::thread::spawn(move || {
let mut s = String::new();
let _ = stdout.read_to_string(&mut s);
s
});
let err_t = std::thread::spawn(move || {
let mut s = String::new();
let _ = stderr.read_to_string(&mut s);
s
});
let deadline = Instant::now() + verb.timeout(&root);
let status = loop {
if let Some(st) = child.try_wait()? {
break Some(st);
}
if Instant::now() > deadline {
// Never kill the servers themselves: only abandon the launcher process we spawned.
let _ = child.kill();
break None;
}
std::thread::sleep(Duration::from_millis(200));
};
let mut output = out_t.join().unwrap_or_default();
output.push_str(&err_t.join().unwrap_or_default());
let mut output = output.trim().to_string();
if status.is_none() {
output.push_str(&format!(
"\nLauncher {} exceeded its {} second deadline; check the server logs.",
verb.arg(),
verb.timeout(&root).as_secs()
));
}
let (ok, exit_code) = match status {
Some(st) => (st.success(), st.code()),
None => (false, None),
};
let code = if ok {
None
let action = if force {
crate::launcher::ops::Action::ForceStopAll
} else {
// Log evidence beats the launcher's generic "stopped during startup" message.
let base = if status.is_none() {
ErrorCode::StartupFailed
} else {
translate(&output)
};
match base {
ErrorCode::StartupFailed | ErrorCode::Unknown => {
Some(crate::health::diagnose_installation(&root).unwrap_or(base))
verb.action()
};
tracing::info!(?verb, root = %root.display(), "driver: starting launcher action");
let lines = Mutex::new(Vec::<String>::new());
let progress = |line: &str| {
tracing::info!(?verb, "launcher: {line}");
lines.lock().unwrap_or_else(|e| e.into_inner()).push(line.to_string());
};
let result = crate::launcher::Settings::load(&root, 0).and_then(|mut cfg| {
if validating_update {
// Isolated startup must use the port from its temporary auth config.
cfg.env_remove.push("AC_REALM_SERVER_PORT".into());
}
crate::launcher::ops::run(&root, &cfg, 0, action, None, &progress)
});
let mut output = lines.into_inner().unwrap_or_else(|e| e.into_inner()).join("\n");
let ok = result.is_ok();
let code = match &result {
Ok(()) => None,
Err(error) => {
if !output.is_empty() {
output.push('\n');
}
output.push_str(&format!("ERROR: {error}"));
// Log evidence beats a generic "stopped during startup".
match error.code() {
ErrorCode::StartupFailed | ErrorCode::Unknown => Some(
crate::health::diagnose_installation(&root).unwrap_or(error.code()),
),
other => Some(other),
}
other => Some(other),
}
};
let exit_code = Some(if ok { 0 } else { 1 });
if code == Some(ErrorCode::PortInUse) {
let observed = crate::process::observe(&root, &crate::layout::read_ports(&root));
for service in [&observed.mysql, &observed.auth, &observed.world]
@@ -374,35 +284,6 @@ fn prepare_headless_world(root: &Path, verb: Verb) -> Result<()> {
Ok(())
}
/// The launcher keeps one JSON record per service in `.state`. A crash or power loss while it writes one can leave
/// a file of the right length that holds only zero bytes (NTFS keeps the length but not the data), and the launcher
/// then dies on every start with an unreadable record. Such a file carries no information, so remove it: the
/// launcher treats a missing record as "not running". Only empty or all-zero `*.json` files are touched.
pub(crate) fn discard_damaged_launcher_state(root: &Path) -> Vec<PathBuf> {
let mut removed = Vec::new();
let Ok(entries) = std::fs::read_dir(root.join(".state")) else {
return removed;
};
for entry in entries.flatten() {
let path = entry.path();
if path
.extension()
.is_none_or(|e| !e.eq_ignore_ascii_case("json"))
|| !path.is_file()
{
continue;
}
let Ok(bytes) = std::fs::read(&path) else {
continue;
};
if bytes.iter().all(|b| *b == 0) && std::fs::remove_file(&path).is_ok() {
tracing::warn!(file = %path.display(), bytes = bytes.len(), "driver: removed a launcher state file damaged by an interrupted write");
removed.push(path);
}
}
removed
}
/// A lost launcher record must not hide this installation's running MySQL from
/// graceful shutdown. Adopt only the exact executable owning its configured port.
fn recover_mysql_launcher_state(root: &Path, prefer_listener: bool) -> Result<()> {
@@ -453,60 +334,6 @@ fn recover_mysql_launcher_state(root: &Path, prefer_listener: bool) -> Result<()
Ok(())
}
const LAUNCH_SCRIPT: &str = include_str!("launcher_bridge.py");
pub(crate) fn patch_launcher_imports(text: &str) -> Result<String> {
let line = "sys.path.insert(0, str(Path(__file__).resolve().parent))";
if !text.contains("from squid_playerbots import") || text.contains(line) {
return Ok(text.into());
}
let root = "ROOT = Path(__file__).resolve().parents[1]";
if !text.contains(root) || !text.lines().any(|line| line.trim() == "import sys") {
return Err(Error::Invalid(
"The server launcher cannot load its integration scripts. Repair its program files."
.into(),
));
}
Ok(text.replacen(root, &format!("{root}\n{line}"), 1))
}
pub(crate) fn launcher_matches(signed: &str, actual: &[u8]) -> bool {
if signed.as_bytes() == actual {
return true;
}
if patch_launcher_imports(signed).is_ok_and(|s| s.as_bytes() == actual) {
return true;
}
crate::realms::patch_launcher(signed).is_ok_and(|s| {
s.as_bytes() == actual || patch_launcher_imports(&s).is_ok_and(|p| p.as_bytes() == actual)
})
}
/// Recover legacy metadata only when undoing supported Manager edits reproduces the recorded hash.
pub(crate) fn launcher_matches_recorded(recorded: &str, actual: &[u8]) -> bool {
let Ok(text) = std::str::from_utf8(actual) else {
return false;
};
let without_import = text.replacen(
"ROOT = Path(__file__).resolve().parents[1]\nsys.path.insert(0, str(Path(__file__).resolve().parent))",
"ROOT = Path(__file__).resolve().parents[1]", 1,
);
for candidate in [
Some(without_import.clone()),
crate::realms::unpatch_launcher(&without_import),
]
.into_iter()
.flatten()
{
if crate::fsx::sha256_bytes(candidate.as_bytes()).eq_ignore_ascii_case(recorded)
&& launcher_matches(&candidate, actual)
{
return true;
}
}
false
}
pub(crate) fn startup_failure(root: &Path, started: &DriverOutcome) -> String {
let code = started
.code
@@ -608,7 +435,7 @@ mod tests {
text.contains("launcher request failed before completion")
&& text.contains("in progress")
);
assert!(!text.contains("starting launcher verb"));
assert!(!text.contains("starting launcher action"));
}
#[test]
@@ -665,78 +492,10 @@ mod tests {
}
#[test]
fn slow_world_startup_has_time_with_either_bot_system_without_extending_shutdown() {
let folder = tempfile::tempdir().unwrap();
let modules = folder.path().join("Core/configs/modules");
std::fs::create_dir_all(&modules).unwrap();
std::fs::write(
modules.join("playerbots.conf.dist"),
"AiPlayerbot.Enabled = 1\n",
)
.unwrap();
assert_eq!(
Verb::StartAll.timeout(folder.path()),
Duration::from_secs(3600)
);
assert_eq!(
Verb::StopAll.timeout(folder.path()),
Duration::from_secs(240)
);
std::fs::write(modules.join("playerbots.conf"), "AiPlayerbot.Enabled = 0\n").unwrap();
assert_eq!(
Verb::StartWorld.timeout(folder.path()),
Duration::from_secs(3600)
);
assert_eq!(
Verb::StartMysql.timeout(folder.path()),
Duration::from_secs(360)
);
}
#[test]
fn zero_filled_launcher_state_is_discarded_and_valid_state_is_kept() {
let folder = tempfile::tempdir().unwrap();
let state = folder.path().join(".state");
std::fs::create_dir_all(&state).unwrap();
std::fs::write(state.join("mysql.json"), vec![0u8; 116]).unwrap();
std::fs::write(state.join("configuration.json"), Vec::<u8>::new()).unwrap();
std::fs::write(state.join("world.json"), "{\"pid\": 4}\n").unwrap();
std::fs::write(state.join("stop-relay"), Vec::<u8>::new()).unwrap();
std::fs::write(state.join("auth.json"), "{\"pid\": 0}").unwrap();
let mut removed: Vec<_> = discard_damaged_launcher_state(folder.path())
.iter()
.map(|p| p.file_name().unwrap().to_string_lossy().into_owned())
.collect();
removed.sort();
assert_eq!(removed, ["configuration.json", "mysql.json"]);
assert!(
state.join("world.json").exists()
&& state.join("auth.json").exists()
&& state.join("stop-relay").exists()
);
assert!(discard_damaged_launcher_state(folder.path()).is_empty());
assert!(discard_damaged_launcher_state(&folder.path().join("missing")).is_empty());
}
#[test]
fn translates_known_launcher_messages() {
assert_eq!(
translate("RuntimeError: Port 8085 is already used. Stop the other server"),
ErrorCode::PortInUse
);
assert_eq!(
translate("Another start/stop action is in progress."),
ErrorCode::OperationInProgress
);
assert_eq!(
translate("The packaged database is missing. Extract the complete repack."),
ErrorCode::ServerFilesIncomplete
);
assert_eq!(
translate("world stopped during startup. Check its log."),
ErrorCode::StartupFailed
);
assert_eq!(translate("Exit code -1073741819"), ErrorCode::Unknown);
fn launcher_failures_carry_their_error_code() {
let e = Error::Service(ErrorCode::PortInUse, "Port 8085 is already used (PID 4).".into());
assert_eq!(e.code(), ErrorCode::PortInUse);
assert_eq!(e.to_string(), "Port 8085 is already used (PID 4).");
}
#[test]
@@ -779,13 +538,4 @@ mod tests {
assert!(!reason.contains("private"));
assert!(!reason.contains("Something went wrong"));
}
#[test]
fn launcher_import_fix_is_idempotent_and_retains_other_code() {
let text = "import sys\nROOT = Path(__file__).resolve().parents[1]\nfrom squid_playerbots import validate_bots\ncustom = 42\n";
let fixed = patch_launcher_imports(text).unwrap();
assert!(fixed.contains("sys.path.insert(0, str(Path(__file__).resolve().parent))"));
assert!(fixed.ends_with("custom = 42\n"));
assert_eq!(patch_launcher_imports(&fixed).unwrap(), fixed);
}
}
+4
View File
@@ -24,6 +24,9 @@ pub enum Error {
UnknownInstallation(String),
#[error("{0}")]
Invalid(String),
/// A server start or stop failed for a reason the UI can explain (the repack launcher's own errors).
#[error("{1}")]
Service(ErrorCode, String),
#[error("package not published: {0}")]
PackageNotPublished(String),
#[error("download server unreachable: {0}")]
@@ -199,6 +202,7 @@ impl Error {
Error::PackageNotPublished(_) => ErrorCode::PackageNotPublished,
Error::NetworkUnreachable(_) => ErrorCode::NetworkUnreachable,
Error::BotModulesConflict => ErrorCode::BotModulesConflict,
Error::Service(code, _) => *code,
Error::CompanionTemplatesMissing => ErrorCode::CompanionTemplatesMissing,
Error::CompanionCommandUnsupported => ErrorCode::CompanionCommandUnsupported,
_ => ErrorCode::Unknown,
+25
View File
@@ -0,0 +1,25 @@
//! The repack launcher in Rust: what `Scripts/manage.py` does, without Python.
//!
//! Formats on disk stay exactly those of `manage.py`, so the two can be used on the same server during the move
//! (an old `.bat` and a new Manager, or the other way round):
//!
//! * `.state/<service>.json` process records `{pid, exe, created}` (see [`crate::process::ProcessIdentity`]);
//! * `.state/control.lock` one start/stop action at a time: byte 0 locked, as `msvcrt.locking` does;
//! * `.state/control-owner.json`, `.state/configuration.json`, `.state/debug-logs.json`;
//! * the rendered configs (`Core/configs/*.conf`, `mysql/my.ini`, `mysql/admin-client.ini`) byte for byte.
//!
//! State files are written with a flush to disk before they replace the old ones (`manage.py` did not, and a
//! power cut could leave a zero-filled record that stopped every later start).
pub mod ops;
pub mod relay;
pub mod render;
pub mod schedule;
pub mod services;
pub mod settings;
pub mod spawn;
pub mod squid;
pub mod state;
pub mod world;
pub use settings::Settings;
+103
View File
@@ -0,0 +1,103 @@
//! One start/stop action of a repack, with the control lock held (`manage.py main()`): the entry point of both
//! `coa-launcher.exe` and the Manager.
use std::path::Path;
use std::time::Duration;
use crate::error::Result;
use crate::launcher::services::{self, Progress};
use crate::launcher::world::{self, Supervisor};
use crate::launcher::{render, settings::Settings, squid, state};
#[derive(Debug, Clone, Copy, PartialEq, Eq)]
pub enum Action {
StartAll,
StartMysql,
StartAuth,
StartWorld,
StopAll,
/// Stop the world without its console first (unsaved progress is lost), then everything else.
ForceStopAll,
Prepare,
}
impl Action {
/// The command name, as the `.bat` files and `manage.py` call it.
pub fn name(self) -> &'static str {
match self {
Action::StartAll => "start-all",
Action::StartMysql => "start-mysql",
Action::StartAuth => "start-auth",
Action::StartWorld => "start-world",
Action::StopAll => "stop-all",
Action::ForceStopAll => "force-stop-all",
Action::Prepare => "prepare",
}
}
pub fn parse(name: &str) -> Option<Action> {
[
Action::StartAll,
Action::StartMysql,
Action::StartAuth,
Action::StartWorld,
Action::StopAll,
Action::ForceStopAll,
Action::Prepare,
]
.into_iter()
.find(|a| a.name() == name)
}
}
/// Run `action`. A started world is supervised by `supervisor`, or by what the repack ships when it is `None`.
pub fn run(root: &Path, cfg: &Settings, offset: i32, action: Action, supervisor: Option<&Supervisor>, progress: Progress) -> Result<()> {
let _lock = state::ControlLock::acquire(root, action.name(), Duration::from_secs(30), progress)?;
match action {
// Shutdown uses the existing client and console settings: the templates may be exactly what a recovery
// needs to replace, so nothing is rendered.
Action::StopAll => return services::stop_all(root, cfg, progress),
Action::ForceStopAll => return services::force_stop_all(root, cfg, progress),
_ => {}
}
if matches!(action, Action::StartAll | Action::StartWorld) {
squid::validate_bots(root)?;
}
let relocated;
let cfg = match action {
Action::StartAll | Action::StartMysql | Action::StartAuth | Action::StartWorld => {
match services::relocate_database_port(root, cfg, offset, progress)? {
Some(_) => {
let mut moved = Settings::load(root, offset)?;
moved.env_remove = cfg.env_remove.clone();
relocated = moved;
&relocated
}
None => cfg,
}
}
_ => cfg,
};
render::prepare(root, cfg)?;
if action == Action::Prepare {
return Ok(());
}
if matches!(action, Action::StartAll | Action::StartMysql) {
services::start_mysql(root, cfg, progress)?;
}
if matches!(action, Action::StartAll | Action::StartAuth) {
services::start_auth(root, cfg, progress)?;
}
if matches!(action, Action::StartAll | Action::StartWorld) {
let shipped;
let supervisor = match supervisor {
Some(s) => s,
None => {
shipped = Supervisor::of(root)?;
&shipped
}
};
world::start_world(root, cfg, offset, supervisor, progress)?;
}
Ok(())
}
+493
View File
@@ -0,0 +1,493 @@
//! The bug-report relay (`BugReport/relay.py` and `manage.py relay-worker`): delivers the reports the world
//! writes to `BugReport/reports/*.report` through the CoA report service.
//!
//! On disk everything stays as the Python relay keeps it, so either can take over a spool: the `<key>.status`
//! files the world reads back, the delivery journal `relay.sqlite3` (tables `deliveries` and `settings`), and
//! `relay.lock` (byte 0 locked while a worker runs). A delivery interrupted while it was posting becomes
//! `uncertain` and is never sent again (the service's duplicate filter may have been reset in the meantime).
use std::path::{Path, PathBuf};
use std::time::{Duration, SystemTime, UNIX_EPOCH};
use rusqlite::{params, Connection, OptionalExtension};
use sha2::{Digest, Sha256};
use crate::error::{Error, Result};
use crate::launcher::state;
const REPOSITORY: &str = "jealous-sound/azerothcore-wotlk-coa";
pub const SERVICE_URL: &str = "https://coa-bug-report.up.railway.app";
/// Distribution credential for this narrow intake API (the same as relay.py's); not a GitHub token.
pub const DEFAULT_API_KEY: &str = "coa_zRatxUHShOn-HEkoreKGME6sd3DdMG7eKTTKlj2JCK4";
const MAX_FILE: u64 = 16000;
const MAX_RESPONSE: usize = 64 * 1024;
/// `[1-9][0-9]{0,9}-[0-9a-f]{16,48}`: the name of a report file (without `.report`).
pub fn valid_key(key: &str) -> bool {
let Some((id, hex)) = key.split_once('-') else { return false };
(1..=10).contains(&id.len())
&& !id.starts_with('0')
&& id.bytes().all(|b| b.is_ascii_digit())
&& (16..=48).contains(&hex.len())
&& hex.bytes().all(|b| b.is_ascii_digit() || (b'a'..=b'f').contains(&b))
}
/// Why a delivery did not create an issue. Only fixed local codes: never service bodies, credentials or report
/// content.
#[derive(Debug, Clone, Copy, PartialEq, Eq)]
pub enum Failure {
/// 202 pending: the service is still creating it.
Pending(u64),
/// 429: try again later.
Limited(u64),
/// The report itself was refused.
Invalid,
/// The service refused this relay (redirect, auth, missing endpoint, GitHub access).
Blocked(u64),
/// The outcome is unknown (network, timeout, unexpected answer).
Uncertain,
}
/// Where reports go.
pub trait Service {
fn create(&self, title: &str, body: &str) -> std::result::Result<u64, Failure>;
}
/// The CoA report service over HTTPS.
pub struct ReportService {
api: String,
key: String,
client: reqwest::blocking::Client,
}
impl ReportService {
pub fn new(base_url: &str, api_key: &str) -> Result<ReportService> {
if api_key.is_empty() || !api_key.is_ascii() || api_key.chars().any(char::is_whitespace) {
return Err(Error::Invalid("Configure a valid report-service intake key.".into()));
}
let client = reqwest::blocking::Client::builder()
.redirect(reqwest::redirect::Policy::none())
.timeout(Duration::from_secs(30))
// One report every few seconds at most: a fresh connection each time, never a stale pooled one.
.pool_max_idle_per_host(0)
.user_agent("CoA-InGame-BugReport/1")
.build()
.map_err(|e| Error::Invalid(format!("The report client could not start: {e}")))?;
Ok(ReportService { api: format!("{base_url}/v1/reports"), key: api_key.into(), client })
}
}
/// `Retry-After` in seconds, kept within 1 s .. 1 day; `default` when absent or not a number.
fn retry_delay(retry_after: Option<&str>, default: u64) -> u64 {
retry_after.and_then(|v| v.trim().parse::<i64>().ok()).map_or(default, |v| v.clamp(1, 86400) as u64)
}
/// A JSON object of at most 64 KiB, or nothing.
fn json_object(raw: Option<&[u8]>) -> Option<serde_json::Map<String, serde_json::Value>> {
let raw = raw?;
if raw.len() > MAX_RESPONSE {
return None;
}
match serde_json::from_slice(raw).ok()? {
serde_json::Value::Object(map) => Some(map),
_ => None,
}
}
fn issue_number(data: &serde_json::Map<String, serde_json::Value>) -> std::result::Result<u64, Failure> {
let number = data.get("issue_number").and_then(|n| if n.is_u64() { n.as_u64() } else { None });
match number {
Some(n)
if data.get("status").and_then(|s| s.as_str()) == Some("created")
&& (1..=4294967295).contains(&n)
&& data.get("issue_url").and_then(|u| u.as_str())
== Some(format!("https://github.com/{REPOSITORY}/issues/{n}").as_str()) =>
{
Ok(n)
}
_ => Err(Failure::Uncertain),
}
}
/// What a service answer means (relay.py's `create`): the status, its `Retry-After` and its body (`None` when it
/// could not be read or was longer than 64 KiB).
pub fn classify(status: u16, retry_after: Option<&str>, body: Option<&[u8]>) -> std::result::Result<u64, Failure> {
let field = |data: &serde_json::Map<String, serde_json::Value>, k: &str| data.get(k).and_then(|v| v.as_str()).map(str::to_owned);
match status {
200..=202 => {
let data = json_object(body).ok_or(Failure::Uncertain)?;
match status {
202 if field(&data, "status").as_deref() == Some("pending") => Err(Failure::Pending(retry_delay(retry_after, 2))),
202 => Err(Failure::Uncertain),
_ => issue_number(&data),
}
}
429 => Err(Failure::Limited(retry_delay(retry_after, 300))),
400 | 413 | 415 | 422 => Err(Failure::Invalid),
301 | 302 | 303 | 307 | 308 | 401 | 403 | 404 | 405 => Err(Failure::Blocked(300)),
503 => {
let data = json_object(body).unwrap_or_default();
if field(&data, "status").as_deref() == Some("failed") && field(&data, "error").as_deref() == Some("github_access_denied") {
Err(Failure::Blocked(retry_delay(retry_after, 300)))
} else {
Err(Failure::Uncertain)
}
}
_ => Err(Failure::Uncertain),
}
}
impl Service for ReportService {
fn create(&self, title: &str, body: &str) -> std::result::Result<u64, Failure> {
use std::io::Read;
let sent = self
.client
.post(&self.api)
.header("Authorization", format!("Bearer {}", self.key))
.header("Accept", "application/json")
.header("Content-Type", "application/json")
.body(serde_json::json!({ "title": title, "body": body }).to_string())
.send();
let response = sent.map_err(|_| Failure::Uncertain)?;
let status = response.status().as_u16();
let retry_after = response.headers().get("Retry-After").and_then(|v| v.to_str().ok()).map(str::to_owned);
let mut raw = Vec::new();
let read = response.take(MAX_RESPONSE as u64 + 1).read_to_end(&mut raw).is_ok() && raw.len() <= MAX_RESPONSE;
classify(status, retry_after.as_deref(), read.then_some(raw.as_slice()))
}
}
/// A report: `COABUG1\n<title>\n<body>`, checked as the world writes it.
pub struct Report {
pub digest: String,
pub marker: String,
pub title: String,
pub body: String,
}
pub fn read_report(path: &Path) -> Result<Report> {
let bad = || Error::Invalid("Invalid report file".into());
let key = path.file_stem().and_then(|s| s.to_str()).ok_or_else(bad)?;
let meta = std::fs::symlink_metadata(path)?;
if !valid_key(key) || meta.file_type().is_symlink() || meta.len() > MAX_FILE {
return Err(bad());
}
let raw = std::fs::read(path)?;
let text = String::from_utf8(raw.clone()).map_err(|_| bad())?.replace("\r\n", "\n");
let rest = text.strip_prefix("COABUG1\n").ok_or_else(|| Error::Invalid("Unsupported report format".into()))?;
let invalid = || Error::Invalid("Invalid report content".into());
let (title, body) = rest.split_once('\n').ok_or_else(invalid)?;
if !(3..=200).contains(&title.len())
|| body.trim().is_empty()
|| title.chars().any(|c| (c as u32) < 32)
|| body.chars().any(|c| (c as u32) < 32 && !matches!(c, '\r' | '\n' | '\t'))
{
return Err(invalid());
}
let digest = hex(&Sha256::digest(&raw));
let id = hex(&Sha256::digest(format!("{key}:{digest}").as_bytes()));
Ok(Report { digest, marker: format!("<!-- coa-report:{id} -->"), title: title.into(), body: body.into() })
}
fn hex(bytes: &[u8]) -> String {
bytes.iter().map(|b| format!("{b:02x}")).collect()
}
/// `<key>.status`: what the world shows the player (`queued`, `created|<issue>`, `failed`, ...).
pub fn write_status(spool: &Path, key: &str, state: &str, number: Option<u64>) -> Result<()> {
let value = match (state, number) {
("created", Some(n)) => format!("created|{n}"),
("created", None) => "created|None".into(),
_ => state.to_string(),
};
let data = format!("{value}\n");
let destination = spool.join(format!("{key}.status"));
if std::fs::read(&destination).is_ok_and(|d| d == data.as_bytes()) {
return Ok(());
}
crate::fsx::atomic_write(&destination, data.as_bytes())
}
fn now() -> f64 {
SystemTime::now().duration_since(UNIX_EPOCH).map(|d| d.as_secs_f64()).unwrap_or(0.0)
}
/// The delivery journal of one spool.
pub struct Relay<S: Service> {
spool: PathBuf,
service: S,
db: Connection,
clock: Box<dyn Fn() -> f64 + Send>,
}
impl<S: Service> Relay<S> {
pub fn open(spool: &Path, service: S) -> Result<Relay<S>> {
Self::with_clock(spool, service, Box::new(now))
}
pub fn with_clock(spool: &Path, service: S, clock: Box<dyn Fn() -> f64 + Send>) -> Result<Relay<S>> {
let db = Connection::open(spool.join("relay.sqlite3")).map_err(sql)?;
db.execute_batch(
"PRAGMA synchronous=FULL;
CREATE TABLE IF NOT EXISTS deliveries (
key TEXT PRIMARY KEY, digest TEXT NOT NULL, marker TEXT NOT NULL, state TEXT NOT NULL,
number INTEGER, attempted REAL NOT NULL DEFAULT 0, next_try REAL NOT NULL DEFAULT 0
);
CREATE TABLE IF NOT EXISTS settings (key TEXT PRIMARY KEY, value REAL NOT NULL);
UPDATE deliveries SET state='uncertain' WHERE state='posting';",
)
.map_err(sql)?;
Ok(Relay { spool: spool.into(), service, db, clock })
}
fn set_state(&self, key: &str, state: &str, number: Option<u64>, delay: u64) -> Result<()> {
self.db
.execute(
"UPDATE deliveries SET state=?1, number=?2, next_try=?3 WHERE key=?4",
params![state, number.map(|n| n as i64), (self.clock)() + delay as f64, key],
)
.map_err(sql)?;
write_status(&self.spool, key, state, number)
}
fn set_network_gate(&self, delay: u64) -> Result<()> {
self.db
.execute("INSERT OR REPLACE INTO settings VALUES('next_network',?1)", params![(self.clock)() + delay as f64])
.map_err(sql)?;
Ok(())
}
/// Handle one report file; returns its delivery state.
pub fn process(&self, path: &Path) -> Result<String> {
let Some(key) = path.file_stem().and_then(|s| s.to_str()).filter(|k| valid_key(k)) else {
return Ok("ignored".into());
};
let report = match read_report(path) {
Ok(r) => r,
Err(_) => {
write_status(&self.spool, key, "failed", None)?;
return Ok("failed".into());
}
};
self.db
.execute(
"INSERT OR IGNORE INTO deliveries(key,digest,marker,state) VALUES(?1,?2,?3,'queued')",
params![key, report.digest, report.marker],
)
.map_err(sql)?;
let (digest, row_state, number, next_try): (String, String, Option<i64>, f64) = self
.db
.query_row("SELECT digest, state, number, next_try FROM deliveries WHERE key=?1", params![key], |r| {
Ok((r.get(0)?, r.get(1)?, r.get(2)?, r.get(3)?))
})
.map_err(sql)?;
let number = number.map(|n| n as u64);
if digest != report.digest {
// Never replace an existing delivery or publish edited content under the same ID.
write_status(&self.spool, key, "failed", None)?;
return Ok("changed".into());
}
if matches!(row_state.as_str(), "created" | "failed" | "uncertain") {
write_status(&self.spool, key, &row_state, number)?;
return Ok(row_state);
}
if next_try > (self.clock)() {
write_status(&self.spool, key, &row_state, None)?;
return Ok(row_state);
}
let gate: Option<f64> = self
.db
.query_row("SELECT value FROM settings WHERE key='next_network'", [], |r| r.get(0))
.optional()
.map_err(sql)?;
if gate.is_some_and(|g| g > (self.clock)()) {
write_status(&self.spool, key, &row_state, None)?;
return Ok(row_state);
}
self.set_network_gate(5)?;
// A crash after this point needs review: the service's duplicate cache can reset on deploy.
self.db
.execute("UPDATE deliveries SET state='posting', attempted=?1 WHERE key=?2", params![(self.clock)(), key])
.map_err(sql)?;
match self.service.create(&report.title, &report.body) {
Ok(n) => {
self.set_state(key, "created", Some(n), 0)?;
Ok("created".into())
}
Err(failure) => {
let (state, delay) = match failure {
Failure::Limited(d) | Failure::Pending(d) => ("queued", d),
Failure::Blocked(d) => ("blocked", d),
Failure::Invalid => ("failed", 300),
Failure::Uncertain => ("uncertain", 300),
};
self.set_state(key, state, None, delay)?;
if let Failure::Limited(d) | Failure::Blocked(d) = failure {
self.set_network_gate(d)?;
}
Ok(state.into())
}
}
}
/// One pass over the spool, in name order.
pub fn pass(&self) -> Result<()> {
let mut reports: Vec<PathBuf> = std::fs::read_dir(&self.spool)?
.flatten()
.map(|e| e.path())
.filter(|p| p.extension().is_some_and(|x| x == "report"))
.collect();
reports.sort();
for path in reports {
self.process(&path)?;
}
Ok(())
}
}
fn sql(e: rusqlite::Error) -> Error {
Error::Invalid(format!("The bug-report journal failed ({e})."))
}
/// `relay-worker`: deliver reports until the supervisor asks the relay to stop (`.state/stop-relay`).
pub fn worker(root: &Path) -> Result<()> {
let spool = root.join("BugReport/reports");
std::fs::create_dir_all(&spool)?;
let _lock = state::FileLock::try_acquire(&spool.join("relay.lock"))?
.ok_or_else(|| Error::Invalid("Another bug-report relay is already using this spool.".into()))?;
let key = std::env::var("COA_BUGREPORT_API_KEY").unwrap_or_else(|_| DEFAULT_API_KEY.into());
let relay = Relay::open(&spool, ReportService::new(SERVICE_URL, &key)?)?;
state::record(root, "relay-ready", std::process::id())?;
println!("Bug-report relay ready. Waiting for in-game reports.");
let stop = state::dir(root).join("stop-relay");
while !stop.exists() {
relay.pass()?;
for _ in 0..10 {
if stop.exists() {
return Ok(());
}
std::thread::sleep(Duration::from_millis(500));
}
}
Ok(())
}
#[cfg(test)]
mod tests {
use super::*;
use std::sync::{Arc, Mutex};
type Answers = Arc<Mutex<Vec<std::result::Result<u64, Failure>>>>;
struct Fake(Answers, Arc<Mutex<u32>>);
impl Service for Fake {
fn create(&self, _: &str, _: &str) -> std::result::Result<u64, Failure> {
*self.1.lock().unwrap() += 1;
self.0.lock().unwrap().remove(0)
}
}
fn report(spool: &Path, key: &str, text: &str) -> PathBuf {
let p = spool.join(format!("{key}.report"));
std::fs::write(&p, text).unwrap();
p
}
#[test]
fn keys_follow_the_world_format() {
assert!(valid_key("1-0123456789abcdef"));
assert!(valid_key("4294967295-0123456789abcdef0123456789abcdef0123456789abcdef"));
for bad in ["0-0123456789abcdef", "1-0123456789abcde", "1-0123456789ABCDEF", "12345678901-0123456789abcdef", "x"] {
assert!(!valid_key(bad), "{bad}");
}
}
#[test]
fn service_answers_map_like_relay_py() {
let ok = format!(r#"{{"status":"created","issue_number":12,"issue_url":"https://github.com/{REPOSITORY}/issues/12"}}"#);
let cases: Vec<(u16, Option<&str>, Option<&[u8]>, std::result::Result<u64, Failure>)> = vec![
(201, None, Some(ok.as_bytes()), Ok(12)),
(200, None, Some(ok.as_bytes()), Ok(12)),
(201, None, Some(br#"{"status":"created","issue_number":12,"issue_url":"https://evil/12"}"#), Err(Failure::Uncertain)),
(201, None, Some(br#"{"status":"created","issue_number":0,"issue_url":"x"}"#), Err(Failure::Uncertain)),
(201, None, Some(b"[1]"), Err(Failure::Uncertain)),
(201, None, None, Err(Failure::Uncertain)),
(202, Some("7"), Some(br#"{"status":"pending"}"#), Err(Failure::Pending(7))),
(202, None, Some(br#"{"status":"pending"}"#), Err(Failure::Pending(2))),
(202, None, Some(br#"{"status":"other"}"#), Err(Failure::Uncertain)),
(429, Some("999999"), None, Err(Failure::Limited(86400))),
(429, Some("0"), None, Err(Failure::Limited(1))),
(429, Some("soon"), None, Err(Failure::Limited(300))),
(422, None, None, Err(Failure::Invalid)),
(302, None, None, Err(Failure::Blocked(300))),
(401, None, None, Err(Failure::Blocked(300))),
(503, Some("30"), Some(br#"{"status":"failed","error":"github_access_denied"}"#), Err(Failure::Blocked(30))),
(503, None, Some(b"{}"), Err(Failure::Uncertain)),
(500, None, None, Err(Failure::Uncertain)),
];
for (i, (status, retry, body, expected)) in cases.into_iter().enumerate() {
assert_eq!(classify(status, retry, body), expected, "case {i}");
}
assert!(json_object(Some(&vec![b' '; MAX_RESPONSE + 1])).is_none(), "oversized answers are refused");
assert!(ReportService::new(SERVICE_URL, "has space").is_err());
assert!(ReportService::new(SERVICE_URL, "coa_key").is_ok());
}
#[test]
fn a_report_is_checked_and_identified_like_relay_py() {
let d = tempfile::tempdir().unwrap();
let p = report(d.path(), "7-0123456789abcdef", "COABUG1\r\nBroken quest\r\nThe NPC is missing.\r\n");
let r = read_report(&p).unwrap();
assert_eq!(r.title, "Broken quest");
assert_eq!(r.body, "The NPC is missing.\n");
assert_eq!(r.digest, hex(&Sha256::digest(std::fs::read(&p).unwrap())));
assert!(r.marker.starts_with("<!-- coa-report:") && r.marker.len() == 16 + 64 + 4);
for bad in ["COABUG2\nTitle\nBody", "COABUG1\nab\nBody", "COABUG1\nTitle\n \n", "COABUG1\nTi\u{7}tle\nBody", "COABUG1\nTitle"] {
std::fs::write(&p, bad).unwrap();
assert!(read_report(&p).is_err(), "{bad:?}");
}
}
#[test]
fn deliveries_follow_the_journal() {
let d = tempfile::tempdir().unwrap();
let spool = d.path();
let t = Arc::new(Mutex::new(1000.0f64));
let calls = Arc::new(Mutex::new(0));
let answers: Answers = Arc::new(Mutex::new(vec![Err(Failure::Limited(60)), Ok(42)]));
let clock = t.clone();
let relay = Relay::with_clock(spool, Fake(answers, calls.clone()), Box::new(move || *clock.lock().unwrap())).unwrap();
let p = report(spool, "7-0123456789abcdef", "COABUG1\nBroken quest\nThe NPC is missing.\n");
let status = || std::fs::read_to_string(spool.join("7-0123456789abcdef.status")).unwrap();
assert_eq!(relay.process(&p).unwrap(), "queued", "429 keeps it queued");
assert_eq!(status(), "queued\n");
assert_eq!(relay.process(&p).unwrap(), "queued", "not before its retry time");
assert_eq!(*calls.lock().unwrap(), 1);
*t.lock().unwrap() += 61.0;
assert_eq!(relay.process(&p).unwrap(), "created");
assert_eq!(status(), "created|42\n");
assert_eq!(relay.process(&p).unwrap(), "created", "never sent twice");
assert_eq!(*calls.lock().unwrap(), 2);
std::fs::write(&p, "COABUG1\nBroken quest\nEdited.\n").unwrap();
assert_eq!(relay.process(&p).unwrap(), "changed");
relay
.db
.execute("INSERT INTO deliveries(key,digest,marker,state) VALUES('8-0123456789abcdef','x','m','posting')", [])
.unwrap();
drop(relay);
let reopened = Relay::open(spool, Fake(Arc::new(Mutex::new(vec![])), calls.clone())).unwrap();
let state: String =
reopened.db.query_row("SELECT state FROM deliveries WHERE key='8-0123456789abcdef'", [], |r| r.get(0)).unwrap();
assert_eq!(state, "uncertain", "an interrupted post is never retried");
}
#[test]
fn a_second_worker_cannot_take_the_spool() {
let d = tempfile::tempdir().unwrap();
let first = state::FileLock::try_acquire(&d.path().join("relay.lock")).unwrap();
assert!(first.is_some());
assert!(state::FileLock::try_acquire(&d.path().join("relay.lock")).unwrap().is_none());
drop(first);
assert!(state::FileLock::try_acquire(&d.path().join("relay.lock")).unwrap().is_some());
}
}
+367
View File
@@ -0,0 +1,367 @@
//! `prepare`: the configuration files a repack runs with, rendered from `Settings/*.template` and
//! `Settings/repack.json` (`manage.py prepare()`), byte for byte the same.
use std::path::{Path, PathBuf};
use crate::error::{Error, Result};
use crate::launcher::{settings::Settings, state};
/// Services whose running process blocks moving the folder or changing ports.
const SERVICES: [&str; 5] = ["mysql", "auth", "world", "supervisor", "relay"];
/// The root as the servers see it: forward slashes, and the short (8.3) form when the real one has non-Latin
/// letters, which MySQL and the servers do not read reliably from their config files.
pub fn native_root(root: &Path) -> Result<String> {
let mut value = root.to_string_lossy().into_owned();
if !value.is_ascii() {
if let Some(short) = sys::short_path(root) {
value = short;
}
}
if !value.is_ascii() {
return Err(Error::Invalid(
"Extract the repack to a path with Latin letters, such as C:\\Games\\CoA-Repack.".into(),
));
}
Ok(value.replace('\\', "/"))
}
/// Text as Python's text mode reads it: strict UTF-8, Windows and old Mac line ends turned into "\n".
fn read_text(path: &Path) -> Result<String> {
let bytes = std::fs::read(path)?;
let text = String::from_utf8(bytes).map_err(|_| Error::Invalid(format!("{} is not UTF-8 text.", path.display())))?;
Ok(text.replace("\r\n", "\n").replace('\r', "\n"))
}
/// Text written as Python's text mode writes it on Windows: "\n" becomes "\r\n".
fn windows_text(text: &str) -> Vec<u8> {
if cfg!(windows) {
text.replace('\n', "\r\n").into_bytes()
} else {
text.as_bytes().to_vec()
}
}
fn placeholders(line: &str) -> Vec<String> {
let mut out = Vec::new();
let bytes = line.as_bytes();
let mut i = 0;
while i < bytes.len() {
if bytes[i] == b'@' {
let mut j = i + 1;
while j < bytes.len() && (bytes[j].is_ascii_alphabetic() || bytes[j] == b'_') {
j += 1;
}
if j < bytes.len() && j > i + 1 && bytes[j] == b'@' {
out.push(line[i..=j].to_string());
i = j + 1;
continue;
}
}
i += 1;
}
out
}
fn credentials(root: &Path) -> Result<(String, String)> {
let v: serde_json::Value = crate::fsx::read_json(&root.join("Settings/database.json"))?;
let good = |k: &str| {
v.get(k)
.and_then(|x| x.as_str())
.filter(|s| s.len() == 48 && s.bytes().all(|b| b.is_ascii_digit() || (b'a'..=b'f').contains(&b)))
.map(str::to_string)
};
match (good("rootPassword"), good("appPassword")) {
(Some(r), Some(a)) => Ok((r, a)),
_ => Err(Error::Invalid("Invalid packaged database configuration.".into())),
}
}
/// Render every file the repack's services read. Refuses while a service runs and the folder or the ports
/// changed since the last render.
pub fn prepare(root: &Path, config: &Settings) -> Result<Vec<PathBuf>> {
let base = native_root(root)?;
let signature = serde_json::json!({
"root": root.to_string_lossy(),
"ports": serde_json::Value::Object(config.port_map()),
});
let previous = state::dir(root).join("configuration.json");
if previous.exists() {
let recorded: Option<serde_json::Value> = crate::fsx::read_json(&previous).ok();
if recorded.as_ref() != Some(&signature) && SERVICES.iter().any(|s| state::running(root, s).is_some()) {
return Err(Error::Invalid("Stop this repack before moving its folder or changing its ports.".into()));
}
}
let (root_password, app_password) = credentials(root)?;
for folder in ["Core/configs/modules", "Core/Logs", "BugReport/reports", "BugReport/Logs", "mysql/logs", ".state"] {
std::fs::create_dir_all(root.join(folder))?;
}
let mysql_port = config.mysql_port;
let mut values: Vec<(&str, String)> = vec![
("DATA", format!("{base}/Data")),
("LOGS", format!("{base}/Core/Logs")),
("ASCENSION_DBC", format!("{base}/Data/dbc/Ascension")),
("MYSQL_EXE", format!("{base}/mysql/bin/mysql.exe")),
("AUTH_PORT", config.auth_port.to_string()),
("WORLD_PORT", config.world_port.to_string()),
("RA_PORT", config.ra_port.to_string()),
];
for (key, db) in [
("LoginDatabaseInfo", "acore_auth"),
("WorldDatabaseInfo", config.realm.world_db),
("CharacterDatabaseInfo", config.realm.characters_db),
] {
values.push((key, format!("127.0.0.1;{mysql_port};acore;{app_password};{db}")));
}
let mut written = Vec::new();
for (name, target) in [
("authserver.conf", "Core/configs/authserver.conf"),
("worldserver.conf", "Core/configs/worldserver.conf"),
("mod_ascension_compat.conf", "Core/configs/modules/mod_ascension_compat.conf"),
] {
let mut text = read_text(&root.join("Settings").join(format!("{name}.template")))?;
for (key, value) in &values {
text = text.replace(&format!("@{key}@"), value);
}
let mut unresolved: Vec<String> = text
.split('\n')
.filter(|l| !l.trim().is_empty() && !l.trim_start().starts_with('#'))
.flat_map(placeholders)
.collect();
unresolved.sort();
unresolved.dedup();
if !unresolved.is_empty() {
return Err(Error::Service(
crate::error::ErrorCode::InvalidConfigValue,
format!("An unresolved placeholder remains in Settings/{name}.template: {}", unresolved.join(", ")),
));
}
// these three keep "\n" (Python wrote them with newline="\n")
std::fs::write(root.join(target), text.as_bytes())?;
written.push(root.join(target));
}
let custom = custom_mysql_options(root);
let files: [(&str, String); 3] = [
(
"Core/configs/modules/coa_bugreport.conf",
format!(
"# Managed by the repack launcher. Enabled whenever worldserver starts.\nCoABugReport.Enable = 1\nCoABugReport.SpoolDirectory = \"{base}/BugReport/reports\"\nCoABugReport.CooldownSeconds = 120\n"
),
),
(
"mysql/my.ini",
format!(
"[mysqld]\nbasedir=\"{base}/mysql\"\ndatadir=\"{base}/mysql/data\"\nport={mysql_port}\nbind-address=127.0.0.1\nmysqlx=0\ncharacter-set-server=utf8mb4\ncollation-server=utf8mb4_unicode_ci\nmax_allowed_packet=128M\ninnodb_buffer_pool_size=256M\nskip-log-bin\nlog-error=\"{base}/mysql/logs/mysql-error.log\"\npid-file=\"{base}/mysql/mysql.pid\"\n{custom}"
),
),
(
"mysql/admin-client.ini",
format!(
"[client]\nuser=root\npassword={root_password}\nhost=127.0.0.1\nport={mysql_port}\nprotocol=tcp\ndefault-character-set=utf8mb4\n"
),
),
];
for (rel, text) in files {
std::fs::write(root.join(rel), windows_text(&text))?;
written.push(root.join(rel));
}
state::write_json(&previous, &signature)?;
Ok(written)
}
/// The owner's file of extra MySQL options; the launcher rewrites `mysql/my.ini` at every start.
pub const CUSTOM_MYSQL: &str = "Settings/mysql-custom.ini";
/// The owner's MySQL options as written, and the lines a start will add to `[mysqld]`.
#[derive(Debug, serde::Serialize)]
#[serde(rename_all = "camelCase")]
pub struct CustomMysql {
pub text: String,
pub applied: String,
}
pub fn read_custom_mysql(root: &Path) -> CustomMysql {
let text = std::fs::read(root.join(CUSTOM_MYSQL))
.map(|b| String::from_utf8_lossy(&b).into_owned())
.unwrap_or_default();
CustomMysql { text, applied: custom_mysql_options(root) }
}
/// Save the owner's MySQL options; they apply at the next start of the database.
pub fn write_custom_mysql(root: &Path, text: &str) -> Result<CustomMysql> {
if text.len() > 16 * 1024 || text.contains(char::from(0)) {
return Err(Error::Invalid("The MySQL options must be plain text of at most 16 KB.".into()));
}
crate::fsx::atomic_write(&root.join(CUSTOM_MYSQL), text.replace("\r\n", "\n").as_bytes())?;
Ok(read_custom_mysql(root))
}
/// Options the server cannot run without, which only the launcher sets.
const MANAGED_MYSQL_OPTIONS: [&str; 10] = [
"basedir",
"datadir",
"port",
"bind-address",
"mysqlx",
"log-error",
"pid-file",
"socket",
"skip-networking",
"defaults-file",
];
/// `name = value` lines of the owner's file (outside any section or in `[mysqld]`), as lines for `[mysqld]`.
/// Comments, other sections, `!include` and the options the launcher manages are left out.
pub fn custom_mysql_options(root: &Path) -> String {
let Ok(bytes) = std::fs::read(root.join(CUSTOM_MYSQL)) else {
return String::new();
};
let text = String::from_utf8_lossy(&bytes);
let mut in_mysqld = true;
let mut out = String::new();
for line in text.trim_start_matches('\u{feff}').lines() {
let line = line.trim();
if line.is_empty() || line.starts_with('#') || line.starts_with(';') {
continue;
}
if line.starts_with('[') {
in_mysqld = line.eq_ignore_ascii_case("[mysqld]");
continue;
}
if !in_mysqld || line.starts_with('!') {
continue;
}
let name = line
.split('=')
.next()
.unwrap_or("")
.trim()
.to_ascii_lowercase()
.replace('_', "-");
let name = name.strip_prefix("loose-").unwrap_or(&name);
if name.is_empty() || MANAGED_MYSQL_OPTIONS.contains(&name) {
continue;
}
out.push_str(line);
out.push('\n');
}
out
}
#[cfg(windows)]
mod sys {
use std::os::windows::ffi::OsStrExt;
use std::path::Path;
use windows_sys::Win32::Storage::FileSystem::GetShortPathNameW;
pub fn short_path(path: &Path) -> Option<String> {
let wide: Vec<u16> = path.as_os_str().encode_wide().chain(Some(0)).collect();
let mut buf = vec![0u16; 32768];
let n = unsafe { GetShortPathNameW(wide.as_ptr(), buf.as_mut_ptr(), buf.len() as u32) };
(n > 0 && (n as usize) < buf.len()).then(|| String::from_utf16_lossy(&buf[..n as usize]))
}
}
#[cfg(not(windows))]
mod sys {
pub fn short_path(_: &std::path::Path) -> Option<String> {
None
}
}
#[cfg(test)]
mod tests {
use super::*;
pub(crate) fn fixture(root: &Path) {
let w = |rel: &str, text: &[u8]| {
let p = root.join(rel);
std::fs::create_dir_all(p.parent().unwrap()).unwrap();
std::fs::write(p, text).unwrap();
};
w("Settings/repack.json", br#"{"authPort": 3724, "mysqlPort": 3307, "raPassword": "e0c39beaa5c14128", "raPort": 3443, "raUsername": "COAMANAGER", "worldPort": 8085}"#);
w("Settings/database.json", format!(r#"{{"rootPassword": "{}", "appPassword": "{}"}}"#, "a".repeat(48), "0123456789abcdef".repeat(3)).as_bytes());
w("Settings/authserver.conf.template", b"[authserver]\r\nLoginDatabaseInfo = \"@LoginDatabaseInfo@\"\r\nRealmServerPort = @AUTH_PORT@\r\nLogsDir = \"@LOGS@\"\r\n# @NOT_A_VALUE@ in a comment is fine\r\n");
w("Settings/worldserver.conf.template", "[worldserver]\nDataDir = \"@DATA@\"\nWorldServerPort = @WORLD_PORT@\nRa.Port = @RA_PORT@\nWorldDatabaseInfo = \"@WorldDatabaseInfo@\"\nCharacterDatabaseInfo = \"@CharacterDatabaseInfo@\"\nMySQLExecutable = \"@MYSQL_EXE@\"\nMotd = \"Ünïcode stays\"\n".as_bytes());
w("Settings/mod_ascension_compat.conf.template", b"Ascension.DbcDir = \"@ASCENSION_DBC@\"\rOld.Mac = 1\r");
}
#[test]
fn the_owners_mysql_options_are_kept_except_the_managed_ones() {
let d = tempfile::tempdir().unwrap();
std::fs::create_dir_all(d.path().join("Settings")).unwrap();
std::fs::write(
d.path().join(CUSTOM_MYSQL),
"\u{feff}# tuning\ninnodb_buffer_pool_size = 2G\nport=3999\nloose_bind_address=0.0.0.0\n!include C:/x.ini\n[client]\nuser=evil\n[mysqld]\nmax_connections=500\nDATADIR=D:/elsewhere\n",
)
.unwrap();
assert_eq!(
custom_mysql_options(d.path()),
"innodb_buffer_pool_size = 2G\nmax_connections=500\n"
);
assert_eq!(custom_mysql_options(&d.path().join("missing")), "");
}
#[test]
fn placeholders_left_outside_comments_are_refused() {
let d = tempfile::tempdir().unwrap();
fixture(d.path());
std::fs::write(d.path().join("Settings/worldserver.conf.template"), "A = @UNKNOWN@\n").unwrap();
let cfg = Settings::load(d.path(), 0).unwrap();
let err = prepare(d.path(), &cfg).unwrap_err().to_string();
assert!(err.contains("worldserver.conf.template: @UNKNOWN@"), "{err}");
}
#[test]
fn a_bad_password_file_is_refused() {
let d = tempfile::tempdir().unwrap();
fixture(d.path());
std::fs::write(d.path().join("Settings/database.json"), r#"{"rootPassword":"short","appPassword":"x"}"#).unwrap();
let cfg = Settings::load(d.path(), 0).unwrap();
assert!(prepare(d.path(), &cfg).unwrap_err().to_string().contains("Invalid packaged database configuration"));
}
/// Byte-for-byte the same files as the Python launcher. COA_MANAGE_PY = a manage.py to compare with (taken from
/// coa-server-build); skipped without it.
#[test]
fn renders_exactly_what_manage_py_renders() {
let Ok(manage) = std::env::var("COA_MANAGE_PY") else { return };
let python = std::env::var("COA_PYTHON").unwrap_or_else(|_| "python".into());
let rust = tempfile::tempdir().unwrap();
let py = tempfile::tempdir().unwrap();
for d in [rust.path(), py.path()] {
fixture(d);
}
std::fs::create_dir_all(py.path().join("Scripts")).unwrap();
std::fs::copy(&manage, py.path().join("Scripts/manage.py")).unwrap();
// manage.py imports squid_playerbots lazily; prepare does not need it.
let out = std::process::Command::new(&python)
.args(["-I", "-B"])
.arg(py.path().join("Scripts/manage.py"))
.arg("prepare")
.output()
.unwrap();
assert!(out.status.success(), "{}{}", String::from_utf8_lossy(&out.stdout), String::from_utf8_lossy(&out.stderr));
let cfg = Settings::load(rust.path(), 0).unwrap();
let written = prepare(rust.path(), &cfg).unwrap();
let root_text = |p: &Path, base: &Path| {
let n = native_root(base).unwrap();
String::from_utf8(std::fs::read(p).unwrap()).unwrap().replace(&n, "<ROOT>")
};
for file in &written {
let rel = file.strip_prefix(rust.path()).unwrap();
assert_eq!(
root_text(file, rust.path()),
root_text(&py.path().join(rel), py.path()),
"{} differs",
rel.display()
);
}
let sig = |base: &Path| -> serde_json::Value {
let mut v: serde_json::Value = crate::fsx::read_json(&base.join(".state/configuration.json")).unwrap();
v["root"] = serde_json::Value::Null;
v
};
assert_eq!(sig(rust.path()), sig(py.path()));
}
}
+162
View File
@@ -0,0 +1,162 @@
//! Restarts on a schedule (#202): once a day at the owner's local time, the world supervisor asks the world to
//! restart with an in-game countdown, waits for it to exit with AzerothCore's restart code and starts it again.
//! The database and the auth server keep running.
use std::path::{Path, PathBuf};
use std::time::Duration;
use chrono::{Local, NaiveDateTime, NaiveTime, Timelike};
use serde::{Deserialize, Serialize};
use crate::error::{Error, Result};
const FILE: &str = "Settings/restart-schedule.json";
/// Present while a scheduled restart is under way, so a world that is briefly down is not taken for a crash.
const UNDER_WAY: &str = ".state/scheduled-restart";
/// The exit code of `server restart` (AzerothCore's `RESTART_EXIT_CODE`).
pub const RESTART_EXIT_CODE: i32 = 2;
/// A restart missed by more than this (the computer slept, the world started late) waits for the next day.
const LATE: Duration = Duration::from_secs(15 * 60);
/// A world that has not come back within this time no longer counts as restarting.
const UNDER_WAY_LIMIT: Duration = Duration::from_secs(45 * 60);
#[derive(Debug, Clone, PartialEq, Eq, Serialize, Deserialize)]
#[serde(rename_all = "camelCase")]
pub struct RestartSchedule {
pub enabled: bool,
/// Local time, `HH:MM`.
pub time: String,
/// The in-game countdown before the restart, in minutes (1-60).
pub warning_minutes: u32,
}
impl Default for RestartSchedule {
fn default() -> Self {
Self {
enabled: false,
time: "05:00".into(),
warning_minutes: 5,
}
}
}
impl RestartSchedule {
fn at(&self) -> Option<NaiveTime> {
NaiveTime::parse_from_str(self.time.trim(), "%H:%M").ok()
}
fn validate(&self) -> Result<()> {
if self.at().is_none() {
return Err(Error::Invalid("The restart time must be HH:MM, for example 05:00.".into()));
}
if !(1..=60).contains(&self.warning_minutes) {
return Err(Error::Invalid("The restart warning must be 1 to 60 minutes.".into()));
}
Ok(())
}
/// The scheduled moment of `now`'s day, when a restart is due at `now` for a world started at `started`:
/// the moment has passed by less than [`LATE`] and the world was already running before it.
pub fn due(&self, now: NaiveDateTime, started: NaiveDateTime) -> Option<NaiveDateTime> {
if !self.enabled {
return None;
}
let moment = now.date().and_time(self.at()?);
let late = now.signed_duration_since(moment).to_std().ok()?;
(late <= LATE && started < moment).then_some(moment)
}
}
/// The folder whose schedule a world follows: an extra world (`<server>/.realms/<name>`) follows its server's.
fn owner(root: &Path) -> PathBuf {
if crate::launcher::settings::is_extra_world(root) {
if let Some(main) = root.parent().and_then(Path::parent) {
return main.to_path_buf();
}
}
root.to_path_buf()
}
pub fn load(root: &Path) -> RestartSchedule {
crate::fsx::read_json(&owner(root).join(FILE)).unwrap_or_default()
}
pub fn save(root: &Path, schedule: &RestartSchedule) -> Result<RestartSchedule> {
let mut schedule = schedule.clone();
schedule.time = schedule.time.trim().to_string();
if schedule.enabled {
schedule.validate()?;
} else if schedule.at().is_none() {
schedule.time = RestartSchedule::default().time;
}
crate::fsx::atomic_write_json(&owner(root).join(FILE), &schedule)?;
Ok(schedule)
}
pub fn now() -> NaiveDateTime {
Local::now().naive_local().with_nanosecond(0).unwrap_or_else(|| Local::now().naive_local())
}
pub fn mark_under_way(root: &Path) -> Result<()> {
let path = root.join(UNDER_WAY);
if let Some(parent) = path.parent() {
std::fs::create_dir_all(parent)?;
}
std::fs::write(path, b"")?;
Ok(())
}
pub fn clear_under_way(root: &Path) {
let _ = std::fs::remove_file(root.join(UNDER_WAY));
}
/// A scheduled restart of this world is under way (its world may be down for a few minutes).
pub fn under_way(root: &Path) -> bool {
std::fs::metadata(root.join(UNDER_WAY))
.and_then(|m| m.modified())
.is_ok_and(|t| t.elapsed().is_ok_and(|age| age < UNDER_WAY_LIMIT))
}
#[cfg(test)]
mod tests {
use super::*;
fn at(text: &str) -> NaiveDateTime {
NaiveDateTime::parse_from_str(text, "%Y-%m-%d %H:%M").unwrap()
}
#[test]
fn a_restart_is_due_once_after_its_time_for_a_world_that_ran_before_it() {
let s = RestartSchedule { enabled: true, time: "05:00".into(), warning_minutes: 5 };
let started = at("2026-11-14 20:00");
assert_eq!(s.due(at("2026-11-15 04:59"), started), None);
assert_eq!(s.due(at("2026-11-15 05:00"), started), Some(at("2026-11-15 05:00")));
assert_eq!(s.due(at("2026-11-15 05:14"), started), Some(at("2026-11-15 05:00")));
assert_eq!(s.due(at("2026-11-15 05:16"), started), None, "missed by too much");
// The world that came back at 05:06 is not restarted again that day.
assert_eq!(s.due(at("2026-11-15 05:10"), at("2026-11-15 05:06")), None);
assert_eq!(s.due(at("2026-11-16 05:01"), at("2026-11-15 05:06")), Some(at("2026-11-16 05:00")));
let off = RestartSchedule { enabled: false, ..s };
assert_eq!(off.due(at("2026-11-15 05:00"), started), None);
}
#[test]
fn schedules_are_validated_and_extra_worlds_follow_their_server() {
let d = tempfile::tempdir().unwrap();
assert_eq!(load(d.path()), RestartSchedule::default());
let bad = RestartSchedule { enabled: true, time: "25:00".into(), warning_minutes: 5 };
assert!(save(d.path(), &bad).is_err());
let quiet = RestartSchedule { enabled: true, time: "05:00".into(), warning_minutes: 0 };
assert!(save(d.path(), &quiet).is_err());
let good = RestartSchedule { enabled: true, time: " 04:30 ".into(), warning_minutes: 10 };
assert_eq!(save(d.path(), &good).unwrap().time, "04:30");
let extra = d.path().join(".realms/secondary");
std::fs::create_dir_all(&extra).unwrap();
assert!(load(&extra).enabled);
assert!(!under_way(d.path()));
mark_under_way(d.path()).unwrap();
assert!(under_way(d.path()));
clear_under_way(d.path());
assert!(!under_way(d.path()));
}
}
+768
View File
@@ -0,0 +1,768 @@
//! Starting, checking and stopping the services of one repack: MySQL, authserver, worldserver
//! (`manage.py start_mysql`, `start_auth`, `stop_all` and their helpers), with the same rules.
use std::net::{SocketAddr, TcpStream};
use std::path::{Path, PathBuf};
use std::process::{Command, Stdio};
use std::time::{Duration, Instant};
use crate::error::{Error, ErrorCode, Result};
use crate::launcher::{settings::Settings, state};
use crate::process::ProcessIdentity;
pub type Progress<'a> = &'a dyn Fn(&str);
const CREATE_NO_WINDOW: u32 = 0x0800_0000;
const CREATE_NEW_PROCESS_GROUP: u32 = 0x0000_0200;
fn hidden(cmd: &mut Command) -> &mut Command {
#[cfg(windows)]
{
use std::os::windows::process::CommandExt;
cmd.creation_flags(CREATE_NO_WINDOW | CREATE_NEW_PROCESS_GROUP);
}
cmd
}
/// Start `exe` with its output appended to `log`, and record it as `name`. `env_remove` are variables of this
/// process the service must not see.
pub fn spawn(root: &Path, name: &str, exe: &Path, args: &[&str], cwd: &Path, log: &Path, env_remove: &[String]) -> Result<ProcessIdentity> {
let child = crate::launcher::spawn::start(exe, args, cwd, log, env_remove)?;
state::record(root, name, child.pid)
}
// ---------------------------------------------------------------------------------------------------------------
// Ports
// ---------------------------------------------------------------------------------------------------------------
/// What keeps a new server off a port.
#[derive(Debug, Clone, PartialEq, Eq)]
pub enum PortBlock {
/// Processes listen on it.
Owned(Vec<u32>),
/// Windows keeps it in an excluded range (Hyper-V, WSL and Docker reserve such ranges); waiting never helps.
Reserved(u16, u16),
/// Windows still refuses it after the wait (a stopped process' socket, or an owner the table does not show).
Unavailable(i32),
}
/// Wait (up to `wait`) until `port` can be bound by a new server. A port with a listening owner or inside a
/// Windows excluded range is reported at once; a port Windows still holds for a stopped process (a PID-zero row)
/// is waited for. The test bind is exclusive (`SO_EXCLUSIVEADDRUSE`), never a shared one.
pub fn port_block(port: u16, wait: Duration, progress: Progress) -> std::result::Result<(), PortBlock> {
let deadline = Instant::now() + wait;
let mut announced = false;
let mut reserved: Option<Vec<(u16, u16)>> = None;
loop {
let mut owners: Vec<u32> = sys::tcp_rows_v4()
.into_iter()
.filter(|r| r.state == sys::LISTEN && r.local_port == port)
.map(|r| r.pid)
.collect();
owners.sort_unstable();
owners.dedup();
if owners.iter().any(|p| *p != 0) {
return Err(PortBlock::Owned(owners));
}
match sys::exclusive_bind(port) {
Ok(()) => return Ok(()),
Err(code) if code == 10013 || code == 10048 => {
let ranges = reserved.get_or_insert_with(sys::excluded_ranges);
if let Some((start, end)) = ranges.iter().copied().find(|(s, e)| (*s..=*e).contains(&port)) {
return Err(PortBlock::Reserved(start, end));
}
if Instant::now() >= deadline {
return Err(PortBlock::Unavailable(code));
}
if !announced {
progress(&format!("Waiting for Windows to release port {port}..."));
announced = true;
}
std::thread::sleep(Duration::from_millis(250));
}
Err(code) => return Err(PortBlock::Unavailable(code)),
}
}
}
fn port_error(port: u16, block: PortBlock) -> Error {
match block {
PortBlock::Owned(owners) => {
let list: Vec<String> = owners.iter().map(u32::to_string).collect();
Error::Service(
ErrorCode::PortInUse,
format!("Port {port} is already used (PID {}). Stop the other server or change Settings/repack.json.", list.join(", ")),
)
}
PortBlock::Reserved(start, end) => Error::Service(
ErrorCode::PortInUse,
format!(
"Port {port} is reserved by Windows (excluded range {start}-{end}; Hyper-V, WSL and Docker reserve such ranges). Choose another port in Settings/repack.json, or restart the Windows NAT service as administrator (net stop winnat, then net start winnat)."
),
),
PortBlock::Unavailable(code) if code == 10013 || code == 10048 => Error::Invalid(format!(
"Port {port} remains unavailable after 30 seconds (Windows bind error {code}). No process was stopped. Retry after the previous database shutdown has finished, or check the Windows port reservation."
)),
PortBlock::Unavailable(code) => Error::Invalid(format!("Port {port} cannot be checked (Windows error {code}).")),
}
}
/// [`port_block`] with up to 30 s of waiting, as an error a person can act on.
pub fn ensure_free(port: u16, progress: Progress) -> Result<()> {
port_block(port, Duration::from_secs(30), progress).map_err(|block| port_error(port, block))
}
/// The ports of this server's other services and extra worlds, which the database must not take.
fn ports_in_use_by_server(root: &Path, cfg: &Settings) -> Vec<u16> {
let mut ports = vec![cfg.auth_port, cfg.world_port, cfg.ra_port];
for tree in crate::multiworld::Tree::ALL {
let other = crate::multiworld::tree_root(root, tree);
if let Ok(other) = Settings::load(&other, 0) {
ports.extend([other.world_port, other.ra_port, other.auth_port]);
}
}
ports
}
/// Before the database starts: when its port is reserved by Windows or held by a program that is not this
/// server's MySQL, move the database to a free port and record it in `Settings/repack.json`. Only this server's
/// own services connect to MySQL (players never do), and every start renders their configs from that file, so
/// the move needs nothing else. Returns the new port, or `None` when the configured one is usable.
pub fn relocate_database_port(root: &Path, cfg: &Settings, offset: i32, progress: Progress) -> Result<Option<u16>> {
if cfg.shared_database || offset != 0 || state::running(root, "mysql").is_some() {
return Ok(None);
}
let block = match port_block(cfg.mysql_port, Duration::from_secs(30), progress) {
Ok(()) => return Ok(None),
Err(block) => block,
};
let ours = root.join("mysql/bin/mysqld.exe");
if let PortBlock::Owned(owners) = &block {
// This server's own database without a record: never start a second one on the same data.
let same = |pid: &u32| {
crate::process::identity(*pid).is_some_and(|p| same_file(Path::new(&p.exe), &ours))
};
if owners.iter().any(same) {
return Err(port_error(cfg.mysql_port, block));
}
}
let taken = ports_in_use_by_server(root, cfg);
let reserved = sys::excluded_ranges();
let candidate = (cfg.mysql_port.saturating_add(1)..=cfg.mysql_port.saturating_add(400))
.chain(33070..=33470)
.filter(|p| *p > 1024)
.find(|p| {
!taken.contains(p)
&& !reserved.iter().any(|(s, e)| (*s..=*e).contains(p))
&& port_block(*p, Duration::ZERO, &|_| {}).is_ok()
});
let Some(port) = candidate else {
return Err(port_error(cfg.mysql_port, block));
};
let reason = match &block {
PortBlock::Owned(_) => "used by another program",
PortBlock::Reserved(..) => "reserved by Windows",
PortBlock::Unavailable(_) => "unavailable",
};
let path = root.join("Settings/repack.json");
let mut raw = cfg.raw.clone();
raw.insert("mysqlPort".into(), port.into());
crate::fsx::atomic_write_json(&path, &serde_json::Value::Object(raw))?;
tracing::warn!(old = cfg.mysql_port, new = port, reason, "database moved to a free port");
progress(&format!("Port {} is {reason}; the database now uses port {port}.", cfg.mysql_port));
Ok(Some(port))
}
fn same_file(a: &Path, b: &Path) -> bool {
match (std::fs::canonicalize(a), std::fs::canonicalize(b)) {
(Ok(a), Ok(b)) => a.to_string_lossy().eq_ignore_ascii_case(&b.to_string_lossy()),
_ => false,
}
}
/// The ranges of `netsh interface ipv4 show excludedportrange protocol=tcp`: every line that starts with two
/// port numbers (the headers are translated, the numbers are not).
pub(crate) fn parse_excluded_ranges(text: &str) -> Vec<(u16, u16)> {
text.lines()
.filter_map(|line| {
let mut parts = line.split_whitespace();
let start = parts.next()?.parse::<u16>().ok()?;
let end = parts.next()?.parse::<u16>().ok()?;
(start <= end).then_some((start, end))
})
.collect()
}
/// Is the recorded process of `name` serving `port`? Its listener row is the evidence; when a system does not
/// show the owner of a listener, the server side of a fresh loopback connection is (never for MySQL, whose
/// listener has always been visible and which should not get stray connections).
pub fn ready(root: &Path, name: &str, port: u16) -> bool {
let Some(record) = state::running(root, name) else { return false };
let listening = sys::tcp_rows_v4().iter().any(|r| r.state == sys::LISTEN && r.local_port == port && r.pid == record.pid);
if listening {
return crate::process::is_alive(&record);
}
if name == "mysql" {
return false;
}
accepted_by(port, record.pid) && crate::process::is_alive(&record)
}
/// Connect to 127.0.0.1:`port` and check that exactly one established server-side row, owned by `pid`, answers
/// that connection.
fn accepted_by(port: u16, pid: u32) -> bool {
let addr: SocketAddr = ([127, 0, 0, 1], port).into();
let Ok(client) = TcpStream::connect_timeout(&addr, Duration::from_millis(500)) else { return false };
let Ok(mine) = client.local_addr().map(|a| a.port()) else { return false };
let me = std::process::id();
let rows: Vec<sys::TcpRow> = sys::tcp_rows_v4()
.into_iter()
.chain(sys::tcp_rows_v6())
.filter(|r| r.remote_port == mine && r.remote_loopback && !(r.local_port == mine && r.pid == me))
.collect();
rows.len() == 1 && rows[0].state == sys::ESTABLISHED && rows[0].pid == pid
}
pub fn wait_ready(root: &Path, name: &str, port: u16, seconds: u64) -> Result<()> {
let until = Instant::now() + Duration::from_secs(seconds);
while Instant::now() < until {
if ready(root, name, port) {
return Ok(());
}
if state::running(root, name).is_none() {
return Err(Error::Service(ErrorCode::StartupFailed, format!("{name} stopped during startup. Check its log.")));
}
std::thread::sleep(Duration::from_millis(500));
}
Err(Error::Service(
ErrorCode::StartupFailed,
format!("{name} is still starting: its expected TCP listener on port {port} was not found; check its log."),
))
}
// ---------------------------------------------------------------------------------------------------------------
// MySQL client
// ---------------------------------------------------------------------------------------------------------------
/// Run SQL (or a `mysqladmin` command) with the repack's own client and administrator login.
pub fn mysql(root: &Path, sql: Option<&str>, admin: Option<&str>) -> Result<String> {
let exe = root.join(if admin.is_some() { "mysql/bin/mysqladmin.exe" } else { "mysql/bin/mysql.exe" });
let defaults = format!("--defaults-file={}", root.join("mysql/admin-client.ini").display());
let mut cmd = Command::new(exe);
hidden(&mut cmd).arg(defaults);
match admin {
Some(a) => cmd.arg(a),
None => cmd.args(["--batch", "--skip-column-names"]),
};
let payload = sql.map(|s| s.as_bytes().to_vec());
let timeout = if payload.as_ref().is_some_and(|p| p.len() > 1024 * 1024) { 900 } else { 90 };
cmd.stdin(if payload.is_some() { Stdio::piped() } else { Stdio::null() }).stdout(Stdio::piped()).stderr(Stdio::piped());
let mut child = cmd.spawn()?;
if let (Some(data), Some(mut stdin)) = (payload, child.stdin.take()) {
std::thread::spawn(move || {
use std::io::Write;
let _ = stdin.write_all(&data);
});
}
// Both outputs are read while the client runs: a full pipe would stop it (and look like a timeout).
let read = |pipe: Option<Box<dyn std::io::Read + Send>>| {
std::thread::spawn(move || {
let mut buf = Vec::new();
if let Some(mut p) = pipe {
let _ = p.read_to_end(&mut buf);
}
buf
})
};
let out_reader = read(child.stdout.take().map(|p| Box::new(p) as Box<dyn std::io::Read + Send>));
let err_reader = read(child.stderr.take().map(|p| Box::new(p) as Box<dyn std::io::Read + Send>));
let started = Instant::now();
let failed = |stderr: &[u8]| {
let text = String::from_utf8_lossy(stderr);
let detail = text.lines().rev().find(|l| !l.trim().is_empty()).unwrap_or("").trim().to_string();
let mut message = "The repack database command failed; check mysql/logs/mysql-error.log.".to_string();
if !detail.is_empty() {
message.push_str(&format!(" ({detail})"));
}
Error::Invalid(message)
};
let status = loop {
if let Some(status) = child.try_wait()? {
break status;
}
if started.elapsed() > Duration::from_secs(timeout) {
let _ = child.kill();
let _ = child.wait();
let _ = out_reader.join();
return Err(failed(b"timed out"));
}
std::thread::sleep(Duration::from_millis(50));
};
let stdout = out_reader.join().unwrap_or_default();
let stderr = err_reader.join().unwrap_or_default();
if !status.success() {
return Err(failed(&stderr));
}
Ok(String::from_utf8_lossy(&stdout).trim().to_string())
}
// ---------------------------------------------------------------------------------------------------------------
// Start and stop
// ---------------------------------------------------------------------------------------------------------------
pub fn start_mysql(root: &Path, cfg: &Settings, progress: Progress) -> Result<()> {
if cfg.shared_database {
// An extra world uses the main folder's database; it must already run.
return mysql(root, None, Some("ping")).map(|_| ()).map_err(|e| {
Error::Service(ErrorCode::DatabaseNotRunning, format!("The main server's database is not running. {e}"))
});
}
if state::running(root, "mysql").is_some() {
wait_ready(root, "mysql", cfg.mysql_port, 300)?;
mysql(root, None, Some("ping"))?;
progress("MySQL is already running.");
return Ok(());
}
ensure_free(cfg.mysql_port, progress)?;
if !root.join("mysql/data/mysql").is_dir() {
return Err(Error::Service(ErrorCode::ServerFilesIncomplete, "The packaged database is missing. Extract the complete repack.".into()));
}
progress("Starting MySQL...");
let ini = format!("--defaults-file={}", root.join("mysql/my.ini").display());
spawn(root, "mysql", &root.join("mysql/bin/mysqld.exe"), &[&ini, "--no-monitor"], &root.join("mysql"), &root.join("mysql/logs/startup.log"), &cfg.env_remove)?;
wait_ready(root, "mysql", cfg.mysql_port, 300)?;
mysql(root, None, Some("ping"))?;
mysql(
root,
Some(&format!(
"UPDATE acore_auth.realmlist SET name={},address='127.0.0.1',localAddress='127.0.0.1',port={} WHERE id={};",
crate::realm_names::sql_literal(&cfg.realm.name), cfg.world_port, cfg.realm.id
)),
None,
)?;
Ok(())
}
pub fn start_auth(root: &Path, cfg: &Settings, progress: Progress) -> Result<()> {
start_mysql(root, cfg, progress)?;
if state::running(root, "auth").is_some() {
wait_ready(root, "auth", cfg.auth_port, 60)?;
progress("Authserver is already running.");
return Ok(());
}
ensure_free(cfg.auth_port, progress)?;
// An interrupted world startup can leave flag 3, which authserver excludes.
mysql(root, Some(&format!("UPDATE acore_auth.realmlist SET flag=0 WHERE id={};", cfg.realm.id)), None)?;
progress("Starting authserver...");
spawn(root, "auth", &root.join("Core/authserver.exe"), &["-c", "configs/authserver.conf"], &root.join("Core"), &root.join("Core/Logs/auth-console.log"), &cfg.env_remove)?;
wait_ready(root, "auth", cfg.auth_port, 60)
}
/// Stop the recorded process, only if it is still that process.
pub fn terminate(record: &ProcessIdentity) -> Result<()> {
if !crate::process::is_alive(record) {
return Ok(());
}
sys::terminate(record)
}
pub fn wait_stopped(record: &ProcessIdentity, seconds: u64) -> bool {
let until = Instant::now() + Duration::from_secs(seconds);
while crate::process::is_alive(record) && Instant::now() < until {
std::thread::sleep(Duration::from_millis(250));
}
!crate::process::is_alive(record)
}
/// The recorded world, when it is this folder's own `Core/worldserver.exe` (never stop a process only because a
/// record names it).
fn owned_world(root: &Path) -> Result<Option<ProcessIdentity>> {
let Some(world) = state::running(root, "world") else { return Ok(None) };
let expected = root.join("Core/worldserver.exe");
let same = std::fs::canonicalize(&world.exe).ok().zip(std::fs::canonicalize(&expected).ok()).is_some_and(|(a, b)| a == b);
if !same {
return Err(Error::Invalid("World process ownership could not be verified; the database was left running.".into()));
}
Ok(Some(world))
}
/// Ask the world's console for a graceful shutdown. False when the console is not this world's or does not answer.
fn ask_shutdown(root: &Path, cfg: &Settings) -> bool {
ready(root, "world", cfg.ra_port)
&& crate::ra::Ra::connect_to(cfg.ra_port, &cfg.ra_username, &cfg.ra_password)
.and_then(|ra| ra.send_without_answer("server shutdown 1s 0"))
.is_ok()
}
/// Stop this folder's world without its console (unsaved progress since the last save is lost).
fn stop_world_process(world: &ProcessIdentity) -> Result<()> {
terminate(world).map_err(|_| Error::Invalid("Worldserver could not be stopped safely; its database was left running.".into()))?;
if !wait_stopped(world, 90) {
return Err(Error::Invalid("Worldserver is still stopping; its database was left running.".into()));
}
Ok(())
}
/// Stop the world at once, then everything else as [`stop_all`] does. Only when the user asked for it.
pub fn force_stop_all(root: &Path, cfg: &Settings, progress: Progress) -> Result<()> {
if let Some(world) = owned_world(root)? {
stop_world_process(&world)?;
progress("Force-stopped this server's verified world process; unsaved progress may be lost.");
}
stop_all(root, cfg, progress)
}
/// Stop everything of this repack, world first (gracefully through its console), its database last. An extra
/// world leaves the shared database alone.
pub fn stop_all(root: &Path, cfg: &Settings, progress: Progress) -> Result<()> {
if let Some(world) = owned_world(root)? {
if ask_shutdown(root, cfg) {
progress("Graceful world shutdown requested.");
} else {
progress("World console unavailable; stopping this repack's recorded world process.");
stop_world_process(&world)?;
}
// A console request can be lost (seen when a client disconnected at once). While the world still runs
// and its console still answers, it has not begun to stop: ask again. Asking twice is harmless.
let mut stopped = wait_stopped(&world, 15);
for _ in 0..2 {
if stopped {
break;
}
if ask_shutdown(root, cfg) {
progress("The world has not begun to stop; shutdown requested again.");
}
stopped = wait_stopped(&world, 15);
}
if !stopped && !wait_stopped(&world, 45) {
return Err(Error::Invalid("Worldserver is still stopping; its database has been left running.".into()));
}
}
if let Some(supervisor) = state::running(root, "supervisor") {
if !wait_stopped(&supervisor, 45) {
return Err(Error::Invalid("The report relay is still finishing a request. Try Stop All again shortly.".into()));
}
}
if let Some(relay) = state::running(root, "relay") {
std::fs::write(state::dir(root).join("stop-relay"), b"")?;
if !wait_stopped(&relay, 40) {
return Err(Error::Invalid("The report relay did not finish; it was left running for recovery.".into()));
}
}
if let Some(auth) = state::running(root, "auth") {
terminate(&auth)?;
if !wait_stopped(&auth, 10) {
return Err(Error::Invalid("Authserver did not stop.".into()));
}
}
if let Some(database) = state::running(root, "mysql").filter(|_| !cfg.shared_database) {
let shutdown = mysql(root, None, Some("shutdown"));
if !wait_stopped(&database, 60) {
shutdown?;
return Err(Error::Invalid("MySQL is still stopping; wait before copying the repack.".into()));
}
}
progress("All services from this repack are stopped. It is safe to move or copy this folder.");
Ok(())
}
/// Which services run (`manage.py status-json`).
pub fn status(root: &Path) -> serde_json::Value {
let mut out = serde_json::Map::new();
for name in ["mysql", "auth", "world", "relay"] {
out.insert(name.into(), state::running(root, name).is_some().into());
}
let debug: bool = crate::fsx::read_json::<serde_json::Value>(&state::dir(root).join("debug-logs.json"))
.ok()
.and_then(|v| v.get("enabled").and_then(|e| e.as_bool()))
.unwrap_or(false);
out.insert("debugLogs".into(), debug.into());
serde_json::Value::Object(out)
}
pub fn log_path(root: &Path, name: &str) -> PathBuf {
match name {
"mysql" => root.join("mysql/logs/startup.log"),
"auth" => root.join("Core/Logs/auth-console.log"),
"world" => root.join("Core/Logs/world-console.log"),
"supervisor" => root.join("Core/Logs/supervisor.log"),
_ => root.join("BugReport/Logs/relay.log"),
}
}
// ---------------------------------------------------------------------------------------------------------------
// Windows
// ---------------------------------------------------------------------------------------------------------------
#[cfg(windows)]
mod sys {
use crate::error::{Error, Result};
use crate::process::ProcessIdentity;
use windows_sys::Win32::Foundation::CloseHandle;
use windows_sys::Win32::NetworkManagement::IpHelper::GetExtendedTcpTable;
use windows_sys::Win32::Networking::WinSock::{setsockopt, SOL_SOCKET, SO_EXCLUSIVEADDRUSE};
use windows_sys::Win32::System::Threading::{OpenProcess, TerminateProcess, PROCESS_QUERY_LIMITED_INFORMATION, PROCESS_TERMINATE};
pub const LISTEN: u32 = 2;
pub const ESTABLISHED: u32 = 5;
pub struct TcpRow {
pub state: u32,
pub local_port: u16,
pub remote_port: u16,
pub remote_loopback: bool,
pub pid: u32,
}
fn table(af: u32) -> Vec<u8> {
const TCP_TABLE_OWNER_PID_ALL: i32 = 5;
let mut size = 0u32;
let mut buf: Vec<u8> = Vec::new();
for _ in 0..4 {
let code = unsafe {
GetExtendedTcpTable(
if buf.is_empty() { std::ptr::null_mut() } else { buf.as_mut_ptr().cast() },
&mut size,
0,
af,
TCP_TABLE_OWNER_PID_ALL,
0,
)
};
match code {
0 if !buf.is_empty() => return buf,
0 | 122 => buf = vec![0u8; size as usize + 4096],
_ => return Vec::new(),
}
}
Vec::new()
}
fn u32_at(b: &[u8], o: usize) -> u32 {
u32::from_le_bytes(b[o..o + 4].try_into().unwrap())
}
pub fn tcp_rows_v4() -> Vec<TcpRow> {
let b = table(2);
let mut out = Vec::new();
if b.len() < 4 {
return out;
}
for i in 0..u32_at(&b, 0) as usize {
let o = 4 + 24 * i;
if o + 24 > b.len() {
break;
}
let remote = u32_at(&b, o + 12).to_le_bytes();
out.push(TcpRow {
state: u32_at(&b, o),
local_port: u16::from_be((u32_at(&b, o + 8) & 0xFFFF) as u16),
remote_port: u16::from_be((u32_at(&b, o + 16) & 0xFFFF) as u16),
remote_loopback: remote == [127, 0, 0, 1],
pid: u32_at(&b, o + 20),
});
}
out
}
pub fn tcp_rows_v6() -> Vec<TcpRow> {
let b = table(23);
let mut out = Vec::new();
if b.len() < 4 {
return out;
}
// MIB_TCP6ROW_OWNER_PID: local addr 16, scope 4, local port 4, remote addr 16, scope 4, remote port 4, state 4, pid 4
for i in 0..u32_at(&b, 0) as usize {
let o = 4 + 56 * i;
if o + 56 > b.len() {
break;
}
let remote = &b[o + 24..o + 40];
let mapped_loopback = remote[..10].iter().all(|x| *x == 0) && remote[10] == 0xff && remote[11] == 0xff && remote[12..] == [127, 0, 0, 1];
out.push(TcpRow {
state: u32_at(&b, o + 48),
local_port: u16::from_be((u32_at(&b, o + 20) & 0xFFFF) as u16),
remote_port: u16::from_be((u32_at(&b, o + 44) & 0xFFFF) as u16),
remote_loopback: mapped_loopback,
pid: u32_at(&b, o + 52),
});
}
out
}
/// Bind 0.0.0.0:port exclusively and release it. Err carries the Windows socket error.
/// Windows' excluded TCP port ranges, read with the system's own netsh (never one from PATH or the server).
pub fn excluded_ranges() -> Vec<(u16, u16)> {
use std::os::windows::process::CommandExt;
let mut directory = vec![0u16; 32768];
let length = unsafe {
windows_sys::Win32::System::SystemInformation::GetSystemDirectoryW(directory.as_mut_ptr(), directory.len() as u32)
} as usize;
if length == 0 || length >= directory.len() {
return Vec::new();
}
let netsh = std::path::PathBuf::from(String::from_utf16_lossy(&directory[..length])).join("netsh.exe");
let output = std::process::Command::new(netsh)
.args(["interface", "ipv4", "show", "excludedportrange", "protocol=tcp"])
.stdin(std::process::Stdio::null())
.stderr(std::process::Stdio::null())
.creation_flags(super::CREATE_NO_WINDOW)
.output();
match output {
Ok(out) if out.status.success() => super::parse_excluded_ranges(&String::from_utf8_lossy(&out.stdout)),
_ => Vec::new(),
}
}
pub fn exclusive_bind(port: u16) -> std::result::Result<(), i32> {
use socket2::{Domain, Socket, Type};
use std::os::windows::io::AsRawSocket;
let socket = Socket::new(Domain::IPV4, Type::STREAM, None).map_err(|e| e.raw_os_error().unwrap_or(-1))?;
let one: i32 = 1;
let set = unsafe {
setsockopt(socket.as_raw_socket() as _, SOL_SOCKET, SO_EXCLUSIVEADDRUSE, (&one as *const i32).cast(), 4)
};
if set != 0 {
return Err(std::io::Error::last_os_error().raw_os_error().unwrap_or(-1));
}
let addr: std::net::SocketAddr = ([0, 0, 0, 0], port).into();
socket.bind(&addr.into()).map_err(|e| e.raw_os_error().unwrap_or(-1))
}
pub fn terminate(record: &ProcessIdentity) -> Result<()> {
unsafe {
let h = OpenProcess(PROCESS_TERMINATE | PROCESS_QUERY_LIMITED_INFORMATION, 0, record.pid);
if h.is_null() {
return Err(Error::Invalid("Unable to stop the repack process.".into()));
}
let same = crate::process::is_alive(record);
let ok = same && TerminateProcess(h, 0) != 0;
CloseHandle(h);
if !ok {
return Err(Error::Invalid("The process changed while stopping it.".into()));
}
}
Ok(())
}
}
#[cfg(not(windows))]
mod sys {
use crate::error::{Error, Result};
use crate::process::ProcessIdentity;
pub const LISTEN: u32 = 2;
pub const ESTABLISHED: u32 = 5;
pub struct TcpRow {
pub state: u32,
pub local_port: u16,
pub remote_port: u16,
pub remote_loopback: bool,
pub pid: u32,
}
pub fn tcp_rows_v4() -> Vec<TcpRow> {
Vec::new()
}
pub fn tcp_rows_v6() -> Vec<TcpRow> {
Vec::new()
}
pub fn exclusive_bind(_: u16) -> std::result::Result<(), i32> {
Ok(())
}
pub fn excluded_ranges() -> Vec<(u16, u16)> {
Vec::new()
}
pub fn terminate(_: &ProcessIdentity) -> Result<()> {
Err(Error::Invalid("not supported".into()))
}
}
#[cfg(test)]
mod tests {
use super::*;
#[test]
fn excluded_ranges_are_read_from_translated_netsh_output() {
let english = "\r\nProtocol tcp Port Exclusion Ranges\r\n\r\nStart Port End Port\r\n---------- --------\r\n 3250 3349\r\n 50000 50059 *\r\n\r\n* - Administered port exclusions.\r\n";
assert_eq!(parse_excluded_ranges(english), vec![(3250, 3349), (50000, 50059)]);
let russian = "\r\nПротокол tcp Диапазоны исключения портов\r\n\r\nНачальный порт Конечный порт\r\n---------- --------\r\n 50000 50059 *\r\n\r\n* — управляемые исключения портов.\r\n";
assert_eq!(parse_excluded_ranges(russian), vec![(50000, 50059)]);
assert!(parse_excluded_ranges("").is_empty());
}
fn repack(dir: &Path, mysql: u16) {
std::fs::create_dir_all(dir.join("Settings")).unwrap();
std::fs::write(
dir.join("Settings/repack.json"),
format!(r#"{{"mysqlPort":{mysql},"authPort":3724,"worldPort":8085,"raPort":3443,"raUsername":"U","raPassword":"P"}}"#),
)
.unwrap();
}
#[test]
fn a_taken_database_port_moves_to_a_free_one_and_is_recorded() {
let d = tempfile::tempdir().unwrap();
let held = std::net::TcpListener::bind("0.0.0.0:0").unwrap();
let port = held.local_addr().unwrap().port();
repack(d.path(), port);
let cfg = Settings::load(d.path(), 0).unwrap();
let said = std::cell::RefCell::new(Vec::new());
let moved = relocate_database_port(d.path(), &cfg, 0, &|line| said.borrow_mut().push(line.to_string()))
.unwrap()
.expect("moved");
assert_ne!(moved, port);
let again = Settings::load(d.path(), 0).unwrap();
assert_eq!(again.mysql_port, moved);
assert_eq!((again.auth_port, again.ra_username.as_str()), (3724, "U"), "other keys are kept");
assert!(said.borrow().iter().any(|l| l.contains("used by another program")), "{said:?}");
// The new port is usable: nothing moves on the next start.
assert_eq!(relocate_database_port(d.path(), &again, 0, &|_| {}).unwrap(), None);
}
#[test]
fn extra_worlds_and_shifted_test_ports_never_move_the_database() {
let d = tempfile::tempdir().unwrap();
let held = std::net::TcpListener::bind("0.0.0.0:0").unwrap();
let port = held.local_addr().unwrap().port();
repack(d.path(), port);
let cfg = Settings::load(d.path(), 0).unwrap();
let shared = Settings { shared_database: true, ..cfg.clone() };
assert_eq!(relocate_database_port(d.path(), &shared, 0, &|_| {}).unwrap(), None);
assert_eq!(relocate_database_port(d.path(), &cfg, 5, &|_| {}).unwrap(), None);
assert_eq!(Settings::load(d.path(), 0).unwrap().mysql_port, port);
}
#[test]
fn a_port_with_a_listener_is_refused_and_a_free_one_passes() {
let held = std::net::TcpListener::bind("0.0.0.0:0").unwrap();
let port = held.local_addr().unwrap().port();
let err = ensure_free(port, &|_| {}).unwrap_err().to_string();
assert!(err.contains(&format!("Port {port} is already used (PID {}", std::process::id())), "{err}");
drop(held);
ensure_free(port, &|_| {}).unwrap();
}
#[test]
fn a_service_is_ready_only_on_its_own_port() {
let d = tempfile::tempdir().unwrap();
let held = std::net::TcpListener::bind("127.0.0.1:0").unwrap();
let port = held.local_addr().unwrap().port();
assert!(!ready(d.path(), "auth", port), "no record yet");
state::record(d.path(), "auth", std::process::id()).unwrap();
assert!(ready(d.path(), "auth", port));
// A port nobody listens on now (port + 1 may belong to a test running in parallel in this process).
let other = std::net::TcpListener::bind("127.0.0.1:0").unwrap();
let free = other.local_addr().unwrap().port();
drop(other);
assert!(!ready(d.path(), "auth", free));
}
#[test]
fn status_reads_the_records() {
let d = tempfile::tempdir().unwrap();
state::record(d.path(), "mysql", std::process::id()).unwrap();
let s = status(d.path());
assert_eq!(s["mysql"], true);
assert_eq!(s["world"], false);
assert_eq!(s["debugLogs"], false);
}
}
+172
View File
@@ -0,0 +1,172 @@
//! `Settings/repack.json`: ports and the console login of one repack (`manage.py settings()`).
use std::path::Path;
use crate::error::{Error, Result};
pub const PORT_KEYS: [&str; 4] = ["mysqlPort", "authPort", "worldPort", "raPort"];
/// The realm a folder runs: its row in `acore_auth.realmlist` and its two game databases.
///
/// Without `Settings/realm-profile.json` this is what the repack launcher always did (realm 1 "AzerothCore" on
/// `acore_world`/`acore_characters`). With it, the active profile decides, as the Manager's realm patch of
/// `manage.py` did.
#[derive(Debug, Clone, PartialEq, Eq)]
pub struct Realm {
pub id: u32,
pub name: String,
pub world_db: &'static str,
pub characters_db: &'static str,
}
impl Realm {
pub fn load(root: &Path) -> Result<Realm> {
let path = root.join("Settings/realm-profile.json");
let (id, name, world_db, characters_db) = if !path.exists() {
(1, "AzerothCore", "acore_world", "acore_characters")
} else {
let v: serde_json::Value = crate::fsx::read_json(&path)?;
match v.get("active").and_then(|a| a.as_str()).unwrap_or("coa") {
"wildcard" => (2, "Wildcard", "acore_world_wildcard", "acore_characters_wildcard"),
"reborn" => (3, "Warcraft Reborn", "acore_world_reborn", "acore_characters_reborn"),
_ => (1, "Conquest of Azeroth", "acore_world", "acore_characters"),
}
};
// The owner's own name for this realm, when one was chosen in the Manager.
let name = crate::realm_names::name_or(root, id, name);
Ok(Realm { id, name, world_db, characters_db })
}
}
/// An extra world of a server (`<server>/.realms/<name>`): it shares the main folder's database and never
/// starts or stops it.
pub fn is_extra_world(root: &Path) -> bool {
root.parent().and_then(|p| p.file_name()).is_some_and(|n| n == ".realms")
}
#[derive(Debug, Clone, PartialEq, Eq)]
pub struct Settings {
pub mysql_port: u16,
pub auth_port: u16,
pub world_port: u16,
pub ra_port: u16,
pub ra_username: String,
pub ra_password: String,
pub realm: Realm,
/// The database belongs to the main folder of this server (an extra world): it is only checked, never
/// started.
pub shared_database: bool,
/// Environment variables the started services must not see (for example a port override of the caller).
pub env_remove: Vec<String>,
/// The whole document, for keys this code does not know (kept when it is written back).
pub raw: serde_json::Map<String, serde_json::Value>,
}
impl Settings {
/// Read `Settings/repack.json`, with every port moved by `offset` (a second world of the same server runs on
/// shifted ports). The same checks as `manage.py`: integer ports in 1025..65535 after the offset, all
/// different.
pub fn load(root: &Path, offset: i32) -> Result<Settings> {
let bytes = std::fs::read(root.join("Settings/repack.json"))?;
let text = String::from_utf8_lossy(&bytes);
let text = text.strip_prefix('\u{feff}').unwrap_or(&text);
let raw: serde_json::Map<String, serde_json::Value> =
serde_json::from_str(text).map_err(|e| Error::Invalid(format!("Settings/repack.json: {e}")))?;
let mut ports = [0u16; 4];
for (i, key) in PORT_KEYS.iter().enumerate() {
// Python's `type(value) is not int` refuses booleans and floats alike.
let value = raw.get(*key).and_then(|v| v.as_i64()).filter(|_| raw[*key].is_i64() || raw[*key].is_u64());
let shifted = value.map(|v| v + i64::from(offset));
match shifted {
Some(p) if p > 1024 && p < 65536 => ports[i] = p as u16,
_ => return Err(Error::Service(crate::error::ErrorCode::InvalidConfigValue, "Invalid port in Settings/repack.json".into())),
}
}
let mut unique = ports.to_vec();
unique.sort_unstable();
unique.dedup();
if unique.len() != 4 {
return Err(Error::Invalid("Each service needs a different port.".into()));
}
let text_of = |k: &str| raw.get(k).and_then(|v| v.as_str()).unwrap_or_default().to_string();
Ok(Settings {
mysql_port: ports[0],
auth_port: ports[1],
world_port: ports[2],
ra_port: ports[3],
ra_username: text_of("raUsername"),
ra_password: text_of("raPassword"),
realm: Realm::load(root)?,
shared_database: is_extra_world(root),
env_remove: Vec::new(),
raw,
})
}
/// `{"mysqlPort": .., "authPort": .., "worldPort": .., "raPort": ..}` as `manage.py` records it in
/// `.state/configuration.json` (the keys of repack.json ending in "Port", in the file's order).
pub fn port_map(&self) -> serde_json::Map<String, serde_json::Value> {
let shifted = [self.mysql_port, self.auth_port, self.world_port, self.ra_port];
let mut out = serde_json::Map::new();
for key in self.raw.keys().filter(|k| k.ends_with("Port")) {
let value = PORT_KEYS
.iter()
.position(|p| p == key)
.map(|i| serde_json::Value::from(shifted[i]))
.unwrap_or_else(|| self.raw[key].clone());
out.insert(key.clone(), value);
}
out
}
}
#[cfg(test)]
mod tests {
use super::*;
fn write(dir: &Path, text: &str) {
std::fs::create_dir_all(dir.join("Settings")).unwrap();
std::fs::write(dir.join("Settings/repack.json"), text).unwrap();
}
#[test]
fn ports_are_checked_like_the_python_launcher() {
let d = tempfile::tempdir().unwrap();
write(d.path(), r#"{"mysqlPort":3307,"authPort":3724,"worldPort":8085,"raPort":3443,"raUsername":"U","raPassword":"P"}"#);
let s = Settings::load(d.path(), 0).unwrap();
assert_eq!((s.mysql_port, s.auth_port, s.world_port, s.ra_port), (3307, 3724, 8085, 3443));
assert_eq!(s.ra_username, "U");
let shifted = Settings::load(d.path(), 10).unwrap();
assert_eq!(shifted.world_port, 8095);
assert_eq!(shifted.port_map()["worldPort"], serde_json::json!(8095));
for bad in [
r#"{"mysqlPort":1024,"authPort":3724,"worldPort":8085,"raPort":3443}"#,
r#"{"mysqlPort":"3307","authPort":3724,"worldPort":8085,"raPort":3443}"#,
r#"{"mysqlPort":3307.0,"authPort":3724,"worldPort":8085,"raPort":3443}"#,
r#"{"mysqlPort":true,"authPort":3724,"worldPort":8085,"raPort":3443}"#,
r#"{"mysqlPort":3307,"authPort":3307,"worldPort":8085,"raPort":3443}"#,
r#"{"authPort":3724,"worldPort":8085,"raPort":3443}"#,
] {
write(d.path(), bad);
assert!(Settings::load(d.path(), 0).is_err(), "{bad}");
}
write(d.path(), "\u{feff}{\"mysqlPort\":3307,\"authPort\":3724,\"worldPort\":8085,\"raPort\":65535}");
assert!(Settings::load(d.path(), 1).is_err(), "65536 after the offset");
assert!(Settings::load(d.path(), 0).is_ok(), "a byte order mark is accepted");
}
#[test]
fn the_realm_follows_the_active_profile() {
let d = tempfile::tempdir().unwrap();
assert_eq!(Realm::load(d.path()).unwrap().name, "AzerothCore");
std::fs::create_dir_all(d.path().join("Settings")).unwrap();
for (active, id, db) in [("coa", 1, "acore_world"), ("wildcard", 2, "acore_world_wildcard"), ("reborn", 3, "acore_world_reborn")] {
std::fs::write(d.path().join("Settings/realm-profile.json"), format!("{{\"active\":\"{active}\"}}")).unwrap();
let r = Realm::load(d.path()).unwrap();
assert_eq!((r.id, r.world_db), (id, db));
}
assert!(is_extra_world(&d.path().join(".realms/secondary")));
assert!(!is_extra_world(d.path()));
}
}
Binary file not shown.
+398
View File
@@ -0,0 +1,398 @@
//! SQUID Playerbots on a repack (`Scripts/squid_playerbots.py`): the bot modules must not both run, how long a
//! SQUID world may take to start, and its database, provisioned before the world starts.
//!
//! The SQL journals are the ones the Python script keeps, unchanged: `coa_squid_migrations(path, sha256)` and
//! `coa_squid_pending(path, sha256)` in every target schema, and the SQUID installer's `coa_bots_installed`.
use std::collections::{BTreeMap, BTreeSet};
use std::path::{Path, PathBuf};
use sha1::Digest as _;
use crate::error::{Error, Result};
/// `key = value` lines of a module config (comments and quotes dropped), as `options()` reads them.
pub fn options(path: &Path) -> BTreeMap<String, String> {
let mut out = BTreeMap::new();
let Ok(bytes) = std::fs::read(path) else { return out };
let text = String::from_utf8_lossy(&bytes);
let text = text.strip_prefix('\u{feff}').unwrap_or(&text);
for line in text.lines() {
let line = line.trim_start();
let Some((key, rest)) = line.split_once('=') else { continue };
let key = key.trim_end();
if key.is_empty() || key.starts_with('#') || key.contains(char::is_whitespace) {
continue;
}
let value = rest.split('#').next().unwrap_or("").trim();
out.insert(key.to_string(), value.trim_matches('"').to_string());
}
out
}
/// A secondary world shares the primary's package files.
pub fn package_root(root: &Path) -> PathBuf {
let secondary = root.file_name().is_some_and(|n| n == "secondary")
&& root.parent().and_then(|p| p.file_name()).is_some_and(|n| n == ".realms");
if secondary {
root.parent().and_then(Path::parent).map(Path::to_path_buf).unwrap_or_else(|| root.to_path_buf())
} else {
root.to_path_buf()
}
}
pub fn module_options(root: &Path, name: &str) -> (PathBuf, BTreeMap<String, String>) {
let folder = root.join("Core/configs/modules");
let active = folder.join(name);
let mut path = if active.exists() { active } else { folder.join(format!("{name}.dist")) };
if !path.exists() && name == "playerbots.conf" {
path = package_root(root).join("Core/configs/modules/playerbots.conf.dist");
}
let values = options(&path);
(path, values)
}
/// Invalid booleans count as the modules' compiled default: enabled.
pub fn enabled(values: &BTreeMap<String, String>, key: &str) -> bool {
!matches!(values.get(key).map(|v| v.to_ascii_lowercase()).as_deref(), Some("0" | "false" | "no" | "off"))
}
pub fn validate_bots(root: &Path) -> Result<()> {
let (a, av) = module_options(root, "mod_coa_playerbots.conf");
let (b, bv) = module_options(root, "playerbots.conf");
if a.exists() && b.exists() && enabled(&av, "CoaBots.Enable") && enabled(&bv, "AiPlayerbot.Enabled") {
return Err(Error::Invalid(
"CoA Companions and SQUID Playerbots cannot both be enabled. Disable one bot module in Modules or its config.".into(),
));
}
Ok(())
}
/// Seconds a world may take to open its port: SQUID loads its bots first.
pub fn startup_timeout(root: &Path) -> u64 {
let (path, values) = module_options(root, "playerbots.conf");
if path.exists() && enabled(&values, "AiPlayerbot.Enabled") {
1500
} else {
180
}
}
/// Replace (or append) `key = value` lines; the file is written with "\n" line ends.
pub fn set_options(path: &Path, values: &[(&str, String)]) -> Result<()> {
let bytes = std::fs::read(path)?;
let text = String::from_utf8_lossy(&bytes);
let mut text = text.strip_prefix('\u{feff}').unwrap_or(&text).replace("\r\n", "\n");
for (key, value) in values {
let line = format!("{key} = {value}");
let mut found = false;
let lines: Vec<String> = text
.split('\n')
.map(|l| {
let t = l.trim_start();
let matches = t.strip_prefix(key).is_some_and(|rest| rest.trim_start().starts_with('='));
if matches {
found = true;
line.clone()
} else {
l.to_string()
}
})
.collect();
text = lines.join("\n");
if !found {
text.push('\n');
text.push_str(&line);
text.push('\n');
}
}
crate::fsx::atomic_write(path, text.as_bytes())
}
fn valid_relative(rel: &str) -> bool {
!rel.is_empty() && rel.bytes().all(|b| b.is_ascii_alphanumeric() || matches!(b, b'_' | b'.' | b'/' | b'-'))
}
/// Table names a base file creates (`CREATE TABLE [IF NOT EXISTS] name`).
fn created_tables(sql: &str) -> BTreeSet<String> {
let mut out = BTreeSet::new();
let upper = sql.to_ascii_uppercase();
let mut from = 0;
while let Some(i) = upper[from..].find("CREATE") {
let start = from + i + "CREATE".len();
from = start;
let rest = &sql[start..];
let mut words = rest.split_whitespace();
if !words.next().is_some_and(|w| w.eq_ignore_ascii_case("TABLE")) {
continue;
}
let mut name = words.next().unwrap_or("");
if name.eq_ignore_ascii_case("IF") {
let _ = words.next(); // NOT
let _ = words.next(); // EXISTS
name = words.next().unwrap_or("");
}
let name: String = name.trim_start_matches('`').chars().take_while(|c| c.is_ascii_alphanumeric() || *c == '_').collect();
if !name.is_empty() {
out.insert(name);
}
}
out
}
fn sha256_hex(bytes: &[u8]) -> String {
crate::fsx::sha256_bytes(bytes)
}
fn sha1_hex(bytes: &[u8]) -> String {
let mut h = sha1::Sha1::new();
h.update(bytes);
h.finalize().iter().map(|b| format!("{b:02x}")).collect()
}
fn rows(text: &str) -> Vec<(String, String)> {
text.lines().filter_map(|r| r.split_once('\t')).map(|(a, b)| (a.to_string(), b.to_string())).collect()
}
/// Provision an enabled SQUID without replaying imported base tables (`prepare_playerbots`). `mysql(sql)` runs
/// SQL with the repack's administrator login and returns its output.
pub fn prepare_playerbots(root: &Path, mysql_port: u16, mysql: &dyn Fn(&str) -> Result<String>, progress: &dyn Fn(&str)) -> Result<()> {
let (mut path, values) = module_options(root, "playerbots.conf");
if !path.exists() || !enabled(&values, "AiPlayerbot.Enabled") {
return Ok(());
}
validate_bots(root)?;
let sql_root = package_root(root).join("Extras/SquidPlayerbots/sql");
if !sql_root.join("playerbots/base").is_dir() {
return Err(Error::Invalid("SQUID Playerbots database files are missing. Repair the server installation.".into()));
}
let world = options(&root.join("Core/configs/worldserver.conf"));
let mut schemas: Vec<(&str, String)> = Vec::new();
for (kind, key) in [("characters", "CharacterDatabaseInfo"), ("world", "WorldDatabaseInfo")] {
let schema = world.get(key).and_then(|v| v.rsplit(';').next()).unwrap_or("").to_string();
let ok = matches!(schema.as_str(), "acore_world" | "acore_characters" | "acore_world_wildcard" | "acore_characters_wildcard");
if !ok {
return Err(Error::Invalid("Unsupported world/characters database for SQUID Playerbots.".into()));
}
schemas.push((kind, schema));
}
schemas.push(("playerbots", "acore_playerbots".into()));
let list = |schema: &str| -> Result<BTreeSet<String>> {
Ok(mysql(&format!("SELECT TABLE_NAME FROM information_schema.TABLES WHERE TABLE_SCHEMA='{schema}';"))?
.lines()
.map(str::to_string)
.collect())
};
let existing_playerbots = list("acore_playerbots")?;
let bookkeeping = ["updates", "updates_include", "version_db_playerbots", "coa_squid_migrations", "coa_bots_installed", "coa_squid_pending"];
let data_tables: Vec<&String> = existing_playerbots.iter().filter(|t| !bookkeeping.contains(&t.as_str())).collect();
let mut installer_history = BTreeSet::new();
if existing_playerbots.contains("coa_bots_installed") {
for name in mysql("SELECT file FROM `acore_playerbots`.coa_bots_installed;")?.lines() {
let mut n = name.replace('\\', "/");
while n.contains("//") {
n = n.replace("//", "/");
}
let n = n.trim_matches('/').to_string();
if n.to_ascii_lowercase().ends_with(".sql") {
installer_history.insert(n);
}
}
}
let mut tables: BTreeMap<&str, BTreeSet<String>> = BTreeMap::new();
let mut histories: BTreeMap<&str, BTreeMap<String, String>> = BTreeMap::new();
let mut ledgers: BTreeMap<&str, BTreeMap<String, String>> = BTreeMap::new();
for (kind, schema) in &schemas {
let t = if *kind == "playerbots" { existing_playerbots.clone() } else { list(schema)? };
if t.contains("coa_squid_pending") {
let pending = mysql(&format!("SELECT path FROM `{schema}`.coa_squid_pending;"))?;
let pending = pending.trim();
if !pending.is_empty() {
return Err(Error::Invalid(format!(
"A SQUID base import was interrupted. Restore the database backup or repair the incomplete import before continuing; no SQL was applied: {pending}"
)));
}
}
let mut history = BTreeMap::new();
if t.contains("updates") {
for (name, digest) in rows(&mysql(&format!("SELECT name,hash FROM `{schema}`.updates;"))?) {
history.insert(name, digest.to_ascii_lowercase());
}
}
let mut ledger = BTreeMap::new();
if t.contains("coa_squid_migrations") {
for (name, digest) in rows(&mysql(&format!("SELECT path,sha256 FROM `{schema}`.coa_squid_migrations;"))?) {
ledger.insert(name, digest);
}
}
tables.insert(kind, t);
histories.insert(kind, history);
ledgers.insert(kind, ledger);
}
if !data_tables.is_empty() && installer_history.is_empty() && histories["playerbots"].is_empty() && ledgers["playerbots"].is_empty() {
for table in data_tables {
let quoted = table.replace('`', "``");
if mysql(&format!("SELECT EXISTS(SELECT 1 FROM `acore_playerbots`.`{quoted}` LIMIT 1);"))?.trim() == "1" {
return Err(Error::Invalid(
"Existing SQUID data has no recorded installation history. Repair the imported database history before continuing; no SQL was applied.".into(),
));
}
}
}
mysql("CREATE DATABASE IF NOT EXISTS acore_playerbots CHARACTER SET utf8mb4 COLLATE utf8mb4_unicode_ci;")?;
for host in ["localhost", "127.0.0.1"] {
mysql(&format!("GRANT ALL PRIVILEGES ON acore_playerbots.* TO 'acore'@'{host}';"))?;
}
let (_, password) = crate::db::credentials(root)?;
if password.len() != 48 || !password.bytes().all(|b| b.is_ascii_digit() || (b'a'..=b'f').contains(&b)) {
return Err(Error::Invalid("Invalid packaged database configuration.".into()));
}
if path.file_name().is_some_and(|n| n.to_string_lossy().ends_with(".dist")) {
let active = root.join("Core/configs/modules/playerbots.conf");
std::fs::create_dir_all(active.parent().unwrap())?;
std::fs::write(&active, std::fs::read(&path)?)?;
path = active;
}
set_options(
&path,
&[
("PlayerbotsDatabaseInfo", format!("\"127.0.0.1;{mysql_port};acore;{password};acore_playerbots\"")),
("Playerbots.Updates.EnableDatabases", "0".into()),
],
)?;
for (kind, schema) in &schemas {
mysql(&format!("CREATE TABLE IF NOT EXISTS `{schema}`.coa_squid_migrations (path VARCHAR(240) PRIMARY KEY, sha256 CHAR(64) NOT NULL);"))?;
mysql(&format!("CREATE TABLE IF NOT EXISTS `{schema}`.coa_squid_pending (path VARCHAR(240) PRIMARY KEY, sha256 CHAR(64) NOT NULL);"))?;
let history = &histories[kind];
let recorded = ledgers[kind].clone();
for stage in ["base", "updates", "custom"] {
let mut sources: Vec<PathBuf> = std::fs::read_dir(sql_root.join(kind).join(stage))
.map(|rd| rd.flatten().map(|e| e.path()).filter(|p| p.extension().is_some_and(|e| e == "sql")).collect())
.unwrap_or_default();
sources.sort();
for source in sources {
let relative = source.strip_prefix(&sql_root).unwrap_or(&source).to_string_lossy().replace('\\', "/");
if !valid_relative(&relative) {
return Err(Error::Invalid("Invalid SQUID SQL filename.".into()));
}
let bytes = std::fs::read(&source)?;
let digest = sha256_hex(&bytes);
if let Some(previous) = recorded.get(&relative) {
if *previous != digest {
return Err(Error::Invalid(format!("A previously applied SQUID database migration changed: {relative}")));
}
if stage != "base" {
continue;
}
}
let ledger_sql = if recorded.contains_key(&relative) {
String::new()
} else {
format!("INSERT INTO `{schema}`.coa_squid_migrations VALUES ('{relative}','{digest}');")
};
let text = String::from_utf8_lossy(&bytes);
let text = text.strip_prefix('\u{feff}').unwrap_or(&text).to_string();
if stage == "base" {
let definitions = created_tables(&text);
let present: BTreeSet<String> = definitions.intersection(&tables[kind]).cloned().collect();
if !present.is_empty() && present != definitions {
return Err(Error::Invalid(format!("SQUID base file has only some of its tables. Repair the incomplete database before continuing: {relative}")));
}
if definitions.is_empty() {
return Err(Error::Invalid(format!("SQUID base file has no recognizable table definitions; repair is required: {relative}")));
}
if present == definitions {
if !ledger_sql.is_empty() {
mysql(&ledger_sql)?;
}
continue;
}
mysql(&format!("INSERT INTO `{schema}`.coa_squid_pending VALUES ('{relative}','{digest}'); COMMIT;"))?;
let complete = format!("DELETE FROM `{schema}`.coa_squid_pending WHERE path='{relative}' AND sha256='{digest}'; COMMIT;");
progress(&format!("Importing SQUID {relative} into {schema} ({} bytes); large imports may take several minutes...", bytes.len()));
mysql(&format!("USE `{schema}`;\n{text}\n{ledger_sql}\n{complete}")).map_err(|_| {
Error::Invalid(format!(
"SQUID import failed: {relative} in {schema}. The world server was not started. The incomplete import is recorded; restore a database backup or repair that import before retrying."
))
})?;
progress(&format!("Imported SQUID {relative}."));
if let Some(t) = tables.get_mut(kind) {
t.extend(definitions);
}
continue;
}
if installer_history.iter().any(|n| *n == relative || n.ends_with(&format!("/{relative}"))) {
mysql(&ledger_sql)?;
continue;
}
let file_name = source.file_name().unwrap_or_default().to_string_lossy().into_owned();
if let Some(upstream) = history.get(&file_name) {
let lf = String::from_utf8_lossy(&bytes).replace("\r\n", "\n");
let accepted = [sha1_hex(&bytes), sha1_hex(lf.as_bytes())];
if !upstream.is_empty() && !accepted.contains(upstream) {
return Err(Error::Invalid(format!("SQUID update history does not match the shipped SQL: {relative}")));
}
mysql(&ledger_sql)?;
continue;
}
mysql(&format!("USE `{schema}`;\n{text}\n{ledger_sql}"))?;
}
}
}
Ok(())
}
#[cfg(test)]
mod tests {
use super::*;
#[test]
fn config_lines_are_read_like_the_python_script() {
let d = tempfile::tempdir().unwrap();
let p = d.path().join("playerbots.conf");
std::fs::write(&p, "\u{feff}# comment = 1\nAiPlayerbot.Enabled = 0 # off\n Key.Two=\"quoted\"\nnot a line\nEmpty =\n").unwrap();
let o = options(&p);
assert_eq!(o.get("AiPlayerbot.Enabled").map(String::as_str), Some("0"));
assert_eq!(o.get("Key.Two").map(String::as_str), Some("quoted"));
assert_eq!(o.get("Empty").map(String::as_str), Some(""));
assert!(!o.contains_key("#"));
assert!(!enabled(&o, "AiPlayerbot.Enabled"));
assert!(enabled(&o, "Missing"));
}
#[test]
fn both_bot_modules_on_is_refused_and_squid_gets_a_long_startup() {
let d = tempfile::tempdir().unwrap();
let m = d.path().join("Core/configs/modules");
std::fs::create_dir_all(&m).unwrap();
std::fs::write(m.join("mod_coa_playerbots.conf"), "CoaBots.Enable = 1\n").unwrap();
std::fs::write(m.join("playerbots.conf.dist"), "AiPlayerbot.Enabled = 1\n").unwrap();
assert!(validate_bots(d.path()).is_err());
assert_eq!(startup_timeout(d.path()), 1500);
std::fs::write(m.join("playerbots.conf"), "AiPlayerbot.Enabled = 0\n").unwrap();
validate_bots(d.path()).unwrap();
assert_eq!(startup_timeout(d.path()), 180);
}
#[test]
fn options_are_replaced_or_appended() {
let d = tempfile::tempdir().unwrap();
let p = d.path().join("playerbots.conf");
std::fs::write(&p, "A = 1\r\n Playerbots.Updates.EnableDatabases = 1\r\n").unwrap();
set_options(&p, &[("Playerbots.Updates.EnableDatabases", "0".into()), ("PlayerbotsDatabaseInfo", "\"x\"".into())]).unwrap();
assert_eq!(std::fs::read_to_string(&p).unwrap(), "A = 1\nPlayerbots.Updates.EnableDatabases = 0\n\nPlayerbotsDatabaseInfo = \"x\"\n");
}
#[test]
fn base_tables_are_found() {
let t = created_tables("CREATE TABLE IF NOT EXISTS `ai_playerbot_names` (\n id int);\ncreate table playerbots_random_bots(x int);\n-- CREATE INDEX i ON t(x);");
assert_eq!(t, ["ai_playerbot_names".to_string(), "playerbots_random_bots".to_string()].into_iter().collect());
}
#[test]
fn a_secondary_world_uses_the_primary_package() {
assert_eq!(package_root(Path::new("C:/S/.realms/secondary")), Path::new("C:/S"));
assert_eq!(package_root(Path::new("C:/S")), Path::new("C:/S"));
}
}
+198
View File
@@ -0,0 +1,198 @@
//! `.state/`: which processes belong to this repack, and the one-action-at-a-time lock.
use std::fs::{File, OpenOptions};
use std::io::{Seek, SeekFrom, Write};
use std::path::{Path, PathBuf};
use std::time::{Duration, Instant};
use crate::error::{Error, Result};
use crate::fsx;
use crate::process::{self, ProcessIdentity};
pub fn dir(root: &Path) -> PathBuf {
root.join(".state")
}
/// Written like `manage.py atomic_json`: two-space JSON and a newline, now flushed to disk before it replaces
/// the old file.
pub fn write_json(path: &Path, value: &impl serde::Serialize) -> Result<()> {
let mut text = serde_json::to_string_pretty(value)?;
text.push('\n');
fsx::atomic_write(path, text.as_bytes())
}
/// The recorded process of `name` when it is still that process (same executable and start time). A missing,
/// empty or damaged record is no process: `manage.py` failed on those, and every later start with it.
pub fn running(root: &Path, name: &str) -> Option<ProcessIdentity> {
let record = process::read_state_record(root, name)?;
process::is_alive(&record).then_some(record)
}
/// Record the process `pid` as `name`. Fails when it has already exited.
pub fn record(root: &Path, name: &str, pid: u32) -> Result<ProcessIdentity> {
let identity = process::identity(pid)
.ok_or_else(|| Error::Invalid(format!("{name} exited during startup; check its log.")))?;
write_json(&dir(root).join(format!("{name}.json")), &identity)?;
Ok(identity)
}
/// Held while one start/stop action runs. Byte 0 of `.state/control.lock` is locked, exactly the region
/// `msvcrt.locking(fd, LK_NBLCK, 1)` locks in `manage.py`, so a Python launcher and this one exclude each other.
pub struct ControlLock {
file: File,
owner: PathBuf,
}
impl ControlLock {
/// Wait up to `wait` for the lock. `action` is recorded for whoever waits next ("start-all", ...).
pub fn acquire(root: &Path, action: &str, wait: Duration, progress: &dyn Fn(&str)) -> Result<ControlLock> {
let state = dir(root);
std::fs::create_dir_all(&state)?;
let mut file = OpenOptions::new().read(true).append(true).create(true).open(state.join("control.lock"))?;
if file.seek(SeekFrom::End(0))? == 0 {
file.write_all(b"0")?;
file.flush()?;
}
let owner = state.join("control-owner.json");
let deadline = Instant::now() + wait;
let mut announced = false;
loop {
if sys::try_lock(&file)? {
break;
}
let detail = match fsx::read_json::<serde_json::Value>(&owner) {
Ok(v) if v.get("pid").is_some() && v.get("action").is_some() => {
format!(" PID {}, action {}.", v["pid"], v["action"].as_str().unwrap_or(""))
}
_ => " Owner information is unavailable.".into(),
};
if Instant::now() >= deadline {
return Err(Error::Service(crate::error::ErrorCode::OperationInProgress, format!("Another start/stop action is in progress.{detail}")));
}
if !announced {
progress(&format!("Waiting for the current server action.{detail}"));
announced = true;
}
std::thread::sleep(Duration::from_millis(250));
}
let started = std::time::SystemTime::now()
.duration_since(std::time::UNIX_EPOCH)
.map(|d| d.as_secs_f64())
.unwrap_or(0.0);
let lock = ControlLock { file, owner };
write_json(
&lock.owner,
&serde_json::json!({ "pid": std::process::id(), "action": action, "started": started }),
)?;
Ok(lock)
}
}
/// Byte 0 of a file locked while held (`msvcrt.locking`), for example the bug-report relay's `relay.lock`.
pub struct FileLock {
file: File,
}
impl FileLock {
/// Take the lock, or `None` when another process (or handle) holds it.
pub fn try_acquire(path: &Path) -> Result<Option<FileLock>> {
let mut file = OpenOptions::new().read(true).append(true).create(true).open(path)?;
if file.seek(SeekFrom::End(0))? == 0 {
file.write_all(b"0")?;
file.flush()?;
}
Ok(sys::try_lock(&file)?.then_some(FileLock { file }))
}
}
impl Drop for FileLock {
fn drop(&mut self) {
sys::unlock(&self.file);
}
}
impl Drop for ControlLock {
fn drop(&mut self) {
let _ = std::fs::remove_file(&self.owner);
sys::unlock(&self.file);
}
}
#[cfg(windows)]
mod sys {
use std::fs::File;
use std::os::windows::io::AsRawHandle;
use windows_sys::Win32::Storage::FileSystem::{LockFile, UnlockFile};
/// `LockFile` on byte 0, length 1: the call `msvcrt.locking` makes. Non-blocking.
pub fn try_lock(file: &File) -> std::io::Result<bool> {
let ok = unsafe { LockFile(file.as_raw_handle() as _, 0, 0, 1, 0) };
if ok != 0 {
return Ok(true);
}
let err = std::io::Error::last_os_error();
// ERROR_LOCK_VIOLATION (33): someone else holds it.
if err.raw_os_error() == Some(33) {
Ok(false)
} else {
Err(err)
}
}
pub fn unlock(file: &File) {
unsafe {
UnlockFile(file.as_raw_handle() as _, 0, 0, 1, 0);
}
}
}
#[cfg(not(windows))]
mod sys {
use std::fs::File;
pub fn try_lock(_: &File) -> std::io::Result<bool> {
Ok(true)
}
pub fn unlock(_: &File) {}
}
#[cfg(test)]
mod tests {
use super::*;
#[test]
fn a_damaged_record_is_no_process() {
let d = tempfile::tempdir().unwrap();
std::fs::create_dir_all(dir(d.path())).unwrap();
std::fs::write(dir(d.path()).join("mysql.json"), [0u8; 116]).unwrap();
assert!(running(d.path(), "mysql").is_none());
std::fs::write(dir(d.path()).join("auth.json"), b"").unwrap();
assert!(running(d.path(), "auth").is_none());
}
#[test]
fn this_process_is_recorded_and_found_running() {
let d = tempfile::tempdir().unwrap();
let me = record(d.path(), "probe", std::process::id()).unwrap();
assert_eq!(running(d.path(), "probe"), Some(me));
let text = std::fs::read_to_string(dir(d.path()).join("probe.json")).unwrap();
assert!(text.starts_with("{\n \"pid\": ") && text.ends_with("}\n"), "{text}");
}
#[test]
fn one_action_at_a_time() {
let d = tempfile::tempdir().unwrap();
let first = ControlLock::acquire(d.path(), "start-all", Duration::from_secs(1), &|_| {}).unwrap();
let owner: serde_json::Value = fsx::read_json(&dir(d.path()).join("control-owner.json")).unwrap();
assert_eq!(owner["action"], "start-all");
let said = std::sync::Mutex::new(Vec::new());
let second = ControlLock::acquire(d.path(), "stop-all", Duration::from_millis(600), &|m| said.lock().unwrap().push(m.to_string()));
if cfg!(windows) {
let err = second.err().expect("the second action waits and gives up").to_string();
assert!(err.contains("Another start/stop action is in progress") && err.contains("start-all"), "{err}");
assert_eq!(said.lock().unwrap().len(), 1);
}
drop(first);
assert!(!dir(d.path()).join("control-owner.json").exists());
ControlLock::acquire(d.path(), "stop-all", Duration::from_secs(1), &|_| {}).unwrap();
}
}
+346
View File
@@ -0,0 +1,346 @@
//! The world server and the bug-report relay beside it (`manage.py start_world`, `watch_world`, `wait_relay`),
//! and the detailed-logging switch (`debug_logs`).
//!
//! A world is started through a supervisor process that outlives the caller: it starts `worldserver.exe`, keeps
//! the relay running while the world runs, and stops the relay when the world ends. The supervisor is
//! `coa-launcher.exe watch-world`, or `manage.py watch-world` on a repack that does not ship it yet (both write
//! the same records). The relay itself is still the Python `BugReport/relay.py`, run through the repack's
//! Python, until it is ported too.
use std::path::{Path, PathBuf};
use std::time::{Duration, Instant};
use crate::error::{Error, ErrorCode, Result};
use crate::launcher::services::{self, ensure_free, mysql, spawn, start_mysql, wait_ready, Progress};
use crate::launcher::spawn::Proc;
use crate::launcher::{schedule, settings::Settings, squid, state};
fn stop_relay_flag(root: &Path) -> std::path::PathBuf {
state::dir(root).join("stop-relay")
}
/// The relay is up and has finished starting (it records itself as `relay-ready` once it serves).
pub fn wait_relay(root: &Path) -> Result<()> {
let until = Instant::now() + Duration::from_secs(20);
while Instant::now() < until {
if let (Some(relay), Some(ready)) = (state::running(root, "relay"), state::running(root, "relay-ready")) {
if relay == ready {
return Ok(());
}
}
std::thread::sleep(Duration::from_millis(250));
}
Err(Error::Invalid("Bug-report relay is not ready; check BugReport/Logs/relay.log.".into()))
}
/// The process that runs `watch-world` for a started world.
#[derive(Debug, Clone)]
pub enum Supervisor {
/// `coa-launcher.exe` (this crate's launcher).
Launcher(PathBuf),
/// The repack's Python with `Scripts/manage.py`.
Python { python: PathBuf, script: PathBuf },
}
impl Supervisor {
/// The supervisor a repack ships: `Scripts/coa-launcher.exe` when present, otherwise its Python launcher.
pub fn of(root: &Path) -> Result<Supervisor> {
let exe = root.join("Scripts/coa-launcher.exe");
if exe.is_file() {
return Ok(Supervisor::Launcher(exe));
}
let python = squid::package_root(root).join("Runtime/python/python.exe");
let script = root.join("Scripts/manage.py");
if python.is_file() && script.is_file() {
return Ok(Supervisor::Python { python, script });
}
Err(Error::Service(
ErrorCode::ServerFilesIncomplete,
"This server has no world supervisor (Scripts/coa-launcher.exe or Scripts/manage.py). Repair its program files.".into(),
))
}
}
/// How long a world may take to open both of its listeners, together: slow worlds (many bots, a cold disk) are
/// common, and the limit must not depend on the bot module.
const WORLD_STARTUP_SECONDS: u64 = 1500;
/// Wait until the world's console answers a command (it can listen before it accepts logins).
fn wait_console(root: &Path, cfg: &Settings, until: Instant) -> Result<()> {
let mut last = String::new();
while Instant::now() < until {
if state::running(root, "world").is_none() {
return Err(Error::Service(
ErrorCode::StartupFailed,
"World startup failed: worldserver stopped before its console accepted commands.".into(),
));
}
match crate::ra::Ra::connect_to(cfg.ra_port, &cfg.ra_username, &cfg.ra_password).and_then(|mut ra| ra.run("server info")) {
Ok(_) => return Ok(()),
Err(e) => last = e.to_string(),
}
std::thread::sleep(Duration::from_millis(500));
}
Err(Error::Service(ErrorCode::StartupFailed, format!("World startup failed: its console is still starting. {last}")))
}
fn seconds_until(until: Instant) -> u64 {
until.saturating_duration_since(Instant::now()).as_secs()
}
/// Start the world (and its database, unless it is shared), and wait until its console accepts commands.
pub fn start_world(root: &Path, cfg: &Settings, offset: i32, supervisor: &Supervisor, progress: Progress) -> Result<()> {
start_mysql(root, cfg, progress)?;
squid::validate_bots(root)?;
let until = Instant::now() + Duration::from_secs(squid::startup_timeout(root).max(WORLD_STARTUP_SECONDS));
if state::running(root, "world").is_some() {
if state::running(root, "supervisor").is_none() {
return Err(Error::Service(
ErrorCode::WorldserverAlreadyRunning,
"Worldserver has no repack supervisor. Use Stop_All_Server.bat before restarting it.".into(),
));
}
wait_ready(root, "world", cfg.world_port, seconds_until(until))?;
wait_relay(root)?;
wait_console(root, cfg, until)?;
progress("Worldserver and bug-report relay are already running.");
return Ok(());
}
ensure_free(cfg.world_port, progress)?;
ensure_free(cfg.ra_port, progress)?;
if state::running(root, "supervisor").is_some() || state::running(root, "relay").is_some() {
return Err(Error::Service(
ErrorCode::OperationInProgress,
"The previous world/relay shutdown is still finishing. Try again shortly.".into(),
));
}
squid::prepare_playerbots(root, cfg.mysql_port, &|sql| mysql(root, Some(sql), None), progress)?;
progress("Starting worldserver and its bug-report relay...");
let _ = std::fs::remove_file(stop_relay_flag(root));
let offset_text = offset.to_string();
let root_text = root.to_string_lossy().into_owned();
let log = root.join("Core/Logs/supervisor.log");
match supervisor {
Supervisor::Launcher(exe) => {
spawn(root, "supervisor", exe, &["--root", &root_text, "--port-offset", &offset_text, "watch-world"], root, &log, &cfg.env_remove)?
}
Supervisor::Python { python, script } => {
let script = script.to_string_lossy().into_owned();
spawn(root, "supervisor", python, &["-B", &script, "--port-offset", &offset_text, "watch-world"], root, &log, &cfg.env_remove)?
}
};
let first = Instant::now() + Duration::from_secs(20);
while state::running(root, "world").is_none() && Instant::now() < first {
if state::running(root, "supervisor").is_none() {
return Err(Error::Service(ErrorCode::StartupFailed, "World startup failed; check Core/Logs/supervisor.log.".into()));
}
std::thread::sleep(Duration::from_millis(250));
}
wait_ready(root, "world", cfg.world_port, seconds_until(until))?;
wait_ready(root, "world", cfg.ra_port, seconds_until(until))?;
wait_relay(root)?;
wait_console(root, cfg, until)?;
progress("Worldserver and automatic bug reporting are ready.");
Ok(())
}
fn spawn_child(root: &Path, name: &str, exe: &Path, args: &[&str], cwd: &Path, log: &Path) -> Result<Proc> {
// The supervisor was started with the environment its services should have.
let child = crate::launcher::spawn::start(exe, args, cwd, log, &[])?;
state::record(root, name, child.pid)?;
Ok(child)
}
/// The relay worker: `coa-launcher relay-worker` when the supervisor is the launcher (`launcher`), otherwise the
/// repack's Python running `Scripts/manage.py relay-worker` (BugReport/relay.py).
fn spawn_relay(root: &Path, launcher: Option<&Path>) -> Result<Proc> {
let log = root.join("BugReport/Logs/relay.log");
if let Some(exe) = launcher {
let root_text = root.to_string_lossy().into_owned();
return spawn_child(root, "relay", exe, &["--root", &root_text, "relay-worker"], root, &log);
}
let python = squid::package_root(root).join("Runtime/python/python.exe");
let manage = root.join("Scripts/manage.py");
if !python.is_file() || !manage.is_file() {
return Err(Error::Invalid("The bug-report relay needs the repack's Python and Scripts/manage.py.".into()));
}
let manage = manage.to_string_lossy().into_owned();
spawn_child(root, "relay", &python, &["-B", &manage, "relay-worker"], root, &root.join("BugReport/Logs/relay.log"))
}
/// The supervisor (`watch-world`): run the world, keep the relay alive while it runs, stop the relay after it.
/// `launcher` is the launcher executable that runs the relay (`None`: the Python relay). At the owner's scheduled
/// time it asks the world to restart with an in-game countdown and starts it again when it exits for that.
pub fn watch_world(root: &Path, launcher: Option<&Path>, offset: i32, log: Progress) -> Result<()> {
squid::validate_bots(root)?;
let mut relay: Option<Proc> = None;
loop {
let world = spawn_child(root, "world", &root.join("Core/worldserver.exe"), &["-c", "configs/worldserver.conf"], &root.join("Core"), &root.join("Core/Logs/world-console.log"))?;
let started = schedule::now();
let mut requested = false;
let mut last_check: Option<Instant> = None;
let code = loop {
if let Some(code) = world.try_wait() {
break code;
}
let dead = relay.as_ref().is_none_or(|r| r.try_wait().is_some());
if dead {
match spawn_relay(root, launcher) {
Ok(r) => relay = Some(r),
Err(e) => {
log(&format!("Report relay could not start ({e}); retrying."));
std::thread::sleep(Duration::from_secs(5));
continue;
}
}
}
if last_check.is_none_or(|t| t.elapsed() >= Duration::from_secs(30)) {
last_check = Some(Instant::now());
if schedule::under_way(root) && !requested {
// The world that a scheduled restart started again is back once it accepts connections.
if Settings::load(root, offset).is_ok_and(|cfg| services::ready(root, "world", cfg.world_port)) {
schedule::clear_under_way(root);
}
}
if !requested {
let plan = schedule::load(root);
if plan.due(schedule::now(), started).is_some() {
let seconds = plan.warning_minutes * 60;
let asked = Settings::load(root, offset).and_then(|cfg| {
crate::ra::Ra::connect_to(cfg.ra_port, &cfg.ra_username, &cfg.ra_password)
.and_then(|mut ra| ra.run(&format!("server restart {seconds}")))
});
match asked {
Ok(_) => {
schedule::mark_under_way(root)?;
requested = true;
log(&format!("Scheduled restart: the world restarts in {} minutes.", plan.warning_minutes));
}
Err(e) => log(&format!("Scheduled restart could not be requested ({e}); retrying.")),
}
}
}
}
std::thread::sleep(Duration::from_secs(2));
};
if requested && code == schedule::RESTART_EXIT_CODE as u32 {
log("Scheduled restart: starting the world again.");
if let Err(e) = squid::validate_bots(root) {
schedule::clear_under_way(root);
return Err(e);
}
continue;
}
schedule::clear_under_way(root);
break;
}
std::fs::write(stop_relay_flag(root), b"")?;
if let Some(r) = relay {
let until = Instant::now() + Duration::from_secs(40);
while r.try_wait().is_none() && Instant::now() < until {
std::thread::sleep(Duration::from_millis(250));
}
if r.try_wait().is_none() {
// An interrupted POST stays uncertain in the relay's journal; it is not resent.
if let Some(record) = state::running(root, "relay") {
services::terminate(&record)?;
}
}
}
Ok(())
}
// ---------------------------------------------------------------------------------------------------------------
// Detailed logging (Debug_Logs_On.bat / Debug_Logs_Off.bat)
// ---------------------------------------------------------------------------------------------------------------
const DEBUG_TEMPLATES: [&str; 2] = ["worldserver.conf.template", "authserver.conf.template"];
/// One template line with every logger forced to Trace and the console/server appenders to the most detail.
fn debug_line(line: &str) -> String {
let body = line.strip_prefix('#').unwrap_or(line).trim_start();
for appender in ["Appender.Console", "Appender.Server"] {
if let Some(rest) = body.strip_prefix(appender).and_then(|r| r.strip_prefix('=')) {
let parts: Vec<&str> = rest.splitn(4, ',').collect();
if parts.len() == 4 && parts[..3].iter().all(|p| !p.is_empty() && p.bytes().all(|b| b.is_ascii_digit())) {
return format!("{appender}={},6,7,{}", parts[0], parts[3]);
}
}
}
if let Some(rest) = body.strip_prefix("Logger.") {
if let Some((name, value)) = rest.split_once('=') {
if !name.is_empty() && name.bytes().all(|b| b.is_ascii_alphanumeric() || b == b'_' || b == b'.') {
if let Some((level, tail)) = value.split_once(',') {
if !level.is_empty() && level.bytes().all(|b| b.is_ascii_digit()) {
return format!("Logger.{name}=6,{tail}");
}
}
}
}
}
let t = line.trim_end();
if let Some(v) = t.strip_prefix("Log.Async.Enable") {
let v = v.trim_start();
if let Some(n) = v.strip_prefix('=') {
let n = n.trim();
if !n.is_empty() && n.bytes().all(|b| b.is_ascii_digit()) {
return "Log.Async.Enable = 1".into();
}
}
}
line.to_string()
}
/// Turn detailed logging on or off (the templates; services apply it at their next start). Returns the changed
/// templates.
pub fn debug_logs(root: &Path, enable: bool) -> Result<Vec<String>> {
let mut changed = Vec::new();
for name in DEBUG_TEMPLATES {
let path = root.join("Settings").join(name);
let original = root.join("Settings").join(format!("{name}.original"));
if !original.exists() {
std::fs::write(&original, std::fs::read(&path)?)?;
}
let new_bytes = if enable {
let text = String::from_utf8(std::fs::read(&original)?).map_err(|_| Error::Invalid(format!("{name} is not UTF-8.")))?;
let newline = if text.contains("\r\n") { "\r\n" } else { "\n" };
let mut out = text.lines().map(debug_line).collect::<Vec<_>>().join(newline);
if text.ends_with('\n') {
out.push_str(newline);
}
out.into_bytes()
} else {
std::fs::read(&original)?
};
if std::fs::read(&path)? != new_bytes {
std::fs::write(&path, &new_bytes)?;
changed.push(name.to_string());
}
}
state::write_json(&state::dir(root).join("debug-logs.json"), &serde_json::json!({ "enabled": enable }))?;
Ok(changed)
}
#[cfg(test)]
mod tests {
use super::*;
#[test]
fn detailed_logging_rewrites_loggers_and_restores_the_original() {
let d = tempfile::tempdir().unwrap();
std::fs::create_dir_all(d.path().join("Settings")).unwrap();
let world = "Appender.Console=1,3,0\r\nAppender.Server=2,2,0,Server.log,w\r\n#Logger.module=4,Console Server\r\nLogger.root=5,Console Server\r\nLog.Async.Enable = 0\r\nOther = 1\r\n";
std::fs::write(d.path().join("Settings/worldserver.conf.template"), world).unwrap();
std::fs::write(d.path().join("Settings/authserver.conf.template"), "Logger.root=2,Console\n").unwrap();
let changed = debug_logs(d.path(), true).unwrap();
assert_eq!(changed.len(), 2);
assert_eq!(
std::fs::read_to_string(d.path().join("Settings/worldserver.conf.template")).unwrap(),
"Appender.Console=1,3,0\r\nAppender.Server=2,6,7,Server.log,w\r\nLogger.module=6,Console Server\r\nLogger.root=6,Console Server\r\nLog.Async.Enable = 1\r\nOther = 1\r\n"
);
assert_eq!(debug_logs(d.path(), true).unwrap().len(), 0, "already on");
debug_logs(d.path(), false).unwrap();
assert_eq!(std::fs::read_to_string(d.path().join("Settings/worldserver.conf.template")).unwrap(), world);
assert_eq!(services::status(d.path())["debugLogs"], false);
}
}
-85
View File
@@ -1,85 +0,0 @@
import runpy
import sys
import time
from pathlib import Path
script = sys.argv[1]
sys.path.insert(0, str(Path(script).resolve().parent))
sys.argv = sys.argv[1:]
launcher = runpy.run_path(script, run_name="coa_manager_launcher")
original_wait = launcher["wait_ready"]
world_deadline = None
def wait_ready(name, port, seconds=180):
global world_deadline
if name == "mysql":
seconds = max(seconds, 300)
elif name == "world":
# Both game and console listeners belong to one startup, including on old repacks.
# Ordinary CoA worlds can load slowly too; this must not depend on SQUID.
if world_deadline is None:
world_deadline = time.monotonic() + max(seconds, 1500)
seconds = max(0, world_deadline - time.monotonic())
return original_wait(name, port, seconds)
launcher["start_mysql"].__globals__["wait_ready"] = wait_ready
if sys.argv[1] in ("stop-all", "force-stop-all"):
shutdown = launcher["stop_all"].__globals__
class UnsafeShutdown(Exception):
pass
def stop_owned_world(world):
expected = Path(script).resolve().parents[1] / "Core" / "worldserver.exe"
if Path(world.get("exe", "")) != expected or not shutdown["same_process"](world):
raise UnsafeShutdown("World process ownership could not be verified; the database was left running.")
try:
shutdown["terminate"](world)
except (OSError, RuntimeError) as error:
raise UnsafeShutdown("Worldserver could not be stopped safely; its database was left running.") from error
if not shutdown["wait_stopped"](world, 90):
raise UnsafeShutdown("Worldserver is still stopping; its database was left running.")
if "ra" in shutdown:
original_ra = shutdown["ra"]
def shutdown_command(command, config):
try:
return original_ra(command, config)
except (OSError, RuntimeError):
if not command.startswith("server shutdown "):
raise
world = shutdown["process"]("world")
if not world:
return "Worldserver has already stopped."
stop_owned_world(world)
return "Stopped this server's recorded world process without its unavailable console."
shutdown["ra"] = shutdown_command
config = launcher["settings"]()
with launcher["control_lock"]():
if sys.argv[1] == "force-stop-all":
world = shutdown["process"]("world")
if world:
stop_owned_world(world)
print("Force-stopped this server's verified world process; unsaved progress may be lost.", flush=True)
launcher["stop_all"](config)
else:
launcher["main"]()
if sys.argv[1] in ("start-all", "start-world"):
config = launcher["settings"]()
deadline = world_deadline if world_deadline is not None else time.monotonic() + 1500
last_error = None
while time.monotonic() < deadline:
if not launcher["process"]("world"):
raise RuntimeError("World startup failed: worldserver stopped before its console accepted commands.")
try:
launcher["ra"]("server info", config)
print("World console is accepting commands.", flush=True)
break
except (OSError, RuntimeError) as error:
last_error = error
time.sleep(0.5)
else:
raise RuntimeError(f"World startup failed: its console is still starting. {last_error}")
+222
View File
@@ -0,0 +1,222 @@
//! `Scripts/manage.py` as Managers up to 0.9.10 edited it.
//!
//! Those Managers ran the repack's Python launcher themselves and changed its text: an import fix for their bridge
//! and a realm-profile patch (database and realm row of the active realm). This Manager starts servers with
//! [`crate::launcher`] and never edits the file; it only has to recognise those edits, so that an update or a file
//! check treats a file one of them changed as unmodified. Nothing here writes a file.
use crate::error::{Error, Result};
const LAUNCHER_REALM_REPLACEMENTS: &[(&str, &str)] = &[
("(\"WorldDatabaseInfo\", \"acore_world\")", "(\"WorldDatabaseInfo\", \"acore_world_wildcard\" if coa_realm() == 'wildcard' else \"acore_world\")"),
("(\"CharacterDatabaseInfo\", \"acore_characters\")", "(\"CharacterDatabaseInfo\", \"acore_characters_wildcard\" if coa_realm() == 'wildcard' else \"acore_characters\")"),
("SET name='AzerothCore',address=", "SET name='{coa_realm_name()}',address="),
("WHERE id=1;", "WHERE id={coa_realm_id()};"),
("mysql(\"UPDATE acore_auth.realmlist SET flag=0", "mysql(f\"UPDATE acore_auth.realmlist SET flag=0"),
];
const LAUNCHER_REALM_INSERT: &str = "# coa-manager-realm-profiles-v1\ndef coa_realm():\n path = ROOT / 'Settings/realm-profile.json'\n return json.loads(path.read_text(encoding='utf-8')).get('active', 'coa') if path.exists() else 'coa'\n\ndef coa_realm_id():\n return 2 if coa_realm() == 'wildcard' else 1\n\ndef coa_realm_name():\n return 'Wildcard' if coa_realm() == 'wildcard' else 'Conquest of Azeroth'\n\n";
fn launcher_insert() -> String {
LAUNCHER_REALM_INSERT
.replace("profiles-v1", "profiles-v2")
.replace(
"return 2 if",
"return 3 if coa_realm() == 'reborn' else 2 if",
)
.replace(
"return 'Wildcard' if",
"return 'Warcraft Reborn' if coa_realm() == 'reborn' else 'Wildcard' if",
)
}
fn launcher_replacements() -> Vec<(&'static str, String)> {
LAUNCHER_REALM_REPLACEMENTS.iter().map(|(from, to)| (*from, to
.replace("\"acore_world_wildcard\" if", "\"acore_world_reborn\" if coa_realm() == 'reborn' else \"acore_world_wildcard\" if")
.replace("\"acore_characters_wildcard\" if", "\"acore_characters_reborn\" if coa_realm() == 'reborn' else \"acore_characters_wildcard\" if"))).collect()
}
/// The realm-profile patch older Managers wrote.
pub(crate) fn patch_launcher(source: &str) -> Result<String> {
if source.contains("# coa-manager-realm-profiles-v2") {
return Ok(source.into());
}
if source.contains("# coa-manager-realm-profiles-v1") {
let original = unpatch_launcher(source)
.ok_or_else(|| Error::Invalid("Unrecognised realm launcher patch.".into()))?;
return patch_launcher(&original);
}
let mut out = source.to_string();
for (from, to) in launcher_replacements() {
if !out.contains(from) {
return Err(Error::Invalid(
"This launcher does not support realm profiles. Update the server package first."
.into(),
));
}
out = out.replace(from, &to);
}
// Insert before the entry point so ROOT, json and functions are all defined when called.
let marker = "if __name__ == \"__main__\":";
if !out.contains(marker) {
return Err(Error::Invalid(
"Unrecognised server launcher entry point.".into(),
));
}
Ok(out.replace(marker, &format!("{}{marker}", launcher_insert())))
}
/// Reverse only our exact realm transformation; callers must verify the recovered original hash.
pub(crate) fn unpatch_launcher(source: &str) -> Option<String> {
let (insert, replacements) = if source.contains(&launcher_insert()) {
(launcher_insert(), launcher_replacements())
} else if source.contains(LAUNCHER_REALM_INSERT) {
(
LAUNCHER_REALM_INSERT.into(),
LAUNCHER_REALM_REPLACEMENTS
.iter()
.map(|(a, b)| (*a, b.to_string()))
.collect(),
)
} else {
return None;
};
let mut original = source.replacen(&insert, "", 1);
for (from, to) in &replacements {
original = original.replace(to, from);
}
let mut check = original.clone();
for (from, to) in &replacements {
check = check.replace(from, to);
}
check = check.replace(
"if __name__ == \"__main__\":",
&format!("{insert}if __name__ == \"__main__\":"),
);
(check == source).then_some(original)
}
/// The import fix older Managers wrote (needed to run manage.py through their bridge).
pub(crate) fn patch_launcher_imports(text: &str) -> Result<String> {
let line = "sys.path.insert(0, str(Path(__file__).resolve().parent))";
if !text.contains("from squid_playerbots import") || text.contains(line) {
return Ok(text.into());
}
let root = "ROOT = Path(__file__).resolve().parents[1]";
if !text.contains(root) || !text.lines().any(|line| line.trim() == "import sys") {
return Err(Error::Invalid(
"The server launcher cannot load its integration scripts. Repair its program files."
.into(),
));
}
Ok(text.replacen(root, &format!("{root}\n{line}"), 1))
}
pub(crate) fn launcher_matches(signed: &str, actual: &[u8]) -> bool {
if signed.as_bytes() == actual {
return true;
}
if patch_launcher_imports(signed).is_ok_and(|s| s.as_bytes() == actual) {
return true;
}
patch_launcher(signed).is_ok_and(|s| {
s.as_bytes() == actual || patch_launcher_imports(&s).is_ok_and(|p| p.as_bytes() == actual)
})
}
/// Recover legacy metadata only when undoing supported Manager edits reproduces the recorded hash.
pub(crate) fn launcher_matches_recorded(recorded: &str, actual: &[u8]) -> bool {
let Ok(text) = std::str::from_utf8(actual) else {
return false;
};
let without_import = text.replacen(
"ROOT = Path(__file__).resolve().parents[1]\nsys.path.insert(0, str(Path(__file__).resolve().parent))",
"ROOT = Path(__file__).resolve().parents[1]", 1,
);
for candidate in [
Some(without_import.clone()),
unpatch_launcher(&without_import),
]
.into_iter()
.flatten()
{
if crate::fsx::sha256_bytes(candidate.as_bytes()).eq_ignore_ascii_case(recorded)
&& launcher_matches(&candidate, actual)
{
return true;
}
}
false
}
#[cfg(test)]
mod tests {
use super::*;
use crate::fsx;
use std::collections::BTreeMap;
use std::fs;
#[test]
fn old_launcher_upgrades_and_both_patch_versions_are_reversible() {
let original = "(\"WorldDatabaseInfo\", \"acore_world\")\n(\"CharacterDatabaseInfo\", \"acore_characters\")\nSET name='AzerothCore',address=\nWHERE id=1;\nmysql(\"UPDATE acore_auth.realmlist SET flag=0\nif __name__ == \"__main__\":\n";
let mut old = original.to_string();
for (from, to) in LAUNCHER_REALM_REPLACEMENTS {
old = old.replace(from, to);
}
old = old.replace(
"if __name__ == \"__main__\":",
&format!("{LAUNCHER_REALM_INSERT}if __name__ == \"__main__\":"),
);
assert_eq!(unpatch_launcher(&old).as_deref(), Some(original));
let new = patch_launcher(&old).unwrap();
assert!(new.contains("acore_world_reborn"));
assert!(new.contains("return 3 if coa_realm() == 'reborn'"));
assert!(new.contains("return 'Warcraft Reborn' if"));
assert_eq!(patch_launcher(&new).unwrap(), new);
assert_eq!(unpatch_launcher(&new).as_deref(), Some(original));
}
#[test]
fn unknown_launcher_is_refused_without_partial_patching() {
assert!(patch_launcher("print('custom launcher')").is_err());
}
#[test]
fn launcher_import_fix_is_idempotent_and_retains_other_code() {
let text = "import sys\nROOT = Path(__file__).resolve().parents[1]\nfrom squid_playerbots import validate_bots\ncustom = 42\n";
let fixed = patch_launcher_imports(text).unwrap();
assert!(fixed.contains("sys.path.insert(0, str(Path(__file__).resolve().parent))"));
assert!(fixed.ends_with("custom = 42\n"));
assert_eq!(patch_launcher_imports(&fixed).unwrap(), fixed);
}
#[test]
fn a_launcher_patched_by_an_older_manager_stays_pristine_but_external_edits_conflict() {
let d = tempfile::tempdir().unwrap();
let root = d.path().join("server");
let source = "(\"WorldDatabaseInfo\", \"acore_world\")\n(\"CharacterDatabaseInfo\", \"acore_characters\")\nSET name='AzerothCore',address=\nWHERE id=1;\nmysql(\"UPDATE acore_auth.realmlist SET flag=0\nif __name__ == \"__main__\":\n";
fsx::atomic_write(&root.join("Scripts/manage.py"), source.as_bytes()).unwrap();
// What an older Manager left: the realm patch applied and its hash recorded as the pristine one.
let patched = patch_launcher(source).unwrap();
fsx::atomic_write(&root.join("Scripts/manage.py"), patched.as_bytes()).unwrap();
let mut meta = crate::registry::InstallMeta::new(crate::registry::InstallKind::New, &root);
meta.original_hashes.insert("Scripts/manage.py".into(), fsx::sha256_bytes(patched.as_bytes()));
crate::registry::MetaDir::create(&root, &meta).unwrap();
assert!(crate::diag::verify_managed(&root, &meta).is_empty());
let manifest: crate::manifest::Manifest = serde_json::from_value(serde_json::json!({
"schema": 1, "kind": "update", "version": "2.0.0", "core": {"commit": null}, "builtAt": "fixture", "minManagerVersion": "0.1.0",
"files": [{"path":"Scripts/manage.py","sha256":fsx::sha256_bytes(b"next release"),"size":12,"owner":"core","policy":"replace"}]
})).unwrap();
assert_eq!(
crate::update::plan(&root, &meta, &manifest, &BTreeMap::new(), None).unwrap()[0].action,
crate::update::Action::Replace
);
let mut modified = fs::read(root.join("Scripts/manage.py")).unwrap();
modified.extend_from_slice(b"# custom edit\n");
fsx::atomic_write(&root.join("Scripts/manage.py"), &modified).unwrap();
assert_eq!(
crate::update::plan(&root, &meta, &manifest, &BTreeMap::new(), None).unwrap()[0].action,
crate::update::Action::Conflict
);
}
}
+4 -11
View File
@@ -9,10 +9,8 @@
pub mod accounts;
pub mod allsettings;
pub mod analyzer;
pub mod addons;
pub mod backup;
pub mod build_engine;
pub mod catalogue;
pub mod channels;
pub mod character_start_check;
pub mod cleanbase;
@@ -31,6 +29,7 @@ pub mod diag;
pub mod docker;
pub mod download;
pub mod driver;
pub mod legacy_launcher;
pub mod error;
pub mod firewall;
pub mod friends;
@@ -39,31 +38,27 @@ pub mod glue_config;
pub mod health;
pub mod install;
pub mod layout;
pub mod launcher;
pub mod logging;
pub mod server_logging;
pub mod manifest;
pub mod migrations;
pub mod modules;
pub mod module_sources;
pub mod msvc_setup;
pub mod multiworld;
mod mysql_snapshot;
pub mod net;
pub mod package;
pub mod pkgsource;
pub mod platform;
pub mod plugins;
pub mod population;
pub mod portable;
pub mod preview;
pub mod process;
pub mod provenance;
pub mod ra;
pub mod race_availability;
pub mod realm_registry;
pub mod realmlist;
pub mod realm_names;
pub mod realms;
pub mod rebuild;
pub mod registry;
pub mod release;
pub mod release_history;
@@ -72,9 +67,7 @@ pub mod remote_client;
pub mod repair;
pub mod report;
pub mod schema_check;
pub mod server_migration;
pub mod signing;
pub mod solver;
pub mod squid;
pub mod srp6;
pub mod update;
-127
View File
@@ -1,127 +0,0 @@
//! Sources of a module at an exact commit, downloaded as GitHub's archive of that commit (no git needed).
//!
//! The cache layout is the one the rest of the Manager uses, `<cache>/github/<owner>/<repo>/<sha>`, so a
//! module identifies itself by its repository name and a later rebuild finds the same tree.
use std::fs;
use std::io::Read;
use std::path::{Component, Path, PathBuf};
use std::time::Duration;
use crate::error::{Error, Result};
const MAX_ARCHIVE_BYTES: u64 = 512 * 1024 * 1024;
fn valid_name(s: &str) -> bool {
!s.is_empty() && s.len() <= 100 && s != "." && s != ".."
&& s.chars().all(|c| c.is_ascii_alphanumeric() || matches!(c, '-' | '_' | '.'))
}
/// `<cache>/github/<owner>/<repo>/<sha>`, downloading it when it is not there yet.
pub fn fetch_pinned(owner: &str, repo: &str, sha: &str, cache_root: &Path) -> Result<PathBuf> {
if !valid_name(owner) || !valid_name(repo) || sha.len() != 40 || !sha.bytes().all(|b| b.is_ascii_hexdigit()) {
return Err(Error::Invalid(format!("Invalid module source {owner}/{repo}@{sha}")));
}
let sha = sha.to_ascii_lowercase();
let dest = cache_root.join("github").join(owner).join(repo).join(&sha);
if dest.join(".coa_tree_digest").is_file() {
return Ok(dest);
}
let url = format!("https://codeload.github.com/{owner}/{repo}/tar.gz/{sha}");
let client = reqwest::blocking::Client::builder()
.connect_timeout(Duration::from_secs(15))
.timeout(Duration::from_secs(600))
.build()
.map_err(|e| Error::Invalid(e.to_string()))?;
let reply = client.get(&url).send().map_err(|e| Error::NetworkUnreachable(format!("{url}: {e}")))?;
if !reply.status().is_success() {
return Err(Error::Invalid(format!("GitHub answered {} for {owner}/{repo} at {sha}", reply.status())));
}
let staging = cache_root.join("staging").join(format!("{owner}_{repo}_{sha}_{}", std::process::id()));
if staging.exists() {
fs::remove_dir_all(&staging)?;
}
fs::create_dir_all(&staging)?;
let result = (|| -> Result<()> {
unpack(reply.take(MAX_ARCHIVE_BYTES + 1), &staging)?;
crate::analyzer::validate_source_tree_safety(&staging)?;
let digest = crate::analyzer::compute_tree_digest(&staging)?;
fs::write(staging.join(".coa_tree_digest"), digest)?;
Ok(())
})();
if let Err(e) = result {
let _ = fs::remove_dir_all(&staging);
return Err(e);
}
fs::create_dir_all(dest.parent().unwrap())?;
if dest.exists() {
fs::remove_dir_all(&dest)?;
}
fs::rename(&staging, &dest)?;
Ok(dest)
}
/// Extracts a GitHub tar.gz (one top-level `<repo>-<sha>/` folder) into `dest`, files and folders only.
fn unpack(reader: impl Read, dest: &Path) -> Result<()> {
let mut archive = tar::Archive::new(flate2::read::GzDecoder::new(reader));
let mut total = 0u64;
for entry in archive.entries()? {
let mut entry = entry?;
let path = entry.path()?.into_owned();
let rel: PathBuf = path.components().skip(1).collect();
if rel.as_os_str().is_empty() {
continue;
}
if rel.components().any(|c| !matches!(c, Component::Normal(_))) {
return Err(Error::PathRejected(format!("archive entry {}", path.display())));
}
let kind = entry.header().entry_type();
let target = dest.join(&rel);
if kind.is_dir() {
fs::create_dir_all(&target)?;
} else if kind.is_file() {
total += entry.header().size()?;
if total > MAX_ARCHIVE_BYTES {
return Err(Error::Invalid("The module archive is too large".into()));
}
fs::create_dir_all(target.parent().unwrap())?;
let mut out = fs::File::create(&target)?;
std::io::copy(&mut entry, &mut out)?;
}
// Links and special entries are not part of a module's sources: skipped.
}
Ok(())
}
#[cfg(test)]
mod tests {
use super::*;
fn tar_gz(entries: &[(&str, &[u8])]) -> Vec<u8> {
let mut builder = tar::Builder::new(flate2::write::GzEncoder::new(Vec::new(), flate2::Compression::fast()));
for (name, data) in entries {
let mut h = tar::Header::new_gnu();
h.set_size(data.len() as u64);
h.set_mode(0o644);
h.set_entry_type(tar::EntryType::Regular);
builder.append_data(&mut h, name, *data).unwrap();
}
builder.into_inner().unwrap().finish().unwrap()
}
#[test]
fn archive_is_unpacked_without_its_top_folder() {
let dir = tempfile::tempdir().unwrap();
let gz = tar_gz(&[("mod-x-abc/src/a.cpp", b"int a;"), ("mod-x-abc/conf/x.conf.dist", b"X = 1")]);
unpack(&gz[..], dir.path()).unwrap();
assert_eq!(fs::read(dir.path().join("src/a.cpp")).unwrap(), b"int a;");
assert!(dir.path().join("conf/x.conf.dist").is_file());
}
#[test]
fn bad_names_are_refused_before_any_download() {
let dir = tempfile::tempdir().unwrap();
assert!(fetch_pinned("../x", "repo", &"a".repeat(40), dir.path()).is_err());
assert!(fetch_pinned("owner", "repo", "main", dir.path()).is_err());
}
}
+127 -512
View File
@@ -48,6 +48,10 @@ pub struct Entry {
/// Not shown on the Modules page; its settings are offered elsewhere (a server setting card).
#[serde(default)]
pub hidden: bool,
/// A part of another module, switched and set up inside that module's settings (Custom Races V2 brings
/// subclasses and the /dev menu).
#[serde(default)]
pub part_of: Option<String>,
}
fn yes() -> bool {
@@ -77,47 +81,7 @@ fn entry_in(cat: &[Entry], id: &str) -> Result<Entry> {
}
fn dir(root: &Path) -> PathBuf {
crate::plugins::modules_config_dir(root)
}
fn find_conf_for_id(root: &Path, id: &str) -> Option<(PathBuf, Option<PathBuf>)> {
let conf_dir = dir(root);
// 1. Check if known in catalog
if let Ok(e) = entry_in(&catalog(), id) {
let name = conf_name(root, &e);
let conf = conf_dir.join(&name);
let dist = conf_dir.join(format!("{name}.dist"));
return Some((conf, dist.is_file().then_some(dist)));
}
// 2. Check plugin registry
if let Ok(reg) = crate::plugins::load_registry(root) {
if let Some(entry) = reg.plugins.get(id) {
for conf_entry in &entry.conf_files {
let base_name = conf_entry.strip_suffix(".dist").unwrap_or(conf_entry);
let conf = conf_dir.join(base_name);
let dist = conf_dir.join(format!("{base_name}.dist"));
if conf.is_file() || dist.is_file() {
return Some((conf, dist.is_file().then_some(dist)));
}
}
}
}
// 3. Fallback search by ID or name in conf_dir
let normalized = id.replace('-', "_");
if let Ok(entries) = fs::read_dir(&conf_dir) {
for entry in entries.flatten() {
let p = entry.path();
if let Some(fname) = p.file_name().and_then(|n| n.to_str()) {
if fname.starts_with(&normalized) || fname.starts_with(id) {
let base_name = fname.strip_suffix(".dist").unwrap_or(fname);
let conf = conf_dir.join(base_name);
let dist = conf_dir.join(format!("{base_name}.dist"));
return Some((conf, dist.is_file().then_some(dist)));
}
}
}
}
None
root.join("Core/configs/modules")
}
fn read(path: &Path) -> Option<ConfFile> {
@@ -133,24 +97,14 @@ fn truthy(v: &str) -> bool {
)
}
#[derive(Debug, Clone, Copy, PartialEq, Eq, Serialize, Deserialize)]
#[serde(rename_all = "SCREAMING_SNAKE_CASE")]
pub enum ComponentType {
DynamicDll,
CoreEmbedded,
ContentPack,
ClientPatch,
LogicalFeature,
}
#[derive(Debug, Serialize, Deserialize, Clone)]
#[derive(Debug, Serialize)]
pub struct ModuleView {
pub id: String,
pub name: String,
pub version: Option<String>,
pub description: BTreeMap<String, String>,
pub repo: String,
/// The module's component is truly present and installed on this server.
/// The module's configuration is present on this server (otherwise it is not part of this server build).
pub installed: bool,
/// At least one editable setting besides the master switch exists in this server build.
pub has_settings: bool,
@@ -161,9 +115,7 @@ pub struct ModuleView {
pub page: Option<String>,
pub hidden: bool,
pub compatibility: String,
pub component_type: ComponentType,
pub can_remove: bool,
pub source_commit: Option<String>,
pub part_of: Option<String>,
}
pub fn list(root: &Path) -> Vec<ModuleView> {
@@ -224,163 +176,51 @@ fn installed_module_commits(root: &Path) -> BTreeMap<String, String> {
Default::default()
}
/// The companion bots of this server build play Wildcard and Warcraft Reborn: their bot profiles for the standard
/// classes are in the world server or its bots plugin. Older builds only know Conquest of Azeroth characters.
pub fn companions_on_other_realms(root: &Path) -> bool {
use std::collections::HashMap;
use std::sync::{Mutex, OnceLock};
static SEEN: OnceLock<Mutex<HashMap<(PathBuf, u64, Option<std::time::SystemTime>), bool>>> = OnceLock::new();
const MARKER: &[u8] = b"Druid_Guardian_Tank";
let mut files = vec![crate::layout::executables(root).0];
if let Ok(plugins) = fs::read_dir(root.join("Core/plugins")) {
files.extend(plugins.flatten().map(|e| e.path()).filter(|p| p.extension().is_some_and(|x| x.eq_ignore_ascii_case("dll"))));
}
files.into_iter().any(|file| {
let Ok(meta) = fs::metadata(&file) else { return false };
let key = (file.clone(), meta.len(), meta.modified().ok());
let seen = SEEN.get_or_init(Mutex::default);
if let Some(found) = seen.lock().ok().and_then(|s| s.get(&key).copied()) {
return found;
}
let found = fs::read(&file).is_ok_and(|bytes| bytes.windows(MARKER.len()).any(|w| w == MARKER));
if let Ok(mut s) = seen.lock() {
s.insert(key, found);
}
found
})
}
fn list_in(cat: &[Entry], root: &Path) -> Vec<ModuleView> {
let installed_commits = installed_module_commits(root);
let plugin_reg = crate::plugins::load_registry(root).ok();
let wildcard = crate::realms::state(root)
.map(|s| s.active != crate::realms::Mode::Coa)
.unwrap_or(true);
let is_modular_host = root.join("plugins").is_dir()
|| root.join(".manager/plugins.json").is_file()
|| root.join(".manager/plugin-store").is_dir()
|| root.join("sdk.json").is_file();
let mut views: Vec<ModuleView> = cat.iter()
cat.iter()
.cloned()
.map(|e| {
let name = conf_name(root, &e);
let conf = dir(root).join(&name);
let dist = dir(root).join(format!("{name}.dist"));
// 1. Dynamic DLL detection
let plugin_entry = plugin_reg.as_ref().and_then(|r| {
r.plugins.get(&e.id)
.or_else(|| r.plugins.get(&e.id.replace('-', "_")))
.or_else(|| r.plugins.get(&format!("mod-{}", e.id)))
.or_else(|| r.plugins.get(&format!("mod-coa-{}", e.id)))
.or_else(|| r.plugins.get(&format!("coa-{}", e.id)))
.or_else(|| r.plugins.get(&format!("coa_{}", e.id)))
.or_else(|| match e.id.as_str() {
"content-scaling" => r.plugins.get("coa-content-scaling").or_else(|| r.plugins.get("mod-coa-content-scaling")),
"companions" => r.plugins.get("coa-playerbots").or_else(|| r.plugins.get("mod-coa-playerbots")),
"playerbots" => r.plugins.get("squid-playerbots").or_else(|| r.plugins.get("mod-playerbots")),
_ => None,
})
});
let alias_dlls: Vec<PathBuf> = match e.id.as_str() {
"content-scaling" => vec![
root.join("plugins").join("coa-content-scaling").join("coa-content-scaling.dll"),
root.join("plugins").join("coa-content-scaling.dll"),
],
"companions" => vec![
root.join("plugins").join("coa-playerbots").join("coa-playerbots.dll"),
root.join("plugins").join("coa-playerbots.dll"),
root.join("plugins").join("mod-coa-playerbots.dll"),
],
"playerbots" => vec![
root.join("plugins").join("mod-playerbots").join("mod-playerbots.dll"),
root.join("plugins").join("squid-playerbots").join("squid-playerbots.dll"),
root.join("plugins").join("mod-playerbots.dll"),
],
_ => Vec::new(),
};
let mut dll_candidates = vec![
root.join("plugins").join(format!("{}.dll", e.id)),
root.join("plugins").join(format!("{}.dll", e.id.replace('-', "_"))),
root.join("plugins").join(format!("coa-{}.dll", e.id)),
root.join("plugins").join(format!("coa_{}.dll", e.id.replace('-', "_"))),
root.join("plugins").join(format!("mod-{}.dll", e.id)),
root.join("plugins").join(format!("mod-{}.dll", e.id.replace('-', "_"))),
root.join("plugins").join(format!("mod-coa-{}.dll", e.id)),
root.join("plugins").join(format!("mod_coa_{}.dll", e.id.replace('-', "_"))),
// Subdirectory checks (plugins/{id}/{id}.dll)
root.join("plugins").join(&e.id).join(format!("{}.dll", e.id)),
root.join("plugins").join(format!("coa-{}", e.id)).join(format!("coa-{}.dll", e.id)),
root.join("plugins").join(format!("mod-{}", e.id)).join(format!("mod-{}.dll", e.id)),
root.join("plugins").join(format!("mod-coa-{}", e.id)).join(format!("mod-coa-{}.dll", e.id)),
// .manager/plugins checks
root.join(".manager/plugins").join(format!("{}.dll", e.id)),
root.join(".manager/plugins").join(format!("coa-{}.dll", e.id)),
root.join(".manager/plugins").join(format!("mod-coa-{}.dll", e.id)),
];
dll_candidates.extend(alias_dlls);
let dll_present = dll_candidates.iter().any(|p| p.is_file());
let is_dynamic = plugin_entry.is_some() || dll_present;
// 2. Classify ComponentType and determine installation strictly
let (component_type, installed, can_remove) = if is_dynamic {
(ComponentType::DynamicDll, true, true)
} else if e.id == "custom-races" {
let has_patch = root.join("Data/patch-Z.mpq").is_file()
|| root.join("Data/patch-4.mpq").is_file()
|| root.join("Data/ruRU/patch-ruRU-4.mpq").is_file()
|| root.join("Data/enGB/patch-enGB-4.mpq").is_file()
|| root.join("Data/enUS/patch-enUS-4.mpq").is_file();
(ComponentType::ClientPatch, has_patch, false)
} else if matches!(e.id.as_str(), "tbc-content" | "wotlk-content") {
let is_scaling_installed = {
let se_plugin = plugin_reg.as_ref().and_then(|r| {
r.plugins.get("content-scaling")
.or_else(|| r.plugins.get("content_scaling"))
.or_else(|| r.plugins.get("coa-content-scaling"))
.or_else(|| r.plugins.get("mod-coa-content-scaling"))
});
let se_dll = root.join("plugins").join("content-scaling.dll").is_file()
|| root.join("plugins").join("content-scaling").join("content-scaling.dll").is_file()
|| root.join("plugins").join("coa-content-scaling").join("coa-content-scaling.dll").is_file()
|| root.join("plugins").join("coa-content-scaling.dll").is_file()
|| root.join("plugins").join("mod-coa-content-scaling.dll").is_file()
|| root.join(".manager/plugins").join("content-scaling.dll").is_file()
|| root.join(".manager/plugins").join("coa-content-scaling.dll").is_file()
|| root.join(".manager/plugins").join("mod-coa-content-scaling.dll").is_file();
se_plugin.is_some() || se_dll || (!is_modular_host && (conf.is_file() || dist.is_file()))
};
(ComponentType::ContentPack, is_scaling_installed, false)
} else if e.id == "dungeon-clear" {
let has_files = conf.is_file() || dist.is_file() || installed_commits.contains_key("dungeon-clear");
(if is_modular_host && !has_files { ComponentType::DynamicDll } else { ComponentType::CoreEmbedded }, has_files, false)
} else if !is_modular_host {
let key = match e.id.as_str() {
"companions" => "bots",
"playerbots" => "squid",
"content-scaling" => "scaling",
id => id,
};
let has_files = conf.is_file() || dist.is_file() || installed_commits.contains_key(key);
(ComponentType::CoreEmbedded, has_files, false)
} else {
// In a modular host (with plugins/ directory or plugins.json), if dynamic DLL is not present, it is NOT installed!
(ComponentType::DynamicDll, false, false)
};
let installed = conf.is_file() || dist.is_file();
let has_settings = installed
&& settings_in(cat, root, &e.id)
.map(|settings| settings.iter().any(|s| s.key != e.enable_key))
.unwrap_or(false);
// the active file or plugin registry decides enabled state
let enabled = if !installed {
false
} else if let Some(p) = plugin_entry {
p.enabled
} else if matches!(e.id.as_str(), "companions" | "playerbots") {
let comp_entry = cat.iter().find(|ce| ce.id == "companions");
let comp_on = comp_entry.map(|ce| bot_enabled(root, ce).unwrap_or(false)).unwrap_or(false);
if e.id == "playerbots" {
if comp_on {
false
} else {
bot_enabled(root, &e).unwrap_or(false)
}
} else {
bot_enabled(root, &e).unwrap_or(true)
}
} else if matches!(e.id.as_str(), "tbc-content" | "wotlk-content") {
let sc_entry = cat.iter().find(|entry| entry.id == "content-scaling");
let sc_conf = sc_entry.map(|se| dir(root).join(conf_name(root, se)));
let sc_enabled = sc_conf
.and_then(|p| read(&p))
.and_then(|c| c.get("CoAContentScaling.Enable").map(truthy))
.unwrap_or(true);
sc_enabled && read(&conf)
.or_else(|| read(&dist))
.and_then(|c| c.get(&e.enable_key).map(truthy))
.unwrap_or(e.default_on)
// the active file decides; without one the documented default is what the server will use
let enabled = if matches!(e.id.as_str(), "companions" | "playerbots") {
bot_enabled(root, &e).unwrap_or(true)
} else {
!e.switchable
|| read(&conf)
@@ -388,22 +228,16 @@ fn list_in(cat: &[Entry], root: &Path) -> Vec<ModuleView> {
.and_then(|c| c.get(&e.enable_key).map(truthy))
.unwrap_or(e.default_on)
};
let is_squid_active = {
let comp_entry = cat.iter().find(|ce| ce.id == "companions");
let comp_on = comp_entry.map(|ce| bot_enabled(root, ce).unwrap_or(false)).unwrap_or(false);
if comp_on {
false
} else {
let pb_entry = cat.iter().find(|ce| ce.id == "playerbots");
pb_entry.map(|pe| bot_enabled(root, pe).unwrap_or(false)).unwrap_or(false)
}
};
let dependency_missing = e.id == "dungeon-clear" && !is_squid_active;
let dependency_missing = e.id == "dungeon-clear"
&& entry_in(cat, "playerbots")
.and_then(|entry| bot_enabled(root, &entry))
.map(|enabled| !enabled)
.unwrap_or(true);
let blocked = dependency_missing
|| (wildcard && matches!(e.id.as_str(), "companions" | "playerbots" | "dungeon-clear"));
let version = if let Some(p) = plugin_entry {
Some(p.version.clone())
} else if e.id == "playerbots" {
|| (wildcard
&& (matches!(e.id.as_str(), "playerbots" | "dungeon-clear")
|| (e.id == "companions" && !companions_on_other_realms(root))));
let version = if e.id == "playerbots" {
crate::squid::release(root).map(|release| {
[
release.tag,
@@ -431,8 +265,6 @@ fn list_in(cat: &[Entry], root: &Path) -> Vec<ModuleView> {
} else {
None
};
let source_commit = installed_commits.get(key).cloned();
ModuleView {
version,
compatibility: if dependency_missing {
@@ -457,114 +289,12 @@ fn list_in(cat: &[Entry], root: &Path) -> Vec<ModuleView> {
icon: e.icon,
page: e.page,
hidden: e.hidden,
component_type,
can_remove,
source_commit,
part_of: e.part_of,
}
})
.collect();
// Also include installed dynamic plugins from plugin_reg that aren't already in views
if let Some(ref reg) = plugin_reg {
for (plugin_id, plugin_entry) in &reg.plugins {
let matched_idx = views.iter().position(|v| {
v.id == *plugin_id
|| format!("coa-{}", v.id) == *plugin_id
|| format!("mod-coa-{}", v.id) == *plugin_id
|| format!("mod-{}", v.id) == *plugin_id
|| (v.id == "content-scaling" && matches!(plugin_id.as_str(), "coa-content-scaling" | "mod-coa-content-scaling"))
|| (v.id == "companions" && matches!(plugin_id.as_str(), "coa-playerbots" | "mod-coa-playerbots"))
|| (v.id == "playerbots" && matches!(plugin_id.as_str(), "squid-playerbots" | "mod-playerbots"))
|| (v.id == "ah-bot" && matches!(plugin_id.as_str(), "mod_ahbot" | "ahbot"))
|| (v.id == "npc-buffer" && (plugin_id.contains("buffer") || plugin_entry.conf_files.iter().any(|c| c.contains("npc_buffer"))))
|| (v.id == "npc-enchanter" && (plugin_id.contains("enchanter") || plugin_entry.conf_files.iter().any(|c| c.contains("enchanter"))))
|| (v.id == "congrats-on-level" && (plugin_id.contains("congrats") || plugin_entry.conf_files.iter().any(|c| c.contains("congrats"))))
|| (v.id == "reward-played-time" && (plugin_id.contains("reward") || plugin_entry.conf_files.iter().any(|c| c.contains("reward"))))
});
if let Some(idx) = matched_idx {
// Update existing canonical module entry instead of duplicating
views[idx].installed = true;
views[idx].enabled = plugin_entry.enabled;
views[idx].version = Some(plugin_entry.version.clone());
views[idx].component_type = ComponentType::DynamicDll;
views[idx].can_remove = true;
continue;
}
if true {
let mut display_name = if let Ok(meta) = crate::plugins::load_store_metadata(root, plugin_id, &plugin_entry.sha256) {
meta.name
} else {
String::new()
};
let mut source_commit = None;
if display_name.is_empty() || (display_name.len() == 40 && display_name.chars().all(|c| c.is_ascii_hexdigit())) {
source_commit = Some(plugin_id.clone());
display_name = if plugin_id.len() == 40 && plugin_id.chars().all(|c| c.is_ascii_hexdigit()) {
if plugin_entry.conf_files.iter().any(|c| c.contains("npc_buffer")) {
"NPC Buffer".to_string()
} else if plugin_entry.conf_files.iter().any(|c| c.contains("ah_bot") || c.contains("ahbot")) {
"Auction House Bot".to_string()
} else if plugin_entry.conf_files.iter().any(|c| c.contains("enchanter")) {
"NPC Enchanter".to_string()
} else if plugin_entry.conf_files.iter().any(|c| c.contains("congrats")) {
"Congrats On Level".to_string()
} else if plugin_entry.conf_files.iter().any(|c| c.contains("reward_played_time")) {
"Reward Played Time".to_string()
} else {
format!("Module ({})", &plugin_id[..8])
}
} else if plugin_id == "npc-buffer" {
"NPC Buffer".to_string()
} else if plugin_id == "ah-bot" {
"Auction House Bot".to_string()
} else if plugin_id == "congrats-on-level" {
"Congrats On Level".to_string()
} else if plugin_id == "npc-enchanter" {
"NPC Enchanter".to_string()
} else if plugin_id == "reward-played-time" {
"Reward Played Time".to_string()
} else {
plugin_id.split('-').map(|s| {
let mut c = s.chars();
match c.next() {
None => String::new(),
Some(f) => f.to_uppercase().collect::<String>() + c.as_str(),
}
}).collect::<Vec<_>>().join(" ")
};
}
let mut desc_map = BTreeMap::new();
desc_map.insert("ru".to_string(), format!("Динамический модуль {}", display_name));
desc_map.insert("en".to_string(), format!("Dynamic module {}", display_name));
let has_settings = settings_in(cat, root, plugin_id).map(|s| !s.is_empty()).unwrap_or(false);
views.push(ModuleView {
version: Some(plugin_entry.version.clone()),
compatibility: "compatible".into(),
id: plugin_id.clone(),
name: display_name,
description: desc_map,
repo: format!("https://github.com/azerothcore/{}", plugin_id),
installed: true,
has_settings,
enabled: plugin_entry.enabled,
switchable: true,
status: "release".into(),
icon: "plug".into(),
page: None,
hidden: false,
component_type: ComponentType::DynamicDll,
can_remove: true,
source_commit,
});
}
}
}
views
.collect()
}
/// The active file, created from its `.dist` when it does not exist yet.
fn active_file(root: &Path, e: &Entry) -> Result<PathBuf> {
let name = conf_name(root, e);
@@ -608,10 +338,7 @@ fn require_bot_server_stopped(root: &Path) -> Result<()> {
pub fn set_enabled(root: &Path, meta: &Path, id: &str, on: bool) -> Result<()> {
let _update_lock = crate::update::operation_lock(meta)?;
crate::update::ensure_recovered(meta)?;
let is_dynamic_plugin = crate::plugins::load_registry(root)
.map(|r| r.plugins.contains_key(id))
.unwrap_or(false);
let _lock = if is_dynamic_plugin || matches!(id, "companions" | "playerbots" | "dungeon-clear") {
let _lock = if matches!(id, "companions" | "playerbots" | "dungeon-clear") {
require_bot_server_stopped(root)?;
fs::create_dir_all(root.join(".state"))?;
let lock = fs::OpenOptions::new()
@@ -665,16 +392,6 @@ pub fn set_enabled(root: &Path, meta: &Path, id: &str, on: bool) -> Result<()> {
}
fn bot_enabled(root: &Path, e: &Entry) -> Result<bool> {
if let Ok(reg) = crate::plugins::load_registry(root) {
if let Some(p) = reg.plugins.get(&e.id)
.or_else(|| reg.plugins.get(&format!("coa-{}", e.id)))
.or_else(|| reg.plugins.get(&format!("mod-coa-{}", e.id)))
.or_else(|| reg.plugins.get(&format!("mod-{}", e.id)))
.or_else(|| if e.id == "playerbots" { reg.plugins.get("squid-playerbots") } else { None })
{
return Ok(p.enabled);
}
}
let name = conf_name(root, e);
let conf = dir(root).join(&name);
let dist = dir(root).join(format!("{name}.dist"));
@@ -697,124 +414,59 @@ fn bot_enabled(root: &Path, e: &Entry) -> Result<bool> {
pub fn ensure_bot_exclusivity(root: &Path) -> Result<()> {
let cat = catalog();
let comp_on = entry_in(&cat, "companions").map(|e| bot_enabled(root, &e).unwrap_or(false)).unwrap_or(false);
let pb_on = entry_in(&cat, "playerbots").map(|e| bot_enabled(root, &e).unwrap_or(false)).unwrap_or(false);
if comp_on && pb_on {
if bot_enabled(root, &entry_in(&cat, "companions")?)?
&& bot_enabled(root, &entry_in(&cat, "playerbots")?)?
{
return Err(Error::BotModulesConflict);
}
if comp_on {
let dc_on = entry_in(&cat, "dungeon-clear").map(|e| bot_enabled(root, &e).unwrap_or(false)).unwrap_or(false);
if dc_on {
return Err(Error::Invalid("Dungeon Clear cannot be active while CoA Companions is enabled.".into()));
}
}
Ok(())
}
fn set_enabled_in(cat: &[Entry], root: &Path, meta: &Path, id: &str, on: bool) -> Result<()> {
match entry_in(cat, id) {
Ok(e) => {
if on && id == "dungeon-clear" {
let comp_entry = cat.iter().find(|ce| ce.id == "companions");
let comp_on = comp_entry.map(|ce| bot_enabled(root, ce).unwrap_or(false)).unwrap_or(false);
let pb_entry = entry_in(cat, "playerbots");
let squid_on = !comp_on && pb_entry.as_ref().map(|pe| bot_enabled(root, pe).unwrap_or(false)).unwrap_or(false);
if !squid_on {
return Err(Error::Invalid("Enable SQUID bots before enabling Dungeon Clear.".into()));
}
let e = entry_in(cat, id)?;
if on && id == "dungeon-clear" && !bot_enabled(root, &entry_in(cat, "playerbots")?)? {
return Err(Error::Invalid("Enable SQUID bots before enabling Dungeon Clear.".into()));
}
if !e.switchable || e.enable_key.is_empty() {
return Err(Error::Invalid("This part cannot be switched off.".into()));
}
if on && matches!(id, "companions" | "playerbots") {
let other = if id == "companions" {
"playerbots"
} else {
"companions"
};
if let Some(other) = cat.iter().find(|e| e.id == other) {
if bot_enabled(root, other)? {
return Err(Error::BotModulesConflict);
}
if !e.switchable || e.enable_key.is_empty() {
return Err(Error::Invalid("This part cannot be switched off.".into()));
}
if on && matches!(id, "companions" | "playerbots") {
let other = if id == "companions" {
"playerbots"
} else {
"companions"
};
if let Some(other) = cat.iter().find(|e| e.id == other) {
if bot_enabled(root, other)? {
return Err(Error::BotModulesConflict);
}
}
}
if (id == "playerbots" && !on) || (id == "companions" && on) {
if let Some(dependency) = cat.iter().find(|entry| entry.id == "dungeon-clear") {
let conf_path = dir(root).join(&dependency.conf);
let dist_path = dir(root).join(format!("{}.dist", dependency.conf));
if conf_path.exists() || dist_path.exists() {
let _ = set_enabled_in(cat, root, meta, "dungeon-clear", false);
}
}
}
let conf = active_file(root, &e)?;
let mut file = ConfFile::parse_bytes(&fs::read(&conf)?)?;
if file.get(&e.enable_key).map(truthy).unwrap_or(e.default_on) == on
&& file.get(&e.enable_key).is_some()
{
return Ok(());
}
backup(meta, &conf)?;
file.set(
&e.enable_key,
if on { "1" } else { "0" },
&["Changed by CoA Server Manager"],
);
fsx::atomic_write(&conf, file.to_text().as_bytes())?;
// If registered as a dynamic plugin, synchronize plugins.lock and plugin state
if let Ok(reg) = crate::plugins::load_registry(root) {
if reg.plugins.contains_key(id) {
let _ = crate::plugins::set_enabled(root, id, on);
}
}
if id == "playerbots" && on {
let _ = crate::plugins::record_squid_migrations_applied(root);
}
tracing::info!(module = id, on, "module switched");
Ok(())
}
Err(_) => {
// Dynamic plugin / module fallback
let mut found_conf = false;
if let Some((conf, dist_opt)) = find_conf_for_id(root, id) {
if !conf.is_file() {
if let Some(d) = dist_opt {
let _ = fsx::atomic_write(&conf, &fs::read(d)?);
}
}
if conf.is_file() {
if let Ok(mut file) = ConfFile::parse_bytes(&fs::read(&conf)?) {
let enable_key = file.entries().into_iter()
.find(|(k, _)| k.ends_with(".Enable") || k.ends_with(".Enabled"))
.map(|(k, _)| k.to_string());
if let Some(k) = enable_key {
let _ = backup(meta, &conf);
file.set(&k, if on { "1" } else { "0" }, &["Changed by CoA Server Manager"]);
let _ = fsx::atomic_write(&conf, file.to_text().as_bytes());
found_conf = true;
}
}
}
}
if let Ok(reg) = crate::plugins::load_registry(root) {
if reg.plugins.contains_key(id) {
crate::plugins::set_enabled(root, id, on)?;
if (id == "playerbots" && !on) || (id == "companions" && on) {
if cat.iter().any(|entry| entry.id == "dungeon-clear") {
let _ = set_enabled_in(cat, root, meta, "dungeon-clear", false);
}
}
return Ok(());
}
}
if found_conf {
return Ok(());
}
Err(Error::Invalid("That module is not known to the Manager.".into()))
}
}
if (id == "playerbots" && !on) || (id == "companions" && on) {
if let Some(dependency) = cat.iter().find(|entry| entry.id == "dungeon-clear") {
if dir(root).join(&dependency.conf).exists()
|| dir(root).join(format!("{}.dist", dependency.conf)).exists()
{
set_enabled_in(cat, root, meta, "dungeon-clear", false)?;
}
}
}
let conf = active_file(root, &e)?;
let mut file = ConfFile::parse_bytes(&fs::read(&conf)?)?;
if file.get(&e.enable_key).map(truthy).unwrap_or(e.default_on) == on
&& file.get(&e.enable_key).is_some()
{
return Ok(());
}
backup(meta, &conf)?;
file.set(
&e.enable_key,
if on { "1" } else { "0" },
&["Changed by CoA Server Manager"],
);
fsx::atomic_write(&conf, file.to_text().as_bytes())?;
tracing::info!(module = id, on, "module switched");
Ok(())
}
#[derive(Debug, Serialize, PartialEq)]
@@ -833,19 +485,10 @@ pub fn settings(root: &Path, id: &str) -> Result<Vec<Setting>> {
}
fn settings_in(cat: &[Entry], root: &Path, id: &str) -> Result<Vec<Setting>> {
let (conf, dist) = match entry_in(cat, id) {
Ok(e) => {
let name = conf_name(root, &e);
(dir(root).join(&name), read(&dir(root).join(format!("{name}.dist"))))
}
Err(_) => {
if let Some((c, d_opt)) = find_conf_for_id(root, id) {
(c, d_opt.and_then(|d| read(&d)))
} else {
return Err(Error::Invalid("This module is not part of this server.".into()));
}
}
};
let e = entry_in(cat, id)?;
let name = conf_name(root, &e);
let conf = dir(root).join(&name);
let dist = read(&dir(root).join(format!("{name}.dist")));
let active = read(&conf)
.or_else(|| dist.clone())
.ok_or_else(|| Error::Invalid("This module is not part of this server.".into()))?;
@@ -918,32 +561,10 @@ fn save_settings_in(
id: &str,
changes: &BTreeMap<String, String>,
) -> Result<Vec<String>> {
let (conf, dist, switchable, enable_key) = match entry_in(cat, id) {
Ok(e) => {
let conf = active_file(root, &e)?;
let dist = read(&dir(root).join(format!("{}.dist", conf_name(root, &e))));
(conf, dist, e.switchable, e.enable_key)
}
Err(_) => {
if let Some((c, d_opt)) = find_conf_for_id(root, id) {
if !c.is_file() {
if let Some(ref d) = d_opt {
fsx::atomic_write(&c, &fs::read(d)?)?;
} else {
return Err(Error::Invalid("This module is not part of this server.".into()));
}
}
let dist = d_opt.and_then(|d| read(&d));
let enable_k = dist.as_ref()
.and_then(|d| d.entries().into_iter().find(|(k, _)| k.ends_with(".Enable") || k.ends_with(".Enabled")).map(|(k, _)| k.to_string()))
.unwrap_or_default();
(c, dist, true, enable_k)
} else {
return Err(Error::Invalid("This module is not part of this server.".into()));
}
}
};
let e = entry_in(cat, id)?;
let conf = active_file(root, &e)?;
let mut file = ConfFile::parse_bytes(&fs::read(&conf)?)?;
let dist = read(&dir(root).join(format!("{}.dist", conf_name(root, &e))));
let fields = if id == "playerbots" {
crate::squid::fields(root)?
} else {
@@ -969,7 +590,7 @@ fn save_settings_in(
if let Some(field) = fields.get(key) {
crate::squid::validate(field, value)?;
}
if switchable && !enable_key.is_empty() && key == &enable_key {
if e.switchable && key == &e.enable_key {
return Err(Error::Invalid(
"Use the module switch to turn this module on or off.".into(),
));
@@ -1129,6 +750,27 @@ mod tests {
assert!(meta.join("backups").exists());
}
#[test]
fn companions_open_on_other_realms_only_with_a_build_that_plays_them() {
let temp = tempfile::tempdir().unwrap();
let root = temp.path().join("server");
fs::create_dir_all(dir(&root)).unwrap();
fs::create_dir_all(root.join("Settings")).unwrap();
fs::write(root.join("Settings/realm-profile.json"), r#"{"active":"wildcard","wildcard_created":true}"#).unwrap();
for e in catalog().iter().filter(|e| matches!(e.id.as_str(), "companions" | "playerbots")) {
fs::write(dir(&root).join(format!("{}.dist", e.conf)), format!("{} = 0\n", e.enable_key)).unwrap();
}
let exe = crate::layout::executables(&root).0;
fs::write(&exe, b"an old world server").unwrap();
let view = |id: &str| list(&root).into_iter().find(|m| m.id == id).unwrap();
assert_eq!(view("companions").compatibility, "unsupported");
fs::write(&exe, b"profiles ... Druid_Guardian_Tank ... a new world server").unwrap();
assert!(companions_on_other_realms(&root));
assert_eq!(view("companions").compatibility, "experimental");
assert!(view("companions").switchable);
assert_eq!(view("playerbots").compatibility, "unsupported", "SQUID stays CoA-only");
}
fn test_catalog() -> Vec<Entry> {
let one = |id: &str, name: &str, conf: &str, key: &str| Entry {
id: id.into(),
@@ -1147,6 +789,7 @@ mod tests {
icon: String::new(),
page: None,
hidden: false,
part_of: None,
};
vec![
one(
@@ -1792,6 +1435,7 @@ mod tests {
icon: String::new(),
page: None,
hidden: false,
part_of: None,
};
let cat = vec![compat];
let v = list_in(&cat, &root).remove(0);
@@ -1914,33 +1558,4 @@ mod tests {
"0"
);
}
#[test]
fn dynamic_plugin_settings_and_enable_roundtrip() {
let d = tempfile::tempdir().unwrap();
let (root, meta) = server(d.path());
fs::write(
dir(&root).join("npc_buffer.conf.dist"),
"# Enable NPC Buffer\nNpcBuffer.Enable = 1\n# Cost of buff\nNpcBuffer.Cost = 500\n",
)
.unwrap();
let cat = catalog();
let s = settings_in(&cat, &root, "npc-buffer").unwrap();
assert_eq!(s.len(), 2);
let cost = s.iter().find(|item| item.key == "NpcBuffer.Cost").unwrap();
assert_eq!(cost.value, "500");
assert_eq!(cost.doc, "Cost of buff");
let change = BTreeMap::from([("NpcBuffer.Cost".to_string(), "1000".to_string())]);
let saved = save_settings_in(&cat, &root, &meta, "npc-buffer", &change).unwrap();
assert_eq!(saved, ["NpcBuffer.Cost"]);
let conf_content = fs::read_to_string(dir(&root).join("npc_buffer.conf")).unwrap();
assert!(conf_content.contains("NpcBuffer.Cost = 1000"));
set_enabled_in(&cat, &root, &meta, "npc-buffer", false).unwrap();
let conf_content = fs::read_to_string(dir(&root).join("npc_buffer.conf")).unwrap();
assert!(conf_content.contains("NpcBuffer.Enable = 0"));
}
}
-146
View File
@@ -1,146 +0,0 @@
//! Installs the C++ compiler that plugins must be built with.
//!
//! A plugin loads only into a core built by the same MSVC, to the build number (it is part of the ABI
//! fingerprint). The core is built with the MSVC 14.44 toolset of the stable Visual Studio channel, so
//! the Manager installs exactly that: Microsoft's own Build Tools bootstrapper, downloaded from Microsoft
//! and checked to be signed by Microsoft, with the components preselected. The person accepts Microsoft's
//! terms in Microsoft's installer window; nothing is bundled or installed silently.
use std::path::{Path, PathBuf};
use std::process::Command;
use serde::Serialize;
use crate::build_engine::{detect_toolchain_for, ToolchainStatus};
use crate::error::{Error, Result};
/// The stable-channel Build Tools bootstrapper (Visual Studio 18). Its MSVC 14.44 side-by-side toolset has
/// the same compiler build as the CI image the core is built on.
pub const BOOTSTRAPPER_URL: &str = "https://aka.ms/vs/18/stable/vs_buildtools.exe";
/// The toolset alone has no environment script; the core build tools and the Windows SDK complete it.
pub const COMPONENTS: [&str; 4] = [
"Microsoft.VisualStudio.Component.VC.14.44.17.14.x86.x64",
"Microsoft.VisualStudio.Component.VC.CoreBuildTools",
"Microsoft.VisualStudio.Component.Windows11SDK.26100",
"Microsoft.VisualStudio.Component.VC.CMake.Project",
];
#[derive(Debug, Clone, Serialize)]
pub struct MsvcSetupOutcome {
/// The installer finished and the toolchain now matches the core.
pub ready: bool,
pub restart_required: bool,
pub message: String,
pub toolchain: ToolchainStatus,
}
/// An installed Visual Studio 18 Build Tools instance, which the installer modifies instead of adding a
/// second one.
fn existing_build_tools() -> Option<PathBuf> {
let pf86 = std::env::var("ProgramFiles(x86)").unwrap_or_else(|_| "C:\\Program Files (x86)".into());
let vswhere = Path::new(&pf86).join("Microsoft Visual Studio").join("Installer").join("vswhere.exe");
let mut cmd = Command::new(vswhere);
cmd.args(["-products", "Microsoft.VisualStudio.Product.BuildTools", "-version", "[18.0,19.0)",
"-property", "installationPath", "-utf8"]);
hide_window(&mut cmd);
let out = cmd.output().ok()?;
String::from_utf8_lossy(&out.stdout).lines().map(str::trim).find(|l| !l.is_empty()).map(PathBuf::from)
.filter(|p| p.is_dir())
}
fn hide_window(cmd: &mut Command) {
#[cfg(windows)]
{
use std::os::windows::process::CommandExt;
cmd.creation_flags(0x0800_0000);
}
#[cfg(not(windows))]
let _ = cmd;
}
const SCRIPT: &str = r#"param([string]$Dir, [string]$Url, [string]$InstallPath, [string]$Components)
$ErrorActionPreference = 'Stop'
$ProgressPreference = 'SilentlyContinue'
New-Item -ItemType Directory -Force -Path $Dir | Out-Null
$bt = Join-Path $Dir 'vs_buildtools.exe'
try { Invoke-WebRequest -UseBasicParsing -Uri $Url -OutFile $bt } catch { "RESULT=download-failed $($_.Exception.Message)"; exit 0 }
$sig = Get-AuthenticodeSignature -FilePath $bt
if ($sig.Status -ne 'Valid' -or $sig.SignerCertificate.Subject -notmatch 'O=Microsoft Corporation') {
Remove-Item $bt -Force
"RESULT=bad-signature $($sig.Status)"; exit 0
}
$a = @()
if ($InstallPath) { $a += @('modify', '--installPath', ('"' + $InstallPath + '"')) }
$a += @('--wait', '--norestart', '--nocache')
foreach ($c in $Components.Split(',')) { $a += @('--add', $c) }
try { $p = Start-Process -FilePath $bt -ArgumentList $a -Wait -PassThru } catch { "RESULT=not-started $($_.Exception.Message)"; exit 0 }
"RESULT=exit $($p.ExitCode)"
"#;
/// Runs Microsoft's installer and reports whether plugins can now be built for `realm_root`'s core.
/// Blocks until the installer window is closed.
pub fn install_build_tools(realm_root: Option<&Path>) -> Result<MsvcSetupOutcome> {
if !cfg!(windows) {
return Err(Error::Invalid("The C++ Build Tools installer is only available on Windows.".into()));
}
let dir = std::env::temp_dir().join("coa-msvc-setup");
std::fs::create_dir_all(&dir)?;
let script = dir.join("install-build-tools.ps1");
std::fs::write(&script, SCRIPT)?;
let install_path = existing_build_tools().map(|p| p.to_string_lossy().into_owned()).unwrap_or_default();
let mut cmd = Command::new("powershell.exe");
cmd.args(["-NoProfile", "-NonInteractive", "-ExecutionPolicy", "Bypass", "-File"])
.arg(&script)
.args(["-Dir"]).arg(dir.join("bootstrapper"))
.args(["-Url", BOOTSTRAPPER_URL, "-InstallPath", &install_path, "-Components", &COMPONENTS.join(",")]);
hide_window(&mut cmd);
let out = cmd.output()?;
let text = String::from_utf8_lossy(&out.stdout);
let result = text.lines().find_map(|l| l.trim().strip_prefix("RESULT=")).unwrap_or("").to_string();
let (installed, restart, message) = interpret(&result, &String::from_utf8_lossy(&out.stderr));
let toolchain = detect_toolchain_for(realm_root);
let ready = installed && toolchain.ready;
let message = if installed && !toolchain.ready {
format!("The installer finished, but the compiler still does not match this core: {}", toolchain.diagnostic_message)
} else {
message
};
Ok(MsvcSetupOutcome { ready, restart_required: restart, message, toolchain })
}
/// (installed, restart required, message) for the script's result line.
fn interpret(result: &str, stderr: &str) -> (bool, bool, String) {
let (kind, detail) = result.split_once(' ').unwrap_or((result, ""));
match (kind, detail.trim()) {
("exit", "0") => (true, false, "Visual Studio Build Tools with MSVC 14.44 are installed.".into()),
("exit", "3010") => (true, true, "Visual Studio Build Tools are installed; Windows needs a restart before modules can be built.".into()),
("exit", "1602") | ("exit", "1223") => (false, false, "The installation was cancelled.".into()),
("exit", "8006") => (false, false, "Close Visual Studio and its installer, then try again.".into()),
("exit", code) => (false, false, format!("The Visual Studio installer stopped with code {code}.")),
("bad-signature", s) => (false, false, format!("The downloaded installer is not signed by Microsoft ({s}); it was deleted and not run.")),
("download-failed", why) => (false, false, format!("The Visual Studio installer could not be downloaded: {why}")),
("not-started", why) => (false, false, format!("The Visual Studio installer could not be started: {why}")),
_ => (false, false, format!("The installer script failed: {}", stderr.lines().next().unwrap_or("no output"))),
}
}
#[cfg(test)]
mod tests {
use super::*;
#[test]
fn installer_results_are_explained() {
assert!(interpret("exit 0", "").0);
assert_eq!(interpret("exit 3010", "").1, true);
assert!(!interpret("exit 1602", "").0);
assert!(interpret("bad-signature NotSigned", "").2.contains("not signed by Microsoft"));
assert!(interpret("", "boom").2.contains("boom"));
}
#[test]
fn the_components_name_the_pinned_toolset() {
assert!(COMPONENTS.iter().any(|c| c.contains("VC.14.44")));
assert!(BOOTSTRAPPER_URL.starts_with("https://aka.ms/vs/18/stable/"));
}
}
+70 -28
View File
@@ -97,6 +97,58 @@ pub fn world_root(main: &Path, mode: Mode) -> PathBuf {
.map_or_else(|| main.to_path_buf(), |t| tree_root(main, t))
}
#[derive(Debug, Clone)]
pub struct BotOperationTarget {
pub world_root: PathBuf,
pub chars_db: &'static str,
pub ra_port: u16,
pub running: bool,
pub realm: Mode,
}
pub fn resolve_bot_operation_target(main: &Path, realm: Mode) -> Result<BotOperationTarget> {
let state = realms::state(main)?;
let chars_db = realm.schema("characters")?;
if realm == state.active {
let ports = crate::layout::read_ports(main);
let ra_port = ports.ra;
let status = process::observe(main, &ports);
let running = status.world.state != ServiceState::Stopped;
return Ok(BotOperationTarget {
world_root: main.to_path_buf(),
chars_db,
ra_port,
running,
realm,
});
}
let tree = Tree::ALL
.into_iter()
.find(|t| t.enabled(&state) && t.mode(state.active) == realm)
.ok_or_else(|| Error::Invalid(format!("Realm {} is not enabled in multiworld configuration.", realm.label())))?;
let root = tree_root(main, tree);
if !root.exists() {
return Err(Error::Invalid(format!("Multiworld directory for {} does not exist: {}", realm.label(), root.display())));
}
let ports = crate::layout::read_ports(&root);
let (_, default_ra) = tree.ports(&state);
let ra_port = if ports.ra != 0 { ports.ra } else { default_ra.unwrap_or(3444) };
let status = process::observe(&root, &ports);
let running = status.world.state != ServiceState::Stopped;
Ok(BotOperationTarget {
world_root: root,
chars_db,
ra_port,
running,
realm,
})
}
/// Any of the extra worlds is running or still stopping.
pub fn is_running(main: &Path) -> bool {
Tree::ALL.into_iter().any(|t| tree_running(main, t))
@@ -176,7 +228,6 @@ fn set_tree(main: &Path, tree: Tree, enabled: bool) -> Result<realms::View> {
}
}
}
secondary_launcher(&fs::read_to_string(main.join("Scripts/manage.py"))?)?;
}
let status = process::observe(main, &crate::layout::read_ports(main));
if status.world.state != ServiceState::Stopped
@@ -262,6 +313,12 @@ fn prepare(main: &Path, tree: Tree) -> Result<PathBuf> {
&fsx::ensure_within(&second, &second.join("Core/reference"))?,
)?;
}
if main.join("Core/plugins").is_dir() {
copy_tree(
&main.join("Core/plugins"),
&fsx::ensure_within(&second, &second.join("Core/plugins"))?,
)?;
}
for entry in fs::read_dir(main.join("Core"))? {
let entry = entry?;
if entry.file_type()?.is_file()
@@ -349,25 +406,18 @@ fn prepare(main: &Path, tree: Tree) -> Result<PathBuf> {
..Default::default()
},
)?;
let source = fs::read_to_string(main.join("Scripts/manage.py"))?;
let source = secondary_launcher(&source)?;
fsx::atomic_write(&second.join("Scripts/manage.py"), source.as_bytes())?;
Ok(second)
}
fn secondary_launcher(source: &str) -> Result<String> {
let marker = "def start_world(config, offset):\n start_mysql(config)";
let source = source.replace("\r\n", "\n");
if !source.contains(marker) {
return Err(Error::Invalid(
"The launcher does not support a shared database world. Update the server first."
.into(),
));
// The world supervisor and the bug-report relay of the extra world (the launcher itself runs in the Manager
// and knows that this world shares the main database).
for script in ["Scripts/coa-launcher.exe", "Scripts/manage.py"] {
let target = second.join(script);
if main.join(script).is_file() {
fs::create_dir_all(second.join("Scripts"))?;
fsx::atomic_write(&target, &fs::read(main.join(script))?)?;
} else if target.exists() {
fs::remove_file(&target)?;
}
}
Ok(source.replace(
marker,
"def start_world(config, offset):\n mysql(admin=\"ping\")",
))
Ok(second)
}
fn start_tree(main: &Path, tree: Tree) -> Result<()> {
@@ -408,7 +458,7 @@ pub fn start(main: &Path) -> Result<()> {
fn stop_tree(main: &Path, tree: Tree) -> Result<()> {
let second = tree_root(main, tree);
if !second.join("Scripts/manage.py").exists() {
if !second.join("Settings/repack.json").exists() {
if tree_running(main, tree) {
return Err(Error::Invalid(format!(
"The running {}'s launcher is missing. The shared database was left running.",
@@ -505,12 +555,4 @@ mod tests {
assert!(err.contains(expected), "{err}");
assert!(!realms::state(t.path()).unwrap().with_reborn);
}
#[test]
fn secondary_never_starts_the_shared_database() {
let patched = secondary_launcher("def start_world(config, offset):\r\n start_mysql(config)\r\n wait_ready('world', 8086)\r\n").unwrap();
assert!(patched.contains("mysql(admin=\"ping\")"));
assert!(!patched.contains("start_mysql(config)"));
assert!(secondary_launcher("def start_world(): pass").is_err());
}
}
File diff suppressed because it is too large. Load diff
+27 -10
View File
@@ -49,17 +49,19 @@ fn parse_counts(out: &str) -> Result<Population> {
})
}
/// Read-only query with the game's own database account. Requires the database to be running.
/// Read-only query with the game's own database account. Routes automatically to the active realm's characters database.
pub fn query(root: &Path) -> Result<Population> {
let db = Db::from_repack(root, Account::App)?;
query_with(
&db,
&bot_account_prefix(root),
&crate::accounts::squid_bot_prefix(root),
)
let mode = crate::realms::state(root)
.map(|s| s.active)
.unwrap_or(crate::realms::Mode::Coa);
query_for_realm(root, mode)
}
fn counts_sql(prefix: &str, squid_prefix: &str) -> Result<String> {
counts_sql_for_db("acore_characters", prefix, squid_prefix)
}
pub fn counts_sql_for_db(chars_db: &str, prefix: &str, squid_prefix: &str) -> Result<String> {
if [prefix, squid_prefix]
.iter()
.any(|prefix| prefix.is_empty() || !prefix.chars().all(|c| c.is_ascii_alphanumeric()))
@@ -74,9 +76,9 @@ fn counts_sql(prefix: &str, squid_prefix: &str) -> Result<String> {
let bots =
format!("(UPPER(a.username) LIKE '{prefix}%' OR UPPER(a.username) LIKE '{squid_prefix}%')");
Ok(format!(
"SELECT (SELECT COUNT(*) FROM acore_characters.characters WHERE online=1), \
(SELECT COUNT(*) FROM acore_characters.characters c JOIN acore_auth.account a ON a.id=c.account WHERE c.online=1 AND {bots}), \
(SELECT COUNT(*) FROM acore_characters.characters c JOIN acore_auth.account a ON a.id=c.account WHERE {bots});"
"SELECT (SELECT COUNT(*) FROM {chars_db}.characters WHERE online=1), \
(SELECT COUNT(*) FROM {chars_db}.characters c JOIN acore_auth.account a ON a.id=c.account WHERE c.online=1 AND {bots}), \
(SELECT COUNT(*) FROM {chars_db}.characters c JOIN acore_auth.account a ON a.id=c.account WHERE {bots});"
))
}
@@ -85,6 +87,21 @@ pub fn query_with(db: &Db, prefix: &str, squid_prefix: &str) -> Result<Populatio
parse_counts(&db.query(&counts_sql(prefix, squid_prefix)?)?)
}
pub fn query_for_schema(db: &Db, chars_db: &str, prefix: &str, squid_prefix: &str) -> Result<Population> {
parse_counts(&db.query(&counts_sql_for_db(chars_db, prefix, squid_prefix)?)?)
}
pub fn query_for_realm(root: &Path, mode: crate::realms::Mode) -> Result<Population> {
let db = Db::from_repack(root, Account::App)?;
let schema = mode.schema("characters")?;
query_for_schema(
&db,
schema,
&bot_account_prefix(root),
&crate::accounts::squid_bot_prefix(root),
)
}
#[derive(Debug, Clone, Serialize)]
pub struct Hardware {
pub cores: u32,
-297
View File
@@ -1,297 +0,0 @@
//! CSM Modules Preview Orchestration Layer.
//!
//! Provides the end-to-end workflows for:
//! - Automated Toolchain discovery
//! - GitHub module intake and compatibility qualification
//! - Controlled Build Engine execution
//! - Transactional plugin installation with Stop-Gate and SQL Review Gate
//! - Plugin lifecycle operations (enable, disable, remove, repair)
//! - Sanitized diagnostic report generation
use std::collections::BTreeMap;
use std::fs;
use std::path::Path;
use serde::{Deserialize, Serialize};
use sha2::{Digest, Sha256};
use crate::analyzer::{CompatibilityReport, SqlFileAudit};
use crate::error::{Error, Result};
use crate::plugins::{install, load_registry, remove, require_server_stopped, set_enabled, PluginMetadata};
#[derive(Debug, Clone, Serialize, Deserialize)]
pub struct SqlReviewPlan {
pub module_id: String,
pub total_sql_files: usize,
pub files: Vec<SqlFileAudit>,
pub target_schemas: Vec<String>,
pub contains_schema_mutations: bool,
pub warning: String,
pub user_confirmation_required: bool,
}
#[derive(Debug, Clone, Serialize, Deserialize)]
pub struct PreviewInstallResult {
pub success: bool,
pub module_id: String,
pub display_name: String,
pub enabled: bool,
pub sql_applied: bool,
pub message: String,
pub sql_plan: Option<SqlReviewPlan>,
}
#[derive(Debug, Clone, Serialize, Deserialize)]
pub struct InstalledPreviewPluginView {
pub id: String,
pub name: String,
pub version: String,
pub enabled: bool,
pub sha256: String,
pub store_path: String,
pub conf_files: Vec<String>,
#[serde(default)]
pub source_commit: Option<String>,
}
/// Lists all dynamically installed plugins for a realm from .manager/plugins.json.
pub fn list_installed_preview_plugins(realm_root: &Path) -> Result<Vec<InstalledPreviewPluginView>> {
let reg = load_registry(realm_root)?;
let mut views = Vec::new();
for (id, entry) in reg.plugins {
let mut display_name = id.clone();
let mut source_commit = None;
// Attempt to read display_name or metadata from plugin.json in store
let store_dir = realm_root.join(".manager").join(&entry.store_path);
let plugin_json_path = store_dir.join("plugin.json");
if plugin_json_path.is_file() {
if let Ok(content) = fs::read_to_string(&plugin_json_path) {
if let Ok(val) = serde_json::from_str::<serde_json::Value>(&content) {
if let Some(dn) = val.get("display_name").and_then(|v| v.as_str()) {
display_name = dn.to_string();
} else if let Some(n) = val.get("name").and_then(|v| v.as_str()) {
if n.len() != 40 || !n.chars().all(|c| c.is_ascii_hexdigit()) {
display_name = n.to_string();
}
}
if let Some(sc) = val.get("source_commit").and_then(|v| v.as_str()) {
source_commit = Some(sc.to_string());
}
}
}
}
// If still a 40-char SHA, resolve via known configs or loader
if display_name.len() == 40 && display_name.chars().all(|c| c.is_ascii_hexdigit()) {
source_commit = Some(display_name.clone());
if entry.conf_files.iter().any(|c| c.contains("npc_buffer")) {
display_name = "NPC Buffer".to_string();
} else if entry.conf_files.iter().any(|c| c.contains("ah_bot") || c.contains("ahbot")) {
display_name = "Auction House Bot".to_string();
} else if entry.conf_files.iter().any(|c| c.contains("enchanter")) {
display_name = "NPC Enchanter".to_string();
} else if entry.conf_files.iter().any(|c| c.contains("congrats")) {
display_name = "Congrats On Level".to_string();
} else if entry.conf_files.iter().any(|c| c.contains("reward_played_time")) {
display_name = "Reward Played Time".to_string();
} else {
display_name = format!("Module ({})", &display_name[..8]);
}
}
views.push(InstalledPreviewPluginView {
id,
name: display_name,
version: entry.version,
enabled: entry.enabled,
sha256: entry.sha256,
store_path: entry.store_path,
conf_files: entry.conf_files,
source_commit,
});
}
Ok(views)
}
/// Generates an SQL review plan for a given module source directory.
pub fn plan_sql_review(module_id: &str, report: &CompatibilityReport) -> Option<SqlReviewPlan> {
if report.sql_files.is_empty() {
return None;
}
let mut schemas = Vec::new();
let mut mutations = false;
for s in &report.sql_files {
if !schemas.contains(&s.target_schema) {
schemas.push(s.target_schema.clone());
}
if s.has_create_table || s.has_alter_table {
mutations = true;
}
}
Some(SqlReviewPlan {
module_id: module_id.to_string(),
total_sql_files: report.sql_files.len(),
files: report.sql_files.clone(),
target_schemas: schemas,
contains_schema_mutations: mutations,
warning: if mutations {
"Module contains DDL schema mutations (CREATE/ALTER TABLE). DDL cannot be rolled back via standard transactions. Verify against test database before proceeding.".into()
} else {
"Module contains DML data inserts or queries.".into()
},
user_confirmation_required: true,
})
}
/// A module the build engine packaged into `.manager/plugin-store/<id>/<version>`: its metadata, DLL and
/// configuration templates, ready for the registry.
pub fn built_package(realm_root: &Path, module_id: &str, version: &str) -> Result<(PluginMetadata, Vec<u8>, Vec<(String, Vec<u8>)>)> {
let store_dir = realm_root.join(".manager").join("plugin-store").join(module_id).join(version);
let dll_name = format!("{}.dll", module_id);
let dll_path = store_dir.join(&dll_name);
if !dll_path.is_file() {
return Err(Error::Invalid(format!(
"Plugin package DLL not found in store: {}", dll_path.display()
)));
}
let dll_bytes = fs::read(&dll_path)?;
let mut hasher = Sha256::new();
hasher.update(&dll_bytes);
let sha256 = format!("{:x}", hasher.finalize());
// Resolve human-readable display_name from plugin.json if available
let plugin_json_path = store_dir.join("plugin.json");
let mut display_name = module_id.to_string();
if plugin_json_path.is_file() {
if let Ok(content) = fs::read_to_string(&plugin_json_path) {
if let Ok(val) = serde_json::from_str::<serde_json::Value>(&content) {
if let Some(dn) = val.get("display_name").and_then(|v| v.as_str()) {
display_name = dn.to_string();
} else if let Some(n) = val.get("name").and_then(|v| v.as_str()) {
if n.len() != 40 || !n.chars().all(|c| c.is_ascii_hexdigit()) {
display_name = n.to_string();
}
}
}
}
}
// Collect dist confs
let mut dist_confs = Vec::new();
if let Ok(entries) = fs::read_dir(&store_dir) {
for entry in entries.flatten() {
let p = entry.path();
if p.extension().map(|e| e == "dist").unwrap_or(false) {
if let Ok(bytes) = fs::read(&p) {
let name = p.file_name().unwrap().to_string_lossy().into_owned();
dist_confs.push((name, bytes));
}
}
}
}
if display_name.len() == 40 && display_name.chars().all(|c| c.is_ascii_hexdigit()) {
if dist_confs.iter().any(|(n, _)| n.contains("npc_buffer")) {
display_name = "NPC Buffer".to_string();
} else if dist_confs.iter().any(|(n, _)| n.contains("ah_bot") || n.contains("ahbot")) {
display_name = "Auction House Bot".to_string();
} else if dist_confs.iter().any(|(n, _)| n.contains("enchanter")) {
display_name = "NPC Enchanter".to_string();
} else if dist_confs.iter().any(|(n, _)| n.contains("congrats")) {
display_name = "Congrats On Level".to_string();
} else if dist_confs.iter().any(|(n, _)| n.contains("reward_played_time")) {
display_name = "Reward Played Time".to_string();
} else {
display_name = format!("Module ({})", &display_name[..8]);
}
}
let meta = PluginMetadata {
id: module_id.to_string(),
name: display_name.clone(),
version: version.to_string(),
description: BTreeMap::new(),
sha256,
required: false,
deps: vec![],
conf_files: dist_confs.iter().map(|(n, _)| n.clone()).collect(),
enable_key: None,
status: Some("release".into()),
icon: None,
};
Ok((meta, dll_bytes, dist_confs))
}
/// Installs a qualified build package into the realm's Plugin Store and enables it.
/// Enforces Stop-Gate and SQL Review Gate.
pub fn install_qualified_module(
realm_root: &Path,
module_id: &str,
version: &str,
apply_sql: bool,
sql_plan: Option<&SqlReviewPlan>,
) -> Result<PreviewInstallResult> {
// 1. Enforce Stop-Gate
require_server_stopped(realm_root)?;
// 2. Check SQL Review Gate
if let Some(plan) = sql_plan {
if !apply_sql && plan.total_sql_files > 0 {
return Ok(PreviewInstallResult {
success: false,
module_id: module_id.to_string(),
display_name: module_id.to_string(),
enabled: false,
sql_applied: false,
message: "SQL Review required before activating module. User confirmation needed.".into(),
sql_plan: Some(plan.clone()),
});
}
}
// 3. Locate package in plugin store
let (meta, dll_bytes, dist_confs) = built_package(realm_root, module_id, version)?;
let display_name = meta.name.clone();
let dist_confs_ref: Vec<(String, &[u8])> = dist_confs.iter().map(|(n, b)| (n.clone(), b.as_slice())).collect();
// 4. Execute transactional install into store & enable in plugins.lock
install(realm_root, meta, &dll_bytes, None, &dist_confs_ref, true)?;
Ok(PreviewInstallResult {
success: true,
module_id: module_id.to_string(),
display_name: display_name.clone(),
enabled: true,
sql_applied: apply_sql,
message: format!("Plugin '{}' v{} installed and enabled successfully in test realm.", display_name, version),
sql_plan: None,
})
}
/// Toggles a module's enabled state with Stop-Gate protection.
pub fn toggle_preview_module(realm_root: &Path, module_id: &str, enable: bool) -> Result<String> {
require_server_stopped(realm_root)?;
set_enabled(realm_root, module_id, enable)?;
Ok(format!(
"Plugin '{}' has been {}",
module_id,
if enable { "ENABLED" } else { "DISABLED" }
))
}
/// Safely removes a module from the realm. Preserves SQL data.
pub fn remove_preview_module(realm_root: &Path, module_id: &str) -> Result<String> {
require_server_stopped(realm_root)?;
remove(realm_root, module_id)?;
Ok(format!(
"Plugin '{}' removed from realm plugins. Database tables and user data were preserved.",
module_id
))
}
-356
View File
@@ -1,356 +0,0 @@
use std::collections::BTreeMap;
use std::fs;
use std::path::Path;
use serde::{Deserialize, Serialize};
use sha2::{Digest, Sha256};
use crate::error::{Error, Result};
#[derive(Debug, Clone, Serialize, Deserialize)]
pub struct PeExportEntry {
pub ordinal: u32,
pub rva: String,
pub decorated_name: String,
pub demangled_signature: Option<String>,
pub is_forwarder: bool,
pub forwarder_target: Option<String>,
}
#[derive(Debug, Clone, Serialize, Deserialize)]
pub struct ArtifactProvenanceRecord {
pub file_path: String,
pub file_size: u64,
pub file_sha256: String,
pub machine_architecture: String,
pub is_dll: bool,
pub total_export_count: usize,
pub total_name_count: usize,
pub embedded_abi_fingerprint: Option<String>,
pub sdk_manifest_fingerprint: Option<String>,
pub sdk_manifest_match: bool,
pub category_a_signatures: Vec<String>,
pub category_a_count: usize,
pub compiler_environment: BTreeMap<String, String>,
pub provenance_status: String, // "PROVENANCE_VERIFIED" or "CONFLICT_DETECTED"
pub notes: Vec<String>,
}
/// Helper function to translate RVA to file offset given PE section headers
fn rva_to_offset(rva: u32, sections: &[(u32, u32, u32, u32)]) -> Option<usize> {
for &(sec_va, sec_vsize, sec_raw_ptr, sec_raw_size) in sections {
let size = sec_vsize.max(sec_raw_size);
if rva >= sec_va && rva < sec_va + size {
return Some((sec_raw_ptr + (rva - sec_va)) as usize);
}
}
None
}
/// Parse PE headers and extract all exported symbols and metadata directly from binary bytes
/// The ABI fingerprint in an image's ".coapl" section ("COAPLUGIN1|<id>|<fingerprint>"), read from the file
/// without loading it. Plugin DLLs carry the fingerprint of the SDK they were built with; a plugin host
/// worldserver.exe carries its own (id "worldserver"). None when there is no such section.
pub fn coapl_fingerprint(bytes: &[u8]) -> Option<String> {
let u16_at = |o: usize| bytes.get(o..o + 2).map(|b| u16::from_le_bytes([b[0], b[1]]));
let u32_at = |o: usize| bytes.get(o..o + 4).map(|b| u32::from_le_bytes([b[0], b[1], b[2], b[3]]));
let pe = u32_at(0x3C)? as usize;
if u32_at(pe)? != 0x0000_4550 {
return None;
}
let sections = u16_at(pe + 6)? as usize;
let first = pe + 24 + u16_at(pe + 20)? as usize;
for i in 0..sections.min(96) {
let at = first.checked_add(i * 40)?;
if !bytes.get(at..at + 8)?.starts_with(b".coapl") {
continue;
}
let size = u32_at(at + 8)?.min(u32_at(at + 16)?) as usize;
let raw = u32_at(at + 20)? as usize;
let data = bytes.get(raw..raw.checked_add(size)?)?;
let text = std::str::from_utf8(&data[..data.iter().position(|&c| c == 0).unwrap_or(data.len())]).ok()?;
let mut parts = text.split('|');
return match (parts.next(), parts.next(), parts.next(), parts.next()) {
(Some("COAPLUGIN1"), Some(_), Some(fp), None) if fp.len() == 64 && fp.bytes().all(|c| c.is_ascii_hexdigit()) => {
Some(fp.to_owned())
}
_ => None,
};
}
None
}
/// `coapl_fingerprint` of a file on disk.
pub fn file_abi_fingerprint(path: &Path) -> Option<String> {
fs::read(path).ok().and_then(|b| coapl_fingerprint(&b))
}
/// The plugin ABI the realm's worldserver.exe accepts. None for a server without a plugin host (or one
/// built before hosts recorded their fingerprint).
pub fn realm_host_fingerprint(realm_root: &Path) -> Option<String> {
["Core/worldserver.exe", "worldserver.exe"]
.iter()
.map(|rel| realm_root.join(rel))
.find(|p| p.is_file())
.and_then(|p| file_abi_fingerprint(&p))
}
pub fn parse_pe_exports(bytes: &[u8]) -> Result<(String, bool, Vec<PeExportEntry>, Option<String>)> {
if bytes.len() < 64 {
return Err(Error::Invalid("File too small to be a PE image".into()));
}
// DOS Header
if bytes[0] != b'M' || bytes[1] != b'Z' {
return Err(Error::Invalid("Invalid DOS signature (expected MZ)".into()));
}
let e_lfanew = u32::from_le_bytes(bytes[0x3C..0x40].try_into().unwrap()) as usize;
if e_lfanew + 24 > bytes.len() {
return Err(Error::Invalid("Truncated NT header offset".into()));
}
// PE Signature
if &bytes[e_lfanew..e_lfanew + 4] != b"PE\0\0" {
return Err(Error::Invalid("Invalid PE signature".into()));
}
let file_header_offset = e_lfanew + 4;
let machine = u16::from_le_bytes(bytes[file_header_offset..file_header_offset + 2].try_into().unwrap());
let num_sections = u16::from_le_bytes(bytes[file_header_offset + 2..file_header_offset + 4].try_into().unwrap()) as usize;
let size_of_opt_header = u16::from_le_bytes(bytes[file_header_offset + 16..file_header_offset + 18].try_into().unwrap()) as usize;
let characteristics = u16::from_le_bytes(bytes[file_header_offset + 18..file_header_offset + 20].try_into().unwrap());
let arch = match machine {
0x8664 => "AMD64 (x86_64)",
0x014C => "i386 (x86)",
0xAA64 => "ARM64",
_ => "UNKNOWN",
}.to_string();
let is_dll = (characteristics & 0x2000) != 0;
let opt_header_offset = file_header_offset + 20;
if opt_header_offset + size_of_opt_header > bytes.len() {
return Err(Error::Invalid("Truncated Optional Header".into()));
}
let magic = u16::from_le_bytes(bytes[opt_header_offset..opt_header_offset + 2].try_into().unwrap());
let is_pe32_plus = magic == 0x020B;
let data_dirs_offset = if is_pe32_plus {
opt_header_offset + 112
} else {
opt_header_offset + 96
};
let export_dir_va = u32::from_le_bytes(bytes[data_dirs_offset..data_dirs_offset + 4].try_into().unwrap());
let export_dir_size = u32::from_le_bytes(bytes[data_dirs_offset + 4..data_dirs_offset + 8].try_into().unwrap());
// Section headers
let section_table_offset = opt_header_offset + size_of_opt_header;
let mut sections = Vec::new();
for i in 0..num_sections {
let sec_offset = section_table_offset + i * 40;
if sec_offset + 40 > bytes.len() {
break;
}
let sec_vsize = u32::from_le_bytes(bytes[sec_offset + 8..sec_offset + 12].try_into().unwrap());
let sec_va = u32::from_le_bytes(bytes[sec_offset + 12..sec_offset + 16].try_into().unwrap());
let sec_raw_size = u32::from_le_bytes(bytes[sec_offset + 16..sec_offset + 20].try_into().unwrap());
let sec_raw_ptr = u32::from_le_bytes(bytes[sec_offset + 20..sec_offset + 24].try_into().unwrap());
sections.push((sec_va, sec_vsize, sec_raw_ptr, sec_raw_size));
}
// The ABI fingerprint the image records in its ".coapl" section (plugins and plugin hosts).
let embedded_abi = coapl_fingerprint(bytes);
// Parse Export Table
let mut export_entries = Vec::new();
if export_dir_va != 0 && export_dir_size != 0 {
if let Some(export_offset) = rva_to_offset(export_dir_va, &sections) {
if export_offset + 40 <= bytes.len() {
let ordinal_base = u32::from_le_bytes(bytes[export_offset + 16..export_offset + 20].try_into().unwrap());
let num_functions = u32::from_le_bytes(bytes[export_offset + 20..export_offset + 24].try_into().unwrap()) as usize;
let num_names = u32::from_le_bytes(bytes[export_offset + 24..export_offset + 28].try_into().unwrap()) as usize;
let addr_functions_rva = u32::from_le_bytes(bytes[export_offset + 28..export_offset + 32].try_into().unwrap());
let addr_names_rva = u32::from_le_bytes(bytes[export_offset + 32..export_offset + 36].try_into().unwrap());
let addr_ordinals_rva = u32::from_le_bytes(bytes[export_offset + 36..export_offset + 40].try_into().unwrap());
let names_offset_opt = rva_to_offset(addr_names_rva, &sections);
let ordinals_offset_opt = rva_to_offset(addr_ordinals_rva, &sections);
let functions_offset_opt = rva_to_offset(addr_functions_rva, &sections);
if let (Some(names_off), Some(ords_off), Some(funcs_off)) = (names_offset_opt, ordinals_offset_opt, functions_offset_opt) {
for i in 0..num_names {
if names_off + (i + 1) * 4 > bytes.len() || ords_off + (i + 1) * 2 > bytes.len() {
break;
}
let name_rva = u32::from_le_bytes(bytes[names_off + i * 4..names_off + (i + 1) * 4].try_into().unwrap());
let ordinal_bias = u16::from_le_bytes(bytes[ords_off + i * 2..ords_off + (i + 1) * 2].try_into().unwrap()) as usize;
let ordinal = ordinal_base + ordinal_bias as u32;
let mut func_rva = 0;
if ordinal_bias < num_functions && funcs_off + (ordinal_bias + 1) * 4 <= bytes.len() {
func_rva = u32::from_le_bytes(bytes[funcs_off + ordinal_bias * 4..funcs_off + (ordinal_bias + 1) * 4].try_into().unwrap());
}
// Read string from name_rva
let name_str = if let Some(n_off) = rva_to_offset(name_rva, &sections) {
let mut end = n_off;
while end < bytes.len() && bytes[end] != 0 {
end += 1;
}
String::from_utf8_lossy(&bytes[n_off..end]).to_string()
} else {
format!("UNKNOWN_RVA_{:08X}", name_rva)
};
let is_forwarder = func_rva >= export_dir_va && func_rva < export_dir_va + export_dir_size;
let forwarder_target = if is_forwarder {
if let Some(f_off) = rva_to_offset(func_rva, &sections) {
let mut end = f_off;
while end < bytes.len() && bytes[end] != 0 {
end += 1;
}
Some(String::from_utf8_lossy(&bytes[f_off..end]).to_string())
} else {
None
}
} else {
None
};
export_entries.push(PeExportEntry {
ordinal,
rva: format!("0x{:08X}", func_rva),
decorated_name: name_str,
demangled_signature: None,
is_forwarder,
forwarder_target,
});
}
}
}
}
}
Ok((arch, is_dll, export_entries, embedded_abi))
}
/// Verify artifact provenance for a given worldserver.exe binary path against expected SDK metadata
pub fn verify_worldserver_provenance(
exe_path: &Path,
sdk_json_path: Option<&Path>,
) -> Result<ArtifactProvenanceRecord> {
if !exe_path.exists() {
return Err(Error::Invalid(format!("Executable path does not exist: {}", exe_path.display())));
}
let bytes = fs::read(exe_path)?;
let mut hasher = Sha256::new();
hasher.update(&bytes);
let file_sha256 = hex::encode(hasher.finalize()).to_lowercase();
let file_size = bytes.len() as u64;
let (arch, is_dll, exports, embedded_abi) = parse_pe_exports(&bytes)?;
let mut sdk_manifest_fingerprint = None;
if let Some(sdk_path) = sdk_json_path {
if sdk_path.exists() {
if let Ok(content) = fs::read_to_string(sdk_path) {
if let Ok(parsed) = serde_json::from_str::<serde_json::Value>(&content) {
if let Some(fp) = parsed.get("abi_fingerprint").and_then(|v| v.as_str()) {
sdk_manifest_fingerprint = Some(fp.to_string());
}
}
}
}
}
let sdk_match = match (&embedded_abi, &sdk_manifest_fingerprint) {
(Some(a), Some(b)) => a == b,
(Some(_), None) => true,
_ => false,
};
let category_a_patterns = [
"SendServerMessage@WorldSessionMgr",
"AddGossipItemFor",
"SendGossipMenuFor",
"CloseGossipMenuFor",
"ClearGossipMenuFor",
"SendMailTo@MailDraft",
];
let mut category_a_sigs = Vec::new();
for exp in &exports {
for &pat in &category_a_patterns {
if exp.decorated_name.contains(pat) {
category_a_sigs.push(exp.decorated_name.clone());
break;
}
}
}
let mut notes = Vec::new();
if !sdk_match {
notes.push("CONFLICT: Embedded ABI fingerprint does not match provided sdk.json".into());
} else {
notes.push("Embedded ABI fingerprint strictly matches host binary expectation".into());
}
let status = if sdk_match && !exports.is_empty() {
"PROVENANCE_VERIFIED".to_string()
} else {
"CONFLICT_DETECTED".to_string()
};
let mut compiler_env = BTreeMap::new();
compiler_env.insert("toolchain".into(), "MSVC 19.51.36247 (Visual Studio 2026 Preview/Insiders x64)".into());
compiler_env.insert("target".into(), "x86_64-pc-windows-msvc".into());
compiler_env.insert("crt".into(), "MultiThreadedDLL (/MD)".into());
Ok(ArtifactProvenanceRecord {
file_path: exe_path.to_string_lossy().into_owned(),
file_size,
file_sha256,
machine_architecture: arch,
is_dll,
total_export_count: exports.len(),
total_name_count: exports.len(),
embedded_abi_fingerprint: embedded_abi,
sdk_manifest_fingerprint,
sdk_manifest_match: sdk_match,
category_a_count: category_a_sigs.len(),
category_a_signatures: category_a_sigs,
compiler_environment: compiler_env,
provenance_status: status,
notes,
})
}
#[cfg(test)]
mod tests {
use super::*;
#[test]
fn coapl_fingerprint_reads_plugins_and_rejects_other_images() {
// A plugin built against sdk-v03 carries that SDK's fingerprint.
let dll = Path::new("C:/games/coa-work/plugin-spike/plugins/probe-missing/companions-38c0220/build/companions_38c0220.dll");
if dll.is_file() {
assert_eq!(
file_abi_fingerprint(dll).as_deref(),
Some("2f82013def4698d3f75fa24e5f70ffa504a7782d366b5edb78c7adc3c1ee0883")
);
}
// Not a PE file, a PE without the section, truncated input: no fingerprint, no panic.
assert_eq!(coapl_fingerprint(b"not a pe file"), None);
assert_eq!(coapl_fingerprint(&[]), None);
let notepad = Path::new("C:/Windows/System32/notepad.exe");
if let Ok(bytes) = fs::read(notepad) {
assert_eq!(coapl_fingerprint(&bytes), None);
for cut in [0x40, 0x200, 0x400, bytes.len() / 2] {
let _ = coapl_fingerprint(&bytes[..cut.min(bytes.len())]);
}
}
}
}
+79 -1
View File
@@ -58,6 +58,23 @@ impl Ra {
Self::connect_to(read_ports(root).ra, &cfg.ra_username, &cfg.ra_password)
}
/// Connect to the loopback RA port of the target realm world server.
pub fn connect_target(main: &Path, realm: Option<crate::realms::Mode>) -> Result<Ra> {
let mode = realm.unwrap_or_else(|| {
crate::realms::view(main).map(|v| v.active).unwrap_or_default()
});
let target = crate::multiworld::resolve_bot_operation_target(main, mode)?;
if !target.running {
return Err(Error::Invalid(format!(
"Realm {} worldserver is stopped; cannot execute online bot operation.",
target.realm.label()
)));
}
let cfg: RaSettings = fsx::read_json(&main.join("Settings/repack.json"))
.map_err(|_| Error::Invalid("The server console settings could not be read.".into()))?;
Self::connect_to(target.ra_port, &cfg.ra_username, &cfg.ra_password)
}
pub fn connect_to(port: u16, user: &str, password: &str) -> Result<Ra> {
let addr: SocketAddr = ([127, 0, 0, 1], port).into();
let mut stream =
@@ -87,7 +104,28 @@ impl Ra {
let c = crate::console::check_command(cmd)?;
self.command(c)
}
/// Send a command whose answer does not matter (`server shutdown`). The reply is still read (up to the next
/// prompt, the end of the connection, or a few seconds): closing a socket that holds unread data resets the
/// connection, and the server can then drop the command it has not processed yet.
pub fn send_without_answer(mut self, cmd: &str) -> Result<()> {
let c = crate::console::check_command(cmd)?;
self.stream.write_all(format!("{c}\r\n").as_bytes())?;
self.stream.flush()?;
self.stream.set_read_timeout(Some(Duration::from_secs(10)))?;
let mut seen = Vec::new();
let mut buf = [0u8; 4096];
while let Ok(n) = self.stream.read(&mut buf) {
if n == 0 {
break;
}
seen.extend_from_slice(&buf[..n]);
if seen.ends_with(b"AC>") || seen.len() > 1 << 20 {
break;
}
}
let _ = self.stream.shutdown(std::net::Shutdown::Both);
Ok(())
}
fn command(&mut self, cmd: &str) -> Result<String> {
debug_assert!(!cmd.contains(['\r', '\n']));
self.stream.write_all(format!("{cmd}\r\n").as_bytes())?;
@@ -235,6 +273,11 @@ impl Ra {
Ok(out.lines().last().unwrap_or("").to_string())
}
/// Delete the companion bots of custom races (RaceID above 11), every other bot stays. Returns how many.
pub fn purge_custom_race_bots(&mut self) -> Result<u32> {
Ok(first_number(&self.bot_command("botcmd purgecustomraces")?))
}
/// Ask the bot module to create `count` leveling bots (throttled by the module itself). Only a number is sent.
pub fn spawn_bots(&mut self, count: u32) -> Result<String> {
if !(1..=2000).contains(&count) {
@@ -249,6 +292,41 @@ impl Ra {
Ok(out.lines().last().unwrap_or("").to_string())
}
/// Ask the bot module to spawn a fleet of bots of specific race and level (.botcmd spawnfleet <race> <level>).
pub fn spawn_fleet(&mut self, race: u8, level: u8) -> Result<String> {
let out = self.bot_command(&format!("botcmd spawnfleet {race} {level}"))?;
Ok(out.lines().last().unwrap_or("").to_string())
}
pub fn spawn_custom(
&mut self,
count: u32,
level: u8,
class_id: Option<u8>,
spec_id: Option<u32>,
archetype: Option<&str>,
) -> Result<String> {
let c = class_id.unwrap_or(0);
let s = spec_id.unwrap_or(0);
let a = archetype.unwrap_or("").trim();
let mut cmd = format!("botcmd spawncustom {count} {level}");
if !a.is_empty() {
cmd.push_str(&format!(" {c} {s} {a}"));
} else if s > 0 {
cmd.push_str(&format!(" {c} {s}"));
} else if c > 0 {
cmd.push_str(&format!(" {c}"));
}
let out = self.bot_command(&cmd)?;
Ok(out.lines().last().unwrap_or("").to_string())
}
/// Bring all offline bots online gradually (.botcmd loginall).
pub fn login_all(&mut self) -> Result<String> {
let out = self.bot_command("botcmd loginall")?;
Ok(out.lines().last().unwrap_or("").to_string())
}
/// Set a new password for an existing account.
pub fn set_account_password(&mut self, name: &str, password: &str) -> Result<()> {
validate_account(name, password)?;
+171
View File
@@ -269,9 +269,95 @@ pub fn save(
),
]),
)?;
write_snapshot(root, &current.catalog_sha256, &current.races)?;
status(root)
}
/// Every race catalog (`ChrRaces.dbc` of the custom races overlay) a server build has shipped, by SHA-256:
/// RaceID -> name. Generated from the core repository's history of the overlay.
const SHIPPED_CATALOGS: &str = include_str!("race_catalogs.json");
/// The names of the catalog a restriction was saved against, written by every save.
const SNAPSHOT: &str = "Settings/race-catalog.json";
#[derive(serde::Deserialize, Serialize)]
struct Snapshot {
sha256: String,
races: BTreeMap<u32, String>,
}
/// RaceID -> name of the catalog with `hash`: this server's own snapshot, or a catalog a build shipped.
fn names_of(root: &Path, hash: &str) -> Option<BTreeMap<u32, String>> {
if let Ok(snapshot) = crate::fsx::read_json::<Snapshot>(&root.join(SNAPSHOT)) {
if snapshot.sha256.eq_ignore_ascii_case(hash) {
return Some(snapshot.races);
}
}
#[derive(serde::Deserialize)]
struct Shipped {
catalogs: BTreeMap<String, BTreeMap<u32, String>>,
}
let shipped: Shipped = serde_json::from_str(SHIPPED_CATALOGS).ok()?;
shipped.catalogs.get(&hash.to_ascii_lowercase()).cloned()
}
fn write_snapshot(root: &Path, hash: &str, races: &[Race]) -> Result<()> {
crate::fsx::atomic_write_json(
&root.join(SNAPSHOT),
&Snapshot {
sha256: hash.to_string(),
races: races.iter().map(|race| (race.id, race.name.clone())).collect(),
},
)
}
/// A server update that only adds races keeps the owner's restriction. The worldserver ignores a restriction
/// saved against another catalog (and with it the whole custom races switch), so before a start: when every
/// disabled race still has its RaceID and name in the new catalog, the restriction is bound to the new catalog.
/// Anything else (an unknown old catalog, a renamed or missing race) is left for the owner to review. Returns
/// whether the restriction was bound again.
pub fn rebind_unchanged(root: &Path) -> Result<bool> {
let conf_path = root.join(CONF);
let Ok(conf_bytes) = fs::read(&conf_path) else {
return Ok(false);
};
let mut conf = ConfFile::parse_bytes(&conf_bytes)?;
let configured = parse_ids(conf.get(KEY).unwrap_or(""))?;
let saved = conf
.get(CATALOG_KEY)
.unwrap_or("")
.trim()
.trim_matches('"')
.to_ascii_lowercase();
if configured.is_empty() || saved.is_empty() {
return Ok(false);
}
let Ok(bytes) = fs::read(dbc_path(root)?) else {
return Ok(false);
};
let current = hex::encode(Sha256::digest(&bytes));
if saved == current {
return Ok(false);
}
let races = catalog(&bytes)?;
let Some(before) = names_of(root, &saved) else {
tracing::warn!("race restriction saved against an unknown catalog; it needs the owner's review");
return Ok(false);
};
let now: BTreeMap<u32, &str> = races.iter().map(|race| (race.id, race.name.as_str())).collect();
let unchanged = configured
.iter()
.all(|id| before.get(id).is_some_and(|name| now.get(id) == Some(&name.as_str())));
if !unchanged {
tracing::warn!("a restricted race changed in the new catalog; the restriction needs the owner's review");
return Ok(false);
}
conf.set(CATALOG_KEY, &format!("\"{current}\""), &[]);
crate::fsx::atomic_write(&conf_path, conf.to_text().as_bytes())?;
write_snapshot(root, &current, &races)?;
tracing::info!(races = configured.len(), "race restriction kept for the updated race catalog");
Ok(true)
}
#[cfg(test)]
mod tests {
use super::*;
@@ -292,6 +378,91 @@ mod tests {
bytes
}
fn catalog_of(rows: &[(u32, &str)]) -> Vec<u8> {
let mut strings = vec![0u8];
let mut offsets = Vec::new();
for (_, name) in rows {
offsets.push(strings.len() as u32);
strings.extend(name.as_bytes());
strings.push(0);
}
let mut bytes = b"WDBC".to_vec();
for value in [rows.len() as u32, 69, 276, strings.len() as u32] {
bytes.extend(value.to_le_bytes());
}
for ((id, _), offset) in rows.iter().zip(offsets) {
let mut row = vec![0; 276];
row[..4].copy_from_slice(&id.to_le_bytes());
row[56..60].copy_from_slice(&offset.to_le_bytes());
bytes.extend(row);
}
bytes.extend(strings);
bytes
}
fn restricted_server(catalog: &[u8], disabled: &str, saved_hash: &str) -> tempfile::TempDir {
let d = tempfile::tempdir().unwrap();
fs::create_dir_all(d.path().join("Data/dbc_races")).unwrap();
fs::create_dir_all(d.path().join("Core/configs/modules")).unwrap();
fs::write(d.path().join("Data/dbc_races/ChrRaces.dbc"), catalog).unwrap();
fs::write(
d.path().join(CONF),
format!("CoACustomRaces.Enable = 1\nCoACustomRaces.DisabledRaceIds = \"{disabled}\"\nCoACustomRaces.DisabledRaceCatalogSha256 = \"{saved_hash}\"\n"),
)
.unwrap();
d
}
fn sha(bytes: &[u8]) -> String {
hex::encode(Sha256::digest(bytes))
}
#[test]
fn a_catalog_that_only_adds_races_keeps_the_restriction() {
let old = catalog_of(&[(83, "Vulpera"), (97, "Gnoll")]);
let new = catalog_of(&[(83, "Vulpera"), (97, "Gnoll"), (120, "Nerubian")]);
let d = restricted_server(&new, "83", &sha(&old));
write_snapshot(d.path(), &sha(&old), &catalog(&old).unwrap()).unwrap();
assert!(rebind_unchanged(d.path()).unwrap());
let conf = ConfFile::parse_bytes(&fs::read(d.path().join(CONF)).unwrap()).unwrap();
assert_eq!(conf.get(KEY), Some("\"83\""));
assert_eq!(
conf.get(CATALOG_KEY).map(|h| h.trim_matches('"').to_string()),
Some(sha(&new))
);
assert_eq!(conf.get("CoACustomRaces.Enable"), Some("1"));
assert!(!rebind_unchanged(d.path()).unwrap(), "already bound");
}
#[test]
fn a_renamed_race_or_unknown_catalog_waits_for_review() {
let old = catalog_of(&[(83, "Thin Human"), (97, "Gnoll")]);
let renamed = catalog_of(&[(83, "Forgotten"), (97, "Gnoll")]);
let d = restricted_server(&renamed, "83", &sha(&old));
write_snapshot(d.path(), &sha(&old), &catalog(&old).unwrap()).unwrap();
assert!(!rebind_unchanged(d.path()).unwrap());
let unknown = restricted_server(&renamed, "97", &"ab".repeat(32));
assert!(!rebind_unchanged(unknown.path()).unwrap());
// Nothing is restricted: nothing to bind.
let empty = restricted_server(&renamed, "", &sha(&old));
assert!(!rebind_unchanged(empty.path()).unwrap());
}
#[test]
fn the_shipped_catalogs_include_1_9_2_and_v2_with_stable_ids() {
let shipped: serde_json::Value = serde_json::from_str(SHIPPED_CATALOGS).unwrap();
let catalogs = shipped["catalogs"].as_object().unwrap();
let size = |c: &serde_json::Value| c.as_object().unwrap().len();
assert!(catalogs.values().any(|c| size(c) == 95), "1.9.2 has 95 races");
let v2: Vec<_> = catalogs.values().filter(|c| size(c) == 112).collect();
assert_eq!(v2.len(), 1, "V2 has 112 races");
for old in catalogs.values().filter(|c| size(c) == 95) {
for (id, name) in old.as_object().unwrap() {
assert_eq!(&v2[0][id], name, "race {id}");
}
}
}
#[test]
fn catalog_preserves_ids_and_excludes_stock_and_nonplayable() {
let mut bytes = dbc();
+639
View File
@@ -0,0 +1,639 @@
{
"catalogs": {
"0f9e05112d56609a87f0b1900be88f8130a8fcb24ee4acae585f1fd8d9144bf0": {
"1": "Human",
"10": "Blood Elf",
"100": "Drakonid",
"103": "Grummle",
"11": "Draenei",
"12": "Zandalari Troll",
"13": "Worgen",
"14": "High Elf",
"15": "Tuskarr",
"16": "Kul Tiran",
"17": "Taunka",
"18": "Vrykul",
"19": "Vulpera",
"2": "Orc",
"20": "Pandaren",
"21": "Naga",
"22": "Broken",
"23": "Fel Orc",
"24": "Forest Troll",
"25": "Ice Troll",
"26": "Skeleton",
"27": "Earthen",
"28": "Drakkari Troll",
"29": "Pandaren",
"3": "Dwarf",
"30": "Murloc",
"31": "Murloc",
"32": "Thin Human",
"33": "Thin Human",
"34": "Fel Orc",
"35": "Naga",
"36": "Broken",
"37": "Skeleton",
"38": "Vrykul",
"39": "Tuskarr",
"4": "Night Elf",
"40": "Forest Troll",
"41": "Taunka",
"42": "Northrend Skeleton",
"43": "Ice Troll",
"44": "Drakkari Troll",
"45": "Leper Troll",
"46": "Troglodyte",
"47": "Alpha Worgen",
"48": "Dark Iron Dwarf",
"49": "Mag'har Orc",
"5": "Undead",
"50": "Furbolg",
"51": "Undead Gnome",
"52": "Orc",
"53": "Ogre",
"54": "Dracthyr",
"55": "Eredar",
"56": "Harpy",
"57": "Alpha Goblin",
"58": "Dracthyr",
"59": "Void Elf",
"6": "Tauren",
"60": "Illidari Blood Elf",
"61": "Illidari Night Elf",
"62": "Lightforged Draenei",
"63": "Nightborne",
"65": "Test Race",
"66": "Highmountain Tauren",
"67": "Mechagnome",
"68": "Earthen",
"69": "Earthen",
"7": "Gnome",
"70": "Haranir",
"71": "Haranir",
"72": "Windshaper Skyborne",
"74": "Vulpera",
"77": "High Order Skyborne",
"78": "Jinyu",
"79": "Arakkoa",
"8": "Troll",
"80": "Darkfallen",
"81": "Darkfallen",
"82": "Sethrak",
"83": "Gnoll",
"9": "Goblin",
"97": "Saberon",
"98": "Drakonid",
"99": "Drakkin"
},
"358503359af5b05d16a76f61bab77b5c6221c792bcb0e11793eba8e279689ff7": {
"1": "Human",
"10": "Blood Elf",
"11": "Draenei",
"12": "Zandalari Troll",
"13": "Worgen",
"14": "High Elf",
"15": "Tuskarr",
"16": "Kul Tiran",
"17": "Taunka",
"18": "Vrykul",
"19": "Vulpera",
"2": "Orc",
"20": "Pandaren",
"21": "Naga",
"22": "Broken",
"23": "Fel Orc",
"24": "Forest Troll",
"25": "Ice Troll",
"26": "Skeleton",
"27": "Earthen",
"28": "Drakkari Troll",
"29": "Pandaren",
"3": "Dwarf",
"30": "Murloc",
"31": "Murloc",
"32": "Thin Human",
"33": "Thin Human",
"34": "Fel Orc",
"35": "Naga",
"36": "Broken",
"37": "Skeleton",
"38": "Vrykul",
"39": "Tuskarr",
"4": "Night Elf",
"40": "Forest Troll",
"41": "Taunka",
"42": "Northrend Skeleton",
"43": "Ice Troll",
"44": "Drakkari Troll",
"45": "Leper Troll",
"46": "Troglodyte",
"47": "Alpha Worgen",
"48": "Dark Iron Dwarf",
"49": "Mag'har Orc",
"5": "Undead",
"50": "Furbolg",
"51": "Undead Gnome",
"52": "Orc",
"53": "Ogre",
"54": "Dracthyr",
"55": "Eredar",
"56": "Harpy",
"57": "Alpha Goblin",
"58": "Dracthyr",
"59": "Void Elf",
"6": "Tauren",
"60": "Illidari Blood Elf",
"61": "Illidari Night Elf",
"62": "Lightforged Draenei",
"63": "Nightborne",
"65": "Test Race",
"66": "Highmountain Tauren",
"67": "Mechagnome",
"68": "Earthen",
"69": "Earthen",
"7": "Gnome",
"70": "Haranir",
"71": "Haranir",
"72": "Windshaper Skyborne",
"74": "Vulpera",
"77": "High Order Skyborne",
"78": "Jinyu",
"8": "Troll",
"80": "Darkfallen",
"81": "Darkfallen",
"82": "Sethrak",
"83": "Gnoll",
"9": "Goblin",
"97": "Saberon"
},
"6ad3ac1ad6ef7f32ed347e979cd1667bb5393d7a0967a859e5ba3cfa2a5d04c7": {
"1": "Human",
"10": "Blood Elf",
"100": "Drakonid",
"101": "Venthyr",
"102": "Centaur",
"103": "Grummle",
"104": "Slime Giant",
"106": "Mantid",
"107": "Kyrian",
"109": "Ethereal",
"11": "Draenei",
"110": "Sylvari",
"112": "Hozen",
"12": "Zandalari Troll",
"13": "Worgen",
"14": "High Elf",
"15": "Tuskarr",
"16": "Kul Tiran",
"17": "Taunka",
"18": "Vrykul",
"19": "Vulpera",
"2": "Orc",
"20": "Pandaren",
"21": "Naga",
"22": "Broken",
"23": "Fel Orc",
"24": "Forest Troll",
"25": "Ice Troll",
"26": "Skeleton",
"27": "Earthen",
"28": "Drakkari Troll",
"29": "Pandaren",
"3": "Dwarf",
"30": "Murloc",
"31": "Murloc",
"32": "Forgotten",
"33": "Forgotten",
"34": "Fel Orc",
"35": "Naga",
"36": "Broken",
"37": "Skeleton",
"38": "Vrykul",
"39": "Tuskarr",
"4": "Night Elf",
"40": "Forest Troll",
"41": "Taunka",
"42": "Northrend Skeleton",
"43": "Ice Troll",
"44": "Drakkari Troll",
"45": "Leper Troll",
"46": "Troglodyte",
"47": "Alpha Worgen",
"48": "Dark Iron Dwarf",
"49": "Mag'har Orc",
"5": "Undead",
"50": "Furbolg",
"51": "Undead Gnome",
"52": "Orc",
"53": "Ogre",
"54": "Dracthyr",
"55": "Eredar",
"56": "Harpy",
"57": "Alpha Goblin",
"58": "Dracthyr",
"59": "Void Elf",
"6": "Tauren",
"60": "Illidari Blood Elf",
"61": "Illidari Night Elf",
"62": "Lightforged Draenei",
"63": "Nightborne",
"65": "Test Race",
"66": "Highmountain Tauren",
"67": "Mechagnome",
"68": "Earthen",
"69": "Earthen",
"7": "Gnome",
"70": "Haranir",
"71": "Haranir",
"72": "Windshaper Skyborne",
"74": "Vulpera",
"75": "Centaur",
"77": "High Order Skyborne",
"78": "Jinyu",
"79": "Arakkoa",
"8": "Troll",
"80": "Darkfallen",
"81": "Darkfallen",
"82": "Sethrak",
"83": "Gnoll",
"87": "Faceless One",
"9": "Goblin",
"90": "Banshee",
"97": "Saberon",
"98": "Drakonid",
"99": "Drakkin"
},
"833e18c0f0550d400e78ee5db00bd65bf86d051861fe6b795c0539e3fd9f125d": {
"1": "Human",
"10": "Blood Elf",
"11": "Draenei",
"12": "Zandalari Troll",
"13": "Worgen",
"14": "High Elf",
"15": "Tuskarr",
"16": "Kul Tiran",
"17": "Taunka",
"18": "Vrykul",
"19": "Vulpera",
"2": "Orc",
"20": "Pandaren",
"21": "Naga",
"22": "Broken",
"23": "Fel Orc",
"24": "Forest Troll",
"25": "Ice Troll",
"26": "Skeleton",
"27": "Earthen",
"28": "Drakkari Troll",
"29": "Pandaren",
"3": "Dwarf",
"30": "Murloc",
"31": "Murloc",
"32": "Thin Human",
"33": "Thin Human",
"34": "Fel Orc",
"35": "Naga",
"36": "Broken",
"37": "Skeleton",
"38": "Vrykul",
"39": "Tuskarr",
"4": "Night Elf",
"40": "Forest Troll",
"41": "Taunka",
"42": "Northrend Skeleton",
"43": "Ice Troll",
"44": "Drakkari Troll",
"45": "Leper Troll",
"46": "Troglodyte",
"47": "Alpha Worgen",
"48": "Dark Iron Dwarf",
"49": "Mag'har Orc",
"5": "Undead",
"50": "Furbolg",
"51": "Undead Gnome",
"52": "Orc",
"53": "Ogre",
"54": "Dracthyr",
"55": "Eredar",
"56": "Harpy",
"57": "Alpha Goblin",
"58": "Dracthyr",
"59": "Void Elf",
"6": "Tauren",
"60": "Illidari Blood Elf",
"61": "Illidari Night Elf",
"62": "Lightforged Draenei",
"63": "Nightborne",
"65": "Test Race",
"66": "Highmountain Tauren",
"67": "Mechagnome",
"68": "Earthen",
"69": "Earthen",
"7": "Gnome",
"70": "Haranir",
"71": "Haranir",
"72": "Windshaper Skyborne",
"74": "Vulpera",
"77": "High Order Skyborne",
"8": "Troll",
"9": "Goblin"
},
"9a49163b9a330d844f0add5a2023f538b828bd5c57d6ecbb3cd5b4196930c5da": {
"1": "Human",
"10": "Blood Elf",
"103": "Grummle",
"11": "Draenei",
"12": "Zandalari Troll",
"13": "Worgen",
"14": "High Elf",
"15": "Tuskarr",
"16": "Kul Tiran",
"17": "Taunka",
"18": "Vrykul",
"19": "Vulpera",
"2": "Orc",
"20": "Pandaren",
"21": "Naga",
"22": "Broken",
"23": "Fel Orc",
"24": "Forest Troll",
"25": "Ice Troll",
"26": "Skeleton",
"27": "Earthen",
"28": "Drakkari Troll",
"29": "Pandaren",
"3": "Dwarf",
"30": "Murloc",
"31": "Murloc",
"32": "Thin Human",
"33": "Thin Human",
"34": "Fel Orc",
"35": "Naga",
"36": "Broken",
"37": "Skeleton",
"38": "Vrykul",
"39": "Tuskarr",
"4": "Night Elf",
"40": "Forest Troll",
"41": "Taunka",
"42": "Northrend Skeleton",
"43": "Ice Troll",
"44": "Drakkari Troll",
"45": "Leper Troll",
"46": "Troglodyte",
"47": "Alpha Worgen",
"48": "Dark Iron Dwarf",
"49": "Mag'har Orc",
"5": "Undead",
"50": "Furbolg",
"51": "Undead Gnome",
"52": "Orc",
"53": "Ogre",
"54": "Dracthyr",
"55": "Eredar",
"56": "Harpy",
"57": "Alpha Goblin",
"58": "Dracthyr",
"59": "Void Elf",
"6": "Tauren",
"60": "Illidari Blood Elf",
"61": "Illidari Night Elf",
"62": "Lightforged Draenei",
"63": "Nightborne",
"65": "Test Race",
"66": "Highmountain Tauren",
"67": "Mechagnome",
"68": "Earthen",
"69": "Earthen",
"7": "Gnome",
"70": "Haranir",
"71": "Haranir",
"72": "Windshaper Skyborne",
"74": "Vulpera",
"77": "High Order Skyborne",
"78": "Jinyu",
"79": "Arakkoa",
"8": "Troll",
"80": "Darkfallen",
"81": "Darkfallen",
"82": "Sethrak",
"83": "Gnoll",
"9": "Goblin",
"97": "Saberon"
},
"b78635b08bf0bd63d2898fce97c1fb162c8a9c41632703172eefa88bae79061f": {
"1": "Human",
"10": "Blood Elf",
"100": "Drakonid",
"101": "Venthyr",
"102": "Centaur",
"103": "Grummle",
"104": "Slime Giant",
"106": "Mantid",
"107": "Kyrian",
"109": "Ethereal",
"11": "Draenei",
"110": "Sylvari",
"112": "Hozen",
"12": "Zandalari Troll",
"13": "Worgen",
"14": "High Elf",
"15": "Tuskarr",
"16": "Kul Tiran",
"17": "Taunka",
"18": "Vrykul",
"19": "Vulpera",
"2": "Orc",
"20": "Pandaren",
"21": "Naga",
"22": "Broken",
"23": "Fel Orc",
"24": "Forest Troll",
"25": "Ice Troll",
"26": "Skeleton",
"27": "Earthen",
"28": "Drakkari Troll",
"29": "Pandaren",
"3": "Dwarf",
"30": "Murloc",
"31": "Murloc",
"32": "Forgotten",
"33": "Forgotten",
"34": "Fel Orc",
"35": "Naga",
"36": "Broken",
"37": "Skeleton",
"38": "Vrykul",
"39": "Tuskarr",
"4": "Night Elf",
"40": "Forest Troll",
"41": "Taunka",
"42": "Northrend Skeleton",
"43": "Ice Troll",
"44": "Drakkari Troll",
"45": "Leper Troll",
"46": "Troglodyte",
"47": "Alpha Worgen",
"48": "Dark Iron Dwarf",
"49": "Mag'har Orc",
"5": "Undead",
"50": "Furbolg",
"51": "Undead Gnome",
"52": "Orc",
"53": "Ogre",
"54": "Dracthyr",
"55": "Eredar",
"56": "Harpy",
"57": "Alpha Goblin",
"58": "Dracthyr",
"59": "Void Elf",
"6": "Tauren",
"60": "Illidari Blood Elf",
"61": "Illidari Night Elf",
"62": "Lightforged Draenei",
"63": "Nightborne",
"65": "Test Race",
"66": "Highmountain Tauren",
"67": "Mechagnome",
"68": "Earthen",
"69": "Earthen",
"7": "Gnome",
"70": "Haranir",
"71": "Haranir",
"72": "Windshaper Skyborne",
"74": "Vulpera",
"75": "Centaur",
"77": "High Order Skyborne",
"78": "Jinyu",
"79": "Arakkoa",
"8": "Troll",
"80": "Darkfallen",
"81": "Darkfallen",
"82": "Sethrak",
"83": "Gnoll",
"87": "Faceless One",
"9": "Goblin",
"90": "Banshee",
"97": "Saberon",
"98": "Drakonid",
"99": "Drakkin"
},
"bff09e612ba44567a5c7d928562d6261755504dc8948daa334e675bf49b54938": {
"1": "Human",
"10": "Blood Elf",
"100": "Drakonid",
"101": "Venthyr",
"102": "Centaur",
"103": "Grummle",
"104": "Slime Giant",
"105": "Gilgoblin",
"106": "Mantid",
"107": "Kyrian",
"109": "Ethereal",
"11": "Draenei",
"110": "Sylvari",
"111": "Sporeling",
"112": "Hozen",
"114": "Stormforged",
"118": "Elune's Chosen",
"119": "Mo'arg",
"12": "Zandalari Troll",
"120": "Nerubian",
"122": "Lich",
"123": "Mogu",
"125": "Lost One",
"13": "Worgen",
"14": "High Elf",
"15": "Tuskarr",
"16": "Kul Tiran",
"17": "Taunka",
"18": "Vrykul",
"19": "Vulpera",
"2": "Orc",
"20": "Pandaren",
"21": "Naga",
"22": "Broken",
"23": "Fel Orc",
"24": "Forest Troll",
"25": "Ice Troll",
"26": "Skeleton",
"27": "Earthen",
"28": "Drakkari Troll",
"29": "Pandaren",
"3": "Dwarf",
"30": "Murloc",
"31": "Murloc",
"32": "Forgotten",
"33": "Forgotten",
"34": "Fel Orc",
"35": "Naga",
"36": "Broken",
"37": "Skeleton",
"38": "Vrykul",
"39": "Tuskarr",
"4": "Night Elf",
"40": "Forest Troll",
"41": "Taunka",
"42": "Northrend Skeleton",
"43": "Ice Troll",
"44": "Drakkari Troll",
"45": "Leper Troll",
"46": "Troglodyte",
"47": "Alpha Worgen",
"48": "Dark Iron Dwarf",
"49": "Mag'har Orc",
"5": "Undead",
"50": "Furbolg",
"51": "Undead Gnome",
"52": "Orc",
"53": "Ogre",
"54": "Dracthyr",
"55": "Eredar",
"56": "Harpy",
"57": "Alpha Goblin",
"58": "Dracthyr",
"59": "Void Elf",
"6": "Tauren",
"60": "Illidari Blood Elf",
"61": "Illidari Night Elf",
"62": "Lightforged Draenei",
"63": "Nightborne",
"65": "Test Race",
"66": "Highmountain Tauren",
"67": "Mechagnome",
"68": "Earthen",
"69": "Earthen",
"7": "Gnome",
"70": "Haranir",
"71": "Haranir",
"72": "Windshaper Skyborne",
"74": "Vulpera",
"75": "Centaur",
"77": "High Order Skyborne",
"78": "Jinyu",
"79": "Arakkoa",
"8": "Troll",
"80": "Darkfallen",
"81": "Darkfallen",
"82": "Sethrak",
"83": "Gnoll",
"85": "Two-Headed Ogre",
"86": "Sureki",
"87": "Faceless One",
"88": "Qiraji",
"89": "Dreadlord",
"9": "Goblin",
"90": "Banshee",
"91": "Titan",
"92": "Wretched",
"93": "Fungarian",
"96": "Thin Human",
"97": "Saberon",
"98": "Drakonid",
"99": "Drakkin"
}
},
"schema": 1,
"source": "Corfirean/azerothcore-wotlk-coa modules/mod-coa-custom-races/data/dbc/ChrRaces.dbc"
}
+216
View File
@@ -0,0 +1,216 @@
//! The names players see in the realm list, chosen by the server owner.
//!
//! The launcher writes `acore_auth.realmlist.name` at every start, so a name typed into the database (or into
//! an old `manage.py`) did not last. The owner's choice lives in `Settings/realm-names.json` of the server's main
//! folder, keyed by realm id, and every start and every realm-list setup uses it; extra worlds read their main
//! folder's file.
use std::collections::BTreeMap;
use std::path::{Path, PathBuf};
use serde::{Deserialize, Serialize};
use crate::error::{Error, Result};
use crate::fsx;
const FILE: &str = "Settings/realm-names.json";
/// `acore_auth.realmlist.name` is `varchar(32)`.
pub const MAX_CHARS: usize = 32;
#[derive(Debug, Default, Serialize, Deserialize)]
struct Names {
#[serde(default)]
names: BTreeMap<u32, String>,
}
/// The folder that owns the names: an extra world (`<server>/.realms/<name>`) belongs to `<server>`.
fn main_folder(root: &Path) -> PathBuf {
if crate::launcher::settings::is_extra_world(root) {
if let Some(main) = root.parent().and_then(Path::parent) {
return main.to_path_buf();
}
}
root.to_path_buf()
}
fn read(root: &Path) -> Names {
let path = main_folder(root).join(FILE);
if !path.is_file() {
return Names::default();
}
match fsx::read_json(&path) {
Ok(names) => names,
Err(error) => {
tracing::warn!(%error, "realm names could not be read; the default names are used");
Names::default()
}
}
}
/// A trimmed name the realm list can hold: 1 to 32 characters, no control characters.
pub fn validate(name: &str) -> Result<String> {
let name = name.trim();
if name.is_empty() {
return Err(Error::Invalid("The realm name cannot be empty.".into()));
}
if name.chars().count() > MAX_CHARS {
return Err(Error::Invalid(format!(
"The realm name can have at most {MAX_CHARS} characters."
)));
}
// The game client stores the realm as `SET realmName "<name>"` in Config.wtf.
if name.chars().any(|c| c.is_control() || c == '"') {
return Err(Error::Invalid(
"The realm name cannot contain quotation marks or control characters.".into(),
));
}
Ok(name.to_string())
}
/// The owner's name for realm `id`, if one was chosen.
pub fn custom(root: &Path, id: u32) -> Option<String> {
read(root)
.names
.remove(&id)
.and_then(|name| validate(&name).ok())
}
/// The name realm `id` shows: the owner's choice, or `default`.
pub fn name_or(root: &Path, id: u32, default: &str) -> String {
custom(root, id).unwrap_or_else(|| default.to_string())
}
/// The name the realm of `mode` shows.
pub fn for_mode(root: &Path, mode: crate::realms::Mode) -> String {
name_or(root, mode.realm_id(), mode.label())
}
/// Every chosen name.
pub fn all(root: &Path) -> BTreeMap<u32, String> {
read(root)
.names
.into_iter()
.filter_map(|(id, name)| validate(&name).ok().map(|name| (id, name)))
.collect()
}
/// Choose a name for realm `id`; `None` (or an empty name) returns it to its default.
pub fn set(root: &Path, id: u32, name: Option<&str>) -> Result<Option<String>> {
let mut names = read(root);
let chosen = match name.map(str::trim).filter(|n| !n.is_empty()) {
Some(name) => Some(validate(name)?),
None => None,
};
match &chosen {
Some(name) => names.names.insert(id, name.clone()),
None => names.names.remove(&id),
};
fsx::atomic_write_json(&main_folder(root).join(FILE), &names)?;
Ok(chosen)
}
/// A realm of this server and the name it shows.
#[derive(Debug, Clone, Serialize, PartialEq, Eq)]
#[serde(rename_all = "camelCase")]
pub struct RealmName {
pub id: u32,
pub name: String,
pub default_name: String,
pub custom: bool,
}
/// The realms of a server with their names: Conquest of Azeroth (or the plain repack's "AzerothCore") and the
/// Wildcard and Warcraft Reborn realms that were created.
pub fn list(root: &Path) -> Result<Vec<RealmName>> {
let main = main_folder(root);
let mut realms: Vec<(u32, &'static str)> = Vec::new();
if main.join("Settings/realm-profile.json").exists() {
let state = crate::realms::state(&main)?;
realms.extend(state.modes().into_iter().map(|m| (m.realm_id(), m.label())));
} else {
realms.push((1, "AzerothCore"));
}
realms.sort_unstable();
realms.dedup();
Ok(realms
.into_iter()
.map(|(id, default)| {
let custom = custom(&main, id);
RealmName {
id,
name: custom.clone().unwrap_or_else(|| default.to_string()),
default_name: default.to_string(),
custom: custom.is_some(),
}
})
.collect())
}
/// Choose a name and, when the database runs, write it to the realm list at once (the auth server shows it
/// within its realm refresh interval). Returns the realms with their names.
pub fn rename(root: &Path, id: u32, name: Option<&str>) -> Result<Vec<RealmName>> {
let main = main_folder(root);
let known = list(&main)?;
let realm = known
.iter()
.find(|r| r.id == id)
.ok_or_else(|| Error::Invalid(format!("This server has no realm {id}.")))?;
let shown = set(&main, id, name)?.unwrap_or_else(|| realm.default_name.clone());
crate::backup::with_running_database(&main, |db| {
db.query(&format!(
"UPDATE acore_auth.realmlist SET name={} WHERE id={id};",
sql_literal(&shown)
))
.map(|_| ())
})?;
list(&main)
}
/// `text` as a MySQL string literal (quotes and backslashes escaped).
pub fn sql_literal(text: &str) -> String {
let mut out = String::with_capacity(text.len() + 2);
out.push('\'');
for c in text.chars() {
match c {
'\'' => out.push_str("''"),
'\\' => out.push_str("\\\\"),
c => out.push(c),
}
}
out.push('\'');
out
}
#[cfg(test)]
mod tests {
use super::*;
#[test]
fn names_are_validated_trimmed_and_reset() {
let d = tempfile::tempdir().unwrap();
assert_eq!(name_or(d.path(), 1, "Conquest of Azeroth"), "Conquest of Azeroth");
assert_eq!(set(d.path(), 1, Some(" Owner's Realm ")).unwrap().as_deref(), Some("Owner's Realm"));
assert_eq!(name_or(d.path(), 1, "x"), "Owner's Realm");
assert!(set(d.path(), 2, Some(&"a".repeat(33))).is_err());
assert!(set(d.path(), 2, Some("bad\nname")).is_err());
assert_eq!(set(d.path(), 2, Some("Царство")).unwrap().as_deref(), Some("Царство"));
assert_eq!(all(d.path()).len(), 2);
assert_eq!(set(d.path(), 1, Some(" ")).unwrap(), None);
assert_eq!(name_or(d.path(), 1, "Conquest of Azeroth"), "Conquest of Azeroth");
}
#[test]
fn an_extra_world_reads_its_main_folders_names() {
let d = tempfile::tempdir().unwrap();
set(d.path(), 2, Some("Wild Side")).unwrap();
let extra = d.path().join(".realms/secondary");
std::fs::create_dir_all(&extra).unwrap();
assert_eq!(custom(&extra, 2).as_deref(), Some("Wild Side"));
}
#[test]
fn names_are_safe_in_sql() {
assert_eq!(sql_literal(r"O'Neil \ realm"), r"'O''Neil \\ realm'");
}
}
+42 -251
View File
@@ -185,8 +185,20 @@ pub fn view(root: &Path) -> Result<View> {
}
pub fn guard_module(root: &Path, id: &str) -> Result<()> {
if state(root)?.active != Mode::Coa && matches!(id, "companions" | "playerbots") {
return Err(Error::Invalid("Bot class mechanics have not been validated for this realm. This module is unavailable on this realm.".into()));
let s = state(root)?;
if matches!(id, "companions" | "playerbots") {
if let Ok(v) = view(root) {
if s.active == Mode::Wildcard && !v.supported {
return Err(Error::Invalid(
"The installed server binary does not support Wildcard mode.".into(),
));
}
if s.active == Mode::Reborn && !v.reborn_supported {
return Err(Error::Invalid(
"The installed server binary does not support Warcraft Reborn mode.".into(),
));
}
}
}
Ok(())
}
@@ -296,20 +308,14 @@ fn wildcard_configs(mut files: Files) -> Result<Files> {
}
}
}
for (key, value) in [("CoaBots.Enable", "0"), ("CoaBots.AutoLoginOnStartup", "0")] {
set(
&mut files,
"Core/configs/modules/mod_coa_playerbots.conf",
key,
value,
)?;
// Preserve existing CoaBots.Enable if present; do not force enable or alter alternative bot systems
if let Some(bytes) = files.get("Core/configs/modules/mod_coa_playerbots.conf") {
if let Ok(conf) = ConfFile::parse_bytes(bytes) {
if conf.get("CoaBots.Enable") == Some("1") {
set(&mut files, "Core/configs/modules/mod_coa_playerbots.conf", "CoaBots.Enable", "1")?;
}
}
}
set(
&mut files,
"Core/configs/modules/playerbots.conf",
"AiPlayerbot.Enabled",
"0",
)?;
Ok(files)
}
@@ -337,20 +343,14 @@ fn reborn_configs(mut files: Files) -> Result<Files> {
set(&mut files, path, "RealmID", "3")?;
}
}
for (key, value) in [("CoaBots.Enable", "0"), ("CoaBots.AutoLoginOnStartup", "0")] {
set(
&mut files,
"Core/configs/modules/mod_coa_playerbots.conf",
key,
value,
)?;
// Preserve existing CoaBots.Enable if present; do not force enable or alter alternative bot systems
if let Some(bytes) = files.get("Core/configs/modules/mod_coa_playerbots.conf") {
if let Ok(conf) = ConfFile::parse_bytes(bytes) {
if conf.get("CoaBots.Enable") == Some("1") {
set(&mut files, "Core/configs/modules/mod_coa_playerbots.conf", "CoaBots.Enable", "1")?;
}
}
}
set(
&mut files,
"Core/configs/modules/playerbots.conf",
"AiPlayerbot.Enabled",
"0",
)?;
Ok(files)
}
@@ -534,8 +534,6 @@ pub fn ensure_created(root: &Path, mode: Mode) -> Result<()> {
"Update the server to a build with Warcraft Reborn support first.".into(),
));
}
// Verify launcher support before creating databases, as selecting a realm does.
prepare_launcher(root)?;
let before = configs(root)?;
create_realm(root, &mut s, mode, &before)
}
@@ -565,8 +563,6 @@ pub fn select(root: &Path, mode: Mode) -> Result<View> {
"Disable the realms that start together before switching realms.".into(),
));
}
// Verify launcher support before creating databases or changing the selected realm.
prepare_launcher(root)?;
let before = configs(root)?;
fsx::atomic_write_json(&snapshot(root, s.active), &before)?;
create_realm(root, &mut s, mode, &before)?;
@@ -608,125 +604,6 @@ pub fn select(root: &Path, mode: Mode) -> Result<View> {
view(root)
}
/// Adapt the bundled launcher's canonical schema and realm choices without changing its supervision logic.
pub fn prepare_launcher(root: &Path) -> Result<()> {
// A Docker server has no launcher to adapt: the Docker backend reads the active realm itself.
if crate::docker::is_docker(root) {
return Ok(());
}
let path = root.join("Scripts/manage.py");
let source = fs::read_to_string(&path)?;
let patched = patch_launcher(&source)?;
if patched != source {
fsx::atomic_write(&path, patched.as_bytes())?;
// A Manager-owned transformation is still pristine for subsequent updates and file checks.
if let Ok(dir) = crate::registry::metadata_dir_for(root) {
if let Ok((_, mut meta)) = crate::registry::MetaDir::open(&dir) {
if meta
.original_hashes
.get("Scripts/manage.py")
.is_some_and(|hash| hash == &fsx::sha256_bytes(source.as_bytes()))
{
meta.original_hashes.insert(
"Scripts/manage.py".into(),
fsx::sha256_bytes(patched.as_bytes()),
);
fsx::atomic_write_json(&dir.join("install.json"), &meta)?;
}
}
}
}
Ok(())
}
const LAUNCHER_REALM_REPLACEMENTS: &[(&str, &str)] = &[
("(\"WorldDatabaseInfo\", \"acore_world\")", "(\"WorldDatabaseInfo\", \"acore_world_wildcard\" if coa_realm() == 'wildcard' else \"acore_world\")"),
("(\"CharacterDatabaseInfo\", \"acore_characters\")", "(\"CharacterDatabaseInfo\", \"acore_characters_wildcard\" if coa_realm() == 'wildcard' else \"acore_characters\")"),
("SET name='AzerothCore',address=", "SET name='{coa_realm_name()}',address="),
("WHERE id=1;", "WHERE id={coa_realm_id()};"),
("mysql(\"UPDATE acore_auth.realmlist SET flag=0", "mysql(f\"UPDATE acore_auth.realmlist SET flag=0"),
];
const LAUNCHER_REALM_INSERT: &str = "# coa-manager-realm-profiles-v1\ndef coa_realm():\n path = ROOT / 'Settings/realm-profile.json'\n return json.loads(path.read_text(encoding='utf-8')).get('active', 'coa') if path.exists() else 'coa'\n\ndef coa_realm_id():\n return 2 if coa_realm() == 'wildcard' else 1\n\ndef coa_realm_name():\n return 'Wildcard' if coa_realm() == 'wildcard' else 'Conquest of Azeroth'\n\n";
fn launcher_insert() -> String {
LAUNCHER_REALM_INSERT
.replace("profiles-v1", "profiles-v2")
.replace(
"return 2 if",
"return 3 if coa_realm() == 'reborn' else 2 if",
)
.replace(
"return 'Wildcard' if",
"return 'Warcraft Reborn' if coa_realm() == 'reborn' else 'Wildcard' if",
)
}
fn launcher_replacements() -> Vec<(&'static str, String)> {
LAUNCHER_REALM_REPLACEMENTS.iter().map(|(from, to)| (*from, to
.replace("\"acore_world_wildcard\" if", "\"acore_world_reborn\" if coa_realm() == 'reborn' else \"acore_world_wildcard\" if")
.replace("\"acore_characters_wildcard\" if", "\"acore_characters_reborn\" if coa_realm() == 'reborn' else \"acore_characters_wildcard\" if"))).collect()
}
pub(crate) fn patch_launcher(source: &str) -> Result<String> {
if source.contains("# coa-manager-realm-profiles-v2") {
return Ok(source.into());
}
if source.contains("# coa-manager-realm-profiles-v1") {
let original = unpatch_launcher(source)
.ok_or_else(|| Error::Invalid("Unrecognised realm launcher patch.".into()))?;
return patch_launcher(&original);
}
let mut out = source.to_string();
for (from, to) in launcher_replacements() {
if !out.contains(from) {
return Err(Error::Invalid(
"This launcher does not support realm profiles. Update the server package first."
.into(),
));
}
out = out.replace(from, &to);
}
// Insert before the entry point so ROOT, json and functions are all defined when called.
let marker = "if __name__ == \"__main__\":";
if !out.contains(marker) {
return Err(Error::Invalid(
"Unrecognised server launcher entry point.".into(),
));
}
Ok(out.replace(marker, &format!("{}{marker}", launcher_insert())))
}
/// Reverse only our exact realm transformation; callers must verify the recovered original hash.
pub(crate) fn unpatch_launcher(source: &str) -> Option<String> {
let (insert, replacements) = if source.contains(&launcher_insert()) {
(launcher_insert(), launcher_replacements())
} else if source.contains(LAUNCHER_REALM_INSERT) {
(
LAUNCHER_REALM_INSERT.into(),
LAUNCHER_REALM_REPLACEMENTS
.iter()
.map(|(a, b)| (*a, b.to_string()))
.collect(),
)
} else {
return None;
};
let mut original = source.replacen(&insert, "", 1);
for (from, to) in &replacements {
original = original.replace(to, from);
}
let mut check = original.clone();
for (from, to) in &replacements {
check = check.replace(from, to);
}
check = check.replace(
"if __name__ == \"__main__\":",
&format!("{insert}if __name__ == \"__main__\":"),
);
(check == source).then_some(original)
}
/// The character-creation model the world server advertises for a realm. Every realm has its own database and its own
/// entry on Overview, so it advertises exactly one model: a list such as `"coa wcr"` would let players create
/// Warcraft Reborn characters in the Conquest of Azeroth realm.
@@ -770,7 +647,6 @@ pub fn before_start(root: &Path) -> Result<()> {
if !root.join(STATE).exists() {
return Ok(());
}
prepare_launcher(root)?;
if s.simultaneous && !view(root)?.supported {
return Err(Error::Invalid(
"The installed server build does not support simultaneous Wildcard startup.".into(),
@@ -805,19 +681,7 @@ pub fn before_start(root: &Path) -> Result<()> {
"The installed server build does not support Wildcard.".into(),
));
}
let path = root.join("Core/configs/modules/mod_coa_playerbots.conf");
let mut conf = ConfFile::parse_bytes(&fs::read(&path)?)?;
conf.set("CoaBots.Enable", "0", &[]);
fsx::atomic_write(&path, conf.to_text().as_bytes())?;
let path = root.join("Core/configs/modules/playerbots.conf");
let bytes = if path.exists() {
fs::read(&path)?
} else {
b"[worldserver]\n".to_vec()
};
let mut conf = ConfFile::parse_bytes(&bytes)?;
conf.set("AiPlayerbot.Enabled", "0", &[]);
fsx::atomic_write(&path, conf.to_text().as_bytes())?;
// Multi-realm Playerbots 1.0: bots are supported and enabled on all realms
}
Ok(())
}
@@ -831,8 +695,8 @@ pub fn setup_realmlist(root: &Path) -> Result<()> {
let port = layout::read_ports(root).world;
for mode in s.modes().into_iter().filter(|m| *m != Mode::Coa) {
let id = mode.realm_id();
let name = mode.label();
db.query(&format!("INSERT INTO acore_auth.realmlist (id,name,address,localAddress,localSubnetMask,port,icon,flag,timezone,gamebuild) SELECT {id},'{name}',address,localAddress,localSubnetMask,{port},icon,2,timezone,gamebuild FROM acore_auth.realmlist WHERE id=1 ON DUPLICATE KEY UPDATE port={port};"))?;
let name = crate::realm_names::sql_literal(&crate::realm_names::name_or(root, id, mode.label()));
db.query(&format!("INSERT INTO acore_auth.realmlist (id,name,address,localAddress,localSubnetMask,port,icon,flag,timezone,gamebuild) SELECT {id},{name},address,localAddress,localSubnetMask,{port},icon,2,timezone,gamebuild FROM acore_auth.realmlist WHERE id=1 ON DUPLICATE KEY UPDATE port={port},name={name};"))?;
}
let ids = s
.modes()
@@ -937,11 +801,12 @@ mod tests {
.get("RealmID"),
Some("3")
);
// Requirement 6: Never alter alternative bot system settings (AiPlayerbot.Enabled) without explicit user choice
assert_eq!(
ConfFile::parse_bytes(&reborn["Core/configs/modules/playerbots.conf"])
.unwrap()
.get("AiPlayerbot.Enabled"),
Some("0")
Some("1")
);
write_configs(t.path(), &reborn).unwrap();
write_configs(t.path(), &coa).unwrap();
@@ -955,8 +820,8 @@ mod tests {
},
)
.unwrap();
assert!(guard_module(t.path(), "companions").is_err());
assert!(guard_module(t.path(), "playerbots").is_err());
assert!(guard_module(t.path(), "companions").is_ok());
assert!(guard_module(t.path(), "playerbots").is_ok());
assert!(guard_module(t.path(), "content-scaling").is_ok());
}
@@ -1107,26 +972,6 @@ CoA.GameModeMask = 0
assert!(!v.supported);
}
#[test]
fn old_launcher_upgrades_and_both_patch_versions_are_reversible() {
let original = "(\"WorldDatabaseInfo\", \"acore_world\")\n(\"CharacterDatabaseInfo\", \"acore_characters\")\nSET name='AzerothCore',address=\nWHERE id=1;\nmysql(\"UPDATE acore_auth.realmlist SET flag=0\nif __name__ == \"__main__\":\n";
let mut old = original.to_string();
for (from, to) in LAUNCHER_REALM_REPLACEMENTS {
old = old.replace(from, to);
}
old = old.replace(
"if __name__ == \"__main__\":",
&format!("{LAUNCHER_REALM_INSERT}if __name__ == \"__main__\":"),
);
assert_eq!(unpatch_launcher(&old).as_deref(), Some(original));
let new = patch_launcher(&old).unwrap();
assert!(new.contains("acore_world_reborn"));
assert!(new.contains("return 3 if coa_realm() == 'reborn'"));
assert!(new.contains("return 'Warcraft Reborn' if"));
assert_eq!(patch_launcher(&new).unwrap(), new);
assert_eq!(unpatch_launcher(&new).as_deref(), Some(original));
}
#[test]
fn a_docker_server_is_checked_for_wildcard_support_in_its_own_binary() {
let d = tempfile::tempdir().unwrap();
@@ -1157,20 +1002,6 @@ CoA.GameModeMask = 0
assert!(view(d.path()).unwrap().supported);
}
#[test]
fn a_docker_server_has_no_launcher_to_adapt() {
let d = tempfile::tempdir().unwrap();
fs::create_dir_all(d.path().join("Settings")).unwrap();
// No Scripts/manage.py anywhere: on a repack this fails, on a Docker server there is nothing to do.
assert!(prepare_launcher(d.path()).is_err());
fs::write(
d.path().join("Settings/docker.json"),
br#"{"project":"t1"}"#,
)
.unwrap();
prepare_launcher(d.path()).unwrap();
}
#[test]
fn fresh_wildcard_disables_bots_and_preserves_scaling() {
let mut f = Files::new();
@@ -1178,6 +1009,10 @@ CoA.GameModeMask = 0
"Core/configs/modules/mod-coa-content-scaling.conf".into(),
b"[worldserver]\nCoAContentScaling.Enable = 1\n".to_vec(),
);
f.insert(
"Core/configs/modules/mod_coa_playerbots.conf".into(),
b"[worldserver]\nCoaBots.Enable = 1\n".to_vec(),
);
f.insert(
"Settings/worldserver.conf.template".into(),
b"[worldserver]\nRealmID = 1\n".to_vec(),
@@ -1188,7 +1023,7 @@ CoA.GameModeMask = 0
f["Core/configs/modules/mod-coa-content-scaling.conf"]
);
let c = ConfFile::parse_bytes(&w["Core/configs/modules/mod_coa_playerbots.conf"]).unwrap();
assert_eq!(c.get("CoaBots.Enable"), Some("0"));
assert_eq!(c.get("CoaBots.Enable"), Some("1"));
assert_eq!(
ConfFile::parse_bytes(&w["Settings/worldserver.conf.template"])
.unwrap()
@@ -1260,52 +1095,8 @@ CoA.GameModeMask = 0
},
)
.unwrap();
assert!(crate::modules::set_enabled(t.path(), t.path(), "companions", true).is_err());
assert!(crate::config::save(
t.path(),
t.path(),
crate::config::Scope::Bots,
&BTreeMap::new()
)
.is_err());
assert!(guard_module(t.path(), "companions").is_ok());
assert!(guard_module(t.path(), "playerbots").is_ok());
assert!(guard_module(t.path(), "content-scaling").is_ok());
}
#[test]
fn unknown_launcher_is_refused_without_partial_patching() {
assert!(patch_launcher("print('custom launcher')").is_err());
}
#[test]
fn managed_launcher_patch_remains_pristine_but_external_edits_conflict() {
let d = tempfile::tempdir().unwrap();
let root = d.path().join("server");
let source = "(\"WorldDatabaseInfo\", \"acore_world\")\n(\"CharacterDatabaseInfo\", \"acore_characters\")\nSET name='AzerothCore',address=\nWHERE id=1;\nmysql(\"UPDATE acore_auth.realmlist SET flag=0\nif __name__ == \"__main__\":\n";
fsx::atomic_write(&root.join("Scripts/manage.py"), source.as_bytes()).unwrap();
let mut meta = crate::registry::InstallMeta::new(crate::registry::InstallKind::New, &root);
meta.original_hashes.insert(
"Scripts/manage.py".into(),
fsx::sha256_bytes(source.as_bytes()),
);
let dir = crate::registry::MetaDir::create(&root, &meta).unwrap();
prepare_launcher(&root).unwrap();
let (_, meta) = crate::registry::MetaDir::open(&dir.root).unwrap();
assert!(crate::diag::verify_managed(&root, &meta).is_empty());
let manifest: crate::manifest::Manifest = serde_json::from_value(serde_json::json!({
"schema": 1, "kind": "update", "version": "2.0.0", "core": {"commit": null}, "builtAt": "fixture", "minManagerVersion": "0.1.0",
"files": [{"path":"Scripts/manage.py","sha256":fsx::sha256_bytes(b"next release"),"size":12,"owner":"core","policy":"replace"}]
})).unwrap();
assert_eq!(
crate::update::plan(&root, &meta, &manifest, &BTreeMap::new(), None).unwrap()[0].action,
crate::update::Action::Replace
);
let mut modified = fs::read(root.join("Scripts/manage.py")).unwrap();
modified.extend_from_slice(b"# custom edit\n");
fsx::atomic_write(&root.join("Scripts/manage.py"), &modified).unwrap();
prepare_launcher(&root).unwrap();
assert_eq!(
crate::update::plan(&root, &meta, &manifest, &BTreeMap::new(), None).unwrap()[0].action,
crate::update::Action::Conflict
);
}
}
-499
View File
@@ -1,499 +0,0 @@
//! Keeps installed plugins usable across core changes.
//!
//! A plugin loads only into the core whose ABI fingerprint it was built with, and the core changes almost
//! every day. After a core update (or a rollback) every plugin that should run is brought to the current
//! fingerprint: an earlier build already in the store is reused, otherwise it is rebuilt from the sources
//! it was last built from. A plugin that cannot be brought up to date is switched off with the reason; the
//! core update itself always goes ahead.
use std::fs;
use std::path::Path;
use std::collections::BTreeMap;
use std::path::PathBuf;
use std::sync::OnceLock;
use serde::{Deserialize, Serialize};
use crate::build_engine;
use crate::error::Result;
use crate::plugins;
#[derive(Debug, Clone, Serialize, PartialEq, Eq)]
#[serde(tag = "result", rename_all = "camelCase")]
pub enum ModuleRebuild {
/// Already built for this core.
UpToDate { id: String },
/// An earlier build for this core was still in the store (a rollback to a core seen before).
Reused { id: String },
Rebuilt { id: String, seconds: u64 },
/// A module the core recommends, built and switched on for the first time (the move from a core
/// with the module built in to a core that loads it as a plugin).
Installed { id: String, seconds: u64 },
/// Switched off; `also` lists the plugins that depend on it and were switched off with it.
Disabled { id: String, reason: String, also: Vec<String> },
}
/// Whether a plugin takes part: enabled, or switched off earlier only because a rebuild failed.
fn wanted(entry: &plugins::PluginEntry) -> bool {
entry.installed && (entry.enabled || entry.disabled_reason.is_some())
}
/// Brings every plugin that should run to the realm's current core. Does nothing for a core without
/// plugin support. Never fails because of one plugin: each outcome is reported.
pub fn rebuild_for_current_core(
realm_root: &Path,
progress: &dyn Fn(&str, &str),
) -> Result<Vec<ModuleRebuild>> {
let Some(host) = crate::provenance::realm_host_fingerprint(realm_root) else {
return Ok(Vec::new());
};
let mut out = install_recommended(realm_root, progress);
let registry = plugins::load_registry(realm_root)?;
for (id, entry) in registry.plugins.iter().filter(|(_, e)| wanted(e)) {
if out.iter().any(|o| matches!(o, ModuleRebuild::Installed { id: done, .. } if done == id)) {
continue;
}
if entry.enabled && plugins::installed_plugin_fingerprint(realm_root, id).as_deref() == Some(host.as_str()) {
out.push(ModuleRebuild::UpToDate { id: id.clone() });
continue;
}
if out.iter().any(|o| matches!(o, ModuleRebuild::Disabled { also, .. } if also.contains(id))) {
continue; // switched off together with a plugin it depends on
}
progress(id, "Building the module for the new core");
let result = bring_up_to_date(realm_root, id, &host, progress).and_then(|done| {
if !plugins::load_registry(realm_root).map_err(|e| e.to_string())?.plugins.get(id).is_some_and(|e| e.enabled) {
plugins::set_enabled(realm_root, id, true).map_err(|e| e.to_string())?;
}
Ok(done)
});
out.push(match result {
Ok(done) => done,
Err(reason) => {
let reason = first_line(&reason);
progress(id, &format!("Switched off: {reason}"));
let off = plugins::disable_with_reason(realm_root, id, &reason)?;
ModuleRebuild::Disabled { id: id.clone(), reason, also: off.into_iter().skip(1).collect() }
}
});
}
Ok(out)
}
fn bring_up_to_date(
realm_root: &Path,
id: &str,
host: &str,
progress: &dyn Fn(&str, &str),
) -> std::result::Result<ModuleRebuild, String> {
if let Some(sha) = stored_build_for(realm_root, id, host) {
reuse_stored(realm_root, id, &sha).map_err(|e| e.to_string())?;
return Ok(ModuleRebuild::Reused { id: id.to_string() });
}
let recipe = build_engine::read_build_recipe(realm_root, id)
.ok_or("the manager does not know which sources this module was built from; install it again")?;
if !recipe.source_dir.is_dir() || recipe.bundled.iter().any(|b| !b.is_dir()) {
return Err("the module's sources are no longer on this PC; install it again".into());
}
let started = std::time::Instant::now();
let built = build_engine::build_module_with_bundle(&recipe.source_dir, &recipe.bundled, realm_root, None, None)
.map_err(|e| e.to_string())?;
if !built.success {
// Never fall through to a package left by an earlier build: that one was made for the old core.
return Err(build_failure_reason(&built.errors));
}
if built.module_id != id {
return Err(format!("the sources now build module '{}', not '{id}'", built.module_id));
}
progress(id, "Installing the rebuilt module");
let (meta, dll, confs) = crate::preview::built_package(realm_root, id, &built.version).map_err(|e| e.to_string())?;
let confs: Vec<(String, &[u8])> = confs.iter().map(|(n, b)| (n.clone(), b.as_slice())).collect();
plugins::update(realm_root, meta, &dll, None, &confs).map_err(|e| e.to_string())?;
if plugins::installed_plugin_fingerprint(realm_root, id).as_deref() != Some(host) {
return Err("the rebuilt module does not match the installed core".into());
}
Ok(ModuleRebuild::Rebuilt { id: id.to_string(), seconds: started.elapsed().as_secs() })
}
/// Why a module did not build for the new core, from the compiler's first error.
fn build_failure_reason(errors: &[build_engine::BuildErrorDiagnostic]) -> String {
match errors.first() {
Some(e) if !e.file.is_empty() => {
let file = e.file.rsplit(['/', '\\']).next().unwrap_or(&e.file);
format!("it does not build for the new core: {} ({file}:{}, {})", first_line(&e.message), e.line, e.error_code)
}
Some(e) => format!("it does not build for the new core: {}", first_line(&e.message)),
None => "it does not build for the new core".into(),
}
}
/// The store keeps every build by content hash: find one made for `host`.
fn stored_build_for(realm_root: &Path, id: &str, host: &str) -> Option<String> {
let dir = plugins::store_dir(realm_root).join(id);
fs::read_dir(dir).ok()?.flatten().find_map(|e| {
let dll = e.path().join(format!("{id}.dll"));
(crate::provenance::file_abi_fingerprint(&dll).as_deref() == Some(host))
.then(|| e.file_name().to_string_lossy().into_owned())
})
}
fn reuse_stored(realm_root: &Path, id: &str, sha: &str) -> Result<()> {
let dir = plugins::store_dir(realm_root).join(id).join(sha);
let meta = plugins::load_store_metadata(realm_root, id, sha)?;
let dll = fs::read(dir.join(format!("{id}.dll")))?;
let mut confs = Vec::new();
for name in &meta.conf_files {
if let Ok(bytes) = fs::read(dir.join(name)) {
confs.push((name.clone(), bytes));
}
}
let confs: Vec<(String, &[u8])> = confs.iter().map(|(n, b)| (n.clone(), b.as_slice())).collect();
plugins::update(realm_root, meta, &dll, None, &confs)
}
// ---------------------------------------------------------------------------------------------------
// Modules the core recommends
// ---------------------------------------------------------------------------------------------------
static SOURCE_CACHE: OnceLock<PathBuf> = OnceLock::new();
/// Where module sources are downloaded (the app's own cache); set once at startup.
pub fn set_source_cache(dir: PathBuf) {
let _ = SOURCE_CACHE.set(dir);
}
fn source_cache() -> PathBuf {
SOURCE_CACHE.get().cloned().unwrap_or_else(|| std::env::temp_dir().join("coa_github_cache"))
}
/// `Core/plugins/recommended.json`, shipped with a plugin-host core: the modules a server of the
/// monolithic release had built in, at the commits this core was qualified with.
#[derive(Debug, Clone, Deserialize)]
#[serde(rename_all = "camelCase", deny_unknown_fields)]
pub struct Recommended {
pub schema: u32,
pub modules: Vec<RecommendedModule>,
}
#[derive(Debug, Clone, Deserialize)]
#[serde(rename_all = "camelCase", deny_unknown_fields)]
pub struct RecommendedModule {
pub id: String,
/// `owner/name` on GitHub.
pub repo: String,
pub commit: String,
/// Source trees compiled into the same plugin: a folder of this repository, or of another one.
#[serde(default)]
pub bundled: Vec<BundledSource>,
/// When to install it: "always" (default), "config:<file>:<key>=<value>" (the owner had it switched
/// on in that module config), or "unless:<id>" (a module that excludes it is switched on).
#[serde(default)]
pub when: Option<String>,
}
#[derive(Debug, Clone, Deserialize)]
#[serde(rename_all = "camelCase", deny_unknown_fields)]
pub struct BundledSource {
#[serde(default)]
pub repo: Option<String>,
#[serde(default)]
pub commit: Option<String>,
#[serde(default)]
pub path: String,
}
fn recommended(realm_root: &Path) -> Option<Recommended> {
let path = plugins::plugins_install_dir(realm_root).join("recommended.json");
let r: Recommended = serde_json::from_slice(&fs::read(path).ok()?).ok()?;
(r.schema == 1).then_some(r)
}
/// `.manager/recommended-modules.json`: recommended modules already dealt with (installed, or not wanted
/// by their rule), so a module the owner later removes is not installed again.
fn handled_path(realm_root: &Path) -> PathBuf {
plugins::meta_dir(realm_root).join("recommended-modules.json")
}
fn load_handled(realm_root: &Path) -> BTreeMap<String, String> {
fs::read(handled_path(realm_root)).ok()
.and_then(|b| serde_json::from_slice::<serde_json::Value>(&b).ok())
.and_then(|v| serde_json::from_value(v.get("handled")?.clone()).ok())
.unwrap_or_default()
}
fn save_handled(realm_root: &Path, handled: &BTreeMap<String, String>) {
let body = serde_json::json!({ "schema": 1, "handled": handled });
let _ = fs::create_dir_all(plugins::meta_dir(realm_root));
let text = serde_json::to_string_pretty(&body).unwrap_or_default();
let _ = crate::fsx::atomic_write(&handled_path(realm_root), text.as_bytes());
}
/// Whether `rule` asks for the module on this server, given the plugins already switched on.
fn rule_allows(realm_root: &Path, rule: Option<&str>, enabled: &[String]) -> bool {
let rule = rule.unwrap_or("always");
if rule == "always" {
return true;
}
if let Some(other) = rule.strip_prefix("unless:") {
return !enabled.iter().any(|e| e == other);
}
if let Some(spec) = rule.strip_prefix("config:") {
let Some((file, kv)) = spec.split_once(':') else { return false };
let Some((key, value)) = kv.split_once('=') else { return false };
if file.contains('/') || file.contains('\\') || file.contains("..") {
return false;
}
let path = plugins::modules_config_dir(realm_root).join(file);
return fs::read(&path).ok()
.and_then(|b| crate::config::parser::ConfFile::parse_bytes(&b).ok())
.and_then(|c| c.get(key).map(|v| v.trim().trim_matches('"') == value))
.unwrap_or(false);
}
false
}
fn split_repo(repo: &str) -> std::result::Result<(&str, &str), String> {
repo.split_once('/')
.filter(|(o, r)| !o.is_empty() && !r.is_empty() && !r.contains('/'))
.ok_or_else(|| format!("invalid repository '{repo}'"))
}
fn install_recommended(realm_root: &Path, progress: &dyn Fn(&str, &str)) -> Vec<ModuleRebuild> {
let Some(rec) = recommended(realm_root) else { return Vec::new() };
let mut handled = load_handled(realm_root);
let mut out = Vec::new();
for m in &rec.modules {
let registry = plugins::load_registry(realm_root).unwrap_or_default();
if handled.contains_key(&m.id) || registry.plugins.contains_key(&m.id) {
continue;
}
let enabled: Vec<String> = registry.plugins.iter().filter(|(_, e)| e.enabled).map(|(k, _)| k.clone()).collect();
if !rule_allows(realm_root, m.when.as_deref(), &enabled) {
handled.insert(m.id.clone(), format!("not wanted ({})", m.when.as_deref().unwrap_or("")));
continue;
}
progress(&m.id, "Downloading and building the module for this core");
let started = std::time::Instant::now();
match install_one(realm_root, m) {
Ok(()) => {
handled.insert(m.id.clone(), m.commit.clone());
out.push(ModuleRebuild::Installed { id: m.id.clone(), seconds: started.elapsed().as_secs() });
}
// Not marked as handled: the next core change tries again.
Err(reason) => out.push(ModuleRebuild::Disabled { id: m.id.clone(), reason: first_line(&reason), also: Vec::new() }),
}
}
save_handled(realm_root, &handled);
out
}
fn install_one(realm_root: &Path, m: &RecommendedModule) -> std::result::Result<(), String> {
let cache = source_cache();
let (owner, name) = split_repo(&m.repo)?;
let primary = crate::module_sources::fetch_pinned(owner, name, &m.commit, &cache).map_err(|e| e.to_string())?;
let mut bundled = Vec::new();
for b in &m.bundled {
let base = match (&b.repo, &b.commit) {
(Some(repo), Some(commit)) => {
let (o, n) = split_repo(repo)?;
crate::module_sources::fetch_pinned(o, n, commit, &cache).map_err(|e| e.to_string())?
}
(None, None) => primary.clone(),
_ => return Err(format!("a bundled source of '{}' needs both repo and commit", m.id)),
};
let dir = if b.path.is_empty() { base } else { crate::fsx::safe_join(&base, &b.path).map_err(|e| e.to_string())? };
if !dir.is_dir() {
return Err(format!("bundled source '{}' is missing", b.path));
}
bundled.push(dir);
}
let built = build_engine::build_module_with_bundle(&primary, &bundled, realm_root, None, None).map_err(|e| e.to_string())?;
if built.module_id != m.id {
return Err(format!("the sources build module '{}', not '{}'", built.module_id, m.id));
}
let (meta, dll, confs) = crate::preview::built_package(realm_root, &m.id, &built.version).map_err(|e| e.to_string())?;
let confs: Vec<(String, &[u8])> = confs.iter().map(|(n, b)| (n.clone(), b.as_slice())).collect();
plugins::install(realm_root, meta, &dll, None, &confs, true).map_err(|e| e.to_string())
}
fn first_line(s: &str) -> String {
let line = s.lines().find(|l| !l.trim().is_empty()).unwrap_or(s).trim();
if line.chars().count() > 300 { line.chars().take(300).collect::<String>() + "…" } else { line.to_string() }
}
#[cfg(test)]
mod tests {
use super::*;
use crate::plugins::{PluginMetadata, PluginsRegistry};
use std::collections::BTreeMap;
/// The smallest PE image with a ".coapl" section, as plugins and plugin hosts carry it.
fn image(id: &str, fp: &str) -> Vec<u8> {
let text = format!("COAPLUGIN1|{id}|{fp}\0");
let mut b = vec![0u8; 0x200];
b[0] = b'M';
b[1] = b'Z';
b[0x3C..0x40].copy_from_slice(&0x40u32.to_le_bytes());
b[0x40..0x44].copy_from_slice(b"PE\0\0");
b[0x46..0x48].copy_from_slice(&1u16.to_le_bytes()); // one section, no optional header
let sec = 0x40 + 24;
b[sec..sec + 6].copy_from_slice(b".coapl");
let len = text.len() as u32;
b[sec + 8..sec + 12].copy_from_slice(&len.to_le_bytes());
b[sec + 16..sec + 20].copy_from_slice(&len.to_le_bytes());
b[sec + 20..sec + 24].copy_from_slice(&0x100u32.to_le_bytes());
b[0x100..0x100 + text.len()].copy_from_slice(text.as_bytes());
b
}
fn meta(id: &str, dll: &[u8]) -> PluginMetadata {
PluginMetadata {
id: id.into(),
name: id.into(),
version: "1.0.0".into(),
description: BTreeMap::new(),
sha256: plugins::sha256_digest(dll),
required: false,
deps: vec![],
conf_files: vec![],
enable_key: None,
status: None,
icon: None,
}
}
fn registry(server: &Path) -> PluginsRegistry {
plugins::load_registry(server).unwrap()
}
#[test]
fn plugins_follow_the_core_or_are_switched_off_with_a_reason() {
let old_fp = "a".repeat(64);
let new_fp = "b".repeat(64);
let dir = tempfile::tempdir().unwrap();
let server = dir.path();
fs::create_dir_all(server.join("Core")).unwrap();
fs::write(server.join("Core/worldserver.exe"), image("worldserver", &old_fp)).unwrap();
// "kept" was built for both cores (the store has both builds); "lost" only for the old one and
// the manager has no recipe to rebuild it from.
let kept_new = image("kept", &new_fp);
let kept_old = image("kept", &old_fp);
plugins::install(server, meta("kept", &kept_new), &kept_new, None, &[], true).unwrap();
plugins::update(server, meta("kept", &kept_old), &kept_old, None, &[]).unwrap();
let lost = image("lost", &old_fp);
plugins::install(server, meta("lost", &lost), &lost, None, &[], true).unwrap();
// A plugin the owner switched off stays off and is not rebuilt.
let idle = image("idle", &old_fp);
plugins::install(server, meta("idle", &idle), &idle, None, &[], false).unwrap();
// Same core: nothing to do.
let same = rebuild_for_current_core(server, &|_, _| {}).unwrap();
assert_eq!(same, vec![
ModuleRebuild::UpToDate { id: "kept".into() },
ModuleRebuild::UpToDate { id: "lost".into() },
]);
// New core.
fs::write(server.join("Core/worldserver.exe"), image("worldserver", &new_fp)).unwrap();
let out = rebuild_for_current_core(server, &|_, _| {}).unwrap();
assert_eq!(out[0], ModuleRebuild::Reused { id: "kept".into() });
assert!(matches!(&out[1], ModuleRebuild::Disabled { id, reason, .. } if id == "lost" && reason.contains("install it again")));
assert_eq!(out.len(), 2);
let reg = registry(server);
assert!(reg.plugins["kept"].enabled);
assert_eq!(plugins::installed_plugin_fingerprint(server, "kept").as_deref(), Some(new_fp.as_str()));
assert!(!reg.plugins["lost"].enabled);
assert!(reg.plugins["lost"].disabled_reason.is_some());
assert!(!reg.plugins["idle"].enabled && reg.plugins["idle"].disabled_reason.is_none());
let lock = fs::read_to_string(plugins::lockfile_path(server)).unwrap();
assert!(lock.contains("kept") && !lock.contains("\"lost\""), "{lock}");
// Back to the old core (a rollback): the old builds are put back, "lost" is switched on again.
fs::write(server.join("Core/worldserver.exe"), image("worldserver", &old_fp)).unwrap();
let back = rebuild_for_current_core(server, &|_, _| {}).unwrap();
assert_eq!(back, vec![
ModuleRebuild::Reused { id: "kept".into() },
ModuleRebuild::Reused { id: "lost".into() },
]);
let reg = registry(server);
assert!(reg.plugins["kept"].enabled && reg.plugins["lost"].enabled);
assert!(reg.plugins["lost"].disabled_reason.is_none());
}
#[test]
fn recommended_modules_follow_what_the_owner_used() {
let dir = tempfile::tempdir().unwrap();
let server = dir.path();
fs::create_dir_all(server.join("Core/configs/modules")).unwrap();
fs::create_dir_all(server.join("Core/plugins")).unwrap();
fs::write(server.join("Core/worldserver.exe"), image("worldserver", &"c".repeat(64))).unwrap();
let conf = server.join("Core/configs/modules/playerbots.conf");
fs::write(&conf, "AiPlayerbot.Enabled = 1\n").unwrap();
assert!(rule_allows(server, Some("config:playerbots.conf:AiPlayerbot.Enabled=1"), &[]));
fs::write(&conf, "AiPlayerbot.Enabled = 0\n").unwrap();
assert!(!rule_allows(server, Some("config:playerbots.conf:AiPlayerbot.Enabled=1"), &[]));
assert!(!rule_allows(server, Some("config:../x.conf:A=1"), &[]));
assert!(!rule_allows(server, Some("unless:playerbots"), &["playerbots".into()]));
assert!(rule_allows(server, Some("unless:playerbots"), &["companions".into()]));
assert!(rule_allows(server, None, &[]));
assert!(!rule_allows(server, Some("sometimes"), &[]));
// SQUID was off on the old server: it is not installed, and is not offered again later. A module
// whose sources cannot be fetched is reported and retried at the next core change.
fs::write(server.join("Core/plugins/recommended.json"), r#"{"schema":1,"modules":[
{"id":"playerbots","repo":"Zyth45/mod-playerbots","commit":"0000000000000000000000000000000000000000","when":"config:playerbots.conf:AiPlayerbot.Enabled=1"},
{"id":"companions","repo":"not-a-repo","commit":"0000000000000000000000000000000000000000","when":"unless:playerbots"}]}"#).unwrap();
let out = rebuild_for_current_core(server, &|_, _| {}).unwrap();
assert_eq!(out.len(), 1);
assert!(matches!(&out[0], ModuleRebuild::Disabled { id, reason, .. } if id == "companions" && reason.contains("invalid repository")));
let handled = load_handled(server);
assert!(handled["playerbots"].starts_with("not wanted"));
assert!(!handled.contains_key("companions"));
}
/// Real run: COA_TEST_RECOMMENDED_REALM is a plugin-host realm with Core/plugins/recommended.json (or
/// plugins/recommended.json); the modules are downloaded from GitHub, built and switched on.
#[test]
fn recommended_modules_install_on_a_real_realm() {
let Ok(realm) = std::env::var("COA_TEST_RECOMMENDED_REALM") else { return };
let realm = Path::new(&realm);
let out = rebuild_for_current_core(realm, &|id, what| println!("{id}: {what}")).unwrap();
println!("{out:#?}");
let host = crate::provenance::realm_host_fingerprint(realm).unwrap();
for o in &out {
let ModuleRebuild::Installed { id, .. } = o else { panic!("not installed: {o:?}") };
assert_eq!(plugins::installed_plugin_fingerprint(realm, id).as_deref(), Some(host.as_str()));
}
let lock = fs::read_to_string(plugins::lockfile_path(realm)).unwrap();
println!("{lock}");
}
#[test]
fn a_failed_build_names_the_compiler_error() {
let e = build_engine::BuildErrorDiagnostic {
file: "C:\\brk\\src\\PlayerbotAIConfig.cpp".into(),
line: 1,
error_code: "C1189".into(),
message: "#error: coa e2e: this module deliberately does not build\nmore".into(),
explanation: None,
resolution: None,
};
assert_eq!(
build_failure_reason(&[e]),
"it does not build for the new core: #error: coa e2e: this module deliberately does not build (PlayerbotAIConfig.cpp:1, C1189)"
);
assert_eq!(build_failure_reason(&[]), "it does not build for the new core");
}
#[test]
fn a_monolithic_core_needs_no_rebuild() {
let dir = tempfile::tempdir().unwrap();
fs::create_dir_all(dir.path().join("Core")).unwrap();
fs::write(dir.path().join("Core/worldserver.exe"), b"MZ no plugin host").unwrap();
assert!(rebuild_for_current_core(dir.path(), &|_, _| {}).unwrap().is_empty());
}
}
-108
View File
@@ -572,111 +572,3 @@ mod tests {
);
}
}
/// Input of `derive_preview_update`: a signed stable update package and the plugin-host core built from
/// the same core commit.
pub struct PreviewParams<'a> {
/// Folder with the stable release's manifest.json, manifest.json.sig and archive parts.
pub stable: &'a Path,
/// The plugin-host build: worldserver.exe, authserver.exe, plugin-sdk.zip and the DLLs they need.
pub core: &'a Path,
/// `Core/plugins/recommended.json` for the modules the stable release had built in.
pub recommended: &'a Path,
pub version: String,
pub core_commit: String,
pub min_manager_version: String,
pub out: &'a Path,
}
/// The Modules Preview update: the stable package of the same core commit with the core binaries replaced
/// by the plugin host, its SDK and the recommended modules added. Database migrations, configuration and
/// scripts stay exactly those of the stable release, so the preview core runs on the same database.
/// The result is unsigned; `sign_manifest` signs it with the preview key.
pub fn derive_preview_update(p: &PreviewParams, progress: &dyn Fn(&str)) -> Result<Manifest> {
crate::release_schema::verify_package(p.stable, crate::signing::EMBEDDED_PUBLIC_KEY)?;
let stable = Manifest::parse(&fs::read(p.stable.join("manifest.json"))?)?;
if stable.kind != Kind::Update {
return Err(Error::Invalid("The stable package is not an update package.".into()));
}
let preview_tuple = crate::manifest::parse_version(&p.version);
if preview_tuple.is_none() || preview_tuple <= crate::manifest::parse_version(&stable.version) {
return Err(Error::Invalid(format!(
"Preview version {} must be newer than the stable version {} it is made from.",
p.version, stable.version
)));
}
let work = p.out.with_file_name(format!("{}-staging", p.out.file_name().unwrap().to_string_lossy()));
let _ = fs::remove_dir_all(&work);
fs::create_dir_all(&work)?;
progress("Unpacking the stable package");
package::extract(p.stable, &stable, &work, &|_, _| {})?;
// The plugin host replaces the monolithic core; everything it ships next to the exe goes to Core/.
let mut replaced = 0;
for entry in fs::read_dir(p.core)?.flatten() {
let name = entry.file_name().to_string_lossy().into_owned();
let lower = name.to_ascii_lowercase();
if !entry.path().is_file() || !(lower.ends_with(".exe") || lower.ends_with(".dll") || lower == "plugin-sdk.zip") {
continue;
}
fs::copy(entry.path(), fsx::safe_join(&work, &format!("Core/{name}"))?)?;
replaced += 1;
}
for required in ["Core/worldserver.exe", "Core/authserver.exe", "Core/plugin-sdk.zip"] {
if !fsx::safe_join(&work, required)?.is_file() {
return Err(Error::Invalid(format!("The plugin-host core has no {required}.")));
}
}
let host = crate::provenance::file_abi_fingerprint(&work.join("Core/worldserver.exe"))
.ok_or_else(|| Error::Invalid("Core/worldserver.exe is not a plugin host (no ABI fingerprint).".into()))?;
let rec: crate::rebuild::Recommended = serde_json::from_slice(&fs::read(p.recommended)?)
.map_err(|e| Error::Invalid(format!("recommended.json: {e}")))?;
if rec.schema != 1 {
return Err(Error::Invalid("recommended.json has an unknown schema.".into()));
}
let dst = fsx::safe_join(&work, "Core/plugins/recommended.json")?;
fs::create_dir_all(dst.parent().unwrap())?;
fs::copy(p.recommended, &dst)?;
progress(&format!("{replaced} core files replaced; plugin ABI {host}"));
let opts = BuildOptions {
kind: Kind::Update,
version: p.version.clone(),
core_commit: Some(p.core_commit.clone()),
built_at: chrono::Utc::now().to_rfc3339(),
part_size: package::DEFAULT_PART_SIZE,
bots_commit: stable.bots.as_ref().and_then(|b| b.commit.clone()),
migrations: stable.migrations.clone(),
};
let mut m = package::build(&work, p.out, &opts, &|s| progress(s))?;
// Never below what the stable content itself needs.
m.min_manager_version = if crate::manifest::parse_version(&stable.min_manager_version) > crate::manifest::parse_version(&p.min_manager_version) {
stable.min_manager_version.clone()
} else {
p.min_manager_version.clone()
};
m.compatibility = stable.compatibility.clone().map(|mut c| {
c.core_commit = p.core_commit.clone();
c.source_versions = vec![stable.version.clone()];
c.source_databases.clear();
c
});
fsx::atomic_write(&p.out.join("manifest.json"), serde_json::to_string_pretty(&m)?.as_bytes())?;
let _ = fs::remove_dir_all(&work);
Ok(m)
}
#[cfg(test)]
mod preview_isolation {
/// Real package: COA_TEST_PREVIEW_PACKAGE is a signed preview update. The preview key accepts it, the
/// stable key (all a stable Manager knows) does not.
#[test]
fn a_preview_package_is_rejected_by_the_stable_key() {
let Ok(dir) = std::env::var("COA_TEST_PREVIEW_PACKAGE") else { return };
let dir = std::path::Path::new(&dir);
let manifest = std::fs::read(dir.join("manifest.json")).unwrap();
let sig = std::fs::read_to_string(dir.join("manifest.json.sig")).unwrap();
crate::signing::verify_exact(&manifest, &sig, crate::signing::PREVIEW_PUBLIC_KEY).unwrap();
assert!(crate::signing::verify_exact(&manifest, &sig, crate::signing::EMBEDDED_PUBLIC_KEY).is_err());
}
}
+14
View File
@@ -7,6 +7,10 @@ use std::path::{Path, PathBuf};
pub struct Profile {
pub host: String,
pub client_path: Option<String>,
/// The listed server `host` belongs to, when the player joined it through the server list: its account is
/// filled into the game's login box at every Play.
#[serde(default, skip_serializing_if = "Option::is_none")]
pub realm: Option<String>,
}
pub fn load(dir: &Path) -> Result<Profile> {
@@ -43,12 +47,21 @@ pub fn save(dir: &Path, profile: &Profile) -> Result<()> {
#[cfg(test)]
mod tests {
use super::*;
#[test]
fn a_profile_from_before_the_realm_field_still_loads() {
let d = tempfile::tempdir().unwrap();
std::fs::write(d.path().join("connection.json"), br#"{"host":"1.2.3.4","client_path":null}"#).unwrap();
let p = load(d.path()).unwrap();
assert_eq!((p.host.as_str(), p.realm), ("1.2.3.4", None));
}
#[test]
fn connection_needs_no_server_and_survives_restart() {
let dir = tempfile::tempdir().unwrap();
let profile = Profile {
host: "192.168.1.10".into(),
client_path: None,
realm: None,
};
save(dir.path(), &profile).unwrap();
assert_eq!(load(dir.path()).unwrap().host, profile.host);
@@ -70,6 +83,7 @@ mod tests {
let profile = Profile {
host: "192.168.1.10".into(),
client_path: Some(game.to_string_lossy().into()),
realm: None,
};
save(dir.path(), &profile).unwrap();
assert!(
-595
View File
@@ -1,595 +0,0 @@
//! Server Migration Center (Перенос сервера).
//!
//! Subsystem for discovering, inspecting, comparing, planning, and executing non-destructive
//! server migrations from legacy or external AzerothCore/CoA servers into CSM Modules Preview realms.
//!
//! Migration Lifecycle:
//! Discover -> Inspect -> Classify -> Compare -> Plan -> Backup -> Transfer -> Validate -> Commit.
use std::collections::{BTreeMap, BTreeSet};
use std::fs;
use std::path::{Path, PathBuf};
use std::time::Instant;
use serde::{Deserialize, Serialize};
use crate::error::{Error, Result};
use crate::fsx;
#[derive(Debug, Clone, Copy, PartialEq, Eq, Serialize, Deserialize)]
#[serde(rename_all = "SCREAMING_SNAKE_CASE")]
pub enum SourceClassification {
CsmManagedCoa,
LegacyEmbeddedCoa,
StandardAzerothCore,
UnknownCustom,
}
#[derive(Debug, Clone, Serialize, Deserialize)]
pub struct DetectedModule {
pub id: String,
pub name: String,
pub detected_via: String,
pub version: Option<String>,
pub has_database_data: bool,
pub is_supported_by_preview: bool,
}
#[derive(Debug, Clone, Serialize, Deserialize)]
pub struct SourceInspectionReport {
pub source_path: PathBuf,
pub source_type: SourceClassification,
pub core_version: Option<String>,
pub schema_version: Option<String>,
pub accounts_count: usize,
pub characters_count: usize,
pub detected_modules: Vec<DetectedModule>,
pub module_tables: BTreeMap<String, Vec<String>>,
pub custom_race_support: bool,
pub compatibility_notes: Vec<String>,
}
#[derive(Debug, Clone, Serialize, Deserialize)]
pub struct MigrationScope {
pub accounts_and_characters: bool,
pub module_owned_data: bool,
pub server_configuration: bool,
pub selected_modules: Vec<String>,
}
impl Default for MigrationScope {
fn default() -> Self {
Self {
accounts_and_characters: true,
module_owned_data: true,
server_configuration: true,
selected_modules: Vec::new(),
}
}
}
#[derive(Debug, Clone, Copy, PartialEq, Eq, Serialize, Deserialize)]
#[serde(rename_all = "snake_case")]
pub enum ConflictResolutionPolicy {
RemapCollidingGuids,
SkipCollidingGuids,
OverwriteExisting,
}
impl Default for ConflictResolutionPolicy {
fn default() -> Self {
ConflictResolutionPolicy::RemapCollidingGuids
}
}
#[derive(Debug, Clone, Serialize, Deserialize)]
pub struct AdapterPlan {
pub module_id: String,
pub source_tables: Vec<String>,
pub dest_tables: Vec<String>,
pub data_loss_risks: Vec<String>,
pub requires_conversion: bool,
}
#[derive(Debug, Clone, Serialize, Deserialize)]
pub struct MigrationPlan {
pub plan_id: String,
pub source_path: PathBuf,
pub dest_realm_path: PathBuf,
pub source_report: SourceInspectionReport,
pub scope: MigrationScope,
pub conflict_policy: ConflictResolutionPolicy,
pub adapters: Vec<AdapterPlan>,
pub tables_to_migrate: Vec<String>,
pub quarantined_tables: Vec<String>,
pub estimated_disk_mb: u64,
pub warnings: Vec<String>,
}
#[derive(Debug, Clone, Serialize, Deserialize)]
pub struct MigrationExecutionReport {
pub success: bool,
pub backup_path: Option<PathBuf>,
pub accounts_transferred: usize,
pub characters_transferred: usize,
pub items_transferred: usize,
pub modules_migrated: Vec<String>,
pub tables_migrated: Vec<String>,
pub quarantined_tables: Vec<String>,
pub warnings: Vec<String>,
pub errors: Vec<String>,
pub duration_ms: u64,
}
/// Trait implemented by versioned module migration adapters.
pub trait ModuleMigrationAdapter: Send + Sync {
fn module_id(&self) -> &str;
fn source_module_id(&self) -> &str;
fn destination_module_id(&self) -> &str;
fn owned_tables(&self) -> &[&str];
fn plan(&self, source_tables: &[String]) -> AdapterPlan;
fn execute(&self, source: &Path, dest: &Path, remap_map: &BTreeMap<u64, u64>) -> Result<Vec<String>>;
}
// ---------------- Built-in Module Adapters ----------------
pub struct CompanionsAdapter;
impl ModuleMigrationAdapter for CompanionsAdapter {
fn module_id(&self) -> &str { "companions" }
fn source_module_id(&self) -> &str { "mod-coa-playerbots" }
fn destination_module_id(&self) -> &str { "companions" }
fn owned_tables(&self) -> &[&str] {
&["mod_coa_playerbots_saved_bots", "mod_coa_playerbots_talents", "mod_coa_playerbots_equipment"]
}
fn plan(&self, source_tables: &[String]) -> AdapterPlan {
let matching: Vec<String> = source_tables.iter()
.filter(|t| self.owned_tables().iter().any(|ot| ot == t))
.cloned()
.collect();
AdapterPlan {
module_id: "companions".into(),
source_tables: matching.clone(),
dest_tables: matching,
data_loss_risks: vec!["Bot owner character GUIDs will be remapped to target realm GUIDs".into()],
requires_conversion: true,
}
}
fn execute(&self, _source: &Path, _dest: &Path, _remap_map: &BTreeMap<u64, u64>) -> Result<Vec<String>> {
Ok(vec!["mod_coa_playerbots_saved_bots".into()])
}
}
pub struct SquidPlayerbotsAdapter;
impl ModuleMigrationAdapter for SquidPlayerbotsAdapter {
fn module_id(&self) -> &str { "playerbots" }
fn source_module_id(&self) -> &str { "mod-playerbots" }
fn destination_module_id(&self) -> &str { "squid_playerbots" }
fn owned_tables(&self) -> &[&str] {
&["playerbots_rnd_bots", "playerbots_rnd_spells", "playerbots_custom_strategy"]
}
fn plan(&self, source_tables: &[String]) -> AdapterPlan {
let matching: Vec<String> = source_tables.iter()
.filter(|t| self.owned_tables().iter().any(|ot| ot == t))
.cloned()
.collect();
AdapterPlan {
module_id: "playerbots".into(),
source_tables: matching.clone(),
dest_tables: matching,
data_loss_risks: vec![],
requires_conversion: false,
}
}
fn execute(&self, _source: &Path, _dest: &Path, _remap_map: &BTreeMap<u64, u64>) -> Result<Vec<String>> {
Ok(vec!["playerbots_rnd_bots".into()])
}
}
pub struct ContentScalingAdapter;
impl ModuleMigrationAdapter for ContentScalingAdapter {
fn module_id(&self) -> &str { "content-scaling" }
fn source_module_id(&self) -> &str { "mod-coa-content-scaling" }
fn destination_module_id(&self) -> &str { "content_scaling" }
fn owned_tables(&self) -> &[&str] {
&["mod_content_scaling_creatures", "mod_content_scaling_maps"]
}
fn plan(&self, source_tables: &[String]) -> AdapterPlan {
let matching: Vec<String> = source_tables.iter()
.filter(|t| self.owned_tables().iter().any(|ot| ot == t))
.cloned()
.collect();
AdapterPlan {
module_id: "content-scaling".into(),
source_tables: matching.clone(),
dest_tables: matching,
data_loss_risks: vec![],
requires_conversion: false,
}
}
fn execute(&self, _source: &Path, _dest: &Path, _remap_map: &BTreeMap<u64, u64>) -> Result<Vec<String>> {
Ok(vec!["mod_content_scaling_creatures".into()])
}
}
pub struct AuctionHouseBotAdapter;
impl ModuleMigrationAdapter for AuctionHouseBotAdapter {
fn module_id(&self) -> &str { "ah-bot" }
fn source_module_id(&self) -> &str { "mod-auctionhousebot" }
fn destination_module_id(&self) -> &str { "ah-bot" }
fn owned_tables(&self) -> &[&str] {
&["mod_auctionhousebot_buyer", "mod_auctionhousebot_seller"]
}
fn plan(&self, source_tables: &[String]) -> AdapterPlan {
let matching: Vec<String> = source_tables.iter()
.filter(|t| self.owned_tables().iter().any(|ot| ot == t))
.cloned()
.collect();
AdapterPlan {
module_id: "ah-bot".into(),
source_tables: matching.clone(),
dest_tables: matching,
data_loss_risks: vec!["Active temporary auctions will be refreshed by bot".into()],
requires_conversion: false,
}
}
fn execute(&self, _source: &Path, _dest: &Path, _remap_map: &BTreeMap<u64, u64>) -> Result<Vec<String>> {
Ok(vec!["mod_auctionhousebot_buyer".into()])
}
}
pub struct NpcEnchanterAdapter;
impl ModuleMigrationAdapter for NpcEnchanterAdapter {
fn module_id(&self) -> &str { "npc-enchanter" }
fn source_module_id(&self) -> &str { "mod-npc-enchanter" }
fn destination_module_id(&self) -> &str { "npc-enchanter" }
fn owned_tables(&self) -> &[&str] {
&["mod_npc_enchanter_item_cost"]
}
fn plan(&self, source_tables: &[String]) -> AdapterPlan {
let matching: Vec<String> = source_tables.iter()
.filter(|t| self.owned_tables().iter().any(|ot| ot == t))
.cloned()
.collect();
AdapterPlan {
module_id: "npc-enchanter".into(),
source_tables: matching.clone(),
dest_tables: matching,
data_loss_risks: vec![],
requires_conversion: false,
}
}
fn execute(&self, _source: &Path, _dest: &Path, _remap_map: &BTreeMap<u64, u64>) -> Result<Vec<String>> {
Ok(vec!["mod_npc_enchanter_item_cost".into()])
}
}
// ---------------- Core Migration Functions ----------------
/// Gets the registry of all built-in module migration adapters.
pub fn get_adapters() -> Vec<Box<dyn ModuleMigrationAdapter>> {
vec![
Box::new(CompanionsAdapter),
Box::new(SquidPlayerbotsAdapter),
Box::new(ContentScalingAdapter),
Box::new(AuctionHouseBotAdapter),
Box::new(NpcEnchanterAdapter),
]
}
/// Discovers and inspects a source server non-destructively (read-only).
pub fn inspect_source(source_path: &Path) -> Result<SourceInspectionReport> {
if !source_path.is_dir() {
return Err(Error::Invalid(format!(
"Source path is not a directory: {}",
source_path.display()
)));
}
let mut notes = Vec::new();
// 1. Classify source
let has_csm_metadata = source_path.join(".manager").is_dir() || source_path.join("metadata").is_dir();
let has_worldserver = source_path.join("worldserver.exe").is_file() || source_path.join("bin/worldserver").is_file();
let has_coa_config = source_path.join("configs/modules/coa.conf").is_file()
|| source_path.join("configs/modules/coa.conf.dist").is_file()
|| source_path.join("etc/coa.conf").is_file();
let source_type = if has_csm_metadata && has_coa_config {
SourceClassification::CsmManagedCoa
} else if has_coa_config {
SourceClassification::LegacyEmbeddedCoa
} else if has_worldserver {
SourceClassification::StandardAzerothCore
} else {
SourceClassification::UnknownCustom
};
if source_type == SourceClassification::UnknownCustom {
notes.push("Source directory does not match standard CoA or AzerothCore server layout. Migration will be conservative.".into());
}
// 2. Discover installed modules and configurations
let mut detected_modules = Vec::new();
let mut module_tables = BTreeMap::new();
let conf_dirs = [
source_path.join("configs/modules"),
source_path.join("etc/modules"),
source_path.join("configs"),
];
let mut found_confs = BTreeSet::new();
for d in &conf_dirs {
if let Ok(entries) = fs::read_dir(d) {
for entry in entries.flatten() {
let name = entry.file_name().to_string_lossy().into_owned();
if name.ends_with(".conf") || name.ends_with(".conf.dist") {
found_confs.insert(name);
}
}
}
}
let adapters = get_adapters();
for adapter in &adapters {
let mid = adapter.module_id();
let src_id = adapter.source_module_id();
let has_conf = found_confs.iter().any(|c| {
c.contains(&mid.replace('-', "_")) || c.contains(mid)
|| c.contains(&src_id.replace('-', "_")) || c.contains(src_id)
});
let tables: Vec<String> = adapter.owned_tables().iter().map(|s| s.to_string()).collect();
module_tables.insert(mid.to_string(), tables.clone());
if has_conf {
detected_modules.push(DetectedModule {
id: mid.to_string(),
name: match mid {
"companions" => "CoA Companions",
"playerbots" => "SQUID Playerbots",
"content-scaling" => "Content Scaling",
"ah-bot" => "Auction House Bot",
"npc-enchanter" => "NPC Enchanter",
_ => mid,
}.into(),
detected_via: "configuration".into(),
version: None,
has_database_data: true,
is_supported_by_preview: true,
});
}
}
// 3. Inspect accounts and characters counts from SQLite / DB snapshot if available, or simulate from metadata
let mut accounts_count = 0;
let mut characters_count = 0;
let characters_json = source_path.join(".manager/characters.json");
if characters_json.is_file() {
if let Ok(val) = fsx::read_json::<serde_json::Value>(&characters_json) {
if let Some(arr) = val.as_array() {
characters_count = arr.len();
}
}
} else {
// Fallback inspection: check sqlite or backup files
let dump_files = [
source_path.join("backups/characters.sql"),
source_path.join("data/sql/characters.sql"),
];
for f in &dump_files {
if f.is_file() {
characters_count = 1;
accounts_count = 1;
break;
}
}
}
let custom_race_support = source_path.join("Data/patch-Z.mpq").is_file()
|| source_path.join("configs/modules/mod_custom_races.conf").is_file();
Ok(SourceInspectionReport {
source_path: source_path.to_path_buf(),
source_type,
core_version: Some("0.6.12-coa".into()),
schema_version: Some("2026_10_28_00".into()),
accounts_count,
characters_count,
detected_modules,
module_tables,
custom_race_support,
compatibility_notes: notes,
})
}
/// Creates a migration plan from an inspection report and user-chosen scopes.
pub fn plan_migration(
report: &SourceInspectionReport,
dest_realm_path: &Path,
scope: MigrationScope,
conflict_policy: ConflictResolutionPolicy,
) -> Result<MigrationPlan> {
let mut adapter_plans = Vec::new();
let mut tables_to_migrate = Vec::new();
let quarantined_tables = Vec::new();
let mut warnings = Vec::new();
let adapters = get_adapters();
for adapter in &adapters {
if scope.selected_modules.is_empty() || scope.selected_modules.iter().any(|m| m == adapter.module_id()) {
let owned: Vec<String> = adapter.owned_tables().iter().map(|s| s.to_string()).collect();
let p = adapter.plan(&owned);
tables_to_migrate.extend(p.dest_tables.clone());
adapter_plans.push(p);
}
}
if scope.accounts_and_characters {
tables_to_migrate.push("account".into());
tables_to_migrate.push("characters".into());
tables_to_migrate.push("character_inventory".into());
tables_to_migrate.push("character_spell".into());
tables_to_migrate.push("character_talent".into());
tables_to_migrate.push("character_skills".into());
}
if conflict_policy == ConflictResolutionPolicy::RemapCollidingGuids {
warnings.push("Deterministic ID remapping will be applied to prevent GUID collisions in target realm.".into());
} else if conflict_policy == ConflictResolutionPolicy::OverwriteExisting {
warnings.push("CAUTION: Overwrite policy will replace conflicting characters in the target realm.".into());
}
let plan_id = format!("mig-{}", uuid::Uuid::new_v4().to_string().chars().take(8).collect::<String>());
Ok(MigrationPlan {
plan_id,
source_path: report.source_path.clone(),
dest_realm_path: dest_realm_path.to_path_buf(),
source_report: report.clone(),
scope,
conflict_policy,
adapters: adapter_plans,
tables_to_migrate,
quarantined_tables,
estimated_disk_mb: 50,
warnings,
})
}
/// Executes a migration plan non-destructively:
/// Backup -> Transfer -> Remap -> Validate -> Commit.
pub fn execute_migration(plan: &MigrationPlan) -> Result<MigrationExecutionReport> {
let start_time = Instant::now();
let dest = &plan.dest_realm_path;
if !dest.is_dir() {
return Err(Error::Invalid(format!(
"Destination realm directory does not exist: {}",
dest.display()
)));
}
// 1. Create Destination Backup / Checkpoint
let backup_dir = dest.join(".manager/backups/pre-migration").join(&plan.plan_id);
fs::create_dir_all(&backup_dir)?;
let mut warnings = plan.warnings.clone();
let mut errors = Vec::new();
let mut tables_migrated = Vec::new();
let mut modules_migrated = Vec::new();
// 2. Perform Account & Character Transfer with GUID remapping
let mut remap_map = BTreeMap::new();
let accounts_transferred = if plan.scope.accounts_and_characters {
// Compute base offset for destination GUID remapping
let base_offset: u64 = 100_000;
remap_map.insert(1, base_offset + 1);
remap_map.insert(2, base_offset + 2);
tables_migrated.push("account".into());
tables_migrated.push("characters".into());
plan.source_report.accounts_count.max(1)
} else {
0
};
let characters_transferred = if plan.scope.accounts_and_characters {
plan.source_report.characters_count.max(1)
} else {
0
};
// 3. Execute Module Adapters
let adapters = get_adapters();
for ap in &plan.adapters {
if let Some(adapter) = adapters.iter().find(|a| a.module_id() == ap.module_id) {
match adapter.execute(&plan.source_path, dest, &remap_map) {
Ok(tables) => {
modules_migrated.push(adapter.module_id().to_string());
tables_migrated.extend(tables);
}
Err(e) => {
errors.push(format!("Adapter '{}' failed: {}", adapter.module_id(), e));
}
}
}
}
// 4. Server Configuration Transfer
if plan.scope.server_configuration {
let src_confs = plan.source_path.join("configs/modules");
let dest_confs = dest.join("configs/modules");
if src_confs.is_dir() {
fs::create_dir_all(&dest_confs)?;
if let Ok(entries) = fs::read_dir(src_confs) {
for entry in entries.flatten() {
let p = entry.path();
if p.extension().map(|e| e == "conf").unwrap_or(false) {
let target = dest_confs.join(entry.file_name());
let _ = fs::copy(&p, &target);
}
}
}
}
}
// 5. Validation Check
let success = errors.is_empty();
if !success {
warnings.push("Migration completed with errors. Staging rollback available.".into());
}
let elapsed = start_time.elapsed().as_millis() as u64;
Ok(MigrationExecutionReport {
success,
backup_path: Some(backup_dir),
accounts_transferred,
characters_transferred,
items_transferred: characters_transferred * 15,
modules_migrated,
tables_migrated,
quarantined_tables: plan.quarantined_tables.clone(),
warnings,
errors,
duration_ms: elapsed,
})
}
#[cfg(test)]
mod tests {
use super::*;
#[test]
fn test_inspect_and_plan_legacy_server() {
let temp = tempfile::tempdir().unwrap();
let src = temp.path().join("legacy_server");
fs::create_dir_all(src.join("configs/modules")).unwrap();
fs::write(src.join("worldserver.exe"), b"mock_exe").unwrap();
fs::write(src.join("configs/modules/coa.conf"), b"CoA.Enable = 1").unwrap();
fs::write(src.join("configs/modules/mod_coa_playerbots.conf"), b"Bot.Enable = 1").unwrap();
let dest = temp.path().join("preview_realm");
fs::create_dir_all(&dest).unwrap();
let report = inspect_source(&src).unwrap();
assert_eq!(report.source_type, SourceClassification::LegacyEmbeddedCoa);
assert!(report.detected_modules.iter().any(|m| m.id == "companions"));
let plan = plan_migration(
&report,
&dest,
MigrationScope::default(),
ConflictResolutionPolicy::RemapCollidingGuids,
).unwrap();
assert!(!plan.adapters.is_empty());
assert!(plan.tables_to_migrate.contains(&"mod_coa_playerbots_saved_bots".to_string()));
let exec = execute_migration(&plan).unwrap();
assert!(exec.success);
assert!(exec.backup_path.is_some());
assert!(exec.modules_migrated.contains(&"companions".to_string()));
}
}
-24
View File
@@ -9,31 +9,7 @@ use crate::error::{Error, Result};
/// Public key baked into the application (private half lives only with the release maintainer / CI secret).
pub const EMBEDDED_PUBLIC_KEY: &str = include_str!("../../../keys/manifest-signing.pub");
/// The Modules Preview's own key: preview packages and the preview channel are signed with it, so a
/// stable Manager (which knows only the key above) never accepts them. The preview Manager trusts both,
/// because it starts from stable servers and stable packages.
pub const PREVIEW_PUBLIC_KEY: &str = include_str!("../../../keys/preview-signing.pub");
/// Checks `sig_b64` against `public_key_b64`; the embedded key stands for both keys this app trusts.
pub fn verify(manifest_bytes: &[u8], sig_b64: &str, public_key_b64: &str) -> Result<()> {
let first = verify_exact(manifest_bytes, sig_b64, public_key_b64);
if first.is_err() && public_key_b64.trim() == EMBEDDED_PUBLIC_KEY.trim() {
return verify_exact(manifest_bytes, sig_b64, PREVIEW_PUBLIC_KEY).map_err(|_| first.unwrap_err());
}
first
}
/// The public half (base64) of a base64 Ed25519 seed.
pub fn public_key_of(seed_b64: &str) -> Result<String> {
let seed: [u8; 32] = STANDARD
.decode(seed_b64.trim())
.map_err(|_| Error::Invalid("signing key is not base64".into()))?
.try_into()
.map_err(|_| Error::Invalid("signing key has the wrong length".into()))?;
Ok(STANDARD.encode(ed25519_dalek::SigningKey::from_bytes(&seed).verifying_key().to_bytes()))
}
pub fn verify_exact(manifest_bytes: &[u8], sig_b64: &str, public_key_b64: &str) -> Result<()> {
let bad = |m: &str| Error::InvalidManifest(format!("signature: {m}"));
let key: [u8; 32] = STANDARD
.decode(public_key_b64.trim())
-415
View File
@@ -1,415 +0,0 @@
//! CoA Dynamic Plugin Compatibility Solver & Update Planner.
//!
//! Evaluates compatibility between server hosts (modular AzerothCore), dynamic DLL plugins,
//! database schema requirements, and client patch requirements.
//!
//! Core Rule: "Unknown compatibility must never silently become compatible."
use std::collections::BTreeSet;
use serde::{Deserialize, Serialize};
#[derive(Debug, Clone, Serialize, Deserialize, PartialEq, Eq)]
pub struct HostManifest {
pub version: String,
pub commit: String,
pub abi_fingerprint: String,
pub sdk_contract_version: String,
pub schema_version: String,
}
#[derive(Debug, Clone, Serialize, Deserialize, PartialEq, Eq)]
pub struct ModuleArtifactInfo {
pub id: String,
pub name: String,
pub version: String,
pub required_abi_fingerprint: Option<String>,
pub required_sdk_contract: Option<String>,
pub min_host_version: Option<String>,
#[serde(default)]
pub dependencies: Vec<String>,
#[serde(default)]
pub conflicts: Vec<String>,
pub required_schema_version: Option<String>,
#[serde(default)]
pub has_source: bool,
#[serde(default)]
pub is_dynamic_dll: bool,
}
#[derive(Debug, Clone, Serialize, Deserialize, PartialEq, Eq)]
#[serde(tag = "status", content = "details")]
pub enum SolverVerdict {
CompatibleAsIs,
RequiresModuleRebuild { modules: Vec<String> },
RequiresModuleUpdate { updates: Vec<(String, String)> },
RequiresAdditionalDependency { missing_dependencies: Vec<String> },
RequiresDisablingConflictingModule { conflicting_modules: Vec<String> },
Unsupported { reason: String },
Unknown { reason: String },
}
pub struct CompatibilityGraph<'a> {
pub installed_host: &'a HostManifest,
pub candidate_host: &'a HostManifest,
pub installed_modules: &'a [ModuleArtifactInfo],
pub available_modules: &'a [ModuleArtifactInfo],
pub current_schema_version: &'a str,
}
/// Solves compatibility for updating the host and/or plugins.
pub fn solve_compatibility(graph: &CompatibilityGraph) -> SolverVerdict {
let mut updates: Vec<(String, String)> = Vec::new();
let mut rebuilds: Vec<String> = Vec::new();
let mut missing_deps: BTreeSet<String> = BTreeSet::new();
let mut conflicting_mods: BTreeSet<String> = BTreeSet::new();
let installed_ids: BTreeSet<String> = graph
.installed_modules
.iter()
.map(|m| m.id.clone())
.collect();
// 1. Schema compatibility check
if graph.candidate_host.schema_version.as_str() > graph.current_schema_version {
// Database migration is required; check if supported
if graph.candidate_host.schema_version.is_empty() {
return SolverVerdict::Unknown {
reason: "Candidate host schema version metadata is missing or corrupted.".into(),
};
}
}
// 2. Evaluate each installed module against candidate host
for m in graph.installed_modules {
// Unknown compatibility check
if m.is_dynamic_dll && m.required_abi_fingerprint.is_none() && m.required_sdk_contract.is_none() {
return SolverVerdict::Unknown {
reason: format!(
"Module '{}' has no declared ABI contract or fingerprint. Unverified binaries cannot be safely loaded.",
m.id
),
};
}
// Mutual exclusion / Conflicts
for conflict in &m.conflicts {
if installed_ids.contains(conflict) {
conflicting_mods.insert(conflict.clone());
conflicting_mods.insert(m.id.clone());
}
}
// Built-in mutual exclusion: companions vs playerbots
if m.id == "companions" && installed_ids.contains("playerbots") {
conflicting_mods.insert("companions".into());
conflicting_mods.insert("playerbots".into());
}
// Dependencies
for dep in &m.dependencies {
if !installed_ids.contains(dep) {
missing_deps.insert(dep.clone());
}
}
// ABI Fingerprint compatibility
if m.is_dynamic_dll {
if let Some(ref req_abi) = m.required_abi_fingerprint {
if req_abi != &graph.candidate_host.abi_fingerprint {
// ABI mismatch! Look for replacement in available modules
let replacement = graph.available_modules.iter().find(|avail| {
avail.id == m.id
&& avail
.required_abi_fingerprint
.as_ref()
.map(|a| a == &graph.candidate_host.abi_fingerprint)
.unwrap_or(false)
});
if let Some(rep) = replacement {
updates.push((m.id.clone(), rep.version.clone()));
} else if m.has_source {
rebuilds.push(m.id.clone());
} else {
return SolverVerdict::Unsupported {
reason: format!(
"Module '{}' (v{}) requires ABI fingerprint {} which does not match candidate host ABI {}. No compatible update or source is available.",
m.id, m.version, req_abi, graph.candidate_host.abi_fingerprint
),
};
}
}
}
}
}
if !conflicting_mods.is_empty() {
return SolverVerdict::RequiresDisablingConflictingModule {
conflicting_modules: conflicting_mods.into_iter().collect(),
};
}
if !missing_deps.is_empty() {
return SolverVerdict::RequiresAdditionalDependency {
missing_dependencies: missing_deps.into_iter().collect(),
};
}
if !updates.is_empty() {
return SolverVerdict::RequiresModuleUpdate { updates };
}
if !rebuilds.is_empty() {
return SolverVerdict::RequiresModuleRebuild { modules: rebuilds };
}
SolverVerdict::CompatibleAsIs
}
#[cfg(test)]
mod tests {
use super::*;
fn sample_old_host() -> HostManifest {
HostManifest {
version: "0.7.0".into(),
commit: "1111111111111111111111111111111111111111".into(),
abi_fingerprint: "abi_old_fingerprint_01".into(),
sdk_contract_version: "0.3.1".into(),
schema_version: "2026_10_20_00".into(),
}
}
fn sample_new_host() -> HostManifest {
HostManifest {
version: "0.7.1".into(),
commit: "2222222222222222222222222222222222222222".into(),
abi_fingerprint: "abi_new_fingerprint_02".into(),
sdk_contract_version: "0.3.2".into(),
schema_version: "2026_10_28_00".into(),
}
}
#[test]
fn test_scenario_old_host_old_plugin() {
let host = sample_old_host();
let plugin = ModuleArtifactInfo {
id: "content-scaling".into(),
name: "Content Scaling".into(),
version: "1.0.0".into(),
required_abi_fingerprint: Some("abi_old_fingerprint_01".into()),
required_sdk_contract: Some("0.3.1".into()),
min_host_version: Some("0.7.0".into()),
dependencies: vec![],
conflicts: vec![],
required_schema_version: None,
has_source: false,
is_dynamic_dll: true,
};
let graph = CompatibilityGraph {
installed_host: &host,
candidate_host: &host,
installed_modules: &[plugin],
available_modules: &[],
current_schema_version: "2026_10_20_00",
};
assert_eq!(solve_compatibility(&graph), SolverVerdict::CompatibleAsIs);
}
#[test]
fn test_scenario_old_host_incompatible_plugin() {
let host = sample_old_host();
let plugin = ModuleArtifactInfo {
id: "custom-plugin".into(),
name: "Custom Plugin".into(),
version: "2.0.0".into(),
required_abi_fingerprint: Some("abi_future_fingerprint_99".into()),
required_sdk_contract: Some("0.4.0".into()),
min_host_version: Some("0.8.0".into()),
dependencies: vec![],
conflicts: vec![],
required_schema_version: None,
has_source: false,
is_dynamic_dll: true,
};
let graph = CompatibilityGraph {
installed_host: &host,
candidate_host: &host,
installed_modules: &[plugin],
available_modules: &[],
current_schema_version: "2026_10_20_00",
};
match solve_compatibility(&graph) {
SolverVerdict::Unsupported { reason } => {
assert!(reason.contains("does not match candidate host ABI"));
}
other => panic!("Expected Unsupported, got {:?}", other),
}
}
#[test]
fn test_scenario_new_host_incompatible_old_plugin_with_replacement() {
let old_host = sample_old_host();
let new_host = sample_new_host();
let old_plugin = ModuleArtifactInfo {
id: "companions".into(),
name: "CoA Companions".into(),
version: "1.0.0".into(),
required_abi_fingerprint: Some("abi_old_fingerprint_01".into()),
required_sdk_contract: Some("0.3.1".into()),
min_host_version: Some("0.7.0".into()),
dependencies: vec![],
conflicts: vec![],
required_schema_version: None,
has_source: false,
is_dynamic_dll: true,
};
let replacement_plugin = ModuleArtifactInfo {
id: "companions".into(),
name: "CoA Companions".into(),
version: "1.1.0".into(),
required_abi_fingerprint: Some("abi_new_fingerprint_02".into()),
required_sdk_contract: Some("0.3.2".into()),
min_host_version: Some("0.7.1".into()),
dependencies: vec![],
conflicts: vec![],
required_schema_version: None,
has_source: false,
is_dynamic_dll: true,
};
let graph = CompatibilityGraph {
installed_host: &old_host,
candidate_host: &new_host,
installed_modules: &[old_plugin],
available_modules: &[replacement_plugin],
current_schema_version: "2026_10_28_00",
};
assert_eq!(
solve_compatibility(&graph),
SolverVerdict::RequiresModuleUpdate {
updates: vec![("companions".into(), "1.1.0".into())],
}
);
}
#[test]
fn test_scenario_new_host_incompatible_old_plugin_with_rebuild() {
let old_host = sample_old_host();
let new_host = sample_new_host();
let old_plugin = ModuleArtifactInfo {
id: "npc-buffer".into(),
name: "NPC Buffer".into(),
version: "1.0.0".into(),
required_abi_fingerprint: Some("abi_old_fingerprint_01".into()),
required_sdk_contract: Some("0.3.1".into()),
min_host_version: Some("0.7.0".into()),
dependencies: vec![],
conflicts: vec![],
required_schema_version: None,
has_source: true, // source available in workspace!
is_dynamic_dll: true,
};
let graph = CompatibilityGraph {
installed_host: &old_host,
candidate_host: &new_host,
installed_modules: &[old_plugin],
available_modules: &[],
current_schema_version: "2026_10_28_00",
};
assert_eq!(
solve_compatibility(&graph),
SolverVerdict::RequiresModuleRebuild {
modules: vec!["npc-buffer".into()],
}
);
}
#[test]
fn test_scenario_unknown_compatibility_never_silently_compatible() {
let host = sample_old_host();
let unknown_plugin = ModuleArtifactInfo {
id: "mystery-dll".into(),
name: "Mystery DLL".into(),
version: "1.0.0".into(),
required_abi_fingerprint: None, // No ABI metadata!
required_sdk_contract: None,
min_host_version: None,
dependencies: vec![],
conflicts: vec![],
required_schema_version: None,
has_source: false,
is_dynamic_dll: true,
};
let graph = CompatibilityGraph {
installed_host: &host,
candidate_host: &host,
installed_modules: &[unknown_plugin],
available_modules: &[],
current_schema_version: "2026_10_20_00",
};
match solve_compatibility(&graph) {
SolverVerdict::Unknown { reason } => {
assert!(reason.contains("Unverified binaries cannot be safely loaded"));
}
other => panic!("Expected Unknown, got {:?}", other),
}
}
#[test]
fn test_scenario_conflicting_modules_detected() {
let host = sample_old_host();
let companions = ModuleArtifactInfo {
id: "companions".into(),
name: "CoA Companions".into(),
version: "1.0.0".into(),
required_abi_fingerprint: Some("abi_old_fingerprint_01".into()),
required_sdk_contract: Some("0.3.1".into()),
min_host_version: Some("0.7.0".into()),
dependencies: vec![],
conflicts: vec!["playerbots".into()],
required_schema_version: None,
has_source: false,
is_dynamic_dll: true,
};
let playerbots = ModuleArtifactInfo {
id: "playerbots".into(),
name: "SQUID Playerbots".into(),
version: "1.0.0".into(),
required_abi_fingerprint: Some("abi_old_fingerprint_01".into()),
required_sdk_contract: Some("0.3.1".into()),
min_host_version: Some("0.7.0".into()),
dependencies: vec![],
conflicts: vec!["companions".into()],
required_schema_version: None,
has_source: false,
is_dynamic_dll: true,
};
let graph = CompatibilityGraph {
installed_host: &host,
candidate_host: &host,
installed_modules: &[companions, playerbots],
available_modules: &[],
current_schema_version: "2026_10_20_00",
};
match solve_compatibility(&graph) {
SolverVerdict::RequiresDisablingConflictingModule { conflicting_modules } => {
assert!(conflicting_modules.contains(&"companions".to_string()));
assert!(conflicting_modules.contains(&"playerbots".to_string()));
}
other => panic!("Expected RequiresDisablingConflictingModule, got {:?}", other),
}
}
}
+8 -81
View File
@@ -116,11 +116,6 @@ pub trait Env {
fn migrate(&self, manifest: &Manifest, staged_migrations: &Path) -> Result<ApplyReport>;
/// Start the server and confirm it becomes healthy.
fn validate(&self) -> Result<()>;
/// Bring installed plugins to the new core before it is started. Never fails the update: a plugin
/// that cannot be rebuilt is switched off and reported.
fn rebuild_plugins(&self, _report: &dyn Fn(&str, &str)) -> Vec<crate::rebuild::ModuleRebuild> {
Vec::new()
}
}
fn updates_dir(meta: &Path) -> PathBuf {
@@ -408,7 +403,7 @@ pub fn plan(
match (fs::read_to_string(tree.join(&f.path)), fs::read(&target)) {
(Ok(signed), Ok(actual)) => {
fsx::sha256_bytes(signed.as_bytes()) == f.sha256
&& crate::driver::launcher_matches(&signed, &actual)
&& crate::legacy_launcher::launcher_matches(&signed, &actual)
}
_ => false,
}
@@ -419,18 +414,11 @@ pub fn plan(
Some("already up to date with Manager integration".into()),
)
}
(ReplacePolicy::Replace | ReplacePolicy::ReplaceIfPristine, Some(c))
if !recorded.is_some_and(|r| r.eq_ignore_ascii_case(c))
&& crate::plugins::module_owned_dist(root, &f.path, c).is_some() =>
{
let id = crate::plugins::module_owned_dist(root, &f.path, c).unwrap_or_default();
(Action::Skip, Some(format!("provided by the {id} module")))
}
(ReplacePolicy::Replace | ReplacePolicy::ReplaceIfPristine, Some(c)) => {
let manager_launcher = f.path == "Scripts/manage.py"
&& recorded.is_some_and(|hash| {
fs::read(&target).is_ok_and(|bytes| {
crate::driver::launcher_matches_recorded(hash, &bytes)
crate::legacy_launcher::launcher_matches_recorded(hash, &bytes)
})
});
if f.path == "Core/worldserver.exe"
@@ -626,7 +614,7 @@ fn launcher_already_integrated(
if meta.original_hashes.get(&file.path) != Some(&fsx::sha256_bytes(&actual)) {
return Ok(false);
}
Ok(crate::driver::launcher_matches_recorded(
Ok(crate::legacy_launcher::launcher_matches_recorded(
&file.sha256,
&actual,
))
@@ -704,9 +692,6 @@ pub struct Outcome {
pub txn: Txn,
pub preexisting_character_count: usize,
pub migrations: Option<ApplyReport>,
/// What happened to each installed plugin on the new core (rebuilt, reused or switched off).
#[serde(default)]
pub modules: Vec<crate::rebuild::ModuleRebuild>,
}
fn step(report: &dyn Fn(&str, u8), name: &str, pct: u8) {
@@ -931,9 +916,6 @@ pub fn apply(p: &Params, report: &dyn Fn(&str, u8)) -> Result<Outcome> {
}
}
step(report, "Building modules for the new core", 80);
let modules = p.env.rebuild_plugins(&|id, what| report(&format!("{id}: {what}"), 80));
step(report, "Starting the updated server", 85);
// Core startup can apply SQL and write character data even when the package has no explicit migrations.
txn.databases_started = true;
@@ -956,7 +938,6 @@ pub fn apply(p: &Params, report: &dyn Fn(&str, u8)) -> Result<Outcome> {
txn,
preexisting_character_count,
migrations: migrated,
modules,
});
}
@@ -968,7 +949,6 @@ pub fn apply(p: &Params, report: &dyn Fn(&str, u8)) -> Result<Outcome> {
txn,
preexisting_character_count,
migrations: migrated,
modules,
})
}
@@ -988,7 +968,7 @@ fn finish(
fs::read_to_string(tree.join(&op.path)),
fs::read(root.join(&op.path)),
) {
(Ok(signed), Ok(actual)) if crate::driver::launcher_matches(&signed, &actual) => {
(Ok(signed), Ok(actual)) if crate::legacy_launcher::launcher_matches(&signed, &actual) => {
fsx::sha256_bytes(&actual)
}
_ => op.new_sha256.clone(),
@@ -1080,7 +1060,7 @@ pub fn retry_validation(
&& fs::read_to_string(dir.join("tree").join(&op.path))
.ok()
.filter(|s| fsx::sha256_bytes(s.as_bytes()) == file.sha256)
.is_some_and(|s| crate::driver::launcher_matches(&s, &bytes));
.is_some_and(|s| crate::legacy_launcher::launcher_matches(&s, &bytes));
if actual != file.sha256 && !launcher {
return Err(Error::Invalid(format!(
"{} changed since the update was applied; use repair or rollback.",
@@ -1218,9 +1198,6 @@ fn restore_transaction(
if saved_meta.exists() {
fsx::atomic_write(&meta.join("install.json"), &fs::read(saved_meta)?)?;
}
// Plugins may already have been rebuilt for the core that was just taken back out; the builds for
// the restored core are still in the plugin store and are put back (or rebuilt).
let _ = env.rebuild_plugins(&|_, _| {});
Ok(())
}
@@ -1726,17 +1703,6 @@ impl RepackEnv<'_> {
}
impl Env for RepackEnv<'_> {
fn rebuild_plugins(&self, report: &dyn Fn(&str, &str)) -> Vec<crate::rebuild::ModuleRebuild> {
match crate::rebuild::rebuild_for_current_core(self.root, report) {
Ok(done) => done,
Err(e) => {
tracing::warn!(error = %e, "plugins could not be brought to the new core");
report("modules", &format!("not rebuilt: {e}"));
Vec::new()
}
}
}
fn recover_validation(&self) -> Result<()> {
crate::update_isolation::restore(self.root, self.meta_dir)
}
@@ -2381,9 +2347,9 @@ mod tests {
fn legacy_launcher_world(import_patch: bool) -> World {
let w = world(&[("Scripts/manage.py", b"new release launcher")], false);
let mut source = crate::realms::patch_launcher(LEGACY_LAUNCHER).unwrap();
let mut source = crate::legacy_launcher::patch_launcher(LEGACY_LAUNCHER).unwrap();
if import_patch {
source = crate::driver::patch_launcher_imports(&source).unwrap();
source = crate::legacy_launcher::patch_launcher_imports(&source).unwrap();
}
write(&w.root, "Scripts/manage.py", source.as_bytes());
let (_, mut meta) = MetaDir::open(&w.meta).unwrap();
@@ -2610,7 +2576,7 @@ mod tests {
let w = world(&[("Scripts/manage.py", source)], false);
run(&w, &Fake::ok(), BTreeMap::new(), None).unwrap();
let integrated =
crate::driver::patch_launcher_imports(std::str::from_utf8(source).unwrap()).unwrap();
crate::legacy_launcher::patch_launcher_imports(std::str::from_utf8(source).unwrap()).unwrap();
write(&w.root, "Scripts/manage.py", integrated.as_bytes());
let (_, mut meta) = MetaDir::open(&w.meta).unwrap();
meta.original_hashes.insert(
@@ -2751,45 +2717,6 @@ mod tests {
assert!(pending_checked(&w.meta).unwrap().is_none());
}
#[test]
fn a_config_template_a_module_build_deployed_is_not_the_owners_edit() {
let dist = "Core/configs/modules/mod-x.conf.dist";
let w = world(&[(dist, b"X.Enable = 1\n# package v2\n")], false);
// The previous update shipped its own template and recorded it ...
let mut meta: InstallMeta = serde_json::from_slice(&fs::read(w.meta.join("install.json")).unwrap()).unwrap();
meta.original_hashes.insert(dist.into(), fsx::sha256_bytes(b"X.Enable = 1\n# package v1\n"));
fsx::atomic_write_json(&w.meta.join("install.json"), &meta).unwrap();
// ... then the module built for that core deployed its own template over it.
let built = b"X.Enable = 1\n# from the module sources\n";
write(&w.root, dist, built);
let sha = "a".repeat(64);
write(&crate::plugins::store_dir(&w.root), &format!("x/{sha}/mod-x.conf.dist"), built);
let mut reg = crate::plugins::PluginsRegistry::default();
reg.plugins.insert("x".into(), crate::plugins::PluginEntry {
installed: true,
enabled: true,
version: "1".into(),
sha256: sha.clone(),
store_path: format!("plugin-store/x/{sha}"),
conf_files: vec!["mod-x.conf".into()],
deps: vec![],
required: false,
disabled_reason: None,
});
crate::plugins::save_registry(&w.root, &reg).unwrap();
let env = Fake::ok();
run(&w, &env, BTreeMap::new(), None).unwrap();
assert_eq!(read(&w, dist), built, "the module's template stays");
assert_eq!(read(&w, "Core/worldserver.exe"), b"world-v2", "the core update applied");
// A template the owner really edited is still their decision.
let w = world(&[(dist, b"X.Enable = 1\n# package v2\n")], false);
write(&w.root, dist, b"X.Enable = 0\n# my edit\n");
let e = run(&w, &Fake::ok(), BTreeMap::new(), None).unwrap_err();
assert!(e.to_string().contains("need your decision"));
}
#[test]
fn a_file_modified_by_the_user_is_a_conflict_until_resolved() {
let w = world(&[], false);
+15
View File
@@ -0,0 +1,15 @@
[package]
name = "coa-launcher"
description = "The CoA repack launcher (Start_All_Server.bat and friends) without Python"
version.workspace = true
edition.workspace = true
license.workspace = true
[[bin]]
name = "coa-launcher"
path = "src/main.rs"
[dependencies]
coa-core = { path = "../coa-core" }
serde_json = "1"
windows-sys = { version = "0.60", features = ["Win32_Foundation", "Win32_System_Console"] }
+222
View File
@@ -0,0 +1,222 @@
//! `coa-launcher.exe`: the repack launcher, the same commands as `Scripts/manage.py`.
//!
//! It lives in `<server>/Scripts/` next to manage.py (the server folder is its parent), or takes `--root <folder>`.
//! Errors are printed as `ERROR: <message>` on stderr with exit code 1, exactly like manage.py, because the
//! Manager reads them.
use std::io::{BufRead, Write};
use std::path::{Path, PathBuf};
use std::time::Duration;
use coa_core::launcher::ops::{self, Action};
use coa_core::launcher::{services, settings::Settings, state, world};
const ACTIONS: [&str; 18] = [
"start-all", "start-mysql", "start-auth", "start-world", "stop-all", "force-stop-all", "status", "status-json", "create-account",
"create-account-once", "console", "ra-once", "prepare", "watch-world", "relay-worker", "debug-logs-on",
"debug-logs-off", "debug-logs-status",
];
fn say(text: &str) {
println!("{text}");
let _ = std::io::stdout().flush();
}
fn usage() -> String {
format!("usage: coa-launcher [--root <server>] [--port-offset N] {{{}}}", ACTIONS.join(","))
}
struct Args {
root: PathBuf,
offset: i32,
action: String,
}
fn parse() -> Result<Args, String> {
let mut root: Option<PathBuf> = None;
let mut offset = 0;
let mut action = None;
let mut it = std::env::args().skip(1);
while let Some(a) = it.next() {
match a.as_str() {
"--root" => root = Some(PathBuf::from(it.next().ok_or_else(usage)?)),
"--port-offset" => offset = it.next().and_then(|v| v.parse().ok()).ok_or_else(usage)?,
_ if ACTIONS.contains(&a.as_str()) && action.is_none() => action = Some(a),
_ => return Err(usage()),
}
}
let root = match root {
Some(r) => r,
None => {
// <server>/Scripts/coa-launcher.exe -> <server>
let exe = std::env::current_exe().map_err(|e| e.to_string())?;
exe.parent().and_then(Path::parent).map(Path::to_path_buf).ok_or("cannot find the server folder")?
}
};
Ok(Args { root, offset, action: action.ok_or_else(usage)? })
}
fn read_line(prompt: &str) -> std::io::Result<String> {
print!("{prompt}");
std::io::stdout().flush()?;
let mut line = String::new();
std::io::stdin().lock().read_line(&mut line)?;
Ok(line.trim_end_matches(['\r', '\n']).to_string())
}
/// Read a line without showing it (passwords).
fn read_secret(prompt: &str) -> std::io::Result<String> {
#[cfg(windows)]
unsafe {
use windows_sys::Win32::System::Console::{GetConsoleMode, GetStdHandle, SetConsoleMode, ENABLE_ECHO_INPUT, STD_INPUT_HANDLE};
let h = GetStdHandle(STD_INPUT_HANDLE);
let mut mode = 0;
if GetConsoleMode(h, &mut mode) != 0 {
SetConsoleMode(h, mode & !ENABLE_ECHO_INPUT);
let line = read_line(prompt);
SetConsoleMode(h, mode);
println!();
return line;
}
}
read_line(prompt)
}
fn valid_login(text: &str) -> bool {
(1..=16).contains(&text.len()) && text.bytes().all(|b| b.is_ascii_alphanumeric())
}
fn ra(cfg: &Settings, root: &Path, command: &str) -> Result<String, String> {
if !services::ready(root, "world", cfg.ra_port) {
return Err("Start this repack's worldserver first.".into());
}
let mut console = coa_core::ra::Ra::connect_to(cfg.ra_port, &cfg.ra_username, &cfg.ra_password).map_err(|e| e.to_string())?;
console.run(command).map_err(|e| e.to_string())
}
fn run(args: Args) -> Result<(), String> {
let root = args.root.as_path();
let e = |x: coa_core::Error| x.to_string();
match args.action.as_str() {
"watch-world" => {
let me = std::env::current_exe().map_err(|x| x.to_string())?;
return world::watch_world(root, Some(&me), args.offset, &|m| say(m)).map_err(e);
}
"relay-worker" => return coa_core::launcher::relay::worker(root).map_err(e),
"debug-logs-status" => {
let on = services::status(root)["debugLogs"].as_bool().unwrap_or(false);
say(&format!("Detailed server logging is {}.", if on { "ON" } else { "off" }));
if on {
say("Every AzerothCore logger is forced to Trace level in Core/Logs (Server.log, Auth.log, world-console.log, auth-console.log). Expect much larger, faster-growing log files.");
}
say("Run Debug_Logs_On.bat / Debug_Logs_Off.bat, then restart the affected service(s) to apply.");
return Ok(());
}
"debug-logs-on" | "debug-logs-off" => {
let on = args.action == "debug-logs-on";
let changed = {
let _lock = state::ControlLock::acquire(root, &args.action, Duration::from_secs(30), &|m| say(m)).map_err(e)?;
world::debug_logs(root, on).map_err(e)?
};
if changed.is_empty() {
say(&format!("Detailed logging was already {}.", if on { "on" } else { "off" }));
} else {
say(&format!("{} detailed logging in: {}", if on { "Enabled" } else { "Restored" }, changed.join(", ")));
}
say("Restart the affected service(s) (Stop_All_Server.bat then Start_All_Server.bat) to apply this.");
return Ok(());
}
_ => {}
}
let cfg = Settings::load(root, args.offset).map_err(e)?;
match args.action.as_str() {
"console" => {
say("World console. Enter a server command, or exit to close this window.");
loop {
let command = read_line("AC> ").map_err(|x| x.to_string())?;
let command = command.trim();
if command.eq_ignore_ascii_case("exit") || command.eq_ignore_ascii_case("quit") {
return Ok(());
}
if !command.is_empty() {
say(&ra(&cfg, root, command)?);
}
}
}
"create-account" => {
let name = read_line("New account name (letters and digits, up to 16): ").map_err(|x| x.to_string())?;
let name = name.trim();
let password = read_secret("New account password (letters and digits, up to 16): ").map_err(|x| x.to_string())?;
let again = read_secret("Repeat password: ").map_err(|x| x.to_string())?;
if !valid_login(name) || !valid_login(&password) {
return Err("Use 1-16 letters or digits for the account name and password.".into());
}
if password != again {
return Err("Passwords do not match.".into());
}
say(&ra(&cfg, root, &format!("account create {name} {password}"))?);
if read_line("Give this account GM permissions? [y/N]: ").map_err(|x| x.to_string())?.trim().eq_ignore_ascii_case("y") {
say(&ra(&cfg, root, &format!("account set gmlevel {name} 3 -1"))?);
}
return Ok(());
}
"ra-once" => {
let command = read_line("").map_err(|x| x.to_string())?;
let command = command.trim();
if command.is_empty() {
return Err("No command given.".into());
}
say(&ra(&cfg, root, command)?);
return Ok(());
}
"create-account-once" => {
let line = read_line("").map_err(|x| x.to_string())?;
let request: serde_json::Value = serde_json::from_str(&line).map_err(|x| x.to_string())?;
let name = request.get("username").and_then(|v| v.as_str()).unwrap_or("").trim().to_string();
let password = request.get("password").and_then(|v| v.as_str()).unwrap_or("").to_string();
if !valid_login(&name) || !valid_login(&password) {
return Err("Use 1-16 letters or digits for the account name and password.".into());
}
let mut messages = vec![ra(&cfg, root, &format!("account create {name} {password}"))?];
if request.get("gm").and_then(|v| v.as_bool()).unwrap_or(false) {
messages.push(ra(&cfg, root, &format!("account set gmlevel {name} 3 -1"))?);
}
say(&serde_json::json!({ "messages": messages }).to_string());
return Ok(());
}
_ => {}
}
match args.action.as_str() {
"status" | "status-json" => {
let _lock = state::ControlLock::acquire(root, &args.action, Duration::from_secs(30), &|m| say(m)).map_err(e)?;
if args.action == "status-json" {
say(&services::status(root).to_string());
} else {
for name in ["mysql", "auth", "world", "relay"] {
let line = match state::running(root, name) {
Some(r) => format!("{name:12} running (PID {})", r.pid),
None => format!("{name:12} stopped"),
};
say(&line);
}
}
return Ok(());
}
_ => {}
}
let action = Action::parse(&args.action).ok_or_else(usage)?;
let me = world::Supervisor::Launcher(std::env::current_exe().map_err(|x| x.to_string())?);
ops::run(root, &cfg, args.offset, action, Some(&me), &|m| say(m)).map_err(e)?;
if args.action.starts_with("start-") {
say("Use Stop_All_Server.bat to shut down this repack safely.");
}
Ok(())
}
fn main() {
let result = parse().and_then(run);
if let Err(message) = result {
eprintln!("ERROR: {message}");
std::process::exit(1);
}
}
+2 -26
View File
@@ -8,10 +8,7 @@
//! coa-release clean-base --repack DIR --core DIR --tree DIR --out DIR [--bots DIR] [--data DIR]
//! coa-release export-baseline --server DIR --out DIR (the three databases of a prepared server, for a Linux package)
//! coa-release sign --dir DIR (key: env COA_SIGNING_KEY, or ~/.coa-manager/signing/manifest-signing.key)
//! coa-release verify --dir DIR (against the public keys built into this tool)
//! coa-release derive-preview --stable DIR --core DIR --recommended FILE --version X --core-commit SHA
//! --min-manager-version X --out DIR (Modules Preview update from a stable update)
//! coa-release public-key (public half of the signing key, to embed in the app)
//! coa-release verify --dir DIR (against the public key built into this tool)
use std::collections::HashMap;
use std::path::PathBuf;
@@ -300,33 +297,12 @@ fn run() -> Result<(), String> {
.map_err(e)?;
println!("signature, archive contents and database schema contract OK");
}
"derive-preview" => {
let out = PathBuf::from(need(&a, "out")?);
let m = coa_core::release::derive_preview_update(
&coa_core::release::PreviewParams {
stable: std::path::Path::new(need(&a, "stable")?),
core: std::path::Path::new(need(&a, "core")?),
recommended: std::path::Path::new(need(&a, "recommended")?),
version: need(&a, "version")?.clone(),
core_commit: need(&a, "core-commit")?.clone(),
min_manager_version: need(&a, "min-manager-version")?.clone(),
out: &out,
},
&|s| eprintln!("{s}"),
)
.map_err(e)?;
println!("preview update {} ({} files) in {}", m.version, m.files.len(), out.display());
}
"public-key" => {
// The public half of the signing key (COA_SIGNING_KEY or the key file), for the app to embed.
println!("{}", coa_core::signing::public_key_of(&signing_key()?).map_err(e)?);
}
"sign-channel" => {
let pointer = coa_core::channels::Pointer {
schema: 1,
channel: need(&a, "channel")?.clone(),
version: need(&a, "version")?.clone(),
release_tag: coa_core::channels::release_tag(need(&a, "channel")?, need(&a, "version")?),
release_tag: format!("server-{}", need(&a, "version")?),
snapshot: need(&a, "snapshot")?.clone(),
};
let bytes = coa_core::channels::sign(&pointer, &signing_key()?).map_err(e)?;
-77
View File
@@ -1,77 +0,0 @@
# Independent Update Stream & Compatibility Matrix
## 1. Overview & Verification Scope
The CoA Modules Preview decouples updates into three independent streams:
- **Stream A:** CSM Desktop Manager Application
- **Stream B:** Modular Core Host (`worldserver.exe`, `authserver.exe`, SDK headers)
- **Stream C:** Dynamic DLL Plugins and Content Packs
This document records the formal verification results for all 10 update and recovery scenarios executed against the contract-based compatibility solver and transaction engine.
---
## 2. Compatibility Solver Decision Architecture
The compatibility solver (`solve_compatibility(&CompatibilityGraph) -> SolverVerdict`) validates proposed updates against strict structural and cryptographic constraints:
```mermaid
flowchart TD
Start[Evaluate Candidate Host or Plugin] --> CheckKnown{Contract Known & Parsable?}
CheckKnown -- No --> RejectUnknown[REJECT: Unsupported - Unknown Contract]
CheckKnown -- Yes --> CheckConflict{Conflicting Modules Installed?}
CheckConflict -- Yes --> RejectConflict[REJECT: Requires Disabling Conflicting Module]
CheckConflict -- No --> CheckABI{ABI Fingerprint Match?}
CheckABI -- Yes --> Compatible[ACCEPT: Compatible As-Is]
CheckABI -- No --> CheckRebuild{Module Rebuild Candidate Available?}
CheckRebuild -- Yes --> ReqRebuild[ACTION: Requires Module Rebuild]
CheckRebuild -- No --> CheckUpdate{Compatible Replacement DLL Available?}
CheckUpdate -- Yes --> ReqUpdate[ACTION: Requires Module Replacement]
CheckUpdate -- No --> RejectABI[REJECT: Incompatible ABI - Update Blocked]
```
### 2.1 Solver Invariant
**Strict Fail-Closed Invariant**: Unknown, incomplete, or ambiguous compatibility records are rejected immediately. An unverified state **never** silently defaults to compatible.
---
## 3. Independent Update Verification Matrix
Each scenario was evaluated under controlled test harnesses simulating production file states, update journals, and running process locks:
| Scenario ID | Test Scenario Description | Input Conditions | Solver Verdict / Action Taken | Result Status | Rollback / Safety Verification |
|---|---|---|---|---|---|
| **SCN-01** | **Old Host + Old Plugin** | Host ABI `2f8201...`, Plugin ABI `2f8201...` | `SolverVerdict::Compatible` | **PASS** | Existing runtime continues unaffected. |
| **SCN-02** | **Old Host + New Compatible Plugin** | Host SDK `0.3.2`, Plugin SDK `0.3.0..=0.3.2`, ABI match | `SolverVerdict::Compatible` | **PASS** | Plugin staged, verified, and hot-swapped without touching host. |
| **SCN-03** | **Old Host + Incompatible Plugin** | Host SDK `0.3.2`, Plugin requires SDK `>= 0.4.0` | `SolverVerdict::Unsupported` | **PASS** | Plugin install blocked; core remains unchanged. |
| **SCN-04** | **New Host + Old Compatible Plugin** | Candidate Host SDK `0.3.3`, Plugin supports `0.3.x`, identical ABI | `SolverVerdict::Compatible` | **PASS** | Host updated; existing plugin loaded seamlessly. |
| **SCN-05** | **New Host + Incompatible Old Plugin (Replacement available)** | Candidate Host ABI `3a91bc...`, Old Plugin ABI `2f8201...`, Verified replacement in catalog | `SolverVerdict::RequiresModuleUpdate("compat replacement")` | **PASS** | User prompted to update both host and plugin together. |
| **SCN-06** | **New Host + Newly Rebuilt Plugin** | Candidate Host ABI `3a91bc...`, Plugin rebuilt against matching SDK | `SolverVerdict::Compatible` | **PASS** | Both binaries staged and verified cleanly. |
| **SCN-07** | **Core Update Interrupted (Crash/Stall during file copy)** | Simulated power failure mid-way through `worldserver.exe` write | Journal detects incomplete transaction (`StagingIncomplete`) | **PASS** | Automatic recovery restores pre-update `worldserver.exe` exactly. |
| **SCN-08** | **Plugin Update Interrupted (Network or disk failure)** | Simulated download failure mid-stream for `squid_playerbots.dll` | File checksum validation fails in staging directory | **PASS** | Staged file purged; live plugin left untouched. |
| **SCN-09** | **Failed Module Post-Update Validation** | Corrupt DLL or unexported symbol causing worldserver startup panic | Process supervisor detects crash within 10s of launch | **PASS** | Transaction marked `FAILED`; automated rollback triggered. |
| **SCN-10** | **Atomic Multi-Artifact Reversion** | User requests manual rollback of host + 3 dynamic plugins | Restore point selected from `.manager/backups/` | **PASS** | Host, DLLs, and configs reverted byte-for-byte in single lock cycle. |
---
## 4. Stop-Gate Enforcement
A core or dynamic plugin binary replacement is strictly prohibited while `worldserver.exe` or `authserver.exe` holds file descriptors or listening sockets:
1. **Active Port Detection:** Port probes check if worldserver TCP port (`8085`) or SOAP port (`7878`) is active.
2. **Process ID Verification:** OS-level task check inspects realm `.state/worldserver.pid`.
3. **Control Lock Guard:** `.state/control.lock` enforces exclusive cross-process synchronization.
4. **Enforcement Behavior:** Any update command issued while the server is active is rejected with error:
```
Error: Stop the server before applying core or dynamic plugin updates.
```
---
## 5. Checkpoint & Rollback Guarantee
Prior to writing any updated binary to disk:
1. An immutable snapshot of the destination directory is saved to `.manager/recovery/<session-id>/`.
2. A manifest checksum of all affected files is written to `transaction.journal`.
3. Candidate files are staged in `.manager/staging/<session-id>/` and validated with SHA-256 before replacement.
4. In the event of file replace failure, power loss, or crash during startup, the journal executes byte-for-byte restoration.
-78
View File
@@ -1,78 +0,0 @@
# Preview Builder & Release Qualification Report
## 1. Candidate Identification
| Field | Value |
|---|---|
| **Product Target** | CoA Modules Preview — Modular Host & Dynamic Modules |
| **Preview Channel** | `preview/modules-v2` |
| **Core Branch** | `preview/dynamic-plugin-host` |
| **Core Full Commit SHA** | `a11c2a7143c29e4ce8021d63eae319a2cc623f99` |
| **Builder Full Commit SHA** | `b976818eb8aef00d3dfc78be9939e14c1f930e1c` |
| **Manager Commit SHA** | `3b06b75` |
| **CoA Plugin SDK Version** | `0.3.2` |
| **SDK ABI Fingerprint** | `2f82013def4698d3f75fa24e5f70ffa504a7782d366b5edb78c7adc3c1ee0883` |
| **Toolchain & Compiler** | MSVC 19.44 / C++20 / Windows SDK 10.0.22621.0 |
| **Client Target** | 3.3.5a (12340) |
| **Database Baseline** | `world_base_20261026.sql` / `auth_base_20261026.sql` / `characters_base_20261026.sql` |
| **Verification Timestamp** | 2026-11-03 01:19:14 UTC |
---
## 2. Dedicated Preview Pipelines
The build automation in `Corfirean/coa-server-build` on branch `preview/modules-v2` provides dedicated CI and local scripts:
### 2.1 Workflow Definitions
- `.github/workflows/preview-build.yml`: Compiles the dynamic plugin host `worldserver.exe` from `preview/dynamic-plugin-host`, generates the SDK headers and export contract (`coa_plugin_exports.def`), and builds official dynamic DLL plugins.
- `.github/workflows/preview-verify.yml`: Executes the automated qualification test harness against candidate builds, verifying ABI consistency, symbol export integrity, and regression guards.
- `.github/workflows/preview-release.yml`: Assembles candidate distribution archives and publishes the isolated `csm-preview-latest.json` manifest without touching stable endpoints.
### 2.2 Local Builder Scripts
- `scripts/preview-build.ps1`: Builds modular core and exports SDK headers.
- `scripts/preview-build-plugins.ps1`: Compiles dynamic plugin DLLs against the candidate SDK.
- `scripts/preview-package.ps1`: Packages candidate artifacts, computes SHA-256 digests, and generates `candidate-lock.json`.
- `scripts/preview-verify.ps1`: Verifies that candidate artifacts conform 100% to qualification requirements.
---
## 3. Verified Artifact Catalog & Hashes
All qualified binaries have been compiled, verified, and sealed with immutable SHA-256 hashes:
| Artifact Name | Component Role | Size (Bytes) | SHA-256 Digest |
|---|---|---|---|
| `worldserver.exe` | Dynamic Plugin Host Core | 37,215,744 | `048f810e44bcf7e3bcbbc1c6d3037a5f829e6815e959f9f0cf0d3b3c8594fc4b` |
| `companions.dll` | Dynamic Bot System Plugin | 4,118,528 | `34be20f127c709fc7b6be9b5b6cd49cc16dd38d0e1e2a51d40aef5c3c0e5fd48` |
| `content_scaling.dll` | Dynamic Difficulty Scaling | 729,600 | `46e215ea723c180886c4617e49335dee1edfc3b0dacf7530bcea8755821420a1` |
| `squid_playerbots.dll` | Dynamic SQUID Bot Plugin | 11,269,632 | `9e42dccf534f333c50a49c0e661143267ca4e297d79f6c2b5bcb98ff215f94f0` |
| `time-is-time.dll` | Dynamic Game Clock Sync | 425,984 | `941916f1559c5d120a108e4ad2dca84343ce044cf8d80f8eb0ea7f66a935f1ff` |
| `CSM Modules Preview.exe` | Desktop Manager Preview UI | 54,768,128 | `4c9d13224265505137e90f35131a048723178c241796a5932285f186d0109bfe` |
| `candidate-lock.json` | Immutable Release Lock | 1,420 | Verified Lockfile |
---
## 4. Static vs. Dynamic Duplication Elimination
The dynamic host loader strictly prevents double registration of scripts, bot managers, and hook systems:
1. **Host-Level Dynamic Export**: `worldserver.exe` dynamic host exports `Gossip`, `MailReceiver`, `WorldSessionMgr`, and `Player` destruction hooks via `coa_plugin_exports.def`.
2. **De-coupling of Official Modules**: Official modules (`companions`, `playerbots`, `content-scaling`) are removed from static compilation inside the modular `worldserver.exe`. They are loaded exclusively via `plugins/<module>.dll` through the dynamic plugin loader.
3. **Guard Against Coexistence**: The compatibility solver and core startup validator verify that conflicting bot systems (`companions` vs `playerbots`) cannot simultaneously register active hooks or controllers.
---
## 5. Qualification Gate Results
| Test / Verification Check | Requirement | Result | Status |
|---|---|---|---|
| **Core Source Identity** | Frozen commit `a11c2a7`, not floating branch | Exact SHA locked | **PASS** |
| **Builder Source Identity** | Branch `preview/modules-v2`, commit `b976818` | Exact SHA locked | **PASS** |
| **SDK ABI Stability** | Fingerprint match `2f82013def...` | Exact match | **PASS** |
| **DLL Integrity Verification** | All 4 dynamic plugins load with zero missing imports | Complete export contract | **PASS** |
| **Updater Channel Isolation**| Manifest points to `csm-preview-latest.json` | Verified in `tauri.conf.json` | **PASS** |
| **Stop-Gate Verification** | Prevent core replacement while process is active | Enforced via PID/port check | **PASS** |
| **Rollback Capability** | Full restore from pre-update checkpoint | Tested and verified | **PASS** |
| **Automated Test Suite** | All `coa-core` unit tests pass | 774/774 passed | **PASS** |
**OVERALL BUILDER STATUS: QUALIFIED FOR PREVIEW DISTRIBUTION**
-122
View File
@@ -1,122 +0,0 @@
# CoA Modules Preview — Distribution & Architecture Specification
## 1. Executive Summary
The **CoA Modules Preview** platform establishes an isolated, independently updateable, and migration-capable testing system for AzerothCore dynamic module hosting. It provides external testers with an environment to test dynamic C++ DLL plugins, migration of legacy servers, and modular server operations without disrupting production Stable users or databases.
---
## 2. Source & Branch Topology
To prevent regressions and avoid polluting stable production lines, the architecture defines three isolated branches:
| Subsystem | Repository | Production Stable Branch | Preview Isolation Branch | Responsibility |
|-----------|------------|-------------------------|--------------------------|----------------|
| **Manager UI & Engine** | `Corfirean/coa-server-manager` | `main` | `preview/modules-v2` | Desktop UI, updater client, dynamic component inventory, compatibility solver, server migration wizard |
| **Modular Core** | `Corfirean/azerothcore-wotlk-coa` | `master` | `preview/dynamic-plugin-host` | Dynamic plugin loader host, dynamic export contract (`coa_plugin_exports.def`), C++ SDK export header tree |
| **Builder & Distribution** | `Corfirean/coa-server-build` | `main` | `preview/modules-v2` | CI/CD pipelines, candidate lock manifests, qualified packaging, update manifest endpoints |
### 2.1 Branch Isolation Invariants
1. **Zero Stable Impact**: No changes to `main`/`master` workflows or stable release assets (`coa-bots`, stable `latest.json`).
2. **Explicit Preview Pinning**: The Preview build pipeline explicitly consumes `preview/dynamic-plugin-host` and never silently falls back to stable branches.
3. **Immutable Candidate Lock**: Every preview build is anchored by `candidate-lock.json` freezing exact commit SHAs, ABI fingerprints, and verified module hashes.
---
## 3. Authoritative Per-Realm Component Inventory
Prior versions treated `.conf` or `.conf.dist` presence in `etc/modules` as proof of installation, resulting in phantom modules being displayed. The Preview architecture implements an authoritative per-realm classification engine:
### 3.1 Component Classification Matrix
```mermaid
flowchart TD
Detect[Inspect Realm Component]
Detect --> CheckDLL{DLL in plugins/ or registry?}
CheckDLL -- Yes --> DynDLL[DYNAMIC_DLL: Removable, Dynamic Lifecycle]
CheckDLL -- No --> CheckPatch{MPQ Patch in Data/?}
CheckPatch -- Yes --> Patch[CLIENT_PATCH: Removable/Configurable]
CheckPatch -- No --> CheckContent{Content in data/ or config?}
CheckContent -- Yes --> Content[CONTENT_PACK: Immutable Content Pack]
CheckContent -- No --> CheckModularHost{Modular Host Present?}
CheckModularHost -- Yes --> NotInstalled[NOT INSTALLED: In Catalog Only]
CheckModularHost -- No --> Embedded[CORE_EMBEDDED: Non-removable Legacy Core]
```
| ComponentType | Description | Detection Rule | Removal Allowed |
|---------------|-------------|----------------|-----------------|
| `DYNAMIC_DLL` | Dynamic C++ library loaded at runtime | Verified `.dll` present in `plugins/` or `.manager/plugins/` + valid registration in `.manager/plugins.json` | **YES** (`can_remove = true`) |
| `CORE_EMBEDDED`| C++ module statically compiled into legacy `worldserver.exe` | Non-modular host + binary commit signature or compiled script registration | **NO** (`can_remove = false`) |
| `CONTENT_PACK`| Server-side game content data | DBC/Maps/VMaps/Data directories present under `data/` | **NO** |
| `CLIENT_PATCH`| Client-side MPQ archive | `patch-Z.mpq` / `patch-4.mpq` present in client directory | **YES** |
| `LOGICAL_FEATURE`| Protocol or core logical behavioral switch | Core configuration toggle (e.g. `client-compat`) | **NO** |
### 3.2 Dynamic Removal & Uninstallation
- All `DYNAMIC_DLL` modules (both official and third-party) can be uninstalled through the UI.
- When uninstalled:
1. The module entry is removed from `.manager/plugins.json`.
2. The dynamic `.dll` is purged or archived.
3. The module disappears from the **Installed** view immediately.
4. The module remains available in the **Catalog** tab for re-installation.
- Legacy `CORE_EMBEDDED` modules display a non-removable shield badge preventing improper removal actions.
---
## 4. Three Independent Update Streams
The preview platform decouples updates into three independently deliverable channels:
```
┌─────────────────────────────────────────┐
│ CoA Update Ecosystem │
└────────────────────┬────────────────────┘
│
┌───────────────────────────────┼───────────────────────────────┐
▼ ▼ ▼
┌──────────────────┐ ┌──────────────────┐ ┌──────────────────┐
│ Stream A │ │ Stream B │ │ Stream C │
│ CSM Preview │ │ Modular Host │ │ Dynamic Modules │
│ Application │ │ (worldserver) │ │ & Content Packs │
└────────┬─────────┘ └────────┬─────────┘ └────────┬─────────┘
│ │ │
▼ ▼ ▼
Dedicated Preview Candidate Lock Independent Module
Updater Manifest URL Contract Solver & Lifecycle & Hot-Swap
(csm-preview-latest.json) Stop-Gate Compatibility Gate
```
### 4.1 Stream A: CSM Modules Preview Application
- **App Identifier:** `com.corfirean.csm.preview` (isolated from stable `com.corfirean.csm`).
- **App Data Scope:** `%APPDATA%\CoA Server Manager Preview`.
- **Updater Endpoint:** `https://raw.githubusercontent.com/Corfirean/coa-server-build/preview/modules-v2/updates/csm-preview-latest.json`.
- **Updater Mode:** Tauri v2 signed updater (`createUpdaterArtifacts: true`).
- **Signature Verification:** Mandatory Ed25519 minisign verification before any binary staging.
### 4.2 Stream B: Modular AzerothCore Host
- Updates the host `worldserver.exe`, `authserver.exe`, and export contract SDK.
- **Stop-Gate Requirement:** Core updates are strictly blocked if `worldserver.exe` is actively running.
- **Rollback Guarantee:** Full transactional pre-update snapshot taken prior to executable swap; corrupt startups trigger automatic binary restoration.
### 4.3 Stream C: Dynamic Modules & SDK-Dependent Plugins
- Modules update on individual release cadences (upstream bugfixes, new features).
- Does NOT force a core host update unless the module requires newer host ABI export capabilities.
---
## 5. Contract-Based Compatibility Resolver
Compatibility is evaluated via the `solve_compatibility(&CompatibilityGraph)` solver engine:
### 5.1 Verification Logic
1. **ABI Fingerprint Check:** Compares host `abi_fingerprint` against plugin `target_abi_fingerprint`.
2. **SDK Range Check:** Evaluates whether `host.sdk_version` satisfies `plugin.min_sdk_version..=max_sdk_version`.
3. **Mutual Exclusivity:** Enforces bot exclusivity (e.g., `companions` vs `playerbots` conflict prevention).
4. **Unknown Rejection Invariant:** If metadata is missing or compatibility is indeterminate, the solver returns `SolverVerdict::Unsupported("Unknown ABI contract")`. Indeterminate states never silently become compatible.
---
## 6. Security & Distribution Model
- External preview testers can run both Stable CSM and Preview CSM concurrently without registry or directory collision.
- Updates are staged in `.manager/staging` with SHA-256 hash checks before atomic replacement.
- Full offline rollback preserves user database schemas and configuration integrity across all lifecycle events.
-94
View File
@@ -1,94 +0,0 @@
# Preview Release Handoff & Publication Runbook
## 1. Executive Summary
This handoff document summarizes the delivery of the **CoA Modules Preview Testing Platform**. All code, build pipelines, qualification harnesses, migration adapters, and qualified artifacts have been implemented, tested, and staged locally on dedicated preview branches.
---
## 2. Qualified Artifact Manifest & SHA-256 Hashes
The candidate artifacts have been compiled, verified, and sealed with immutable SHA-256 digests:
| Artifact Name | Scope / Role | Size (Bytes) | SHA-256 Digest |
|---|---|---|---|
| `worldserver.exe` | Modular Dynamic Plugin Host | 37,215,744 | `048f810e44bcf7e3bcbbc1c6d3037a5f829e6815e959f9f0cf0d3b3c8594fc4b` |
| `companions.dll` | Official Dynamic Bot Plugin | 4,118,528 | `34be20f127c709fc7b6be9b5b6cd49cc16dd38d0e1e2a51d40aef5c3c0e5fd48` |
| `content_scaling.dll` | Official Dynamic Scaling Plugin | 729,600 | `46e215ea723c180886c4617e49335dee1edfc3b0dacf7530bcea8755821420a1` |
| `squid_playerbots.dll` | Official Dynamic SQUID Bot Plugin | 11,269,632 | `9e42dccf534f333c50a49c0e661143267ca4e297d79f6c2b5bcb98ff215f94f0` |
| `time-is-time.dll` | Dynamic Game Time Synchronization | 425,984 | `941916f1559c5d120a108e4ad2dca84343ce044cf8d80f8eb0ea7f66a935f1ff` |
| `CSM Modules Preview.exe` | Desktop Preview Application (Debug) | 54,768,128 | `4c9d13224265505137e90f35131a048723178c241796a5932285f186d0109bfe` |
| `candidate-lock.json` | Candidate Lockfile | 1,420 | `73c09b78a05c754d9220993510c49466b0cf1c0b39c0bc067ddafecbc1b0fa3f` |
---
## 3. Branch Topology & Staged Commits
All three source repositories are staged on their dedicated preview branches:
1. **Manager UI & Subsystems:**
- **Repository:** `Corfirean/coa-server-manager`
- **Branch:** `preview/modules-v2`
- **Commit:** `3b06b75`
- **Changes:** Authoritative module inventory, component classification (`ComponentType`), contract-based compatibility solver, Server Migration Center wizard and adapters, updater manifest isolation.
2. **Dynamic Plugin Host Core:**
- **Repository:** `Corfirean/azerothcore-wotlk-coa`
- **Branch:** `preview/dynamic-plugin-host`
- **Commit:** `a11c2a7143c29e4ce8021d63eae319a2cc623f99`
- **Changes:** Dynamic symbol export contract (`coa_plugin_exports.def`), C++ dynamic plugin loader, symbol exports for `Gossip`, `MailReceiver`, `WorldSessionMgr`, and `Player` destruction.
3. **Build & Release Pipelines:**
- **Repository:** `Corfirean/coa-server-build`
- **Branch:** `preview/modules-v2`
- **Commit:** `b976818`
- **Changes:** Workflows `preview-build.yml`, `preview-verify.yml`, `preview-release.yml`, builder automation scripts, immutable lockfile `candidate-lock.json`, and isolated updater channels.
---
## 4. Repository Owner Publication Instructions
To publish this candidate release to external testers, the repository owner should follow this runbook:
### Step 1: Push Dedicated Branches to Remote
Run the following git push commands to publish the isolated branches:
```bash
# Push Manager Preview Branch
cd C:\games\coa-server-manager-preview
git push origin preview/modules-v2
# Push Core Host Dynamic Plugin Branch
cd C:\games\coa-core-fork
git push origin preview/dynamic-plugin-host
# Push Builder Infrastructure Branch
cd C:\games\coa-server-build
git push origin preview/modules-v2
```
### Step 2: Sign Updater Packages (Tauri v2)
Using the repository owner's private signing key:
```bash
# Generate signature for csm-modules-preview release package
tauri signer sign -k <PATH_TO_PRIVATE_KEY> "release-preview/CSM-Modules-Preview-v2/csm-modules-preview_0.7.1_x64_en-US.msi.zip"
```
Update the `signature` field in `updates/csm-preview-latest.json` with the resulting signature string.
### Step 3: Trigger GitHub Action Release
Navigate to `Corfirean/coa-server-build` Actions tab and dispatch workflow:
- **Workflow:** `preview-release.yml`
- **Branch:** `preview/modules-v2`
- **Release Tag:** `preview-modules-v2-rc1`
The workflow will create a GitHub Pre-release and deploy `csm-preview-latest.json` to the preview update distribution endpoint.
---
## 5. Verification Checklist
- [x] Stable release branches and workflows (`main`, `master`, `coa-bots`) remain completely untouched.
- [x] All 774 unit tests in `coa-core` pass without failures.
- [x] All 6 scenarios in contract compatibility solver pass.
- [x] Server Migration Center successfully inspects, plans, backs up, and executes legacy server conversion.
- [x] Dynamic DLL modules can be installed, configured, and uninstalled through the UI.
- [x] Core embedded modules are protected from improper deletion.
- [x] Stop-Gate reliably blocks in-flight server binary modifications.
- [x] Automated preflight snapshots guarantee rollback capability.
-83
View File
@@ -1,83 +0,0 @@
# Server Migration Center — Compatibility & Adapter Specification
## 1. Overview & Architecture
The **Server Migration Center** is an integrated engine and UI wizard within CSM Modules Preview designed to safely transition existing AzerothCore realms (including legacy monolithic `coa-bots` servers) to the modular dynamic host architecture.
The migration subsystem operates through an authoritative 9-step lifecycle:
```
Discover ➔ Inspect ➔ Classify ➔ Compare ➔ Plan ➔ Backup ➔ Transfer ➔ Validate ➔ Commit
```
---
## 2. Migration Lifecycle Stages
```mermaid
sequenceDiagram
autonumber
actor User as Tester / Admin
participant Wizard as Migration Wizard UI
participant Core as Migration Engine (coa-core)
participant Source as Source Server
participant Target as Target Modular Realm
User->>Wizard: Select Source Directory & Target Realm
Wizard->>Core: preview_migration_inspect(source_path)
Core->>Source: Read worldserver.conf, module configs, database schemas
Core-->>Wizard: SourceInspectionView (modules, db status, server identity)
User->>Wizard: Select Migration Scope (Configs, Characters, World DB)
Wizard->>Core: preview_migration_plan(source_path, target_realm, scope)
Core-->>Wizard: MigrationPlanView (tasks, adapters, warnings, conflicts)
User->>Wizard: Confirm Preflight Plan
Wizard->>Core: preview_migration_execute(source_path, target_realm, plan)
Core->>Target: 1. Create Pre-migration Backup (.manager/backups/migration-pre-*)
Core->>Target: 2. Deploy Dynamic Module DLLs & Registry
Core->>Target: 3. Execute Versioned Config Adapters
Core->>Target: 4. Import/Migrate Database Tables & Accounts
Core->>Target: 5. Verify Target File & Plugin Integrity
Core-->>Wizard: MigrationExecutionResult (success, tasks_completed, warnings)
Wizard-->>User: Display Migration Summary & Launch Realm
```
---
## 3. Versioned Module Adapters
The migration engine utilizes dedicated, versioned adapters to transform monolithic configs and database states into modular components without data loss:
### 3.1 Supported Migration Adapters
| Adapter Name | Source Module Identity | Target Dynamic Plugin | Configuration Mapping Details |
|---|---|---|---|
| **CompanionsAdapter** | `mod_coa_playerbots` (`mod_coa_playerbots.conf`) | `companions` (`companions.dll`) | Migrates `CoaBots.Enable`, bot limits, companion inventories, and AI party behaviors into `etc/modules/companions.conf`. |
| **SquidPlayerbotsAdapter** | `mod-playerbots` (`playerbots.conf`) | `playerbots` (`squid_playerbots.dll`) | Translates SQUID bot settings (`AiPlayerbot.*`), guild bot flags, and bot combat rotations into `etc/modules/squid_playerbots.conf`. |
| **ContentScalingAdapter** | `mod-content-scaling` (`mod_content_scaling.conf`) | `content-scaling` (`content_scaling.dll`) | Maps health multipliers, damage curves, and dungeon group size auto-scaling into `etc/modules/content_scaling.conf`. |
| **AuctionHouseBotAdapter**| `mod-auction-house-bot` (`mod_ahbot.conf`) | `ah-bot` (`ah-bot.dll`) | Converts auction buyer/seller intervals, item price multipliers, and inventory caps. |
| **NpcEnchanterAdapter** | `mod-npc-enchanter` (`mod_npc_enchanter.conf`) | `npc-enchanter` (`npc-enchanter.dll`) | Converts NPC vendor costs and reagent bypass flags. |
| **CustomRacesAdapter** | `mod-custom-races` | `custom-races` (Client Patch + Script) | Validates client MPQ patches and links character creation hooks. |
---
## 4. Conflict Prevention & Invariants
To avoid gameplay and engine instability, the migration engine strictly enforces the following invariants:
1. **Bot Manager Mutex:**
- A realm cannot have both `companions` and `playerbots` active simultaneously.
- If a source realm contains configuration for both bot systems, the migration planner flags a `Warning::BotConflict` and prompts the user to select the active primary bot system before proceeding.
2. **Double-Scaling Prevention:**
- Monolithic scaling logic embedded in old cores is retired upon transition to modular `worldserver.exe`.
- The adapter verifies that only `content_scaling.dll` handles creature stat recalculation, preventing compound stat explosion (e.g. bosses receiving 4x health instead of 2x).
3. **Database GUID & Row Preservation:**
- Character GUIDs, pet IDs, mail items, guild rosters, and bot equipment records in `characters` database are preserved byte-for-byte.
- Database migration scripts are applied additively without dropping existing user tables.
---
## 5. Rollback & Fault Tolerance
Every migration action is protected by transactional safety:
- **Pre-Migration Safety Snapshot:** Before modifying any file or database in the target realm, the engine creates an uncompressed snapshot in `.manager/backups/migration-pre-<timestamp>/`.
- **Atomic File Writing:** All target configuration and plugin files are written via atomic file replacement (`fsx::atomic_write`).
- **Disaster Recovery:** If any error occurs during file translation, DLL staging, or database copy, the wizard halts execution, restores all files from the snapshot, and reports the exact diagnostic error message to the user.
-92
View File
@@ -1,92 +0,0 @@
# Tester Guide: CoA Modules Preview Testing Platform
Welcome to the **CoA Modules Preview**! This platform introduces dynamic C++ DLL plugins, an authoritative dynamic module inventory, independent update streams, and the automated Server Migration Center.
This guide helps external testers set up test environments, run migrations, evaluate dynamic modules, and report diagnostic findings.
---
## 1. Quick Start & Installation
### 1.1 Portable vs. Installed Mode
- **Portable Distribution:** Unpack `CSM-Modules-Preview-Portable.zip` into any folder (e.g. `C:\Games\CSM-Preview\`) and launch `CSM Modules Preview.exe`. All application state is stored locally within the directory.
- **Side-by-Side Coexistence:** The Preview application uses the unique application identifier `com.corfirean.csm.preview` and stores configuration in `%APPDATA%\CoA Server Manager Preview`. You can safely run both the **Stable CSM** and **Preview CSM** on the same Windows machine without configuration collisions.
---
## 2. Dynamic Module Management
### 2.1 The Authoritative Inventory
Unlike earlier versions that treated leftover `.conf` files as proof of installation, the Preview application verifies actual runtime presence:
- **Installed Tab:** Shows only components truly installed in the active realm (`DYNAMIC_DLL`, `CORE_EMBEDDED`, `CONTENT_PACK`, `CLIENT_PATCH`).
- **Catalog Tab:** Lists available modules ready for installation.
### 2.2 Installing a Dynamic Module
1. Open **Modules** from the left navigation bar.
2. Switch to the **Catalog** tab.
3. Choose a module (e.g. **CoA Companions**, **Content Scaling**, or **TimeIsTime**).
4. Click **Install Module**.
5. Once installed, the module moves to the **Installed** tab with a blue `DLL` badge.
6. Click the gear icon to customize module settings (e.g. companion limits, XP rates, or bot behaviors).
### 2.3 Uninstalling a Dynamic Module
1. In the **Installed** tab, locate the dynamic module.
2. Click **Remove Module**.
3. Confirm uninstallation.
4. The module DLL is removed from `plugins/`, unregistered from `.manager/plugins.json`, and immediately disappears from the **Installed** list while remaining accessible in **Catalog**.
> [!NOTE]
> Core embedded legacy modules display an amber `EMBEDDED` badge. In accordance with safety rules, embedded code cannot be removed via DLL deletion.
---
## 3. Testing the Server Migration Center
The Server Migration Center allows you to upgrade an existing monolithic AzerothCore or `coa-bots` server into the modular architecture:
### 3.1 Migration Steps
1. Click **Server Migration** (`Перенос сервера`) in the left navigation sidebar.
2. **Step 1: Source & Target**:
- Enter or browse to the path of your legacy server (e.g. `C:\OldServer\`).
- Select the target modular realm where you want to migrate data.
- Click **Inspect Server**.
3. **Step 2: Source Inspection**:
- Review detected components, core commit, database schemas, and existing module configurations.
4. **Step 3: Migration Scope**:
- Check the components you wish to migrate:
- [x] Module Configuration (converts legacy configs via versioned adapters)
- [x] Character & Account Databases (preserves GUIDs, bots, items, gold)
- [x] World Database Overrides & Custom Spawns
- [x] Client MPQ Patches
5. **Step 4: Preflight Plan**:
- Inspect the adapter execution plan (`CompanionsAdapter`, `ContentScalingAdapter`, etc.).
- Verify that all conflict warnings are resolved.
6. **Step 5: Execute & Verify**:
- Click **Execute Migration**.
- The engine automatically creates a pre-migration safety backup in `.manager/backups/`.
- Monitor the real-time progress bar.
- Upon completion, review the final validation report and launch your updated modular realm!
---
## 4. Independent Update Testing
The Preview Manager features its own dedicated update channel:
- **Application Updates:** Preview checks `csm-preview-latest.json`. It will never prompt to download stable releases, nor will stable CSM download preview releases.
- **Stop-Gate Testing:** Verify that trying to update the core host while `worldserver.exe` is running correctly displays the Stop-Gate protection error.
- **Rollback Verification:** If a module update fails or the server process crashes on boot, verify that the previous working binaries can be restored from the **Backups** tab.
---
## 5. Diagnostic Reporting & Logs
If you encounter unexpected behavior, crashes, or migration errors:
1. Locate the diagnostic logs:
- Application Log: `%APPDATA%\CoA Server Manager Preview\logs\preview.log`
- Server World Log: `<RealmPath>\logs\worldserver.log`
- Migration Journal: `<RealmPath>\.manager\backups\migration.journal`
2. Create a zip archive containing the logs and relevant `.conf` files.
3. Submit your report to the testing issue tracker or Discord channel with:
- Windows OS version
- Source server commit / version
- Steps to reproduce
+1 -1
View File
@@ -3,7 +3,7 @@
<head>
<meta charset="UTF-8" />
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
<title>CSM Modules Preview</title>
<title>CoA Server Manager</title>
<link rel="icon" type="image/png" href="/src/assets/logo.png" />
</head>
<body>
-1
View File
@@ -1 +0,0 @@
KASc8Nx8HKDW6DycDfqGgMgZaU1n9M8P20vBfNszgfA=
Loaded 100 of 160 files, more files were not shown because too many files have changed in this diff. Show more