mirror of
https://github.com/Corfirean/coa-server-manager.git
synced 2026-11-19 11:25:56 +00:00
Compare commits
86
Commits
| Author | SHA1 | Date | |
|---|---|---|---|
|
|
9f6d35fb9f | ||
|
|
41977442e9 | ||
|
|
c75785d13e | ||
|
|
2b9021ce07 | ||
|
|
d812b7868f | ||
|
|
8cce092d16 | ||
|
|
d087d65444 | ||
|
|
b9e663079e | ||
|
|
d7693b0878 | ||
|
|
1f64da3ae0 | ||
|
|
1aec8e5394 | ||
|
|
326a4fe3d3 | ||
|
|
59132216f7 | ||
|
|
f9839ba369 | ||
|
|
e951eb134b | ||
|
|
6cbf007d72 | ||
|
|
07e9bc497d | ||
|
|
e4edb7cbdd | ||
|
|
ca2514c790 | ||
|
|
69c9938aba | ||
|
|
06b606c100 | ||
|
|
2fd42f2acd | ||
|
|
34f6fa1cd1 | ||
|
|
fc8b18ef97 | ||
|
|
05630ec9eb | ||
|
|
d64fdb51be | ||
|
|
260d10b729 | ||
|
|
20657df203 | ||
|
|
f08ae1c76b | ||
|
|
4fc133c35e | ||
|
|
de38e60444 | ||
|
|
3c26004e04 | ||
|
|
d1534ebc92 | ||
|
|
20d4c3351e | ||
|
|
8a313b83b8 | ||
|
|
7eea72c415 | ||
|
|
e8ffa6efe3 | ||
|
|
baeecd2ddf | ||
|
|
d352731280 | ||
|
|
a0545286ee | ||
|
|
4acc07d6fd | ||
|
|
993a7b8e63 | ||
|
|
6f8ed793a7 | ||
|
|
b3c88ce2a6 | ||
|
|
1d9817bd7a | ||
|
|
d71c5635e3 | ||
|
|
cbaca4f917 | ||
|
|
755761d0de | ||
|
|
550e475962 | ||
|
|
f126cb4ed0 | ||
|
|
fdbf38ee4e | ||
|
|
6091e545f8 | ||
|
|
2e6fcceb05 | ||
|
|
5ccd8871d1 | ||
|
|
abcc816581 | ||
|
|
1ee17f8415 | ||
|
|
71ffd568bb | ||
|
|
8353b791fb | ||
|
|
b81227b0ea | ||
|
|
a9fb982ab0 | ||
|
|
a822bfc99b | ||
|
|
1211de5a77 | ||
|
|
ee36692db7 | ||
|
|
ee43522019 | ||
|
|
a0d3cc08ce | ||
|
|
89e2abb642 | ||
|
|
b4dc30b84a | ||
|
|
73a6cca753 | ||
|
|
705bee7d56 | ||
|
|
5aa9b32283 | ||
|
|
711f378ae8 | ||
|
|
c29d56e2b3 | ||
|
|
d63e85bb18 | ||
|
|
c513649beb | ||
|
|
d2e6fef188 | ||
|
|
db23c9b098 | ||
|
|
f62729d281 | ||
|
|
e7744dfc7c | ||
|
|
899b7c6617 | ||
|
|
3987f1b2ff | ||
|
|
b647e62ca6 | ||
|
|
d990efcfad | ||
|
|
9f48cfc8d5 | ||
|
|
3866e219ce | ||
|
|
2224afd2ea | ||
|
|
1a1976d9ad |
No files matched your search
@@ -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
|
||||
@@ -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
|
||||
@@ -8,6 +8,47 @@ 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.15 — 2026-11-19
|
||||
|
||||
- The Custom Races client update brings version 2.0.2.
|
||||
|
||||
[Release](https://github.com/Corfirean/coa-server-manager/releases/tag/v0.9.15) · [Source changes](https://github.com/Corfirean/coa-server-manager/compare/v0.9.14...v0.9.15)
|
||||
|
||||
## 0.9.14 — 2026-11-16
|
||||
|
||||
- Install community addons from the Manager.
|
||||
- Old item and creature data is cleared before every Play.
|
||||
- Turning the custom races client patch on or off takes seconds again.
|
||||
- The database moves to a free port when Windows reserves or another program takes 3307.
|
||||
- Your own MySQL settings survive restarts and updates.
|
||||
- Disabled custom races stay disabled after a server update that adds races.
|
||||
- Rename your realms in the Manager.
|
||||
- The account for a friend's server is in the login box at every Play.
|
||||
- Restart the world every day at a chosen time.
|
||||
- Switches for the Custom Races V2 subclasses, Hero Races and the /dev menu.
|
||||
- Companion bots on Wildcard and Warcraft Reborn.
|
||||
- The Custom Races card tells which characters stay out while races are off.
|
||||
|
||||
[Release](https://github.com/Corfirean/coa-server-manager/releases/tag/v0.9.14) · [Source changes](https://github.com/Corfirean/coa-server-manager/compare/v0.9.13...v0.9.14)
|
||||
|
||||
## 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
+30
-3
@@ -586,7 +586,7 @@ dependencies = [
|
||||
|
||||
[[package]]
|
||||
name = "coa-core"
|
||||
version = "0.9.9"
|
||||
version = "0.9.15"
|
||||
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.15"
|
||||
dependencies = [
|
||||
"coa-core",
|
||||
"serde_json",
|
||||
"windows-sys 0.60.2",
|
||||
]
|
||||
|
||||
[[package]]
|
||||
name = "coa-registry-proto"
|
||||
version = "0.1.0"
|
||||
@@ -634,7 +644,7 @@ dependencies = [
|
||||
|
||||
[[package]]
|
||||
name = "coa-release"
|
||||
version = "0.9.9"
|
||||
version = "0.9.15"
|
||||
dependencies = [
|
||||
"chrono",
|
||||
"coa-core",
|
||||
@@ -772,7 +782,7 @@ dependencies = [
|
||||
|
||||
[[package]]
|
||||
name = "csm-modules-preview"
|
||||
version = "0.9.9"
|
||||
version = "0.9.15"
|
||||
dependencies = [
|
||||
"coa-control-proto",
|
||||
"coa-core",
|
||||
@@ -786,7 +796,9 @@ dependencies = [
|
||||
"tauri-plugin-process",
|
||||
"tauri-plugin-single-instance",
|
||||
"tauri-plugin-updater",
|
||||
"tauri-plugin-window-state",
|
||||
"tracing",
|
||||
"uuid",
|
||||
]
|
||||
|
||||
[[package]]
|
||||
@@ -4656,6 +4668,21 @@ dependencies = [
|
||||
"zip 4.6.1",
|
||||
]
|
||||
|
||||
[[package]]
|
||||
name = "tauri-plugin-window-state"
|
||||
version = "2.5.0"
|
||||
source = "registry+https://github.com/rust-lang/crates.io-index"
|
||||
checksum = "5d6815cab7b212f9cfe16a9d79d8d22f9e14159e4a9460f7dec1467167a008e3"
|
||||
dependencies = [
|
||||
"bitflags 2.13.2",
|
||||
"log",
|
||||
"serde",
|
||||
"serde_json",
|
||||
"tauri",
|
||||
"tauri-plugin",
|
||||
"thiserror 2.0.21",
|
||||
]
|
||||
|
||||
[[package]]
|
||||
name = "tauri-runtime"
|
||||
version = "2.12.0"
|
||||
|
||||
+2
-2
@@ -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.15"
|
||||
edition = "2021"
|
||||
license = "AGPL-3.0-only"
|
||||
|
||||
|
||||
+7247
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.
|
||||
@@ -4,4 +4,4 @@ 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.
|
||||
When the compiler modules need is missing or does not match the core, the Toolchain tab offers to install Visual Studio Build Tools with MSVC 14.44. The Manager checks Microsoft's signature on the installer and opens it with the needed parts selected.
|
||||
@@ -4,4 +4,4 @@ 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.
|
||||
After a core update, every enabled module is rebuilt for the new core before the first start, or an existing build is reused. A module that cannot be rebuilt is switched off with the reason shown. Rolling back the core restores the earlier builds.
|
||||
@@ -4,4 +4,4 @@ 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.
|
||||
On a core that loads Content Scaling, Companions or SQUID's Playerbots as modules, the Manager installs them at the versions the core names before the first start. Bots follow what the server used: SQUID if it was on, else Companions. Removed modules stay removed.
|
||||
@@ -0,0 +1,8 @@
|
||||
---
|
||||
area: manager
|
||||
type: changed
|
||||
audience: admins
|
||||
title: Dungeon Clear is shown and switched as part of SQUID's Playerbots
|
||||
---
|
||||
Dungeon Clear no longer has a card of its own, which said "Always on" while SQUID was off. It goes on
|
||||
and off together with SQUID's Playerbots, and its settings open from the SQUID card.
|
||||
@@ -0,0 +1,7 @@
|
||||
---
|
||||
area: manager
|
||||
type: changed
|
||||
audience: admins
|
||||
title: Modules Preview installs a bare modular core and copies classic servers
|
||||
---
|
||||
A new server gets the modular core and compiles no module; add modules later on the Modules page. An existing classic server is not converted: a modular server is installed next to it with its accounts, characters, world, bots and module settings copied. The old server keeps working.
|
||||
@@ -0,0 +1,7 @@
|
||||
---
|
||||
area: manager
|
||||
type: added
|
||||
audience: admins
|
||||
title: Bot strength settings for CoA Companions
|
||||
---
|
||||
A Bot Strength section in the bot settings: turn bot help on or off, choose where it applies (dungeons, raids, PvP, open world) and set bot damage, healing, damage taken and tank threat. All multipliers start at 1, so nothing changes until you raise them.
|
||||
@@ -0,0 +1,7 @@
|
||||
---
|
||||
area: manager
|
||||
type: changed
|
||||
audience: admins
|
||||
title: The Manager starts and stops servers without Python
|
||||
---
|
||||
Start, stop and forced stop run inside the Manager, and errors name their cause (a busy port, missing files, a startup failure). Servers that include Scripts/coa-launcher.exe also run the world supervisor and bug-report relay without Python.
|
||||
@@ -0,0 +1,7 @@
|
||||
---
|
||||
area: manager
|
||||
type: fixed
|
||||
audience: admins
|
||||
title: Server Migration shows the real server and makes a real modular copy
|
||||
---
|
||||
The page read nothing and reported a transfer that did not happen. It now shows the server's version, database state and counts, then makes the same modular copy as "Manage another server". World settings from Server Configuration now go along with the copy.
|
||||
@@ -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.
|
||||
@@ -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.
|
||||
@@ -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.
|
||||
@@ -0,0 +1,7 @@
|
||||
---
|
||||
area: manager
|
||||
type: fixed
|
||||
audience: admins
|
||||
title: Installing a new server works again in the Modules Preview
|
||||
---
|
||||
The newest server release needs a newer Manager than the previous preview, so a fresh install stopped with "This package needs a newer version". This preview meets that requirement.
|
||||
@@ -0,0 +1,7 @@
|
||||
---
|
||||
area: manager
|
||||
type: changed
|
||||
audience: players
|
||||
title: The Custom Races client update brings version 2.0.2
|
||||
---
|
||||
Updating the Custom Races client now installs 2.0.2: the retail body model files, the subclass and HD patches, the current CoACustomRace.exe and the newer subclass interface with the Two-Players bar. The 2.0 archives already downloaded are reused, so about 4.4 GB of new files are fetched. Update the Manager before the server: the matching server release needs this version.
|
||||
+83
-1
@@ -172,10 +172,26 @@
|
||||
"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-addon-catalog.md",
|
||||
"Corfirean/coa-server-manager:20261115-clear-game-cache.md",
|
||||
"Corfirean/coa-server-manager:20261115-custom-races-fast-toggle.md",
|
||||
"Corfirean/coa-server-manager:20261115-custom-races-v2-client.md",
|
||||
"Corfirean/coa-server-manager:20261115-database-port-relocation.md",
|
||||
"Corfirean/coa-server-manager:20261115-mysql-custom-options.md",
|
||||
"Corfirean/coa-server-manager:20261115-race-restriction-kept.md",
|
||||
"Corfirean/coa-server-manager:20261115-realm-names.md",
|
||||
"Corfirean/coa-server-manager:20261115-remembered-friend-login.md",
|
||||
"Corfirean/coa-server-manager:20261115-scheduled-restart.md",
|
||||
"Corfirean/coa-server-manager:20261115-v2-feature-switches.md",
|
||||
"Corfirean/coa-server-manager:20261116-companions-wildcard-reborn.md",
|
||||
"Corfirean/coa-server-manager:20261116-custom-race-characters-off.md",
|
||||
"Corfirean/coa-server-manager:20261118-custom-races-2-0-2-client.md"
|
||||
],
|
||||
"releases": [
|
||||
{
|
||||
@@ -900,6 +916,72 @@
|
||||
],
|
||||
"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"
|
||||
},
|
||||
{
|
||||
"tag": "v0.9.14",
|
||||
"version": "0.9.14",
|
||||
"date": "2026-11-16",
|
||||
"url": "https://github.com/Corfirean/coa-server-manager/releases/tag/v0.9.14",
|
||||
"notes": [
|
||||
"Install community addons from the Manager",
|
||||
"Old item and creature data is cleared before every Play",
|
||||
"Turning the custom races client patch on or off takes seconds again",
|
||||
"The database moves to a free port when Windows reserves or another program takes 3307",
|
||||
"Your own MySQL settings survive restarts and updates",
|
||||
"Disabled custom races stay disabled after a server update that adds races",
|
||||
"Rename your realms in the Manager",
|
||||
"The account for a friend's server is in the login box at every Play",
|
||||
"Restart the world every day at a chosen time",
|
||||
"Switches for the Custom Races V2 subclasses, Hero Races and the /dev menu",
|
||||
"Companion bots on Wildcard and Warcraft Reborn",
|
||||
"The Custom Races card tells which characters stay out while races are off"
|
||||
],
|
||||
"commit": "1f64da3ae064b3f02d2bb11d818c44d26a557045",
|
||||
"compare": "https://github.com/Corfirean/coa-server-manager/compare/v0.9.13...v0.9.14"
|
||||
},
|
||||
{
|
||||
"tag": "v0.9.15",
|
||||
"version": "0.9.15",
|
||||
"date": "2026-11-19",
|
||||
"url": "https://github.com/Corfirean/coa-server-manager/releases/tag/v0.9.15",
|
||||
"notes": [
|
||||
"The Custom Races client update brings version 2.0.2"
|
||||
],
|
||||
"commit": "2b9021ce072e3b6c7e9c8106f8a54f59f1b37424",
|
||||
"compare": "https://github.com/Corfirean/coa-server-manager/compare/v0.9.14...v0.9.15"
|
||||
}
|
||||
]
|
||||
}
|
||||
@@ -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 = []
|
||||
@@ -0,0 +1,7 @@
|
||||
//! Analyze a module by its GitHub link, as "Add from a link" does. usage: analyze_url <url> <cache dir>
|
||||
fn main() {
|
||||
let a: Vec<String> = std::env::args().skip(1).collect();
|
||||
let r = coa_core::analyzer::analyze_github_repository(&a[0], Some(std::path::Path::new(&a[1]))).expect("analysis");
|
||||
println!("{} @ {} cache_hit={:?}", r.repository_name, r.commit, r.cache_hit);
|
||||
println!("classification {:?}; hooks {}; sql {}; cmake {}", r.classification, r.hooks.len(), r.sql_files.len(), r.has_cmakelists);
|
||||
}
|
||||
@@ -0,0 +1,58 @@
|
||||
//! Real MSVC + CMake + Ninja: after the build cache is packed and unpacked, a rebuild with nothing changed
|
||||
//! compiles nothing, and a rebuild after one source changed compiles only that source.
|
||||
//! usage: build_cache_ninja_check <empty folder>
|
||||
use std::path::Path;
|
||||
use std::process::Command;
|
||||
|
||||
fn build(root: &Path, dir: &Path, tc: &coa_core::build_engine::ToolchainStatus) -> String {
|
||||
let bat = root.join("run.bat");
|
||||
let ninja = Path::new(tc.ninja_path.as_ref().unwrap()).parent().unwrap().display().to_string();
|
||||
std::fs::write(&bat, format!(
|
||||
"@echo off\r\ncall \"{}\" > nul 2>&1\r\nset \"PATH={};%PATH%\"\r\n\"{}\" -G Ninja -S \"{}\" -B \"{}\\build\" -DCMAKE_BUILD_TYPE=RelWithDebInfo > nul\r\n\"{}\" --build \"{}\\build\" -- -d explain\r\n",
|
||||
tc.vcvars64_path.as_ref().unwrap(), ninja, tc.cmake_path.as_ref().unwrap(), dir.display(), dir.display(), tc.cmake_path.as_ref().unwrap(), dir.display()
|
||||
)).unwrap();
|
||||
let out = Command::new("cmd.exe").args(["/c", &bat.to_string_lossy()]).output().unwrap();
|
||||
assert!(out.status.success(), "{}{}", String::from_utf8_lossy(&out.stdout), String::from_utf8_lossy(&out.stderr));
|
||||
String::from_utf8_lossy(&out.stdout).into_owned() + &String::from_utf8_lossy(&out.stderr)
|
||||
}
|
||||
|
||||
fn compiled(log: &str) -> usize {
|
||||
log.lines().filter(|l| l.contains("Building CXX object")).count()
|
||||
}
|
||||
|
||||
fn main() {
|
||||
let root = std::path::PathBuf::from(std::env::args().nth(1).expect("usage: build_cache_ninja_check <empty folder>"));
|
||||
assert!(!root.exists() || std::fs::read_dir(&root).unwrap().next().is_none(), "folder must be new or empty");
|
||||
std::fs::create_dir_all(root.join(".manager")).unwrap();
|
||||
let tc = coa_core::build_engine::detect_toolchain();
|
||||
assert!(tc.msvc_available && tc.cmake_available && tc.ninja_available, "toolchain: {tc:?}");
|
||||
|
||||
let dir = coa_core::build_cache::prepare(&root, "probe", "fp").unwrap();
|
||||
std::fs::write(dir.join("CMakeLists.txt"), "cmake_minimum_required(VERSION 3.22)\nproject(p CXX)\nadd_library(p SHARED a.cpp b.cpp c.cpp)\n").unwrap();
|
||||
for f in ["a", "b", "c"] {
|
||||
std::fs::write(dir.join(format!("{f}.cpp")), format!("#include <vector>\n#include <string>\n__declspec(dllexport) int {f}() {{ return (int)std::vector<std::string>(3).size(); }}\n")).unwrap();
|
||||
}
|
||||
let first = build(&root, &dir, &tc);
|
||||
println!("first build compiled {}", compiled(&first));
|
||||
assert_eq!(compiled(&first), 3);
|
||||
|
||||
coa_core::build_cache::finish(&root, "probe");
|
||||
let s = coa_core::build_cache::summary(&root, None);
|
||||
println!("packed: {} bytes from {} unpacked", s.total_bytes, s.modules[0].unpacked_bytes);
|
||||
assert!(!dir.exists());
|
||||
|
||||
let dir = coa_core::build_cache::prepare(&root, "probe", "fp").unwrap();
|
||||
let again = build(&root, &dir, &tc);
|
||||
println!("after unpack, nothing changed: compiled {}\n{}", compiled(&again), again.lines().filter(|l| l.contains("explain")).take(8).collect::<Vec<_>>().join("\n"));
|
||||
assert_eq!(compiled(&again), 0, "nothing should be recompiled");
|
||||
coa_core::build_cache::finish(&root, "probe");
|
||||
|
||||
let dir = coa_core::build_cache::prepare(&root, "probe", "fp").unwrap();
|
||||
std::thread::sleep(std::time::Duration::from_secs(2));
|
||||
std::fs::write(dir.join("b.cpp"), "__declspec(dllexport) int b() { return 2; }\n").unwrap();
|
||||
let one = build(&root, &dir, &tc);
|
||||
println!("after one change: compiled {}", compiled(&one));
|
||||
assert_eq!(compiled(&one), 1);
|
||||
coa_core::build_cache::finish(&root, "probe");
|
||||
println!("PASS");
|
||||
}
|
||||
@@ -0,0 +1,194 @@
|
||||
//! Build the AzerothCore catalogue's modules against a plugin-host realm's SDK and record, per module, the
|
||||
//! evidence: commit, analysis, build result, compiler errors and the core functions the host does not export.
|
||||
//! A rerun skips modules that already have a result; `summary` aggregates the results.
|
||||
//!
|
||||
//! usage: catalog_build_sweep run <realm> <work dir> <how many, by stars>
|
||||
//! catalog_build_sweep summary <work dir>
|
||||
//! The realm needs only Core/worldserver.exe (a plugin host) and its .manager/sdk; use a disposable copy.
|
||||
use std::collections::BTreeMap;
|
||||
use std::path::{Path, PathBuf};
|
||||
|
||||
use serde::{Deserialize, Serialize};
|
||||
|
||||
#[derive(Serialize, Deserialize, Default)]
|
||||
struct Outcome {
|
||||
slug: String,
|
||||
stars: u32,
|
||||
category: String,
|
||||
pushed_at: Option<String>,
|
||||
commit: Option<String>,
|
||||
/// "built" | "link-missing-exports" | "compile-error" | "not-a-plugin" | "analysis-failed" | "build-error"
|
||||
result: String,
|
||||
detail: Option<String>,
|
||||
classification: Option<String>,
|
||||
seconds: f64,
|
||||
/// Core functions the plugin needs that worldserver.exe does not export (MSVC decorated names).
|
||||
missing_exports: Vec<String>,
|
||||
/// Demangled form of each missing export, for reading.
|
||||
missing_readable: Vec<String>,
|
||||
compile_errors: Vec<String>,
|
||||
}
|
||||
|
||||
fn file_name(slug: &str) -> String {
|
||||
slug.replace('/', "__")
|
||||
}
|
||||
|
||||
/// The decorated name and its readable form out of an LNK2019/LNK2001 message.
|
||||
fn missing_symbol(message: &str) -> Option<(String, String)> {
|
||||
let readable = message.split('"').nth(1).unwrap_or("").to_string();
|
||||
let start = message.find("(?")?;
|
||||
let end = message[start..].find(')')? + start;
|
||||
Some((message[start + 1..end].to_string(), readable))
|
||||
}
|
||||
|
||||
fn run(realm: &Path, work: &Path, count: usize) {
|
||||
let results = work.join("results");
|
||||
std::fs::create_dir_all(&results).unwrap();
|
||||
let sources = work.join("sources");
|
||||
let catalogue = coa_core::catalogue::fetch_or_load_catalogue(&work.join("catalogue"), false).expect("catalogue");
|
||||
let mut items: Vec<_> = catalogue
|
||||
.items
|
||||
.into_iter()
|
||||
.filter(|i| !matches!(i.coa_status, coa_core::catalogue::CoaCompatibilityStatus::Incompatible | coa_core::catalogue::CoaCompatibilityStatus::Blocked))
|
||||
.collect();
|
||||
items.sort_by(|a, b| b.stars.cmp(&a.stars));
|
||||
let tc = coa_core::build_engine::detect_toolchain_for(Some(realm));
|
||||
assert!(tc.msvc_available && tc.cmake_available && tc.ninja_available && tc.sdk_dir.is_some(), "toolchain/SDK for the realm: {tc:?}");
|
||||
|
||||
for (n, item) in items.iter().take(count).enumerate() {
|
||||
let out = results.join(format!("{}.json", file_name(&item.full_name)));
|
||||
if out.is_file() {
|
||||
continue;
|
||||
}
|
||||
let started = std::time::Instant::now();
|
||||
let mut o = Outcome {
|
||||
slug: item.full_name.clone(),
|
||||
stars: item.stars,
|
||||
category: item.category.clone(),
|
||||
pushed_at: item.pushed_at.clone(),
|
||||
..Default::default()
|
||||
};
|
||||
println!("[{}/{}] {} ★{}", n + 1, count.min(items.len()), item.full_name, item.stars);
|
||||
match coa_core::analyzer::analyze_github_repository(&item.html_url, Some(&sources)) {
|
||||
Err(e) => {
|
||||
o.result = "analysis-failed".into();
|
||||
o.detail = Some(e.to_string());
|
||||
}
|
||||
Ok(report) => {
|
||||
o.commit = Some(report.commit.clone());
|
||||
o.classification = Some(format!("{:?}", report.classification));
|
||||
let path = PathBuf::from(&report.repository_path);
|
||||
let path = if path.is_dir() { path } else {
|
||||
sources.join("github").join(&item.owner).join(&item.name).join(&report.commit)
|
||||
};
|
||||
match coa_core::build_engine::build_module_with_bundle(&path, &[], realm, None, None) {
|
||||
Err(e) => {
|
||||
let text = e.to_string();
|
||||
o.result = if text.contains("NO_LOADER_FOUND") || text.contains("No C++") || text.contains("MANUAL_ADAPTER") {
|
||||
"not-a-plugin".into()
|
||||
} else {
|
||||
"build-error".into()
|
||||
};
|
||||
o.detail = Some(text);
|
||||
}
|
||||
Ok(b) if b.success => o.result = "built".into(),
|
||||
Ok(b) => {
|
||||
for e in &b.errors {
|
||||
if e.error_code == "LNK2019" || e.error_code == "LNK2001" {
|
||||
if let Some((mangled, readable)) = missing_symbol(&e.message) {
|
||||
if !o.missing_exports.contains(&mangled) {
|
||||
o.missing_exports.push(mangled);
|
||||
o.missing_readable.push(readable);
|
||||
}
|
||||
}
|
||||
} else if !e.error_code.starts_with("LNK") {
|
||||
o.compile_errors.push(format!("{} {}:{} {}", e.error_code, e.file.rsplit(['/', '\\']).next().unwrap_or(""), e.line, e.message.lines().next().unwrap_or("")));
|
||||
}
|
||||
}
|
||||
o.result = if o.compile_errors.is_empty() && !o.missing_exports.is_empty() {
|
||||
"link-missing-exports".into()
|
||||
} else {
|
||||
"compile-error".into()
|
||||
};
|
||||
o.compile_errors.truncate(10);
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
o.seconds = started.elapsed().as_secs_f64();
|
||||
println!(" -> {} ({:.0}s){}", o.result, o.seconds, if o.missing_exports.is_empty() { String::new() } else { format!(", {} missing exports", o.missing_exports.len()) });
|
||||
std::fs::write(&out, serde_json::to_vec_pretty(&o).unwrap()).unwrap();
|
||||
// source downloads of finished modules are not needed again
|
||||
let _ = std::fs::remove_dir_all(sources.join("github").join(&item.owner).join(&item.name));
|
||||
}
|
||||
}
|
||||
|
||||
fn summary(work: &Path) {
|
||||
let mut all: Vec<Outcome> = std::fs::read_dir(work.join("results")).unwrap()
|
||||
.flatten()
|
||||
.filter_map(|e| serde_json::from_slice(&std::fs::read(e.path()).ok()?).ok())
|
||||
.collect();
|
||||
all.sort_by(|a, b| b.stars.cmp(&a.stars));
|
||||
let mut by_result: BTreeMap<&str, usize> = BTreeMap::new();
|
||||
for o in &all {
|
||||
*by_result.entry(o.result.as_str()).or_default() += 1;
|
||||
}
|
||||
let mut symbols: BTreeMap<String, (String, Vec<String>)> = BTreeMap::new();
|
||||
for o in all.iter().filter(|o| o.result == "link-missing-exports") {
|
||||
for (m, r) in o.missing_exports.iter().zip(&o.missing_readable) {
|
||||
symbols.entry(m.clone()).or_insert_with(|| (r.clone(), Vec::new())).1.push(o.slug.clone());
|
||||
}
|
||||
}
|
||||
let mut lines = vec![format!("modules: {}", all.len())];
|
||||
for (r, n) in &by_result {
|
||||
lines.push(format!(" {r}: {n}"));
|
||||
}
|
||||
lines.push(format!("distinct missing exports (modules that only lack exports): {}", symbols.len()));
|
||||
let mut sym: Vec<_> = symbols.iter().collect();
|
||||
sym.sort_by(|a, b| b.1 .1.len().cmp(&a.1 .1.len()));
|
||||
for (_, (readable, mods)) in sym.iter().take(40) {
|
||||
lines.push(format!(" {:>3} {}", mods.len(), readable));
|
||||
}
|
||||
// why modules do not compile: a header they need is not there (a dependency: playerbots, a library), or
|
||||
// the core's API differs from the one they were written for
|
||||
let mut kinds: BTreeMap<String, usize> = BTreeMap::new();
|
||||
for o in all.iter().filter(|o| o.result == "compile-error") {
|
||||
let header = o.compile_errors.iter().find(|e| e.starts_with("C1083")).and_then(|e| {
|
||||
let start = e.find(": ")? + 2;
|
||||
Some(e[start..].split(':').next()?.trim().to_string())
|
||||
});
|
||||
let kind = match header {
|
||||
Some(h) => format!("missing header {h}"),
|
||||
None => format!("core API differs ({})", o.compile_errors.first().map(|e| e.split(' ').next().unwrap_or("")).unwrap_or("")),
|
||||
};
|
||||
*kinds.entry(kind).or_default() += 1;
|
||||
}
|
||||
lines.push(String::new());
|
||||
lines.push("compile errors by cause:".into());
|
||||
let mut k: Vec<_> = kinds.into_iter().collect();
|
||||
k.sort_by(|a, b| b.1.cmp(&a.1));
|
||||
for (kind, n) in k.iter().take(25) {
|
||||
lines.push(format!(" {n:>3} {kind}"));
|
||||
}
|
||||
lines.push(String::new());
|
||||
for o in &all {
|
||||
lines.push(format!("{:<22} ★{:<5} {:<48} {}", o.result, o.stars, o.slug,
|
||||
if o.result == "link-missing-exports" { format!("{} exports", o.missing_exports.len()) }
|
||||
else { o.detail.clone().or_else(|| o.compile_errors.first().cloned()).unwrap_or_default().chars().take(110).collect() }));
|
||||
}
|
||||
let text = lines.join("\n");
|
||||
println!("{text}");
|
||||
std::fs::write(work.join("summary.txt"), &text).unwrap();
|
||||
// the exports a core build would add, one decorated name per line
|
||||
let def: Vec<&String> = symbols.keys().collect();
|
||||
std::fs::write(work.join("missing-exports.txt"), def.iter().map(|s| s.as_str()).collect::<Vec<_>>().join("\n")).unwrap();
|
||||
}
|
||||
|
||||
fn main() {
|
||||
let a: Vec<String> = std::env::args().skip(1).collect();
|
||||
match a.first().map(String::as_str) {
|
||||
Some("run") => run(Path::new(&a[1]), Path::new(&a[2]), a[3].parse().unwrap()),
|
||||
Some("summary") => summary(Path::new(&a[1])),
|
||||
_ => eprintln!("usage: catalog_build_sweep run <realm> <work> <count> | summary <work>"),
|
||||
}
|
||||
}
|
||||
@@ -0,0 +1,23 @@
|
||||
//! How the module categories fall on a real catalogue: counts per category and a few modules of each.
|
||||
//! usage: catalogue_categories <catalogue.json downloaded from azerothcore.org>
|
||||
fn main() {
|
||||
let path = std::env::args().nth(1).expect("usage: catalogue_categories <catalogue.json>");
|
||||
let raw: coa_core::catalogue::OfficialCatalogueRaw =
|
||||
serde_json::from_slice(&std::fs::read(path).unwrap()).unwrap();
|
||||
let overlay = coa_core::catalogue::load_coa_overlay(None);
|
||||
let items = coa_core::catalogue::normalize_catalogue(&raw, &overlay);
|
||||
let mut by: std::collections::BTreeMap<String, Vec<(u32, String, String)>> = Default::default();
|
||||
for i in &items {
|
||||
let c = coa_core::catalogue::categorize(&i.full_name, &i.name, &i.description, &i.topics);
|
||||
by.entry(c).or_default().push((i.stars, i.full_name.clone(), i.description.chars().take(70).collect()));
|
||||
}
|
||||
println!("modules: {}", items.len());
|
||||
for c in coa_core::catalogue::categories() {
|
||||
let mut list = by.remove(&c.code).unwrap_or_default();
|
||||
list.sort_by(|a, b| b.0.cmp(&a.0));
|
||||
println!("\n== {} ({}) {}", c.code, c.ru, list.len());
|
||||
for (s, n, d) in list.iter().take(6) {
|
||||
println!(" {s:>5} {n:<45} {d}");
|
||||
}
|
||||
}
|
||||
}
|
||||
@@ -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(®_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: ®, 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");
|
||||
}
|
||||
@@ -0,0 +1,197 @@
|
||||
//! 0.9.10 install paths of the Modules Preview, end to end on DISPOSABLE servers under <work>:
|
||||
//!
|
||||
//! 1. fresh: a new server goes on to the preview core with the bare core (no module is compiled).
|
||||
//! 2. copy: a classic server (stopped) gets a modular copy next to it: accounts, characters, the world and
|
||||
//! module settings arrive, the old server's files are byte-for-byte unchanged, the copy takes the
|
||||
//! preview core with the modules the old server had switched on.
|
||||
//! 3. copy-running: the same copy step from a classic server whose database is running.
|
||||
//!
|
||||
//! usage: preview_bare_and_copy_e2e <empty work folder> [fresh|copy|all]
|
||||
use std::collections::BTreeMap;
|
||||
use std::path::{Path, PathBuf};
|
||||
|
||||
use coa_core::install::{install_base, Params, Source};
|
||||
use coa_core::registry::Registry;
|
||||
use coa_core::update::{self, RepackEnv};
|
||||
|
||||
const KEY: &str = coa_core::signing::EMBEDDED_PUBLIC_KEY;
|
||||
type R<T> = Result<T, Box<dyn std::error::Error>>;
|
||||
|
||||
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}"))
|
||||
}
|
||||
|
||||
fn install(root: &Path, reg: &Registry) -> R<()> {
|
||||
let image = coa_core::channels::stable_source()?;
|
||||
let t = std::time::Instant::now();
|
||||
let done = 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 {:?}", root.display(), done.version, t.elapsed());
|
||||
Ok(())
|
||||
}
|
||||
|
||||
fn set_free_ports(root: &Path) -> R<()> {
|
||||
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)?)?;
|
||||
Ok(())
|
||||
}
|
||||
|
||||
/// The same steps as the Manager's install_preview_core.
|
||||
fn preview_core(root: &Path) -> R<update::Outcome> {
|
||||
let meta_dir = coa_core::registry::metadata_dir_for(root)?;
|
||||
let (_, meta) = coa_core::registry::MetaDir::open(&meta_dir)?;
|
||||
let source = coa_core::update_route::select(&meta, coa_core::channels::preview_update_source()?, KEY)?.source;
|
||||
let env = RepackEnv { root, meta_dir: &meta_dir };
|
||||
let t = std::time::Instant::now();
|
||||
let out = coa_core::install::with_scratch_ports(root, || 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 out = out?;
|
||||
println!("[{}] preview core: {:?} in {:?}; modules {:?}", root.display(), out.txn.state, t.elapsed(), out.modules);
|
||||
assert_eq!(out.txn.state, update::State::Committed);
|
||||
assert!(coa_core::provenance::realm_host_fingerprint(root).is_some(), "the plugin host is installed");
|
||||
Ok(out)
|
||||
}
|
||||
|
||||
/// sha256 of every file under the old server, except the launcher's own run state.
|
||||
fn tree(root: &Path) -> BTreeMap<String, String> {
|
||||
fn walk(base: &Path, dir: &Path, out: &mut BTreeMap<String, String>) {
|
||||
for e in std::fs::read_dir(dir).into_iter().flatten().flatten() {
|
||||
let p = e.path();
|
||||
if p.is_dir() {
|
||||
walk(base, &p, out);
|
||||
} else {
|
||||
let rel = p.strip_prefix(base).unwrap().to_string_lossy().replace('\\', "/");
|
||||
out.insert(rel, coa_core::fsx::sha256_file(&p).unwrap_or_else(|e| format!("unreadable: {e}")));
|
||||
}
|
||||
}
|
||||
}
|
||||
let mut out = BTreeMap::new();
|
||||
walk(root, root, &mut out);
|
||||
out
|
||||
}
|
||||
|
||||
fn fresh(work: &Path, reg: &Registry) -> R<()> {
|
||||
let root = work.join("fresh-fixture");
|
||||
install(&root, reg)?; // shipped ports, as in the Manager: another server may be running on them
|
||||
coa_core::rebuild::decline_recommended(&root)?;
|
||||
let out = preview_core(&root)?;
|
||||
assert!(out.modules.is_empty(), "a new server compiles nothing: {:?}", out.modules);
|
||||
let registry = coa_core::plugins::load_registry(&root)?;
|
||||
assert!(registry.plugins.values().all(|e| !e.installed), "no plugin installed: {:?}", registry.plugins.keys());
|
||||
let boot: serde_json::Value = serde_json::from_slice(&std::fs::read(root.join("Core/plugins/plugin-boot-report.json"))?)?;
|
||||
println!("boot report: {boot}");
|
||||
assert_eq!(boot["anyFaulted"], serde_json::json!(false));
|
||||
println!("FRESH PASS");
|
||||
Ok(())
|
||||
}
|
||||
|
||||
fn copy(work: &Path, reg: &Registry) -> R<()> {
|
||||
// A classic server with data of its own.
|
||||
let old = work.join("classic-fixture");
|
||||
install(&old, reg)?;
|
||||
set_free_ports(&old)?; // the test runs this "old" server; it must not meet a real one on the shipped ports
|
||||
sql(&old, "INSERT INTO acore_auth.account (username, salt, verifier, email, reg_mail) \
|
||||
VALUES ('E2ECOPY', UNHEX(REPEAT('11',32)), UNHEX(REPEAT('22',32)), '', '')");
|
||||
let account = sql(&old, "SELECT id FROM acore_auth.account WHERE username='E2ECOPY'").trim().to_string();
|
||||
sql(&old, &format!("SET SESSION sql_mode=''; INSERT INTO acore_characters.characters (guid, account, name, race, class, gender, level, money) \
|
||||
VALUES (900001, {account}, 'Copytest', 1, 1, 0, 42, 123456)"));
|
||||
let conf = old.join("Core/configs/modules/mod-coa-content-scaling.conf");
|
||||
let conf_text = std::fs::read_to_string(&conf).unwrap_or_default() + "\n# e2e owner edit\n";
|
||||
std::fs::write(&conf, &conf_text)?;
|
||||
let fingerprint = |root: &Path| sql(root, "SELECT CONCAT((SELECT COUNT(*) FROM acore_auth.account),'|',(SELECT COUNT(*) FROM acore_characters.characters),'|',\
|
||||
(SELECT CONCAT(name,':',level,':',money) FROM acore_characters.characters WHERE guid=900001))").trim().to_string();
|
||||
let expected = fingerprint(&old);
|
||||
let counts = sql(&old, "SELECT CONCAT((SELECT COUNT(*) FROM acore_auth.account),'|',(SELECT COUNT(*) FROM acore_characters.characters))").trim().to_string();
|
||||
// A world setting changed on the Server Configuration page lives in the old server's template.
|
||||
let old_meta = coa_core::registry::metadata_dir_for(&old)?;
|
||||
let rate = BTreeMap::from([("Rate.XP.Kill".to_string(), "3".to_string())]);
|
||||
assert_eq!(coa_core::allsettings::save(&old, &old_meta, &rate)?, ["Rate.XP.Kill"]);
|
||||
let _ = coa_core::driver::run(&old, coa_core::driver::Verb::StopAll);
|
||||
println!("old server data: {expected}");
|
||||
assert!(coa_core::modular_copy::is_classic(&old));
|
||||
let before_preview = tree(&old);
|
||||
let p = coa_core::modular_copy::preview(&old)?;
|
||||
println!("preview (stopped): {p:?}");
|
||||
assert!(p.classic && !p.modular && p.database == "stopped" && p.accounts.is_none());
|
||||
assert!(p.database_bytes > 0 && p.config_files.iter().any(|f| f.ends_with("mod-coa-content-scaling.conf")));
|
||||
assert_eq!(tree(&old), before_preview, "the preview changed the old server's files");
|
||||
|
||||
// 2. copy of the stopped server, then the preview core on the copy.
|
||||
let before = tree(&old);
|
||||
let new = work.join("copy-fixture");
|
||||
install(&new, reg)?;
|
||||
let report = coa_core::modular_copy::copy_data(&old, &new, &|w| println!(" copy: {w}"))?;
|
||||
println!("copy report: {report:?}");
|
||||
assert_eq!(report.read_from, "copy of the stopped database");
|
||||
assert_eq!(tree(&old), before, "the old server's files changed");
|
||||
let observed = coa_core::process::observe(&new, &coa_core::layout::read_ports(&new));
|
||||
assert_eq!(observed.mysql.state, coa_core::process::ServiceState::Stopped, "a database of the copy is still running: {:?}", observed.mysql);
|
||||
assert!(!coa_core::registry::metadata_dir_for(&new)?.join("import").exists(), "the private copy of the old data is removed");
|
||||
assert_eq!(std::fs::read_to_string(new.join("Core/configs/modules/mod-coa-content-scaling.conf"))?, conf_text);
|
||||
assert_eq!(report.world_settings, ["Rate.XP.Kill"], "skipped: {:?}", report.world_settings_skipped);
|
||||
let world_value = |root: &Path| coa_core::allsettings::list(root).unwrap().into_iter().find(|i| i.key == "Rate.XP.Kill").map(|i| i.value);
|
||||
assert_eq!(world_value(&new).as_deref(), Some("3"));
|
||||
let out = preview_core(&new)?;
|
||||
println!("modules on the copy: {:?}", out.modules);
|
||||
let got = fingerprint(&new);
|
||||
let _ = coa_core::driver::run(&new, coa_core::driver::Verb::StopAll);
|
||||
assert_eq!(got, expected, "data of the copy after the preview core");
|
||||
assert_eq!(tree(&old), before, "the old server's files changed");
|
||||
println!("COPY (stopped) PASS");
|
||||
|
||||
// 3. copy while the old database runs: read from it, change nothing.
|
||||
let started = coa_core::driver::run(&old, coa_core::driver::Verb::StartMysql)?;
|
||||
assert!(started.ok, "{}", started.output);
|
||||
let data_before: BTreeMap<String, String> = tree(&old).into_iter().filter(|(k, _)| !k.starts_with("mysql/") && !k.starts_with(".state/") && !k.starts_with("Core/configs/")).collect();
|
||||
let rows_before = fingerprint(&old);
|
||||
let p = coa_core::modular_copy::preview(&old)?;
|
||||
println!("preview (running): accounts {:?} characters {:?} schemas {:?}", p.accounts, p.characters, p.schemas);
|
||||
assert_eq!(p.database, "running");
|
||||
assert_eq!(format!("{}|{}", p.accounts.unwrap(), p.characters.unwrap()), counts);
|
||||
assert!(p.schemas.iter().any(|s| s == "acore_characters"));
|
||||
let new2 = work.join("copy-running-fixture");
|
||||
install(&new2, reg)?;
|
||||
let report = coa_core::modular_copy::copy_data(&old, &new2, &|w| println!(" copy: {w}"));
|
||||
let rows_after = fingerprint(&old);
|
||||
let _ = coa_core::driver::run(&old, coa_core::driver::Verb::StopAll);
|
||||
let report = report?;
|
||||
assert_eq!(report.read_from, "running database");
|
||||
assert_eq!(rows_after, rows_before);
|
||||
let data_after: BTreeMap<String, String> = tree(&old).into_iter().filter(|(k, _)| !k.starts_with("mysql/") && !k.starts_with(".state/") && !k.starts_with("Core/configs/")).collect();
|
||||
assert_eq!(data_after, data_before, "files outside the database changed");
|
||||
assert_eq!(fingerprint(&new2), expected);
|
||||
assert_eq!(world_value(&new2).as_deref(), Some("3"));
|
||||
let _ = coa_core::driver::run(&new2, coa_core::driver::Verb::StopAll);
|
||||
println!("COPY (running) PASS");
|
||||
Ok(())
|
||||
}
|
||||
|
||||
fn main() -> R<()> {
|
||||
let a: Vec<String> = std::env::args().skip(1).collect();
|
||||
let work = PathBuf::from(a.first().expect("usage: preview_bare_and_copy_e2e <empty work folder> [fresh|copy|all]"));
|
||||
let mode = a.get(1).map(String::as_str).unwrap_or("all");
|
||||
assert!(!work.exists() || std::fs::read_dir(&work)?.next().is_none(), "work folder must be new or empty");
|
||||
std::fs::create_dir_all(&work)?;
|
||||
let reg = Registry::at(work.join("installs.json"));
|
||||
if mode == "fresh" || mode == "all" {
|
||||
fresh(&work, ®)?;
|
||||
}
|
||||
if mode == "copy" || mode == "all" {
|
||||
copy(&work, ®)?;
|
||||
}
|
||||
println!("ALL PASS ({mode})");
|
||||
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");
|
||||
}
|
||||
@@ -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-")));
|
||||
}
|
||||
}
|
||||
@@ -1032,8 +1032,13 @@ pub fn analyze_github_repository(url_str: &str, cache_base_dir: Option<&Path>) -
|
||||
let marker_file = commit_cache_dir.join(".coa_tree_digest");
|
||||
|
||||
let cache_hit = commit_cache_dir.exists() && marker_file.exists();
|
||||
let pinned = resolved_commit.len() == 40 && resolved_commit.bytes().all(|b| b.is_ascii_hexdigit());
|
||||
let target_dir = if cache_hit {
|
||||
commit_cache_dir
|
||||
} else if pinned {
|
||||
// GitHub's archive of the exact commit, without the game-client files some repositories carry (they
|
||||
// are not needed to build a server module and used to push such repositories over the size limit).
|
||||
crate::module_sources::fetch_pinned(&owner, &repo, &resolved_commit, &base_cache)?
|
||||
} else {
|
||||
// Clone into temporary staging directory
|
||||
let staging_id = format!("{}_{}_{}", owner, repo, std::time::SystemTime::now().duration_since(std::time::UNIX_EPOCH).unwrap().as_millis());
|
||||
|
||||
@@ -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));
|
||||
|
||||
@@ -0,0 +1,355 @@
|
||||
//! The compiler's work kept between builds of a module, small on disk.
|
||||
//!
|
||||
//! A build works in `<meta>/build-cache/<module>/` (sources, CMake/Ninja state, object files). Between builds
|
||||
//! that folder is packed into `<module>.tar.zst` (object files compress about 4x) with a small record of the
|
||||
//! core it was made for. Before the next build it is unpacked again, so Ninja recompiles only what changed.
|
||||
//!
|
||||
//! Object files made for another core are useless (every one depends on the core's headers), so a cache for
|
||||
//! another core is dropped instead of unpacked. The whole cache is kept under a size limit: the modules built
|
||||
//! longest ago go first. Incremental-link files (`.ilk`) and linker maps are not kept.
|
||||
|
||||
use std::fs;
|
||||
use std::io::{BufReader, BufWriter};
|
||||
use std::path::{Path, PathBuf};
|
||||
|
||||
use serde::{Deserialize, Serialize};
|
||||
|
||||
use crate::error::{Error, Result};
|
||||
|
||||
/// Packed caches above this total are removed, the least recently built first.
|
||||
pub const LIMIT_BYTES: u64 = 2 * 1024 * 1024 * 1024;
|
||||
|
||||
#[derive(Debug, Clone, Serialize, Deserialize)]
|
||||
struct Record {
|
||||
/// ABI fingerprint of the core the objects were compiled for.
|
||||
fingerprint: String,
|
||||
/// Unix seconds of the last build.
|
||||
last_used: i64,
|
||||
unpacked_bytes: u64,
|
||||
}
|
||||
|
||||
#[derive(Debug, Clone, Serialize)]
|
||||
pub struct CacheEntry {
|
||||
pub module: String,
|
||||
/// Bytes on disk now (packed, or unpacked while a build runs).
|
||||
pub bytes: u64,
|
||||
pub unpacked_bytes: u64,
|
||||
pub last_used: i64,
|
||||
/// Made for the core this server runs now (otherwise it is dropped at the next build).
|
||||
pub current_core: bool,
|
||||
pub packed: bool,
|
||||
}
|
||||
|
||||
#[derive(Debug, Clone, Serialize)]
|
||||
pub struct CacheSummary {
|
||||
pub modules: Vec<CacheEntry>,
|
||||
pub total_bytes: u64,
|
||||
/// Downloaded module sources (shared by all servers of this Manager).
|
||||
pub sources_bytes: u64,
|
||||
pub limit_bytes: u64,
|
||||
}
|
||||
|
||||
pub fn root(realm_root: &Path) -> PathBuf {
|
||||
crate::plugins::meta_dir(realm_root).join("build-cache")
|
||||
}
|
||||
|
||||
fn valid_id(id: &str) -> bool {
|
||||
!id.is_empty() && id.len() <= 100 && id.chars().all(|c| c.is_ascii_alphanumeric() || matches!(c, '-' | '_' | '.')) && id != "." && id != ".."
|
||||
}
|
||||
|
||||
fn paths(realm_root: &Path, id: &str) -> Result<(PathBuf, PathBuf, PathBuf)> {
|
||||
if !valid_id(id) {
|
||||
return Err(Error::Invalid(format!("Invalid module id for the build cache: {id}")));
|
||||
}
|
||||
let r = root(realm_root);
|
||||
Ok((r.join(id), r.join(format!("{id}.tar.zst")), r.join(format!("{id}.json"))))
|
||||
}
|
||||
|
||||
fn now() -> i64 {
|
||||
chrono::Utc::now().timestamp()
|
||||
}
|
||||
|
||||
pub(crate) fn dir_bytes(dir: &Path) -> u64 {
|
||||
fs::read_dir(dir)
|
||||
.map(|rd| {
|
||||
rd.flatten()
|
||||
.map(|e| match e.metadata() {
|
||||
Ok(m) if m.is_dir() => dir_bytes(&e.path()),
|
||||
Ok(m) => m.len(),
|
||||
Err(_) => 0,
|
||||
})
|
||||
.sum()
|
||||
})
|
||||
.unwrap_or(0)
|
||||
}
|
||||
|
||||
fn read_record(path: &Path) -> Option<Record> {
|
||||
serde_json::from_slice(&fs::read(path).ok()?).ok()
|
||||
}
|
||||
|
||||
/// The working folder for a build of `id` for the core `fingerprint`, with the earlier work of a build for the
|
||||
/// same core unpacked into it. A cache for another core is dropped.
|
||||
pub fn prepare(realm_root: &Path, id: &str, fingerprint: &str) -> Result<PathBuf> {
|
||||
let (dir, archive, record) = paths(realm_root, id)?;
|
||||
let rec = read_record(&record);
|
||||
let same_core = rec.as_ref().is_some_and(|r| r.fingerprint == fingerprint);
|
||||
if !same_core {
|
||||
// made for another core (or unknown): its objects would all be rebuilt anyway
|
||||
if dir.exists() {
|
||||
fs::remove_dir_all(&dir)?;
|
||||
}
|
||||
let _ = fs::remove_file(&archive);
|
||||
let _ = fs::remove_file(&record);
|
||||
} else if archive.is_file() {
|
||||
if dir.exists() {
|
||||
fs::remove_dir_all(&dir)?; // an older, interrupted working folder: the archive is the newer state
|
||||
}
|
||||
unpack(&archive, &dir).map_err(|e| {
|
||||
let _ = fs::remove_dir_all(&dir);
|
||||
Error::Invalid(format!("The build cache of {id} could not be unpacked: {e}"))
|
||||
})?;
|
||||
fs::remove_file(&archive)?;
|
||||
}
|
||||
fs::create_dir_all(&dir)?;
|
||||
let unpacked_bytes = dir_bytes(&dir);
|
||||
crate::fsx::atomic_write_json(&record, &Record { fingerprint: fingerprint.into(), last_used: now(), unpacked_bytes })?;
|
||||
Ok(dir)
|
||||
}
|
||||
|
||||
/// After a build (successful or not): drop what does not speed up the next one, pack the rest, keep the total
|
||||
/// under the limit. Never fails the build: problems only cost the cache.
|
||||
pub fn finish(realm_root: &Path, id: &str) {
|
||||
let Ok((dir, archive, record)) = paths(realm_root, id) else { return };
|
||||
if !dir.is_dir() {
|
||||
return;
|
||||
}
|
||||
remove_by_ext(&dir, &["ilk", "map"]);
|
||||
let unpacked_bytes = dir_bytes(&dir);
|
||||
let tmp = archive.with_extension("zst.partial");
|
||||
match pack(&dir, &tmp).and_then(|_| fs::rename(&tmp, &archive).map_err(Into::into)) {
|
||||
Ok(()) => {
|
||||
let _ = fs::remove_dir_all(&dir);
|
||||
if let Some(mut r) = read_record(&record) {
|
||||
r.last_used = now();
|
||||
r.unpacked_bytes = unpacked_bytes;
|
||||
let _ = crate::fsx::atomic_write_json(&record, &r);
|
||||
}
|
||||
}
|
||||
Err(e) => {
|
||||
tracing::warn!(module = id, error = %e, "build cache not packed; it is kept unpacked");
|
||||
let _ = fs::remove_file(&tmp);
|
||||
}
|
||||
}
|
||||
enforce_limit(realm_root, LIMIT_BYTES, Some(id));
|
||||
}
|
||||
|
||||
fn remove_by_ext(dir: &Path, exts: &[&str]) {
|
||||
for e in fs::read_dir(dir).into_iter().flatten().flatten() {
|
||||
let p = e.path();
|
||||
if p.is_dir() {
|
||||
remove_by_ext(&p, exts);
|
||||
} else if p.extension().and_then(|x| x.to_str()).is_some_and(|x| exts.iter().any(|w| w.eq_ignore_ascii_case(x))) {
|
||||
let _ = fs::remove_file(p);
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
fn pack(dir: &Path, out: &Path) -> Result<()> {
|
||||
let file = BufWriter::new(fs::File::create(out)?);
|
||||
let mut enc = zstd::Encoder::new(file, 3)?;
|
||||
let _ = enc.multithread(std::thread::available_parallelism().map(|n| n.get() as u32).unwrap_or(1).min(8));
|
||||
{
|
||||
let mut tar = tar::Builder::new(&mut enc);
|
||||
tar.follow_symlinks(false);
|
||||
// modification times are kept: Ninja decides from them what is up to date
|
||||
tar.mode(tar::HeaderMode::Complete);
|
||||
tar.append_dir_all(".", dir)?;
|
||||
tar.finish()?;
|
||||
}
|
||||
enc.finish()?;
|
||||
Ok(())
|
||||
}
|
||||
|
||||
fn unpack(archive: &Path, dir: &Path) -> Result<()> {
|
||||
fs::create_dir_all(dir)?;
|
||||
let dec = zstd::Decoder::new(BufReader::new(fs::File::open(archive)?))?;
|
||||
let mut tar = tar::Archive::new(dec);
|
||||
tar.set_preserve_mtime(true);
|
||||
for entry in tar.entries()? {
|
||||
let mut entry = entry?;
|
||||
// unpack_in refuses paths that would leave `dir`
|
||||
if !entry.unpack_in(dir)? {
|
||||
return Err(Error::PathRejected(format!("build cache entry {}", entry.path()?.display())));
|
||||
}
|
||||
}
|
||||
Ok(())
|
||||
}
|
||||
|
||||
/// Everything in the build cache of this server, largest first.
|
||||
pub fn summary(realm_root: &Path, sources_dir: Option<&Path>) -> CacheSummary {
|
||||
let current = crate::provenance::realm_host_fingerprint(realm_root);
|
||||
let r = root(realm_root);
|
||||
let mut modules = Vec::new();
|
||||
for e in fs::read_dir(&r).into_iter().flatten().flatten() {
|
||||
let name = e.file_name().to_string_lossy().into_owned();
|
||||
let Some(id) = name.strip_suffix(".json") else { continue };
|
||||
let Ok((dir, archive, record)) = paths(realm_root, id) else { continue };
|
||||
let Some(rec) = read_record(&record) else { continue };
|
||||
let packed = archive.is_file();
|
||||
let bytes = if packed { fs::metadata(&archive).map(|m| m.len()).unwrap_or(0) } else { dir_bytes(&dir) };
|
||||
modules.push(CacheEntry {
|
||||
module: id.to_string(),
|
||||
bytes,
|
||||
unpacked_bytes: rec.unpacked_bytes,
|
||||
last_used: rec.last_used,
|
||||
current_core: current.as_deref() == Some(rec.fingerprint.as_str()),
|
||||
packed,
|
||||
});
|
||||
}
|
||||
// working folders of an older Manager, without a record
|
||||
for e in fs::read_dir(&r).into_iter().flatten().flatten() {
|
||||
let name = e.file_name().to_string_lossy().into_owned();
|
||||
if e.path().is_dir() && valid_id(&name) && !modules.iter().any(|m| m.module == name) {
|
||||
let bytes = dir_bytes(&e.path());
|
||||
modules.push(CacheEntry { module: name, bytes, unpacked_bytes: bytes, last_used: 0, current_core: false, packed: false });
|
||||
}
|
||||
}
|
||||
modules.sort_by(|a, b| b.bytes.cmp(&a.bytes));
|
||||
CacheSummary {
|
||||
total_bytes: modules.iter().map(|m| m.bytes).sum(),
|
||||
sources_bytes: sources_dir.map(dir_bytes).unwrap_or(0),
|
||||
limit_bytes: LIMIT_BYTES,
|
||||
modules,
|
||||
}
|
||||
}
|
||||
|
||||
/// Remove the cache of one module, or of all. The next build of a module compiles it in full.
|
||||
pub fn clear(realm_root: &Path, module: Option<&str>) -> Result<u64> {
|
||||
let before = summary(realm_root, None).total_bytes;
|
||||
match module {
|
||||
Some(id) => {
|
||||
let (dir, archive, record) = paths(realm_root, id)?;
|
||||
if dir.exists() {
|
||||
fs::remove_dir_all(dir)?;
|
||||
}
|
||||
let _ = fs::remove_file(archive);
|
||||
let _ = fs::remove_file(record);
|
||||
}
|
||||
None => {
|
||||
let r = root(realm_root);
|
||||
if r.exists() {
|
||||
fs::remove_dir_all(&r)?;
|
||||
}
|
||||
}
|
||||
}
|
||||
Ok(before.saturating_sub(summary(realm_root, None).total_bytes))
|
||||
}
|
||||
|
||||
/// Keep the packed caches under `limit`, dropping the least recently built (never `keep`).
|
||||
fn enforce_limit(realm_root: &Path, limit: u64, keep: Option<&str>) {
|
||||
let mut s = summary(realm_root, None);
|
||||
s.modules.sort_by_key(|m| m.last_used);
|
||||
let mut total = s.total_bytes;
|
||||
for m in &s.modules {
|
||||
if total <= limit {
|
||||
break;
|
||||
}
|
||||
if Some(m.module.as_str()) == keep {
|
||||
continue;
|
||||
}
|
||||
if clear(realm_root, Some(&m.module)).is_ok() {
|
||||
tracing::info!(module = %m.module, bytes = m.bytes, "build cache over its limit: oldest removed");
|
||||
total = total.saturating_sub(m.bytes);
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
/// Downloaded module sources the Manager keeps (`<cache>/github`, `<cache>/staging`).
|
||||
pub fn clear_sources(sources_dir: &Path) -> Result<u64> {
|
||||
let before = dir_bytes(sources_dir);
|
||||
for sub in ["github", "staging"] {
|
||||
let p = sources_dir.join(sub);
|
||||
if p.exists() {
|
||||
fs::remove_dir_all(p)?;
|
||||
}
|
||||
}
|
||||
Ok(before.saturating_sub(dir_bytes(sources_dir)))
|
||||
}
|
||||
|
||||
#[cfg(test)]
|
||||
mod tests {
|
||||
use super::*;
|
||||
use std::time::{Duration, SystemTime};
|
||||
|
||||
fn server() -> tempfile::TempDir {
|
||||
let d = tempfile::tempdir().unwrap();
|
||||
fs::create_dir_all(d.path().join(".manager")).unwrap();
|
||||
d
|
||||
}
|
||||
|
||||
#[test]
|
||||
fn a_cache_is_packed_between_builds_and_comes_back_with_its_times() {
|
||||
let s = server();
|
||||
let dir = prepare(s.path(), "companions", "fp1").unwrap();
|
||||
fs::create_dir_all(dir.join("build/obj")).unwrap();
|
||||
fs::write(dir.join("build/obj/a.obj"), vec![7u8; 100_000]).unwrap();
|
||||
fs::write(dir.join("build/x.ilk"), b"incremental link").unwrap();
|
||||
let old = SystemTime::now() - Duration::from_secs(3600);
|
||||
fs::File::options().write(true).open(dir.join("build/obj/a.obj")).unwrap().set_modified(old).unwrap();
|
||||
finish(s.path(), "companions");
|
||||
assert!(!dir.exists(), "packed between builds");
|
||||
let sum = summary(s.path(), None);
|
||||
assert_eq!(sum.modules.len(), 1);
|
||||
assert!(sum.modules[0].packed && sum.modules[0].bytes < 100_000 / 4, "compressed: {}", sum.modules[0].bytes);
|
||||
|
||||
let dir = prepare(s.path(), "companions", "fp1").unwrap();
|
||||
assert_eq!(fs::read(dir.join("build/obj/a.obj")).unwrap().len(), 100_000);
|
||||
assert!(!dir.join("build/x.ilk").exists(), "incremental-link files are not kept");
|
||||
let mtime = fs::metadata(dir.join("build/obj/a.obj")).unwrap().modified().unwrap();
|
||||
let drift = mtime.duration_since(old).unwrap_or_else(|e| e.duration());
|
||||
assert!(drift < Duration::from_secs(2), "modification time kept (drift {drift:?})");
|
||||
}
|
||||
|
||||
#[test]
|
||||
fn a_cache_for_another_core_is_dropped() {
|
||||
let s = server();
|
||||
let dir = prepare(s.path(), "scaling", "old-core").unwrap();
|
||||
fs::write(dir.join("a.obj"), b"old").unwrap();
|
||||
finish(s.path(), "scaling");
|
||||
let dir = prepare(s.path(), "scaling", "new-core").unwrap();
|
||||
assert!(!dir.join("a.obj").exists());
|
||||
}
|
||||
|
||||
#[test]
|
||||
fn clear_removes_one_module_or_all_and_bad_ids_are_refused() {
|
||||
let s = server();
|
||||
for id in ["a", "b"] {
|
||||
let d = prepare(s.path(), id, "fp").unwrap();
|
||||
fs::write(d.join("x.obj"), b"x").unwrap();
|
||||
finish(s.path(), id);
|
||||
}
|
||||
clear(s.path(), Some("a")).unwrap();
|
||||
assert_eq!(summary(s.path(), None).modules.iter().map(|m| m.module.as_str()).collect::<Vec<_>>(), ["b"]);
|
||||
clear(s.path(), None).unwrap();
|
||||
assert!(summary(s.path(), None).modules.is_empty());
|
||||
assert!(clear(s.path(), Some("../x")).is_err());
|
||||
}
|
||||
|
||||
#[test]
|
||||
fn the_least_recently_built_go_first_over_the_limit() {
|
||||
let s = server();
|
||||
for (n, id) in ["old", "new"].iter().enumerate() {
|
||||
let d = prepare(s.path(), id, "fp").unwrap();
|
||||
fs::write(d.join("x.obj"), vec![n as u8; 50_000]).unwrap();
|
||||
finish(s.path(), id);
|
||||
let rec = root(s.path()).join(format!("{id}.json"));
|
||||
let mut r = read_record(&rec).unwrap();
|
||||
r.last_used = 1000 + n as i64;
|
||||
crate::fsx::atomic_write_json(&rec, &r).unwrap();
|
||||
}
|
||||
let total = summary(s.path(), None).total_bytes;
|
||||
enforce_limit(s.path(), total - 1, None);
|
||||
let left: Vec<String> = summary(s.path(), None).modules.into_iter().map(|m| m.module).collect();
|
||||
assert_eq!(left, ["new"]);
|
||||
}
|
||||
}
|
||||
@@ -977,8 +977,25 @@ pub fn build_module_with_bundle(
|
||||
.unwrap_or_else(|| with_plugin_id(&adapter_source, &plugin_id));
|
||||
|
||||
// 2. Prepare the persistent staging directory
|
||||
let default_staging = realm_root.join(".manager").join("build-cache").join(&module_id);
|
||||
let staging_dir = custom_staging_dir.map(PathBuf::from).unwrap_or(default_staging);
|
||||
// The Manager's own builds use the module's build cache (unpacked for the build, packed again afterwards);
|
||||
// a caller-chosen folder is used as it is.
|
||||
let staging_dir = match custom_staging_dir {
|
||||
Some(p) => PathBuf::from(p),
|
||||
None => crate::build_cache::prepare(realm_root, &module_id, &sdk_abi_fingerprint(Path::new(&sdk_dir))?)?,
|
||||
};
|
||||
struct PackAfter<'a>(Option<(&'a Path, String)>);
|
||||
impl Drop for PackAfter<'_> {
|
||||
fn drop(&mut self) {
|
||||
if let Some((root, id)) = self.0.take() {
|
||||
crate::build_cache::finish(root, &id);
|
||||
}
|
||||
}
|
||||
}
|
||||
let _pack_after = PackAfter(custom_staging_dir.is_none().then(|| (realm_root, module_id.clone())));
|
||||
let log_path = match custom_staging_dir {
|
||||
Some(_) => staging_dir.join("build.log"),
|
||||
None => crate::build_cache::root(realm_root).join(format!("{module_id}.log")),
|
||||
};
|
||||
fs::create_dir_all(&staging_dir)?;
|
||||
let staging_src = staging_dir.join("src");
|
||||
fs::create_dir_all(&staging_src)?;
|
||||
@@ -1142,11 +1159,11 @@ if errorlevel 1 exit /b 103
|
||||
}
|
||||
|
||||
// The full log stays next to the build, so a failure can always be read afterwards.
|
||||
let _ = fs::write(staging_dir.join("build.log"), all_logs.join("
|
||||
let _ = fs::write(&log_path, all_logs.join("
|
||||
"));
|
||||
let mut errors = parse_msvc_errors(&all_logs);
|
||||
if exit_code != 0 && errors.is_empty() {
|
||||
errors.push(unparsed_failure(exit_code, &all_logs, &staging_dir.join("build.log")));
|
||||
errors.push(unparsed_failure(exit_code, &all_logs, &log_path));
|
||||
}
|
||||
|
||||
let expected_dll_path = build_output_dir.join(format!("{}.dll", safe_target_name));
|
||||
|
||||
@@ -170,6 +170,178 @@ pub struct PublicCatalogueItem {
|
||||
pub coa_status_source: String, // "Overlay", "VerifiedCatalog", "AutoPublic"
|
||||
pub conflict_reason: Option<String>,
|
||||
pub is_coa_recommended: bool,
|
||||
/// Functional category code (see `coa-module-categories.json`); "other" when nothing fits.
|
||||
#[serde(default)]
|
||||
pub category: String,
|
||||
}
|
||||
|
||||
#[derive(Debug, Clone, Serialize, Deserialize)]
|
||||
pub struct CategoryInfo {
|
||||
pub code: String,
|
||||
pub ru: String,
|
||||
pub en: String,
|
||||
#[serde(default)]
|
||||
pub keywords: Vec<String>,
|
||||
}
|
||||
|
||||
#[derive(Debug, Clone, Deserialize)]
|
||||
struct CategoryDocument {
|
||||
categories: Vec<CategoryInfo>,
|
||||
/// Owner-reviewed assignments (lowercase `owner/repo` -> category code).
|
||||
repos: BTreeMap<String, String>,
|
||||
}
|
||||
|
||||
static EMBEDDED_CATEGORIES_JSON: &str = include_str!("coa-module-categories.json");
|
||||
|
||||
fn category_document() -> &'static CategoryDocument {
|
||||
static DOC: std::sync::OnceLock<CategoryDocument> = std::sync::OnceLock::new();
|
||||
DOC.get_or_init(|| {
|
||||
serde_json::from_str(EMBEDDED_CATEGORIES_JSON).unwrap_or(CategoryDocument { categories: Vec::new(), repos: BTreeMap::new() })
|
||||
})
|
||||
}
|
||||
|
||||
pub fn categories() -> Vec<CategoryInfo> {
|
||||
category_document().categories.clone()
|
||||
}
|
||||
|
||||
/// Lowercase words of a text: letters and digits, so `mod-pvp-titles` gives `mod`, `pvp`, `titles`.
|
||||
fn words(text: &str) -> Vec<String> {
|
||||
text.to_lowercase()
|
||||
.split(|c: char| !c.is_alphanumeric() && c != '+')
|
||||
.filter(|w| !w.is_empty())
|
||||
.map(str::to_string)
|
||||
.collect()
|
||||
}
|
||||
|
||||
fn keyword_hits(keyword: &str, text_words: &[String]) -> usize {
|
||||
let kw = words(keyword);
|
||||
match kw.as_slice() {
|
||||
[] => 0,
|
||||
// one word: whole-word match; words of 4+ letters also match their plural or longer forms
|
||||
[k] => text_words.iter().filter(|w| *w == k || (k.chars().count() >= 4 && w.starts_with(k.as_str()))).count(),
|
||||
// a phrase: its words in a row
|
||||
many => text_words.windows(many.len()).filter(|win| win.iter().zip(many).all(|(a, b)| a == b)).count(),
|
||||
}
|
||||
}
|
||||
|
||||
/// The category of a module: the owner-reviewed list first, then the keywords of each category against the
|
||||
/// repository's name (counted twice), description and topics; "other" when no keyword matches.
|
||||
pub fn categorize(slug: &str, name: &str, description: &str, topics: &[String]) -> String {
|
||||
let doc = category_document();
|
||||
if let Some(code) = doc.repos.get(&normalize_repo_slug(slug)) {
|
||||
return code.clone();
|
||||
}
|
||||
let name_words = words(name);
|
||||
let mut body = words(description);
|
||||
for t in topics.iter().filter(|t| !t.starts_with("azerothcore") && !matches!(t.as_str(), "wow" | "wotlk" | "world-of-warcraft")) {
|
||||
body.extend(words(t));
|
||||
}
|
||||
let mut best: Option<(&str, usize)> = None;
|
||||
for c in &doc.categories {
|
||||
let score: usize = c.keywords.iter().map(|k| 2 * keyword_hits(k, &name_words) + keyword_hits(k, &body)).sum();
|
||||
if score > 0 && best.is_none_or(|(_, s)| score > s) {
|
||||
best = Some((&c.code, score));
|
||||
}
|
||||
}
|
||||
best.map(|(c, _)| c.to_string()).unwrap_or_else(|| "other".into())
|
||||
}
|
||||
|
||||
/// Statuses and categories come from the current overlay and category list on every read, never from what a
|
||||
/// cache stored: a corrected overlay must show at once. Entries an earlier version made up for overlay rules the
|
||||
/// public catalogue does not contain (marked with the `coa-verified` topic) are dropped.
|
||||
fn finalize(items: Vec<PublicCatalogueItem>, overlay: &CoaOverlayDocument) -> Vec<PublicCatalogueItem> {
|
||||
let rules: BTreeMap<String, &CoaOverlayRule> =
|
||||
overlay.rules.iter().map(|r| (normalize_repo_slug(&r.repo_slug), r)).collect();
|
||||
items
|
||||
.into_iter()
|
||||
.filter(|i| !i.topics.iter().any(|t| t == "coa-verified"))
|
||||
.map(|mut i| {
|
||||
let slug = normalize_repo_slug(&i.full_name);
|
||||
match rules.get(&slug) {
|
||||
Some(rule) => {
|
||||
i.coa_status = rule.status;
|
||||
i.coa_status_source = "Overlay".into();
|
||||
i.conflict_reason = rule.reason.clone();
|
||||
i.is_coa_recommended = rule.is_recommended || rule.status == CoaCompatibilityStatus::Recommended;
|
||||
}
|
||||
None => {
|
||||
i.coa_status = CoaCompatibilityStatus::Unverified;
|
||||
i.coa_status_source = "AutoPublic".into();
|
||||
i.conflict_reason = None;
|
||||
i.is_coa_recommended = false;
|
||||
}
|
||||
}
|
||||
i.category = categorize(&slug, &i.name, &i.description, &i.topics);
|
||||
i
|
||||
})
|
||||
.collect()
|
||||
}
|
||||
|
||||
fn respond(items: Vec<PublicCatalogueItem>, overlay: &CoaOverlayDocument, cached_at: String, is_offline: bool, etag: Option<String>) -> PublicCatalogueResponse {
|
||||
let items = finalize(items, overlay);
|
||||
PublicCatalogueResponse {
|
||||
total_count: items.len(),
|
||||
recommended_count: items.iter().filter(|i| i.is_coa_recommended).count(),
|
||||
cached_at,
|
||||
is_offline,
|
||||
etag,
|
||||
items,
|
||||
categories: categories().into_iter().map(|c| CategoryInfo { keywords: Vec::new(), ..c }).collect(),
|
||||
}
|
||||
}
|
||||
|
||||
/// Last push (`pushed_at`) of GitHub repositories given as `owner/name`, for modules the public catalogue does
|
||||
/// not list. Kept in `cache_file` for 12 hours; a repository GitHub does not answer for is `None` and asked
|
||||
/// again next time.
|
||||
pub fn repo_last_push(cache_file: &Path, repos: &[String]) -> Result<BTreeMap<String, Option<String>>> {
|
||||
#[derive(Serialize, Deserialize, Default)]
|
||||
struct Cache {
|
||||
at: i64,
|
||||
pushed: BTreeMap<String, String>,
|
||||
}
|
||||
let now = Utc::now().timestamp();
|
||||
let mut cache: Cache = fs::read(cache_file).ok().and_then(|b| serde_json::from_slice(&b).ok()).unwrap_or_default();
|
||||
if now - cache.at > 12 * 3600 {
|
||||
cache = Cache { at: now, pushed: BTreeMap::new() };
|
||||
}
|
||||
let name_ok = |s: Option<&str>| {
|
||||
s.is_some_and(|s| !s.is_empty() && s.len() <= 100 && s.chars().all(|c| c.is_ascii_alphanumeric() || matches!(c, '-' | '_' | '.')))
|
||||
};
|
||||
let valid = |r: &str| {
|
||||
let mut parts = r.split('/');
|
||||
name_ok(parts.next()) && name_ok(parts.next()) && parts.next().is_none()
|
||||
};
|
||||
let client = reqwest::blocking::Client::builder()
|
||||
.connect_timeout(Duration::from_secs(CONNECT_TIMEOUT_SECS))
|
||||
.timeout(Duration::from_secs(10))
|
||||
.build()
|
||||
.map_err(|e| Error::Invalid(e.to_string()))?;
|
||||
let mut out = BTreeMap::new();
|
||||
for repo in repos.iter().map(|r| r.trim().to_ascii_lowercase()).filter(|r| valid(r)) {
|
||||
if let Some(v) = cache.pushed.get(&repo) {
|
||||
out.insert(repo, Some(v.clone()));
|
||||
continue;
|
||||
}
|
||||
let pushed = client
|
||||
.get(format!("https://api.github.com/repos/{repo}"))
|
||||
.header(reqwest::header::USER_AGENT, "CSM-Modules-Preview")
|
||||
.header(reqwest::header::ACCEPT, "application/vnd.github+json")
|
||||
.send()
|
||||
.ok()
|
||||
.filter(|r| r.status().is_success())
|
||||
.and_then(|r| r.text().ok())
|
||||
.and_then(|t| serde_json::from_str::<serde_json::Value>(&t).ok())
|
||||
.and_then(|v| v.get("pushed_at")?.as_str().map(str::to_string));
|
||||
if let Some(p) = &pushed {
|
||||
cache.pushed.insert(repo.clone(), p.clone());
|
||||
}
|
||||
out.insert(repo, pushed);
|
||||
}
|
||||
if let Some(dir) = cache_file.parent() {
|
||||
let _ = fs::create_dir_all(dir);
|
||||
}
|
||||
let _ = fsx::atomic_write_json(cache_file, &cache);
|
||||
Ok(out)
|
||||
}
|
||||
|
||||
#[derive(Debug, Clone, Serialize, Deserialize)]
|
||||
@@ -191,6 +363,8 @@ pub struct PublicCatalogueResponse {
|
||||
pub etag: Option<String>,
|
||||
pub total_count: usize,
|
||||
pub recommended_count: usize,
|
||||
#[serde(default)]
|
||||
pub categories: Vec<CategoryInfo>,
|
||||
}
|
||||
|
||||
// ---------------------------------------------------------------------------
|
||||
@@ -368,44 +542,14 @@ pub fn normalize_catalogue(
|
||||
coa_status_source: coa_source,
|
||||
conflict_reason: reason,
|
||||
is_coa_recommended: is_rec,
|
||||
category: String::new(),
|
||||
});
|
||||
}
|
||||
|
||||
// 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())
|
||||
};
|
||||
// Overlay rules for repositories the public catalogue does not list are not turned into entries: the
|
||||
// catalogue shows only what azerothcore.org lists (CoA's own modules are in the Manager's curated list).
|
||||
|
||||
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:
|
||||
// 4. 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
|
||||
@@ -461,15 +605,7 @@ pub fn fetch_or_load_catalogue(
|
||||
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,
|
||||
});
|
||||
return Ok(respond(cached.items, &overlay, cached.cached_at, false, cached.etag));
|
||||
}
|
||||
}
|
||||
}
|
||||
@@ -507,15 +643,7 @@ pub fn fetch_or_load_catalogue(
|
||||
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,
|
||||
});
|
||||
return Ok(respond(cached.items, &overlay, cached.cached_at, false, cached.etag));
|
||||
}
|
||||
}
|
||||
}
|
||||
@@ -540,7 +668,6 @@ pub fn fetch_or_load_catalogue(
|
||||
})?;
|
||||
|
||||
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 {
|
||||
@@ -557,14 +684,7 @@ pub fn fetch_or_load_catalogue(
|
||||
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,
|
||||
});
|
||||
return Ok(respond(items, &overlay, now_str, false, new_etag));
|
||||
}
|
||||
|
||||
// If non-200 and non-304 HTTP status, fallback to existing cache if available
|
||||
@@ -585,15 +705,7 @@ fn try_offline_fallback(
|
||||
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,
|
||||
});
|
||||
return Ok(respond(cached.items, overlay, cached.cached_at, true, cached.etag.or(stored_etag)));
|
||||
}
|
||||
}
|
||||
}
|
||||
@@ -604,16 +716,7 @@ fn try_offline_fallback(
|
||||
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,
|
||||
})
|
||||
Ok(respond(items, overlay, Utc::now().to_rfc3339(), true, None))
|
||||
}
|
||||
|
||||
// ---------------------------------------------------------------------------
|
||||
@@ -808,6 +911,7 @@ mod tests {
|
||||
coa_status_source: "CacheTest".into(),
|
||||
conflict_reason: None,
|
||||
is_coa_recommended: false,
|
||||
category: String::new(),
|
||||
}
|
||||
];
|
||||
|
||||
@@ -833,6 +937,56 @@ mod tests {
|
||||
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");
|
||||
// nothing is made up from overlay rules when there is no catalogue to show
|
||||
assert!(fallback_resp.items.is_empty());
|
||||
}
|
||||
|
||||
fn item(full_name: &str, name: &str, description: &str, topics: &[&str]) -> PublicCatalogueItem {
|
||||
PublicCatalogueItem {
|
||||
id: 1,
|
||||
name: name.into(),
|
||||
full_name: full_name.into(),
|
||||
owner: full_name.split('/').next().unwrap().into(),
|
||||
html_url: format!("https://github.com/{full_name}"),
|
||||
description: description.into(),
|
||||
stars: 0,
|
||||
forks: 0,
|
||||
default_branch: "master".into(),
|
||||
pushed_at: None,
|
||||
updated_at: None,
|
||||
license: None,
|
||||
topics: topics.iter().map(|t| t.to_string()).collect(),
|
||||
coa_status: CoaCompatibilityStatus::Verified,
|
||||
coa_status_source: "Overlay".into(),
|
||||
conflict_reason: Some("stale".into()),
|
||||
is_coa_recommended: true,
|
||||
category: String::new(),
|
||||
}
|
||||
}
|
||||
|
||||
#[test]
|
||||
fn statuses_come_from_the_current_overlay_not_the_cache_and_made_up_entries_are_dropped() {
|
||||
let overlay = load_coa_overlay(None);
|
||||
let cached = vec![
|
||||
item("azerothcore/mod-duel-reset", "mod-duel-reset", "Duel reset module", &["azerothcore-module"]),
|
||||
item("azerothcore/mod-cfbg", "mod-cfbg", "Cross-faction battlegrounds", &["azerothcore-module", "coa-verified"]),
|
||||
];
|
||||
let out = finalize(cached, &overlay);
|
||||
assert_eq!(out.len(), 1, "the made-up mod-cfbg entry is dropped");
|
||||
assert_eq!(out[0].coa_status, CoaCompatibilityStatus::Unverified);
|
||||
assert!(out[0].conflict_reason.is_none() && !out[0].is_coa_recommended);
|
||||
assert_eq!(out[0].category, "pvp");
|
||||
}
|
||||
|
||||
#[test]
|
||||
fn modules_get_a_category_from_the_reviewed_list_or_keywords() {
|
||||
// reviewed list (the owner's file)
|
||||
assert_eq!(categorize("DustinHendrickson/mod-ollama-chat", "mod-ollama-chat", "", &[]), "bots");
|
||||
// keywords: whole words, not parts of other words
|
||||
assert_eq!(categorize("x/mod-arena-points", "mod-arena-points", "Gives arena points", &[]), "pvp");
|
||||
assert_eq!(categorize("x/mod-guild-chat", "mod-guild-chat", "", &[]), "social");
|
||||
assert_eq!(categorize("x/mod-maintain", "mod-maintain", "Maintains things", &[]), "other");
|
||||
assert_eq!(categorize("x/mod-nothing", "mod-nothing", "", &["azerothcore-module".to_string(), "wotlk".to_string()]), "other");
|
||||
assert!(categories().iter().any(|c| c.code == "other"));
|
||||
}
|
||||
}
|
||||
@@ -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"
|
||||
|
||||
@@ -0,0 +1,473 @@
|
||||
{
|
||||
"version": 1,
|
||||
"source": "azerothcore_catalogue_categorized_2026-11-07.xlsx (owner), modules with high or medium confidence",
|
||||
"categories": [
|
||||
{
|
||||
"code": "bots",
|
||||
"ru": "Боты и искусственный интеллект",
|
||||
"en": "Bots and AI",
|
||||
"keywords": [
|
||||
"playerbots",
|
||||
"bots",
|
||||
"npcbot",
|
||||
"llm",
|
||||
"ollama",
|
||||
"ai",
|
||||
"автономные спутники"
|
||||
]
|
||||
},
|
||||
{
|
||||
"code": "pve",
|
||||
"ru": "PvE, подземелья и рейды",
|
||||
"en": "PvE, dungeons and raids",
|
||||
"keywords": [
|
||||
"pve",
|
||||
"dungeon",
|
||||
"raid",
|
||||
"boss",
|
||||
"mythic+",
|
||||
"scaling",
|
||||
"rdf",
|
||||
"инстансы"
|
||||
]
|
||||
},
|
||||
{
|
||||
"code": "pvp",
|
||||
"ru": "PvP, арены и поля боя",
|
||||
"en": "PvP, arenas and battlegrounds",
|
||||
"keywords": [
|
||||
"pvp",
|
||||
"arena",
|
||||
"battleground",
|
||||
"bg",
|
||||
"duel",
|
||||
"ffa",
|
||||
"фракции"
|
||||
]
|
||||
},
|
||||
{
|
||||
"code": "hardcore",
|
||||
"ru": "Hardcore и режимы сложности",
|
||||
"en": "Hardcore and difficulty",
|
||||
"keywords": [
|
||||
"hardcore",
|
||||
"ironman",
|
||||
"permadeath",
|
||||
"high risk",
|
||||
"difficulty"
|
||||
]
|
||||
},
|
||||
{
|
||||
"code": "progression",
|
||||
"ru": "Прокачка и прогрессия",
|
||||
"en": "Leveling and progression",
|
||||
"keywords": [
|
||||
"xp",
|
||||
"level",
|
||||
"rates",
|
||||
"leveling",
|
||||
"rewards",
|
||||
"prestige",
|
||||
"progression",
|
||||
"experience",
|
||||
"reputation",
|
||||
"rested"
|
||||
]
|
||||
},
|
||||
{
|
||||
"code": "classes",
|
||||
"ru": "Классы, расы и способности",
|
||||
"en": "Classes, races and abilities",
|
||||
"keywords": [
|
||||
"race",
|
||||
"class",
|
||||
"talent",
|
||||
"spells",
|
||||
"specialization",
|
||||
"pets"
|
||||
]
|
||||
},
|
||||
{
|
||||
"code": "cosmetics",
|
||||
"ru": "Косметика и трансмог",
|
||||
"en": "Cosmetics and transmog",
|
||||
"keywords": [
|
||||
"transmog",
|
||||
"appearance",
|
||||
"morph",
|
||||
"visual",
|
||||
"vanity",
|
||||
"cosmetics"
|
||||
]
|
||||
},
|
||||
{
|
||||
"code": "items",
|
||||
"ru": "Лут, предметы и экипировка",
|
||||
"en": "Loot, items and gear",
|
||||
"keywords": [
|
||||
"loot",
|
||||
"item",
|
||||
"gear",
|
||||
"enchant",
|
||||
"reforging",
|
||||
"bank",
|
||||
"inventory",
|
||||
"items",
|
||||
"reagent"
|
||||
]
|
||||
},
|
||||
{
|
||||
"code": "economy",
|
||||
"ru": "Торговля, экономика и профессии",
|
||||
"en": "Trade, economy and professions",
|
||||
"keywords": [
|
||||
"auction",
|
||||
"market",
|
||||
"vendor",
|
||||
"trade",
|
||||
"gold",
|
||||
"shop",
|
||||
"profession",
|
||||
"ahbot",
|
||||
"auction house",
|
||||
"gather",
|
||||
"herbs",
|
||||
"mining",
|
||||
"fishing",
|
||||
"crafting"
|
||||
]
|
||||
},
|
||||
{
|
||||
"code": "account",
|
||||
"ru": "Аккаунты и персонажи",
|
||||
"en": "Accounts and characters",
|
||||
"keywords": [
|
||||
"account",
|
||||
"character",
|
||||
"mounts",
|
||||
"collection",
|
||||
"migration",
|
||||
"recruit",
|
||||
"login",
|
||||
"alts"
|
||||
]
|
||||
},
|
||||
{
|
||||
"code": "social",
|
||||
"ru": "Гильдии, чат и социальные",
|
||||
"en": "Guilds, chat and social",
|
||||
"keywords": [
|
||||
"guild",
|
||||
"chat",
|
||||
"messages",
|
||||
"announcements",
|
||||
"friends",
|
||||
"mail"
|
||||
]
|
||||
},
|
||||
{
|
||||
"code": "npc",
|
||||
"ru": "NPC и игровые сервисы",
|
||||
"en": "NPCs and services",
|
||||
"keywords": [
|
||||
"npc",
|
||||
"buffer",
|
||||
"trainer",
|
||||
"enchanter",
|
||||
"services",
|
||||
"assistant",
|
||||
"vendor npc",
|
||||
"gossip"
|
||||
]
|
||||
},
|
||||
{
|
||||
"code": "world",
|
||||
"ru": "Мир, зоны и перемещение",
|
||||
"en": "World, zones and travel",
|
||||
"keywords": [
|
||||
"world",
|
||||
"zone",
|
||||
"spawn",
|
||||
"teleport",
|
||||
"portal",
|
||||
"travel",
|
||||
"respawn"
|
||||
]
|
||||
},
|
||||
{
|
||||
"code": "events",
|
||||
"ru": "События и мини-игры",
|
||||
"en": "Events and mini-games",
|
||||
"keywords": [
|
||||
"events",
|
||||
"holidays",
|
||||
"quests",
|
||||
"trivia",
|
||||
"minigames",
|
||||
"treasure"
|
||||
]
|
||||
},
|
||||
{
|
||||
"code": "server",
|
||||
"ru": "Сервер, хостинг и автоматизация",
|
||||
"en": "Server and automation",
|
||||
"keywords": [
|
||||
"server",
|
||||
"deployment",
|
||||
"backup",
|
||||
"cache",
|
||||
"relay",
|
||||
"restart",
|
||||
"monitoring"
|
||||
]
|
||||
},
|
||||
{
|
||||
"code": "admin",
|
||||
"ru": "Администрирование и безопасность",
|
||||
"en": "Administration and security",
|
||||
"keywords": [
|
||||
"gm",
|
||||
"admin",
|
||||
"moderation",
|
||||
"logs",
|
||||
"security",
|
||||
"bans",
|
||||
"abuse"
|
||||
]
|
||||
},
|
||||
{
|
||||
"code": "web",
|
||||
"ru": "Сайты, API и интеграции",
|
||||
"en": "Websites, API and integrations",
|
||||
"keywords": [
|
||||
"api",
|
||||
"cms",
|
||||
"website",
|
||||
"discord",
|
||||
"telegram",
|
||||
"web",
|
||||
"metrics"
|
||||
]
|
||||
},
|
||||
{
|
||||
"code": "dev",
|
||||
"ru": "Разработка, SQL и инструменты",
|
||||
"en": "Development, SQL and tools",
|
||||
"keywords": [
|
||||
"editor",
|
||||
"db",
|
||||
"sql",
|
||||
"lua",
|
||||
"eluna",
|
||||
"ide",
|
||||
"tooling",
|
||||
"sdk"
|
||||
]
|
||||
},
|
||||
{
|
||||
"code": "client",
|
||||
"ru": "Клиент, патчи и интерфейс",
|
||||
"en": "Client, patches and UI",
|
||||
"keywords": [
|
||||
"client",
|
||||
"patch",
|
||||
"addon",
|
||||
"ui",
|
||||
"launcher",
|
||||
"controller",
|
||||
"mpq"
|
||||
]
|
||||
},
|
||||
{
|
||||
"code": "other",
|
||||
"ru": "Прочее",
|
||||
"en": "Other",
|
||||
"keywords": [
|
||||
|
||||
]
|
||||
}
|
||||
],
|
||||
"repos": {
|
||||
"liyunfan1223/mod-playerbots": "bots",
|
||||
"dustinhendrickson/mod-ollama-chat": "bots",
|
||||
"dustinhendrickson/mod-player-bot-level-brackets": "bots",
|
||||
"dustinhendrickson/mod-ollama-bot-buddy": "bots",
|
||||
"azerothcore/mod-autobalance": "pve",
|
||||
"zhengpeiru21/mod-challenge-modes": "pve",
|
||||
"anchydev/dungeonrespawn": "pve",
|
||||
"azerothcore/mod-rdf-expansion": "pve",
|
||||
"silviu20092/mod-mythic-plus": "pve",
|
||||
"avarishd/mod-brawlers-guild": "pve",
|
||||
"sogladev/mod-vanilla-naxxramas": "pve",
|
||||
"pangolp/mod-cfpve": "pve",
|
||||
"bewarellamas/mod-dungeonmaster": "pve",
|
||||
"araxiaonline/mod-mythic-plus": "pve",
|
||||
"sogladev/mod-reset-raid-cooldowns": "pve",
|
||||
"hallgaeuer/mod-quickbalance": "pve",
|
||||
"valsan-azerty-boi/mod-ony-naxx-logout-teleport": "pve",
|
||||
"stealthyape/raidteleporter": "pve",
|
||||
"zesman21/mod-nordf": "pve",
|
||||
"helias/mod-bg-slaveryvalley": "pvp",
|
||||
"azerothcore/mod-duel-reset": "pvp",
|
||||
"gitdalisar/mod-faction-free": "pvp",
|
||||
"azerothcore/mod-pvp-titles": "pvp",
|
||||
"helias/mod-bg-twinpeaks": "pvp",
|
||||
"helias/mod-bg-battle-for-gilneas": "pvp",
|
||||
"talamortis/mod-pvpscript": "pvp",
|
||||
"gozzim/mod-npc-spectator": "pvp",
|
||||
"azerothcore/mod-bg-reward": "pvp",
|
||||
"helias/mod-arena-tigerspeak": "pvp",
|
||||
"helias/mod-arena-tolviron": "pvp",
|
||||
"tbcstar/mod-high-risk-system": "pvp",
|
||||
"azerothcore/mod-pvp-zones": "pvp",
|
||||
"azerothcore/mod-bg-item-reward": "pvp",
|
||||
"azerothcore/mod-desertion-warnings": "pvp",
|
||||
"azerothcore/mod-low-level-rbg": "pvp",
|
||||
"youpeoples/ultimate-full-loot-pvp": "pvp",
|
||||
"azerothcore/mod-pvpstats-announcer": "pvp",
|
||||
"anchydev/ffafix": "pvp",
|
||||
"azerothcore/mod-low-level-arena": "pvp",
|
||||
"trembon/mod-peacekeeper": "pvp",
|
||||
"anchydev/bgqueuechecker": "pvp",
|
||||
"anchydev/hardmode": "hardcore",
|
||||
"kjack9/mod-dead-means-dead": "hardcore",
|
||||
"conan1996-2/mod-hard-modes": "hardcore",
|
||||
"jorge990125/mod-hardcore-makgora": "hardcore",
|
||||
"stuntmonkey4u/mod-trial-of-finality": "hardcore",
|
||||
"zindokar/mod-hardcore": "hardcore",
|
||||
"zhengpeiru21/mod-individual-progression": "progression",
|
||||
"azerothcore/mod-congrats-on-level": "progression",
|
||||
"noisiver/mod-weekendbonus": "progression",
|
||||
"youpeoples/prestige-and-draft-mode": "progression",
|
||||
"anchydev/attriboost": "progression",
|
||||
"azerothcore/mod-fireworks-on-level": "progression",
|
||||
"anchydev/extendedxp": "progression",
|
||||
"anchydev/prestigious": "progression",
|
||||
"noisiver/mod-appreciation": "progression",
|
||||
"betayi/mod_spec_reward": "progression",
|
||||
"brian8544/setxpbar": "progression",
|
||||
"nhobodyimportant/prestige": "progression",
|
||||
"azerothcore/mod-alpha-rewards": "progression",
|
||||
"michaeldelago/mod-quest-count-level": "progression",
|
||||
"regrad/update-mob-level-to-player-and-random-item-stats": "progression",
|
||||
"azerothcore/mod-chromie-xp": "progression",
|
||||
"kadan-gx/mod-login-rewards": "progression",
|
||||
"talamortis/mod-individual-xp": "progression",
|
||||
"talamortis/reward-system": "progression",
|
||||
"brian8544/mod-setxpbar": "progression",
|
||||
"fischerlol/mod-level-15-boost": "progression",
|
||||
"notepadguyofficial/mod-level-rewards": "progression",
|
||||
"thearktect/mod-weekend-xp": "progression",
|
||||
"heyitsbench/mod-arac": "classes",
|
||||
"heyitsbench/mod-worgoblin": "classes",
|
||||
"azerothcore/mod-npc-beastmaster": "classes",
|
||||
"zhengpeiru21/mod-leech": "classes",
|
||||
"azerothcore/mod-racial-trait-swap": "classes",
|
||||
"noisiver/mod-learnspells": "classes",
|
||||
"silviu20092/mod-warlock-pet-rename": "classes",
|
||||
"vhiperdev/mod-spellregulator": "classes",
|
||||
"xiii-hearts/mod-npc-subclass": "classes",
|
||||
"gozzim/mod-starting-pet": "classes",
|
||||
"bewarellamas/mod-profspecs": "classes",
|
||||
"sogladev/mod-demonic-pact-classic": "classes",
|
||||
"brian8544/mod-talentbutton": "classes",
|
||||
"lenzork/mod-petequip": "classes",
|
||||
"azerothcore/mod-transmog": "cosmetics",
|
||||
"azerothcore/mod-weapon-visual": "cosmetics",
|
||||
"azerothcore/mod-morphsummon": "cosmetics",
|
||||
"azerothcore/mod-costumes": "cosmetics",
|
||||
"azerothcore/mod-npc-morph": "cosmetics",
|
||||
"azerothcore/mod-aoe-loot": "items",
|
||||
"azerothcore/mod-npc-enchanter": "items",
|
||||
"anchydev/statbooster": "items",
|
||||
"zhengpeiru21/mod-reagent-bank": "items",
|
||||
"silviu20092/mod-item-upgrade": "items",
|
||||
"silviu20092/mod-reforging": "items",
|
||||
"terrabyte-tbwps/mod-aoe-loot": "items",
|
||||
"silviu20092/mod-improved-bank": "items",
|
||||
"pangolp/mod-quest-loot-party": "items",
|
||||
"anchydev/recycleditems": "items",
|
||||
"anchydev/statboosterreroller": "items",
|
||||
"hallgaeuer/mod-dynamic-loot-rates": "items",
|
||||
"seaferer/aoe-loot---merge": "items",
|
||||
"protonull/mod-starter-wands": "items",
|
||||
"talamortis/mod-itemlevel": "items",
|
||||
"noisiver/mod-junk-to-gold": "economy",
|
||||
"youpeoples/black-market-auction-house": "economy",
|
||||
"wowhellgarve-holydeew/mod-multi-vendor": "economy",
|
||||
"azerothcore/mod-money-for-kills": "economy",
|
||||
"azerothcore/mod-npc-gambler": "economy",
|
||||
"elmsroth/mod-trade-items-filter": "economy",
|
||||
"talamortis/mod_reward_shop": "economy",
|
||||
"silviu20092/mod-sell-items": "economy",
|
||||
"tereneckla/mod-profession-experience": "economy",
|
||||
"jorge990125/mod-black-market": "economy",
|
||||
"heyitsbench/mod-ptr-template": "account",
|
||||
"pangolp/mod-recruit-friend": "account",
|
||||
"azerothcore/mod-npc-all-mounts": "account",
|
||||
"gozzim/mod-firstlogin-aio": "account",
|
||||
"talamortis/mod-premium": "account",
|
||||
"zerkenn/mod-character-services": "account",
|
||||
"lucafolloni/mod-account-vanity-pets": "account",
|
||||
"noisiver/mod-accountbound": "account",
|
||||
"pangolp/mod-mounts-on-account": "account",
|
||||
"microbica/mod-share-mounts": "account",
|
||||
"gozzim/mod-globalchat": "social",
|
||||
"azerothcore/mod-guild-zone-system": "social",
|
||||
"azerothcore/mod-starter-guild": "social",
|
||||
"anchydev/itembroadcastguildchat": "social",
|
||||
"azerothcore/mod-chat-transmitter": "social",
|
||||
"azerothcore/mod-global-chat": "social",
|
||||
"noisiver/mod-guildfunds": "social",
|
||||
"jorge990125/mod-streams": "social",
|
||||
"noisiver/mod-assistant": "npc",
|
||||
"azerothcore/mod-npc-services": "npc",
|
||||
"azerothcore/mod-npc-buffer": "npc",
|
||||
"pangolp/mod-npc-promotion": "npc",
|
||||
"azerothcore/mod-npc-codebox": "npc",
|
||||
"azerothcore/mod-buff-command": "npc",
|
||||
"jorge990125/mod-bienvenida": "npc",
|
||||
"dunjeon/mod-timeistime": "world",
|
||||
"bytesgalore/mod-no-hearthstone-cooldown": "world",
|
||||
"justin-kaufmann/mod-changeablespawnrates": "world",
|
||||
"hallgaeuer/mod-quick-respawn": "world",
|
||||
"justin-kaufmann/mod-noclip": "world",
|
||||
"eldoba/mod-dynamic-resurrections-": "world",
|
||||
"elmegaard/mod-auto-resurrect": "world",
|
||||
"noisiver/mod-spawnpoints": "world",
|
||||
"tralenor/mod-objscale": "world",
|
||||
"silviu20092/mod-flightmaster-whistle": "world",
|
||||
"sogladev/mod-ghost-speed": "world",
|
||||
"talamortis/playerteleport": "world",
|
||||
"vhiperdev/mod-no-farming": "world",
|
||||
"noisiver/mod-activatezones": "world",
|
||||
"zyggy123/treasure-chest-system": "events",
|
||||
"azerothcore/mod-tic-tac-toe": "events",
|
||||
"pangolp/mod-quest-status": "events",
|
||||
"azerothcore/mod-war-effort": "events",
|
||||
"youpeoples/quizmaster": "events",
|
||||
"azerothcore/mod-cta-switch": "events",
|
||||
"azerothcore/mod-dmf-switch": "events",
|
||||
"azerothcore/mod-server-auto-shutdown": "server",
|
||||
"anchydev/recache": "server",
|
||||
"azerothcore/mod-queue-list-cache": "server",
|
||||
"maluramichael/mod-influxdb": "server",
|
||||
"sogladev/mod-increment-cache-version": "server",
|
||||
"anchydev/aci": "server",
|
||||
"azerothcore/mod-ip-tracker": "admin",
|
||||
"tralenor/mod-gomove": "admin",
|
||||
"talamortis/mod-whologged": "admin",
|
||||
"talamortis/mod_character_tools": "admin",
|
||||
"azerothcore/mod-notify-muted": "admin",
|
||||
"mellianstudios/mod-encounter-logs": "admin",
|
||||
"miithrandiir/mod_sponsorship": "web",
|
||||
"exitare/mod-discord-webhook": "web",
|
||||
"abutbul/mod-game-state-api": "web",
|
||||
"thearktect/mod-discord-announce": "web",
|
||||
"azerothcore/skeleton-module": "dev",
|
||||
"azerothcore/eluna-ts": "dev",
|
||||
"azerothcore/mod-premium-lib": "dev",
|
||||
"anchydev/breakingnewsoverride": "client",
|
||||
"gitdalisar/addon-faction-free-unit-popup": "client"
|
||||
}
|
||||
}
|
||||
@@ -58,33 +58,27 @@
|
||||
},
|
||||
{
|
||||
"repo_slug": "azerothcore/mod-cfbg",
|
||||
"status": "Verified",
|
||||
"status": "Incompatible",
|
||||
"is_recommended": false,
|
||||
"reason": "Cross-faction battlegrounds system. Built into CoA core fork."
|
||||
"reason": "Already built into the CoA core (cross-faction battlegrounds); a separate DLL would load it a second time."
|
||||
},
|
||||
{
|
||||
"repo_slug": "azerothcore/mod-duel-reset",
|
||||
"status": "Verified",
|
||||
"repo_slug": "helias/mod-bg-battle-for-gilneas",
|
||||
"status": "Incompatible",
|
||||
"is_recommended": false,
|
||||
"reason": "Resets health, mana, cooldowns and auras after duels. Verified dynamic DLL."
|
||||
"reason": "Needs the server's DBC files replaced (including Spell.dbc, which CoA ships its own of), a client patch and a modified wow.exe; written for AzerothCore 2019."
|
||||
},
|
||||
{
|
||||
"repo_slug": "azerothcore/mod-pvp-titles",
|
||||
"status": "Verified",
|
||||
"repo_slug": "helias/mod-bg-twinpeaks",
|
||||
"status": "Incompatible",
|
||||
"is_recommended": false,
|
||||
"reason": "Classic PvP rank titles awarded based on honorable kills."
|
||||
"reason": "Needs the server's DBC files replaced (CoA ships its own), a client patch and a modified wow.exe."
|
||||
},
|
||||
{
|
||||
"repo_slug": "azerothcore/mod-starter-guild",
|
||||
"status": "Verified",
|
||||
"repo_slug": "helias/mod-bg-slaveryvalley",
|
||||
"status": "Incompatible",
|
||||
"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."
|
||||
"reason": "Needs the server's DBC files replaced (CoA ships its own) and a client patch."
|
||||
},
|
||||
{
|
||||
"repo_slug": "azerothcore/mod-learn-spells",
|
||||
|
||||
File diff suppressed because it is too large.
Load diff
+1070
-167
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"
|
||||
}
|
||||
File diff suppressed because it is too large.
Load diff
@@ -337,6 +337,17 @@ impl Db {
|
||||
.map(|o| o.status.success()).unwrap_or(false)
|
||||
}
|
||||
|
||||
/// Ask the server to shut down cleanly (`mysqladmin shutdown`).
|
||||
pub fn shutdown_server(&self) -> Result<()> {
|
||||
let mut c = self.command("mysqladmin.exe");
|
||||
c.arg("shutdown").arg("--connect-timeout=5");
|
||||
let out = bounded_client_output(&mut c, b"", Instant::now() + Duration::from_secs(60))?;
|
||||
if !out.status.success() {
|
||||
return Err(self.fail(&out.stderr));
|
||||
}
|
||||
Ok(())
|
||||
}
|
||||
|
||||
pub(crate) fn with_read_deadline(mut self, deadline: Instant) -> Self {
|
||||
self.read_deadline = Some(deadline);
|
||||
self
|
||||
|
||||
+58
-308
@@ -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);
|
||||
}
|
||||
}
|
||||
@@ -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,
|
||||
|
||||
@@ -210,7 +210,7 @@ pub(crate) fn free_port() -> Result<u16> {
|
||||
|
||||
/// Run `f` with the staging copy listening on unused ports, so an installation never collides with a server (or any
|
||||
/// other program) already using the shipped ports. The shipped ports are put back afterwards.
|
||||
pub(crate) fn with_scratch_ports<T>(root: &Path, f: impl FnOnce() -> Result<T>) -> Result<T> {
|
||||
pub fn with_scratch_ports<T>(root: &Path, f: impl FnOnce() -> Result<T>) -> Result<T> {
|
||||
const KEYS: [&str; 4] = ["mysqlPort", "authPort", "worldPort", "raPort"];
|
||||
let path = root.join("Settings/repack.json");
|
||||
let original: serde_json::Value = fsx::read_json(&path)?;
|
||||
@@ -378,15 +378,18 @@ pub fn install_base(p: &Params, report: &dyn Fn(Step)) -> Result<Installed> {
|
||||
})?;
|
||||
say("Preparing database", 82, None);
|
||||
bootstrap_database(&staging_root)?;
|
||||
crate::backup::with_database(&staging_root, |db| {
|
||||
let problems = crate::schema_check::check(db, &staging_root)?;
|
||||
if let Some(p) = problems.first() {
|
||||
return Err(Error::Invalid(format!(
|
||||
"The packaged database is incomplete: {}.{}.{}: {}.",
|
||||
p.database, p.table, p.column, p.detail
|
||||
)));
|
||||
}
|
||||
Ok(())
|
||||
// On unused ports too: another server running on the shipped ports must not stop the installation.
|
||||
with_scratch_ports(&staging_root, || {
|
||||
crate::backup::with_database(&staging_root, |db| {
|
||||
let problems = crate::schema_check::check(db, &staging_root)?;
|
||||
if let Some(p) = problems.first() {
|
||||
return Err(Error::Invalid(format!(
|
||||
"The packaged database is incomplete: {}.{}.{}: {}.",
|
||||
p.database, p.table, p.column, p.detail
|
||||
)));
|
||||
}
|
||||
Ok(())
|
||||
})
|
||||
})?;
|
||||
// 4. Commit: the only moment the destination changes. The marker stays until everything is done, so an
|
||||
// unfinished install can always be recognised as ours (and cleaned up), wherever it stopped.
|
||||
|
||||
@@ -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;
|
||||
@@ -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(())
|
||||
}
|
||||
@@ -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());
|
||||
}
|
||||
}
|
||||
@@ -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()));
|
||||
}
|
||||
}
|
||||
@@ -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()));
|
||||
}
|
||||
}
|
||||
@@ -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);
|
||||
}
|
||||
}
|
||||
@@ -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.
@@ -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"));
|
||||
}
|
||||
}
|
||||
@@ -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();
|
||||
}
|
||||
}
|
||||
@@ -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);
|
||||
}
|
||||
}
|
||||
@@ -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}")
|
||||
@@ -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
|
||||
);
|
||||
}
|
||||
}
|
||||
@@ -9,8 +9,10 @@
|
||||
|
||||
pub mod accounts;
|
||||
pub mod allsettings;
|
||||
pub mod addons;
|
||||
pub mod analyzer;
|
||||
pub mod backup;
|
||||
pub mod build_cache;
|
||||
pub mod build_engine;
|
||||
pub mod catalogue;
|
||||
pub mod channels;
|
||||
@@ -31,6 +33,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,10 +42,12 @@ 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 modular_copy;
|
||||
pub mod modules;
|
||||
pub mod module_sources;
|
||||
pub mod msvc_setup;
|
||||
@@ -62,6 +67,7 @@ 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;
|
||||
@@ -72,7 +78,6 @@ 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;
|
||||
|
||||
@@ -0,0 +1,521 @@
|
||||
//! A modular copy of a classic server, next to it.
|
||||
//!
|
||||
//! A server with the classic core (every module compiled into `worldserver.exe`) is never converted in place.
|
||||
//! The Modules Preview installs a new server beside it and copies the old one's data into it: every game
|
||||
//! database (accounts, characters, world, bots) and the module settings. The old server is only read:
|
||||
//!
|
||||
//! * if its database is running, the schemas are dumped from it (consistent snapshots, nothing is written);
|
||||
//! * if it is stopped, its data files are copied to a private folder and read by a temporary database
|
||||
//! process of the NEW server; nothing of the old server is started or executed.
|
||||
//!
|
||||
//! The new server then takes the preview core like any other server (the caller applies the update).
|
||||
|
||||
use std::fs;
|
||||
use std::path::{Path, PathBuf};
|
||||
use std::process::{Child, Command, Stdio};
|
||||
use std::time::{Duration, Instant};
|
||||
|
||||
use serde::Serialize;
|
||||
|
||||
use crate::db::{Account, Db};
|
||||
use crate::error::{Error, Result};
|
||||
use crate::fsx;
|
||||
use crate::process::ServiceState;
|
||||
|
||||
/// Whether `root` runs the classic core: a Windows repack whose `worldserver.exe` carries no plugin-host
|
||||
/// fingerprint.
|
||||
pub fn is_classic(root: &Path) -> bool {
|
||||
!crate::docker::is_docker(root)
|
||||
&& root.join("Core/worldserver.exe").is_file()
|
||||
&& crate::provenance::realm_host_fingerprint(root).is_none()
|
||||
}
|
||||
|
||||
#[derive(Debug, Clone, Serialize)]
|
||||
pub struct CopyReport {
|
||||
pub schemas: Vec<String>,
|
||||
pub accounts: u64,
|
||||
pub characters: u64,
|
||||
pub config_files: Vec<String>,
|
||||
/// How the old data was read: "running database" or "copy of the stopped database".
|
||||
pub read_from: String,
|
||||
/// World settings the owner changed (Server Configuration) that were set on the new server too.
|
||||
pub world_settings: Vec<String>,
|
||||
/// Changed world settings the new server's configuration does not take, with the reason.
|
||||
pub world_settings_skipped: Vec<String>,
|
||||
}
|
||||
|
||||
/// What a modular copy of `old` would take, read without changing anything: the old server is never started,
|
||||
/// and its database is only queried when it is already running.
|
||||
#[derive(Debug, Clone, Serialize)]
|
||||
pub struct CopyPreview {
|
||||
pub path: PathBuf,
|
||||
/// The classic core (modules compiled in): the only kind that is copied.
|
||||
pub classic: bool,
|
||||
/// Already a modular core: it is added as it is, not copied.
|
||||
pub modular: bool,
|
||||
pub version: Option<String>,
|
||||
/// "running", "stopped" or "missing" (no database folder).
|
||||
pub database: String,
|
||||
/// Read from the running database; `None` when it is stopped (they are counted while copying).
|
||||
pub accounts: Option<u64>,
|
||||
pub characters: Option<u64>,
|
||||
pub schemas: Vec<String>,
|
||||
/// Size of the old database files; a stopped database is copied once more while it is read.
|
||||
pub database_bytes: u64,
|
||||
/// Settings files that go along (module configs, realm profiles).
|
||||
pub config_files: Vec<String>,
|
||||
/// Extra worlds of the old server (`.realms/<name>`). Their databases are in the same MySQL and go along, and
|
||||
/// the copied realm profile switches them on; the new server prepares their folders when it starts them.
|
||||
pub extra_worlds: Vec<String>,
|
||||
}
|
||||
|
||||
pub fn preview(old: &Path) -> Result<CopyPreview> {
|
||||
if !old.is_dir() {
|
||||
return Err(Error::Invalid(format!("{} is not a folder.", old.display())));
|
||||
}
|
||||
let classic = is_classic(old);
|
||||
let modular = !crate::docker::is_docker(old)
|
||||
&& old.join("Core/worldserver.exe").is_file()
|
||||
&& crate::provenance::realm_host_fingerprint(old).is_some();
|
||||
let version = crate::registry::metadata_dir_for(old)
|
||||
.ok()
|
||||
.and_then(|dir| crate::registry::MetaDir::open(&dir).ok())
|
||||
.and_then(|(_, meta)| meta.core.version);
|
||||
let data = old.join("mysql/data");
|
||||
let has_data = data.join("mysql").is_dir();
|
||||
let observed = crate::process::observe(old, &crate::layout::read_ports(old));
|
||||
let running_db = (has_data && observed.mysql.state == ServiceState::Running)
|
||||
.then(|| Db::from_repack(old, Account::Admin).ok())
|
||||
.flatten()
|
||||
.filter(|db| db.ping())
|
||||
.map(|db| db.for_realm(crate::realms::Mode::Coa));
|
||||
let (database, accounts, characters, schemas) = match &running_db {
|
||||
Some(db) => (
|
||||
"running",
|
||||
Some(count(db, "SELECT COUNT(*) FROM acore_auth.account;")),
|
||||
Some(count(db, "SELECT COUNT(*) FROM acore_characters.characters;")),
|
||||
game_schemas(db).unwrap_or_default(),
|
||||
),
|
||||
None if has_data => ("stopped", None, None, Vec::new()),
|
||||
None => ("missing", None, None, Vec::new()),
|
||||
};
|
||||
let mut extra_worlds: Vec<String> = fs::read_dir(old.join(".realms"))
|
||||
.map(|rd| rd.flatten().filter(|e| e.path().is_dir()).map(|e| e.file_name().to_string_lossy().into_owned()).collect())
|
||||
.unwrap_or_default();
|
||||
extra_worlds.sort();
|
||||
Ok(CopyPreview {
|
||||
path: old.to_path_buf(),
|
||||
classic,
|
||||
modular,
|
||||
version,
|
||||
database: database.into(),
|
||||
accounts,
|
||||
characters,
|
||||
schemas,
|
||||
database_bytes: if has_data { dir_size(&data) } else { 0 },
|
||||
config_files: settings_files(old),
|
||||
extra_worlds,
|
||||
})
|
||||
}
|
||||
|
||||
/// Game schemas of a CoA server: `acore_*` (auth, characters, world, their Wildcard/Reborn variants, bots).
|
||||
fn game_schemas(db: &Db) -> Result<Vec<String>> {
|
||||
let mut out: Vec<String> = db
|
||||
.query("SELECT SCHEMA_NAME FROM information_schema.SCHEMATA WHERE SCHEMA_NAME LIKE 'acore\\_%' ORDER BY SCHEMA_NAME;")?
|
||||
.lines()
|
||||
.map(|l| l.trim().to_string())
|
||||
.filter(|s| !s.is_empty() && s.chars().all(|c| c.is_ascii_alphanumeric() || c == '_'))
|
||||
// work schemas a restore leaves behind are not game data
|
||||
.filter(|s| !s.contains("_restore_") && !s.contains("_before_restore_"))
|
||||
.collect();
|
||||
out.dedup();
|
||||
if !out.iter().any(|s| s == "acore_auth") || !out.iter().any(|s| s == "acore_characters") {
|
||||
return Err(Error::Invalid("The old server's database has no accounts or characters schema.".into()));
|
||||
}
|
||||
Ok(out)
|
||||
}
|
||||
|
||||
fn count(db: &Db, sql: &str) -> u64 {
|
||||
db.query(sql).ok().and_then(|s| s.trim().parse().ok()).unwrap_or(0)
|
||||
}
|
||||
|
||||
/// A database process of the new server reading a private copy of the old server's stopped data files.
|
||||
struct TemporaryDatabase {
|
||||
child: Child,
|
||||
dir: PathBuf,
|
||||
db: Option<Db>,
|
||||
stopped: bool,
|
||||
}
|
||||
|
||||
impl TemporaryDatabase {
|
||||
/// Shut it down cleanly, force it if it does not go, and remove the private copy. Fails if the process is
|
||||
/// still there afterwards, so a leftover database never holds the new server's files.
|
||||
fn stop(&mut self) -> Result<()> {
|
||||
if self.stopped {
|
||||
return Ok(());
|
||||
}
|
||||
if let Some(db) = &self.db {
|
||||
let _ = db.shutdown_server();
|
||||
}
|
||||
let deadline = Instant::now() + Duration::from_secs(90);
|
||||
loop {
|
||||
match self.child.try_wait()? {
|
||||
Some(_) => break,
|
||||
None if Instant::now() > deadline => {
|
||||
tracing::warn!(pid = self.child.id(), "temporary database did not shut down; terminating it");
|
||||
self.child.kill()?;
|
||||
self.child.wait()?;
|
||||
break;
|
||||
}
|
||||
None => std::thread::sleep(Duration::from_millis(250)),
|
||||
}
|
||||
}
|
||||
self.stopped = true;
|
||||
fs::remove_dir_all(&self.dir)?;
|
||||
Ok(())
|
||||
}
|
||||
}
|
||||
|
||||
impl Drop for TemporaryDatabase {
|
||||
fn drop(&mut self) {
|
||||
if !self.stopped {
|
||||
if let Err(e) = self.stop() {
|
||||
tracing::warn!(error = %e, pid = self.child.id(), "temporary database left behind");
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
fn copy_tree(from: &Path, to: &Path) -> Result<u64> {
|
||||
let mut bytes = 0;
|
||||
fs::create_dir_all(to)?;
|
||||
for entry in fs::read_dir(from)? {
|
||||
let entry = entry?;
|
||||
let md = fs::symlink_metadata(entry.path())?;
|
||||
if md.file_type().is_symlink() {
|
||||
return Err(Error::Invalid(format!("{} is a link; the database folder is not copied.", entry.path().display())));
|
||||
}
|
||||
let target = to.join(entry.file_name());
|
||||
if md.is_dir() {
|
||||
bytes += copy_tree(&entry.path(), &target)?;
|
||||
} else {
|
||||
fs::copy(entry.path(), &target)?;
|
||||
bytes += md.len();
|
||||
}
|
||||
}
|
||||
Ok(bytes)
|
||||
}
|
||||
|
||||
fn dir_size(dir: &Path) -> u64 {
|
||||
fs::read_dir(dir).map(|rd| rd.flatten().map(|e| {
|
||||
let p = e.path();
|
||||
if p.is_dir() { dir_size(&p) } else { e.metadata().map(|m| m.len()).unwrap_or(0) }
|
||||
}).sum()).unwrap_or(0)
|
||||
}
|
||||
|
||||
fn start_temporary(old: &Path, new: &Path, work: &Path, progress: &dyn Fn(&str)) -> Result<(TemporaryDatabase, Db)> {
|
||||
let source = old.join("mysql/data");
|
||||
if !source.join("mysql").is_dir() || !source.join("ibdata1").is_file() {
|
||||
return Err(Error::Invalid("The old server's database folder is incomplete.".into()));
|
||||
}
|
||||
let dir = work.join("old-database");
|
||||
let _ = fs::remove_dir_all(&dir);
|
||||
fsx::require_space(work, dir_size(&source))?;
|
||||
progress("Copying the old server's database files");
|
||||
let data = dir.join("data");
|
||||
copy_tree(&source, &data)?;
|
||||
let (root_password, _) = crate::db::credentials(old)?;
|
||||
let bin = new.join("mysql/bin");
|
||||
let port = crate::install::free_port()?;
|
||||
let child = Command::new(bin.join("mysqld.exe"))
|
||||
.arg("--no-defaults")
|
||||
.arg(format!("--basedir={}", new.join("mysql").display()))
|
||||
.arg(format!("--datadir={}", data.display()))
|
||||
.arg(format!("--port={port}"))
|
||||
.args(["--bind-address=127.0.0.1", "--mysqlx=0", "--skip-log-bin", "--character-set-server=utf8mb4",
|
||||
"--collation-server=utf8mb4_unicode_ci", "--max_allowed_packet=128M"])
|
||||
.arg(format!("--log-error={}", dir.join("mysql-error.log").display()))
|
||||
.arg(format!("--pid-file={}", dir.join("mysql.pid").display()))
|
||||
.stdout(Stdio::null())
|
||||
.stderr(Stdio::null())
|
||||
.creation_flags_hidden()
|
||||
.spawn()?;
|
||||
let db = Db::with_tools(bin, port, "root", &root_password, crate::realms::Mode::Coa);
|
||||
let mut temp = TemporaryDatabase { child, dir, db: Some(db.clone()), stopped: false };
|
||||
progress("Opening the copy of the old database");
|
||||
let deadline = Instant::now() + Duration::from_secs(300);
|
||||
while !db.ping() {
|
||||
if let Ok(Some(status)) = temp.child.try_wait() {
|
||||
let log = fs::read_to_string(temp.dir.join("mysql-error.log")).unwrap_or_default();
|
||||
let tail: Vec<&str> = log.lines().rev().take(8).collect();
|
||||
return Err(Error::Invalid(format!(
|
||||
"The copy of the old database did not open ({status}). {}",
|
||||
tail.into_iter().rev().collect::<Vec<_>>().join(" ")
|
||||
)));
|
||||
}
|
||||
if Instant::now() > deadline {
|
||||
return Err(Error::Invalid("The copy of the old database did not open within 5 minutes.".into()));
|
||||
}
|
||||
std::thread::sleep(Duration::from_millis(300));
|
||||
}
|
||||
Ok((temp, db))
|
||||
}
|
||||
|
||||
trait HiddenWindow {
|
||||
fn creation_flags_hidden(&mut self) -> &mut Self;
|
||||
}
|
||||
|
||||
impl HiddenWindow for Command {
|
||||
fn creation_flags_hidden(&mut self) -> &mut Self {
|
||||
#[cfg(windows)]
|
||||
{
|
||||
use std::os::windows::process::CommandExt;
|
||||
self.creation_flags(0x0800_0000);
|
||||
}
|
||||
self
|
||||
}
|
||||
}
|
||||
|
||||
/// Settings the owner may have changed that the new core can take as they are: the module configs
|
||||
/// (`Core/configs/modules/*.conf`; the shipped `.dist` files belong to the new core) and the realm profiles.
|
||||
/// `worldserver.conf` and `authserver.conf` are rendered by the launcher from the new server's own
|
||||
/// templates at every start, so they are not copied.
|
||||
fn settings_files(old: &Path) -> Vec<String> {
|
||||
crate::backup::config_files(old)
|
||||
.into_iter()
|
||||
.filter(|f| {
|
||||
(f.starts_with("Core/configs/modules/") && f.ends_with(".conf") && !f.ends_with("/mod_ascension_compat.conf"))
|
||||
|| f.starts_with("Settings/realm-profile")
|
||||
})
|
||||
.collect()
|
||||
}
|
||||
|
||||
/// Copy the old server's data into `new`, a server just installed and not yet started by anyone.
|
||||
pub fn copy_data(old: &Path, new: &Path, progress: &dyn Fn(&str)) -> Result<CopyReport> {
|
||||
if !is_classic(old) {
|
||||
return Err(Error::Invalid("Only a server with the classic core is copied.".into()));
|
||||
}
|
||||
if fsx::canonicalize_lenient(old)? == fsx::canonicalize_lenient(new)? {
|
||||
return Err(Error::Invalid("The new server must be in another folder.".into()));
|
||||
}
|
||||
let work = crate::registry::metadata_dir_for(new)?.join("import");
|
||||
let _ = fs::remove_dir_all(&work);
|
||||
fs::create_dir_all(&work)?;
|
||||
|
||||
// 1. Read the old databases.
|
||||
let observed = crate::process::observe(old, &crate::layout::read_ports(old));
|
||||
let running = observed.mysql.state == ServiceState::Running
|
||||
&& Db::from_repack(old, Account::Admin).map(|db| db.ping()).unwrap_or(false);
|
||||
let mut temporary: Option<TemporaryDatabase> = None;
|
||||
let (source, read_from) = if running {
|
||||
(Db::from_repack(old, Account::Admin)?.for_realm(crate::realms::Mode::Coa), "running database")
|
||||
} else {
|
||||
let (temp, db) = start_temporary(old, new, &work, progress)?;
|
||||
temporary = Some(temp);
|
||||
(db, "copy of the stopped database")
|
||||
};
|
||||
let schemas = game_schemas(&source)?;
|
||||
let accounts = count(&source, "SELECT COUNT(*) FROM acore_auth.account;");
|
||||
let characters = count(&source, "SELECT COUNT(*) FROM acore_characters.characters;");
|
||||
let mut dumps = Vec::new();
|
||||
for schema in &schemas {
|
||||
progress(&format!("Copying {schema}"));
|
||||
let file = work.join(format!("{schema}.sql.zst"));
|
||||
source.dump_to(schema, &file)?;
|
||||
dumps.push((schema.clone(), file));
|
||||
}
|
||||
// The private copy of the old data files is not needed any more; its database must be gone before the new
|
||||
// server's own database starts.
|
||||
if let Some(mut temp) = temporary.take() {
|
||||
progress("Closing the copy of the old database");
|
||||
temp.stop()?;
|
||||
}
|
||||
|
||||
// 2. Put them into the new server, on ports nobody uses, so a running old server is not disturbed.
|
||||
crate::install::with_scratch_ports(new, || {
|
||||
crate::backup::with_database(new, |db| {
|
||||
let db = db.clone().for_realm(crate::realms::Mode::Coa);
|
||||
for (schema, file) in &dumps {
|
||||
progress(&format!("Importing {schema}"));
|
||||
db.query(&format!(
|
||||
"DROP DATABASE IF EXISTS `{schema}`; CREATE DATABASE `{schema}` CHARACTER SET utf8mb4 COLLATE utf8mb4_unicode_ci;"
|
||||
))?;
|
||||
db.import_from(schema, file)?;
|
||||
}
|
||||
let (a, c) = (
|
||||
count(&db, "SELECT COUNT(*) FROM acore_auth.account;"),
|
||||
count(&db, "SELECT COUNT(*) FROM acore_characters.characters;"),
|
||||
);
|
||||
if (a, c) != (accounts, characters) {
|
||||
return Err(Error::Invalid(format!(
|
||||
"The copy is incomplete: {a} of {accounts} accounts and {c} of {characters} characters arrived."
|
||||
)));
|
||||
}
|
||||
Ok(())
|
||||
})
|
||||
})?;
|
||||
|
||||
// 3. Settings: module configs and realm profiles; ports and console login as the old server had them
|
||||
// (the console account lives in the copied accounts database).
|
||||
progress("Copying settings");
|
||||
let files = settings_files(old);
|
||||
for rel in &files {
|
||||
let from = fsx::ensure_within(old, &fsx::safe_join(old, rel)?)?;
|
||||
let to = fsx::ensure_within(new, &fsx::safe_join(new, rel)?)?;
|
||||
fsx::atomic_write(&to, &fs::read(from)?)?;
|
||||
}
|
||||
let old_repack: serde_json::Value = fsx::read_json(&old.join("Settings/repack.json"))?;
|
||||
let mut repack: serde_json::Value = fsx::read_json(&new.join("Settings/repack.json"))?;
|
||||
if let (Some(dst), Some(src)) = (repack.as_object_mut(), old_repack.as_object()) {
|
||||
for (k, v) in src {
|
||||
dst.insert(k.clone(), v.clone());
|
||||
}
|
||||
}
|
||||
fsx::atomic_write_json(&new.join("Settings/repack.json"), &repack)?;
|
||||
let _ = fs::remove_dir_all(&work);
|
||||
progress("Copying world settings");
|
||||
let (world_settings, world_settings_skipped) = carry_world_settings(old, new)?;
|
||||
Ok(CopyReport {
|
||||
schemas,
|
||||
accounts,
|
||||
characters,
|
||||
config_files: files,
|
||||
read_from: read_from.into(),
|
||||
world_settings,
|
||||
world_settings_skipped,
|
||||
})
|
||||
}
|
||||
|
||||
/// The world settings changed on the old server (they live in its `Settings/worldserver.conf.template`, which the new
|
||||
/// server does not take: it keeps the template of its own version) are set on the new server through the same checks
|
||||
/// the Server Configuration page uses. Settings the Manager owns (ports, folders, passwords) are not among them.
|
||||
///
|
||||
/// The shipped template already differs from `worldserver.conf.dist` in many places, so "changed" means "differs from
|
||||
/// what the new server has now": for a copy onto the same version that is exactly what the owner changed. (A value the
|
||||
/// owner never touched but a newer release ships differently cannot be told apart from an owner's change; it keeps the
|
||||
/// old server's value, which is what that server ran with.)
|
||||
fn carry_world_settings(old: &Path, new: &Path) -> Result<(Vec<String>, Vec<String>)> {
|
||||
let current: std::collections::BTreeMap<String, String> =
|
||||
crate::allsettings::list(new)?.into_iter().map(|i| (i.key, i.value)).collect();
|
||||
let mut changes = std::collections::BTreeMap::new();
|
||||
let mut skipped = Vec::new();
|
||||
for item in crate::allsettings::list(old)? {
|
||||
match current.get(&item.key) {
|
||||
Some(now) if *now == item.value => {}
|
||||
Some(_) => {
|
||||
changes.insert(item.key, item.value);
|
||||
}
|
||||
None if item.changed => skipped.push(format!("{}: not a setting of the new version", item.key)),
|
||||
None => {}
|
||||
}
|
||||
}
|
||||
let meta = crate::registry::metadata_dir_for(new)?;
|
||||
let mut carried = Vec::new();
|
||||
match crate::allsettings::save(new, &meta, &changes) {
|
||||
Ok(set) => carried.extend(set),
|
||||
// One value the new version refuses must not lose the others: set them one at a time.
|
||||
Err(_) => {
|
||||
for (key, value) in changes {
|
||||
match crate::allsettings::save(new, &meta, &std::collections::BTreeMap::from([(key.clone(), value)])) {
|
||||
Ok(set) => carried.extend(set),
|
||||
Err(e) => skipped.push(format!("{key}: {e}")),
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
Ok((carried, skipped))
|
||||
}
|
||||
|
||||
#[cfg(test)]
|
||||
mod tests {
|
||||
use super::*;
|
||||
|
||||
const DIST: &str = "[worldserver]\r\n\r\n#\r\n# Rate.Drop.Item.Epic\r\n# Description: Epic drops.\r\n# Default: 1\r\n#\r\n\r\nRate.Drop.Item.Epic = 1\r\n\r\n#\r\n# LoginDatabaseInfo\r\n# Description: secret\r\n#\r\n\r\nLoginDatabaseInfo = \"127.0.0.1;3306;a;b;c\"\r\n\r\n#\r\n# Instance.ResetTimeHour\r\n# Description: Hour of the reset.\r\n# Default: 4\r\n#\r\n\r\nInstance.ResetTimeHour = 4\r\n";
|
||||
|
||||
fn world(root: &Path, dist: &str, conf: &str) {
|
||||
fs::create_dir_all(root.join("Core/configs")).unwrap();
|
||||
fs::create_dir_all(root.join("Settings")).unwrap();
|
||||
fs::create_dir_all(crate::registry::metadata_dir_for(root).unwrap()).unwrap();
|
||||
fs::write(root.join("Core/configs/worldserver.conf.dist"), dist).unwrap();
|
||||
fs::write(root.join("Settings/worldserver.conf.template"), conf).unwrap();
|
||||
fs::write(root.join("Core/configs/worldserver.conf"), conf).unwrap();
|
||||
}
|
||||
|
||||
#[test]
|
||||
fn changed_world_settings_go_to_the_new_server_and_the_rest_keep_its_defaults() {
|
||||
let dir = tempfile::tempdir().unwrap();
|
||||
let (old, new) = (dir.path().join("old"), dir.path().join("new"));
|
||||
let old_dist = format!("{DIST}\r\n#\r\n# Old.Only\r\n# Description: gone in the new version.\r\n# Default: 1\r\n#\r\n\r\nOld.Only = 1\r\n");
|
||||
world(&old, &old_dist, "[worldserver]\r\nRate.Drop.Item.Epic = 3\r\nOld.Only = 2\r\nLoginDatabaseInfo = \"old\"\r\n");
|
||||
world(&new, DIST, "[worldserver]\r\nLoginDatabaseInfo = \"new\"\r\n");
|
||||
|
||||
let (carried, skipped) = carry_world_settings(&old, &new).unwrap();
|
||||
assert_eq!(carried, ["Rate.Drop.Item.Epic"]);
|
||||
assert_eq!(skipped.len(), 1, "{skipped:?}");
|
||||
assert!(skipped[0].starts_with("Old.Only"));
|
||||
for f in ["Settings/worldserver.conf.template", "Core/configs/worldserver.conf"] {
|
||||
let text = fs::read_to_string(new.join(f)).unwrap();
|
||||
assert!(text.contains("Rate.Drop.Item.Epic = 3"), "{f}: {text}");
|
||||
assert!(text.contains("LoginDatabaseInfo = \"new\""), "the Manager's own settings stay: {text}");
|
||||
assert!(!text.contains("Old.Only"), "{text}");
|
||||
}
|
||||
}
|
||||
|
||||
#[test]
|
||||
fn the_preview_of_a_folder_reads_only_files() {
|
||||
let dir = tempfile::tempdir().unwrap();
|
||||
let classic = dir.path().join("classic");
|
||||
fs::create_dir_all(classic.join("Core/configs/modules")).unwrap();
|
||||
fs::create_dir_all(classic.join("mysql/data/mysql")).unwrap();
|
||||
fs::create_dir_all(classic.join(".realms/secondary")).unwrap();
|
||||
fs::write(classic.join("Core/worldserver.exe"), b"not a plugin host").unwrap();
|
||||
fs::write(classic.join("Core/configs/modules/mod_x.conf"), b"x").unwrap();
|
||||
fs::write(classic.join("mysql/data/ibdata1"), vec![0u8; 2048]).unwrap();
|
||||
let p = preview(&classic).unwrap();
|
||||
assert!(p.classic && !p.modular);
|
||||
assert_eq!(p.database, "stopped");
|
||||
assert_eq!((p.accounts, p.characters), (None, None), "a stopped database is not opened");
|
||||
assert_eq!(p.database_bytes, 2048);
|
||||
assert_eq!(p.config_files, ["Core/configs/modules/mod_x.conf"]);
|
||||
assert_eq!(p.extra_worlds, ["secondary"]);
|
||||
|
||||
let empty = dir.path().join("empty");
|
||||
fs::create_dir_all(&empty).unwrap();
|
||||
let p = preview(&empty).unwrap();
|
||||
assert!(!p.classic && !p.modular);
|
||||
assert_eq!(p.database, "missing");
|
||||
assert!(preview(&dir.path().join("nowhere")).is_err());
|
||||
}
|
||||
|
||||
#[test]
|
||||
fn only_owner_settings_are_copied() {
|
||||
let dir = tempfile::tempdir().unwrap();
|
||||
let old = dir.path();
|
||||
for rel in [
|
||||
"Core/configs/worldserver.conf",
|
||||
"Core/configs/worldserver.conf.dist",
|
||||
"Core/configs/modules/mod_x.conf",
|
||||
"Core/configs/modules/mod_x.conf.dist",
|
||||
"Core/configs/modules/mod_ascension_compat.conf",
|
||||
"Settings/repack.json",
|
||||
"Settings/worldserver.conf.template",
|
||||
"Settings/realm-profile.json",
|
||||
] {
|
||||
let p = old.join(rel);
|
||||
fs::create_dir_all(p.parent().unwrap()).unwrap();
|
||||
fs::write(p, b"x").unwrap();
|
||||
}
|
||||
let mut got = settings_files(old);
|
||||
got.sort();
|
||||
assert_eq!(got, vec![
|
||||
"Core/configs/modules/mod_x.conf".to_string(),
|
||||
"Settings/realm-profile.json".to_string(),
|
||||
]);
|
||||
}
|
||||
|
||||
#[test]
|
||||
fn a_folder_without_a_core_is_not_classic() {
|
||||
let dir = tempfile::tempdir().unwrap();
|
||||
assert!(!is_classic(dir.path()));
|
||||
}
|
||||
}
|
||||
@@ -61,10 +61,24 @@ pub fn fetch_pinned(owner: &str, repo: &str, sha: &str, cache_root: &Path) -> Re
|
||||
Ok(dest)
|
||||
}
|
||||
|
||||
/// Game-client and media files a server module's build never reads (client patches, DBC/map data, textures,
|
||||
/// archives). Some repositories carry hundreds of MB of them next to a few KB of server code; they are left out
|
||||
/// of the sources, and their names listed in `.coa_skipped_assets`.
|
||||
fn is_client_asset(rel: &Path) -> bool {
|
||||
const EXT: [&str; 22] = [
|
||||
"mpq", "dbc", "db2", "adt", "wdt", "wdl", "wmo", "m2", "skin", "anim", "blp", "tga", "trs", "vmtile", "vmtree",
|
||||
"mmap", "mmtile", "zip", "7z", "rar", "mp3", "ogg",
|
||||
];
|
||||
rel.extension()
|
||||
.and_then(|e| e.to_str())
|
||||
.is_some_and(|e| EXT.iter().any(|x| x.eq_ignore_ascii_case(e)))
|
||||
}
|
||||
|
||||
/// 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<()> {
|
||||
pub(crate) fn unpack(reader: impl Read, dest: &Path) -> Result<()> {
|
||||
let mut archive = tar::Archive::new(flate2::read::GzDecoder::new(reader));
|
||||
let mut total = 0u64;
|
||||
let mut skipped = Vec::new();
|
||||
for entry in archive.entries()? {
|
||||
let mut entry = entry?;
|
||||
let path = entry.path()?.into_owned();
|
||||
@@ -79,6 +93,8 @@ fn unpack(reader: impl Read, dest: &Path) -> Result<()> {
|
||||
let target = dest.join(&rel);
|
||||
if kind.is_dir() {
|
||||
fs::create_dir_all(&target)?;
|
||||
} else if kind.is_file() && is_client_asset(&rel) {
|
||||
skipped.push(rel.to_string_lossy().replace('\\', "/"));
|
||||
} else if kind.is_file() {
|
||||
total += entry.header().size()?;
|
||||
if total > MAX_ARCHIVE_BYTES {
|
||||
@@ -90,6 +106,9 @@ fn unpack(reader: impl Read, dest: &Path) -> Result<()> {
|
||||
}
|
||||
// Links and special entries are not part of a module's sources: skipped.
|
||||
}
|
||||
if !skipped.is_empty() {
|
||||
fs::write(dest.join(".coa_skipped_assets"), skipped.join("\n"))?;
|
||||
}
|
||||
Ok(())
|
||||
}
|
||||
|
||||
@@ -118,6 +137,24 @@ mod tests {
|
||||
assert!(dir.path().join("conf/x.conf.dist").is_file());
|
||||
}
|
||||
|
||||
#[test]
|
||||
fn client_assets_are_left_out_and_listed() {
|
||||
let dir = tempfile::tempdir().unwrap();
|
||||
let gz = tar_gz(&[
|
||||
("mod-bg-abc/server-side/src/BG.cpp", b"int a;"),
|
||||
("mod-bg-abc/client-side/DBFilesClient/Spell.dbc", b"dbc"),
|
||||
("mod-bg-abc/client-data.zip", b"zip"),
|
||||
("mod-bg-abc/data/sql/db-world/bg.sql", b"SELECT 1;"),
|
||||
]);
|
||||
unpack(&gz[..], dir.path()).unwrap();
|
||||
assert!(dir.path().join("server-side/src/BG.cpp").is_file());
|
||||
assert!(dir.path().join("data/sql/db-world/bg.sql").is_file());
|
||||
assert!(!dir.path().join("client-side/DBFilesClient/Spell.dbc").exists());
|
||||
assert!(!dir.path().join("client-data.zip").exists());
|
||||
let listed = fs::read_to_string(dir.path().join(".coa_skipped_assets")).unwrap();
|
||||
assert!(listed.contains("Spell.dbc") && listed.contains("client-data.zip"));
|
||||
}
|
||||
|
||||
#[test]
|
||||
fn bad_names_are_refused_before_any_download() {
|
||||
let dir = tempfile::tempdir().unwrap();
|
||||
|
||||
@@ -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 {
|
||||
@@ -164,6 +168,7 @@ pub struct ModuleView {
|
||||
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,6 +229,32 @@ 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();
|
||||
@@ -400,7 +431,9 @@ fn list_in(cat: &[Entry], root: &Path) -> Vec<ModuleView> {
|
||||
};
|
||||
let dependency_missing = e.id == "dungeon-clear" && !is_squid_active;
|
||||
let blocked = dependency_missing
|
||||
|| (wildcard && matches!(e.id.as_str(), "companions" | "playerbots" | "dungeon-clear"));
|
||||
|| (wildcard
|
||||
&& (matches!(e.id.as_str(), "playerbots" | "dungeon-clear")
|
||||
|| (e.id == "companions" && !companions_on_other_realms(root))));
|
||||
let version = if let Some(p) = plugin_entry {
|
||||
Some(p.version.clone())
|
||||
} else if e.id == "playerbots" {
|
||||
@@ -460,6 +493,7 @@ fn list_in(cat: &[Entry], root: &Path) -> Vec<ModuleView> {
|
||||
component_type,
|
||||
can_remove,
|
||||
source_commit,
|
||||
part_of: e.part_of,
|
||||
}
|
||||
})
|
||||
.collect();
|
||||
@@ -558,6 +592,7 @@ fn list_in(cat: &[Entry], root: &Path) -> Vec<ModuleView> {
|
||||
component_type: ComponentType::DynamicDll,
|
||||
can_remove: true,
|
||||
source_commit,
|
||||
part_of: None,
|
||||
});
|
||||
}
|
||||
}
|
||||
@@ -711,6 +746,17 @@ pub fn ensure_bot_exclusivity(root: &Path) -> Result<()> {
|
||||
Ok(())
|
||||
}
|
||||
|
||||
/// Dungeon Clear is part of SQUID's Playerbots (the plugin core builds it into the SQUID DLL): it goes on
|
||||
/// with SQUID, and off with it, wherever its config exists.
|
||||
fn switch_on_dungeon_clear_with_squid(cat: &[Entry], root: &Path, meta: &Path) {
|
||||
if let Some(dc) = cat.iter().find(|entry| entry.id == "dungeon-clear") {
|
||||
let name = conf_name(root, dc);
|
||||
if dir(root).join(&name).exists() || dir(root).join(format!("{name}.dist")).exists() {
|
||||
let _ = set_enabled_in(cat, root, meta, "dungeon-clear", true);
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
fn set_enabled_in(cat: &[Entry], root: &Path, meta: &Path, id: &str, on: bool) -> Result<()> {
|
||||
match entry_in(cat, id) {
|
||||
Ok(e) => {
|
||||
@@ -770,6 +816,7 @@ fn set_enabled_in(cat: &[Entry], root: &Path, meta: &Path, id: &str, on: bool) -
|
||||
}
|
||||
if id == "playerbots" && on {
|
||||
let _ = crate::plugins::record_squid_migrations_applied(root);
|
||||
switch_on_dungeon_clear_with_squid(cat, root, meta);
|
||||
}
|
||||
|
||||
tracing::info!(module = id, on, "module switched");
|
||||
@@ -806,6 +853,9 @@ fn set_enabled_in(cat: &[Entry], root: &Path, meta: &Path, id: &str, on: bool) -
|
||||
let _ = set_enabled_in(cat, root, meta, "dungeon-clear", false);
|
||||
}
|
||||
}
|
||||
if id == "playerbots" && on {
|
||||
switch_on_dungeon_clear_with_squid(cat, root, meta);
|
||||
}
|
||||
return Ok(());
|
||||
}
|
||||
}
|
||||
@@ -1129,6 +1179,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 +1218,7 @@ mod tests {
|
||||
icon: String::new(),
|
||||
page: None,
|
||||
hidden: false,
|
||||
part_of: None,
|
||||
};
|
||||
vec![
|
||||
one(
|
||||
@@ -1255,7 +1327,7 @@ mod tests {
|
||||
}
|
||||
|
||||
#[test]
|
||||
fn dungeon_clear_requires_squid_and_stays_off_after_squid_is_reenabled() {
|
||||
fn dungeon_clear_requires_squid_and_follows_it() {
|
||||
let d = tempfile::tempdir().unwrap();
|
||||
let root = d.path();
|
||||
fs::create_dir_all(dir(root)).unwrap();
|
||||
@@ -1266,13 +1338,13 @@ mod tests {
|
||||
let cat = catalog();
|
||||
assert!(set_enabled_in(&cat, root, root, "dungeon-clear", true).is_err());
|
||||
assert!(!list_in(&cat, root).iter().find(|entry| entry.id == "dungeon-clear").unwrap().switchable);
|
||||
// part of SQUID: on with it, off with it, on again with it
|
||||
set_enabled_in(&cat, root, root, "playerbots", true).unwrap();
|
||||
set_enabled_in(&cat, root, root, "dungeon-clear", true).unwrap();
|
||||
assert!(read(&dungeon).unwrap().get("DungeonClear.Enable").map(truthy).unwrap());
|
||||
set_enabled_in(&cat, root, root, "playerbots", false).unwrap();
|
||||
assert!(!read(&dungeon).unwrap().get("DungeonClear.Enable").map(truthy).unwrap());
|
||||
set_enabled_in(&cat, root, root, "playerbots", true).unwrap();
|
||||
assert!(!read(&dungeon).unwrap().get("DungeonClear.Enable").map(truthy).unwrap());
|
||||
assert!(read(&dungeon).unwrap().get("DungeonClear.Enable").map(truthy).unwrap());
|
||||
}
|
||||
|
||||
#[test]
|
||||
@@ -1792,6 +1864,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);
|
||||
|
||||
@@ -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());
|
||||
}
|
||||
}
|
||||
@@ -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,
|
||||
|
||||
@@ -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)?;
|
||||
|
||||
@@ -269,9 +269,95 @@ pub fn save(
|
||||
),
|
||||
]),
|
||||
)?;
|
||||
write_snapshot(root, ¤t.catalog_sha256, ¤t.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, ¤t, &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();
|
||||
|
||||
@@ -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"
|
||||
}
|
||||
@@ -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
@@ -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
|
||||
);
|
||||
}
|
||||
}
|
||||
@@ -259,9 +259,32 @@ fn split_repo(repo: &str) -> std::result::Result<(&str, &str), String> {
|
||||
.ok_or_else(|| format!("invalid repository '{repo}'"))
|
||||
}
|
||||
|
||||
/// Mark a server that starts with the bare core: the modules the core recommends are not installed on it
|
||||
/// (the owner adds modules from the Modules page). Taken into account the first time a plugin-host core
|
||||
/// arrives; after that every recommended module counts as dealt with.
|
||||
pub fn decline_recommended(realm_root: &Path) -> Result<()> {
|
||||
let body = serde_json::json!({ "schema": 1, "handled": load_handled(realm_root), "declineAll": true });
|
||||
fs::create_dir_all(plugins::meta_dir(realm_root))?;
|
||||
crate::fsx::atomic_write(&handled_path(realm_root), serde_json::to_string_pretty(&body)?.as_bytes())
|
||||
}
|
||||
|
||||
fn declined_all(realm_root: &Path) -> bool {
|
||||
fs::read(handled_path(realm_root)).ok()
|
||||
.and_then(|b| serde_json::from_slice::<serde_json::Value>(&b).ok())
|
||||
.and_then(|v| v.get("declineAll")?.as_bool())
|
||||
.unwrap_or(false)
|
||||
}
|
||||
|
||||
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);
|
||||
if declined_all(realm_root) {
|
||||
for m in &rec.modules {
|
||||
handled.entry(m.id.clone()).or_insert_with(|| "not installed: new server with the bare core".into());
|
||||
}
|
||||
save_handled(realm_root, &handled); // drops the mark: it applies to this first core only
|
||||
return Vec::new();
|
||||
}
|
||||
let mut out = Vec::new();
|
||||
for m in &rec.modules {
|
||||
let registry = plugins::load_registry(realm_root).unwrap_or_default();
|
||||
@@ -455,6 +478,25 @@ mod tests {
|
||||
assert!(!handled.contains_key("companions"));
|
||||
}
|
||||
|
||||
#[test]
|
||||
fn a_new_server_with_the_bare_core_installs_no_recommended_module() {
|
||||
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();
|
||||
decline_recommended(server).unwrap();
|
||||
// the mark is written before the plugin-host core (and its recommended.json) arrives
|
||||
fs::write(server.join("Core/plugins/recommended.json"), r#"{"schema":1,"modules":[
|
||||
{"id":"companions","repo":"not-a-repo","commit":"0000000000000000000000000000000000000000"}]}"#).unwrap();
|
||||
let out = rebuild_for_current_core(server, &|_, _| panic!("nothing is built")).unwrap();
|
||||
assert!(out.is_empty(), "{out:?}");
|
||||
assert!(load_handled(server)["companions"].contains("bare core"));
|
||||
assert!(!declined_all(server), "the mark applies to the first plugin-host core only");
|
||||
// a later core change does not bring it back either
|
||||
assert!(rebuild_for_current_core(server, &|_, _| panic!("nothing is built")).unwrap().is_empty());
|
||||
}
|
||||
|
||||
/// 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]
|
||||
|
||||
@@ -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!(
|
||||
|
||||
@@ -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()));
|
||||
}
|
||||
}
|
||||
@@ -408,7 +408,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,
|
||||
}
|
||||
@@ -430,7 +430,7 @@ pub fn plan(
|
||||
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 +626,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,
|
||||
))
|
||||
@@ -988,7 +988,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 +1080,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.",
|
||||
@@ -2381,9 +2381,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 +2610,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(
|
||||
|
||||
@@ -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"] }
|
||||
@@ -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);
|
||||
}
|
||||
}
|
||||
@@ -165,6 +165,48 @@
|
||||
"enable_key": "CoACustomRaces.Enable",
|
||||
"default_on": false
|
||||
},
|
||||
{
|
||||
"id": "subclass",
|
||||
"name": "Subclasses and Hero Races",
|
||||
"description": {
|
||||
"en": "Part of Custom Races V2: a second class for the Thin Twins and the Two-Headed Ogre, and two players sharing one character.",
|
||||
"ru": "Часть Custom Races V2: второй класс для Хрупких близнецов и Двуглавого огра и один персонаж на двух игроков.",
|
||||
"de": "Teil von Custom Races V2: eine zweite Klasse für die Dünnen Zwillinge und die Zweiköpfige Ogerin sowie zwei Spieler an einer Figur.",
|
||||
"fr": "Partie de Custom Races V2 : une seconde classe pour les Jumeaux maigres et l'Ogre à deux têtes, et deux joueurs pour un personnage.",
|
||||
"es": "Parte de Custom Races V2: una segunda clase para los Gemelos delgados y el Ogro de dos cabezas, y dos jugadores en un personaje.",
|
||||
"zh": "Custom Races V2 的一部分:为瘦弱双子和双头食人魔提供第二职业,并允许两名玩家共用一个角色。"
|
||||
},
|
||||
"repo": "https://github.com/Corfirean/azerothcore-wotlk-coa",
|
||||
"conf": "mod_subclass.conf",
|
||||
"switchable": true,
|
||||
"status": "early",
|
||||
"icon": "races",
|
||||
"enable_key": "Subclass.Enable",
|
||||
"default_on": true,
|
||||
"part_of": "custom-races",
|
||||
"hidden": true
|
||||
},
|
||||
{
|
||||
"id": "dev-menu",
|
||||
"name": "Dev Menu",
|
||||
"description": {
|
||||
"en": "Part of Custom Races V2: the in-game /dev editor for game masters (NPCs, items).",
|
||||
"ru": "Часть Custom Races V2: внутриигровой редактор /dev для гейм-мастеров (НПС, предметы).",
|
||||
"de": "Teil von Custom Races V2: der /dev-Editor im Spiel für Spielleiter (NPCs, Gegenstände).",
|
||||
"fr": "Partie de Custom Races V2 : l'éditeur /dev en jeu pour les maîtres du jeu (PNJ, objets).",
|
||||
"es": "Parte de Custom Races V2: el editor /dev del juego para los máster (PNJ, objetos).",
|
||||
"zh": "Custom Races V2 的一部分:供游戏管理员使用的游戏内 /dev 编辑器(NPC、物品)。"
|
||||
},
|
||||
"repo": "https://github.com/Corfirean/azerothcore-wotlk-coa",
|
||||
"conf": "mod_ilusixn_devmenu.conf",
|
||||
"switchable": true,
|
||||
"status": "early",
|
||||
"icon": "sparkles",
|
||||
"enable_key": "DevMenu.Enable",
|
||||
"default_on": true,
|
||||
"part_of": "custom-races",
|
||||
"hidden": true
|
||||
},
|
||||
{
|
||||
"id": "time-is-time",
|
||||
"name": "TimeIsTime",
|
||||
|
||||
Generated
+2
-2
@@ -1,12 +1,12 @@
|
||||
{
|
||||
"name": "coa-server-manager",
|
||||
"version": "0.9.9",
|
||||
"version": "0.9.15",
|
||||
"lockfileVersion": 3,
|
||||
"requires": true,
|
||||
"packages": {
|
||||
"": {
|
||||
"name": "coa-server-manager",
|
||||
"version": "0.9.9",
|
||||
"version": "0.9.15",
|
||||
"dependencies": {
|
||||
"@tauri-apps/api": "^2.12.0",
|
||||
"@tauri-apps/plugin-dialog": "^2.8.0",
|
||||
|
||||
+1
-1
@@ -1,7 +1,7 @@
|
||||
{
|
||||
"name": "coa-server-manager",
|
||||
"private": true,
|
||||
"version": "0.9.9",
|
||||
"version": "0.9.15",
|
||||
"license": "AGPL-3.0-only",
|
||||
"type": "module",
|
||||
"scripts": {
|
||||
|
||||
@@ -34,6 +34,10 @@
|
||||
"id": "dungeon",
|
||||
"title": "Dungeon Finder"
|
||||
},
|
||||
{
|
||||
"id": "scaling",
|
||||
"title": "Bot Strength"
|
||||
},
|
||||
{
|
||||
"id": "battlegrounds",
|
||||
"title": "Battlegrounds"
|
||||
@@ -643,6 +647,128 @@
|
||||
"restartRequired": "world",
|
||||
"dangerous": true
|
||||
},
|
||||
{
|
||||
"key": "CoaBots.Scaling.Enable",
|
||||
"type": "bool",
|
||||
"category": "scaling",
|
||||
"title": "Help bots in group content",
|
||||
"description": "Applies the multipliers below to bots, their pets and totems. With every multiplier at 1 nothing changes.",
|
||||
"default": true,
|
||||
"advanced": false,
|
||||
"restartRequired": "world",
|
||||
"dangerous": false
|
||||
},
|
||||
{
|
||||
"key": "CoaBots.Scaling.Dungeons",
|
||||
"type": "bool",
|
||||
"category": "scaling",
|
||||
"title": "In dungeons",
|
||||
"description": "Apply the multipliers in 5-player dungeons.",
|
||||
"default": true,
|
||||
"advanced": false,
|
||||
"restartRequired": "world",
|
||||
"dangerous": false
|
||||
},
|
||||
{
|
||||
"key": "CoaBots.Scaling.Raids",
|
||||
"type": "bool",
|
||||
"category": "scaling",
|
||||
"title": "In raids",
|
||||
"description": "Apply the multipliers in raids.",
|
||||
"default": true,
|
||||
"advanced": false,
|
||||
"restartRequired": "world",
|
||||
"dangerous": false
|
||||
},
|
||||
{
|
||||
"key": "CoaBots.Scaling.Battlegrounds",
|
||||
"type": "bool",
|
||||
"category": "scaling",
|
||||
"title": "In battlegrounds and arenas",
|
||||
"description": "Apply the multipliers in battlegrounds and arenas, against creatures only.",
|
||||
"default": false,
|
||||
"advanced": false,
|
||||
"restartRequired": "world",
|
||||
"dangerous": false
|
||||
},
|
||||
{
|
||||
"key": "CoaBots.Scaling.World",
|
||||
"type": "bool",
|
||||
"category": "scaling",
|
||||
"title": "In the open world",
|
||||
"description": "Apply the multipliers outside instances.",
|
||||
"default": false,
|
||||
"advanced": false,
|
||||
"restartRequired": "world",
|
||||
"dangerous": false
|
||||
},
|
||||
{
|
||||
"key": "CoaBots.Scaling.DamageDone",
|
||||
"type": "float",
|
||||
"category": "scaling",
|
||||
"title": "Bot damage",
|
||||
"description": "Damage bots deal to monsters. 1 is normal, 1.5 is half as much again.",
|
||||
"default": 1.0,
|
||||
"advanced": false,
|
||||
"restartRequired": "world",
|
||||
"dangerous": false,
|
||||
"min": 0.1,
|
||||
"max": 10,
|
||||
"unit": "x"
|
||||
},
|
||||
{
|
||||
"key": "CoaBots.Scaling.HealingDone",
|
||||
"type": "float",
|
||||
"category": "scaling",
|
||||
"title": "Bot healing",
|
||||
"description": "Healing bots cast. 1 is normal.",
|
||||
"default": 1.0,
|
||||
"advanced": false,
|
||||
"restartRequired": "world",
|
||||
"dangerous": false,
|
||||
"min": 0.1,
|
||||
"max": 10,
|
||||
"unit": "x"
|
||||
},
|
||||
{
|
||||
"key": "CoaBots.Scaling.DamageTaken",
|
||||
"type": "float",
|
||||
"category": "scaling",
|
||||
"title": "Damage bots take",
|
||||
"description": "Damage monsters deal to bots. Below 1 bots take less; 0.7 means 30% less.",
|
||||
"default": 1.0,
|
||||
"advanced": false,
|
||||
"restartRequired": "world",
|
||||
"dangerous": false,
|
||||
"min": 0.1,
|
||||
"max": 10,
|
||||
"unit": "x"
|
||||
},
|
||||
{
|
||||
"key": "CoaBots.Scaling.TankThreat",
|
||||
"type": "float",
|
||||
"category": "scaling",
|
||||
"title": "Bot tank threat",
|
||||
"description": "Threat a bot tank generates, so monsters stay on it. 1 is normal.",
|
||||
"default": 1.0,
|
||||
"advanced": false,
|
||||
"restartRequired": "world",
|
||||
"dangerous": false,
|
||||
"min": 1,
|
||||
"max": 10,
|
||||
"unit": "x"
|
||||
},
|
||||
{
|
||||
"key": "CoaBots.Scaling.BossTuning",
|
||||
"type": "bool",
|
||||
"category": "scaling",
|
||||
"title": "Extra help against a few hard bosses",
|
||||
"description": "Stronger multipliers for Loken, Drakkari Elemental, Drakkari Colossus and Gal'darah, which level 60 bots could not beat otherwise.",
|
||||
"default": false,
|
||||
"advanced": true,
|
||||
"restartRequired": "world",
|
||||
"dangerous": false
|
||||
},
|
||||
{
|
||||
"key": "CoaBots.BGFill.Enable",
|
||||
"type": "bool",
|
||||
|
||||
@@ -18,9 +18,11 @@ tauri-plugin-updater = "2"
|
||||
tauri-plugin-process = "2"
|
||||
tauri-plugin-single-instance = "2"
|
||||
tauri-plugin-opener = "2"
|
||||
tauri-plugin-window-state = "2"
|
||||
serde = { version = "1", features = ["derive"] }
|
||||
serde_json = "1"
|
||||
coa-core = { path = "../crates/coa-core" }
|
||||
coa-registry-proto = { path = "../crates/coa-registry-proto" }
|
||||
coa-control-proto = { path = "../crates/coa-control-proto" }
|
||||
tracing = "0.1"
|
||||
uuid = { version = "1", features = ["v4"] }
|
||||
@@ -439,6 +439,7 @@ pub(crate) async fn join_realm(
|
||||
let mut profile = coa_core::remote_client::load(&dir)
|
||||
.map_err(|e| fail("other", e.to_string()))?;
|
||||
profile.host = host;
|
||||
profile.realm = Some(realm.clone());
|
||||
coa_core::remote_client::save(&dir, &profile)
|
||||
.map_err(|e| fail("launch", e.to_string()))?;
|
||||
super::play(state, REMOTE_CLIENT_ID.to_string())
|
||||
|
||||
+625
-139
File diff suppressed because it is too large.
Load diff
@@ -11,3 +11,15 @@ pub fn close_to_tray(dir: &Path) -> coa_core::Result<bool> {
|
||||
pub fn save(dir: &Path, enabled: bool) -> coa_core::Result<()> {
|
||||
coa_core::fsx::atomic_write_json(&dir.join("close-to-tray.json"), &enabled)
|
||||
}
|
||||
|
||||
/// Clear the game's cache of server data before every Play (on unless the player turned it off).
|
||||
pub fn clear_cache_on_play(dir: &Path) -> bool {
|
||||
std::fs::read(dir.join("clear-game-cache.json"))
|
||||
.ok()
|
||||
.and_then(|bytes| serde_json::from_slice(&bytes).ok())
|
||||
.unwrap_or(true)
|
||||
}
|
||||
|
||||
pub fn save_clear_cache_on_play(dir: &Path, enabled: bool) -> coa_core::Result<()> {
|
||||
coa_core::fsx::atomic_write_json(&dir.join("clear-game-cache.json"), &enabled)
|
||||
}
|
||||
@@ -1,7 +1,7 @@
|
||||
{
|
||||
"$schema": "https://schema.tauri.app/config/2",
|
||||
"productName": "CSM Modules Preview",
|
||||
"version": "0.9.9",
|
||||
"version": "0.9.15",
|
||||
"identifier": "com.corfirean.csm-modules-preview",
|
||||
"build": {
|
||||
"beforeBuildCommand": "npm run build",
|
||||
|
||||
+20
-1
@@ -19,6 +19,10 @@ function Main() {
|
||||
const [servers, setServers] = useState<ServerSummary[] | null>(null);
|
||||
const [view, setView] = useState<View>(initialView);
|
||||
const [activeId, setActiveId] = useState<string | null>(null);
|
||||
// A classic server the owner chose: the install screen makes a modular copy of it next to it.
|
||||
const [copyFrom, setCopyFrom] = useState<string | null>(null);
|
||||
// Where Cancel on that install screen goes back to: the import screen or the server's own pages.
|
||||
const [copyBack, setCopyBack] = useState<View>("import");
|
||||
|
||||
const refresh = useCallback(async () => {
|
||||
const list = await api.list().catch(() => []);
|
||||
@@ -44,6 +48,11 @@ function Main() {
|
||||
activeId={activeId}
|
||||
onSelect={setActiveId}
|
||||
onAddAnother={() => setView("add")}
|
||||
onCopy={(path) => {
|
||||
setCopyFrom(path);
|
||||
setCopyBack("welcome");
|
||||
setView("install");
|
||||
}}
|
||||
onForget={async (id) => {
|
||||
await api.forget(id);
|
||||
await refresh();
|
||||
@@ -56,8 +65,13 @@ function Main() {
|
||||
return (
|
||||
<InstallServer
|
||||
canCancel
|
||||
onCancel={() => setView(servers.length > 0 ? "add" : "welcome")}
|
||||
copyFrom={copyFrom ?? undefined}
|
||||
onCancel={() => {
|
||||
setView(copyFrom ? copyBack : servers.length > 0 ? "add" : "welcome");
|
||||
setCopyFrom(null);
|
||||
}}
|
||||
onDone={async (s) => {
|
||||
setCopyFrom(null);
|
||||
await refresh();
|
||||
setActiveId(s.id);
|
||||
setView("welcome");
|
||||
@@ -76,6 +90,11 @@ function Main() {
|
||||
setActiveId(s.id);
|
||||
setView("welcome");
|
||||
}}
|
||||
onCopy={(path) => {
|
||||
setCopyFrom(path);
|
||||
setCopyBack("import");
|
||||
setView("install");
|
||||
}}
|
||||
/>
|
||||
);
|
||||
}
|
||||
|
||||
Loaded 100 of 136 files, more files were not shown because too many files have changed in this diff.
Show more
Reference in new issue
Block a user