mirror of
https://github.com/Corfirean/coa-server-manager.git
synced 2026-11-19 11:25:56 +00:00
Compare commits
| Author | SHA1 | Date | |
|---|---|---|---|
|
|
1f64da3ae0 | ||
|
|
1aec8e5394 | ||
|
|
326a4fe3d3 | ||
|
|
f9839ba369 | ||
|
|
e951eb134b | ||
|
|
6cbf007d72 | ||
|
|
07e9bc497d | ||
|
|
e4edb7cbdd | ||
|
|
ca2514c790 | ||
|
|
69c9938aba | ||
|
|
2fd42f2acd | ||
|
|
05630ec9eb | ||
|
|
d64fdb51be | ||
|
|
260d10b729 | ||
|
|
20657df203 | ||
|
|
f08ae1c76b | ||
|
|
4fc133c35e | ||
|
|
de38e60444 | ||
|
|
3c26004e04 | ||
|
|
d1534ebc92 | ||
|
|
20d4c3351e | ||
|
|
8a313b83b8 | ||
|
|
7eea72c415 | ||
|
|
e8ffa6efe3 | ||
|
|
baeecd2ddf | ||
|
|
d352731280 | ||
|
|
a0545286ee | ||
|
|
6f8ed793a7 | ||
|
|
b3c88ce2a6 | ||
|
|
d71c5635e3 | ||
|
|
755761d0de | ||
|
|
550e475962 | ||
|
|
2e6fcceb05 | ||
|
|
abcc816581 | ||
|
|
8353b791fb | ||
|
|
b81227b0ea | ||
|
|
a9fb982ab0 | ||
|
|
a822bfc99b | ||
|
|
1211de5a77 | ||
|
|
ee36692db7 | ||
|
|
ee43522019 | ||
|
|
b4dc30b84a | ||
|
|
73a6cca753 | ||
|
|
705bee7d56 | ||
|
|
5aa9b32283 | ||
|
|
711f378ae8 | ||
|
|
c29d56e2b3 | ||
|
|
d63e85bb18 | ||
|
|
c513649beb | ||
|
|
d2e6fef188 | ||
|
|
2224afd2ea | ||
|
|
3a5558f388 | ||
|
|
173248efbe | ||
|
|
5697a1d36e | ||
|
|
bc62ae206f | ||
|
|
076fba185c | ||
|
|
23cbb108ad | ||
|
|
1a1976d9ad | ||
|
|
dc3fcab7e1 | ||
|
|
ba5816e3ae | ||
|
|
56faaa3a2a | ||
|
|
35084dbce8 | ||
|
|
7e7216979a | ||
|
|
7c0c4cda1f | ||
|
|
642da8fdc1 | ||
|
|
30d2f56997 | ||
|
|
4d1a6e0b21 | ||
|
|
bda38b9f26 | ||
|
|
c004b90c54 | ||
|
|
d44e00f9ad | ||
|
|
dad10d8a5d | ||
|
|
b33821e7eb | ||
|
|
1288a84da2 | ||
|
|
e7b76137d1 | ||
|
|
7bb0ea9472 | ||
|
|
1dab6154c7 | ||
|
|
06a6302732 | ||
|
|
65631450ff | ||
|
|
a8ab201d7d | ||
|
|
733d73ef76 | ||
|
|
5525325160 |
No files matched your search
@@ -26,5 +26,4 @@ jobs:
|
|||||||
- run: node tools/check-i18n.mjs
|
- run: node tools/check-i18n.mjs
|
||||||
- run: npm run build
|
- run: npm run build
|
||||||
- run: node --experimental-strip-types --test tools/*.test.mjs
|
- 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
|
- run: cargo test --workspace --locked
|
||||||
@@ -69,10 +69,11 @@ jobs:
|
|||||||
with:
|
with:
|
||||||
node-version: 22
|
node-version: 22
|
||||||
- run: npm ci
|
- run: npm ci
|
||||||
|
# tauri::generate_context! needs ../dist; without a warm target cache the tests do not compile without it.
|
||||||
|
- run: npm run build
|
||||||
- name: Tests
|
- name: Tests
|
||||||
run: cargo test --workspace --locked -- --test-threads=1
|
run: cargo test --workspace --locked -- --test-threads=1
|
||||||
- run: node --experimental-strip-types --test tools/*.test.mjs
|
- 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)
|
- name: Build and sign (publish only when requested)
|
||||||
id: tauri
|
id: tauri
|
||||||
uses: tauri-apps/tauri-action@v0
|
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
|
||||||
@@ -35,6 +35,16 @@ Every published Manager version, including a clearly marked Pre-release, belongs
|
|||||||
CHANGELOG.md and changelog/history.json. Its GitHub release notes use the same reviewed record.
|
CHANGELOG.md and changelog/history.json. Its GitHub release notes use the same reviewed record.
|
||||||
Promotion updates that entry without duplicating it; Manager and server histories remain separate.
|
Promotion updates that entry without duplicating it; Manager and server histories remain separate.
|
||||||
|
|
||||||
|
Translated release notes are a required preparation step before freezing a new Manager source. Follow the
|
||||||
|
runbook's "Mandatory translated release notes during preparation" checklist: translate every new reviewed
|
||||||
|
Manager/server note into Russian, German, French, Spanish and Simplified Chinese in
|
||||||
|
`src/data/latest-note-translations.json`, keyed by exact canonical English text. Preserve existing translations
|
||||||
|
and released fragments. Refresh the bundled server-history snapshot from a pinned canonical commit and record
|
||||||
|
its provenance. Run `node --test tools/release-history.test.mjs`, `node tools/check-i18n.mjs` and `npm run build`;
|
||||||
|
verify each new record, all six viewer languages, English fallback and offline use. Save source/version and checks
|
||||||
|
in the handoff. Translations ship with Manager: a server-only release must record the carrying Manager version or
|
||||||
|
pending translation delivery, without forcing another Manager release or changing already signed installers.
|
||||||
|
|
||||||
Before preparing or publishing a Manager/server release, read the maintained
|
Before preparing or publishing a Manager/server release, read the maintained
|
||||||
[release runbook](https://github.com/Corfirean/coa-server-build/blob/main/docs/server-release.md)
|
[release runbook](https://github.com/Corfirean/coa-server-build/blob/main/docs/server-release.md)
|
||||||
and [build agent instructions](https://github.com/Corfirean/coa-server-build/blob/main/AGENTS.md).
|
and [build agent instructions](https://github.com/Corfirean/coa-server-build/blob/main/AGENTS.md).
|
||||||
|
|||||||
@@ -8,6 +8,90 @@ 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.
|
Dates follow GitHub publication (UTC); legacy records retain their archived dates. Newest releases first.
|
||||||
|
|
||||||
|
## 0.9.13 — 2026-11-15
|
||||||
|
|
||||||
|
- The custom races client is updated to Custom Races V2.
|
||||||
|
|
||||||
|
[Release](https://github.com/Corfirean/coa-server-manager/releases/tag/v0.9.13) · [Source changes](https://github.com/Corfirean/coa-server-manager/compare/v0.9.12...v0.9.13)
|
||||||
|
|
||||||
|
## 0.9.12 — 2026-11-14
|
||||||
|
|
||||||
|
- Settings for how much help bots get in dungeons and raids.
|
||||||
|
|
||||||
|
[Release](https://github.com/Corfirean/coa-server-manager/releases/tag/v0.9.12) · [Source changes](https://github.com/Corfirean/coa-server-manager/compare/v0.9.10...v0.9.12)
|
||||||
|
|
||||||
|
## 0.9.10 — 2026-11-08
|
||||||
|
|
||||||
|
- Custom Races patch installation recovers from interrupted downloads.
|
||||||
|
|
||||||
|
[Release](https://github.com/Corfirean/coa-server-manager/releases/tag/v0.9.10) · [Source changes](https://github.com/Corfirean/coa-server-manager/compare/v0.9.9...v0.9.10)
|
||||||
|
|
||||||
|
## 0.9.9 — 2026-11-04
|
||||||
|
|
||||||
|
- Update and recovery checks use the temporary login port even with a Windows override.
|
||||||
|
|
||||||
|
[Release](https://github.com/Corfirean/coa-server-manager/releases/tag/v0.9.9) · [Source changes](https://github.com/Corfirean/coa-server-manager/compare/v0.9.8...v0.9.9)
|
||||||
|
|
||||||
|
## 0.9.8 — 2026-11-01
|
||||||
|
|
||||||
|
- Dungeon Clear can be enabled when SQUID bots are active.
|
||||||
|
- Diagnostic exports include launcher stages and lock owner records.
|
||||||
|
- Choose normal logs, errors only or no server logs in maintenance settings.
|
||||||
|
- Update checks temporarily suspend bot population and restore your configuration.
|
||||||
|
- Update validation keeps MySQL running between compatible checks.
|
||||||
|
|
||||||
|
[Release](https://github.com/Corfirean/coa-server-manager/releases/tag/v0.9.8) · [Source changes](https://github.com/Corfirean/coa-server-manager/compare/v0.9.7...v0.9.8)
|
||||||
|
|
||||||
|
## 0.9.7 — 2026-10-30
|
||||||
|
|
||||||
|
- Show available update notes even when release history is cached.
|
||||||
|
|
||||||
|
[Release](https://github.com/Corfirean/coa-server-manager/releases/tag/v0.9.7) · [Source changes](https://github.com/Corfirean/coa-server-manager/compare/v0.9.5...v0.9.7)
|
||||||
|
|
||||||
|
## 0.9.5 — 2026-10-30
|
||||||
|
|
||||||
|
- Account creation verifies a lost console reply against the requested login.
|
||||||
|
- Abandoned game relay tunnels close their local connection immediately.
|
||||||
|
- Keep disabled graphics components disabled during client updates.
|
||||||
|
- Force-stop an unresponsive world after a failed normal shutdown.
|
||||||
|
- Crash history includes reports from every world and Windows text files.
|
||||||
|
- Show the online bot count for Playerbots on the overview.
|
||||||
|
- Disable public server browsing in Settings.
|
||||||
|
- Keep deliberate stops and update shutdowns from triggering crash restart.
|
||||||
|
- Server startup waits for a responsive console before reporting success.
|
||||||
|
- Restore the existing Manager window when launching it again.
|
||||||
|
|
||||||
|
[Release](https://github.com/Corfirean/coa-server-manager/releases/tag/v0.9.5) · [Source changes](https://github.com/Corfirean/coa-server-manager/compare/v0.9.4...v0.9.5)
|
||||||
|
|
||||||
|
## 0.9.4 — 2026-10-29
|
||||||
|
|
||||||
|
**Portable Characters are experimental and may contain bugs.**
|
||||||
|
|
||||||
|
- Settings group updates, startup and maintenance with translated release history.
|
||||||
|
- Update and launch without updating share a divided button.
|
||||||
|
- Maximizing the window keeps text and controls at a comfortable size.
|
||||||
|
|
||||||
|
[Release](https://github.com/Corfirean/coa-server-manager/releases/tag/v0.9.4) · [Source changes](https://github.com/Corfirean/coa-server-manager/compare/v0.9.3...v0.9.4)
|
||||||
|
|
||||||
|
## 0.9.3 — 2026-10-29
|
||||||
|
|
||||||
|
**Portable Characters are experimental and may contain bugs.**
|
||||||
|
|
||||||
|
- Slow server startup no longer triggers an early update rollback.
|
||||||
|
|
||||||
|
[Release](https://github.com/Corfirean/coa-server-manager/releases/tag/v0.9.3) · [Source changes](https://github.com/Corfirean/coa-server-manager/compare/v0.9.2...v0.9.3)
|
||||||
|
|
||||||
|
## 0.9.2 — 2026-10-28
|
||||||
|
|
||||||
|
**Portable Characters are experimental and may contain bugs.**
|
||||||
|
|
||||||
|
- New server installation waits for slower database startup.
|
||||||
|
- Find and edit CoA options in the existing server settings.
|
||||||
|
- Simultaneous update checks share results or wait their turn.
|
||||||
|
- Recovery can stop an unfinished world startup after restoring an older launcher.
|
||||||
|
|
||||||
|
[Release](https://github.com/Corfirean/coa-server-manager/releases/tag/v0.9.2) · [Source changes](https://github.com/Corfirean/coa-server-manager/compare/v0.9.1...v0.9.2)
|
||||||
|
|
||||||
## 0.9.1 — 2026-10-28
|
## 0.9.1 — 2026-10-28
|
||||||
|
|
||||||
**Portable Characters are experimental and may contain bugs.**
|
**Portable Characters are experimental and may contain bugs.**
|
||||||
|
|||||||
Generated
+31
-3
@@ -586,7 +586,7 @@ dependencies = [
|
|||||||
|
|
||||||
[[package]]
|
[[package]]
|
||||||
name = "coa-core"
|
name = "coa-core"
|
||||||
version = "0.9.2"
|
version = "0.9.14"
|
||||||
dependencies = [
|
dependencies = [
|
||||||
"base64 0.22.1",
|
"base64 0.22.1",
|
||||||
"chrono",
|
"chrono",
|
||||||
@@ -606,6 +606,7 @@ dependencies = [
|
|||||||
"serde_json",
|
"serde_json",
|
||||||
"sha1",
|
"sha1",
|
||||||
"sha2",
|
"sha2",
|
||||||
|
"socket2",
|
||||||
"tar",
|
"tar",
|
||||||
"tempfile",
|
"tempfile",
|
||||||
"thiserror 2.0.21",
|
"thiserror 2.0.21",
|
||||||
@@ -618,6 +619,15 @@ dependencies = [
|
|||||||
"zstd",
|
"zstd",
|
||||||
]
|
]
|
||||||
|
|
||||||
|
[[package]]
|
||||||
|
name = "coa-launcher"
|
||||||
|
version = "0.9.14"
|
||||||
|
dependencies = [
|
||||||
|
"coa-core",
|
||||||
|
"serde_json",
|
||||||
|
"windows-sys 0.60.2",
|
||||||
|
]
|
||||||
|
|
||||||
[[package]]
|
[[package]]
|
||||||
name = "coa-registry-proto"
|
name = "coa-registry-proto"
|
||||||
version = "0.1.0"
|
version = "0.1.0"
|
||||||
@@ -634,7 +644,7 @@ dependencies = [
|
|||||||
|
|
||||||
[[package]]
|
[[package]]
|
||||||
name = "coa-release"
|
name = "coa-release"
|
||||||
version = "0.9.2"
|
version = "0.9.14"
|
||||||
dependencies = [
|
dependencies = [
|
||||||
"chrono",
|
"chrono",
|
||||||
"coa-core",
|
"coa-core",
|
||||||
@@ -643,7 +653,7 @@ dependencies = [
|
|||||||
|
|
||||||
[[package]]
|
[[package]]
|
||||||
name = "coa-server-manager"
|
name = "coa-server-manager"
|
||||||
version = "0.9.2"
|
version = "0.9.14"
|
||||||
dependencies = [
|
dependencies = [
|
||||||
"coa-control-proto",
|
"coa-control-proto",
|
||||||
"coa-core",
|
"coa-core",
|
||||||
@@ -655,8 +665,10 @@ dependencies = [
|
|||||||
"tauri-plugin-dialog",
|
"tauri-plugin-dialog",
|
||||||
"tauri-plugin-opener",
|
"tauri-plugin-opener",
|
||||||
"tauri-plugin-process",
|
"tauri-plugin-process",
|
||||||
|
"tauri-plugin-single-instance",
|
||||||
"tauri-plugin-updater",
|
"tauri-plugin-updater",
|
||||||
"tracing",
|
"tracing",
|
||||||
|
"uuid",
|
||||||
]
|
]
|
||||||
|
|
||||||
[[package]]
|
[[package]]
|
||||||
@@ -4606,6 +4618,22 @@ dependencies = [
|
|||||||
"tauri-plugin",
|
"tauri-plugin",
|
||||||
]
|
]
|
||||||
|
|
||||||
|
[[package]]
|
||||||
|
name = "tauri-plugin-single-instance"
|
||||||
|
version = "2.5.5"
|
||||||
|
source = "registry+https://github.com/rust-lang/crates.io-index"
|
||||||
|
checksum = "726b6da0dd5bd1344f84f4108a622c07d01923baacb5c803a605189672c5352f"
|
||||||
|
dependencies = [
|
||||||
|
"serde",
|
||||||
|
"serde_json",
|
||||||
|
"tauri",
|
||||||
|
"thiserror 2.0.21",
|
||||||
|
"tokio",
|
||||||
|
"tracing",
|
||||||
|
"windows-sys 0.61.2",
|
||||||
|
"zbus",
|
||||||
|
]
|
||||||
|
|
||||||
[[package]]
|
[[package]]
|
||||||
name = "tauri-plugin-updater"
|
name = "tauri-plugin-updater"
|
||||||
version = "2.13.1"
|
version = "2.13.1"
|
||||||
|
|||||||
+2
-2
@@ -1,10 +1,10 @@
|
|||||||
[workspace]
|
[workspace]
|
||||||
resolver = "2"
|
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"]
|
exclude = ["services/coa-registry", "services/coa-registry-e2e", "services/coa-coordinator", "services/coa-relay"]
|
||||||
|
|
||||||
[workspace.package]
|
[workspace.package]
|
||||||
version = "0.9.2"
|
version = "0.9.14"
|
||||||
edition = "2021"
|
edition = "2021"
|
||||||
license = "AGPL-3.0-only"
|
license = "AGPL-3.0-only"
|
||||||
|
|
||||||
|
|||||||
+7247
File diff suppressed because it is too large.
Load diff
@@ -0,0 +1,7 @@
|
|||||||
|
---
|
||||||
|
area: manager
|
||||||
|
type: changed
|
||||||
|
audience: admins
|
||||||
|
title: Settings group updates, startup and maintenance with translated release history
|
||||||
|
---
|
||||||
|
Server and Manager keep separate update controls. Read their published changes in one place, including translations of the latest releases in all six interface languages. Saved notes remain available offline. Find public realm controls under Play with friends.
|
||||||
@@ -0,0 +1,7 @@
|
|||||||
|
---
|
||||||
|
area: manager
|
||||||
|
type: changed
|
||||||
|
audience: admins
|
||||||
|
title: Update and launch without updating share a divided button
|
||||||
|
---
|
||||||
|
Server and game client actions each use two adjacent segments of equal height. Both actions remain visible and keep their own availability checks.
|
||||||
@@ -0,0 +1,7 @@
|
|||||||
|
---
|
||||||
|
area: manager
|
||||||
|
type: fixed
|
||||||
|
audience: admins
|
||||||
|
title: Maximizing the window keeps text and controls at a comfortable size
|
||||||
|
---
|
||||||
|
The interface no longer enlarges with window width. System display scaling and browser zoom still work, and large action buttons use more compact spacing.
|
||||||
@@ -0,0 +1,7 @@
|
|||||||
|
---
|
||||||
|
area: manager
|
||||||
|
type: fixed
|
||||||
|
audience: admins
|
||||||
|
title: Slow server startup no longer triggers an early update rollback
|
||||||
|
---
|
||||||
|
World startup now allows up to 25 minutes with either bot system and waits for both game and console ports within one deadline. Servers that stop during startup still fail immediately.
|
||||||
@@ -0,0 +1,7 @@
|
|||||||
|
---
|
||||||
|
area: manager
|
||||||
|
type: fixed
|
||||||
|
audience: admins
|
||||||
|
title: Account creation verifies a lost console reply against the requested login
|
||||||
|
---
|
||||||
|
Confirm the requested credentials after a lost reply, block creation during another server action, and explicitly report accounts whose administrator access could not be confirmed.
|
||||||
@@ -0,0 +1,7 @@
|
|||||||
|
---
|
||||||
|
area: manager
|
||||||
|
type: fixed
|
||||||
|
audience: admins
|
||||||
|
title: Abandoned game relay tunnels close their local connection immediately
|
||||||
|
---
|
||||||
|
Dropping a tunnel shuts down its shared socket directly instead of relying only on a background message, releasing its local read and write connection.
|
||||||
@@ -0,0 +1,7 @@
|
|||||||
|
---
|
||||||
|
area: manager
|
||||||
|
type: fixed
|
||||||
|
audience: admins
|
||||||
|
title: Keep disabled graphics components disabled during client updates
|
||||||
|
---
|
||||||
|
Client settings can disable DXVK and graphics enhancements. Existing launcher DISABLED files are respected.
|
||||||
@@ -0,0 +1,7 @@
|
|||||||
|
---
|
||||||
|
area: manager
|
||||||
|
type: added
|
||||||
|
audience: admins
|
||||||
|
title: Force-stop an unresponsive world after a failed normal shutdown
|
||||||
|
---
|
||||||
|
Confirm the risk of unsaved progress before stopping verified server processes. Shared databases stay running until every owned world has stopped.
|
||||||
@@ -0,0 +1,7 @@
|
|||||||
|
---
|
||||||
|
area: manager
|
||||||
|
type: fixed
|
||||||
|
audience: admins
|
||||||
|
title: Crash history includes reports from every world and Windows text files
|
||||||
|
---
|
||||||
|
Create and verify the crash report folder before native startup, and include reports from simultaneous worlds and files containing Windows ANSI text.
|
||||||
@@ -0,0 +1,7 @@
|
|||||||
|
---
|
||||||
|
area: manager
|
||||||
|
type: fixed
|
||||||
|
audience: admins
|
||||||
|
title: Show the online bot count for Playerbots on the overview
|
||||||
|
---
|
||||||
|
The overview displays bot population for both supported bot systems.
|
||||||
@@ -0,0 +1,7 @@
|
|||||||
|
---
|
||||||
|
area: manager
|
||||||
|
type: added
|
||||||
|
audience: admins
|
||||||
|
title: Disable public server browsing in Settings
|
||||||
|
---
|
||||||
|
Turn off public server browsing to block catalog list and detail requests. When browsing is enabled, load the list with Refresh.
|
||||||
@@ -0,0 +1,7 @@
|
|||||||
|
---
|
||||||
|
area: manager
|
||||||
|
type: fixed
|
||||||
|
audience: admins
|
||||||
|
title: Keep deliberate stops and update shutdowns from triggering crash restart
|
||||||
|
---
|
||||||
|
Status checks no longer forget a stop request while the world is still shutting down. Update validation and recovery do not trigger automatic crash restarts.
|
||||||
@@ -0,0 +1,7 @@
|
|||||||
|
---
|
||||||
|
area: manager
|
||||||
|
type: fixed
|
||||||
|
audience: admins
|
||||||
|
title: Show available update notes even when release history is cached
|
||||||
|
---
|
||||||
|
Fetch the release notes for the offered update when they are missing from the cached history, including when an update becomes available while the history is open.
|
||||||
@@ -0,0 +1,7 @@
|
|||||||
|
---
|
||||||
|
area: manager
|
||||||
|
type: fixed
|
||||||
|
audience: admins
|
||||||
|
title: Server startup waits for a responsive console before reporting success
|
||||||
|
---
|
||||||
|
An open port no longer marks a loading world as ready. Account creation checks that the console processes commands before sending a create request.
|
||||||
@@ -0,0 +1,7 @@
|
|||||||
|
---
|
||||||
|
area: manager
|
||||||
|
type: fixed
|
||||||
|
audience: admins
|
||||||
|
title: Restore the existing Manager window when launching it again
|
||||||
|
---
|
||||||
|
Choose whether closing the window exits the Manager or minimizes it to the tray. Tray actions restore the window on the UI thread.
|
||||||
@@ -0,0 +1,7 @@
|
|||||||
|
---
|
||||||
|
area: manager
|
||||||
|
type: added
|
||||||
|
audience: admins
|
||||||
|
title: Dungeon Clear can be enabled when SQUID bots are active
|
||||||
|
---
|
||||||
|
Dungeon Clear starts disabled. Switching SQUID bots off also switches Dungeon Clear off; enabling SQUID again leaves Dungeon Clear off until you choose to enable it.
|
||||||
@@ -0,0 +1,7 @@
|
|||||||
|
---
|
||||||
|
area: manager
|
||||||
|
type: added
|
||||||
|
audience: admins
|
||||||
|
title: Diagnostic exports include launcher stages and lock owner records
|
||||||
|
---
|
||||||
|
Support packages include recent launcher diagnostics for each realm, with sensitive fields removed. Recorded lock owners help diagnose overlapping startup and shutdown actions.
|
||||||
@@ -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.
|
||||||
@@ -0,0 +1,7 @@
|
|||||||
|
---
|
||||||
|
area: manager
|
||||||
|
type: added
|
||||||
|
audience: admins
|
||||||
|
title: Choose normal logs, errors only or no server logs in maintenance settings
|
||||||
|
---
|
||||||
|
The logging preset updates both the game world and login server, including their configuration templates. Previous settings are saved in configuration snapshots. Restart the server to apply the change.
|
||||||
@@ -0,0 +1,7 @@
|
|||||||
|
---
|
||||||
|
area: manager
|
||||||
|
type: fixed
|
||||||
|
audience: admins
|
||||||
|
title: Update checks temporarily suspend bot population and restore your configuration
|
||||||
|
---
|
||||||
|
Validation preserves the selected bot system and its population limits. Original configuration files are restored after validation, including recovery from interrupted updates.
|
||||||
@@ -0,0 +1,7 @@
|
|||||||
|
---
|
||||||
|
area: manager
|
||||||
|
type: fixed
|
||||||
|
audience: admins
|
||||||
|
title: Update validation keeps MySQL running between compatible checks
|
||||||
|
---
|
||||||
|
Database checks and the temporary server startup share one MySQL session. The server still stops before files or database snapshots are replaced or restored.
|
||||||
@@ -0,0 +1,6 @@
|
|||||||
|
---
|
||||||
|
area: manager
|
||||||
|
type: fixed
|
||||||
|
audience: admins
|
||||||
|
title: Update and recovery checks use the temporary login port even with a Windows override
|
||||||
|
---
|
||||||
@@ -0,0 +1,7 @@
|
|||||||
|
---
|
||||||
|
area: manager
|
||||||
|
type: added
|
||||||
|
audience: admins
|
||||||
|
title: Settings for how much help bots get in dungeons and raids
|
||||||
|
---
|
||||||
|
Bot damage, healing, damage taken and tank threat can now be tuned under Bots, Combat. Everything defaults to 1 (no change); a switch turns the extra help for four hard bosses on.
|
||||||
@@ -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.
|
||||||
+166
-1
@@ -149,8 +149,36 @@
|
|||||||
"Corfirean/coa-server-manager:20261027-skill-gain-controls.md",
|
"Corfirean/coa-server-manager:20261027-skill-gain-controls.md",
|
||||||
"Corfirean/coa-server-manager:20261027-start-checks-the-realm-class-setting.md",
|
"Corfirean/coa-server-manager:20261027-start-checks-the-realm-class-setting.md",
|
||||||
"Corfirean/coa-server-manager:20261027-start-wildcard-and-reborn-with-coa.md",
|
"Corfirean/coa-server-manager:20261027-start-wildcard-and-reborn-with-coa.md",
|
||||||
|
"Corfirean/coa-server-manager:20261028-coa-config-search.md",
|
||||||
"Corfirean/coa-server-manager:20261028-existing-character-update-validation.md",
|
"Corfirean/coa-server-manager:20261028-existing-character-update-validation.md",
|
||||||
"Corfirean/coa-server-manager:20261028-portable-settings-and-tray.md"
|
"Corfirean/coa-server-manager:20261028-legacy-world-shutdown.md",
|
||||||
|
"Corfirean/coa-server-manager:20261028-mysql-install-startup.md",
|
||||||
|
"Corfirean/coa-server-manager:20261028-portable-settings-and-tray.md",
|
||||||
|
"Corfirean/coa-server-manager:20261028-settings-release-history.md",
|
||||||
|
"Corfirean/coa-server-manager:20261028-split-update-actions.md",
|
||||||
|
"Corfirean/coa-server-manager:20261028-update-check-queue.md",
|
||||||
|
"Corfirean/coa-server-manager:20261028-window-density.md",
|
||||||
|
"Corfirean/coa-server-manager:20261029-slow-world-startup.md",
|
||||||
|
"Corfirean/coa-server-manager:20261030-account-console-confirmation.md",
|
||||||
|
"Corfirean/coa-server-manager:20261030-close-abandoned-relay-sockets.md",
|
||||||
|
"Corfirean/coa-server-manager:20261030-disabled-client-renderers.md",
|
||||||
|
"Corfirean/coa-server-manager:20261030-force-stop-unresponsive-world.md",
|
||||||
|
"Corfirean/coa-server-manager:20261030-native-crash-reports.md",
|
||||||
|
"Corfirean/coa-server-manager:20261030-playerbots-overview-count.md",
|
||||||
|
"Corfirean/coa-server-manager:20261030-public-server-browsing-control.md",
|
||||||
|
"Corfirean/coa-server-manager:20261030-stop-does-not-trigger-auto-restart.md",
|
||||||
|
"Corfirean/coa-server-manager:20261030-update-history-target-cache.md",
|
||||||
|
"Corfirean/coa-server-manager:20261030-wait-for-world-console-readiness.md",
|
||||||
|
"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:20261107-bot-strength-scaling-settings.md",
|
||||||
|
"Corfirean/coa-server-manager:20261115-custom-races-v2-client.md"
|
||||||
],
|
],
|
||||||
"releases": [
|
"releases": [
|
||||||
{
|
{
|
||||||
@@ -771,6 +799,143 @@
|
|||||||
"url": "https://github.com/Corfirean/coa-server-manager/releases/tag/v0.9.1",
|
"url": "https://github.com/Corfirean/coa-server-manager/releases/tag/v0.9.1",
|
||||||
"compare": "https://github.com/Corfirean/coa-server-manager/compare/v0.9.0...v0.9.1",
|
"compare": "https://github.com/Corfirean/coa-server-manager/compare/v0.9.0...v0.9.1",
|
||||||
"commit": "8bbf16ed4f14e9b78c680783e4be5d8c580cc06b"
|
"commit": "8bbf16ed4f14e9b78c680783e4be5d8c580cc06b"
|
||||||
|
},
|
||||||
|
{
|
||||||
|
"tag": "v0.9.2",
|
||||||
|
"version": "0.9.2",
|
||||||
|
"date": "2026-10-28",
|
||||||
|
"url": "https://github.com/Corfirean/coa-server-manager/releases/tag/v0.9.2",
|
||||||
|
"notes": [
|
||||||
|
"New server installation waits for slower database startup",
|
||||||
|
"Find and edit CoA options in the existing server settings",
|
||||||
|
"Simultaneous update checks share results or wait their turn",
|
||||||
|
"Recovery can stop an unfinished world startup after restoring an older launcher"
|
||||||
|
],
|
||||||
|
"commit": "2d9c6a65bbb1e296dc919e4c9e5785ed9d4a070b",
|
||||||
|
"compare": "https://github.com/Corfirean/coa-server-manager/compare/v0.9.1...v0.9.2",
|
||||||
|
"experimentalFeatures": [
|
||||||
|
"portable-characters"
|
||||||
|
]
|
||||||
|
},
|
||||||
|
{
|
||||||
|
"tag": "v0.9.3",
|
||||||
|
"version": "0.9.3",
|
||||||
|
"date": "2026-10-29",
|
||||||
|
"url": "https://github.com/Corfirean/coa-server-manager/releases/tag/v0.9.3",
|
||||||
|
"notes": [
|
||||||
|
"Slow server startup no longer triggers an early update rollback"
|
||||||
|
],
|
||||||
|
"commit": "e7b76137d1b22a7596c2b1fa05ca9d12403b99d3",
|
||||||
|
"compare": "https://github.com/Corfirean/coa-server-manager/compare/v0.9.2...v0.9.3",
|
||||||
|
"experimentalFeatures": [
|
||||||
|
"portable-characters"
|
||||||
|
]
|
||||||
|
},
|
||||||
|
{
|
||||||
|
"tag": "v0.9.4",
|
||||||
|
"version": "0.9.4",
|
||||||
|
"date": "2026-10-29",
|
||||||
|
"url": "https://github.com/Corfirean/coa-server-manager/releases/tag/v0.9.4",
|
||||||
|
"notes": [
|
||||||
|
"Settings group updates, startup and maintenance with translated release history",
|
||||||
|
"Update and launch without updating share a divided button",
|
||||||
|
"Maximizing the window keeps text and controls at a comfortable size"
|
||||||
|
],
|
||||||
|
"commit": "c004b90c54fa358b3037c56b093cf019dfcf02b8",
|
||||||
|
"compare": "https://github.com/Corfirean/coa-server-manager/compare/v0.9.3...v0.9.4",
|
||||||
|
"experimentalFeatures": [
|
||||||
|
"portable-characters"
|
||||||
|
]
|
||||||
|
},
|
||||||
|
{
|
||||||
|
"tag": "v0.9.5",
|
||||||
|
"version": "0.9.5",
|
||||||
|
"date": "2026-10-30",
|
||||||
|
"url": "https://github.com/Corfirean/coa-server-manager/releases/tag/v0.9.5",
|
||||||
|
"notes": [
|
||||||
|
"Account creation verifies a lost console reply against the requested login",
|
||||||
|
"Abandoned game relay tunnels close their local connection immediately",
|
||||||
|
"Keep disabled graphics components disabled during client updates",
|
||||||
|
"Force-stop an unresponsive world after a failed normal shutdown",
|
||||||
|
"Crash history includes reports from every world and Windows text files",
|
||||||
|
"Show the online bot count for Playerbots on the overview",
|
||||||
|
"Disable public server browsing in Settings",
|
||||||
|
"Keep deliberate stops and update shutdowns from triggering crash restart",
|
||||||
|
"Server startup waits for a responsive console before reporting success",
|
||||||
|
"Restore the existing Manager window when launching it again"
|
||||||
|
],
|
||||||
|
"commit": "642da8fdc1a0165aea74fbd1ab1b46933fc7e589",
|
||||||
|
"compare": "https://github.com/Corfirean/coa-server-manager/compare/v0.9.4...v0.9.5"
|
||||||
|
},
|
||||||
|
{
|
||||||
|
"tag": "v0.9.7",
|
||||||
|
"version": "0.9.7",
|
||||||
|
"date": "2026-10-30",
|
||||||
|
"url": "https://github.com/Corfirean/coa-server-manager/releases/tag/v0.9.7",
|
||||||
|
"notes": [
|
||||||
|
"Show available update notes even when release history is cached"
|
||||||
|
],
|
||||||
|
"commit": "ba5816e3aea471d5b870e5f0db0b03920c071ed3",
|
||||||
|
"compare": "https://github.com/Corfirean/coa-server-manager/compare/v0.9.5...v0.9.7"
|
||||||
|
},
|
||||||
|
{
|
||||||
|
"tag": "v0.9.8",
|
||||||
|
"version": "0.9.8",
|
||||||
|
"date": "2026-11-01",
|
||||||
|
"url": "https://github.com/Corfirean/coa-server-manager/releases/tag/v0.9.8",
|
||||||
|
"notes": [
|
||||||
|
"Dungeon Clear can be enabled when SQUID bots are active",
|
||||||
|
"Diagnostic exports include launcher stages and lock owner records",
|
||||||
|
"Choose normal logs, errors only or no server logs in maintenance settings",
|
||||||
|
"Update checks temporarily suspend bot population and restore your configuration",
|
||||||
|
"Update validation keeps MySQL running between compatible checks"
|
||||||
|
],
|
||||||
|
"commit": "076fba185c4d96d74f7258d6ca0cae6a4ae4a613",
|
||||||
|
"compare": "https://github.com/Corfirean/coa-server-manager/compare/v0.9.7...v0.9.8"
|
||||||
|
},
|
||||||
|
{
|
||||||
|
"tag": "v0.9.9",
|
||||||
|
"version": "0.9.9",
|
||||||
|
"date": "2026-11-04",
|
||||||
|
"url": "https://github.com/Corfirean/coa-server-manager/releases/tag/v0.9.9",
|
||||||
|
"notes": [
|
||||||
|
"Update and recovery checks use the temporary login port even with a Windows override"
|
||||||
|
],
|
||||||
|
"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"
|
||||||
}
|
}
|
||||||
]
|
]
|
||||||
}
|
}
|
||||||
@@ -5,6 +5,7 @@ edition.workspace = true
|
|||||||
license.workspace = true
|
license.workspace = true
|
||||||
|
|
||||||
[dependencies]
|
[dependencies]
|
||||||
|
socket2 = "0.6"
|
||||||
serde = { version = "1", features = ["derive"] }
|
serde = { version = "1", features = ["derive"] }
|
||||||
serde_json = "1"
|
serde_json = "1"
|
||||||
sha2 = "0.10"
|
sha2 = "0.10"
|
||||||
@@ -37,7 +38,7 @@ rand_core = { version = "0.6", features = ["getrandom"] }
|
|||||||
ed25519-dalek = { version = "2", features = ["rand_core"] }
|
ed25519-dalek = { version = "2", features = ["rand_core"] }
|
||||||
|
|
||||||
[target.'cfg(windows)'.dependencies]
|
[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]
|
[features]
|
||||||
testkit = []
|
testkit = []
|
||||||
@@ -0,0 +1,154 @@
|
|||||||
|
use coa_core::{
|
||||||
|
db::{Account, Db},
|
||||||
|
driver::{self, Verb},
|
||||||
|
ra::Ra,
|
||||||
|
Result,
|
||||||
|
};
|
||||||
|
use std::path::PathBuf;
|
||||||
|
fn main() -> Result<()> {
|
||||||
|
let root = PathBuf::from(std::env::args().nth(1).expect("disposable fixture"));
|
||||||
|
assert!(root
|
||||||
|
.file_name()
|
||||||
|
.unwrap()
|
||||||
|
.to_string_lossy()
|
||||||
|
.starts_with("coa-update-recovery-fixture-"));
|
||||||
|
assert!(root.join("recovery-e2e-started").is_file());
|
||||||
|
let result = std::panic::catch_unwind(|| -> Result<()> {
|
||||||
|
let started = driver::run(&root, Verb::StartAll)?;
|
||||||
|
assert!(started.ok, "{}", started.output);
|
||||||
|
assert!(root.join("Core/Crashes").is_dir());
|
||||||
|
let db = Db::from_repack(&root, Account::Admin)?;
|
||||||
|
println!("Account acceptance: server started, connecting to RA");
|
||||||
|
let mut ra = Ra::connect(&root)?;
|
||||||
|
println!("Account acceptance: RA authenticated");
|
||||||
|
let name = "STABILITYACCT2";
|
||||||
|
assert_eq!(
|
||||||
|
db.query("SELECT COUNT(*) FROM acore_auth.account WHERE username='STABILITYACCT2';")?
|
||||||
|
.trim(),
|
||||||
|
"0"
|
||||||
|
);
|
||||||
|
println!("Account acceptance: sending create command");
|
||||||
|
coa_core::accounts::create(&root, name, "PrivateTest773", true)?;
|
||||||
|
println!("Account acceptance: created");
|
||||||
|
assert_eq!(db.query("SELECT COUNT(*) FROM acore_auth.account WHERE username='STABILITYACCT2' AND LENGTH(salt)=32 AND LENGTH(verifier)=32;")?.trim(), "1");
|
||||||
|
assert!(ra
|
||||||
|
.create_account(name, "PrivateTest773")
|
||||||
|
.unwrap_err()
|
||||||
|
.to_string()
|
||||||
|
.contains("already taken"));
|
||||||
|
ra.set_account_password(name, "PrivateTest774")?;
|
||||||
|
ra.set_account_access(name, 3)?;
|
||||||
|
assert_eq!(db.query("SELECT gmlevel FROM acore_auth.account_access WHERE id=(SELECT id FROM acore_auth.account WHERE username='STABILITYACCT2');")?.trim(), "3");
|
||||||
|
ra.delete_account(name)?;
|
||||||
|
assert_eq!(
|
||||||
|
db.query("SELECT COUNT(*) FROM acore_auth.account WHERE username='STABILITYACCT2';")?
|
||||||
|
.trim(),
|
||||||
|
"0"
|
||||||
|
);
|
||||||
|
lost_reply(&root, &db)?;
|
||||||
|
println!("PASS: native RA account create, SRP salt/verifier, duplicate refusal, password change, administrator access and deletion");
|
||||||
|
Ok(())
|
||||||
|
});
|
||||||
|
let stopped = driver::run(&root, Verb::StopAll)?;
|
||||||
|
assert!(stopped.ok, "{}", stopped.output);
|
||||||
|
result.map_err(|_| {
|
||||||
|
coa_core::Error::Invalid("Native account acceptance failed; fixture stopped".into())
|
||||||
|
})?
|
||||||
|
}
|
||||||
|
|
||||||
|
fn lost_reply(root: &std::path::Path, db: &Db) -> Result<()> {
|
||||||
|
use std::io::{Read, Write};
|
||||||
|
use std::net::{TcpListener, TcpStream};
|
||||||
|
let path = root.join("Settings/repack.json");
|
||||||
|
let original = std::fs::read(&path)?;
|
||||||
|
struct Restore(std::path::PathBuf, Vec<u8>);
|
||||||
|
impl Drop for Restore {
|
||||||
|
fn drop(&mut self) {
|
||||||
|
std::fs::write(&self.0, &self.1).expect("restore disposable fixture settings");
|
||||||
|
}
|
||||||
|
}
|
||||||
|
let restore = Restore(path.clone(), original.clone());
|
||||||
|
let actual = coa_core::layout::read_ports(root).ra;
|
||||||
|
for (name, forward, ready) in [
|
||||||
|
("STABLOSTREPLY", true, true),
|
||||||
|
("STABNOTCREATED", false, true),
|
||||||
|
("STABNOTREADY", false, false),
|
||||||
|
] {
|
||||||
|
assert_eq!(
|
||||||
|
db.query(&format!(
|
||||||
|
"SELECT COUNT(*) FROM acore_auth.account WHERE username='{name}';"
|
||||||
|
))?
|
||||||
|
.trim(),
|
||||||
|
"0"
|
||||||
|
);
|
||||||
|
let listener = TcpListener::bind(("127.0.0.1", 0))?;
|
||||||
|
let mut config: serde_json::Value = serde_json::from_slice(&original)?;
|
||||||
|
config["raPort"] = listener.local_addr()?.port().into();
|
||||||
|
coa_core::fsx::atomic_write_json(&path, &config)?;
|
||||||
|
let proxy = std::thread::spawn(move || {
|
||||||
|
fn until(s: &mut TcpStream, marker: &[u8]) -> Vec<u8> {
|
||||||
|
s.set_read_timeout(Some(std::time::Duration::from_secs(30)))
|
||||||
|
.unwrap();
|
||||||
|
let mut bytes = Vec::new();
|
||||||
|
let mut byte = [0];
|
||||||
|
while !bytes.ends_with(marker) {
|
||||||
|
s.read_exact(&mut byte).unwrap();
|
||||||
|
bytes.push(byte[0]);
|
||||||
|
}
|
||||||
|
bytes
|
||||||
|
}
|
||||||
|
let (mut client, _) = listener.accept().unwrap();
|
||||||
|
let mut server = TcpStream::connect(("127.0.0.1", actual)).unwrap();
|
||||||
|
for marker in [b"Username: ".as_slice(), b"Password: ".as_slice()] {
|
||||||
|
client.write_all(&until(&mut server, marker)).unwrap();
|
||||||
|
server.write_all(&until(&mut client, b"\r\n")).unwrap();
|
||||||
|
}
|
||||||
|
client.write_all(&until(&mut server, b"AC>")).unwrap();
|
||||||
|
let readiness = until(&mut client, b"\r\n");
|
||||||
|
assert_eq!(readiness, b"server info\r\n");
|
||||||
|
if !ready {
|
||||||
|
return;
|
||||||
|
}
|
||||||
|
server.write_all(&readiness).unwrap();
|
||||||
|
client.write_all(&until(&mut server, b"AC>")).unwrap();
|
||||||
|
let command = until(&mut client, b"\r\n");
|
||||||
|
if forward {
|
||||||
|
server.write_all(&command).unwrap();
|
||||||
|
let _ = until(&mut server, b"AC>");
|
||||||
|
}
|
||||||
|
});
|
||||||
|
let outcome = coa_core::accounts::create(root, name, "PrivateTest773", false);
|
||||||
|
proxy.join().unwrap();
|
||||||
|
std::fs::write(&path, &original)?;
|
||||||
|
if forward {
|
||||||
|
outcome?;
|
||||||
|
assert_eq!(
|
||||||
|
db.query(&format!(
|
||||||
|
"SELECT COUNT(*) FROM acore_auth.account WHERE username='{name}';"
|
||||||
|
))?
|
||||||
|
.trim(),
|
||||||
|
"1"
|
||||||
|
);
|
||||||
|
assert!(coa_core::accounts::create(root, name, "DifferentPass77", false).is_err());
|
||||||
|
Ra::connect(root)?.delete_account(name)?;
|
||||||
|
} else {
|
||||||
|
assert!(outcome.is_err());
|
||||||
|
if !ready {
|
||||||
|
assert!(outcome
|
||||||
|
.unwrap_err()
|
||||||
|
.to_string()
|
||||||
|
.contains("No create command was sent"));
|
||||||
|
}
|
||||||
|
assert_eq!(
|
||||||
|
db.query(&format!(
|
||||||
|
"SELECT COUNT(*) FROM acore_auth.account WHERE username='{name}';"
|
||||||
|
))?
|
||||||
|
.trim(),
|
||||||
|
"0"
|
||||||
|
);
|
||||||
|
}
|
||||||
|
}
|
||||||
|
drop(restore);
|
||||||
|
println!("PASS: a lost native console reply is reconciled by exact SRP credentials; a command that was never executed is rejected");
|
||||||
|
Ok(())
|
||||||
|
}
|
||||||
@@ -0,0 +1,11 @@
|
|||||||
|
use coa_core::{crashes, Result};
|
||||||
|
fn main()->Result<()> {
|
||||||
|
let root=std::path::PathBuf::from(std::env::args().nth(1).expect("marked native fixture"));
|
||||||
|
assert!(root.join("recovery-e2e-started").is_file());
|
||||||
|
let reports=crashes::list(&root,30)?;
|
||||||
|
let matching:Vec<_>=reports.iter().filter(|r|r.full_log.contains("AllowableRaces")).collect();
|
||||||
|
assert!(!matching.is_empty());
|
||||||
|
assert!(matching.iter().all(|r|r.exception_code.as_deref()==Some("C0000420")));
|
||||||
|
println!("PASS: Manager discovered {} actual worldserver SQL assertion reports from Core/Crashes, including Windows ANSI text",matching.len());
|
||||||
|
Ok(())
|
||||||
|
}
|
||||||
@@ -0,0 +1,91 @@
|
|||||||
|
use coa_core::{
|
||||||
|
db::{Account, Db},
|
||||||
|
driver::{self, Verb},
|
||||||
|
ra::Ra,
|
||||||
|
Result,
|
||||||
|
};
|
||||||
|
use std::{
|
||||||
|
path::PathBuf,
|
||||||
|
time::{Duration, Instant},
|
||||||
|
};
|
||||||
|
fn main() -> Result<()> {
|
||||||
|
let root = PathBuf::from(
|
||||||
|
std::env::args()
|
||||||
|
.nth(1)
|
||||||
|
.expect("disposable recovery fixture"),
|
||||||
|
);
|
||||||
|
assert!(root
|
||||||
|
.file_name()
|
||||||
|
.unwrap()
|
||||||
|
.to_string_lossy()
|
||||||
|
.starts_with("coa-update-recovery-fixture-"));
|
||||||
|
assert!(root.join("recovery-e2e-started").is_file());
|
||||||
|
let result = std::panic::catch_unwind(|| -> Result<()> {
|
||||||
|
let start = driver::run(&root, Verb::StartAll)?;
|
||||||
|
assert!(start.ok, "{}", start.output);
|
||||||
|
let db = Db::from_repack(&root, Account::Admin)?;
|
||||||
|
coa_core::companions::ensure_templates(&db)?;
|
||||||
|
let mut ra = Ra::connect(&root)?;
|
||||||
|
let before = coa_core::population::query(&root)?;
|
||||||
|
assert_eq!(before.bots_online, 0);
|
||||||
|
let rejected = db.query("SELECT name, at_login FROM acore_characters.characters WHERE guid=3030 AND account IN (SELECT id FROM acore_auth.account WHERE username LIKE 'COABOTHOST%');")?;
|
||||||
|
assert!(rejected.contains("Christian Shadowheart"));
|
||||||
|
assert_eq!(rejected.split_whitespace().last(), Some("1"));
|
||||||
|
println!("Repair reply: {}", ra.run("botcmd spawnbot 3030")?);
|
||||||
|
let repair_deadline = Instant::now() + Duration::from_secs(60);
|
||||||
|
loop {
|
||||||
|
let row = db.query(
|
||||||
|
"SELECT name, at_login, online FROM acore_characters.characters WHERE guid=3030;",
|
||||||
|
)?;
|
||||||
|
if row.trim().ends_with("0\t1") {
|
||||||
|
assert!(!row.contains("Christian Shadowheart"));
|
||||||
|
println!("PASS: the exact previously rejected companion was renamed by server validation and logged in");
|
||||||
|
break;
|
||||||
|
}
|
||||||
|
assert!(
|
||||||
|
Instant::now() < repair_deadline,
|
||||||
|
"previously rejected companion logged in"
|
||||||
|
);
|
||||||
|
std::thread::sleep(Duration::from_secs(1));
|
||||||
|
}
|
||||||
|
let _ = ra.despawn_all()?;
|
||||||
|
let clear_deadline = Instant::now() + Duration::from_secs(30);
|
||||||
|
while coa_core::population::query(&root)?.bots_online > 0 {
|
||||||
|
assert!(Instant::now() < clear_deadline);
|
||||||
|
std::thread::sleep(Duration::from_secs(1));
|
||||||
|
}
|
||||||
|
println!("Spawn reply: {}", ra.spawn_bots(21)?);
|
||||||
|
let deadline = Instant::now() + Duration::from_secs(180);
|
||||||
|
loop {
|
||||||
|
let pop = coa_core::population::query(&root)?;
|
||||||
|
if pop.bots_online >= 21 {
|
||||||
|
println!(
|
||||||
|
"PASS: {} companions logged in; real players={}",
|
||||||
|
pop.bots_online, pop.players_online
|
||||||
|
);
|
||||||
|
break;
|
||||||
|
}
|
||||||
|
if Instant::now() > deadline {
|
||||||
|
return Err(coa_core::Error::Invalid(format!(
|
||||||
|
"Only {} of 21 companion logins completed",
|
||||||
|
pop.bots_online
|
||||||
|
)));
|
||||||
|
}
|
||||||
|
std::thread::sleep(Duration::from_secs(2));
|
||||||
|
}
|
||||||
|
let _ = ra.cancel_spawning()?;
|
||||||
|
let _ = ra.despawn_all()?;
|
||||||
|
let deadline = Instant::now() + Duration::from_secs(30);
|
||||||
|
while coa_core::population::query(&root)?.bots_online > 0 {
|
||||||
|
assert!(Instant::now() < deadline, "companions despawned");
|
||||||
|
std::thread::sleep(Duration::from_secs(1));
|
||||||
|
}
|
||||||
|
println!("PASS: companion despawn completed");
|
||||||
|
Ok(())
|
||||||
|
});
|
||||||
|
let stopped = driver::run(&root, Verb::StopAll)?;
|
||||||
|
assert!(stopped.ok, "{}", stopped.output);
|
||||||
|
result.map_err(|_| {
|
||||||
|
coa_core::Error::Invalid("Companion native acceptance panicked; fixture stopped".into())
|
||||||
|
})?
|
||||||
|
}
|
||||||
@@ -0,0 +1,12 @@
|
|||||||
|
use coa_core::{crashes, Result};
|
||||||
|
fn main() -> Result<()> {
|
||||||
|
let root = std::path::PathBuf::from(std::env::args().nth(1).expect("native crash evidence"));
|
||||||
|
assert!(root.join(".crash-report-evidence").is_file());
|
||||||
|
let reports = crashes::list(&root, 10)?;
|
||||||
|
assert_eq!(reports.len(), 1);
|
||||||
|
assert_eq!(reports[0].exception_code.as_deref(), Some("C0000005"));
|
||||||
|
assert_eq!(reports[0].category, "access_violation");
|
||||||
|
assert!(!reports[0].full_log.is_empty());
|
||||||
|
println!("PASS: Manager crash history discovers and classifies the actual native handler report from Core/Crashes");
|
||||||
|
Ok(())
|
||||||
|
}
|
||||||
@@ -0,0 +1,90 @@
|
|||||||
|
use coa_core::{driver, fsx, process, Result};
|
||||||
|
#[cfg(windows)]
|
||||||
|
use std::os::windows::process::CommandExt;
|
||||||
|
use std::{
|
||||||
|
path::Path,
|
||||||
|
process::{Child, Command, Stdio},
|
||||||
|
};
|
||||||
|
|
||||||
|
struct OwnedChild(Child);
|
||||||
|
impl Drop for OwnedChild {
|
||||||
|
fn drop(&mut self) {
|
||||||
|
let _ = self.0.kill();
|
||||||
|
let _ = self.0.wait();
|
||||||
|
}
|
||||||
|
}
|
||||||
|
fn copy_tree(source: &Path, target: &Path) -> Result<()> {
|
||||||
|
std::fs::create_dir_all(target)?;
|
||||||
|
for entry in std::fs::read_dir(source)? {
|
||||||
|
let entry = entry?;
|
||||||
|
let destination = target.join(entry.file_name());
|
||||||
|
if entry.file_type()?.is_dir() {
|
||||||
|
copy_tree(&entry.path(), &destination)?;
|
||||||
|
} else {
|
||||||
|
std::fs::copy(entry.path(), destination)?;
|
||||||
|
}
|
||||||
|
}
|
||||||
|
Ok(())
|
||||||
|
}
|
||||||
|
fn spawn(path: &Path) -> OwnedChild {
|
||||||
|
let mut cmd = Command::new(path);
|
||||||
|
cmd.args(["-t", "127.0.0.1"])
|
||||||
|
.stdin(Stdio::null())
|
||||||
|
.stdout(Stdio::null())
|
||||||
|
.stderr(Stdio::null());
|
||||||
|
#[cfg(windows)]
|
||||||
|
cmd.creation_flags(0x0800_0000);
|
||||||
|
OwnedChild(cmd.spawn().unwrap())
|
||||||
|
}
|
||||||
|
fn main() -> Result<()> {
|
||||||
|
assert!(cfg!(windows));
|
||||||
|
let source = std::path::PathBuf::from(
|
||||||
|
std::env::args()
|
||||||
|
.nth(1)
|
||||||
|
.expect("marked disposable runtime source"),
|
||||||
|
);
|
||||||
|
assert_eq!(
|
||||||
|
std::fs::read(source.join(".release-schema-fixture"))?,
|
||||||
|
b"disposable release-schema fixture"
|
||||||
|
);
|
||||||
|
let temp = tempfile::tempdir()?;
|
||||||
|
let root = temp.path();
|
||||||
|
copy_tree(&source.join("Runtime"), &root.join("Runtime"))?;
|
||||||
|
std::fs::create_dir_all(root.join("Core"))?;
|
||||||
|
std::fs::create_dir_all(root.join("Scripts"))?;
|
||||||
|
let system =
|
||||||
|
std::path::PathBuf::from(std::env::var_os("SystemRoot").unwrap()).join("System32/ping.exe");
|
||||||
|
std::fs::copy(&system, root.join("Core/worldserver.exe"))?;
|
||||||
|
std::fs::copy(&system, root.join("foreign.exe"))?;
|
||||||
|
let mut ports = Vec::new();
|
||||||
|
let mut listeners = Vec::new();
|
||||||
|
for _ in 0..4 {
|
||||||
|
let listener = std::net::TcpListener::bind("127.0.0.1:0")?;
|
||||||
|
ports.push(listener.local_addr()?.port());
|
||||||
|
listeners.push(listener);
|
||||||
|
}
|
||||||
|
let config = serde_json::json!({"mysqlPort":ports[0],"authPort":ports[1],"worldPort":ports[2],"raPort":ports[3],"raUsername":"fixture","raPassword":"fixture"});
|
||||||
|
fsx::atomic_write_json(&root.join("Settings/repack.json"), &config)?;
|
||||||
|
drop(listeners);
|
||||||
|
let mut launcher = std::fs::read_to_string(source.join("Scripts/manage.py"))?;
|
||||||
|
launcher.push_str("\nfrom contextlib import nullcontext\ndef control_lock(): return nullcontext()\ndef stop_all(config):\n assert not process('world'), 'world must stop before database'\n (ROOT/'database-stage').write_text('safe')\n");
|
||||||
|
fsx::atomic_write(&root.join("Scripts/manage.py"), launcher.as_bytes())?;
|
||||||
|
let mut foreign = spawn(&root.join("foreign.exe"));
|
||||||
|
let foreign_identity = process::identity(foreign.0.id()).unwrap();
|
||||||
|
fsx::atomic_write_json(&root.join(".state/world.json"), &foreign_identity)?;
|
||||||
|
let rejected = driver::force_stop(root)?;
|
||||||
|
assert!(!rejected.ok, "a foreign world record must be rejected");
|
||||||
|
assert!(!root.join("database-stage").exists());
|
||||||
|
assert!(foreign.0.try_wait()?.is_none());
|
||||||
|
let mut owned = spawn(&root.join("Core/worldserver.exe"));
|
||||||
|
let stopped = driver::force_stop(root)?;
|
||||||
|
assert!(stopped.ok, "{}", stopped.output);
|
||||||
|
assert!(owned.0.try_wait()?.is_some());
|
||||||
|
assert!(
|
||||||
|
foreign.0.try_wait()?.is_none(),
|
||||||
|
"foreign process was untouched"
|
||||||
|
);
|
||||||
|
assert_eq!(std::fs::read(root.join("database-stage"))?, b"safe");
|
||||||
|
println!("PASS: native Windows forced-stop rejects foreign records, recovers the exact owned world identity, stops it before the database stage, and leaves the foreign process alive");
|
||||||
|
Ok(())
|
||||||
|
}
|
||||||
@@ -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,199 @@
|
|||||||
|
use base64::{engine::general_purpose::STANDARD, Engine};
|
||||||
|
use coa_core::{
|
||||||
|
backup,
|
||||||
|
db::Db,
|
||||||
|
driver::{self, Verb},
|
||||||
|
fsx,
|
||||||
|
manifest::{Kind, Migration},
|
||||||
|
package::{self, BuildOptions},
|
||||||
|
pkgsource::Source,
|
||||||
|
registry::MetaDir,
|
||||||
|
update::{self, RepackEnv},
|
||||||
|
Result,
|
||||||
|
};
|
||||||
|
use ed25519_dalek::{Signer, SigningKey};
|
||||||
|
use std::{collections::BTreeMap, path::PathBuf};
|
||||||
|
fn main() -> Result<()> {
|
||||||
|
let root = PathBuf::from(
|
||||||
|
std::env::args()
|
||||||
|
.nth(1)
|
||||||
|
.expect("qualified disposable fixture"),
|
||||||
|
);
|
||||||
|
let sql = std::fs::read(std::env::args().nth(2).expect("corrective SQL"))?;
|
||||||
|
assert_eq!(
|
||||||
|
root.file_name().unwrap(),
|
||||||
|
"coa-schema-fixture-stability-upgrade-76-85-20261030"
|
||||||
|
);
|
||||||
|
assert!(root.join(".release-schema-fixture").is_file());
|
||||||
|
assert!(!root.join("legacy-start-data-e2e-started").exists());
|
||||||
|
fsx::atomic_write(
|
||||||
|
&root.join("legacy-start-data-e2e-started"),
|
||||||
|
b"disposable regression test",
|
||||||
|
)?;
|
||||||
|
let result = std::panic::catch_unwind(|| -> Result<()> {
|
||||||
|
let meta = coa_core::registry::metadata_dir_for(&root)?;
|
||||||
|
let mut identities = String::new();
|
||||||
|
let mut custom = String::new();
|
||||||
|
backup::with_database(&root, |db| {
|
||||||
|
assert_eq!(
|
||||||
|
db.query(
|
||||||
|
"SELECT COUNT(*) FROM acore_world.playercreateinfo WHERE race IN (33,45);"
|
||||||
|
)?
|
||||||
|
.trim(),
|
||||||
|
"0"
|
||||||
|
);
|
||||||
|
let base: u32 = db
|
||||||
|
.query("SELECT MAX(guid)+100 FROM acore_characters.characters;")?
|
||||||
|
.trim()
|
||||||
|
.parse()
|
||||||
|
.unwrap();
|
||||||
|
clone_character(db, base, 33, 12, "Thinprobe")?;
|
||||||
|
clone_character(db, base + 1, 45, 30, "Leperprobe")?;
|
||||||
|
identities = db.query(&format!(
|
||||||
|
"SELECT * FROM acore_characters.characters WHERE guid IN ({base},{});",
|
||||||
|
base + 1
|
||||||
|
))?;
|
||||||
|
let missing = coa_core::character_start_check::missing(db)?;
|
||||||
|
assert!(missing
|
||||||
|
.iter()
|
||||||
|
.any(|c| c.guid == base && c.race == 33 && c.class == 12));
|
||||||
|
assert!(missing
|
||||||
|
.iter()
|
||||||
|
.any(|c| c.guid == base + 1 && c.race == 45 && c.class == 30));
|
||||||
|
db.query("INSERT INTO acore_world.playercreateinfo SELECT 33,class,map,zone,position_x+0.125,position_y,position_z,orientation FROM acore_world.playercreateinfo WHERE race=1 AND class=32;")?;
|
||||||
|
custom =
|
||||||
|
db.query("SELECT * FROM acore_world.playercreateinfo WHERE race=33 AND class=32;")?;
|
||||||
|
fsx::atomic_write(
|
||||||
|
&root.join("legacy-probe-guids.json"),
|
||||||
|
serde_json::to_string(&[base, base + 1])?.as_bytes(),
|
||||||
|
)?;
|
||||||
|
println!("PASS: reproduced missing starting data for existing race 33/class 12 and race 45/class 30 characters");
|
||||||
|
Ok(())
|
||||||
|
})?;
|
||||||
|
let source = root.join("legacy-start-data-source");
|
||||||
|
let pkg = root.join("legacy-start-data-package");
|
||||||
|
fsx::atomic_write(
|
||||||
|
&source.join("Core/legacy-start-data-proof.txt"),
|
||||||
|
b"corrective migration acceptance",
|
||||||
|
)?;
|
||||||
|
fsx::atomic_write(
|
||||||
|
&source.join("_migrations/world/stabilization_legacy_starts.sql"),
|
||||||
|
&sql,
|
||||||
|
)?;
|
||||||
|
let manifest = package::build(
|
||||||
|
&source,
|
||||||
|
&pkg,
|
||||||
|
&BuildOptions {
|
||||||
|
kind: Kind::Update,
|
||||||
|
version: "2.0.0".into(),
|
||||||
|
core_commit: None,
|
||||||
|
bots_commit: None,
|
||||||
|
built_at: "private regression acceptance".into(),
|
||||||
|
part_size: 1 << 20,
|
||||||
|
migrations: vec![Migration {
|
||||||
|
id: "stabilization_legacy_starts".into(),
|
||||||
|
db: "world".into(),
|
||||||
|
sha256: fsx::sha256_bytes(&sql),
|
||||||
|
compatible_sha256: vec![],
|
||||||
|
destructive: false,
|
||||||
|
}],
|
||||||
|
},
|
||||||
|
&|_| {},
|
||||||
|
)?;
|
||||||
|
let key = SigningKey::generate(&mut rand_core::OsRng);
|
||||||
|
fsx::atomic_write(
|
||||||
|
&pkg.join("manifest.json.sig"),
|
||||||
|
STANDARD
|
||||||
|
.encode(
|
||||||
|
key.sign(&std::fs::read(pkg.join("manifest.json"))?)
|
||||||
|
.to_bytes(),
|
||||||
|
)
|
||||||
|
.as_bytes(),
|
||||||
|
)?;
|
||||||
|
let trusted = STANDARD.encode(key.verifying_key().to_bytes());
|
||||||
|
let env = RepackEnv {
|
||||||
|
root: &root,
|
||||||
|
meta_dir: &meta,
|
||||||
|
};
|
||||||
|
let out = update::apply(
|
||||||
|
&update::Params {
|
||||||
|
root: &root,
|
||||||
|
meta_dir: &meta,
|
||||||
|
source: Source::Dir(pkg),
|
||||||
|
trusted_key: &trusted,
|
||||||
|
cancel: Default::default(),
|
||||||
|
resolutions: BTreeMap::new(),
|
||||||
|
env: &env,
|
||||||
|
fail_after_ops: None,
|
||||||
|
},
|
||||||
|
&|step, pct| println!("{pct}% {step}"),
|
||||||
|
)?;
|
||||||
|
assert_eq!(out.txn.state, update::State::Committed);
|
||||||
|
assert_eq!(
|
||||||
|
MetaDir::open(&meta)?.1.core.version.as_deref(),
|
||||||
|
Some("2.0.0")
|
||||||
|
);
|
||||||
|
backup::with_database(&root, |db| {
|
||||||
|
let guids: Vec<u32> =
|
||||||
|
serde_json::from_slice(&std::fs::read(root.join("legacy-probe-guids.json"))?)?;
|
||||||
|
assert_eq!(
|
||||||
|
db.query(&format!(
|
||||||
|
"SELECT * FROM acore_characters.characters WHERE guid IN ({},{});",
|
||||||
|
guids[0], guids[1]
|
||||||
|
))?,
|
||||||
|
identities
|
||||||
|
);
|
||||||
|
assert!(coa_core::character_start_check::missing(db)?
|
||||||
|
.iter()
|
||||||
|
.all(|c| !guids.contains(&c.guid)));
|
||||||
|
assert_eq!(
|
||||||
|
db.query("SELECT * FROM acore_world.playercreateinfo WHERE race=33 AND class=32;")?,
|
||||||
|
custom
|
||||||
|
);
|
||||||
|
assert!(coa_core::migrations::status(db, &manifest.migrations)?
|
||||||
|
.iter()
|
||||||
|
.all(|m| m.status == coa_core::migrations::Status::Applied));
|
||||||
|
let before = counts(db)?;
|
||||||
|
db.query(&format!(
|
||||||
|
"USE acore_world; {}",
|
||||||
|
String::from_utf8_lossy(&sql)
|
||||||
|
))?;
|
||||||
|
assert_eq!(counts(db)?, before);
|
||||||
|
assert_eq!(
|
||||||
|
db.query("SELECT * FROM acore_world.playercreateinfo WHERE race=33 AND class=32;")?,
|
||||||
|
custom
|
||||||
|
);
|
||||||
|
println!("PASS: signed Manager update restored legacy starts, preserved complete character rows and custom starts, and remained idempotent on a second SQL execution");
|
||||||
|
Ok(())
|
||||||
|
})?;
|
||||||
|
Ok(())
|
||||||
|
});
|
||||||
|
let stopped = driver::run(&root, Verb::StopAll)?;
|
||||||
|
assert!(stopped.ok, "{}", stopped.output);
|
||||||
|
result.map_err(|_| {
|
||||||
|
coa_core::Error::Invalid("Legacy start regression failed; fixture stopped".into())
|
||||||
|
})?
|
||||||
|
}
|
||||||
|
fn counts(db: &Db) -> Result<String> {
|
||||||
|
db.query("SELECT COUNT(*) FROM acore_world.playercreateinfo WHERE race IN (33,45); SELECT COUNT(*) FROM acore_world.playercreateinfo_item WHERE race IN (33,45); SELECT COUNT(*) FROM acore_world.playercreateinfo_action WHERE race IN (33,45); SELECT COUNT(*) FROM acore_world.player_race_stats WHERE Race IN (33,45); SELECT COUNT(*) FROM acore_world.ascension_custom_class_race WHERE race IN (33,45);")
|
||||||
|
}
|
||||||
|
fn clone_character(db: &Db, guid: u32, race: u32, class: u32, name: &str) -> Result<()> {
|
||||||
|
let columns = db.query("SHOW COLUMNS FROM acore_characters.characters;")?;
|
||||||
|
let names: Vec<_> = columns
|
||||||
|
.lines()
|
||||||
|
.map(|l| l.split('\t').next().unwrap())
|
||||||
|
.collect();
|
||||||
|
let values: Vec<String> = names
|
||||||
|
.iter()
|
||||||
|
.map(|c| match *c {
|
||||||
|
"guid" => guid.to_string(),
|
||||||
|
"name" => format!("'{name}'"),
|
||||||
|
"race" => race.to_string(),
|
||||||
|
"class" => class.to_string(),
|
||||||
|
"online" | "at_login" => "0".into(),
|
||||||
|
_ => format!("`{c}`"),
|
||||||
|
})
|
||||||
|
.collect();
|
||||||
|
db.query(&format!("INSERT INTO acore_characters.characters ({}) SELECT {} FROM acore_characters.characters WHERE class={class} LIMIT 1;",names.iter().map(|c|format!("`{c}`")).collect::<Vec<_>>().join(","),values.join(",")))?;
|
||||||
|
Ok(())
|
||||||
|
}
|
||||||
@@ -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,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,8 @@
|
|||||||
|
use coa_core::{backup, schema_check, Result};
|
||||||
|
fn main()->Result<()> {
|
||||||
|
let root=std::path::PathBuf::from(std::env::args().nth(1).unwrap());
|
||||||
|
let contract=std::path::PathBuf::from(std::env::args().nth(2).unwrap());
|
||||||
|
assert!(root.join("recovery-e2e-started").is_file());
|
||||||
|
assert!(contract.join(".release-schema-fixture").is_file());
|
||||||
|
backup::with_database(&root,|db| {for p in schema_check::check(db,&contract)? {println!("{}.{}.{}: {}",p.database,p.table,p.column,p.detail);} Ok(())})
|
||||||
|
}
|
||||||
@@ -0,0 +1,132 @@
|
|||||||
|
use base64::{engine::general_purpose::STANDARD, Engine};
|
||||||
|
use coa_core::{
|
||||||
|
backup,
|
||||||
|
driver::{self, Verb},
|
||||||
|
fsx,
|
||||||
|
manifest::{Kind, Migration},
|
||||||
|
package::{self, BuildOptions},
|
||||||
|
pkgsource::Source,
|
||||||
|
update::{self, RepackEnv},
|
||||||
|
Result,
|
||||||
|
};
|
||||||
|
use ed25519_dalek::{Signer, SigningKey};
|
||||||
|
use std::{collections::BTreeMap, path::PathBuf};
|
||||||
|
fn main() -> Result<()> {
|
||||||
|
let root = PathBuf::from(std::env::args().nth(1).unwrap());
|
||||||
|
let core = PathBuf::from(std::env::args().nth(2).unwrap());
|
||||||
|
let release = PathBuf::from(std::env::args().nth(3).unwrap());
|
||||||
|
assert!(root.join("recovery-e2e-started").is_file());
|
||||||
|
let result = std::panic::catch_unwind(|| -> Result<()> {
|
||||||
|
let meta = coa_core::registry::metadata_dir_for(&root)?;
|
||||||
|
let source = root.join("schema-sync-source-v2");
|
||||||
|
let pkg = root.join("schema-sync-package-v2");
|
||||||
|
assert!(!pkg.exists());
|
||||||
|
fsx::atomic_write(
|
||||||
|
&source.join("Core/schema-sync-proof.txt"),
|
||||||
|
b"official schema migration acceptance",
|
||||||
|
)?;
|
||||||
|
let published =
|
||||||
|
coa_core::manifest::Manifest::parse(&std::fs::read(release.join("manifest.json"))?)?;
|
||||||
|
let contract_path = PathBuf::from("C:/games/source/coa-schema-fixture-stability-upgrade-76-85-20261030/Scripts/database-schema.json");
|
||||||
|
let contract = std::fs::read(contract_path)?;
|
||||||
|
let expected = published
|
||||||
|
.files
|
||||||
|
.iter()
|
||||||
|
.find(|f| f.path == "Scripts/database-schema.json")
|
||||||
|
.unwrap();
|
||||||
|
assert_eq!(fsx::sha256_bytes(&contract), expected.sha256);
|
||||||
|
fsx::atomic_write(&source.join("Scripts/database-schema.json"), &contract)?;
|
||||||
|
let mut migrations: Vec<Migration> = Vec::new();
|
||||||
|
for id in [
|
||||||
|
"rev_1793212891571528600",
|
||||||
|
"rev_20261027_18_coa_strange_piece_of_scrap_faction_diamond",
|
||||||
|
] {
|
||||||
|
let m = published
|
||||||
|
.migrations
|
||||||
|
.iter()
|
||||||
|
.find(|m| m.id == id)
|
||||||
|
.unwrap()
|
||||||
|
.clone();
|
||||||
|
let sql = std::fs::read(
|
||||||
|
core.join(format!("data/sql/updates/pending_db_{}/{}.sql", m.db, m.id)),
|
||||||
|
)?;
|
||||||
|
assert_eq!(fsx::sha256_bytes(&sql), m.sha256);
|
||||||
|
fsx::atomic_write(
|
||||||
|
&source.join(format!("_migrations/{}/{}.sql", m.db, m.id)),
|
||||||
|
&sql,
|
||||||
|
)?;
|
||||||
|
migrations.push(m);
|
||||||
|
}
|
||||||
|
package::build(
|
||||||
|
&source,
|
||||||
|
&pkg,
|
||||||
|
&BuildOptions {
|
||||||
|
kind: Kind::Update,
|
||||||
|
version: "3.0.0".into(),
|
||||||
|
core_commit: None,
|
||||||
|
bots_commit: None,
|
||||||
|
built_at: "private native fixture schema sync".into(),
|
||||||
|
part_size: 1 << 20,
|
||||||
|
migrations,
|
||||||
|
},
|
||||||
|
&|_| {},
|
||||||
|
)?;
|
||||||
|
let key = SigningKey::generate(&mut rand_core::OsRng);
|
||||||
|
fsx::atomic_write(
|
||||||
|
&pkg.join("manifest.json.sig"),
|
||||||
|
STANDARD
|
||||||
|
.encode(
|
||||||
|
key.sign(&std::fs::read(pkg.join("manifest.json"))?)
|
||||||
|
.to_bytes(),
|
||||||
|
)
|
||||||
|
.as_bytes(),
|
||||||
|
)?;
|
||||||
|
let trusted = STANDARD.encode(key.verifying_key().to_bytes());
|
||||||
|
let env = RepackEnv {
|
||||||
|
root: &root,
|
||||||
|
meta_dir: &meta,
|
||||||
|
};
|
||||||
|
let out = update::apply(
|
||||||
|
&update::Params {
|
||||||
|
root: &root,
|
||||||
|
meta_dir: &meta,
|
||||||
|
source: Source::Dir(pkg),
|
||||||
|
trusted_key: &trusted,
|
||||||
|
cancel: Default::default(),
|
||||||
|
resolutions: BTreeMap::from([(
|
||||||
|
"Scripts/database-schema.json".into(),
|
||||||
|
update::Resolution::Replace,
|
||||||
|
)]),
|
||||||
|
env: &env,
|
||||||
|
fail_after_ops: None,
|
||||||
|
},
|
||||||
|
&|step, pct| println!("{pct}% {step}"),
|
||||||
|
)?;
|
||||||
|
assert_eq!(out.txn.state, update::State::Committed);
|
||||||
|
backup::with_database(&root, |db| {
|
||||||
|
assert_eq!(
|
||||||
|
db.query("SELECT name,at_login FROM acore_characters.characters WHERE guid=3030;")?
|
||||||
|
.trim(),
|
||||||
|
"Christian Shadowheart\t1"
|
||||||
|
);
|
||||||
|
assert_eq!(
|
||||||
|
db.query("SELECT id FROM acore_characters.manager_recovery_probe;")?
|
||||||
|
.trim(),
|
||||||
|
"42"
|
||||||
|
);
|
||||||
|
assert_eq!(
|
||||||
|
db.query("SELECT id FROM acore_world.manager_recovery_probe;")?
|
||||||
|
.trim(),
|
||||||
|
"44"
|
||||||
|
);
|
||||||
|
Ok(())
|
||||||
|
})?;
|
||||||
|
println!("PASS: the exact two published migrations brought the old fixture schema forward through the Manager updater while preserving the rejected companion and recovery probes");
|
||||||
|
Ok(())
|
||||||
|
});
|
||||||
|
let stop = driver::run(&root, Verb::StopAll)?;
|
||||||
|
assert!(stop.ok, "{}", stop.output);
|
||||||
|
result.map_err(|_| {
|
||||||
|
coa_core::Error::Invalid("Schema sync acceptance failed; fixture stopped".into())
|
||||||
|
})?
|
||||||
|
}
|
||||||
@@ -0,0 +1,166 @@
|
|||||||
|
use base64::{engine::general_purpose::STANDARD, Engine};
|
||||||
|
use coa_core::{
|
||||||
|
backup, driver, fsx,
|
||||||
|
manifest::{Kind, Migration},
|
||||||
|
package::{self, BuildOptions},
|
||||||
|
pkgsource::Source,
|
||||||
|
registry::MetaDir,
|
||||||
|
update::{self, RepackEnv},
|
||||||
|
Result,
|
||||||
|
};
|
||||||
|
use ed25519_dalek::{Signer, SigningKey};
|
||||||
|
use std::{collections::BTreeMap, path::PathBuf};
|
||||||
|
|
||||||
|
fn main() -> Result<()> {
|
||||||
|
let root = PathBuf::from(
|
||||||
|
std::env::args()
|
||||||
|
.nth(1)
|
||||||
|
.expect("disposable recovery fixture"),
|
||||||
|
);
|
||||||
|
assert!(root
|
||||||
|
.file_name()
|
||||||
|
.unwrap()
|
||||||
|
.to_string_lossy()
|
||||||
|
.starts_with("coa-update-recovery-fixture-"));
|
||||||
|
assert!(root.join("recovery-e2e-started").is_file());
|
||||||
|
let cycles_only = std::env::args().nth(2).as_deref() == Some("--cycles-only");
|
||||||
|
if !cycles_only {
|
||||||
|
assert!(!root.join("success-e2e-started").exists());
|
||||||
|
fsx::atomic_write(
|
||||||
|
&root.join("success-e2e-started"),
|
||||||
|
b"disposable success acceptance",
|
||||||
|
)?;
|
||||||
|
}
|
||||||
|
let result = std::panic::catch_unwind(std::panic::AssertUnwindSafe(|| {
|
||||||
|
if cycles_only {
|
||||||
|
restart_cycles(&root)
|
||||||
|
} else {
|
||||||
|
exercise(&root)
|
||||||
|
}
|
||||||
|
}));
|
||||||
|
assert!(
|
||||||
|
driver::run(&root, driver::Verb::StopAll)?.ok,
|
||||||
|
"fixture shutdown"
|
||||||
|
);
|
||||||
|
result.map_err(|_| {
|
||||||
|
coa_core::Error::Invalid(
|
||||||
|
"Success acceptance assertion failed; fixture services stopped".into(),
|
||||||
|
)
|
||||||
|
})?
|
||||||
|
}
|
||||||
|
|
||||||
|
fn exercise(root: &std::path::Path) -> Result<()> {
|
||||||
|
let meta = coa_core::registry::metadata_dir_for(root)?;
|
||||||
|
assert!(update::unfinished(&meta).is_none());
|
||||||
|
assert!(driver::run(root, driver::Verb::StopAll)?.ok);
|
||||||
|
let source = root.join("success-source");
|
||||||
|
let pkg = root.join("success-package");
|
||||||
|
fsx::atomic_write(
|
||||||
|
&source.join("Core/stabilization-success.txt"),
|
||||||
|
b"verified update",
|
||||||
|
)?;
|
||||||
|
let sql = b"UPDATE manager_recovery_probe SET id=44 WHERE id=43;";
|
||||||
|
fsx::atomic_write(
|
||||||
|
&source.join("_migrations/world/stabilization_success.sql"),
|
||||||
|
sql,
|
||||||
|
)?;
|
||||||
|
let manifest = package::build(
|
||||||
|
&source,
|
||||||
|
&pkg,
|
||||||
|
&BuildOptions {
|
||||||
|
kind: Kind::Update,
|
||||||
|
version: "2.0.0".into(),
|
||||||
|
core_commit: None,
|
||||||
|
bots_commit: None,
|
||||||
|
built_at: "disposable acceptance".into(),
|
||||||
|
part_size: 1 << 20,
|
||||||
|
migrations: vec![Migration {
|
||||||
|
id: "stabilization_success".into(),
|
||||||
|
db: "world".into(),
|
||||||
|
sha256: fsx::sha256_bytes(sql),
|
||||||
|
compatible_sha256: vec![],
|
||||||
|
destructive: false,
|
||||||
|
}],
|
||||||
|
},
|
||||||
|
&|_| {},
|
||||||
|
)?;
|
||||||
|
let key = SigningKey::generate(&mut rand_core::OsRng);
|
||||||
|
fsx::atomic_write(
|
||||||
|
&pkg.join("manifest.json.sig"),
|
||||||
|
STANDARD
|
||||||
|
.encode(
|
||||||
|
key.sign(&std::fs::read(pkg.join("manifest.json"))?)
|
||||||
|
.to_bytes(),
|
||||||
|
)
|
||||||
|
.as_bytes(),
|
||||||
|
)?;
|
||||||
|
let trusted = STANDARD.encode(key.verifying_key().to_bytes());
|
||||||
|
let env = RepackEnv {
|
||||||
|
root,
|
||||||
|
meta_dir: &meta,
|
||||||
|
};
|
||||||
|
let outcome = update::apply(
|
||||||
|
&update::Params {
|
||||||
|
root,
|
||||||
|
meta_dir: &meta,
|
||||||
|
source: Source::Dir(pkg),
|
||||||
|
trusted_key: &trusted,
|
||||||
|
cancel: Default::default(),
|
||||||
|
resolutions: BTreeMap::new(),
|
||||||
|
env: &env,
|
||||||
|
fail_after_ops: None,
|
||||||
|
},
|
||||||
|
&|step, pct| println!("{pct}% {step}"),
|
||||||
|
)?;
|
||||||
|
assert_eq!(outcome.txn.state, update::State::Committed);
|
||||||
|
assert_eq!(
|
||||||
|
MetaDir::open(&meta)?.1.core.version.as_deref(),
|
||||||
|
Some("2.0.0")
|
||||||
|
);
|
||||||
|
assert!(update::unfinished(&meta).is_none());
|
||||||
|
assert_eq!(
|
||||||
|
std::fs::read(root.join("Core/stabilization-success.txt"))?,
|
||||||
|
b"verified update"
|
||||||
|
);
|
||||||
|
backup::with_database(root, |db| {
|
||||||
|
assert_eq!(
|
||||||
|
db.query("SELECT id FROM acore_characters.manager_recovery_probe;")?,
|
||||||
|
"42"
|
||||||
|
);
|
||||||
|
assert_eq!(
|
||||||
|
db.query("SELECT id FROM acore_characters.manager_recovery_view;")?,
|
||||||
|
"42"
|
||||||
|
);
|
||||||
|
assert_eq!(
|
||||||
|
db.query("SELECT id FROM acore_world.manager_recovery_probe;")?,
|
||||||
|
"44"
|
||||||
|
);
|
||||||
|
assert!(coa_core::migrations::status(db, &manifest.migrations)?
|
||||||
|
.iter()
|
||||||
|
.all(|m| m.status == coa_core::migrations::Status::Applied));
|
||||||
|
Ok(())
|
||||||
|
})?;
|
||||||
|
restart_cycles(root)?;
|
||||||
|
println!("PASS: signed update committed after failed rehearsal and recovery; SQL, files, metadata and player data verified; two native restart cycles passed");
|
||||||
|
Ok(())
|
||||||
|
}
|
||||||
|
|
||||||
|
fn restart_cycles(root: &std::path::Path) -> Result<()> {
|
||||||
|
for cycle in 0..2 {
|
||||||
|
let stopped = driver::run(root, driver::Verb::StopAll)?;
|
||||||
|
assert!(
|
||||||
|
stopped.ok,
|
||||||
|
"Stop cycle {cycle}: {}",
|
||||||
|
coa_core::diag::redact(&stopped.output)
|
||||||
|
);
|
||||||
|
let started = driver::run(root, driver::Verb::StartAll)?;
|
||||||
|
assert!(started.ok, "{}", started.output);
|
||||||
|
let pop = coa_core::population::query(root)?;
|
||||||
|
println!(
|
||||||
|
"Restart cycle {cycle}: world ready, players={}, bots={}",
|
||||||
|
pop.players_online, pop.bots_online
|
||||||
|
);
|
||||||
|
}
|
||||||
|
println!("PASS: two native restart cycles finished");
|
||||||
|
Ok(())
|
||||||
|
}
|
||||||
@@ -30,15 +30,27 @@ fn main() -> Result<()> {
|
|||||||
.unwrap()
|
.unwrap()
|
||||||
.to_string_lossy()
|
.to_string_lossy()
|
||||||
.starts_with("coa-update-recovery-fixture-"));
|
.starts_with("coa-update-recovery-fixture-"));
|
||||||
assert!(
|
let resume = std::env::args().nth(2).as_deref() == Some("--verify-recovered");
|
||||||
!root.join("recovery-e2e-started").exists(),
|
let result = std::panic::catch_unwind(std::panic::AssertUnwindSafe(|| {
|
||||||
"Use a new fixture; never reuse an owned server"
|
if resume {
|
||||||
);
|
assert!(root.join("recovery-e2e-started").is_file());
|
||||||
fsx::atomic_write(&root.join("recovery-e2e-started"), b"disposable fixture")?;
|
let manifest = coa_core::manifest::Manifest::parse(&std::fs::read(
|
||||||
let result = exercise(&root);
|
root.join("fixture-package/manifest.json"),
|
||||||
let stopped = driver::run(&root, Verb::StopAll)?;
|
)?)?;
|
||||||
assert!(stopped.ok);
|
verify_recovered(&root, &manifest)
|
||||||
result
|
} else {
|
||||||
|
assert!(
|
||||||
|
!root.join("recovery-e2e-started").exists(),
|
||||||
|
"Use a new fixture"
|
||||||
|
);
|
||||||
|
fsx::atomic_write(&root.join("recovery-e2e-started"), b"disposable fixture")?;
|
||||||
|
exercise(&root)
|
||||||
|
}
|
||||||
|
}));
|
||||||
|
assert!(driver::run(&root, Verb::StopAll)?.ok);
|
||||||
|
result.map_err(|_| {
|
||||||
|
Error::Invalid("Recovery acceptance assertion failed; owned services were stopped".into())
|
||||||
|
})?
|
||||||
}
|
}
|
||||||
|
|
||||||
fn exercise(root: &Path) -> Result<()> {
|
fn exercise(root: &Path) -> Result<()> {
|
||||||
@@ -122,9 +134,18 @@ fn exercise(root: &Path) -> Result<()> {
|
|||||||
assert!(
|
assert!(
|
||||||
error
|
error
|
||||||
.to_string()
|
.to_string()
|
||||||
.contains("private update rehearsal failed"),
|
.contains("files and databases were restored to the recovery point"),
|
||||||
"{error}"
|
"{error}"
|
||||||
);
|
);
|
||||||
|
verify_recovered(root, &manifest)
|
||||||
|
}
|
||||||
|
|
||||||
|
fn verify_recovered(root: &Path, manifest: &coa_core::manifest::Manifest) -> Result<()> {
|
||||||
|
let meta = coa_core::registry::metadata_dir_for(root)?;
|
||||||
|
let env = RepackEnv {
|
||||||
|
root,
|
||||||
|
meta_dir: &meta,
|
||||||
|
};
|
||||||
assert!(!root.join("Core/recovery-probe.txt").exists());
|
assert!(!root.join("Core/recovery-probe.txt").exists());
|
||||||
assert!(update::unfinished(&meta).is_none());
|
assert!(update::unfinished(&meta).is_none());
|
||||||
assert_eq!(
|
assert_eq!(
|
||||||
@@ -168,6 +189,6 @@ fn exercise(root: &Path) -> Result<()> {
|
|||||||
Db::from_repack(root, Account::Admin)?.realm(),
|
Db::from_repack(root, Account::Admin)?.realm(),
|
||||||
coa_core::realms::Mode::Coa
|
coa_core::realms::Mode::Coa
|
||||||
);
|
);
|
||||||
println!("PASS: private rehearsal caught failed SQL before changing the installed world, characters, ledger, objects, files or version; complete recovery succeeded");
|
println!("PASS: failed SQL was rolled back; characters, world, ledger, views, triggers, routines, files and version were verified; the saved recovery point was restored again");
|
||||||
Ok(())
|
Ok(())
|
||||||
}
|
}
|
||||||
@@ -80,6 +80,60 @@ fn upper(name: &str) -> Result<String> {
|
|||||||
Ok(name.to_ascii_uppercase())
|
Ok(name.to_ascii_uppercase())
|
||||||
}
|
}
|
||||||
|
|
||||||
|
pub fn create(root: &Path, name: &str, password: &str, administrator: bool) -> Result<()> {
|
||||||
|
validate_account(name, password)?;
|
||||||
|
let name = name.to_ascii_uppercase();
|
||||||
|
let db = Db::from_repack(root, Account::Admin)?;
|
||||||
|
if db
|
||||||
|
.query(&format!(
|
||||||
|
"SELECT COUNT(*) FROM acore_auth.account WHERE username='{name}';"
|
||||||
|
))?
|
||||||
|
.trim()
|
||||||
|
!= "0"
|
||||||
|
{
|
||||||
|
return Err(Error::Invalid("That account name is already taken.".into()));
|
||||||
|
}
|
||||||
|
let mut ra = Ra::connect(root)?;
|
||||||
|
ra.performance().map_err(|error| Error::Invalid(format!("The server console is not ready for account creation. No create command was sent. {error}")))?;
|
||||||
|
let confirmed = ra.create_account(&name, password);
|
||||||
|
if let Err(error) = confirmed {
|
||||||
|
let stored = db.query(&format!(
|
||||||
|
"SELECT HEX(salt), HEX(verifier) FROM acore_auth.account WHERE username='{name}';"
|
||||||
|
))?;
|
||||||
|
if !matches_credentials(&stored, &name, password) {
|
||||||
|
return Err(Error::Invalid(format!("Account creation was not confirmed. Refresh the account list before retrying. {error}")));
|
||||||
|
}
|
||||||
|
if administrator {
|
||||||
|
ra = Ra::connect(root).map_err(|error| Error::Invalid(format!("The account was created, but administrator access was not confirmed. Refresh the account list and check its access level. {error}")))?;
|
||||||
|
}
|
||||||
|
}
|
||||||
|
if administrator {
|
||||||
|
if let Err(error) = ra.make_administrator(&name) {
|
||||||
|
let access = db.query(&format!("SELECT COUNT(*) FROM acore_auth.account_access WHERE id=(SELECT id FROM acore_auth.account WHERE username='{name}') AND gmlevel=3 AND RealmID=-1;"))?;
|
||||||
|
if access.trim() != "1" {
|
||||||
|
return Err(Error::Invalid(format!("The account was created, but administrator access was not confirmed. Refresh the account list and check its access level. {error}")));
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
Ok(())
|
||||||
|
}
|
||||||
|
|
||||||
|
fn matches_credentials(stored: &str, name: &str, password: &str) -> bool {
|
||||||
|
let Some((salt, verifier)) = stored.trim().split_once('\t') else {
|
||||||
|
return false;
|
||||||
|
};
|
||||||
|
let Ok(salt) = hex::decode(salt) else {
|
||||||
|
return false;
|
||||||
|
};
|
||||||
|
let Ok(salt): std::result::Result<[u8; 32], _> = salt.try_into() else {
|
||||||
|
return false;
|
||||||
|
};
|
||||||
|
let Ok(verifier) = hex::decode(verifier) else {
|
||||||
|
return false;
|
||||||
|
};
|
||||||
|
verifier.as_slice() == crate::srp6::verifier(name, password, &salt)
|
||||||
|
}
|
||||||
|
|
||||||
/// Give the account a new name. Needs the world console (the new password is what makes the login work again) and an
|
/// Give the account a new name. Needs the world console (the new password is what makes the login work again) and an
|
||||||
/// account that is not logged in. The old name is put back if anything goes wrong.
|
/// account that is not logged in. The old name is put back if anything goes wrong.
|
||||||
pub fn rename(root: &Path, ra: &mut Ra, old: &str, new: &str, password: &str) -> Result<()> {
|
pub fn rename(root: &Path, ra: &mut Ra, old: &str, new: &str, password: &str) -> Result<()> {
|
||||||
@@ -165,6 +219,19 @@ pub fn delete(root: &Path, ra: &mut Ra, name: &str) -> Result<()> {
|
|||||||
mod tests {
|
mod tests {
|
||||||
use super::*;
|
use super::*;
|
||||||
|
|
||||||
|
#[test]
|
||||||
|
fn lost_reply_requires_the_exact_requested_credentials() {
|
||||||
|
let salt = [42; 32];
|
||||||
|
let verifier = crate::srp6::verifier("NewPlayer", "Password77", &salt);
|
||||||
|
let stored = format!("{}\t{}\n", hex::encode(salt), hex::encode(verifier));
|
||||||
|
assert!(matches_credentials(&stored, "NEWPLAYER", "password77"));
|
||||||
|
assert!(!matches_credentials(&stored, "NEWPLAYER", "wrongpass"));
|
||||||
|
assert!(!matches_credentials(&stored, "OTHERPLAYER", "Password77"));
|
||||||
|
for value in ["", "NULL\tNULL", "00\t00", "malformed"] {
|
||||||
|
assert!(!matches_credentials(value, "NewPlayer", "Password77"));
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
#[test]
|
#[test]
|
||||||
fn rows_from_the_client_become_accounts() {
|
fn rows_from_the_client_become_accounts() {
|
||||||
let out = "2\tALICE\t3\t0\t2026-09-30 21:04:11\t4\n5\tBOB\t0\t1\t\t0\n7\tBROKEN\n";
|
let out = "2\tALICE\t3\t0\t2026-09-30 21:04:11\t4\n5\tBOB\t0\t1\t\t0\n7\tBROKEN\n";
|
||||||
|
|||||||
@@ -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-")));
|
||||||
|
}
|
||||||
|
}
|
||||||
@@ -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 db = Db::from_repack(root, Account::Admin)?;
|
||||||
let observed = process::observe(root, &read_ports(root));
|
let observed = process::observe(root, &read_ports(root));
|
||||||
let mysql_was_up = observed.mysql.state == ServiceState::Running && db.ping();
|
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)?;
|
let out = driver::run(root, Verb::StartMysql)?;
|
||||||
if !out.ok {
|
if !out.ok {
|
||||||
// Keep the launcher's own last lines: the title alone ("Something went wrong") hides the cause.
|
// 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)
|
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);
|
let result = f(&db);
|
||||||
if !mysql_was_up {
|
if !mysql_was_up {
|
||||||
let now = process::observe(root, &read_ports(root));
|
let now = process::observe(root, &read_ports(root));
|
||||||
|
|||||||
@@ -15,7 +15,8 @@ use crate::fsx;
|
|||||||
pub use crate::glue_config;
|
pub use crate::glue_config;
|
||||||
|
|
||||||
pub const ADDON_NAME: &str = "CoABotUI";
|
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 {
|
pub fn is_running(client: &Path) -> bool {
|
||||||
if crate::platform::flavor() == crate::platform::Flavor::Docker {
|
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> {
|
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(
|
fn sync_realm_when_closed(
|
||||||
client: &Path,
|
client: &Path,
|
||||||
meta: &Path,
|
meta: &Path,
|
||||||
mode: crate::realms::Mode,
|
realm: &str,
|
||||||
running: bool,
|
running: bool,
|
||||||
) -> Result<bool> {
|
) -> Result<bool> {
|
||||||
if running {
|
if running {
|
||||||
@@ -89,11 +100,6 @@ fn sync_realm_when_closed(
|
|||||||
Err(e) if e.kind() == std::io::ErrorKind::NotFound => Vec::new(),
|
Err(e) if e.kind() == std::io::ErrorKind::NotFound => Vec::new(),
|
||||||
Err(e) => return Err(e.into()),
|
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);
|
let new = realm_config(&old, realm);
|
||||||
if new == old {
|
if new == old {
|
||||||
return Ok(true);
|
return Ok(true);
|
||||||
@@ -409,6 +415,38 @@ pub fn install_addon(client: &Path, meta: &Path, source: &Path) -> Result<()> {
|
|||||||
Ok(())
|
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.
|
/// Start the game client. The caller is responsible for making sure the server is ready first.
|
||||||
pub fn launch(client: &Path) -> Result<u32> {
|
pub fn launch(client: &Path) -> Result<u32> {
|
||||||
let exe =
|
let exe =
|
||||||
@@ -607,6 +645,23 @@ pub fn recover_all_realmlist_overrides(meta_roots: &[PathBuf]) -> usize {
|
|||||||
#[cfg(test)]
|
#[cfg(test)]
|
||||||
mod tests {
|
mod tests {
|
||||||
use super::*;
|
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)]
|
#[cfg(windows)]
|
||||||
#[test]
|
#[test]
|
||||||
@@ -677,10 +732,10 @@ mod tests {
|
|||||||
let meta = d.path().join("meta");
|
let meta = d.path().join("meta");
|
||||||
let original = b"SET realmName \"Wildcard\"\n";
|
let original = b"SET realmName \"Wildcard\"\n";
|
||||||
fs::write(c.join("WTF/Config.wtf"), original).unwrap();
|
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_eq!(fs::read(c.join("WTF/Config.wtf")).unwrap(), original);
|
||||||
assert!(!backup_dir(&meta).exists());
|
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!(
|
assert_eq!(
|
||||||
fs::read(c.join("WTF/Config.wtf")).unwrap(),
|
fs::read(c.join("WTF/Config.wtf")).unwrap(),
|
||||||
b"SET realmName \"Conquest of Azeroth\"\n"
|
b"SET realmName \"Conquest of Azeroth\"\n"
|
||||||
|
|||||||
@@ -0,0 +1,134 @@
|
|||||||
|
use crate::{fsx, Error, Result};
|
||||||
|
use serde::{Deserialize, Serialize};
|
||||||
|
use std::{fs, path::Path};
|
||||||
|
|
||||||
|
#[derive(Default, Serialize, Deserialize)]
|
||||||
|
pub struct Graphics {
|
||||||
|
pub dxvk_disabled: bool,
|
||||||
|
pub enhancements_disabled: bool,
|
||||||
|
}
|
||||||
|
|
||||||
|
fn preferences(client: &Path) -> Result<Option<Graphics>> {
|
||||||
|
match fs::read(client.join(".coa-manager/graphics.json")) {
|
||||||
|
Ok(bytes) => Ok(Some(serde_json::from_slice(&bytes)?)),
|
||||||
|
Err(e) if e.kind() == std::io::ErrorKind::NotFound => Ok(None),
|
||||||
|
Err(e) => Err(e.into()),
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
pub fn status(client: &Path) -> Result<Graphics> {
|
||||||
|
let saved = preferences(client)?.unwrap_or_default();
|
||||||
|
let actual = |name: &str, remembered: bool| -> Result<bool> {
|
||||||
|
let active = client.join(name).is_file();
|
||||||
|
let inactive = client.join(format!("{name}.DISABLED")).is_file();
|
||||||
|
if active && inactive {
|
||||||
|
return Err(Error::Invalid(
|
||||||
|
"Both enabled and disabled renderer files exist.".into(),
|
||||||
|
));
|
||||||
|
}
|
||||||
|
Ok(inactive || (!active && remembered))
|
||||||
|
};
|
||||||
|
Ok(Graphics {
|
||||||
|
dxvk_disabled: actual("d3d9.dll", saved.dxvk_disabled)?,
|
||||||
|
enhancements_disabled: actual("dxgi.dll", saved.enhancements_disabled)?,
|
||||||
|
})
|
||||||
|
}
|
||||||
|
|
||||||
|
pub fn disabled(client: &Path, path: &str) -> Result<bool> {
|
||||||
|
let name = path.to_ascii_lowercase();
|
||||||
|
if !matches!(name.as_str(), "d3d9.dll" | "dxgi.dll") {
|
||||||
|
return Ok(false);
|
||||||
|
}
|
||||||
|
let state = status(client)?;
|
||||||
|
Ok(if name == "d3d9.dll" {
|
||||||
|
state.dxvk_disabled
|
||||||
|
} else {
|
||||||
|
state.enhancements_disabled
|
||||||
|
})
|
||||||
|
}
|
||||||
|
|
||||||
|
pub fn set(client: &Path, name: &str, disabled: bool) -> Result<Graphics> {
|
||||||
|
if !matches!(name, "d3d9.dll" | "dxgi.dll") {
|
||||||
|
return Err(Error::Invalid("Unknown graphics setting.".into()));
|
||||||
|
}
|
||||||
|
if crate::client::is_running(client) {
|
||||||
|
return Err(Error::Invalid(
|
||||||
|
"Close the game before changing graphics settings.".into(),
|
||||||
|
));
|
||||||
|
}
|
||||||
|
let active = fsx::safe_join(client, name)?;
|
||||||
|
let inactive = fsx::safe_join(client, &format!("{name}.DISABLED"))?;
|
||||||
|
if active.exists() && inactive.exists() {
|
||||||
|
return Err(Error::Invalid("Both enabled and disabled renderer files exist. Resolve the conflict before changing graphics settings.".into()));
|
||||||
|
}
|
||||||
|
let mut state = status(client)?;
|
||||||
|
if name == "d3d9.dll" {
|
||||||
|
state.dxvk_disabled = disabled;
|
||||||
|
} else {
|
||||||
|
state.enhancements_disabled = disabled;
|
||||||
|
}
|
||||||
|
let (source, target) = if disabled {
|
||||||
|
(&active, &inactive)
|
||||||
|
} else {
|
||||||
|
(&inactive, &active)
|
||||||
|
};
|
||||||
|
// The no-clobber link also preserves an existing destination if another app changes the setting.
|
||||||
|
if source.is_file() {
|
||||||
|
if let Err(error) = fs::hard_link(source, target) {
|
||||||
|
if error.kind() == std::io::ErrorKind::AlreadyExists {
|
||||||
|
return Err(error.into());
|
||||||
|
}
|
||||||
|
let mut output = fs::OpenOptions::new()
|
||||||
|
.write(true)
|
||||||
|
.create_new(true)
|
||||||
|
.open(target)?;
|
||||||
|
let copied = std::fs::File::open(source)
|
||||||
|
.and_then(|mut input| std::io::copy(&mut input, &mut output))
|
||||||
|
.and_then(|_| output.sync_all());
|
||||||
|
drop(output);
|
||||||
|
if let Err(error) = copied {
|
||||||
|
let _ = fs::remove_file(target);
|
||||||
|
return Err(error.into());
|
||||||
|
}
|
||||||
|
}
|
||||||
|
if let Err(error) = fs::remove_file(source) {
|
||||||
|
let _ = fs::remove_file(target);
|
||||||
|
return Err(error.into());
|
||||||
|
}
|
||||||
|
}
|
||||||
|
fsx::atomic_write_json(&client.join(".coa-manager/graphics.json"), &state)?;
|
||||||
|
Ok(state)
|
||||||
|
}
|
||||||
|
|
||||||
|
#[cfg(test)]
|
||||||
|
mod tests {
|
||||||
|
use super::*;
|
||||||
|
#[test]
|
||||||
|
fn toggles_preserve_bytes_and_refuse_conflicts() {
|
||||||
|
let dir = tempfile::tempdir().unwrap();
|
||||||
|
let root = dir.path();
|
||||||
|
fs::write(root.join("d3d9.dll"), b"custom renderer").unwrap();
|
||||||
|
assert!(set(root, "d3d9.dll", true).unwrap().dxvk_disabled);
|
||||||
|
assert!(!root.join("d3d9.dll").exists());
|
||||||
|
assert_eq!(
|
||||||
|
fs::read(root.join("d3d9.dll.DISABLED")).unwrap(),
|
||||||
|
b"custom renderer"
|
||||||
|
);
|
||||||
|
assert!(!set(root, "d3d9.dll", false).unwrap().dxvk_disabled);
|
||||||
|
fs::write(root.join("d3d9.dll.DISABLED"), b"other").unwrap();
|
||||||
|
assert!(set(root, "d3d9.dll", false).is_err());
|
||||||
|
assert_eq!(fs::read(root.join("d3d9.dll")).unwrap(), b"custom renderer");
|
||||||
|
assert_eq!(fs::read(root.join("d3d9.dll.DISABLED")).unwrap(), b"other");
|
||||||
|
}
|
||||||
|
|
||||||
|
#[test]
|
||||||
|
fn remembers_missing_wrapper_and_imports_launcher_marker() {
|
||||||
|
let dir = tempfile::tempdir().unwrap();
|
||||||
|
let root = dir.path();
|
||||||
|
assert!(set(root, "d3d9.dll", true).unwrap().dxvk_disabled);
|
||||||
|
assert!(disabled(root, "d3d9.dll").unwrap());
|
||||||
|
fs::write(root.join("dxgi.dll.DISABLED"), b"launcher disabled").unwrap();
|
||||||
|
assert!(disabled(root, "dxgi.dll").unwrap());
|
||||||
|
assert!(!disabled(root, "Data/d3d9.dll").unwrap());
|
||||||
|
}
|
||||||
|
}
|
||||||
@@ -299,6 +299,11 @@ pub fn plan(
|
|||||||
bytes_per_sec: 0,
|
bytes_per_sec: 0,
|
||||||
file: Some(f.path.clone()),
|
file: Some(f.path.clone()),
|
||||||
});
|
});
|
||||||
|
if crate::client_graphics::disabled(client, &f.path)? {
|
||||||
|
kept += 1;
|
||||||
|
done += f.size;
|
||||||
|
continue;
|
||||||
|
}
|
||||||
let path = fsx::safe_join(client, &f.path)?;
|
let path = fsx::safe_join(client, &f.path)?;
|
||||||
let meta = match fs::metadata(&path) {
|
let meta = match fs::metadata(&path) {
|
||||||
Ok(meta) if meta.is_file() => meta,
|
Ok(meta) if meta.is_file() => meta,
|
||||||
@@ -440,6 +445,9 @@ pub fn apply(a: &Apply, on_step: &dyn Fn(Step)) -> Result<()> {
|
|||||||
|
|
||||||
let mut todo = Vec::new();
|
let mut todo = Vec::new();
|
||||||
for item in &a.plan.items {
|
for item in &a.plan.items {
|
||||||
|
if crate::client_graphics::disabled(a.client, &item.path)? {
|
||||||
|
continue;
|
||||||
|
}
|
||||||
if item.kind == Kind::Modified && a.keep_modified {
|
if item.kind == Kind::Modified && a.keep_modified {
|
||||||
let path = fsx::safe_join(a.client, &item.path)?;
|
let path = fsx::safe_join(a.client, &item.path)?;
|
||||||
let meta = fs::metadata(&path)?;
|
let meta = fs::metadata(&path)?;
|
||||||
@@ -777,6 +785,52 @@ mod tests {
|
|||||||
);
|
);
|
||||||
}
|
}
|
||||||
|
|
||||||
|
#[test]
|
||||||
|
fn disabled_launcher_renderers_are_never_restored_even_with_a_stale_plan() {
|
||||||
|
let dir = tempfile::tempdir().unwrap();
|
||||||
|
let files: Vec<(&str, &[u8])> = vec![("d3d9.dll", b"dxvk"), ("dxgi.dll", b"enhancements")];
|
||||||
|
let manifest = manifest("v1", &files);
|
||||||
|
let cancel = Cancel::default();
|
||||||
|
let old_plan = plan(dir.path(), &manifest, &State::default(), &cancel, &|_| {}).unwrap();
|
||||||
|
fs::write(dir.path().join("d3d9.dll.DISABLED"), b"custom disabled").unwrap();
|
||||||
|
crate::client_graphics::set(dir.path(), "dxgi.dll", true).unwrap();
|
||||||
|
let server = Server::new(&files);
|
||||||
|
apply(
|
||||||
|
&Apply {
|
||||||
|
client: dir.path(),
|
||||||
|
manifest: &manifest,
|
||||||
|
plan: &old_plan,
|
||||||
|
keep_modified: false,
|
||||||
|
transport: &server,
|
||||||
|
objects_url: "https://x.invalid/objects",
|
||||||
|
cancel: &cancel,
|
||||||
|
},
|
||||||
|
&|_| {},
|
||||||
|
)
|
||||||
|
.unwrap();
|
||||||
|
assert!(server.requested.lock().unwrap().is_empty());
|
||||||
|
assert!(!dir.path().join("d3d9.dll").exists());
|
||||||
|
assert!(!dir.path().join("dxgi.dll").exists());
|
||||||
|
assert_eq!(
|
||||||
|
fs::read(dir.path().join("d3d9.dll.DISABLED")).unwrap(),
|
||||||
|
b"custom disabled"
|
||||||
|
);
|
||||||
|
let after = plan(
|
||||||
|
dir.path(),
|
||||||
|
&manifest,
|
||||||
|
&load_state(dir.path()).unwrap(),
|
||||||
|
&cancel,
|
||||||
|
&|_| {},
|
||||||
|
)
|
||||||
|
.unwrap();
|
||||||
|
assert!(after.items.is_empty());
|
||||||
|
crate::client_graphics::set(dir.path(), "d3d9.dll", false).unwrap();
|
||||||
|
assert_eq!(
|
||||||
|
fs::read(dir.path().join("d3d9.dll")).unwrap(),
|
||||||
|
b"custom disabled"
|
||||||
|
);
|
||||||
|
}
|
||||||
|
|
||||||
#[test]
|
#[test]
|
||||||
fn renderer_files_configs_and_everything_not_in_the_manifest_survive_an_update_untouched() {
|
fn renderer_files_configs_and_everything_not_in_the_manifest_survive_an_update_untouched() {
|
||||||
let d = tempfile::tempdir().unwrap();
|
let d = tempfile::tempdir().unwrap();
|
||||||
|
|||||||
File diff suppressed because it is too large.
Load diff
@@ -214,11 +214,13 @@ fn run(
|
|||||||
struct StreamWorker {
|
struct StreamWorker {
|
||||||
tx: Sender<TunnelMsg>,
|
tx: Sender<TunnelMsg>,
|
||||||
reset_on_drop: bool,
|
reset_on_drop: bool,
|
||||||
|
shutdown: Arc<TcpStream>,
|
||||||
}
|
}
|
||||||
|
|
||||||
impl Drop for StreamWorker {
|
impl Drop for StreamWorker {
|
||||||
fn drop(&mut self) {
|
fn drop(&mut self) {
|
||||||
if self.reset_on_drop {
|
if self.reset_on_drop {
|
||||||
|
let _ = self.shutdown.shutdown(std::net::Shutdown::Both);
|
||||||
let _ = self.tx.send(TunnelMsg::Reset { stream_id: 0 });
|
let _ = self.tx.send(TunnelMsg::Reset { stream_id: 0 });
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
@@ -388,6 +390,8 @@ fn session(
|
|||||||
};
|
};
|
||||||
match TcpStream::connect(("127.0.0.1", local_port)) {
|
match TcpStream::connect(("127.0.0.1", local_port)) {
|
||||||
Ok(tcp) => {
|
Ok(tcp) => {
|
||||||
|
let tcp = Arc::new(tcp);
|
||||||
|
let shutdown = tcp.clone();
|
||||||
let (stream_tx, stream_rx) = channel::<TunnelMsg>();
|
let (stream_tx, stream_rx) = channel::<TunnelMsg>();
|
||||||
let ws_tx = ws_out_tx.clone();
|
let ws_tx = ws_out_tx.clone();
|
||||||
|
|
||||||
@@ -398,6 +402,7 @@ fn session(
|
|||||||
StreamWorker {
|
StreamWorker {
|
||||||
tx: stream_tx,
|
tx: stream_tx,
|
||||||
reset_on_drop: true,
|
reset_on_drop: true,
|
||||||
|
shutdown,
|
||||||
},
|
},
|
||||||
);
|
);
|
||||||
|
|
||||||
@@ -456,19 +461,20 @@ fn session(
|
|||||||
|
|
||||||
fn spawn_local_tcp_bridge(
|
fn spawn_local_tcp_bridge(
|
||||||
stream_id: u32,
|
stream_id: u32,
|
||||||
mut tcp: TcpStream,
|
tcp: Arc<TcpStream>,
|
||||||
from_tunnel: Receiver<TunnelMsg>,
|
from_tunnel: Receiver<TunnelMsg>,
|
||||||
to_tunnel: Sender<TunnelMsg>,
|
to_tunnel: Sender<TunnelMsg>,
|
||||||
) {
|
) {
|
||||||
let _ = tcp.set_nonblocking(false);
|
let _ = tcp.set_nonblocking(false);
|
||||||
let _ = tcp.set_nodelay(true);
|
let _ = tcp.set_nodelay(true);
|
||||||
let mut tcp_read = tcp.try_clone().expect("tcp clone");
|
let tcp_read = tcp.clone();
|
||||||
let to_tunnel_read = to_tunnel.clone();
|
let to_tunnel_read = to_tunnel.clone();
|
||||||
|
|
||||||
// Local TCP read -> to tunnel
|
// Local TCP read -> to tunnel
|
||||||
std::thread::Builder::new()
|
std::thread::Builder::new()
|
||||||
.name(format!("relay-stream-{stream_id}-read"))
|
.name(format!("relay-stream-{stream_id}-read"))
|
||||||
.spawn(move || {
|
.spawn(move || {
|
||||||
|
let mut tcp_read = tcp_read.as_ref();
|
||||||
let mut buf = [0u8; 16384];
|
let mut buf = [0u8; 16384];
|
||||||
loop {
|
loop {
|
||||||
match tcp_read.read(&mut buf) {
|
match tcp_read.read(&mut buf) {
|
||||||
@@ -498,11 +504,12 @@ fn spawn_local_tcp_bridge(
|
|||||||
std::thread::Builder::new()
|
std::thread::Builder::new()
|
||||||
.name(format!("relay-stream-{stream_id}-write"))
|
.name(format!("relay-stream-{stream_id}-write"))
|
||||||
.spawn(move || {
|
.spawn(move || {
|
||||||
|
let mut tcp_write = tcp.as_ref();
|
||||||
while let Ok(msg) = from_tunnel.recv() {
|
while let Ok(msg) = from_tunnel.recv() {
|
||||||
match msg {
|
match msg {
|
||||||
TunnelMsg::Data { chunk, .. } => {
|
TunnelMsg::Data { chunk, .. } => {
|
||||||
if let Ok(data) = base64::engine::general_purpose::STANDARD.decode(&chunk) {
|
if let Ok(data) = base64::engine::general_purpose::STANDARD.decode(&chunk) {
|
||||||
if tcp.write_all(&data).is_err() {
|
if tcp_write.write_all(&data).is_err() {
|
||||||
break;
|
break;
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
@@ -608,22 +615,71 @@ mod tests {
|
|||||||
}
|
}
|
||||||
|
|
||||||
#[test]
|
#[test]
|
||||||
fn dropping_a_tunnel_closes_its_local_tcp_stream() {
|
fn local_tunnel_exchanges_data_in_both_directions_before_reset() {
|
||||||
let listener = TcpListener::bind("127.0.0.1:0").unwrap();
|
let listener = TcpListener::bind("127.0.0.1:0").unwrap();
|
||||||
let tcp = TcpStream::connect(listener.local_addr().unwrap()).unwrap();
|
let tcp = Arc::new(TcpStream::connect(listener.local_addr().unwrap()).unwrap());
|
||||||
|
let shutdown = tcp.clone();
|
||||||
let (mut peer, _) = listener.accept().unwrap();
|
let (mut peer, _) = listener.accept().unwrap();
|
||||||
peer.set_read_timeout(Some(Duration::from_secs(3))).unwrap();
|
peer.set_read_timeout(Some(Duration::from_secs(3))).unwrap();
|
||||||
let (tx, rx) = channel();
|
let (tx, rx) = channel();
|
||||||
let (out, _) = channel();
|
let (out, replies) = channel();
|
||||||
spawn_local_tcp_bridge(7, tcp, rx, out);
|
spawn_local_tcp_bridge(8, tcp, rx, out);
|
||||||
drop(StreamWorker {
|
let worker = StreamWorker {
|
||||||
tx,
|
tx,
|
||||||
reset_on_drop: true,
|
reset_on_drop: true,
|
||||||
});
|
shutdown,
|
||||||
match peer.read(&mut [0u8; 1]) {
|
};
|
||||||
Ok(0) => {},
|
worker
|
||||||
Err(error) if matches!(error.kind(), std::io::ErrorKind::ConnectionReset | std::io::ErrorKind::ConnectionAborted) => {},
|
.tx
|
||||||
other => panic!("The abandoned relay stream must close, got {other:?}"),
|
.send(TunnelMsg::Data {
|
||||||
|
stream_id: 8,
|
||||||
|
chunk: base64::engine::general_purpose::STANDARD.encode(b"request"),
|
||||||
|
})
|
||||||
|
.unwrap();
|
||||||
|
let mut request = [0; 7];
|
||||||
|
peer.read_exact(&mut request).unwrap();
|
||||||
|
assert_eq!(&request, b"request");
|
||||||
|
peer.write_all(b"response").unwrap();
|
||||||
|
let mut response = Vec::new();
|
||||||
|
while response.len() < 8 {
|
||||||
|
match replies.recv_timeout(Duration::from_secs(3)).unwrap() {
|
||||||
|
TunnelMsg::Data { chunk, .. } => response.extend(
|
||||||
|
base64::engine::general_purpose::STANDARD
|
||||||
|
.decode(chunk)
|
||||||
|
.unwrap(),
|
||||||
|
),
|
||||||
|
other => panic!("Expected the local reply, got {other:?}"),
|
||||||
|
}
|
||||||
|
}
|
||||||
|
assert_eq!(response, b"response");
|
||||||
|
drop(worker);
|
||||||
|
}
|
||||||
|
|
||||||
|
#[test]
|
||||||
|
fn dropping_a_tunnel_closes_its_local_tcp_stream() {
|
||||||
|
for _ in 0..32 {
|
||||||
|
let listener = TcpListener::bind("127.0.0.1:0").unwrap();
|
||||||
|
let tcp = Arc::new(TcpStream::connect(listener.local_addr().unwrap()).unwrap());
|
||||||
|
let shutdown = tcp.clone();
|
||||||
|
let (mut peer, _) = listener.accept().unwrap();
|
||||||
|
peer.set_read_timeout(Some(Duration::from_secs(3))).unwrap();
|
||||||
|
let (tx, rx) = channel();
|
||||||
|
let (out, _) = channel();
|
||||||
|
spawn_local_tcp_bridge(7, tcp, rx, out);
|
||||||
|
drop(StreamWorker {
|
||||||
|
tx,
|
||||||
|
reset_on_drop: true,
|
||||||
|
shutdown,
|
||||||
|
});
|
||||||
|
match peer.read(&mut [0u8; 1]) {
|
||||||
|
Ok(0) => {}
|
||||||
|
Err(error)
|
||||||
|
if matches!(
|
||||||
|
error.kind(),
|
||||||
|
std::io::ErrorKind::ConnectionReset | std::io::ErrorKind::ConnectionAborted
|
||||||
|
) => {}
|
||||||
|
other => panic!("The abandoned relay stream must close, got {other:?}"),
|
||||||
|
}
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
@@ -24,17 +24,25 @@ pub struct CrashItem {
|
|||||||
|
|
||||||
/// Lists recent crash reports from `Core/Crashes`, sorted newest first.
|
/// Lists recent crash reports from `Core/Crashes`, sorted newest first.
|
||||||
pub fn list(root: &Path, limit: usize) -> Result<Vec<CrashItem>> {
|
pub fn list(root: &Path, limit: usize) -> Result<Vec<CrashItem>> {
|
||||||
let dir = root.join("Core/Crashes");
|
let mut roots = vec![root.to_path_buf()];
|
||||||
|
roots.extend(crate::multiworld::Tree::ALL.map(|tree| crate::multiworld::tree_root(root, tree)));
|
||||||
let mut files: Vec<(PathBuf, SystemTime)> = Vec::new();
|
let mut files: Vec<(PathBuf, SystemTime)> = Vec::new();
|
||||||
if let Ok(entries) = fs::read_dir(&dir) {
|
for world_root in roots {
|
||||||
for entry in entries.flatten() {
|
let entries = match fs::read_dir(world_root.join("Core/Crashes")) {
|
||||||
let path = entry.path();
|
Ok(entries) => Some(entries),
|
||||||
if path.is_file() && path.extension().and_then(|e| e.to_str()) == Some("txt") {
|
Err(e) if e.kind() == std::io::ErrorKind::NotFound => None,
|
||||||
let mtime = entry
|
Err(e) => return Err(e.into()),
|
||||||
.metadata()
|
};
|
||||||
.and_then(|m| m.modified())
|
if let Some(entries) = entries {
|
||||||
.unwrap_or(SystemTime::UNIX_EPOCH);
|
for entry in entries.flatten() {
|
||||||
files.push((path, mtime));
|
let path = entry.path();
|
||||||
|
if path.is_file() && path.extension().and_then(|e| e.to_str()) == Some("txt") {
|
||||||
|
let mtime = entry
|
||||||
|
.metadata()
|
||||||
|
.and_then(|m| m.modified())
|
||||||
|
.unwrap_or(SystemTime::UNIX_EPOCH);
|
||||||
|
files.push((path, mtime));
|
||||||
|
}
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
@@ -43,8 +51,12 @@ pub fn list(root: &Path, limit: usize) -> Result<Vec<CrashItem>> {
|
|||||||
|
|
||||||
let mut items = Vec::new();
|
let mut items = Vec::new();
|
||||||
for (path, mtime) in files {
|
for (path, mtime) in files {
|
||||||
if let Ok(content) = fs::read_to_string(&path) {
|
if let Ok(bytes) = fs::read(&path) {
|
||||||
let item = parse_crash_content(&path, mtime, &content);
|
let content = String::from_utf8_lossy(&bytes);
|
||||||
|
let mut item = parse_crash_content(&path, mtime, &content);
|
||||||
|
if let Ok(relative) = path.strip_prefix(root) {
|
||||||
|
item.id = relative.to_string_lossy().replace('\\', "/");
|
||||||
|
}
|
||||||
items.push(item);
|
items.push(item);
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
@@ -237,6 +249,49 @@ fn explain(
|
|||||||
mod tests {
|
mod tests {
|
||||||
use super::*;
|
use super::*;
|
||||||
|
|
||||||
|
#[test]
|
||||||
|
fn discovers_native_ansi_reports_and_ignores_dump_files() {
|
||||||
|
let root = tempfile::tempdir().unwrap();
|
||||||
|
assert!(list(root.path(), 10).unwrap().is_empty());
|
||||||
|
fs::create_dir_all(root.path().join("Core/Crashes")).unwrap();
|
||||||
|
fs::write(
|
||||||
|
root.path().join("Core/Crashes/report.txt"),
|
||||||
|
b"Exception code: C0000005 \xff\r\n",
|
||||||
|
)
|
||||||
|
.unwrap();
|
||||||
|
fs::write(root.path().join("Core/Crashes/report.dmp"), b"binary").unwrap();
|
||||||
|
let reports = list(root.path(), 10).unwrap();
|
||||||
|
assert_eq!(reports.len(), 1);
|
||||||
|
assert_eq!(reports[0].exception_code.as_deref(), Some("C0000005"));
|
||||||
|
}
|
||||||
|
|
||||||
|
#[test]
|
||||||
|
fn discovers_reports_from_all_worlds_without_filename_collisions() {
|
||||||
|
let root = tempfile::tempdir().unwrap();
|
||||||
|
for relative in [
|
||||||
|
"Core/Crashes",
|
||||||
|
".realms/secondary/Core/Crashes",
|
||||||
|
".realms/reborn/Core/Crashes",
|
||||||
|
] {
|
||||||
|
fs::create_dir_all(root.path().join(relative)).unwrap();
|
||||||
|
fs::write(
|
||||||
|
root.path().join(relative).join("same.txt"),
|
||||||
|
b"Exception code: C0000005",
|
||||||
|
)
|
||||||
|
.unwrap();
|
||||||
|
}
|
||||||
|
let reports = list(root.path(), 10).unwrap();
|
||||||
|
assert_eq!(reports.len(), 3);
|
||||||
|
assert_eq!(
|
||||||
|
reports
|
||||||
|
.iter()
|
||||||
|
.map(|r| &r.id)
|
||||||
|
.collect::<std::collections::HashSet<_>>()
|
||||||
|
.len(),
|
||||||
|
3
|
||||||
|
);
|
||||||
|
}
|
||||||
|
|
||||||
#[test]
|
#[test]
|
||||||
fn parses_assertion_report() {
|
fn parses_assertion_report() {
|
||||||
let report = r#"Revision: AzerothCore rev. df5bcdf26092 2026-10-02 22:08:42 +0500 (coa-bots branch) (Win64, RelWithDebInfo, Static)
|
let report = r#"Revision: AzerothCore rev. df5bcdf26092 2026-10-02 22:08:42 +0500 (coa-bots branch) (Win64, RelWithDebInfo, Static)
|
||||||
|
|||||||
+1003
-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"
|
||||||
|
}
|
||||||
@@ -718,6 +718,24 @@ pub fn export_package(
|
|||||||
"maintenance.json",
|
"maintenance.json",
|
||||||
serde_json::to_string_pretty(&maintenance)?.as_bytes(),
|
serde_json::to_string_pretty(&maintenance)?.as_bytes(),
|
||||||
)?;
|
)?;
|
||||||
|
for (realm, prefix) in [("primary", ""), ("secondary", ".realms/secondary/"), ("reborn", ".realms/reborn/")] {
|
||||||
|
let state = root.join(format!("{prefix}.state"));
|
||||||
|
if let Ok(owner) = fs::read_to_string(state.join("control-owner.json")) {
|
||||||
|
add(&format!("launcher/{realm}/control-owner.json"), redact_json(&owner).as_bytes())?;
|
||||||
|
}
|
||||||
|
for (path, _, _) in newest_files(&state.join("diagnostics"), "jsonl", 20)
|
||||||
|
.into_iter()
|
||||||
|
.filter(|(path, _, _)| path.file_name().is_some_and(|name| name.to_string_lossy().starts_with("manage-")))
|
||||||
|
.take(5)
|
||||||
|
{
|
||||||
|
let bytes = tail(&path, 512 * 1024);
|
||||||
|
let entries: Vec<serde_json::Value> = String::from_utf8_lossy(&bytes).lines().map(|line| {
|
||||||
|
serde_json::from_str(&redact_json(line)).unwrap_or_else(|_| serde_json::Value::String(redact(line)))
|
||||||
|
}).collect();
|
||||||
|
add(&format!("launcher/{realm}/{}.json", path.file_stem().unwrap_or_default().to_string_lossy()),
|
||||||
|
serde_json::to_string_pretty(&entries)?.as_bytes())?;
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
// Logs. The newest update logs of the repack's own updater are added under their own names.
|
// Logs. The newest update logs of the repack's own updater are added under their own names.
|
||||||
let mut logs: Vec<(String, PathBuf)> = vec![
|
let mut logs: Vec<(String, PathBuf)> = vec![
|
||||||
@@ -1257,6 +1275,12 @@ real error
|
|||||||
fs::create_dir_all(meta_dir.join("diagnostics")).unwrap();
|
fs::create_dir_all(meta_dir.join("diagnostics")).unwrap();
|
||||||
fs::write(meta_dir.join("diagnostics/schema-validation-CoA-test.json"), r#"{"problems":[{"table":"creature_display_preset","column":"display_id","detail":"default mismatch"}],"password":"schema-secret"}"#).unwrap();
|
fs::write(meta_dir.join("diagnostics/schema-validation-CoA-test.json"), r#"{"problems":[{"table":"creature_display_preset","column":"display_id","detail":"default mismatch"}],"password":"schema-secret"}"#).unwrap();
|
||||||
fs::write(meta_dir.join("diagnostics/database-recovery-test.json"), r#"{"objects":[{"database":"acore_characters","kind":"TRIGGER","name":"user_character_trigger"}],"password":"recovery-secret"}"#).unwrap();
|
fs::write(meta_dir.join("diagnostics/database-recovery-test.json"), r#"{"objects":[{"database":"acore_characters","kind":"TRIGGER","name":"user_character_trigger"}],"password":"recovery-secret"}"#).unwrap();
|
||||||
|
for prefix in ["", ".realms/secondary/", ".realms/reborn/"] {
|
||||||
|
let state = root.join(format!("{prefix}.state"));
|
||||||
|
fs::create_dir_all(state.join("diagnostics")).unwrap();
|
||||||
|
fs::write(state.join("control-owner.json"), r#"{"pid":42,"action":"start-all","password":"launcher-owner-secret"}"#).unwrap();
|
||||||
|
fs::write(state.join("diagnostics/manage-test.jsonl"), "{\"event\":\"launcher-stage-test\",\"password\":\"launcher-stage-secret\"}\n{\"event\":\"wait_ready.error\",\"port\":3307}\n").unwrap();
|
||||||
|
}
|
||||||
let meta = InstallMeta::new(InstallKind::Imported, &root);
|
let meta = InstallMeta::new(InstallKind::Imported, &root);
|
||||||
let report = run(&root, &meta);
|
let report = run(&root, &meta);
|
||||||
let zip_path = d.path().join("diag.zip");
|
let zip_path = d.path().join("diag.zip");
|
||||||
@@ -1289,6 +1313,9 @@ real error
|
|||||||
assert!(all.contains("checking updates") && all.contains("1234"));
|
assert!(all.contains("checking updates") && all.contains("1234"));
|
||||||
assert!(all.contains("lockFilePresent") && all.contains("does not establish"));
|
assert!(all.contains("lockFilePresent") && all.contains("does not establish"));
|
||||||
assert!(!all.contains("owner-secret"));
|
assert!(!all.contains("owner-secret"));
|
||||||
|
assert!(all.contains("launcher-stage-test"));
|
||||||
|
assert!(all.contains("wait_ready.error"));
|
||||||
|
assert!(!all.contains("launcher-stage-secret"));
|
||||||
assert_eq!(fs::read(meta_dir.join("update.lock")).unwrap(), b"");
|
assert_eq!(fs::read(meta_dir.join("update.lock")).unwrap(), b"");
|
||||||
assert!(
|
assert!(
|
||||||
!all.contains("hunter2")
|
!all.contains("hunter2")
|
||||||
|
|||||||
+127
-316
@@ -1,11 +1,10 @@
|
|||||||
//! Start/stop of a repack-shaped installation by delegating to the repack's own supervisor
|
//! Start/stop of a repack-shaped installation through the repack launcher in this crate
|
||||||
//! (`Runtime\python\python.exe Scripts\manage.py <verb>`), which already implements config rendering, the
|
//! ([`crate::launcher`]): config rendering, the services, the world supervisor, graceful shutdown and readiness.
|
||||||
//! bug-report relay, RA graceful shutdown and readiness. Observation stays native (see `process`).
|
//! 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;
|
||||||
use std::path::{Path, PathBuf};
|
use std::sync::Mutex;
|
||||||
use std::process::{Command, Stdio};
|
|
||||||
use std::time::{Duration, Instant};
|
|
||||||
|
|
||||||
use serde::Serialize;
|
use serde::Serialize;
|
||||||
|
|
||||||
@@ -22,43 +21,15 @@ pub enum Verb {
|
|||||||
}
|
}
|
||||||
|
|
||||||
impl Verb {
|
impl Verb {
|
||||||
fn arg(self) -> &'static str {
|
fn action(self) -> crate::launcher::ops::Action {
|
||||||
|
use crate::launcher::ops::Action;
|
||||||
match self {
|
match self {
|
||||||
Verb::StartAll => "start-all",
|
Verb::StartAll => Action::StartAll,
|
||||||
Verb::StartMysql => "start-mysql",
|
Verb::StartMysql => Action::StartMysql,
|
||||||
Verb::StartWorld => "start-world",
|
Verb::StartWorld => Action::StartWorld,
|
||||||
Verb::StopAll => "stop-all",
|
Verb::StopAll => Action::StopAll,
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
fn timeout(self, root: &Path) -> Duration {
|
|
||||||
match self {
|
|
||||||
Verb::StartAll | Verb::StartWorld if squid_enabled(root) => Duration::from_secs(2700),
|
|
||||||
Verb::StartAll | Verb::StartWorld => Duration::from_secs(720),
|
|
||||||
Verb::StartMysql => Duration::from_secs(360),
|
|
||||||
Verb::StopAll => Duration::from_secs(240),
|
|
||||||
}
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
fn squid_enabled(root: &Path) -> bool {
|
|
||||||
let active = root.join("Core/configs/modules/playerbots.conf");
|
|
||||||
let path = if active.exists() {
|
|
||||||
active
|
|
||||||
} else {
|
|
||||||
root.join("Core/configs/modules/playerbots.conf.dist")
|
|
||||||
};
|
|
||||||
std::fs::read(path)
|
|
||||||
.ok()
|
|
||||||
.and_then(|bytes| crate::config::parser::ConfFile::parse_bytes(&bytes).ok())
|
|
||||||
.is_some_and(|config| {
|
|
||||||
config.get("AiPlayerbot.Enabled").is_none_or(|value| {
|
|
||||||
!matches!(
|
|
||||||
value.trim().trim_matches('"').to_ascii_lowercase().as_str(),
|
|
||||||
"0" | "false" | "no" | "off"
|
|
||||||
)
|
|
||||||
})
|
|
||||||
})
|
|
||||||
}
|
}
|
||||||
|
|
||||||
#[derive(Debug, Clone, Serialize)]
|
#[derive(Debug, Clone, Serialize)]
|
||||||
@@ -71,41 +42,14 @@ pub struct DriverOutcome {
|
|||||||
pub output: String,
|
pub output: String,
|
||||||
}
|
}
|
||||||
|
|
||||||
/// Map the launcher's own messages onto stable error codes. Unknown text stays `Unknown` (details remain visible).
|
fn has_launcher_settings(root: &Path) -> Result<()> {
|
||||||
pub fn translate(output: &str) -> ErrorCode {
|
if !root.join("Settings/repack.json").is_file() {
|
||||||
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() {
|
|
||||||
return Err(Error::Invalid(
|
return Err(Error::Invalid(
|
||||||
"This server has no CoA Repack launcher; start/stop is not available for it yet."
|
"This server has no CoA Repack launcher; start/stop is not available for it yet."
|
||||||
.into(),
|
.into(),
|
||||||
));
|
));
|
||||||
}
|
}
|
||||||
Ok((python, script))
|
Ok(())
|
||||||
}
|
}
|
||||||
|
|
||||||
/// Run a launcher verb to completion (blocking; call from a worker thread).
|
/// Run a launcher verb to completion (blocking; call from a worker thread).
|
||||||
@@ -122,7 +66,69 @@ pub(crate) fn validate_update(root: &Path) -> Result<DriverOutcome> {
|
|||||||
run_inner(root, Verb::StartAll, true)
|
run_inner(root, Verb::StartAll, true)
|
||||||
}
|
}
|
||||||
|
|
||||||
|
pub fn force_stop(root: &Path) -> Result<DriverOutcome> {
|
||||||
|
if crate::docker::is_docker(root) {
|
||||||
|
return Err(Error::Invalid(
|
||||||
|
"Forced shutdown is only available for Windows repacks.".into(),
|
||||||
|
));
|
||||||
|
}
|
||||||
|
for tree in crate::multiworld::Tree::ALL {
|
||||||
|
let path = crate::multiworld::tree_root(root, tree);
|
||||||
|
if crate::multiworld::tree_running(root, tree)
|
||||||
|
|| !crate::process::find_by_exe(&path.join("Core/worldserver.exe")).is_empty()
|
||||||
|
{
|
||||||
|
let child = fsx::ensure_within(root, &path)?;
|
||||||
|
let out = run_inner_mode(&child, Verb::StopAll, false, true)?;
|
||||||
|
if !out.ok || crate::multiworld::tree_running(root, tree) {
|
||||||
|
return Err(Error::Invalid(format!(
|
||||||
|
"An extra world could not stop; the shared database was left running. {}",
|
||||||
|
out.output
|
||||||
|
)));
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
run_inner_mode(root, Verb::StopAll, false, true)
|
||||||
|
}
|
||||||
|
|
||||||
|
fn recover_world_for_forced_stop(root: &Path) -> Result<()> {
|
||||||
|
let worlds = crate::process::find_by_exe(&root.join("Core/worldserver.exe"));
|
||||||
|
if worlds.len() > 1 {
|
||||||
|
return Err(Error::Invalid(
|
||||||
|
"More than one world process belongs to this folder; its database was left running."
|
||||||
|
.into(),
|
||||||
|
));
|
||||||
|
}
|
||||||
|
if let Some(world) = worlds.first() {
|
||||||
|
if !crate::process::is_alive(world) {
|
||||||
|
return Err(Error::Invalid(
|
||||||
|
"The world process identity changed; retry the stop.".into(),
|
||||||
|
));
|
||||||
|
}
|
||||||
|
if crate::process::read_state_record(root, "world")
|
||||||
|
.is_none_or(|saved| !saved.same_as(world))
|
||||||
|
{
|
||||||
|
let record = root.join(".state/world.json");
|
||||||
|
let previous = root.join(".state/world-before-forced-stop-recovery.json");
|
||||||
|
if record.is_file() && !previous.exists() {
|
||||||
|
fsx::atomic_write(&previous, &std::fs::read(&record)?)?;
|
||||||
|
}
|
||||||
|
fsx::atomic_write_json(&record, world)?;
|
||||||
|
tracing::warn!(pid = world.pid, root = %root.display(), "Recovered owned world identity before an explicitly requested forced stop");
|
||||||
|
}
|
||||||
|
}
|
||||||
|
Ok(())
|
||||||
|
}
|
||||||
|
|
||||||
fn run_inner(root: &Path, verb: Verb, validating_update: bool) -> Result<DriverOutcome> {
|
fn run_inner(root: &Path, verb: Verb, validating_update: bool) -> Result<DriverOutcome> {
|
||||||
|
run_inner_mode(root, verb, validating_update, false)
|
||||||
|
}
|
||||||
|
|
||||||
|
fn run_inner_mode(
|
||||||
|
root: &Path,
|
||||||
|
verb: Verb,
|
||||||
|
validating_update: bool,
|
||||||
|
force: bool,
|
||||||
|
) -> Result<DriverOutcome> {
|
||||||
let root = fsx::canonicalize_lenient(root)?;
|
let root = fsx::canonicalize_lenient(root)?;
|
||||||
let _update_lock = if !validating_update && matches!(verb, Verb::StartAll | Verb::StartWorld) {
|
let _update_lock = if !validating_update && matches!(verb, Verb::StartAll | Verb::StartWorld) {
|
||||||
Some(crate::update::operation_lock_for(
|
Some(crate::update::operation_lock_for(
|
||||||
@@ -138,12 +144,16 @@ fn run_inner(root: &Path, verb: Verb, validating_update: bool) -> Result<DriverO
|
|||||||
}
|
}
|
||||||
if matches!(verb, Verb::StartAll | Verb::StartWorld) {
|
if matches!(verb, Verb::StartAll | Verb::StartWorld) {
|
||||||
crate::modules::ensure_bot_exclusivity(&root)?;
|
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) {
|
if crate::docker::is_docker(&root) {
|
||||||
prepare_headless_world(&root, verb)?;
|
prepare_headless_world(&root, verb)?;
|
||||||
return crate::docker::run(&root, verb);
|
return crate::docker::run(&root, verb);
|
||||||
}
|
}
|
||||||
if verb == Verb::StopAll {
|
if verb == Verb::StopAll && !force {
|
||||||
crate::multiworld::stop(&root)?;
|
crate::multiworld::stop(&root)?;
|
||||||
}
|
}
|
||||||
if verb == Verb::StartAll {
|
if verb == Verb::StartAll {
|
||||||
@@ -162,94 +172,51 @@ fn run_inner(root: &Path, verb: Verb, validating_update: bool) -> Result<DriverO
|
|||||||
if matches!(verb, Verb::StartAll | Verb::StartWorld) {
|
if matches!(verb, Verb::StartAll | Verb::StartWorld) {
|
||||||
crate::modules::ensure_bot_exclusivity(&root)?;
|
crate::modules::ensure_bot_exclusivity(&root)?;
|
||||||
}
|
}
|
||||||
let (python, script) = launcher(&root)?;
|
has_launcher_settings(&root)?;
|
||||||
prepare_headless_world(&root, verb)?;
|
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) {
|
if matches!(verb, Verb::StopAll | Verb::StartMysql | Verb::StartAll) {
|
||||||
recover_mysql_launcher_state(&root, verb != Verb::StopAll)?;
|
recover_mysql_launcher_state(&root, verb != Verb::StopAll)?;
|
||||||
}
|
}
|
||||||
let mut cmd = Command::new(&python);
|
if force {
|
||||||
cmd.arg("-B")
|
recover_world_for_forced_stop(&root)?;
|
||||||
.arg("-c")
|
|
||||||
.arg(LAUNCH_SCRIPT)
|
|
||||||
.arg(&script)
|
|
||||||
.arg(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 action = if force {
|
||||||
let mut child = cmd.spawn()?;
|
crate::launcher::ops::Action::ForceStopAll
|
||||||
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();
|
|
||||||
let (ok, exit_code) = match status {
|
|
||||||
Some(st) => (st.success(), st.code()),
|
|
||||||
None => (false, None),
|
|
||||||
};
|
|
||||||
let code = if ok {
|
|
||||||
None
|
|
||||||
} else {
|
} else {
|
||||||
// Log evidence beats the launcher's generic "stopped during startup" message.
|
verb.action()
|
||||||
let base = if status.is_none() {
|
};
|
||||||
ErrorCode::StartupFailed
|
tracing::info!(?verb, root = %root.display(), "driver: starting launcher action");
|
||||||
} else {
|
let lines = Mutex::new(Vec::<String>::new());
|
||||||
translate(&output)
|
let progress = |line: &str| {
|
||||||
};
|
tracing::info!(?verb, "launcher: {line}");
|
||||||
match base {
|
lines.lock().unwrap_or_else(|e| e.into_inner()).push(line.to_string());
|
||||||
ErrorCode::StartupFailed | ErrorCode::Unknown => {
|
};
|
||||||
Some(crate::health::diagnose_installation(&root).unwrap_or(base))
|
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) {
|
if code == Some(ErrorCode::PortInUse) {
|
||||||
let observed = crate::process::observe(&root, &crate::layout::read_ports(&root));
|
let observed = crate::process::observe(&root, &crate::layout::read_ports(&root));
|
||||||
for service in [&observed.mysql, &observed.auth, &observed.world]
|
for service in [&observed.mysql, &observed.auth, &observed.world]
|
||||||
@@ -290,6 +257,9 @@ fn prepare_headless_world(root: &Path, verb: Verb) -> Result<()> {
|
|||||||
if !matches!(verb, Verb::StartAll | Verb::StartWorld) {
|
if !matches!(verb, Verb::StartAll | Verb::StartWorld) {
|
||||||
return Ok(());
|
return Ok(());
|
||||||
}
|
}
|
||||||
|
std::fs::create_dir_all(root.join("Core/Crashes"))?;
|
||||||
|
let probe = tempfile::NamedTempFile::new_in(root.join("Core/Crashes"))?;
|
||||||
|
probe.close()?;
|
||||||
for relative in [
|
for relative in [
|
||||||
"Settings/worldserver.conf.template",
|
"Settings/worldserver.conf.template",
|
||||||
"Core/configs/worldserver.conf",
|
"Core/configs/worldserver.conf",
|
||||||
@@ -314,35 +284,6 @@ fn prepare_headless_world(root: &Path, verb: Verb) -> Result<()> {
|
|||||||
Ok(())
|
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
|
/// A lost launcher record must not hide this installation's running MySQL from
|
||||||
/// graceful shutdown. Adopt only the exact executable owning its configured port.
|
/// graceful shutdown. Adopt only the exact executable owning its configured port.
|
||||||
fn recover_mysql_launcher_state(root: &Path, prefer_listener: bool) -> Result<()> {
|
fn recover_mysql_launcher_state(root: &Path, prefer_listener: bool) -> Result<()> {
|
||||||
@@ -393,60 +334,6 @@ fn recover_mysql_launcher_state(root: &Path, prefer_listener: bool) -> Result<()
|
|||||||
Ok(())
|
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 {
|
pub(crate) fn startup_failure(root: &Path, started: &DriverOutcome) -> String {
|
||||||
let code = started
|
let code = started
|
||||||
.code
|
.code
|
||||||
@@ -548,7 +435,7 @@ mod tests {
|
|||||||
text.contains("launcher request failed before completion")
|
text.contains("launcher request failed before completion")
|
||||||
&& text.contains("in progress")
|
&& text.contains("in progress")
|
||||||
);
|
);
|
||||||
assert!(!text.contains("starting launcher verb"));
|
assert!(!text.contains("starting launcher action"));
|
||||||
}
|
}
|
||||||
|
|
||||||
#[test]
|
#[test]
|
||||||
@@ -587,6 +474,7 @@ mod tests {
|
|||||||
let folder = tempfile::tempdir().unwrap();
|
let folder = tempfile::tempdir().unwrap();
|
||||||
let root = folder.path();
|
let root = folder.path();
|
||||||
prepare_headless_world(root, Verb::StartAll).unwrap();
|
prepare_headless_world(root, Verb::StartAll).unwrap();
|
||||||
|
assert!(root.join("Core/Crashes").is_dir());
|
||||||
std::fs::create_dir_all(root.join("Core/configs")).unwrap();
|
std::fs::create_dir_all(root.join("Core/configs")).unwrap();
|
||||||
let path = root.join("Core/configs/worldserver.conf");
|
let path = root.join("Core/configs/worldserver.conf");
|
||||||
for original in [
|
for original in [
|
||||||
@@ -604,78 +492,10 @@ mod tests {
|
|||||||
}
|
}
|
||||||
|
|
||||||
#[test]
|
#[test]
|
||||||
fn large_squid_provisioning_has_time_to_finish_without_extending_shutdown() {
|
fn launcher_failures_carry_their_error_code() {
|
||||||
let folder = tempfile::tempdir().unwrap();
|
let e = Error::Service(ErrorCode::PortInUse, "Port 8085 is already used (PID 4).".into());
|
||||||
let modules = folder.path().join("Core/configs/modules");
|
assert_eq!(e.code(), ErrorCode::PortInUse);
|
||||||
std::fs::create_dir_all(&modules).unwrap();
|
assert_eq!(e.to_string(), "Port 8085 is already used (PID 4).");
|
||||||
std::fs::write(
|
|
||||||
modules.join("playerbots.conf.dist"),
|
|
||||||
"AiPlayerbot.Enabled = 1\n",
|
|
||||||
)
|
|
||||||
.unwrap();
|
|
||||||
assert_eq!(
|
|
||||||
Verb::StartAll.timeout(folder.path()),
|
|
||||||
Duration::from_secs(2700)
|
|
||||||
);
|
|
||||||
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(720)
|
|
||||||
);
|
|
||||||
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);
|
|
||||||
}
|
}
|
||||||
|
|
||||||
#[test]
|
#[test]
|
||||||
@@ -718,13 +538,4 @@ mod tests {
|
|||||||
assert!(!reason.contains("private"));
|
assert!(!reason.contains("private"));
|
||||||
assert!(!reason.contains("Something went wrong"));
|
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),
|
UnknownInstallation(String),
|
||||||
#[error("{0}")]
|
#[error("{0}")]
|
||||||
Invalid(String),
|
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}")]
|
#[error("package not published: {0}")]
|
||||||
PackageNotPublished(String),
|
PackageNotPublished(String),
|
||||||
#[error("download server unreachable: {0}")]
|
#[error("download server unreachable: {0}")]
|
||||||
@@ -199,6 +202,7 @@ impl Error {
|
|||||||
Error::PackageNotPublished(_) => ErrorCode::PackageNotPublished,
|
Error::PackageNotPublished(_) => ErrorCode::PackageNotPublished,
|
||||||
Error::NetworkUnreachable(_) => ErrorCode::NetworkUnreachable,
|
Error::NetworkUnreachable(_) => ErrorCode::NetworkUnreachable,
|
||||||
Error::BotModulesConflict => ErrorCode::BotModulesConflict,
|
Error::BotModulesConflict => ErrorCode::BotModulesConflict,
|
||||||
|
Error::Service(code, _) => *code,
|
||||||
Error::CompanionTemplatesMissing => ErrorCode::CompanionTemplatesMissing,
|
Error::CompanionTemplatesMissing => ErrorCode::CompanionTemplatesMissing,
|
||||||
Error::CompanionCommandUnsupported => ErrorCode::CompanionCommandUnsupported,
|
Error::CompanionCommandUnsupported => ErrorCode::CompanionCommandUnsupported,
|
||||||
_ => ErrorCode::Unknown,
|
_ => ErrorCode::Unknown,
|
||||||
|
|||||||
@@ -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,50 +0,0 @@
|
|||||||
import runpy
|
|
||||||
import sys
|
|
||||||
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"]
|
|
||||||
|
|
||||||
|
|
||||||
def wait_ready(name, port, seconds=180):
|
|
||||||
return original_wait(name, port, max(seconds, 300) if name == "mysql" else seconds)
|
|
||||||
|
|
||||||
|
|
||||||
launcher["start_mysql"].__globals__["wait_ready"] = wait_ready
|
|
||||||
if sys.argv[1] == "stop-all":
|
|
||||||
shutdown = launcher["stop_all"].__globals__
|
|
||||||
if "ra" in shutdown:
|
|
||||||
original_ra = shutdown["ra"]
|
|
||||||
|
|
||||||
class UnsafeShutdown(Exception):
|
|
||||||
pass
|
|
||||||
|
|
||||||
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."
|
|
||||||
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.")
|
|
||||||
return "Stopped this server's recorded world process without its unavailable console."
|
|
||||||
|
|
||||||
shutdown["ra"] = shutdown_command
|
|
||||||
config = launcher["settings"]()
|
|
||||||
with launcher["control_lock"]():
|
|
||||||
launcher["stop_all"](config)
|
|
||||||
else:
|
|
||||||
launcher["main"]()
|
|
||||||
@@ -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,11 +9,13 @@
|
|||||||
|
|
||||||
pub mod accounts;
|
pub mod accounts;
|
||||||
pub mod allsettings;
|
pub mod allsettings;
|
||||||
|
pub mod addons;
|
||||||
pub mod backup;
|
pub mod backup;
|
||||||
pub mod channels;
|
pub mod channels;
|
||||||
pub mod character_start_check;
|
pub mod character_start_check;
|
||||||
pub mod cleanbase;
|
pub mod cleanbase;
|
||||||
pub mod client;
|
pub mod client;
|
||||||
|
pub mod client_graphics;
|
||||||
pub mod clientdl;
|
pub mod clientdl;
|
||||||
pub mod companions;
|
pub mod companions;
|
||||||
pub mod config;
|
pub mod config;
|
||||||
@@ -27,6 +29,7 @@ pub mod diag;
|
|||||||
pub mod docker;
|
pub mod docker;
|
||||||
pub mod download;
|
pub mod download;
|
||||||
pub mod driver;
|
pub mod driver;
|
||||||
|
pub mod legacy_launcher;
|
||||||
pub mod error;
|
pub mod error;
|
||||||
pub mod firewall;
|
pub mod firewall;
|
||||||
pub mod friends;
|
pub mod friends;
|
||||||
@@ -35,7 +38,9 @@ pub mod glue_config;
|
|||||||
pub mod health;
|
pub mod health;
|
||||||
pub mod install;
|
pub mod install;
|
||||||
pub mod layout;
|
pub mod layout;
|
||||||
|
pub mod launcher;
|
||||||
pub mod logging;
|
pub mod logging;
|
||||||
|
pub mod server_logging;
|
||||||
pub mod manifest;
|
pub mod manifest;
|
||||||
pub mod migrations;
|
pub mod migrations;
|
||||||
pub mod modules;
|
pub mod modules;
|
||||||
@@ -52,9 +57,11 @@ pub mod ra;
|
|||||||
pub mod race_availability;
|
pub mod race_availability;
|
||||||
pub mod realm_registry;
|
pub mod realm_registry;
|
||||||
pub mod realmlist;
|
pub mod realmlist;
|
||||||
|
pub mod realm_names;
|
||||||
pub mod realms;
|
pub mod realms;
|
||||||
pub mod registry;
|
pub mod registry;
|
||||||
pub mod release;
|
pub mod release;
|
||||||
|
pub mod release_history;
|
||||||
pub mod release_schema;
|
pub mod release_schema;
|
||||||
pub mod remote_client;
|
pub mod remote_client;
|
||||||
pub mod repair;
|
pub mod repair;
|
||||||
|
|||||||
@@ -307,6 +307,51 @@ pub struct Item {
|
|||||||
pub error: Option<String>,
|
pub error: Option<String>,
|
||||||
}
|
}
|
||||||
|
|
||||||
|
#[derive(Debug, Serialize)]
|
||||||
|
#[serde(rename_all = "camelCase")]
|
||||||
|
pub struct Audit {
|
||||||
|
pub total: usize,
|
||||||
|
pub applied: usize,
|
||||||
|
pub checksum_verified: usize,
|
||||||
|
pub legacy_unknown: usize,
|
||||||
|
}
|
||||||
|
|
||||||
|
pub fn inventory_sha256(list: &[Migration]) -> Result<String> {
|
||||||
|
let inventory: Vec<_> = list
|
||||||
|
.iter()
|
||||||
|
.map(|m| (&m.db, &m.id, &m.sha256, &m.compatible_sha256, m.destructive))
|
||||||
|
.collect();
|
||||||
|
Ok(fsx::sha256_bytes(&serde_json::to_vec(&inventory)?))
|
||||||
|
}
|
||||||
|
|
||||||
|
pub fn audit_applied(store: &dyn Store, list: &[Migration]) -> Result<Audit> {
|
||||||
|
let rows = store.load_readonly()?;
|
||||||
|
check_history(&rows, list)?;
|
||||||
|
let mut audit = Audit {
|
||||||
|
total: list.len(),
|
||||||
|
applied: 0,
|
||||||
|
checksum_verified: 0,
|
||||||
|
legacy_unknown: 0,
|
||||||
|
};
|
||||||
|
for migration in list {
|
||||||
|
let row = recorded(&rows, migration)
|
||||||
|
.filter(|r| r.status == Status::Applied)
|
||||||
|
.ok_or_else(|| {
|
||||||
|
Error::Invalid(format!(
|
||||||
|
"Release migration {} ({}) is not recorded as applied.",
|
||||||
|
migration.id, migration.db
|
||||||
|
))
|
||||||
|
})?;
|
||||||
|
audit.applied += 1;
|
||||||
|
if row.sha256 == "0".repeat(64) {
|
||||||
|
audit.legacy_unknown += 1;
|
||||||
|
} else {
|
||||||
|
audit.checksum_verified += 1;
|
||||||
|
}
|
||||||
|
}
|
||||||
|
Ok(audit)
|
||||||
|
}
|
||||||
|
|
||||||
pub fn status(store: &dyn Store, list: &[Migration]) -> Result<Vec<Item>> {
|
pub fn status(store: &dyn Store, list: &[Migration]) -> Result<Vec<Item>> {
|
||||||
let rows = store.load()?;
|
let rows = store.load()?;
|
||||||
Ok(list
|
Ok(list
|
||||||
@@ -358,7 +403,7 @@ fn preserve_auth_history(store: &dyn Store, rows: &[LedgerRow], list: &[Migratio
|
|||||||
}
|
}
|
||||||
|
|
||||||
/// Migrations that were published with different bytes but have the same effect, so a server that applied either
|
/// Migrations that were published with different bytes but have the same effect, so a server that applied either
|
||||||
/// version accepts the other. The Wildcard table repair went out as `c1d8…` (0.261005.0, 0.261006.1) and as `9e4a…`
|
/// version accepts the other. The Wildcard table repair went out as `c1d8…` (0.261005.0, 0.261006.1) and as `9e4a…`
|
||||||
/// (0.261005.22, 0.261007.24); the packages carry no list of compatible versions, so the Manager knows this pair.
|
/// (0.261005.22, 0.261007.24); the packages carry no list of compatible versions, so the Manager knows this pair.
|
||||||
const SAME_EFFECT: &[(&str, &[&str])] = &[(
|
const SAME_EFFECT: &[(&str, &[&str])] = &[(
|
||||||
"manager_repair__20261005_missing_wildcard_tables",
|
"manager_repair__20261005_missing_wildcard_tables",
|
||||||
@@ -667,6 +712,61 @@ mod tests {
|
|||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
|
#[test]
|
||||||
|
fn qualification_inventory_digest_matches_release_pipeline_encoding() {
|
||||||
|
let list = vec![Migration {
|
||||||
|
id: "one".into(),
|
||||||
|
db: "world".into(),
|
||||||
|
sha256: "a".repeat(64),
|
||||||
|
compatible_sha256: vec![],
|
||||||
|
destructive: false,
|
||||||
|
}];
|
||||||
|
assert_eq!(
|
||||||
|
inventory_sha256(&list).unwrap(),
|
||||||
|
"b35e45f666304500e69ff352f83103910075ace998afb7915b548765b8c30703"
|
||||||
|
);
|
||||||
|
}
|
||||||
|
|
||||||
|
#[test]
|
||||||
|
fn qualification_rejects_missing_interrupted_failed_and_changed_history() {
|
||||||
|
let (_dir, list) = setup(&[("world", "qualification_probe", "SELECT 1;")]);
|
||||||
|
let store = Mem::default();
|
||||||
|
assert!(audit_applied(&store, &list).is_err());
|
||||||
|
for status in [Status::Running, Status::Failed, Status::Pending] {
|
||||||
|
store
|
||||||
|
.put(&LedgerRow {
|
||||||
|
db: "world".into(),
|
||||||
|
id: list[0].id.clone(),
|
||||||
|
sha256: list[0].sha256.clone(),
|
||||||
|
status,
|
||||||
|
error: None,
|
||||||
|
baseline: false,
|
||||||
|
})
|
||||||
|
.unwrap();
|
||||||
|
assert!(audit_applied(&store, &list).is_err());
|
||||||
|
}
|
||||||
|
store
|
||||||
|
.put(&LedgerRow {
|
||||||
|
db: "world".into(),
|
||||||
|
id: list[0].id.clone(),
|
||||||
|
sha256: "a".repeat(64),
|
||||||
|
status: Status::Applied,
|
||||||
|
error: None,
|
||||||
|
baseline: false,
|
||||||
|
})
|
||||||
|
.unwrap();
|
||||||
|
assert!(audit_applied(&store, &list).is_err());
|
||||||
|
store.rows.borrow_mut()[0].sha256 = list[0].sha256.clone();
|
||||||
|
assert_eq!(audit_applied(&store, &list).unwrap().checksum_verified, 1);
|
||||||
|
store.rows.borrow_mut()[0].sha256 = "0".repeat(64);
|
||||||
|
let audit = audit_applied(&store, &list).unwrap();
|
||||||
|
assert_eq!(
|
||||||
|
(audit.applied, audit.checksum_verified, audit.legacy_unknown),
|
||||||
|
(1, 0, 1)
|
||||||
|
);
|
||||||
|
assert!(store.ran.borrow().is_empty());
|
||||||
|
}
|
||||||
|
|
||||||
fn setup(files: &[(&str, &str, &str)]) -> (tempfile::TempDir, Vec<Migration>) {
|
fn setup(files: &[(&str, &str, &str)]) -> (tempfile::TempDir, Vec<Migration>) {
|
||||||
let d = tempfile::tempdir().unwrap();
|
let d = tempfile::tempdir().unwrap();
|
||||||
let mut list = Vec::new();
|
let mut list = Vec::new();
|
||||||
|
|||||||
@@ -48,6 +48,10 @@ pub struct Entry {
|
|||||||
/// Not shown on the Modules page; its settings are offered elsewhere (a server setting card).
|
/// Not shown on the Modules page; its settings are offered elsewhere (a server setting card).
|
||||||
#[serde(default)]
|
#[serde(default)]
|
||||||
pub hidden: bool,
|
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 {
|
fn yes() -> bool {
|
||||||
@@ -111,6 +115,7 @@ pub struct ModuleView {
|
|||||||
pub page: Option<String>,
|
pub page: Option<String>,
|
||||||
pub hidden: bool,
|
pub hidden: bool,
|
||||||
pub compatibility: String,
|
pub compatibility: String,
|
||||||
|
pub part_of: Option<String>,
|
||||||
}
|
}
|
||||||
|
|
||||||
pub fn list(root: &Path) -> Vec<ModuleView> {
|
pub fn list(root: &Path) -> Vec<ModuleView> {
|
||||||
@@ -171,6 +176,32 @@ fn installed_module_commits(root: &Path) -> BTreeMap<String, String> {
|
|||||||
Default::default()
|
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> {
|
fn list_in(cat: &[Entry], root: &Path) -> Vec<ModuleView> {
|
||||||
let installed_commits = installed_module_commits(root);
|
let installed_commits = installed_module_commits(root);
|
||||||
let wildcard = crate::realms::state(root)
|
let wildcard = crate::realms::state(root)
|
||||||
@@ -197,7 +228,15 @@ fn list_in(cat: &[Entry], root: &Path) -> Vec<ModuleView> {
|
|||||||
.and_then(|c| c.get(&e.enable_key).map(truthy))
|
.and_then(|c| c.get(&e.enable_key).map(truthy))
|
||||||
.unwrap_or(e.default_on)
|
.unwrap_or(e.default_on)
|
||||||
};
|
};
|
||||||
let blocked = wildcard && matches!(e.id.as_str(), "companions" | "playerbots");
|
let dependency_missing = e.id == "dungeon-clear"
|
||||||
|
&& entry_in(cat, "playerbots")
|
||||||
|
.and_then(|entry| bot_enabled(root, &entry))
|
||||||
|
.map(|enabled| !enabled)
|
||||||
|
.unwrap_or(true);
|
||||||
|
let blocked = dependency_missing
|
||||||
|
|| (wildcard
|
||||||
|
&& (matches!(e.id.as_str(), "playerbots" | "dungeon-clear")
|
||||||
|
|| (e.id == "companions" && !companions_on_other_realms(root))));
|
||||||
let version = if e.id == "playerbots" {
|
let version = if e.id == "playerbots" {
|
||||||
crate::squid::release(root).map(|release| {
|
crate::squid::release(root).map(|release| {
|
||||||
[
|
[
|
||||||
@@ -228,7 +267,9 @@ fn list_in(cat: &[Entry], root: &Path) -> Vec<ModuleView> {
|
|||||||
};
|
};
|
||||||
ModuleView {
|
ModuleView {
|
||||||
version,
|
version,
|
||||||
compatibility: if blocked {
|
compatibility: if dependency_missing {
|
||||||
|
"requires-squid"
|
||||||
|
} else if blocked {
|
||||||
"unsupported"
|
"unsupported"
|
||||||
} else if wildcard && e.id != "client-compat" {
|
} else if wildcard && e.id != "client-compat" {
|
||||||
"experimental"
|
"experimental"
|
||||||
@@ -248,6 +289,7 @@ fn list_in(cat: &[Entry], root: &Path) -> Vec<ModuleView> {
|
|||||||
icon: e.icon,
|
icon: e.icon,
|
||||||
page: e.page,
|
page: e.page,
|
||||||
hidden: e.hidden,
|
hidden: e.hidden,
|
||||||
|
part_of: e.part_of,
|
||||||
}
|
}
|
||||||
})
|
})
|
||||||
.collect()
|
.collect()
|
||||||
@@ -296,7 +338,7 @@ fn require_bot_server_stopped(root: &Path) -> Result<()> {
|
|||||||
pub fn set_enabled(root: &Path, meta: &Path, id: &str, on: bool) -> Result<()> {
|
pub fn set_enabled(root: &Path, meta: &Path, id: &str, on: bool) -> Result<()> {
|
||||||
let _update_lock = crate::update::operation_lock(meta)?;
|
let _update_lock = crate::update::operation_lock(meta)?;
|
||||||
crate::update::ensure_recovered(meta)?;
|
crate::update::ensure_recovered(meta)?;
|
||||||
let _lock = if matches!(id, "companions" | "playerbots") {
|
let _lock = if matches!(id, "companions" | "playerbots" | "dungeon-clear") {
|
||||||
require_bot_server_stopped(root)?;
|
require_bot_server_stopped(root)?;
|
||||||
fs::create_dir_all(root.join(".state"))?;
|
fs::create_dir_all(root.join(".state"))?;
|
||||||
let lock = fs::OpenOptions::new()
|
let lock = fs::OpenOptions::new()
|
||||||
@@ -317,6 +359,9 @@ pub fn set_enabled(root: &Path, meta: &Path, id: &str, on: bool) -> Result<()> {
|
|||||||
};
|
};
|
||||||
if on {
|
if on {
|
||||||
crate::realms::guard_module(root, id)?;
|
crate::realms::guard_module(root, id)?;
|
||||||
|
if id == "dungeon-clear" {
|
||||||
|
crate::realms::guard_module(root, "playerbots")?;
|
||||||
|
}
|
||||||
}
|
}
|
||||||
if id == "custom-races" {
|
if id == "custom-races" {
|
||||||
if let Ok(meta_content) = fs::read_to_string(meta.join("install.json")) {
|
if let Ok(meta_content) = fs::read_to_string(meta.join("install.json")) {
|
||||||
@@ -379,6 +424,9 @@ pub fn ensure_bot_exclusivity(root: &Path) -> Result<()> {
|
|||||||
|
|
||||||
fn set_enabled_in(cat: &[Entry], root: &Path, meta: &Path, id: &str, on: bool) -> Result<()> {
|
fn set_enabled_in(cat: &[Entry], root: &Path, meta: &Path, id: &str, on: bool) -> Result<()> {
|
||||||
let e = entry_in(cat, id)?;
|
let e = entry_in(cat, id)?;
|
||||||
|
if on && id == "dungeon-clear" && !bot_enabled(root, &entry_in(cat, "playerbots")?)? {
|
||||||
|
return Err(Error::Invalid("Enable SQUID bots before enabling Dungeon Clear.".into()));
|
||||||
|
}
|
||||||
if !e.switchable || e.enable_key.is_empty() {
|
if !e.switchable || e.enable_key.is_empty() {
|
||||||
return Err(Error::Invalid("This part cannot be switched off.".into()));
|
return Err(Error::Invalid("This part cannot be switched off.".into()));
|
||||||
}
|
}
|
||||||
@@ -394,6 +442,15 @@ fn set_enabled_in(cat: &[Entry], root: &Path, meta: &Path, id: &str, on: bool) -
|
|||||||
}
|
}
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
if (id == "playerbots" && !on) || (id == "companions" && on) {
|
||||||
|
if let Some(dependency) = cat.iter().find(|entry| entry.id == "dungeon-clear") {
|
||||||
|
if dir(root).join(&dependency.conf).exists()
|
||||||
|
|| dir(root).join(format!("{}.dist", dependency.conf)).exists()
|
||||||
|
{
|
||||||
|
set_enabled_in(cat, root, meta, "dungeon-clear", false)?;
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
let conf = active_file(root, &e)?;
|
let conf = active_file(root, &e)?;
|
||||||
let mut file = ConfFile::parse_bytes(&fs::read(&conf)?)?;
|
let mut file = ConfFile::parse_bytes(&fs::read(&conf)?)?;
|
||||||
if file.get(&e.enable_key).map(truthy).unwrap_or(e.default_on) == on
|
if file.get(&e.enable_key).map(truthy).unwrap_or(e.default_on) == on
|
||||||
@@ -693,6 +750,27 @@ mod tests {
|
|||||||
assert!(meta.join("backups").exists());
|
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> {
|
fn test_catalog() -> Vec<Entry> {
|
||||||
let one = |id: &str, name: &str, conf: &str, key: &str| Entry {
|
let one = |id: &str, name: &str, conf: &str, key: &str| Entry {
|
||||||
id: id.into(),
|
id: id.into(),
|
||||||
@@ -711,6 +789,7 @@ mod tests {
|
|||||||
icon: String::new(),
|
icon: String::new(),
|
||||||
page: None,
|
page: None,
|
||||||
hidden: false,
|
hidden: false,
|
||||||
|
part_of: None,
|
||||||
};
|
};
|
||||||
vec![
|
vec![
|
||||||
one(
|
one(
|
||||||
@@ -818,6 +897,27 @@ mod tests {
|
|||||||
);
|
);
|
||||||
}
|
}
|
||||||
|
|
||||||
|
#[test]
|
||||||
|
fn dungeon_clear_requires_squid_and_stays_off_after_squid_is_reenabled() {
|
||||||
|
let d = tempfile::tempdir().unwrap();
|
||||||
|
let root = d.path();
|
||||||
|
fs::create_dir_all(dir(root)).unwrap();
|
||||||
|
fs::write(dir(root).join("playerbots.conf"), "AiPlayerbot.Enabled = 0\n").unwrap();
|
||||||
|
fs::write(dir(root).join("mod_coa_playerbots.conf"), "CoaBots.Enable = 0\n").unwrap();
|
||||||
|
let dungeon = dir(root).join("mod_dungeon_clear.conf");
|
||||||
|
fs::write(&dungeon, "DungeonClear.Enable = 0\n").unwrap();
|
||||||
|
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);
|
||||||
|
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());
|
||||||
|
}
|
||||||
|
|
||||||
#[test]
|
#[test]
|
||||||
fn bot_systems_are_mutually_exclusive_in_both_directions_and_manual_configs() {
|
fn bot_systems_are_mutually_exclusive_in_both_directions_and_manual_configs() {
|
||||||
let d = tempfile::tempdir().unwrap();
|
let d = tempfile::tempdir().unwrap();
|
||||||
@@ -1335,6 +1435,7 @@ mod tests {
|
|||||||
icon: String::new(),
|
icon: String::new(),
|
||||||
page: None,
|
page: None,
|
||||||
hidden: false,
|
hidden: false,
|
||||||
|
part_of: None,
|
||||||
};
|
};
|
||||||
let cat = vec![compat];
|
let cat = vec![compat];
|
||||||
let v = list_in(&cat, &root).remove(0);
|
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))
|
.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.
|
/// Any of the extra worlds is running or still stopping.
|
||||||
pub fn is_running(main: &Path) -> bool {
|
pub fn is_running(main: &Path) -> bool {
|
||||||
Tree::ALL.into_iter().any(|t| tree_running(main, t))
|
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));
|
let status = process::observe(main, &crate::layout::read_ports(main));
|
||||||
if status.world.state != ServiceState::Stopped
|
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"))?,
|
&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"))? {
|
for entry in fs::read_dir(main.join("Core"))? {
|
||||||
let entry = entry?;
|
let entry = entry?;
|
||||||
if entry.file_type()?.is_file()
|
if entry.file_type()?.is_file()
|
||||||
@@ -349,25 +406,18 @@ fn prepare(main: &Path, tree: Tree) -> Result<PathBuf> {
|
|||||||
..Default::default()
|
..Default::default()
|
||||||
},
|
},
|
||||||
)?;
|
)?;
|
||||||
let source = fs::read_to_string(main.join("Scripts/manage.py"))?;
|
// The world supervisor and the bug-report relay of the extra world (the launcher itself runs in the Manager
|
||||||
let source = secondary_launcher(&source)?;
|
// and knows that this world shares the main database).
|
||||||
fsx::atomic_write(&second.join("Scripts/manage.py"), source.as_bytes())?;
|
for script in ["Scripts/coa-launcher.exe", "Scripts/manage.py"] {
|
||||||
Ok(second)
|
let target = second.join(script);
|
||||||
}
|
if main.join(script).is_file() {
|
||||||
|
fs::create_dir_all(second.join("Scripts"))?;
|
||||||
fn secondary_launcher(source: &str) -> Result<String> {
|
fsx::atomic_write(&target, &fs::read(main.join(script))?)?;
|
||||||
let marker = "def start_world(config, offset):\n start_mysql(config)";
|
} else if target.exists() {
|
||||||
let source = source.replace("\r\n", "\n");
|
fs::remove_file(&target)?;
|
||||||
if !source.contains(marker) {
|
}
|
||||||
return Err(Error::Invalid(
|
|
||||||
"The launcher does not support a shared database world. Update the server first."
|
|
||||||
.into(),
|
|
||||||
));
|
|
||||||
}
|
}
|
||||||
Ok(source.replace(
|
Ok(second)
|
||||||
marker,
|
|
||||||
"def start_world(config, offset):\n mysql(admin=\"ping\")",
|
|
||||||
))
|
|
||||||
}
|
}
|
||||||
|
|
||||||
fn start_tree(main: &Path, tree: Tree) -> Result<()> {
|
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<()> {
|
fn stop_tree(main: &Path, tree: Tree) -> Result<()> {
|
||||||
let second = tree_root(main, tree);
|
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) {
|
if tree_running(main, tree) {
|
||||||
return Err(Error::Invalid(format!(
|
return Err(Error::Invalid(format!(
|
||||||
"The running {}'s launcher is missing. The shared database was left running.",
|
"The running {}'s launcher is missing. The shared database was left running.",
|
||||||
@@ -497,15 +547,12 @@ mod tests {
|
|||||||
)
|
)
|
||||||
.unwrap();
|
.unwrap();
|
||||||
let err = set_reborn_enabled(t.path(), true).unwrap_err().to_string();
|
let err = set_reborn_enabled(t.path(), true).unwrap_err().to_string();
|
||||||
assert!(err.contains("Select Conquest of Azeroth first"), "{err}");
|
let expected = if cfg!(windows) {
|
||||||
|
"Select Conquest of Azeroth first"
|
||||||
|
} else {
|
||||||
|
"Simultaneous realms currently require Windows"
|
||||||
|
};
|
||||||
|
assert!(err.contains(expected), "{err}");
|
||||||
assert!(!realms::state(t.path()).unwrap().with_reborn);
|
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> {
|
pub fn query(root: &Path) -> Result<Population> {
|
||||||
let db = Db::from_repack(root, Account::App)?;
|
let mode = crate::realms::state(root)
|
||||||
query_with(
|
.map(|s| s.active)
|
||||||
&db,
|
.unwrap_or(crate::realms::Mode::Coa);
|
||||||
&bot_account_prefix(root),
|
query_for_realm(root, mode)
|
||||||
&crate::accounts::squid_bot_prefix(root),
|
|
||||||
)
|
|
||||||
}
|
}
|
||||||
|
|
||||||
fn counts_sql(prefix: &str, squid_prefix: &str) -> Result<String> {
|
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]
|
if [prefix, squid_prefix]
|
||||||
.iter()
|
.iter()
|
||||||
.any(|prefix| prefix.is_empty() || !prefix.chars().all(|c| c.is_ascii_alphanumeric()))
|
.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 =
|
let bots =
|
||||||
format!("(UPPER(a.username) LIKE '{prefix}%' OR UPPER(a.username) LIKE '{squid_prefix}%')");
|
format!("(UPPER(a.username) LIKE '{prefix}%' OR UPPER(a.username) LIKE '{squid_prefix}%')");
|
||||||
Ok(format!(
|
Ok(format!(
|
||||||
"SELECT (SELECT COUNT(*) FROM acore_characters.characters WHERE online=1), \
|
"SELECT (SELECT COUNT(*) FROM {chars_db}.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 {chars_db}.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 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)?)?)
|
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)]
|
#[derive(Debug, Clone, Serialize)]
|
||||||
pub struct Hardware {
|
pub struct Hardware {
|
||||||
pub cores: u32,
|
pub cores: u32,
|
||||||
|
|||||||
@@ -58,6 +58,23 @@ impl Ra {
|
|||||||
Self::connect_to(read_ports(root).ra, &cfg.ra_username, &cfg.ra_password)
|
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> {
|
pub fn connect_to(port: u16, user: &str, password: &str) -> Result<Ra> {
|
||||||
let addr: SocketAddr = ([127, 0, 0, 1], port).into();
|
let addr: SocketAddr = ([127, 0, 0, 1], port).into();
|
||||||
let mut stream =
|
let mut stream =
|
||||||
@@ -87,7 +104,28 @@ impl Ra {
|
|||||||
let c = crate::console::check_command(cmd)?;
|
let c = crate::console::check_command(cmd)?;
|
||||||
self.command(c)
|
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> {
|
fn command(&mut self, cmd: &str) -> Result<String> {
|
||||||
debug_assert!(!cmd.contains(['\r', '\n']));
|
debug_assert!(!cmd.contains(['\r', '\n']));
|
||||||
self.stream.write_all(format!("{cmd}\r\n").as_bytes())?;
|
self.stream.write_all(format!("{cmd}\r\n").as_bytes())?;
|
||||||
@@ -235,6 +273,11 @@ impl Ra {
|
|||||||
Ok(out.lines().last().unwrap_or("").to_string())
|
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.
|
/// 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> {
|
pub fn spawn_bots(&mut self, count: u32) -> Result<String> {
|
||||||
if !(1..=2000).contains(&count) {
|
if !(1..=2000).contains(&count) {
|
||||||
@@ -249,6 +292,41 @@ impl Ra {
|
|||||||
Ok(out.lines().last().unwrap_or("").to_string())
|
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.
|
/// Set a new password for an existing account.
|
||||||
pub fn set_account_password(&mut self, name: &str, password: &str) -> Result<()> {
|
pub fn set_account_password(&mut self, name: &str, password: &str) -> Result<()> {
|
||||||
validate_account(name, password)?;
|
validate_account(name, password)?;
|
||||||
|
|||||||
@@ -269,9 +269,95 @@ pub fn save(
|
|||||||
),
|
),
|
||||||
]),
|
]),
|
||||||
)?;
|
)?;
|
||||||
|
write_snapshot(root, ¤t.catalog_sha256, ¤t.races)?;
|
||||||
status(root)
|
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)]
|
#[cfg(test)]
|
||||||
mod tests {
|
mod tests {
|
||||||
use super::*;
|
use super::*;
|
||||||
@@ -292,6 +378,91 @@ mod tests {
|
|||||||
bytes
|
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]
|
#[test]
|
||||||
fn catalog_preserves_ids_and_excludes_stock_and_nonplayable() {
|
fn catalog_preserves_ids_and_excludes_stock_and_nonplayable() {
|
||||||
let mut bytes = dbc();
|
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<()> {
|
pub fn guard_module(root: &Path, id: &str) -> Result<()> {
|
||||||
if state(root)?.active != Mode::Coa && matches!(id, "companions" | "playerbots") {
|
let s = state(root)?;
|
||||||
return Err(Error::Invalid("Bot class mechanics have not been validated for this realm. This module is unavailable on this realm.".into()));
|
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(())
|
Ok(())
|
||||||
}
|
}
|
||||||
@@ -296,20 +308,14 @@ fn wildcard_configs(mut files: Files) -> Result<Files> {
|
|||||||
}
|
}
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
for (key, value) in [("CoaBots.Enable", "0"), ("CoaBots.AutoLoginOnStartup", "0")] {
|
// Preserve existing CoaBots.Enable if present; do not force enable or alter alternative bot systems
|
||||||
set(
|
if let Some(bytes) = files.get("Core/configs/modules/mod_coa_playerbots.conf") {
|
||||||
&mut files,
|
if let Ok(conf) = ConfFile::parse_bytes(bytes) {
|
||||||
"Core/configs/modules/mod_coa_playerbots.conf",
|
if conf.get("CoaBots.Enable") == Some("1") {
|
||||||
key,
|
set(&mut files, "Core/configs/modules/mod_coa_playerbots.conf", "CoaBots.Enable", "1")?;
|
||||||
value,
|
}
|
||||||
)?;
|
}
|
||||||
}
|
}
|
||||||
set(
|
|
||||||
&mut files,
|
|
||||||
"Core/configs/modules/playerbots.conf",
|
|
||||||
"AiPlayerbot.Enabled",
|
|
||||||
"0",
|
|
||||||
)?;
|
|
||||||
Ok(files)
|
Ok(files)
|
||||||
}
|
}
|
||||||
|
|
||||||
@@ -337,20 +343,14 @@ fn reborn_configs(mut files: Files) -> Result<Files> {
|
|||||||
set(&mut files, path, "RealmID", "3")?;
|
set(&mut files, path, "RealmID", "3")?;
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
for (key, value) in [("CoaBots.Enable", "0"), ("CoaBots.AutoLoginOnStartup", "0")] {
|
// Preserve existing CoaBots.Enable if present; do not force enable or alter alternative bot systems
|
||||||
set(
|
if let Some(bytes) = files.get("Core/configs/modules/mod_coa_playerbots.conf") {
|
||||||
&mut files,
|
if let Ok(conf) = ConfFile::parse_bytes(bytes) {
|
||||||
"Core/configs/modules/mod_coa_playerbots.conf",
|
if conf.get("CoaBots.Enable") == Some("1") {
|
||||||
key,
|
set(&mut files, "Core/configs/modules/mod_coa_playerbots.conf", "CoaBots.Enable", "1")?;
|
||||||
value,
|
}
|
||||||
)?;
|
}
|
||||||
}
|
}
|
||||||
set(
|
|
||||||
&mut files,
|
|
||||||
"Core/configs/modules/playerbots.conf",
|
|
||||||
"AiPlayerbot.Enabled",
|
|
||||||
"0",
|
|
||||||
)?;
|
|
||||||
Ok(files)
|
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(),
|
"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)?;
|
let before = configs(root)?;
|
||||||
create_realm(root, &mut s, mode, &before)
|
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(),
|
"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)?;
|
let before = configs(root)?;
|
||||||
fsx::atomic_write_json(&snapshot(root, s.active), &before)?;
|
fsx::atomic_write_json(&snapshot(root, s.active), &before)?;
|
||||||
create_realm(root, &mut s, mode, &before)?;
|
create_realm(root, &mut s, mode, &before)?;
|
||||||
@@ -608,125 +604,6 @@ pub fn select(root: &Path, mode: Mode) -> Result<View> {
|
|||||||
view(root)
|
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
|
/// 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
|
/// 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.
|
/// 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() {
|
if !root.join(STATE).exists() {
|
||||||
return Ok(());
|
return Ok(());
|
||||||
}
|
}
|
||||||
prepare_launcher(root)?;
|
|
||||||
if s.simultaneous && !view(root)?.supported {
|
if s.simultaneous && !view(root)?.supported {
|
||||||
return Err(Error::Invalid(
|
return Err(Error::Invalid(
|
||||||
"The installed server build does not support simultaneous Wildcard startup.".into(),
|
"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(),
|
"The installed server build does not support Wildcard.".into(),
|
||||||
));
|
));
|
||||||
}
|
}
|
||||||
let path = root.join("Core/configs/modules/mod_coa_playerbots.conf");
|
// Multi-realm Playerbots 1.0: bots are supported and enabled on all realms
|
||||||
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())?;
|
|
||||||
}
|
}
|
||||||
Ok(())
|
Ok(())
|
||||||
}
|
}
|
||||||
@@ -831,8 +695,8 @@ pub fn setup_realmlist(root: &Path) -> Result<()> {
|
|||||||
let port = layout::read_ports(root).world;
|
let port = layout::read_ports(root).world;
|
||||||
for mode in s.modes().into_iter().filter(|m| *m != Mode::Coa) {
|
for mode in s.modes().into_iter().filter(|m| *m != Mode::Coa) {
|
||||||
let id = mode.realm_id();
|
let id = mode.realm_id();
|
||||||
let name = mode.label();
|
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};"))?;
|
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
|
let ids = s
|
||||||
.modes()
|
.modes()
|
||||||
@@ -937,11 +801,12 @@ mod tests {
|
|||||||
.get("RealmID"),
|
.get("RealmID"),
|
||||||
Some("3")
|
Some("3")
|
||||||
);
|
);
|
||||||
|
// Requirement 6: Never alter alternative bot system settings (AiPlayerbot.Enabled) without explicit user choice
|
||||||
assert_eq!(
|
assert_eq!(
|
||||||
ConfFile::parse_bytes(&reborn["Core/configs/modules/playerbots.conf"])
|
ConfFile::parse_bytes(&reborn["Core/configs/modules/playerbots.conf"])
|
||||||
.unwrap()
|
.unwrap()
|
||||||
.get("AiPlayerbot.Enabled"),
|
.get("AiPlayerbot.Enabled"),
|
||||||
Some("0")
|
Some("1")
|
||||||
);
|
);
|
||||||
write_configs(t.path(), &reborn).unwrap();
|
write_configs(t.path(), &reborn).unwrap();
|
||||||
write_configs(t.path(), &coa).unwrap();
|
write_configs(t.path(), &coa).unwrap();
|
||||||
@@ -955,8 +820,8 @@ mod tests {
|
|||||||
},
|
},
|
||||||
)
|
)
|
||||||
.unwrap();
|
.unwrap();
|
||||||
assert!(guard_module(t.path(), "companions").is_err());
|
assert!(guard_module(t.path(), "companions").is_ok());
|
||||||
assert!(guard_module(t.path(), "playerbots").is_err());
|
assert!(guard_module(t.path(), "playerbots").is_ok());
|
||||||
assert!(guard_module(t.path(), "content-scaling").is_ok());
|
assert!(guard_module(t.path(), "content-scaling").is_ok());
|
||||||
}
|
}
|
||||||
|
|
||||||
@@ -1107,26 +972,6 @@ CoA.GameModeMask = 0
|
|||||||
assert!(!v.supported);
|
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]
|
#[test]
|
||||||
fn a_docker_server_is_checked_for_wildcard_support_in_its_own_binary() {
|
fn a_docker_server_is_checked_for_wildcard_support_in_its_own_binary() {
|
||||||
let d = tempfile::tempdir().unwrap();
|
let d = tempfile::tempdir().unwrap();
|
||||||
@@ -1157,20 +1002,6 @@ CoA.GameModeMask = 0
|
|||||||
assert!(view(d.path()).unwrap().supported);
|
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]
|
#[test]
|
||||||
fn fresh_wildcard_disables_bots_and_preserves_scaling() {
|
fn fresh_wildcard_disables_bots_and_preserves_scaling() {
|
||||||
let mut f = Files::new();
|
let mut f = Files::new();
|
||||||
@@ -1178,6 +1009,10 @@ CoA.GameModeMask = 0
|
|||||||
"Core/configs/modules/mod-coa-content-scaling.conf".into(),
|
"Core/configs/modules/mod-coa-content-scaling.conf".into(),
|
||||||
b"[worldserver]\nCoAContentScaling.Enable = 1\n".to_vec(),
|
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(
|
f.insert(
|
||||||
"Settings/worldserver.conf.template".into(),
|
"Settings/worldserver.conf.template".into(),
|
||||||
b"[worldserver]\nRealmID = 1\n".to_vec(),
|
b"[worldserver]\nRealmID = 1\n".to_vec(),
|
||||||
@@ -1188,7 +1023,7 @@ CoA.GameModeMask = 0
|
|||||||
f["Core/configs/modules/mod-coa-content-scaling.conf"]
|
f["Core/configs/modules/mod-coa-content-scaling.conf"]
|
||||||
);
|
);
|
||||||
let c = ConfFile::parse_bytes(&w["Core/configs/modules/mod_coa_playerbots.conf"]).unwrap();
|
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!(
|
assert_eq!(
|
||||||
ConfFile::parse_bytes(&w["Settings/worldserver.conf.template"])
|
ConfFile::parse_bytes(&w["Settings/worldserver.conf.template"])
|
||||||
.unwrap()
|
.unwrap()
|
||||||
@@ -1260,52 +1095,8 @@ CoA.GameModeMask = 0
|
|||||||
},
|
},
|
||||||
)
|
)
|
||||||
.unwrap();
|
.unwrap();
|
||||||
assert!(crate::modules::set_enabled(t.path(), t.path(), "companions", true).is_err());
|
assert!(guard_module(t.path(), "companions").is_ok());
|
||||||
assert!(crate::config::save(
|
assert!(guard_module(t.path(), "playerbots").is_ok());
|
||||||
t.path(),
|
|
||||||
t.path(),
|
|
||||||
crate::config::Scope::Bots,
|
|
||||||
&BTreeMap::new()
|
|
||||||
)
|
|
||||||
.is_err());
|
|
||||||
assert!(guard_module(t.path(), "content-scaling").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
|
|
||||||
);
|
|
||||||
}
|
|
||||||
}
|
}
|
||||||
@@ -21,22 +21,33 @@ pub struct SqlFile {
|
|||||||
pub sha256: String,
|
pub sha256: String,
|
||||||
}
|
}
|
||||||
|
|
||||||
fn sql_in(dir: &Path) -> Vec<PathBuf> {
|
fn entries(dir: &Path) -> Result<Vec<fs::DirEntry>> {
|
||||||
let mut v: Vec<PathBuf> = fs::read_dir(dir)
|
match fs::read_dir(dir) {
|
||||||
.map(|rd| {
|
Ok(rd) => Ok(rd.collect::<std::io::Result<Vec<_>>>()?),
|
||||||
rd.flatten()
|
Err(error) if error.kind() == std::io::ErrorKind::NotFound => Ok(vec![]),
|
||||||
.map(|e| e.path())
|
Err(error) => Err(error.into()),
|
||||||
.filter(|p| p.extension().map(|e| e == "sql").unwrap_or(false))
|
}
|
||||||
.collect()
|
}
|
||||||
})
|
|
||||||
.unwrap_or_default();
|
fn sql_in(dir: &Path) -> Result<Vec<PathBuf>> {
|
||||||
v.sort();
|
let mut paths: Vec<_> = entries(dir)?
|
||||||
v
|
.into_iter()
|
||||||
|
.map(|entry| entry.path())
|
||||||
|
.filter(|path| path.extension().is_some_and(|ext| ext == "sql"))
|
||||||
|
.collect();
|
||||||
|
paths.sort();
|
||||||
|
Ok(paths)
|
||||||
}
|
}
|
||||||
|
|
||||||
/// The order in which files were first added to the repository (a pending script may rely on a table a module
|
/// The order in which files were first added to the repository (a pending script may rely on a table a module
|
||||||
/// created earlier). Files git does not know come last, in name order.
|
/// created earlier). Files git does not know come last, in name order.
|
||||||
fn introduction_rank(repo: &Path, pathspecs: &[&str]) -> std::collections::HashMap<String, usize> {
|
fn introduction_rank(
|
||||||
|
repo: &Path,
|
||||||
|
pathspecs: &[&str],
|
||||||
|
) -> Result<std::collections::HashMap<String, usize>> {
|
||||||
|
if !repo.join(".git").exists() {
|
||||||
|
return Ok(Default::default());
|
||||||
|
}
|
||||||
let mut args = vec![
|
let mut args = vec![
|
||||||
"log",
|
"log",
|
||||||
"--full-history",
|
"--full-history",
|
||||||
@@ -48,18 +59,22 @@ fn introduction_rank(repo: &Path, pathspecs: &[&str]) -> std::collections::HashM
|
|||||||
"--",
|
"--",
|
||||||
];
|
];
|
||||||
args.extend_from_slice(pathspecs);
|
args.extend_from_slice(pathspecs);
|
||||||
let out = Command::new("git").current_dir(repo).args(&args).output();
|
let out = Command::new("git").current_dir(repo).args(&args).output()?;
|
||||||
let mut rank = std::collections::HashMap::new();
|
if !out.status.success() {
|
||||||
if let Ok(o) = out {
|
return Err(Error::Invalid(format!(
|
||||||
for (i, line) in String::from_utf8_lossy(&o.stdout)
|
"Cannot establish SQL migration order: {}",
|
||||||
.lines()
|
String::from_utf8_lossy(&out.stderr)
|
||||||
.filter(|l| l.ends_with(".sql"))
|
)));
|
||||||
.enumerate()
|
|
||||||
{
|
|
||||||
rank.entry(line.to_string()).or_insert(i);
|
|
||||||
}
|
|
||||||
}
|
}
|
||||||
rank
|
let mut rank = std::collections::HashMap::new();
|
||||||
|
for (i, line) in String::from_utf8_lossy(&out.stdout)
|
||||||
|
.lines()
|
||||||
|
.filter(|line| line.ends_with(".sql"))
|
||||||
|
.enumerate()
|
||||||
|
{
|
||||||
|
rank.entry(line.to_string()).or_insert(i);
|
||||||
|
}
|
||||||
|
Ok(rank)
|
||||||
}
|
}
|
||||||
|
|
||||||
/// Incremental SQL of a core checkout. Installation-only module bases must never be replayed on a live database.
|
/// Incremental SQL of a core checkout. Installation-only module bases must never be replayed on a live database.
|
||||||
@@ -91,7 +106,7 @@ fn collect_core_sql_mode(core: &Path, include_base: bool) -> Result<Vec<SqlFile>
|
|||||||
("world", ["db_world", "pending_db_world"]),
|
("world", ["db_world", "pending_db_world"]),
|
||||||
] {
|
] {
|
||||||
for d in dirs {
|
for d in dirs {
|
||||||
for f in sql_in(&core.join("data/sql/updates").join(d)) {
|
for f in sql_in(&core.join("data/sql/updates").join(d))? {
|
||||||
let stem = f.file_stem().unwrap().to_string_lossy().into_owned();
|
let stem = f.file_stem().unwrap().to_string_lossy().into_owned();
|
||||||
let rel = format!(
|
let rel = format!(
|
||||||
"data/sql/updates/{d}/{}",
|
"data/sql/updates/{d}/{}",
|
||||||
@@ -101,8 +116,8 @@ fn collect_core_sql_mode(core: &Path, include_base: bool) -> Result<Vec<SqlFile>
|
|||||||
}
|
}
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
if let Ok(rd) = fs::read_dir(core.join("modules")) {
|
{
|
||||||
let mut mods: Vec<_> = rd.flatten().collect();
|
let mut mods = entries(&core.join("modules"))?;
|
||||||
mods.sort_by_key(|e| e.file_name());
|
mods.sort_by_key(|e| e.file_name());
|
||||||
for m in mods {
|
for m in mods {
|
||||||
let name = m.file_name().to_string_lossy().into_owned();
|
let name = m.file_name().to_string_lossy().into_owned();
|
||||||
@@ -110,7 +125,7 @@ fn collect_core_sql_mode(core: &Path, include_base: bool) -> Result<Vec<SqlFile>
|
|||||||
for kind in ["auth", "characters", "world"] {
|
for kind in ["auth", "characters", "world"] {
|
||||||
let base = m.path().join(format!("data/sql/db-{kind}"));
|
let base = m.path().join(format!("data/sql/db-{kind}"));
|
||||||
for f in if include_base {
|
for f in if include_base {
|
||||||
sql_in(&base.join("base"))
|
sql_in(&base.join("base"))?
|
||||||
} else {
|
} else {
|
||||||
vec![]
|
vec![]
|
||||||
} {
|
} {
|
||||||
@@ -121,7 +136,7 @@ fn collect_core_sql_mode(core: &Path, include_base: bool) -> Result<Vec<SqlFile>
|
|||||||
);
|
);
|
||||||
push(kind, format!("mod_{mname}__base__{stem}"), f, rel)?;
|
push(kind, format!("mod_{mname}__base__{stem}"), f, rel)?;
|
||||||
}
|
}
|
||||||
for f in sql_in(&base) {
|
for f in sql_in(&base)? {
|
||||||
let stem = f.file_stem().unwrap().to_string_lossy().into_owned();
|
let stem = f.file_stem().unwrap().to_string_lossy().into_owned();
|
||||||
let rel = format!(
|
let rel = format!(
|
||||||
"modules/{name}/data/sql/db-{kind}/{}",
|
"modules/{name}/data/sql/db-{kind}/{}",
|
||||||
@@ -132,7 +147,7 @@ fn collect_core_sql_mode(core: &Path, include_base: bool) -> Result<Vec<SqlFile>
|
|||||||
}
|
}
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
let rank = introduction_rank(core, &["data/sql/updates", "modules"]);
|
let rank = introduction_rank(core, &["data/sql/updates", "modules"])?;
|
||||||
out.sort_by_key(|f| rank.get(&f.origin).copied().unwrap_or(usize::MAX));
|
out.sort_by_key(|f| rank.get(&f.origin).copied().unwrap_or(usize::MAX));
|
||||||
Ok(out)
|
Ok(out)
|
||||||
}
|
}
|
||||||
@@ -155,7 +170,7 @@ pub fn export_baseline(server: &Path, out: &Path) -> Result<Vec<(String, u64)>>
|
|||||||
/// SQL a bots module checkout ships for the characters database (its `dist/sql`).
|
/// SQL a bots module checkout ships for the characters database (its `dist/sql`).
|
||||||
pub fn collect_bots_sql(bots: &Path) -> Result<Vec<SqlFile>> {
|
pub fn collect_bots_sql(bots: &Path) -> Result<Vec<SqlFile>> {
|
||||||
let mut out = Vec::new();
|
let mut out = Vec::new();
|
||||||
for f in sql_in(&bots.join("dist/sql")) {
|
for f in sql_in(&bots.join("dist/sql"))? {
|
||||||
let stem = f.file_stem().unwrap().to_string_lossy().into_owned();
|
let stem = f.file_stem().unwrap().to_string_lossy().into_owned();
|
||||||
out.push(SqlFile {
|
out.push(SqlFile {
|
||||||
db: "characters".into(),
|
db: "characters".into(),
|
||||||
@@ -364,6 +379,30 @@ mod tests {
|
|||||||
fs::write(p, c).unwrap();
|
fs::write(p, c).unwrap();
|
||||||
}
|
}
|
||||||
|
|
||||||
|
#[test]
|
||||||
|
fn sql_collection_rejects_broken_history_in_a_git_checkout() {
|
||||||
|
let dir = tempfile::tempdir().unwrap();
|
||||||
|
write(dir.path(), ".git", "gitdir: missing-history");
|
||||||
|
write(dir.path(), "data/sql/updates/db_world/one.sql", "SELECT 1;");
|
||||||
|
assert!(collect_core_sql(dir.path())
|
||||||
|
.unwrap_err()
|
||||||
|
.to_string()
|
||||||
|
.contains("migration order"));
|
||||||
|
}
|
||||||
|
|
||||||
|
#[test]
|
||||||
|
fn sql_collection_rejects_unreadable_directories_instead_of_omitting_migrations() {
|
||||||
|
let dir = tempfile::tempdir().unwrap();
|
||||||
|
write(dir.path(), "data/sql/updates/db_world", "not a directory");
|
||||||
|
assert!(collect_core_sql(dir.path()).is_err());
|
||||||
|
let bots = tempfile::tempdir().unwrap();
|
||||||
|
write(bots.path(), "dist/sql", "not a directory");
|
||||||
|
assert!(collect_bots_sql(bots.path()).is_err());
|
||||||
|
let modules = tempfile::tempdir().unwrap();
|
||||||
|
write(modules.path(), "modules", "not a directory");
|
||||||
|
assert!(collect_core_sql(modules.path()).is_err());
|
||||||
|
}
|
||||||
|
|
||||||
#[test]
|
#[test]
|
||||||
fn collects_core_and_module_sql_with_module_base_first_and_stable_ids() {
|
fn collects_core_and_module_sql_with_module_base_first_and_stable_ids() {
|
||||||
let d = tempfile::tempdir().unwrap();
|
let d = tempfile::tempdir().unwrap();
|
||||||
|
|||||||
@@ -0,0 +1,229 @@
|
|||||||
|
//! Read-only, bounded canonical histories. Offline fallback is also bundled in the UI.
|
||||||
|
use serde_json::Value;
|
||||||
|
use std::{io::Read, path::Path, time::Duration};
|
||||||
|
|
||||||
|
const LIMIT: u64 = 2 * 1024 * 1024;
|
||||||
|
|
||||||
|
fn repository(component: &str) -> Result<(&'static str, &'static str), String> {
|
||||||
|
match component {
|
||||||
|
"server" => Ok(("Corfirean/coa-server-build", "main")),
|
||||||
|
"manager" => Ok(("Corfirean/coa-server-manager", "master")),
|
||||||
|
_ => Err("Unknown release component".into()),
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
fn validate(bytes: &[u8], component: &str) -> Result<Value, String> {
|
||||||
|
let (repo, _) = repository(component)?;
|
||||||
|
if bytes.len() as u64 > LIMIT {
|
||||||
|
return Err("Release history is too large".into());
|
||||||
|
}
|
||||||
|
let value: Value = serde_json::from_slice(bytes).map_err(|e| e.to_string())?;
|
||||||
|
if value["schema"] != 1 || value["component"] != component || value["repository"] != repo {
|
||||||
|
return Err("Release history identity mismatch".into());
|
||||||
|
}
|
||||||
|
let releases = value["releases"].as_array().ok_or("Missing releases")?;
|
||||||
|
if releases.len() > 2000 {
|
||||||
|
return Err("Too many releases".into());
|
||||||
|
}
|
||||||
|
for release in releases {
|
||||||
|
if release.get("prerelease").is_some_and(|v| !v.is_boolean())
|
||||||
|
|| release.get("experimentalFeatures").is_some_and(|v| {
|
||||||
|
v.as_array()
|
||||||
|
.is_none_or(|items| items.iter().any(|item| !item.is_string()))
|
||||||
|
})
|
||||||
|
{
|
||||||
|
return Err("Invalid release flags".into());
|
||||||
|
}
|
||||||
|
for field in ["tag", "date"] {
|
||||||
|
if release[field]
|
||||||
|
.as_str()
|
||||||
|
.is_none_or(|s| s.is_empty() || s.len() > 100)
|
||||||
|
{
|
||||||
|
return Err("Invalid release metadata".into());
|
||||||
|
}
|
||||||
|
}
|
||||||
|
let version = release["version"].as_str().ok_or("Missing version")?;
|
||||||
|
if version.len() > 80
|
||||||
|
|| !version
|
||||||
|
.bytes()
|
||||||
|
.all(|b| b.is_ascii_alphanumeric() || b".-+".contains(&b))
|
||||||
|
{
|
||||||
|
return Err("Invalid version".into());
|
||||||
|
}
|
||||||
|
let notes = release["notes"].as_array().ok_or("Missing notes")?;
|
||||||
|
if notes.len() > 500
|
||||||
|
|| notes
|
||||||
|
.iter()
|
||||||
|
.any(|n| n.as_str().is_none_or(|s| s.len() > 10000))
|
||||||
|
{
|
||||||
|
return Err("Invalid release notes".into());
|
||||||
|
}
|
||||||
|
}
|
||||||
|
Ok(value)
|
||||||
|
}
|
||||||
|
|
||||||
|
pub fn load(component: &str, cache_dir: &Path) -> Result<Value, String> {
|
||||||
|
load_for_target(component, cache_dir, None)
|
||||||
|
}
|
||||||
|
|
||||||
|
pub fn load_for_target(
|
||||||
|
component: &str,
|
||||||
|
cache_dir: &Path,
|
||||||
|
target: Option<&str>,
|
||||||
|
) -> Result<Value, String> {
|
||||||
|
let (repo, branch) = repository(component)?;
|
||||||
|
load_with_remote(component, cache_dir, target, || {
|
||||||
|
let client = reqwest::blocking::Client::builder()
|
||||||
|
.timeout(Duration::from_secs(8))
|
||||||
|
.redirect(reqwest::redirect::Policy::none())
|
||||||
|
.build()
|
||||||
|
.map_err(|e| e.to_string())?;
|
||||||
|
let response = client
|
||||||
|
.get(format!(
|
||||||
|
"https://raw.githubusercontent.com/{repo}/{branch}/changelog/history.json"
|
||||||
|
))
|
||||||
|
.query(&[("target", target.unwrap_or(""))])
|
||||||
|
.header(reqwest::header::CACHE_CONTROL, "no-cache")
|
||||||
|
.send()
|
||||||
|
.and_then(|r| r.error_for_status())
|
||||||
|
.map_err(|e| e.to_string())?;
|
||||||
|
let mut bytes = Vec::new();
|
||||||
|
response
|
||||||
|
.take(LIMIT + 1)
|
||||||
|
.read_to_end(&mut bytes)
|
||||||
|
.map_err(|e| e.to_string())?;
|
||||||
|
Ok(bytes)
|
||||||
|
})
|
||||||
|
}
|
||||||
|
|
||||||
|
fn load_with_remote(
|
||||||
|
component: &str,
|
||||||
|
cache_dir: &Path,
|
||||||
|
target: Option<&str>,
|
||||||
|
remote: impl FnOnce() -> Result<Vec<u8>, String>,
|
||||||
|
) -> Result<Value, String> {
|
||||||
|
repository(component)?;
|
||||||
|
let cache = cache_dir.join(format!("{component}.json"));
|
||||||
|
let cached = || {
|
||||||
|
let mut bytes = Vec::new();
|
||||||
|
std::fs::File::open(&cache)
|
||||||
|
.ok()?
|
||||||
|
.take(LIMIT + 1)
|
||||||
|
.read_to_end(&mut bytes)
|
||||||
|
.ok()?;
|
||||||
|
validate(&bytes, component).ok()
|
||||||
|
};
|
||||||
|
if cache
|
||||||
|
.metadata()
|
||||||
|
.and_then(|m| m.modified())
|
||||||
|
.ok()
|
||||||
|
.and_then(|t| t.elapsed().ok())
|
||||||
|
.is_some_and(|age| age < Duration::from_secs(3600))
|
||||||
|
{
|
||||||
|
if let Some(mut value) = cached() {
|
||||||
|
if target.is_none_or(|target| {
|
||||||
|
value["releases"].as_array().is_some_and(|releases| {
|
||||||
|
releases
|
||||||
|
.iter()
|
||||||
|
.any(|release| release["version"].as_str() == Some(target))
|
||||||
|
})
|
||||||
|
}) {
|
||||||
|
value["source"] = "cache".into();
|
||||||
|
return Ok(value);
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
let fetched = (|| {
|
||||||
|
let bytes = remote()?;
|
||||||
|
let mut value = validate(&bytes, component)?;
|
||||||
|
if std::fs::create_dir_all(cache_dir).is_ok() {
|
||||||
|
let _ = crate::fsx::atomic_write(&cache, &bytes);
|
||||||
|
}
|
||||||
|
value["source"] = "remote".into();
|
||||||
|
Ok(value)
|
||||||
|
})();
|
||||||
|
fetched.or_else(|error| {
|
||||||
|
cached()
|
||||||
|
.map(|mut value| {
|
||||||
|
value["source"] = "cache".into();
|
||||||
|
value
|
||||||
|
})
|
||||||
|
.ok_or(error)
|
||||||
|
})
|
||||||
|
}
|
||||||
|
|
||||||
|
#[cfg(test)]
|
||||||
|
mod tests {
|
||||||
|
use super::*;
|
||||||
|
#[test]
|
||||||
|
fn accepts_both_complete_bundled_canonical_histories() {
|
||||||
|
assert!(validate(include_bytes!("../../../changelog/history.json"), "manager").is_ok());
|
||||||
|
assert!(validate(
|
||||||
|
include_bytes!("../../../src/data/server-history.json"),
|
||||||
|
"server"
|
||||||
|
)
|
||||||
|
.is_ok());
|
||||||
|
}
|
||||||
|
#[test]
|
||||||
|
fn rejects_cross_component_and_untrusted_components() {
|
||||||
|
let bytes = br#"{"schema":1,"component":"manager","repository":"Corfirean/coa-server-manager","releases":[]}"#;
|
||||||
|
assert!(validate(bytes, "manager").is_ok());
|
||||||
|
assert!(validate(bytes, "server").is_err());
|
||||||
|
assert!(repository("../../other").is_err());
|
||||||
|
assert!(validate(&vec![b' '; LIMIT as usize + 1], "manager").is_err());
|
||||||
|
}
|
||||||
|
|
||||||
|
#[test]
|
||||||
|
fn rejects_malformed_records_before_the_ui_can_use_them() {
|
||||||
|
let mut value = serde_json::json!({"schema": 1, "component": "server",
|
||||||
|
"repository": "Corfirean/coa-server-build", "releases": [{
|
||||||
|
"version": "0.261028.83", "tag": "0.261028.83", "date": "2026-10-28",
|
||||||
|
"notes": ["Reviewed note"]
|
||||||
|
}]});
|
||||||
|
assert!(validate(&serde_json::to_vec(&value).unwrap(), "server").is_ok());
|
||||||
|
value["releases"][0]["date"] = Value::Null;
|
||||||
|
assert!(validate(&serde_json::to_vec(&value).unwrap(), "server").is_err());
|
||||||
|
value["releases"][0]["date"] = "2026-10-28".into();
|
||||||
|
value["releases"][0]["notes"] = serde_json::json!([{"html": "not a text note"}]);
|
||||||
|
assert!(validate(&serde_json::to_vec(&value).unwrap(), "server").is_err());
|
||||||
|
}
|
||||||
|
|
||||||
|
#[test]
|
||||||
|
fn available_update_bypasses_fresh_cache_missing_the_target_and_keeps_offline_fallback() {
|
||||||
|
let dir = tempfile::tempdir().unwrap();
|
||||||
|
let feed = |version: &str| {
|
||||||
|
serde_json::to_vec(&serde_json::json!({
|
||||||
|
"schema":1,"component":"manager","repository":"Corfirean/coa-server-manager",
|
||||||
|
"releases":[{"version":version,"tag":format!("v{version}"),"date":"2026-10-30",
|
||||||
|
"notes":["Visible update notes"]}]
|
||||||
|
}))
|
||||||
|
.unwrap()
|
||||||
|
};
|
||||||
|
std::fs::write(dir.path().join("manager.json"), feed("0.9.4")).unwrap();
|
||||||
|
let value =
|
||||||
|
load_with_remote("manager", dir.path(), Some("0.9.5"), || Ok(feed("0.9.5"))).unwrap();
|
||||||
|
assert_eq!(value["source"], "remote");
|
||||||
|
assert_eq!(value["releases"][0]["version"], "0.9.5");
|
||||||
|
let cached = load_with_remote("manager", dir.path(), Some("0.9.5"), || {
|
||||||
|
panic!("fresh target is cached")
|
||||||
|
})
|
||||||
|
.unwrap();
|
||||||
|
assert_eq!(cached["source"], "cache");
|
||||||
|
let offline = load_with_remote("manager", dir.path(), Some("0.9.6"), || {
|
||||||
|
Err("offline".into())
|
||||||
|
})
|
||||||
|
.unwrap();
|
||||||
|
assert_eq!(offline["releases"][0]["version"], "0.9.5");
|
||||||
|
}
|
||||||
|
|
||||||
|
#[test]
|
||||||
|
fn fresh_valid_cache_is_available_without_network() {
|
||||||
|
let dir = std::env::temp_dir().join(format!("coa-history-{}", uuid::Uuid::new_v4()));
|
||||||
|
std::fs::create_dir_all(&dir).unwrap();
|
||||||
|
std::fs::write(dir.join("manager.json"), br#"{"schema":1,"component":"manager","repository":"Corfirean/coa-server-manager","releases":[]}"#).unwrap();
|
||||||
|
let result = load("manager", &dir).unwrap();
|
||||||
|
assert_eq!(result["source"], "cache");
|
||||||
|
std::fs::remove_file(dir.join("manager.json")).unwrap();
|
||||||
|
std::fs::remove_dir(dir).unwrap();
|
||||||
|
}
|
||||||
|
}
|
||||||
Loaded 100 of 177 files, more files were not shown because too many files have changed in this diff.
Show more
Reference in new issue
Block a user