Merge integrate/manager-0.9.14: Manager 0.9.14 (Rust launcher, fast races switch, ports, realm names, addons, companions on Wildcard/Reborn)

This commit is contained in:
Corfirean authored and GitHub committed 2026-11-16 18:14:10 +05:00
commit b9e663079e
88 files changed
+17555 -1478

No files matched your search

-1
View File
@@ -26,5 +26,4 @@ jobs:
- run: node tools/check-i18n.mjs
- run: npm run build
- run: node --experimental-strip-types --test tools/*.test.mjs
- run: python -B -m unittest discover -s tools -p test_launcher_bridge.py
- run: cargo test --workspace --locked
-1
View File
@@ -74,7 +74,6 @@ jobs:
- name: Tests
run: cargo test --workspace --locked -- --test-threads=1
- run: node --experimental-strip-types --test tools/*.test.mjs
- run: python -B -m unittest discover -s tools -p test_launcher_bridge.py
- name: Build and sign (publish only when requested)
id: tauri
uses: tauri-apps/tauri-action@v0
Generated
+14 -3
View File
@@ -586,7 +586,7 @@ dependencies = [
[[package]]
name = "coa-core"
version = "0.9.13"
version = "0.9.14"
dependencies = [
"base64 0.22.1",
"chrono",
@@ -606,6 +606,7 @@ dependencies = [
"serde_json",
"sha1",
"sha2",
"socket2",
"tar",
"tempfile",
"thiserror 2.0.21",
@@ -618,6 +619,15 @@ dependencies = [
"zstd",
]
[[package]]
name = "coa-launcher"
version = "0.9.14"
dependencies = [
"coa-core",
"serde_json",
"windows-sys 0.60.2",
]
[[package]]
name = "coa-registry-proto"
version = "0.1.0"
@@ -634,7 +644,7 @@ dependencies = [
[[package]]
name = "coa-release"
version = "0.9.13"
version = "0.9.14"
dependencies = [
"chrono",
"coa-core",
@@ -643,7 +653,7 @@ dependencies = [
[[package]]
name = "coa-server-manager"
version = "0.9.13"
version = "0.9.14"
dependencies = [
"coa-control-proto",
"coa-core",
@@ -658,6 +668,7 @@ dependencies = [
"tauri-plugin-single-instance",
"tauri-plugin-updater",
"tracing",
"uuid",
]
[[package]]
+2 -2
View File
@@ -1,10 +1,10 @@
[workspace]
resolver = "2"
members = ["crates/coa-core", "crates/coa-release", "crates/coa-registry-proto", "crates/coa-control-proto", "src-tauri"]
members = ["crates/coa-core", "crates/coa-launcher", "crates/coa-release", "crates/coa-registry-proto", "crates/coa-control-proto", "src-tauri"]
exclude = ["services/coa-registry", "services/coa-registry-e2e", "services/coa-coordinator", "services/coa-relay"]
[workspace.package]
version = "0.9.13"
version = "0.9.14"
edition = "2021"
license = "AGPL-3.0-only"
+7247
View File
File diff suppressed because it is too large. Load diff
+7
View File
@@ -0,0 +1,7 @@
---
area: manager
type: added
audience: players
title: Install community addons from the Manager
---
The game client card lists SquidBots Lite, DragonUI, IncahootsCoA and CoACombat. Each comes from its author's GitHub at a pinned version, every file is checked before it goes into Interface/AddOns, and the Manager updates or removes only what it installed.
+7
View File
@@ -0,0 +1,7 @@
---
area: manager
type: added
audience: players
title: Old item and creature data is cleared before every Play
---
After a server update the game showed old names and stats from its own cache (Cache/WDB). Play now clears that cache first; it fills again within seconds. A switch next to the client graphics settings turns it off.
@@ -0,0 +1,7 @@
---
area: manager
type: fixed
audience: players
title: Turning the custom races client patch on or off takes seconds again
---
V2 has over 7,000 files and switching it could run for many minutes. Now only the files the game itself loads are hidden, and the rest stays in place. A switch that was cut short is undone safely.
@@ -0,0 +1,7 @@
---
area: manager
type: fixed
audience: admins
title: The database moves to a free port when Windows reserves or another program takes 3307
---
Hyper-V, WSL and Docker can reserve a range that includes the database port; the start then waited 30 seconds and failed. The database now picks a free port and records it, and a reserved game port is named as such at once.
@@ -0,0 +1,7 @@
---
area: manager
type: added
audience: admins
title: Your own MySQL settings survive restarts and updates
---
Settings, Service has a MySQL settings box. Its options are added to my.ini at every start of the database; before, my.ini was rewritten and hand edits were lost. Port, addresses and data paths stay managed.
@@ -0,0 +1,7 @@
---
area: manager
type: fixed
audience: admins
title: Disabled custom races stay disabled after a server update that adds races
---
A race list saved before Custom Races V2 no longer matched V2's race catalog, and the server then ignored it and turned custom races off. Before a start the Manager now keeps the list when every disabled race kept its ID and name.
+7
View File
@@ -0,0 +1,7 @@
---
area: manager
type: added
audience: admins
title: Rename your realms in the Manager
---
Settings, Startup has a name for every realm. A running server shows it at once, the game client picks it on the next Play, and it stays after restarts and updates. Before, the launcher wrote the default name back at every start.
@@ -0,0 +1,7 @@
---
area: manager
type: fixed
audience: players
title: The account for a friend's server is in the login box at every Play
---
The account the Manager made on a listed server was filled in only when joining. Play now fills it in every time, also after another server's account was used.
@@ -0,0 +1,7 @@
---
area: manager
type: added
audience: admins
title: Restart the world every day at a chosen time
---
Settings, Startup, Scheduled restart: at that local time the world restarts with an in-game countdown and comes back by itself; the database keeps running. It works without the Manager open and needs a server with the new launcher.
@@ -0,0 +1,7 @@
---
area: manager
type: added
audience: admins
title: Switches for the Custom Races V2 subclasses, Hero Races and the /dev menu
---
The Custom Races settings now hold Subclasses and Hero Races (subclasses, the Thin Twins, the Two-Headed Ogre, two players per character) and the GM /dev menu, each with its own switch.
@@ -0,0 +1,7 @@
---
area: manager
type: added
audience: admins
title: Companion bots on Wildcard and Warcraft Reborn
---
With a server build that supports it, Companions can be switched on for Wildcard and Warcraft Reborn: bots get whole Wildcard archetypes or Reborn abilities by level, and bot creation survives a crash without duplicates.
@@ -0,0 +1,7 @@
---
area: manager
type: added
audience: admins
title: The Custom Races card tells which characters stay out while races are off
---
With custom races off, the card shows how many player characters and bots of custom races cannot enter the world, and offers to delete the companion bots of those races.
+2 -1
View File
@@ -5,6 +5,7 @@ edition.workspace = true
license.workspace = true
[dependencies]
socket2 = "0.6"
serde = { version = "1", features = ["derive"] }
serde_json = "1"
sha2 = "0.10"
@@ -37,7 +38,7 @@ rand_core = { version = "0.6", features = ["getrandom"] }
ed25519-dalek = { version = "2", features = ["rand_core"] }
[target.'cfg(windows)'.dependencies]
windows-sys = { version = "0.60", features = ["Win32_Foundation", "Win32_Storage_FileSystem", "Win32_System_Threading", "Win32_System_SystemInformation", "Win32_System_Diagnostics_ToolHelp", "Win32_NetworkManagement_IpHelper", "Win32_Networking_WinSock", "Win32_Security_Cryptography", "Win32_UI_Shell", "Win32_System_Registry", "Win32_UI_WindowsAndMessaging"] }
windows-sys = { version = "0.60", features = ["Win32_Foundation", "Win32_Storage_FileSystem", "Win32_System_Threading", "Win32_System_Console", "Win32_System_SystemInformation", "Win32_System_Diagnostics_ToolHelp", "Win32_NetworkManagement_IpHelper", "Win32_Networking_WinSock", "Win32_Security_Cryptography", "Win32_UI_Shell", "Win32_System_Registry", "Win32_UI_WindowsAndMessaging"] }
[features]
testkit = []
+114
View File
@@ -0,0 +1,114 @@
//! The Rust launcher on a DISPOSABLE repack, side by side with Scripts/manage.py:
//!
//! 1. install the stable server into a new folder on unused ports;
//! 2. coa-launcher start-all, then manage.py status-json must see every service;
//! 3. manage.py stop-all stops what coa-launcher started;
//! 4. manage.py start-all, coa-launcher status-json sees it, coa-launcher stop-all stops it;
//! 5. both stop-alls leave nothing of the repack running.
//!
//! usage: launcher_e2e <new folder ending in -fixture> <coa-launcher.exe>
use std::path::Path;
use std::process::Command;
use coa_core::install::{install_base, Params};
use coa_core::registry::Registry;
fn free_port() -> u16 {
std::net::TcpListener::bind("127.0.0.1:0").unwrap().local_addr().unwrap().port()
}
fn run(exe: &Path, args: &[&str]) -> (bool, String) {
let out = Command::new(exe).args(args).output().unwrap();
let text = String::from_utf8_lossy(&out.stdout).into_owned() + &String::from_utf8_lossy(&out.stderr);
(out.status.success(), text)
}
fn launcher(root: &Path, exe: &Path, action: &str) -> (bool, String) {
let r = root.to_string_lossy().into_owned();
let t = std::time::Instant::now();
let out = run(exe, &["--root", &r, action]);
println!("[coa-launcher {action}] ok={} in {:?}\n{}", out.0, t.elapsed(), indent(&out.1));
out
}
fn manage(root: &Path, action: &str) -> (bool, String) {
let python = root.join("Runtime/python/python.exe");
let script = root.join("Scripts/manage.py").to_string_lossy().into_owned();
let t = std::time::Instant::now();
let out = run(&python, &["-B", &script, action]);
println!("[manage.py {action}] ok={} in {:?}\n{}", out.0, t.elapsed(), indent(&out.1));
out
}
fn indent(s: &str) -> String {
s.lines().map(|l| format!(" {l}")).collect::<Vec<_>>().join("\n")
}
fn status(out: &str) -> serde_json::Value {
let line = out.lines().rev().find(|l| l.trim_start().starts_with('{')).expect("a JSON status line");
serde_json::from_str(line).unwrap()
}
fn all(v: &serde_json::Value, running: bool) -> bool {
["mysql", "auth", "world", "relay"].iter().all(|k| v[*k] == running)
}
fn main() {
let a: Vec<String> = std::env::args().skip(1).collect();
let root = Path::new(&a[0]);
let exe = Path::new(&a[1]);
assert!(a[0].ends_with("-fixture"), "a folder ending in -fixture is required");
if root.join("Core/worldserver.exe").is_file() {
println!("reusing the installed fixture");
} else {
install(root);
}
test(root, exe);
}
fn install(root: &Path) {
assert!(!root.exists(), "a new folder is required");
let reg_dir = std::env::temp_dir().join("coa-launcher-e2e-registry");
let _ = std::fs::remove_dir_all(&reg_dir);
let reg = Registry::at(reg_dir.join("installs.json"));
// what the Manager installs: the stable release's installation image
let image = coa_core::install::Source::Installation(Box::new(coa_core::channels::resolve("stable").expect("stable channel")));
let installed = install_base(
&Params { source: image, dest: root.into(), trusted_key: coa_core::signing::EMBEDDED_PUBLIC_KEY, registry: &reg, cancel: Default::default() },
&|s| eprintln!(" {:>3}% {}", s.percent, s.step),
)
.expect("install");
println!("installed {}", installed.version);
let repack = root.join("Settings/repack.json");
let mut cfg: serde_json::Value = serde_json::from_slice(&std::fs::read(&repack).unwrap()).unwrap();
for k in ["mysqlPort", "authPort", "worldPort", "raPort"] {
cfg[k] = free_port().into();
}
std::fs::write(&repack, serde_json::to_vec_pretty(&cfg).unwrap()).unwrap();
}
fn test(root: &Path, exe: &Path) {
// 2. Rust starts, Python sees it
assert!(launcher(root, exe, "start-all").0, "coa-launcher start-all");
let seen = status(&manage(root, "status-json").1);
assert!(all(&seen, true), "manage.py must see the services coa-launcher started: {seen}");
// 3. Python stops what Rust started
assert!(manage(root, "stop-all").0, "manage.py stop-all");
assert!(all(&status(&launcher(root, exe, "status-json").1), false));
// 4. Python starts, Rust sees and stops it
assert!(manage(root, "start-all").0, "manage.py start-all");
let seen = status(&launcher(root, exe, "status-json").1);
assert!(all(&seen, true), "coa-launcher must see the services manage.py started: {seen}");
assert!(launcher(root, exe, "stop-all").0, "coa-launcher stop-all");
assert!(all(&status(&manage(root, "status-json").1), false));
// 5. Rust alone, a second time (start on a server it stopped)
assert!(launcher(root, exe, "start-all").0);
assert!(launcher(root, exe, "stop-all").0);
let left = coa_core::process::find_by_exe(&root.join("mysql/bin/mysqld.exe")).len()
+ coa_core::process::find_by_exe(&root.join("Core/worldserver.exe")).len()
+ coa_core::process::find_by_exe(&root.join("Core/authserver.exe")).len();
assert_eq!(left, 0, "nothing of the repack may be left running");
println!("LAUNCHER E2E PASS");
}
@@ -0,0 +1,149 @@
//! The Manager's start/stop (`driver`) on the Rust launcher, on a DISPOSABLE repack:
//!
//! 1. driver start-all: every service runs, the console answers, manage.py is not touched and sees the services;
//! 2. driver stop-all stops everything;
//! 3. manage.py start-all, then driver stop-all stops what Python started;
//! 4. a taken world port fails with the typed "port in use" code (no stderr parsing), then stop-all;
//! 5. driver start-all, then the forced stop;
//! 6. with a realm profile: the realm row gets the profile's name, manage.py is still not edited;
//! 7. nothing of the repack is left running.
//!
//! usage: manager_launcher_e2e <existing folder ending in -fixture>
use std::path::Path;
use std::process::Command;
use std::time::Instant;
use coa_core::driver::{self, Verb};
use coa_core::error::ErrorCode;
use coa_core::launcher::{services, settings::Settings, state};
fn indent(s: &str) -> String {
s.lines().map(|l| format!(" {l}")).collect::<Vec<_>>().join("\n")
}
fn drive(root: &Path, verb: Verb) -> driver::DriverOutcome {
let t = Instant::now();
let out = driver::run(root, verb).expect("driver");
println!("[driver {verb:?}] ok={} code={:?} in {:?}\n{}", out.ok, out.code, t.elapsed(), indent(&out.output));
out
}
fn manage(root: &Path, action: &str) -> (bool, String) {
let python = root.join("Runtime/python/python.exe");
let script = root.join("Scripts/manage.py").to_string_lossy().into_owned();
let t = Instant::now();
let out = Command::new(python).args(["-B", &script, action]).output().unwrap();
let text = String::from_utf8_lossy(&out.stdout).into_owned() + &String::from_utf8_lossy(&out.stderr);
println!("[manage.py {action}] ok={} in {:?}\n{}", out.status.success(), t.elapsed(), indent(&text));
(out.status.success(), text)
}
fn python_status(root: &Path) -> serde_json::Value {
let (ok, out) = manage(root, "status-json");
assert!(ok);
let line = out.lines().rev().find(|l| l.trim_start().starts_with('{')).expect("a JSON status line");
serde_json::from_str(line).unwrap()
}
fn all(v: &serde_json::Value, running: bool) -> bool {
["mysql", "auth", "world", "relay"].iter().all(|k| v[*k] == running)
}
fn nothing_running(root: &Path) -> bool {
["mysql", "auth", "world", "supervisor", "relay"].iter().all(|n| state::running(root, n).is_none())
&& ["mysql/bin/mysqld.exe", "Core/authserver.exe", "Core/worldserver.exe"]
.iter()
.all(|exe| coa_core::process::find_by_exe(&root.join(exe)).is_empty())
}
fn console(root: &Path) -> String {
let cfg = Settings::load(root, 0).unwrap();
let mut ra = coa_core::ra::Ra::connect_to(cfg.ra_port, &cfg.ra_username, &cfg.ra_password).unwrap();
ra.run("server info").unwrap()
}
fn realm_name(root: &Path) -> String {
services::mysql(root, Some("SELECT name FROM acore_auth.realmlist WHERE id=1;"), None).unwrap()
}
fn main() {
let a: Vec<String> = std::env::args().skip(1).collect();
let root = Path::new(&a[0]);
assert!(a[0].ends_with("-fixture"), "a folder ending in -fixture is required");
assert!(nothing_running(root), "the fixture must be stopped before the test");
let manage_py = root.join("Scripts/manage.py");
let original = std::fs::read(&manage_py).unwrap();
let profile = root.join("Settings/realm-profile.json");
assert!(!profile.exists(), "the fixture starts without a realm profile");
// 1
let started = drive(root, Verb::StartAll);
assert!(started.ok, "start-all");
assert!(all(&python_status(root), true), "manage.py sees what the Manager started");
let info = console(root);
println!("[console] {}", info.lines().next().unwrap_or(""));
assert_eq!(std::fs::read(&manage_py).unwrap(), original, "manage.py is not rewritten");
assert_eq!(realm_name(root), "AzerothCore", "no profile: the launcher's own realm name");
let shipped = root.join("Scripts/coa-launcher.exe");
let supervisor = state::running(root, "supervisor").expect("a supervisor");
println!("[supervisor] {}", supervisor.exe);
let expected = if shipped.is_file() { "coa-launcher.exe" } else { "python.exe" };
assert!(supervisor.exe.to_lowercase().ends_with(expected), "the world is supervised by {expected}");
let relay = state::running(root, "relay").expect("a bug-report relay");
println!("[relay] {}", relay.exe);
assert!(relay.exe.to_lowercase().ends_with(expected), "the relay is run by {expected}");
assert!(state::running(root, "relay-ready").is_some_and(|r| r.pid == relay.pid), "the relay reported ready");
// 2
assert!(drive(root, Verb::StopAll).ok, "stop-all");
assert!(nothing_running(root), "1-2 left something running");
// 2b: the repack's Python launcher stops a world the Manager started
assert!(drive(root, Verb::StartAll).ok);
assert!(manage(root, "stop-all").0, "manage.py stops what the Manager started");
assert!(nothing_running(root), "2b left something running");
// 3
assert!(manage(root, "start-all").0);
assert!(drive(root, Verb::StopAll).ok, "driver stops what manage.py started");
assert!(nothing_running(root), "3 left something running");
// 4
let cfg = Settings::load(root, 0).unwrap();
let blocker = std::net::TcpListener::bind(("127.0.0.1", cfg.world_port)).unwrap();
let refused = drive(root, Verb::StartAll);
assert!(!refused.ok);
assert_eq!(refused.code, Some(ErrorCode::PortInUse), "typed port error");
assert!(refused.output.contains(&format!("Port {}", cfg.world_port)));
drop(blocker);
assert!(drive(root, Verb::StopAll).ok);
assert!(nothing_running(root), "4 left something running");
// 5
assert!(drive(root, Verb::StartAll).ok);
let t = Instant::now();
let forced = driver::force_stop(root).expect("force stop");
println!("[driver force_stop] ok={} in {:?}\n{}", forced.ok, t.elapsed(), indent(&forced.output));
assert!(forced.ok && forced.output.contains("Force-stopped"));
assert!(nothing_running(root), "5 left something running");
// 6
std::fs::write(&profile, br#"{"active":"coa","wildcard_created":false}"#).unwrap();
let result = std::panic::catch_unwind(|| {
assert!(drive(root, Verb::StartAll).ok, "start-all with a realm profile");
assert_eq!(realm_name(root), "Conquest of Azeroth");
assert_eq!(std::fs::read(&manage_py).unwrap(), original, "manage.py is not edited for a realm profile either");
assert!(drive(root, Verb::StopAll).ok);
});
std::fs::remove_file(&profile).unwrap();
std::fs::write(&manage_py, &original).unwrap();
if result.is_err() {
let _ = driver::run(root, Verb::StopAll);
panic!("step 6 failed");
}
// 7
assert!(nothing_running(root), "something of the repack is still running");
println!("PASS: the Manager starts and stops through the Rust launcher, interoperates with manage.py, typed errors");
}
@@ -0,0 +1,170 @@
//! The Rust bug-report relay against the repack's `BugReport/relay.py`, offline (a scripted service, no network):
//!
//! 1. the same reports and the same service answers give the same `.status` files and journal rows;
//! 2. each relay continues the other's journal: what one delivered is never sent again by the other, and a post the
//! other left in progress is uncertain.
//!
//! usage: relay_equivalence <repack folder with Runtime/python and BugReport/relay.py>
use std::path::{Path, PathBuf};
use std::process::Command;
use std::sync::{Arc, Mutex};
use coa_core::launcher::relay::{Failure, Relay, Service};
const REPORTS: [(&str, &str); 5] = [
("1-00000000000000a1", "COABUG1\r\nQuest broken\r\nThe NPC is gone.\r\n"),
("9-00000000000000b2", "COABUG1\nRate limited\nBody text\n"),
("3-00000000000000c3", "COABUG1\nRejected\nBody\n"),
("4-00000000000000d4", "COABUG1\nxy\nTitle too short\n"),
("5-00000000000000e5", "COABUG1\nUnknown outcome\nBody\n"),
];
/// The answers per title, in the vocabulary of both relays.
fn answer(title: &str) -> std::result::Result<u64, Failure> {
match title {
"Quest broken" => Ok(101),
"Rate limited" => Err(Failure::Limited(60)),
"Rejected" => Err(Failure::Invalid),
_ => Err(Failure::Uncertain),
}
}
const PYTHON: &str = r#"
import importlib.util, sys, json
from pathlib import Path
spec = importlib.util.spec_from_file_location("relay", sys.argv[1]); relay = importlib.util.module_from_spec(spec); spec.loader.exec_module(relay)
spool = Path(sys.argv[2]); calls = []
class Fake:
def create(self, title, body):
calls.append(title)
if title == "Quest broken": return 101
if title == "Rate limited": raise relay.DeliveryError("limited", 60)
if title == "Rejected": raise relay.DeliveryError("invalid")
raise relay.DeliveryError("uncertain")
t = [float(sys.argv[3])]
def clock():
t[0] += 3
return t[0]
r = relay.Relay(spool, Fake(), clock=clock)
for path in sorted(spool.glob("*.report")):
r.process(path)
r.close()
print(json.dumps(calls))
"#;
struct Scripted(Arc<Mutex<Vec<String>>>);
impl Service for Scripted {
fn create(&self, title: &str, _: &str) -> std::result::Result<u64, Failure> {
self.0.lock().unwrap().push(title.into());
answer(title)
}
}
fn spool(dir: &Path) -> PathBuf {
std::fs::create_dir_all(dir).unwrap();
for (key, text) in REPORTS {
std::fs::write(dir.join(format!("{key}.report")), text).unwrap();
}
dir.into()
}
fn python(repack: &Path, spool: &Path, start: f64) -> Vec<String> {
let out = Command::new(repack.join("Runtime/python/python.exe"))
.args(["-I", "-B", "-c", PYTHON])
.arg(repack.join("BugReport/relay.py"))
.arg(spool)
.arg(start.to_string())
.output()
.unwrap();
assert!(out.status.success(), "{}", String::from_utf8_lossy(&out.stderr));
serde_json::from_slice(&out.stdout).unwrap()
}
/// The clock of both relays: `start`, then 3 seconds later at every reading.
fn rust(spool: &Path, start: f64) -> Vec<String> {
let calls = Arc::new(Mutex::new(Vec::new()));
let t = Mutex::new(start);
let clock = move || {
let mut v = t.lock().unwrap();
*v += 3.0;
*v
};
let relay = Relay::with_clock(spool, Scripted(calls.clone()), Box::new(clock)).unwrap();
relay.pass().unwrap();
drop(relay);
let c = calls.lock().unwrap().clone();
c
}
/// `.status` files and journal rows (without the post time).
fn snapshot(spool: &Path) -> (Vec<(String, String)>, Vec<String>) {
let mut statuses: Vec<(String, String)> = std::fs::read_dir(spool)
.unwrap()
.flatten()
.filter(|e| e.path().extension().is_some_and(|x| x == "status"))
.map(|e| (e.file_name().to_string_lossy().into_owned(), std::fs::read_to_string(e.path()).unwrap()))
.collect();
statuses.sort();
let db = rusqlite::Connection::open(spool.join("relay.sqlite3")).unwrap();
let mut q = db.prepare("SELECT key, digest, marker, state, number, next_try FROM deliveries ORDER BY key").unwrap();
let rows = q
.query_map([], |r| {
Ok(format!(
"{}|{}|{}|{}|{:?}|{}",
r.get::<_, String>(0)?,
r.get::<_, String>(1)?,
r.get::<_, String>(2)?,
r.get::<_, String>(3)?,
r.get::<_, Option<i64>>(4)?,
r.get::<_, f64>(5)?
))
})
.unwrap()
.map(Result::unwrap)
.collect();
(statuses, rows)
}
fn main() {
let repack = PathBuf::from(std::env::args().nth(1).expect("repack folder"));
let work = tempfile::tempdir().unwrap();
// 1
let (a, b) = (spool(&work.path().join("python")), spool(&work.path().join("rust")));
let py_calls = python(&repack, &a, 1000.0);
let rs_calls = rust(&b, 1000.0);
println!("python posted {py_calls:?}\nrust posted {rs_calls:?}");
assert_eq!(py_calls, rs_calls, "the same reports are posted");
let (pa, pb) = (snapshot(&a), snapshot(&b));
for s in &pa.0 {
println!(" {} = {}", s.0, s.1.trim());
}
assert_eq!(pa, pb, "the same statuses and journal");
// 2: each continues the other's journal. Before the retry times nothing is sent again; after them only the
// rate-limited report is (created, rejected and uncertain ones never are).
assert!(python(&repack, &b, 1000.0).is_empty(), "Python does not resend what Rust handled");
assert!(rust(&a, 1000.0).is_empty(), "Rust does not resend what Python handled");
// Later passes: the queued reports go out, a refused or uncertain one never again.
for start in [5000.0, 6000.0, 7000.0] {
let (p, r) = (python(&repack, &b, start), rust(&a, start));
println!("at {start}: python on rust's journal posted {p:?}, rust on python's posted {r:?}");
assert_eq!(p, r, "the same retries");
assert!(!p.iter().any(|t| t == "Quest broken" || t == "Unknown outcome"), "created and uncertain are final");
}
assert_eq!(snapshot(&a), snapshot(&b), "the same after a retry by the other relay");
for dir in [&a, &b] {
let db = rusqlite::Connection::open(dir.join("relay.sqlite3")).unwrap();
db.execute("UPDATE deliveries SET state='posting' WHERE key='9-00000000000000b2'", []).unwrap();
}
python(&repack, &b, 9000.0);
rust(&a, 9000.0);
for dir in [&a, &b] {
let db = rusqlite::Connection::open(dir.join("relay.sqlite3")).unwrap();
let state: String = db.query_row("SELECT state FROM deliveries WHERE key='9-00000000000000b2'", [], |r| r.get(0)).unwrap();
assert_eq!(state, "uncertain", "an interrupted post is not retried ({})", dir.display());
}
assert_eq!(snapshot(&a), snapshot(&b), "still the same after the crossover");
println!("PASS: relay journals, statuses and posts are the same in Python and Rust");
}
@@ -0,0 +1,103 @@
//! SQUID database provisioning in Rust gives exactly what Scripts/squid_playerbots.py gives, on a DISPOSABLE repack:
//! the same journals (coa_squid_migrations, coa_squid_pending) in every schema, the same acore_playerbots tables
//! with the same row counts, the same playerbots.conf. Each side starts from the same state (SQUID never
//! provisioned), and a second run of each must change nothing.
//!
//! usage: squid_equivalence <fixture ending in -fixture> <coa-launcher.exe>
use std::path::Path;
use std::process::Command;
use coa_core::launcher::{services, squid};
fn sql(root: &Path, q: &str) -> String {
services::mysql(root, Some(q), None).unwrap_or_else(|e| panic!("{q}: {e}"))
}
/// What provisioning leaves behind, comparable between runs.
fn snapshot(root: &Path) -> String {
let mut out = Vec::new();
for schema in ["acore_characters", "acore_world", "acore_playerbots"] {
let tables = sql(root, &format!("SELECT TABLE_NAME FROM information_schema.TABLES WHERE TABLE_SCHEMA='{schema}' ORDER BY TABLE_NAME;"));
for t in tables.lines() {
if schema != "acore_playerbots" && !t.starts_with("coa_squid") {
continue;
}
let n = sql(root, &format!("SELECT COUNT(*) FROM `{schema}`.`{t}`;"));
out.push(format!("{schema}.{t} rows={n}"));
if t == "coa_squid_migrations" || t == "coa_squid_pending" {
for row in sql(root, &format!("SELECT path, sha256 FROM `{schema}`.`{t}` ORDER BY path;")).lines() {
out.push(format!(" {row}"));
}
}
}
}
let conf = std::fs::read_to_string(root.join("Core/configs/modules/playerbots.conf")).unwrap();
out.push(format!("playerbots.conf:\n{}", conf.replace("\r\n", "\n")));
out.join("\n")
}
fn reset(root: &Path, conf: &[u8]) {
sql(root, "DROP DATABASE IF EXISTS acore_playerbots;");
for schema in ["acore_characters", "acore_world"] {
sql(root, &format!("DROP TABLE IF EXISTS `{schema}`.coa_squid_migrations, `{schema}`.coa_squid_pending;"));
}
std::fs::write(root.join("Core/configs/modules/playerbots.conf"), conf).unwrap();
}
fn python(root: &Path) {
let harness = root.join(".state/squid_harness.py");
std::fs::write(
&harness,
"import sys, pathlib\nroot = pathlib.Path(sys.argv[1])\nsys.path.insert(0, str(root / 'Scripts'))\nsys.argv = ['manage.py']\nimport manage\nfrom squid_playerbots import prepare_playerbots\nprepare_playerbots(manage.ROOT, manage.settings(), manage.mysql)\n",
)
.unwrap();
let out = Command::new(root.join("Runtime/python/python.exe")).arg("-B").arg(&harness).arg(root).output().unwrap();
assert!(out.status.success(), "python: {}{}", String::from_utf8_lossy(&out.stdout), String::from_utf8_lossy(&out.stderr));
print!("{}", String::from_utf8_lossy(&out.stdout));
}
fn rust(root: &Path) {
let cfg = coa_core::launcher::Settings::load(root, 0).unwrap();
squid::prepare_playerbots(root, cfg.mysql_port, &|q| services::mysql(root, Some(q), None), &|m| println!("{m}")).unwrap();
}
fn main() {
let a: Vec<String> = std::env::args().skip(1).collect();
let root = Path::new(&a[0]);
let exe = Path::new(&a[1]);
assert!(a[0].ends_with("-fixture"));
let modules = root.join("Core/configs/modules");
// SQUID on, Companions off
let companions = std::fs::read_to_string(modules.join("mod_coa_playerbots.conf")).unwrap();
std::fs::write(modules.join("mod_coa_playerbots.conf"), companions.replace("CoaBots.Enable = 1", "CoaBots.Enable = 0")).unwrap();
let squid_conf = std::fs::read_to_string(modules.join("playerbots.conf")).unwrap().replace("AiPlayerbot.Enabled = 0", "AiPlayerbot.Enabled = 1");
let r = root.to_string_lossy().into_owned();
let started = Command::new(exe).args(["--root", &r, "start-mysql"]).output().unwrap();
assert!(started.status.success(), "{}", String::from_utf8_lossy(&started.stderr));
reset(root, squid_conf.as_bytes());
let t = std::time::Instant::now();
python(root);
println!("python provisioned in {:?}", t.elapsed());
let by_python = snapshot(root);
python(root);
assert_eq!(snapshot(root), by_python, "a second Python run changed something");
reset(root, squid_conf.as_bytes());
let t = std::time::Instant::now();
rust(root);
println!("rust provisioned in {:?}", t.elapsed());
let by_rust = snapshot(root);
rust(root);
assert_eq!(snapshot(root), by_rust, "a second Rust run changed something");
if by_python != by_rust {
std::fs::write(root.join(".state/squid-python.txt"), &by_python).unwrap();
std::fs::write(root.join(".state/squid-rust.txt"), &by_rust).unwrap();
panic!("Rust and Python differ: see .state/squid-python.txt and squid-rust.txt");
}
println!("{} lines of journal/table/config state are identical", by_rust.lines().count());
let stopped = Command::new(exe).args(["--root", &r, "stop-all"]).output().unwrap();
assert!(stopped.status.success());
println!("SQUID EQUIVALENCE PASS");
}
+494
View File
@@ -0,0 +1,494 @@
//! A catalog of game addons the Manager can install into a client's `Interface/AddOns`.
//!
//! Every addon is pinned to a commit of its GitHub repository; the catalog lists each file it installs with its
//! git blob SHA-1 and size, which are checked after download (GitHub's archives are not byte-stable, their
//! contents are). The Manager records what it installed in `Interface/AddOns/.coa-addons.json` and only ever
//! removes or replaces those folders; a folder of the same name that someone else put there is moved to
//! `Interface/AddOns/.coa-addons-backup` first.
use std::collections::BTreeMap;
use std::fs;
use std::io::{Read, Write};
use std::path::{Path, PathBuf};
use serde::{Deserialize, Serialize};
use sha1::{Digest, Sha1};
use crate::download::{Cancel, Transport};
use crate::error::{Error, Result};
use crate::fsx;
static CATALOG: &str = include_str!("../../../addons/catalog.json");
const STATE: &str = ".coa-addons.json";
const BACKUP: &str = ".coa-addons-backup";
/// No addon archive is anywhere near this; a larger answer is not what the catalog describes.
const MAX_ARCHIVE: u64 = 1 << 30;
#[derive(Debug, Clone, Deserialize)]
struct AddonFile {
path: String,
from: String,
sha1: String,
size: u64,
}
#[derive(Debug, Clone, Deserialize)]
struct Entry {
id: String,
name: String,
description: BTreeMap<String, String>,
author: String,
license: String,
#[serde(default)]
needs: Option<String>,
repo: String,
commit: String,
archive: String,
folders: Vec<String>,
files: Vec<AddonFile>,
}
#[derive(Deserialize)]
struct Catalog {
addons: Vec<Entry>,
}
#[derive(Debug, Default, Clone, Serialize, Deserialize)]
struct Installed {
commit: String,
folders: Vec<String>,
}
/// One addon of the catalog as the Manager shows it for a client.
#[derive(Debug, Clone, Serialize)]
#[serde(rename_all = "camelCase")]
pub struct AddonView {
pub id: String,
pub name: String,
pub description: BTreeMap<String, String>,
pub author: String,
pub license: String,
/// A server module the addon is made for (`playerbots`), shown as a hint.
pub needs: Option<String>,
pub repo: String,
pub size: u64,
pub installed: bool,
pub update_available: bool,
/// Folders of this addon that are in the client but were not installed by the Manager.
pub foreign_folders: Vec<String>,
/// Installed by something else, shown so nobody looks for it twice: `custom-races` (the client patch).
pub bundled: Option<String>,
}
fn catalog() -> Result<Vec<Entry>> {
let catalog: Catalog = serde_json::from_str(CATALOG)?;
for entry in &catalog.addons {
for folder in &entry.folders {
if folder.is_empty() || folder.contains(['/', '\\']) || folder.starts_with('.') {
return Err(Error::Invalid(format!("Invalid addon folder in the catalog: {folder}")));
}
}
}
Ok(catalog.addons)
}
fn addons_dir(client: &Path) -> PathBuf {
client.join("Interface").join("AddOns")
}
fn read_state(client: &Path) -> BTreeMap<String, Installed> {
fsx::read_json(&addons_dir(client).join(STATE)).unwrap_or_default()
}
fn write_state(client: &Path, state: &BTreeMap<String, Installed>) -> Result<()> {
fsx::atomic_write_json(&addons_dir(client).join(STATE), state)
}
/// The catalog with what is installed in `client`.
pub fn list(client: &Path) -> Result<Vec<AddonView>> {
let state = read_state(client);
let dir = addons_dir(client);
let owned: Vec<&String> = state.values().flat_map(|i| i.folders.iter()).collect();
Ok(catalog()?
.into_iter()
.map(|entry| {
let installed = state.get(&entry.id);
AddonView {
foreign_folders: entry
.folders
.iter()
.filter(|f| dir.join(f).exists() && !owned.contains(f))
.cloned()
.collect(),
size: entry.files.iter().map(|f| f.size).sum(),
installed: installed.is_some(),
update_available: installed.is_some_and(|i| i.commit != entry.commit),
id: entry.id,
name: entry.name,
description: entry.description,
author: entry.author,
license: entry.license,
needs: entry.needs,
repo: entry.repo,
bundled: None,
}
})
.chain(std::iter::once(dev_menu(&dir)))
.collect())
}
/// The /dev menu addon of Custom Races V2: the client patch installs it and switches it with the patch.
fn dev_menu(dir: &Path) -> AddonView {
let mut description = BTreeMap::new();
for (lang, text) in [
("en", "The in-game /dev editor for game masters. It comes with the Custom Races V2 client patch and is switched with it."),
("ru", "Внутриигровой редактор /dev для гейм-мастеров. Ставится вместе с клиентским патчем Custom Races V2 и включается вместе с ним."),
("de", "Der /dev-Editor im Spiel für Spielleiter. Er kommt mit dem Client-Patch Custom Races V2 und wird mit ihm geschaltet."),
("fr", "L'éditeur /dev en jeu pour les maîtres du jeu. Il vient avec le patch client Custom Races V2 et s'active avec lui."),
("es", "El editor /dev del juego para los máster. Viene con el parche de cliente Custom Races V2 y se activa con él."),
("zh", "供游戏管理员使用的游戏内 /dev 编辑器。随 Custom Races V2 客户端补丁安装,并随补丁一起开关。"),
] {
description.insert(lang.to_string(), text.to_string());
}
AddonView {
id: "coa-dev-menu".into(),
name: "CoA Dev Menu".into(),
description,
author: "ilusixn".into(),
license: "see repository".into(),
needs: None,
repo: "https://github.com/ilusixn/ilusixn-dev-menu".into(),
size: 0,
installed: dir.join("CoA_DevMenu/CoA_DevMenu.toc").is_file(),
update_available: false,
foreign_folders: Vec::new(),
bundled: Some("custom-races".into()),
}
}
/// The git blob id of `bytes` (what the catalog records for each file).
fn git_blob_sha1(bytes: &[u8]) -> String {
let mut hasher = Sha1::new();
hasher.update(format!("blob {}\0", bytes.len()).as_bytes());
hasher.update(bytes);
hex::encode(hasher.finalize())
}
fn download(transport: &dyn Transport, url: &str, dest: &Path, cancel: &Cancel) -> Result<()> {
crate::download::check_url(url)?;
let reply = transport.get(url, 0).map_err(Error::Invalid)?;
if reply.status != 200 {
return Err(Error::Invalid(format!("The addon download answered HTTP {}.", reply.status)));
}
let mut body = reply.body.take(MAX_ARCHIVE + 1);
let mut file = fs::File::create(dest)?;
let mut buf = vec![0u8; 1 << 20];
let mut total = 0u64;
loop {
if cancel.is_set() {
return Err(Error::Invalid("Operation cancelled.".into()));
}
let n = body.read(&mut buf)?;
if n == 0 {
break;
}
total += n as u64;
if total > MAX_ARCHIVE {
return Err(Error::Invalid("The addon download is larger than any catalog addon.".into()));
}
file.write_all(&buf[..n])?;
}
file.sync_all()?;
Ok(())
}
/// Unpack the catalog's files of `entry` from `archive` into `staging`, checking every one.
fn unpack(entry: &Entry, archive: &Path, staging: &Path) -> Result<()> {
let mut zip = zip::ZipArchive::new(fs::File::open(archive)?)
.map_err(|e| Error::Invalid(format!("The addon download is not a zip archive: {e}")))?;
// GitHub archives hold everything under one top folder (`<repo>-<commit>/`).
let mut by_path = BTreeMap::new();
for index in 0..zip.len() {
let name = zip
.by_index(index)
.map_err(|e| Error::Invalid(e.to_string()))?
.name()
.replace('\\', "/");
if let Some((_, inner)) = name.split_once('/') {
by_path.insert(inner.to_string(), index);
}
}
for file in &entry.files {
let index = *by_path
.get(&file.from)
.ok_or_else(|| Error::Invalid(format!("The addon download lacks {}.", file.from)))?;
let mut zipped = zip.by_index(index).map_err(|e| Error::Invalid(e.to_string()))?;
let mut bytes = Vec::with_capacity(file.size as usize);
zipped.by_ref().take(file.size + 1).read_to_end(&mut bytes)?;
if bytes.len() as u64 != file.size || git_blob_sha1(&bytes) != file.sha1 {
return Err(Error::Invalid(format!("{} failed verification.", file.from)));
}
let target = fsx::safe_join(staging, &file.path)?;
if let Some(parent) = target.parent() {
fs::create_dir_all(parent)?;
}
fs::write(target, bytes)?;
}
Ok(())
}
fn stamp() -> String {
chrono::Local::now().format("%Y%m%d-%H%M%S").to_string()
}
/// Install or update `id` in `client` from `transport`.
pub fn install_with(transport: &dyn Transport, client: &Path, id: &str, cancel: &Cancel) -> Result<Vec<AddonView>> {
if crate::client::is_running(client) {
return Err(Error::Invalid("Close the game before installing addons.".into()));
}
let entry = catalog()?
.into_iter()
.find(|e| e.id == id)
.ok_or_else(|| Error::Invalid(format!("Unknown addon {id}.")))?;
install_entry(transport, client, &entry, cancel)?;
list(client)
}
fn install_entry(transport: &dyn Transport, client: &Path, entry: &Entry, cancel: &Cancel) -> Result<()> {
let dir = addons_dir(client);
fs::create_dir_all(&dir)?;
// Staged next to AddOns' own folders, so the final moves stay on one volume even for a linked AddOns.
let staging = tempfile::Builder::new().prefix(".coa-addon-").tempdir_in(&dir)?;
let archive = staging.path().join("archive.zip");
download(transport, &entry.archive, &archive, cancel)?;
let unpacked = staging.path().join("files");
unpack(entry, &archive, &unpacked)?;
if cancel.is_set() {
return Err(Error::Invalid("Operation cancelled.".into()));
}
let mut state = read_state(client);
let ours: Vec<String> = state.values().flat_map(|i| i.folders.clone()).collect();
// Move what is in the way out first, so a failed move leaves the client as it was.
let mut moved: Vec<(PathBuf, PathBuf)> = Vec::new();
let undo = |moved: &[(PathBuf, PathBuf)]| {
for (from, to) in moved.iter().rev() {
let _ = fs::rename(to, from);
}
};
for folder in &entry.folders {
let target = dir.join(folder);
if !target.exists() {
continue;
}
let aside = if ours.contains(folder) {
staging.path().join("old").join(folder)
} else {
dir.join(BACKUP).join(format!("{folder}-{}", stamp()))
};
if let Some(parent) = aside.parent() {
fs::create_dir_all(parent)?;
}
if let Err(e) = fs::rename(&target, &aside) {
undo(&moved);
return Err(Error::Invalid(format!("{folder} is in use and could not be replaced: {e}")));
}
moved.push((target, aside));
}
let mut placed: Vec<PathBuf> = Vec::new();
for folder in &entry.folders {
let target = dir.join(folder);
if let Err(e) = fs::rename(unpacked.join(folder), &target) {
for p in &placed {
let _ = fs::remove_dir_all(p);
}
undo(&moved);
return Err(Error::Invalid(format!("{folder} could not be installed: {e}")));
}
placed.push(target);
}
state.insert(
entry.id.clone(),
Installed {
commit: entry.commit.clone(),
folders: entry.folders.clone(),
},
);
write_state(client, &state)?;
tracing::info!(addon = %entry.id, commit = %entry.commit, "addon installed");
Ok(())
}
pub fn install(client: &Path, id: &str, cancel: &Cancel) -> Result<Vec<AddonView>> {
install_with(&crate::download::HttpTransport::with_total_timeout(1800)?, client, id, cancel)
}
/// Remove an addon the Manager installed (only its recorded folders).
pub fn remove(client: &Path, id: &str) -> Result<Vec<AddonView>> {
if crate::client::is_running(client) {
return Err(Error::Invalid("Close the game before removing addons.".into()));
}
let mut state = read_state(client);
let Some(installed) = state.remove(id) else {
return list(client);
};
let dir = addons_dir(client);
for folder in &installed.folders {
if folder.is_empty() || folder.contains(['/', '\\']) || folder.starts_with('.') {
continue;
}
let target = dir.join(folder);
if target.exists() {
fs::remove_dir_all(&target)?;
}
}
write_state(client, &state)?;
list(client)
}
#[cfg(test)]
mod tests {
use super::*;
use crate::download::Reply;
struct Serve(Vec<u8>);
impl Transport for Serve {
fn get(&self, _: &str, _: u64) -> std::result::Result<Reply, String> {
Ok(Reply { status: 200, content_range: None, body: Box::new(std::io::Cursor::new(self.0.clone())) })
}
}
/// A GitHub-like archive of the catalog entry `id` with the given file bodies (path in repo -> bytes).
fn archive(entry: &Entry, body: &dyn Fn(&AddonFile) -> Vec<u8>) -> Vec<u8> {
let mut out = std::io::Cursor::new(Vec::new());
let mut zip = zip::ZipWriter::new(&mut out);
for file in &entry.files {
zip.start_file(format!("repo-{}/{}", entry.commit, file.from), zip::write::SimpleFileOptions::default())
.unwrap();
zip.write_all(&body(file)).unwrap();
}
zip.finish().unwrap();
out.into_inner()
}
/// A small catalog entry whose files hash to what the archive will hold.
fn small_entry() -> Entry {
let bytes = b"## Interface: 30300\n".to_vec();
Entry {
id: "t".into(),
name: "T".into(),
description: BTreeMap::new(),
author: "a".into(),
license: "x".into(),
needs: None,
repo: "r".into(),
commit: "c1".into(),
archive: "https://example.invalid/a.zip".into(),
folders: vec!["TestAddon".into()],
files: vec![AddonFile {
path: "TestAddon/TestAddon.toc".into(),
from: "TestAddon/TestAddon.toc".into(),
sha1: git_blob_sha1(&bytes),
size: bytes.len() as u64,
}],
}
}
#[test]
fn the_catalog_is_valid_and_pins_every_addon() {
let entries = catalog().unwrap();
assert!(entries.len() >= 4);
let views = list(Path::new("C:/no-such-client")).unwrap();
assert_eq!(views.iter().filter(|v| v.bundled.is_some()).count(), 1, "the dev menu is shown, not installable");
for e in &entries {
assert_eq!(e.commit.len(), 40, "{}", e.id);
assert!(e.archive.starts_with("https://codeload.github.com/") && e.archive.ends_with(&e.commit));
assert!(e.description.contains_key("en") && e.description.contains_key("ru"));
for folder in &e.folders {
assert!(e.files.iter().any(|f| f.path.eq_ignore_ascii_case(&format!("{folder}/{folder}.toc"))
|| f.path.starts_with(&format!("{folder}/")) && f.path.ends_with(".toc")), "{folder} has no toc");
}
for f in &e.files {
fsx::safe_join(Path::new("C:/x"), &f.path).unwrap();
assert!(e.folders.iter().any(|folder| f.path.starts_with(&format!("{folder}/"))));
}
}
}
#[test]
#[ignore = "Downloads the catalog's small addons from GitHub"]
fn the_real_catalog_installs_from_github() {
let client = tempfile::tempdir().unwrap();
for id in ["incahoots", "coacombat", "squidbots-lite"] {
let views = install(client.path(), id, &Cancel::default()).unwrap();
let view = views.iter().find(|v| v.id == id).unwrap();
assert!(view.installed && !view.update_available, "{id}");
}
assert!(addons_dir(client.path()).join("IncahootsCoA/IncahootsCoA.toc").is_file());
assert!(addons_dir(client.path()).join("SquidBotsLite/SquidBotsLite.toc").is_file());
}
#[test]
fn git_blob_ids_match_git() {
// `printf 'hello\n' | git hash-object --stdin`
assert_eq!(git_blob_sha1(b"hello\n"), "ce013625030ba8dba906f756967f9e9ca394464a");
}
fn unpack_and_place(entry: &Entry, client: &Path, bytes: Vec<u8>) -> Result<()> {
let dir = addons_dir(client);
fs::create_dir_all(&dir)?;
let staging = tempfile::tempdir_in(&dir)?;
let archive = staging.path().join("a.zip");
download(&Serve(bytes), &entry.archive, &archive, &Cancel::default())?;
unpack(entry, &archive, &staging.path().join("files"))
}
#[test]
fn a_tampered_or_incomplete_download_is_refused() {
let client = tempfile::tempdir().unwrap();
let entry = small_entry();
let good = archive(&entry, &|_| b"## Interface: 30300\n".to_vec());
unpack_and_place(&entry, client.path(), good).unwrap();
let bad = archive(&entry, &|_| b"## Interface: 30300 evil\n".to_vec());
assert!(unpack_and_place(&entry, client.path(), bad).unwrap_err().to_string().contains("verification"));
let empty = {
let mut out = std::io::Cursor::new(Vec::new());
zip::ZipWriter::new(&mut out).finish().unwrap();
out.into_inner()
};
assert!(unpack_and_place(&entry, client.path(), empty).unwrap_err().to_string().contains("lacks"));
}
#[test]
fn install_update_and_remove_keep_other_folders() {
let client = tempfile::tempdir().unwrap();
let mut entry = small_entry();
let dir = addons_dir(client.path());
fs::create_dir_all(dir.join("TestAddon")).unwrap();
fs::write(dir.join("TestAddon/mine.lua"), b"player's own").unwrap();
fs::create_dir_all(dir.join("Other")).unwrap();
let serve = Serve(archive(&entry, &|_| b"## Interface: 30300
".to_vec()));
install_entry(&serve, client.path(), &entry, &Cancel::default()).unwrap();
assert!(dir.join("TestAddon/TestAddon.toc").is_file());
assert!(!dir.join("TestAddon/mine.lua").exists(), "the player's folder was set aside");
let backups: Vec<_> = fs::read_dir(dir.join(BACKUP)).unwrap().flatten().collect();
assert_eq!(backups.len(), 1);
assert!(backups[0].path().join("mine.lua").is_file());
assert_eq!(read_state(client.path())["t"].commit, "c1");
// An update replaces the Manager's own folder without another backup.
entry.commit = "c2".into();
install_entry(&serve, client.path(), &entry, &Cancel::default()).unwrap();
assert_eq!(read_state(client.path())["t"].commit, "c2");
assert_eq!(fs::read_dir(dir.join(BACKUP)).unwrap().count(), 1);
// A failed download changes nothing.
let broken = Serve(archive(&entry, &|_| b"tampered".to_vec()));
assert!(install_entry(&broken, client.path(), &entry, &Cancel::default()).is_err());
assert!(dir.join("TestAddon/TestAddon.toc").is_file());
remove(client.path(), "t").unwrap();
assert!(!dir.join("TestAddon").exists());
assert!(dir.join("Other").is_dir());
assert!(!read_state(client.path()).contains_key("t"));
// No leftover staging folders.
assert!(fs::read_dir(&dir).unwrap().flatten().all(|e| !e.file_name().to_string_lossy().starts_with(".coa-addon-")));
}
}
+6 -2
View File
@@ -308,7 +308,9 @@ pub fn with_database<T>(root: &Path, f: impl FnOnce(&Db) -> Result<T>) -> Result
let db = Db::from_repack(root, Account::Admin)?;
let observed = process::observe(root, &read_ports(root));
let mysql_was_up = observed.mysql.state == ServiceState::Running && db.ping();
if !mysql_was_up {
let db = if mysql_was_up {
db
} else {
let out = driver::run(root, Verb::StartMysql)?;
if !out.ok {
// Keep the launcher's own last lines: the title alone ("Something went wrong") hides the cause.
@@ -317,7 +319,9 @@ pub fn with_database<T>(root: &Path, f: impl FnOnce(&Db) -> Result<T>) -> Result
driver::startup_failure(root, &out)
)));
}
}
// The start may have moved the database to another port (a reserved or taken one).
Db::from_repack(root, Account::Admin)?
};
let result = f(&db);
if !mysql_was_up {
let now = process::observe(root, &read_ports(root));
+63 -9
View File
@@ -72,13 +72,23 @@ fn realm_config(old: &[u8], realm: &str) -> Vec<u8> {
}
pub fn sync_realm(client: &Path, meta: &Path, mode: crate::realms::Mode) -> Result<bool> {
sync_realm_when_closed(client, meta, mode, is_running(client))
let realm = match mode {
crate::realms::Mode::Coa => "Conquest of Azeroth",
crate::realms::Mode::Wildcard => "Wildcard",
crate::realms::Mode::Reborn => "Warcraft Reborn",
};
sync_realm_when_closed(client, meta, realm, is_running(client))
}
/// [`sync_realm`] with the realm's name as the server shows it (the owner may have renamed it).
pub fn sync_realm_named(client: &Path, meta: &Path, realm: &str) -> Result<bool> {
sync_realm_when_closed(client, meta, realm, is_running(client))
}
fn sync_realm_when_closed(
client: &Path,
meta: &Path,
mode: crate::realms::Mode,
realm: &str,
running: bool,
) -> Result<bool> {
if running {
@@ -90,11 +100,6 @@ fn sync_realm_when_closed(
Err(e) if e.kind() == std::io::ErrorKind::NotFound => Vec::new(),
Err(e) => return Err(e.into()),
};
let realm = match mode {
crate::realms::Mode::Coa => "Conquest of Azeroth",
crate::realms::Mode::Wildcard => "Wildcard",
crate::realms::Mode::Reborn => "Warcraft Reborn",
};
let new = realm_config(&old, realm);
if new == old {
return Ok(true);
@@ -410,6 +415,38 @@ pub fn install_addon(client: &Path, meta: &Path, source: &Path) -> Result<()> {
Ok(())
}
/// Remove the game's cache of server data (`Cache/WDB/<locale>/*.wdb`: creatures, items, quests, pages). The client
/// keeps answers it got from a server; after the server's data changes they show old names and stats until the
/// cache is gone. Only `.wdb` files under `Cache/WDB` are removed. Returns how many.
pub fn clear_game_cache(client: &Path) -> Result<usize> {
if is_running(client) {
return Ok(0);
}
let root = client.join("Cache").join("WDB");
let mut removed = 0;
let Ok(locales) = fs::read_dir(&root) else {
return Ok(0);
};
for locale in locales.flatten() {
if !locale.file_type().is_ok_and(|t| t.is_dir()) {
continue;
}
let Ok(files) = fs::read_dir(locale.path()) else {
continue;
};
for file in files.flatten() {
let path = file.path();
let is_wdb = path
.extension()
.is_some_and(|e| e.eq_ignore_ascii_case("wdb"));
if is_wdb && file.file_type().is_ok_and(|t| t.is_file()) && fs::remove_file(&path).is_ok() {
removed += 1;
}
}
}
Ok(removed)
}
/// Start the game client. The caller is responsible for making sure the server is ready first.
pub fn launch(client: &Path) -> Result<u32> {
let exe =
@@ -608,6 +645,23 @@ pub fn recover_all_realmlist_overrides(meta_roots: &[PathBuf]) -> usize {
#[cfg(test)]
mod tests {
use super::*;
#[test]
fn only_the_server_data_cache_is_cleared() {
let d = tempfile::tempdir().unwrap();
let wdb = d.path().join("Cache/WDB/enUS");
fs::create_dir_all(&wdb).unwrap();
fs::write(wdb.join("creaturecache.wdb"), b"x").unwrap();
fs::write(wdb.join("itemcache.WDB"), b"x").unwrap();
fs::write(wdb.join("notes.txt"), b"keep").unwrap();
fs::create_dir_all(d.path().join("Data/Retail/Cache")).unwrap();
fs::write(d.path().join("Data/Retail/Cache/id-1.bin"), b"keep").unwrap();
assert_eq!(clear_game_cache(d.path()).unwrap(), 2);
assert!(wdb.join("notes.txt").is_file());
assert!(d.path().join("Data/Retail/Cache/id-1.bin").is_file());
assert_eq!(clear_game_cache(d.path()).unwrap(), 0);
assert_eq!(clear_game_cache(&d.path().join("missing")).unwrap(), 0);
}
#[cfg(windows)]
#[test]
@@ -678,10 +732,10 @@ mod tests {
let meta = d.path().join("meta");
let original = b"SET realmName \"Wildcard\"\n";
fs::write(c.join("WTF/Config.wtf"), original).unwrap();
assert!(!sync_realm_when_closed(&c, &meta, crate::realms::Mode::Coa, true).unwrap());
assert!(!sync_realm_when_closed(&c, &meta, "Conquest of Azeroth", true).unwrap());
assert_eq!(fs::read(c.join("WTF/Config.wtf")).unwrap(), original);
assert!(!backup_dir(&meta).exists());
assert!(sync_realm_when_closed(&c, &meta, crate::realms::Mode::Coa, false).unwrap());
assert!(sync_realm_when_closed(&c, &meta, "Conquest of Azeroth", false).unwrap());
assert_eq!(
fs::read(c.join("WTF/Config.wtf")).unwrap(),
b"SET realmName \"Conquest of Azeroth\"\n"
File diff suppressed because it is too large. Load diff
+373 -31
View File
@@ -463,8 +463,96 @@ fn suffix(path: &Path, extension: &str) -> PathBuf {
))
}
/// SHA-256 of a payload file, remembered for this run of the Manager. V2 is 8.7 GB, and every status check and
/// switch verifies all of it; a rename keeps size, creation and write time, while a replaced file changes them.
fn cached_sha256(path: &Path) -> Option<String> {
use std::collections::HashMap;
use std::sync::{Mutex, OnceLock};
use std::time::UNIX_EPOCH;
static HASHES: OnceLock<Mutex<HashMap<(String, u64, u128, u128), String>>> = OnceLock::new();
let meta = fs::metadata(path).ok()?;
let nanos = |time: io::Result<std::time::SystemTime>| {
time.ok()
.and_then(|t| t.duration_since(UNIX_EPOCH).ok())
.map(|d| d.as_nanos())
};
// The name without `.disabled`: switching renames only that suffix.
let name = path.file_name()?.to_string_lossy().to_ascii_lowercase();
let name = name.strip_suffix(".disabled").unwrap_or(&name).to_string();
let key = match (nanos(meta.modified()), nanos(meta.created())) {
(Some(modified), Some(created)) => Some((name, meta.len(), modified, created)),
_ => None,
};
let hashes = HASHES.get_or_init(Mutex::default);
if let Some(hash) = key.as_ref().and_then(|key| hashes.lock().ok()?.get(key).cloned()) {
return Some(hash);
}
let hash = fsx::sha256_file(path).ok()?;
if let (Some(key), Ok(mut hashes)) = (key, hashes.lock()) {
hashes.insert(key, hash.clone());
}
Some(hash)
}
fn matches_patch(path: &Path, file: &PatchFile) -> bool {
path.is_file() && fsx::sha256_file(path).is_ok_and(|hash| hash == file.sha256)
path.is_file() && cached_sha256(path).is_some_and(|hash| hash == file.sha256)
}
/// Whether disabling the patch must hide this file. The stock client loads only the MPQs in Data,
/// dinput8.dll and the addons; the rest (Data/Retail, VulkanShaders, the Esteria data files) is read by the
/// custom races executable and its libraries alone, so it stays in place: thousands of renames bought nothing.
/// A file that replaced one of the player's own (an `.original` exists) is always switched.
fn is_switched(client: &Path, file: &PatchFile) -> bool {
let lower = file.path.to_ascii_lowercase();
let entry_point = lower.starts_with("interface/addons/")
|| lower
.strip_prefix("data/")
.is_some_and(|name| !name.contains('/') && name.ends_with(".mpq"))
|| (!lower.contains('/')
&& [".dll", ".exe", ".bat"]
.iter()
.any(|extension| lower.ends_with(extension)));
entry_point || suffix(&client.join(&file.path), "original").is_file()
}
/// Characters of custom races (RaceID above 11) on the active realm: a game client without the client patch
/// crashes when one of them comes into view, so the server keeps them out of the world while custom races are
/// off. `None` when the database is not running.
#[derive(Debug, Clone, Copy, Serialize, PartialEq, Eq)]
#[serde(rename_all = "camelCase")]
pub struct CustomRaceCharacters {
pub players: u32,
pub companion_bots: u32,
pub squid_bots: u32,
}
pub fn custom_race_characters(root: &Path) -> Result<Option<CustomRaceCharacters>> {
let squid = crate::accounts::squid_bot_prefix(root);
let characters = crate::realms::state(root)
.map(|s| s.active)
.unwrap_or_default()
.schema("characters")?;
crate::backup::with_running_database(root, |db| {
let out = db.query(&format!(
"SELECT \
IFNULL(SUM(a.username NOT LIKE 'COABOTHOST%' AND a.username NOT LIKE '{squid}%'), 0), \
IFNULL(SUM(a.username LIKE 'COABOTHOST%'), 0), \
IFNULL(SUM(a.username LIKE '{squid}%'), 0) \
FROM {characters}.characters c JOIN acore_auth.account a ON a.id = c.account WHERE c.race > 11;"
))?;
let numbers: Vec<u32> = out
.lines()
.last()
.unwrap_or("")
.split('\t')
.map(|n| n.trim().parse().unwrap_or(0))
.collect();
Ok(CustomRaceCharacters {
players: numbers.first().copied().unwrap_or(0),
companion_bots: numbers.get(1).copied().unwrap_or(0),
squid_bots: numbers.get(2).copied().unwrap_or(0),
})
})
}
/// Only complete, verified payloads are reported as enabled or disabled.
@@ -495,9 +583,11 @@ pub fn client_patch_status(client_path: &Path) -> ClientPatchStatus {
ClientPatchState::Enabled
}
Ok(files)
if files
.iter()
.all(|f| matches_patch(&suffix(&client_path.join(&f.path), "disabled"), f)) =>
if files.iter().all(|f| {
let active = client_path.join(&f.path);
matches_patch(&suffix(&active, "disabled"), f)
|| (!is_switched(client_path, f) && matches_patch(&active, f))
}) =>
{
ClientPatchState::Disabled
}
@@ -539,9 +629,24 @@ struct SavedFile {
moved_to: Option<String>,
}
/// One line of the append-only journal. A payload has thousands of files, so the journal is never rewritten:
/// each step adds one synced line, and recovery replays the lines in order.
#[derive(Serialize, Deserialize)]
#[serde(rename_all = "snake_case")]
enum JournalRecord {
Saved { path: String, existed: bool },
Moved { index: usize, to: String },
Returned { index: usize },
}
const LEGACY_JOURNAL: &str = "journal.json";
const JOURNAL: &str = "journal.jsonl";
struct PatchTransaction<'a> {
root: &'a Path,
entries: Vec<SavedFile>,
index: std::collections::HashMap<String, usize>,
journal: Option<File>,
finished: bool,
}
@@ -564,37 +669,102 @@ fn move_patch_file(source: &Path, target: &Path) -> io::Result<()> {
fs::remove_file(source)
}
fn append_record(journal: &mut File, record: &JournalRecord) -> Result<()> {
use std::io::Write;
let mut line = serde_json::to_vec(record)?;
line.push(b'\n');
journal.write_all(&line)?;
journal.sync_data()?;
Ok(())
}
/// Replays a journal. A line cut short by a crash is the last one and was never followed by its file
/// operation (each line is synced before the operation it describes), so reading stops there.
fn read_journal(directory: &Path) -> Result<Vec<SavedFile>> {
let legacy = directory.join(LEGACY_JOURNAL);
if legacy.is_file() {
return fsx::read_json(&legacy);
}
let bytes = match fs::read(directory.join(JOURNAL)) {
Ok(bytes) => bytes,
Err(error) if error.kind() == io::ErrorKind::NotFound => return Ok(Vec::new()),
Err(error) => return Err(error.into()),
};
let mut entries: Vec<SavedFile> = Vec::new();
for line in bytes.split(|byte| *byte == b'\n') {
let Ok(record) = serde_json::from_slice::<JournalRecord>(line) else {
break;
};
match record {
JournalRecord::Saved { path, existed } => entries.push(SavedFile {
path,
existed,
moved_to: None,
}),
JournalRecord::Moved { index, to } => {
let entry = entries
.get_mut(index)
.ok_or_else(|| Error::Invalid("Invalid custom races journal.".into()))?;
entry.moved_to = Some(to);
}
JournalRecord::Returned { index } => {
let entry = entries
.get_mut(index)
.ok_or_else(|| Error::Invalid("Invalid custom races journal.".into()))?;
entry.moved_to = None;
}
}
}
Ok(entries)
}
impl<'a> PatchTransaction<'a> {
fn new(root: &'a Path) -> Result<Self> {
recover_patch_transaction(root)?;
fs::create_dir(root.join(".coa-races-transaction"))?;
let directory = root.join(".coa-races-transaction");
fs::create_dir(&directory)?;
let journal = fs::OpenOptions::new()
.create_new(true)
.append(true)
.open(directory.join(JOURNAL))?;
Ok(Self {
root,
entries: Vec::new(),
index: std::collections::HashMap::new(),
journal: Some(journal),
finished: false,
})
}
fn save(&mut self, path: &Path) -> Result<()> {
fn relative(&self, path: &Path) -> Result<String> {
let relative = path
.strip_prefix(self.root)
.map_err(|_| Error::Invalid("Patch path escaped the client directory.".into()))?
.to_string_lossy()
.replace('\\', "/");
fsx::safe_join(self.root, &relative)?;
if self.entries.iter().any(|entry| entry.path == relative) {
Ok(relative)
}
fn save(&mut self, path: &Path) -> Result<()> {
let relative = self.relative(path)?;
if self.index.contains_key(&relative) {
return Ok(());
}
let index = self.entries.len();
let existed = path.is_file();
append_record(
self.journal.as_mut().expect("open journal"),
&JournalRecord::Saved {
path: relative.clone(),
existed,
},
)?;
self.index.insert(relative.clone(), index);
self.entries.push(SavedFile {
path: relative,
existed: path.is_file(),
existed,
moved_to: None,
});
fsx::atomic_write_json(
&self.root.join(".coa-races-transaction/journal.json"),
&self.entries,
)?;
if path.is_file() {
if existed {
move_patch_file(
path,
&self
@@ -619,21 +789,16 @@ impl<'a> PatchTransaction<'a> {
// Save the destination first so recovery restores the moved source before it.
self.save(target)?;
self.save(source)?;
let index = self
.entries
.iter()
.position(|entry| self.root.join(&entry.path) == source)
.unwrap();
let relative = target
.strip_prefix(self.root)
.map_err(|_| Error::Invalid("Patch path escaped the client directory.".into()))?
.to_string_lossy()
.replace('\\', "/");
self.entries[index].moved_to = Some(relative);
fsx::atomic_write_json(
&self.root.join(".coa-races-transaction/journal.json"),
&self.entries,
let index = self.index[&self.relative(source)?];
let relative = self.relative(target)?;
append_record(
self.journal.as_mut().expect("open journal"),
&JournalRecord::Moved {
index,
to: relative.clone(),
},
)?;
self.entries[index].moved_to = Some(relative);
fs::create_dir_all(target.parent().unwrap())?;
move_patch_file(
&self
@@ -651,6 +816,8 @@ impl<'a> PatchTransaction<'a> {
b"committed",
)?;
self.finished = true;
// Windows cannot remove a directory while a file in it is open.
self.journal = None;
fs::remove_dir_all(self.root.join(".coa-races-transaction"))?;
Ok(())
}
@@ -658,6 +825,7 @@ impl<'a> PatchTransaction<'a> {
impl Drop for PatchTransaction<'_> {
fn drop(&mut self) {
if !self.finished {
self.journal = None;
let _ = recover_patch_transaction(self.root);
}
}
@@ -668,8 +836,19 @@ fn recover_patch_transaction(root: &Path) -> Result<()> {
if !directory.is_dir() {
return Ok(());
}
if !directory.join("committed").exists() && directory.join("journal.json").exists() {
let mut entries: Vec<SavedFile> = fsx::read_json(&directory.join("journal.json"))?;
if !directory.join("committed").exists() {
let legacy = directory.join(LEGACY_JOURNAL).is_file();
let mut entries = read_journal(&directory)?;
let mut journal = if legacy {
None
} else {
Some(
fs::OpenOptions::new()
.create(true)
.append(true)
.open(directory.join(JOURNAL))?,
)
};
for index in (0..entries.len()).rev() {
let entry = &entries[index];
let path = fsx::safe_join(root, &entry.path)?;
@@ -681,7 +860,10 @@ fn recover_patch_transaction(root: &Path) -> Result<()> {
}
// Persist recovery progress before restoring the source, making retries safe.
entries[index].moved_to = None;
fsx::atomic_write_json(&directory.join("journal.json"), &entries)?;
match journal.as_mut() {
Some(journal) => append_record(journal, &JournalRecord::Returned { index })?,
None => fsx::atomic_write_json(&directory.join(LEGACY_JOURNAL), &entries)?,
}
}
let entry = &entries[index];
if saved.is_file() {
@@ -693,6 +875,7 @@ fn recover_patch_transaction(root: &Path) -> Result<()> {
fs::remove_file(path)?;
}
}
drop(journal);
}
fs::remove_dir_all(directory)?;
Ok(())
@@ -783,7 +966,8 @@ pub fn set_client_patch_enabled(client: &Path, enabled: bool) -> Result<()> {
let active = client.join(&file.path);
let disabled = suffix(&active, "disabled");
let original = suffix(&active, "original");
if enabled {
// Data the stock client never reads stays active, and an older Manager's disabled copy comes back.
if enabled || !is_switched(client, &file) {
if active.is_file() && !matches_patch(&active, &file) {
preserve_original(&mut tx, &active)?;
}
@@ -1422,6 +1606,7 @@ mod tests {
("ADDON", base)
} else {
name.strip_prefix("Data/")
.filter(|base| !base.contains('/'))
.map_or(("ROOT", *name), |base| ("MPQ", base))
};
manifest.push_str(&format!(
@@ -1432,6 +1617,146 @@ mod tests {
fs::write(root.join(MANIFEST_FILENAME), manifest).unwrap();
}
const SWITCHED: &[&str] = &[
"Data/patch-ZE1.MPQ",
"dinput8.dll",
"CoACustomRace.exe",
"Start-CoACustomRace.bat",
"Interface/AddOns/CoAHideArmor/CoAHideArmor.lua",
];
const INERT: &[&str] = &[
"Data/Retail/Cache/Retail/wow/decoded/2/strict/id-1.bin",
"Data/Retail/RetailCasc.ini",
"VulkanShaders/a.spv",
"Vulkan/d3d9.dll",
"forever_data/hd_forever_fog.txt",
"EsteriaAppearance.bin",
];
fn client_with(root: &Path, names: &[&str]) {
for name in names {
let path = root.join(name);
fs::create_dir_all(path.parent().unwrap()).unwrap();
fs::write(&path, format!("custom {name}")).unwrap();
}
record_files(root, names);
}
#[test]
fn disabling_hides_only_what_the_stock_client_loads() {
let temp = tempfile::tempdir().unwrap();
let root = temp.path();
let all: Vec<&str> = SWITCHED.iter().chain(INERT).copied().collect();
client_with(root, &all);
set_client_patch_enabled(root, false).unwrap();
for name in SWITCHED {
assert!(!root.join(name).exists(), "{name} stays active");
assert!(suffix(&root.join(name), "disabled").is_file(), "{name}");
}
for name in INERT {
assert!(root.join(name).is_file(), "{name} was moved");
assert!(!suffix(&root.join(name), "disabled").exists(), "{name}");
}
assert_eq!(client_patch_status(root).state, ClientPatchState::Disabled);
set_client_patch_enabled(root, true).unwrap();
assert_eq!(client_patch_status(root).state, ClientPatchState::Enabled);
for name in &all {
assert!(root.join(name).is_file(), "{name}");
}
}
#[test]
fn a_file_that_replaced_the_players_own_is_still_switched() {
let temp = tempfile::tempdir().unwrap();
let root = temp.path();
let name = "Data/Retail/RetailCasc.ini";
client_with(root, &[name]);
fs::write(suffix(&root.join(name), "original"), b"player").unwrap();
set_client_patch_enabled(root, false).unwrap();
assert_eq!(fs::read(root.join(name)).unwrap(), b"player");
assert!(suffix(&root.join(name), "disabled").is_file());
assert_eq!(client_patch_status(root).state, ClientPatchState::Disabled);
}
#[test]
fn a_client_disabled_by_an_older_manager_is_disabled_and_enables() {
let temp = tempfile::tempdir().unwrap();
let root = temp.path();
let all: Vec<&str> = SWITCHED.iter().chain(INERT).copied().collect();
client_with(root, &all);
// 0.9.13 renamed every file of the payload.
for name in &all {
fs::rename(root.join(name), suffix(&root.join(name), "disabled")).unwrap();
}
assert_eq!(client_patch_status(root).state, ClientPatchState::Disabled);
set_client_patch_enabled(root, false).unwrap();
for name in INERT {
assert!(root.join(name).is_file(), "{name} not restored");
}
assert_eq!(client_patch_status(root).state, ClientPatchState::Disabled);
set_client_patch_enabled(root, true).unwrap();
assert_eq!(client_patch_status(root).state, ClientPatchState::Enabled);
}
#[test]
fn a_transaction_left_by_an_older_manager_is_recovered() {
let temp = tempfile::tempdir().unwrap();
let root = temp.path();
let directory = root.join(".coa-races-transaction");
fs::create_dir(&directory).unwrap();
// The source was moved into the journal and then on to its destination when the old Manager stopped.
fs::write(root.join("patch.MPQ.disabled"), b"patch bytes").unwrap();
fs::write(
directory.join(LEGACY_JOURNAL),
r#"[{"path":"patch.MPQ.disabled","existed":false},{"path":"patch.MPQ","existed":true,"moved_to":"patch.MPQ.disabled"}]"#,
)
.unwrap();
recover_patch_transaction(root).unwrap();
assert_eq!(fs::read(root.join("patch.MPQ")).unwrap(), b"patch bytes");
assert!(!root.join("patch.MPQ.disabled").exists());
assert!(!directory.exists());
}
#[test]
fn a_journal_line_cut_short_by_a_crash_is_ignored() {
let temp = tempfile::tempdir().unwrap();
let root = temp.path();
let file = root.join("dinput8.dll");
fs::write(&file, b"previous").unwrap();
let mut tx = PatchTransaction::new(root).unwrap();
tx.save(&file).unwrap();
fs::write(&file, b"replacement").unwrap();
drop(tx.journal.take());
std::mem::forget(tx);
let journal = root.join(".coa-races-transaction").join(JOURNAL);
let mut bytes = fs::read(&journal).unwrap();
bytes.extend_from_slice(br#"{"saved":{"path":"other.dll","exi"#);
fs::write(&journal, bytes).unwrap();
recover_patch_transaction(root).unwrap();
assert_eq!(fs::read(&file).unwrap(), b"previous");
assert!(!root.join(".coa-races-transaction").exists());
}
#[test]
fn switching_a_release_sized_payload_takes_seconds() {
let temp = tempfile::tempdir().unwrap();
let root = temp.path();
let mut names: Vec<String> = (0..7000)
.map(|i| format!("VulkanShaders/shader-{i}.spv"))
.collect();
names.extend((0..80).map(|i| format!("Data/patch-Z{i}.MPQ")));
names.extend((0..140).map(|i| format!("Interface/AddOns/Addon{}/file{i}.lua", i % 9)));
let names: Vec<&str> = names.iter().map(String::as_str).collect();
client_with(root, &names);
let started = std::time::Instant::now();
set_client_patch_enabled(root, false).unwrap();
set_client_patch_enabled(root, true).unwrap();
let elapsed = started.elapsed();
assert_eq!(client_patch_status(root).state, ClientPatchState::Enabled);
// 0.9.13 needed minutes here: it moved every file and rewrote the whole journal after each one.
assert!(elapsed < std::time::Duration::from_secs(60), "{elapsed:?}");
}
#[test]
fn an_update_retires_files_the_new_release_no_longer_ships() {
let temp = tempfile::tempdir().unwrap();
@@ -1548,8 +1873,23 @@ mod tests {
assert!(root
.join("Interface/AddOns/Ascension_Subclass")
.is_dir());
let started = std::time::Instant::now();
set_client_patch_enabled(root, false).unwrap();
eprintln!("disable took {:?}", started.elapsed());
assert_eq!(client_patch_status(root).state, ClientPatchState::Disabled);
// Only what the stock client loads is hidden; the data its executable alone reads stays put.
assert!(!root.join("CoACustomRace.exe").exists());
assert!(!root.join("dinput8.dll").exists());
assert!(!root.join("Data/patch-ZZZD.MPQ").exists());
assert!(!root.join("Interface/AddOns/CoAHideArmor/CoAHideArmor.lua").exists());
assert!(root.join("Vulkan/d3d9.dll").is_file());
assert!(root.join("Data/Retail/RetailCasc.ini").is_file());
let hidden = patch_files(root)
.unwrap()
.iter()
.filter(|file| suffix(&root.join(&file.path), "disabled").is_file())
.count();
eprintln!("hidden {hidden} of {}", patch_files(root).unwrap().len());
assert_eq!(
fs::read(root.join("Ascension.exe")).unwrap(),
b"original game executable"
@@ -1558,7 +1898,9 @@ mod tests {
fs::read(root.join("Data/patch-T.MPQ")).unwrap(),
b"original game patch"
);
let started = std::time::Instant::now();
set_client_patch_enabled(root, true).unwrap();
eprintln!("enable took {:?}", started.elapsed());
assert_eq!(client_patch_status(root).state, ClientPatchState::Enabled);
uninstall_client_patches(root).unwrap();
assert_eq!(
+58 -308
View File
@@ -1,11 +1,10 @@
//! Start/stop of a repack-shaped installation by delegating to the repack's own supervisor
//! (`Runtime\python\python.exe Scripts\manage.py <verb>`), which already implements config rendering, the
//! bug-report relay, RA graceful shutdown and readiness. Observation stays native (see `process`).
//! Start/stop of a repack-shaped installation through the repack launcher in this crate
//! ([`crate::launcher`]): config rendering, the services, the world supervisor, graceful shutdown and readiness.
//! It writes the same `.state` records as the repack's `Scripts/manage.py`, so the repack's own launcher and
//! this Manager can be used on the same folder. Observation stays native (see `process`).
use std::io::Read;
use std::path::{Path, PathBuf};
use std::process::{Command, Stdio};
use std::time::{Duration, Instant};
use std::path::Path;
use std::sync::Mutex;
use serde::Serialize;
@@ -22,22 +21,13 @@ pub enum Verb {
}
impl Verb {
fn arg(self) -> &'static str {
fn action(self) -> crate::launcher::ops::Action {
use crate::launcher::ops::Action;
match self {
Verb::StartAll => "start-all",
Verb::StartMysql => "start-mysql",
Verb::StartWorld => "start-world",
Verb::StopAll => "stop-all",
}
}
fn timeout(self, _root: &Path) -> Duration {
match self {
// Includes database startup, optional bot provisioning and the shared 25-minute
// world/console wait in launcher_bridge.py, even for older installed scripts.
Verb::StartAll | Verb::StartWorld => Duration::from_secs(3600),
Verb::StartMysql => Duration::from_secs(360),
Verb::StopAll => Duration::from_secs(240),
Verb::StartAll => Action::StartAll,
Verb::StartMysql => Action::StartMysql,
Verb::StartWorld => Action::StartWorld,
Verb::StopAll => Action::StopAll,
}
}
}
@@ -52,41 +42,14 @@ pub struct DriverOutcome {
pub output: String,
}
/// Map the launcher's own messages onto stable error codes. Unknown text stays `Unknown` (details remain visible).
pub fn translate(output: &str) -> ErrorCode {
let o = output.to_lowercase();
if o.contains("is already used") {
ErrorCode::PortInUse
} else if o.contains("another start/stop action is in progress")
|| o.contains("shutdown is still finishing")
{
ErrorCode::OperationInProgress
} else if o.contains("packaged database is missing")
|| o.contains("extract the complete repack")
{
ErrorCode::ServerFilesIncomplete
} else if o.contains("stopped during startup")
|| o.contains("is still starting")
|| o.contains("world startup failed")
{
ErrorCode::StartupFailed
} else if o.contains("invalid port") || o.contains("unresolved placeholder") {
ErrorCode::InvalidConfigValue
} else {
ErrorCode::Unknown
}
}
fn launcher(root: &Path) -> Result<(PathBuf, PathBuf)> {
let python = root.join("Runtime/python/python.exe");
let script = root.join("Scripts/manage.py");
if !python.is_file() || !script.is_file() {
fn has_launcher_settings(root: &Path) -> Result<()> {
if !root.join("Settings/repack.json").is_file() {
return Err(Error::Invalid(
"This server has no CoA Repack launcher; start/stop is not available for it yet."
.into(),
));
}
Ok((python, script))
Ok(())
}
/// Run a launcher verb to completion (blocking; call from a worker thread).
@@ -181,6 +144,10 @@ fn run_inner_mode(
}
if matches!(verb, Verb::StartAll | Verb::StartWorld) {
crate::modules::ensure_bot_exclusivity(&root)?;
// A server update that only added races keeps the owner's race restriction (and custom races on).
if let Err(error) = crate::race_availability::rebind_unchanged(&root) {
tracing::warn!(%error, "the race restriction could not be checked against the race catalog");
}
}
if crate::docker::is_docker(&root) {
prepare_headless_world(&root, verb)?;
@@ -205,108 +172,51 @@ fn run_inner_mode(
if matches!(verb, Verb::StartAll | Verb::StartWorld) {
crate::modules::ensure_bot_exclusivity(&root)?;
}
let (python, script) = launcher(&root)?;
has_launcher_settings(&root)?;
prepare_headless_world(&root, verb)?;
let original = std::fs::read_to_string(&script)?;
let patched = patch_launcher_imports(&original)?;
if original != patched {
fsx::atomic_write(&script, patched.as_bytes())?;
if let Ok(dir) = crate::registry::metadata_dir_for(&root) {
if let Ok((_, mut meta)) = crate::registry::MetaDir::open(&dir) {
if meta.original_hashes.get("Scripts/manage.py")
== Some(&fsx::sha256_bytes(original.as_bytes()))
{
meta.original_hashes.insert(
"Scripts/manage.py".into(),
fsx::sha256_bytes(patched.as_bytes()),
);
fsx::atomic_write_json(&dir.join("install.json"), &meta)?;
}
}
}
}
discard_damaged_launcher_state(&root);
if matches!(verb, Verb::StopAll | Verb::StartMysql | Verb::StartAll) {
recover_mysql_launcher_state(&root, verb != Verb::StopAll)?;
}
if force {
recover_world_for_forced_stop(&root)?;
}
let mut cmd = Command::new(&python);
if validating_update {
// Isolated startup must use the port from its temporary auth config.
cmd.env_remove("AC_REALM_SERVER_PORT");
}
cmd.arg("-B")
.arg("-c")
.arg(LAUNCH_SCRIPT)
.arg(&script)
.arg(if force { "force-stop-all" } else { verb.arg() })
.current_dir(&root)
.stdin(Stdio::null())
.stdout(Stdio::piped())
.stderr(Stdio::piped());
#[cfg(windows)]
{
use std::os::windows::process::CommandExt;
cmd.creation_flags(0x0800_0000); // CREATE_NO_WINDOW
}
tracing::info!(?verb, root = %root.display(), "driver: starting launcher verb");
let mut child = cmd.spawn()?;
let mut stdout = child.stdout.take().expect("piped");
let mut stderr = child.stderr.take().expect("piped");
let out_t = std::thread::spawn(move || {
let mut s = String::new();
let _ = stdout.read_to_string(&mut s);
s
});
let err_t = std::thread::spawn(move || {
let mut s = String::new();
let _ = stderr.read_to_string(&mut s);
s
});
let deadline = Instant::now() + verb.timeout(&root);
let status = loop {
if let Some(st) = child.try_wait()? {
break Some(st);
}
if Instant::now() > deadline {
// Never kill the servers themselves: only abandon the launcher process we spawned.
let _ = child.kill();
break None;
}
std::thread::sleep(Duration::from_millis(200));
};
let mut output = out_t.join().unwrap_or_default();
output.push_str(&err_t.join().unwrap_or_default());
let mut output = output.trim().to_string();
if status.is_none() {
output.push_str(&format!(
"\nLauncher {} exceeded its {} second deadline; check the server logs.",
verb.arg(),
verb.timeout(&root).as_secs()
));
}
let (ok, exit_code) = match status {
Some(st) => (st.success(), st.code()),
None => (false, None),
};
let code = if ok {
None
let action = if force {
crate::launcher::ops::Action::ForceStopAll
} else {
// Log evidence beats the launcher's generic "stopped during startup" message.
let base = if status.is_none() {
ErrorCode::StartupFailed
} else {
translate(&output)
};
match base {
ErrorCode::StartupFailed | ErrorCode::Unknown => {
Some(crate::health::diagnose_installation(&root).unwrap_or(base))
verb.action()
};
tracing::info!(?verb, root = %root.display(), "driver: starting launcher action");
let lines = Mutex::new(Vec::<String>::new());
let progress = |line: &str| {
tracing::info!(?verb, "launcher: {line}");
lines.lock().unwrap_or_else(|e| e.into_inner()).push(line.to_string());
};
let result = crate::launcher::Settings::load(&root, 0).and_then(|mut cfg| {
if validating_update {
// Isolated startup must use the port from its temporary auth config.
cfg.env_remove.push("AC_REALM_SERVER_PORT".into());
}
crate::launcher::ops::run(&root, &cfg, 0, action, None, &progress)
});
let mut output = lines.into_inner().unwrap_or_else(|e| e.into_inner()).join("\n");
let ok = result.is_ok();
let code = match &result {
Ok(()) => None,
Err(error) => {
if !output.is_empty() {
output.push('\n');
}
output.push_str(&format!("ERROR: {error}"));
// Log evidence beats a generic "stopped during startup".
match error.code() {
ErrorCode::StartupFailed | ErrorCode::Unknown => Some(
crate::health::diagnose_installation(&root).unwrap_or(error.code()),
),
other => Some(other),
}
other => Some(other),
}
};
let exit_code = Some(if ok { 0 } else { 1 });
if code == Some(ErrorCode::PortInUse) {
let observed = crate::process::observe(&root, &crate::layout::read_ports(&root));
for service in [&observed.mysql, &observed.auth, &observed.world]
@@ -374,35 +284,6 @@ fn prepare_headless_world(root: &Path, verb: Verb) -> Result<()> {
Ok(())
}
/// The launcher keeps one JSON record per service in `.state`. A crash or power loss while it writes one can leave
/// a file of the right length that holds only zero bytes (NTFS keeps the length but not the data), and the launcher
/// then dies on every start with an unreadable record. Such a file carries no information, so remove it: the
/// launcher treats a missing record as "not running". Only empty or all-zero `*.json` files are touched.
pub(crate) fn discard_damaged_launcher_state(root: &Path) -> Vec<PathBuf> {
let mut removed = Vec::new();
let Ok(entries) = std::fs::read_dir(root.join(".state")) else {
return removed;
};
for entry in entries.flatten() {
let path = entry.path();
if path
.extension()
.is_none_or(|e| !e.eq_ignore_ascii_case("json"))
|| !path.is_file()
{
continue;
}
let Ok(bytes) = std::fs::read(&path) else {
continue;
};
if bytes.iter().all(|b| *b == 0) && std::fs::remove_file(&path).is_ok() {
tracing::warn!(file = %path.display(), bytes = bytes.len(), "driver: removed a launcher state file damaged by an interrupted write");
removed.push(path);
}
}
removed
}
/// A lost launcher record must not hide this installation's running MySQL from
/// graceful shutdown. Adopt only the exact executable owning its configured port.
fn recover_mysql_launcher_state(root: &Path, prefer_listener: bool) -> Result<()> {
@@ -453,60 +334,6 @@ fn recover_mysql_launcher_state(root: &Path, prefer_listener: bool) -> Result<()
Ok(())
}
const LAUNCH_SCRIPT: &str = include_str!("launcher_bridge.py");
pub(crate) fn patch_launcher_imports(text: &str) -> Result<String> {
let line = "sys.path.insert(0, str(Path(__file__).resolve().parent))";
if !text.contains("from squid_playerbots import") || text.contains(line) {
return Ok(text.into());
}
let root = "ROOT = Path(__file__).resolve().parents[1]";
if !text.contains(root) || !text.lines().any(|line| line.trim() == "import sys") {
return Err(Error::Invalid(
"The server launcher cannot load its integration scripts. Repair its program files."
.into(),
));
}
Ok(text.replacen(root, &format!("{root}\n{line}"), 1))
}
pub(crate) fn launcher_matches(signed: &str, actual: &[u8]) -> bool {
if signed.as_bytes() == actual {
return true;
}
if patch_launcher_imports(signed).is_ok_and(|s| s.as_bytes() == actual) {
return true;
}
crate::realms::patch_launcher(signed).is_ok_and(|s| {
s.as_bytes() == actual || patch_launcher_imports(&s).is_ok_and(|p| p.as_bytes() == actual)
})
}
/// Recover legacy metadata only when undoing supported Manager edits reproduces the recorded hash.
pub(crate) fn launcher_matches_recorded(recorded: &str, actual: &[u8]) -> bool {
let Ok(text) = std::str::from_utf8(actual) else {
return false;
};
let without_import = text.replacen(
"ROOT = Path(__file__).resolve().parents[1]\nsys.path.insert(0, str(Path(__file__).resolve().parent))",
"ROOT = Path(__file__).resolve().parents[1]", 1,
);
for candidate in [
Some(without_import.clone()),
crate::realms::unpatch_launcher(&without_import),
]
.into_iter()
.flatten()
{
if crate::fsx::sha256_bytes(candidate.as_bytes()).eq_ignore_ascii_case(recorded)
&& launcher_matches(&candidate, actual)
{
return true;
}
}
false
}
pub(crate) fn startup_failure(root: &Path, started: &DriverOutcome) -> String {
let code = started
.code
@@ -608,7 +435,7 @@ mod tests {
text.contains("launcher request failed before completion")
&& text.contains("in progress")
);
assert!(!text.contains("starting launcher verb"));
assert!(!text.contains("starting launcher action"));
}
#[test]
@@ -665,78 +492,10 @@ mod tests {
}
#[test]
fn slow_world_startup_has_time_with_either_bot_system_without_extending_shutdown() {
let folder = tempfile::tempdir().unwrap();
let modules = folder.path().join("Core/configs/modules");
std::fs::create_dir_all(&modules).unwrap();
std::fs::write(
modules.join("playerbots.conf.dist"),
"AiPlayerbot.Enabled = 1\n",
)
.unwrap();
assert_eq!(
Verb::StartAll.timeout(folder.path()),
Duration::from_secs(3600)
);
assert_eq!(
Verb::StopAll.timeout(folder.path()),
Duration::from_secs(240)
);
std::fs::write(modules.join("playerbots.conf"), "AiPlayerbot.Enabled = 0\n").unwrap();
assert_eq!(
Verb::StartWorld.timeout(folder.path()),
Duration::from_secs(3600)
);
assert_eq!(
Verb::StartMysql.timeout(folder.path()),
Duration::from_secs(360)
);
}
#[test]
fn zero_filled_launcher_state_is_discarded_and_valid_state_is_kept() {
let folder = tempfile::tempdir().unwrap();
let state = folder.path().join(".state");
std::fs::create_dir_all(&state).unwrap();
std::fs::write(state.join("mysql.json"), vec![0u8; 116]).unwrap();
std::fs::write(state.join("configuration.json"), Vec::<u8>::new()).unwrap();
std::fs::write(state.join("world.json"), "{\"pid\": 4}\n").unwrap();
std::fs::write(state.join("stop-relay"), Vec::<u8>::new()).unwrap();
std::fs::write(state.join("auth.json"), "{\"pid\": 0}").unwrap();
let mut removed: Vec<_> = discard_damaged_launcher_state(folder.path())
.iter()
.map(|p| p.file_name().unwrap().to_string_lossy().into_owned())
.collect();
removed.sort();
assert_eq!(removed, ["configuration.json", "mysql.json"]);
assert!(
state.join("world.json").exists()
&& state.join("auth.json").exists()
&& state.join("stop-relay").exists()
);
assert!(discard_damaged_launcher_state(folder.path()).is_empty());
assert!(discard_damaged_launcher_state(&folder.path().join("missing")).is_empty());
}
#[test]
fn translates_known_launcher_messages() {
assert_eq!(
translate("RuntimeError: Port 8085 is already used. Stop the other server"),
ErrorCode::PortInUse
);
assert_eq!(
translate("Another start/stop action is in progress."),
ErrorCode::OperationInProgress
);
assert_eq!(
translate("The packaged database is missing. Extract the complete repack."),
ErrorCode::ServerFilesIncomplete
);
assert_eq!(
translate("world stopped during startup. Check its log."),
ErrorCode::StartupFailed
);
assert_eq!(translate("Exit code -1073741819"), ErrorCode::Unknown);
fn launcher_failures_carry_their_error_code() {
let e = Error::Service(ErrorCode::PortInUse, "Port 8085 is already used (PID 4).".into());
assert_eq!(e.code(), ErrorCode::PortInUse);
assert_eq!(e.to_string(), "Port 8085 is already used (PID 4).");
}
#[test]
@@ -779,13 +538,4 @@ mod tests {
assert!(!reason.contains("private"));
assert!(!reason.contains("Something went wrong"));
}
#[test]
fn launcher_import_fix_is_idempotent_and_retains_other_code() {
let text = "import sys\nROOT = Path(__file__).resolve().parents[1]\nfrom squid_playerbots import validate_bots\ncustom = 42\n";
let fixed = patch_launcher_imports(text).unwrap();
assert!(fixed.contains("sys.path.insert(0, str(Path(__file__).resolve().parent))"));
assert!(fixed.ends_with("custom = 42\n"));
assert_eq!(patch_launcher_imports(&fixed).unwrap(), fixed);
}
}
+4
View File
@@ -24,6 +24,9 @@ pub enum Error {
UnknownInstallation(String),
#[error("{0}")]
Invalid(String),
/// A server start or stop failed for a reason the UI can explain (the repack launcher's own errors).
#[error("{1}")]
Service(ErrorCode, String),
#[error("package not published: {0}")]
PackageNotPublished(String),
#[error("download server unreachable: {0}")]
@@ -199,6 +202,7 @@ impl Error {
Error::PackageNotPublished(_) => ErrorCode::PackageNotPublished,
Error::NetworkUnreachable(_) => ErrorCode::NetworkUnreachable,
Error::BotModulesConflict => ErrorCode::BotModulesConflict,
Error::Service(code, _) => *code,
Error::CompanionTemplatesMissing => ErrorCode::CompanionTemplatesMissing,
Error::CompanionCommandUnsupported => ErrorCode::CompanionCommandUnsupported,
_ => ErrorCode::Unknown,
+25
View File
@@ -0,0 +1,25 @@
//! The repack launcher in Rust: what `Scripts/manage.py` does, without Python.
//!
//! Formats on disk stay exactly those of `manage.py`, so the two can be used on the same server during the move
//! (an old `.bat` and a new Manager, or the other way round):
//!
//! * `.state/<service>.json` process records `{pid, exe, created}` (see [`crate::process::ProcessIdentity`]);
//! * `.state/control.lock` one start/stop action at a time: byte 0 locked, as `msvcrt.locking` does;
//! * `.state/control-owner.json`, `.state/configuration.json`, `.state/debug-logs.json`;
//! * the rendered configs (`Core/configs/*.conf`, `mysql/my.ini`, `mysql/admin-client.ini`) byte for byte.
//!
//! State files are written with a flush to disk before they replace the old ones (`manage.py` did not, and a
//! power cut could leave a zero-filled record that stopped every later start).
pub mod ops;
pub mod relay;
pub mod render;
pub mod schedule;
pub mod services;
pub mod settings;
pub mod spawn;
pub mod squid;
pub mod state;
pub mod world;
pub use settings::Settings;
+103
View File
@@ -0,0 +1,103 @@
//! One start/stop action of a repack, with the control lock held (`manage.py main()`): the entry point of both
//! `coa-launcher.exe` and the Manager.
use std::path::Path;
use std::time::Duration;
use crate::error::Result;
use crate::launcher::services::{self, Progress};
use crate::launcher::world::{self, Supervisor};
use crate::launcher::{render, settings::Settings, squid, state};
#[derive(Debug, Clone, Copy, PartialEq, Eq)]
pub enum Action {
StartAll,
StartMysql,
StartAuth,
StartWorld,
StopAll,
/// Stop the world without its console first (unsaved progress is lost), then everything else.
ForceStopAll,
Prepare,
}
impl Action {
/// The command name, as the `.bat` files and `manage.py` call it.
pub fn name(self) -> &'static str {
match self {
Action::StartAll => "start-all",
Action::StartMysql => "start-mysql",
Action::StartAuth => "start-auth",
Action::StartWorld => "start-world",
Action::StopAll => "stop-all",
Action::ForceStopAll => "force-stop-all",
Action::Prepare => "prepare",
}
}
pub fn parse(name: &str) -> Option<Action> {
[
Action::StartAll,
Action::StartMysql,
Action::StartAuth,
Action::StartWorld,
Action::StopAll,
Action::ForceStopAll,
Action::Prepare,
]
.into_iter()
.find(|a| a.name() == name)
}
}
/// Run `action`. A started world is supervised by `supervisor`, or by what the repack ships when it is `None`.
pub fn run(root: &Path, cfg: &Settings, offset: i32, action: Action, supervisor: Option<&Supervisor>, progress: Progress) -> Result<()> {
let _lock = state::ControlLock::acquire(root, action.name(), Duration::from_secs(30), progress)?;
match action {
// Shutdown uses the existing client and console settings: the templates may be exactly what a recovery
// needs to replace, so nothing is rendered.
Action::StopAll => return services::stop_all(root, cfg, progress),
Action::ForceStopAll => return services::force_stop_all(root, cfg, progress),
_ => {}
}
if matches!(action, Action::StartAll | Action::StartWorld) {
squid::validate_bots(root)?;
}
let relocated;
let cfg = match action {
Action::StartAll | Action::StartMysql | Action::StartAuth | Action::StartWorld => {
match services::relocate_database_port(root, cfg, offset, progress)? {
Some(_) => {
let mut moved = Settings::load(root, offset)?;
moved.env_remove = cfg.env_remove.clone();
relocated = moved;
&relocated
}
None => cfg,
}
}
_ => cfg,
};
render::prepare(root, cfg)?;
if action == Action::Prepare {
return Ok(());
}
if matches!(action, Action::StartAll | Action::StartMysql) {
services::start_mysql(root, cfg, progress)?;
}
if matches!(action, Action::StartAll | Action::StartAuth) {
services::start_auth(root, cfg, progress)?;
}
if matches!(action, Action::StartAll | Action::StartWorld) {
let shipped;
let supervisor = match supervisor {
Some(s) => s,
None => {
shipped = Supervisor::of(root)?;
&shipped
}
};
world::start_world(root, cfg, offset, supervisor, progress)?;
}
Ok(())
}
+493
View File
@@ -0,0 +1,493 @@
//! The bug-report relay (`BugReport/relay.py` and `manage.py relay-worker`): delivers the reports the world
//! writes to `BugReport/reports/*.report` through the CoA report service.
//!
//! On disk everything stays as the Python relay keeps it, so either can take over a spool: the `<key>.status`
//! files the world reads back, the delivery journal `relay.sqlite3` (tables `deliveries` and `settings`), and
//! `relay.lock` (byte 0 locked while a worker runs). A delivery interrupted while it was posting becomes
//! `uncertain` and is never sent again (the service's duplicate filter may have been reset in the meantime).
use std::path::{Path, PathBuf};
use std::time::{Duration, SystemTime, UNIX_EPOCH};
use rusqlite::{params, Connection, OptionalExtension};
use sha2::{Digest, Sha256};
use crate::error::{Error, Result};
use crate::launcher::state;
const REPOSITORY: &str = "jealous-sound/azerothcore-wotlk-coa";
pub const SERVICE_URL: &str = "https://coa-bug-report.up.railway.app";
/// Distribution credential for this narrow intake API (the same as relay.py's); not a GitHub token.
pub const DEFAULT_API_KEY: &str = "coa_zRatxUHShOn-HEkoreKGME6sd3DdMG7eKTTKlj2JCK4";
const MAX_FILE: u64 = 16000;
const MAX_RESPONSE: usize = 64 * 1024;
/// `[1-9][0-9]{0,9}-[0-9a-f]{16,48}`: the name of a report file (without `.report`).
pub fn valid_key(key: &str) -> bool {
let Some((id, hex)) = key.split_once('-') else { return false };
(1..=10).contains(&id.len())
&& !id.starts_with('0')
&& id.bytes().all(|b| b.is_ascii_digit())
&& (16..=48).contains(&hex.len())
&& hex.bytes().all(|b| b.is_ascii_digit() || (b'a'..=b'f').contains(&b))
}
/// Why a delivery did not create an issue. Only fixed local codes: never service bodies, credentials or report
/// content.
#[derive(Debug, Clone, Copy, PartialEq, Eq)]
pub enum Failure {
/// 202 pending: the service is still creating it.
Pending(u64),
/// 429: try again later.
Limited(u64),
/// The report itself was refused.
Invalid,
/// The service refused this relay (redirect, auth, missing endpoint, GitHub access).
Blocked(u64),
/// The outcome is unknown (network, timeout, unexpected answer).
Uncertain,
}
/// Where reports go.
pub trait Service {
fn create(&self, title: &str, body: &str) -> std::result::Result<u64, Failure>;
}
/// The CoA report service over HTTPS.
pub struct ReportService {
api: String,
key: String,
client: reqwest::blocking::Client,
}
impl ReportService {
pub fn new(base_url: &str, api_key: &str) -> Result<ReportService> {
if api_key.is_empty() || !api_key.is_ascii() || api_key.chars().any(char::is_whitespace) {
return Err(Error::Invalid("Configure a valid report-service intake key.".into()));
}
let client = reqwest::blocking::Client::builder()
.redirect(reqwest::redirect::Policy::none())
.timeout(Duration::from_secs(30))
// One report every few seconds at most: a fresh connection each time, never a stale pooled one.
.pool_max_idle_per_host(0)
.user_agent("CoA-InGame-BugReport/1")
.build()
.map_err(|e| Error::Invalid(format!("The report client could not start: {e}")))?;
Ok(ReportService { api: format!("{base_url}/v1/reports"), key: api_key.into(), client })
}
}
/// `Retry-After` in seconds, kept within 1 s .. 1 day; `default` when absent or not a number.
fn retry_delay(retry_after: Option<&str>, default: u64) -> u64 {
retry_after.and_then(|v| v.trim().parse::<i64>().ok()).map_or(default, |v| v.clamp(1, 86400) as u64)
}
/// A JSON object of at most 64 KiB, or nothing.
fn json_object(raw: Option<&[u8]>) -> Option<serde_json::Map<String, serde_json::Value>> {
let raw = raw?;
if raw.len() > MAX_RESPONSE {
return None;
}
match serde_json::from_slice(raw).ok()? {
serde_json::Value::Object(map) => Some(map),
_ => None,
}
}
fn issue_number(data: &serde_json::Map<String, serde_json::Value>) -> std::result::Result<u64, Failure> {
let number = data.get("issue_number").and_then(|n| if n.is_u64() { n.as_u64() } else { None });
match number {
Some(n)
if data.get("status").and_then(|s| s.as_str()) == Some("created")
&& (1..=4294967295).contains(&n)
&& data.get("issue_url").and_then(|u| u.as_str())
== Some(format!("https://github.com/{REPOSITORY}/issues/{n}").as_str()) =>
{
Ok(n)
}
_ => Err(Failure::Uncertain),
}
}
/// What a service answer means (relay.py's `create`): the status, its `Retry-After` and its body (`None` when it
/// could not be read or was longer than 64 KiB).
pub fn classify(status: u16, retry_after: Option<&str>, body: Option<&[u8]>) -> std::result::Result<u64, Failure> {
let field = |data: &serde_json::Map<String, serde_json::Value>, k: &str| data.get(k).and_then(|v| v.as_str()).map(str::to_owned);
match status {
200..=202 => {
let data = json_object(body).ok_or(Failure::Uncertain)?;
match status {
202 if field(&data, "status").as_deref() == Some("pending") => Err(Failure::Pending(retry_delay(retry_after, 2))),
202 => Err(Failure::Uncertain),
_ => issue_number(&data),
}
}
429 => Err(Failure::Limited(retry_delay(retry_after, 300))),
400 | 413 | 415 | 422 => Err(Failure::Invalid),
301 | 302 | 303 | 307 | 308 | 401 | 403 | 404 | 405 => Err(Failure::Blocked(300)),
503 => {
let data = json_object(body).unwrap_or_default();
if field(&data, "status").as_deref() == Some("failed") && field(&data, "error").as_deref() == Some("github_access_denied") {
Err(Failure::Blocked(retry_delay(retry_after, 300)))
} else {
Err(Failure::Uncertain)
}
}
_ => Err(Failure::Uncertain),
}
}
impl Service for ReportService {
fn create(&self, title: &str, body: &str) -> std::result::Result<u64, Failure> {
use std::io::Read;
let sent = self
.client
.post(&self.api)
.header("Authorization", format!("Bearer {}", self.key))
.header("Accept", "application/json")
.header("Content-Type", "application/json")
.body(serde_json::json!({ "title": title, "body": body }).to_string())
.send();
let response = sent.map_err(|_| Failure::Uncertain)?;
let status = response.status().as_u16();
let retry_after = response.headers().get("Retry-After").and_then(|v| v.to_str().ok()).map(str::to_owned);
let mut raw = Vec::new();
let read = response.take(MAX_RESPONSE as u64 + 1).read_to_end(&mut raw).is_ok() && raw.len() <= MAX_RESPONSE;
classify(status, retry_after.as_deref(), read.then_some(raw.as_slice()))
}
}
/// A report: `COABUG1\n<title>\n<body>`, checked as the world writes it.
pub struct Report {
pub digest: String,
pub marker: String,
pub title: String,
pub body: String,
}
pub fn read_report(path: &Path) -> Result<Report> {
let bad = || Error::Invalid("Invalid report file".into());
let key = path.file_stem().and_then(|s| s.to_str()).ok_or_else(bad)?;
let meta = std::fs::symlink_metadata(path)?;
if !valid_key(key) || meta.file_type().is_symlink() || meta.len() > MAX_FILE {
return Err(bad());
}
let raw = std::fs::read(path)?;
let text = String::from_utf8(raw.clone()).map_err(|_| bad())?.replace("\r\n", "\n");
let rest = text.strip_prefix("COABUG1\n").ok_or_else(|| Error::Invalid("Unsupported report format".into()))?;
let invalid = || Error::Invalid("Invalid report content".into());
let (title, body) = rest.split_once('\n').ok_or_else(invalid)?;
if !(3..=200).contains(&title.len())
|| body.trim().is_empty()
|| title.chars().any(|c| (c as u32) < 32)
|| body.chars().any(|c| (c as u32) < 32 && !matches!(c, '\r' | '\n' | '\t'))
{
return Err(invalid());
}
let digest = hex(&Sha256::digest(&raw));
let id = hex(&Sha256::digest(format!("{key}:{digest}").as_bytes()));
Ok(Report { digest, marker: format!("<!-- coa-report:{id} -->"), title: title.into(), body: body.into() })
}
fn hex(bytes: &[u8]) -> String {
bytes.iter().map(|b| format!("{b:02x}")).collect()
}
/// `<key>.status`: what the world shows the player (`queued`, `created|<issue>`, `failed`, ...).
pub fn write_status(spool: &Path, key: &str, state: &str, number: Option<u64>) -> Result<()> {
let value = match (state, number) {
("created", Some(n)) => format!("created|{n}"),
("created", None) => "created|None".into(),
_ => state.to_string(),
};
let data = format!("{value}\n");
let destination = spool.join(format!("{key}.status"));
if std::fs::read(&destination).is_ok_and(|d| d == data.as_bytes()) {
return Ok(());
}
crate::fsx::atomic_write(&destination, data.as_bytes())
}
fn now() -> f64 {
SystemTime::now().duration_since(UNIX_EPOCH).map(|d| d.as_secs_f64()).unwrap_or(0.0)
}
/// The delivery journal of one spool.
pub struct Relay<S: Service> {
spool: PathBuf,
service: S,
db: Connection,
clock: Box<dyn Fn() -> f64 + Send>,
}
impl<S: Service> Relay<S> {
pub fn open(spool: &Path, service: S) -> Result<Relay<S>> {
Self::with_clock(spool, service, Box::new(now))
}
pub fn with_clock(spool: &Path, service: S, clock: Box<dyn Fn() -> f64 + Send>) -> Result<Relay<S>> {
let db = Connection::open(spool.join("relay.sqlite3")).map_err(sql)?;
db.execute_batch(
"PRAGMA synchronous=FULL;
CREATE TABLE IF NOT EXISTS deliveries (
key TEXT PRIMARY KEY, digest TEXT NOT NULL, marker TEXT NOT NULL, state TEXT NOT NULL,
number INTEGER, attempted REAL NOT NULL DEFAULT 0, next_try REAL NOT NULL DEFAULT 0
);
CREATE TABLE IF NOT EXISTS settings (key TEXT PRIMARY KEY, value REAL NOT NULL);
UPDATE deliveries SET state='uncertain' WHERE state='posting';",
)
.map_err(sql)?;
Ok(Relay { spool: spool.into(), service, db, clock })
}
fn set_state(&self, key: &str, state: &str, number: Option<u64>, delay: u64) -> Result<()> {
self.db
.execute(
"UPDATE deliveries SET state=?1, number=?2, next_try=?3 WHERE key=?4",
params![state, number.map(|n| n as i64), (self.clock)() + delay as f64, key],
)
.map_err(sql)?;
write_status(&self.spool, key, state, number)
}
fn set_network_gate(&self, delay: u64) -> Result<()> {
self.db
.execute("INSERT OR REPLACE INTO settings VALUES('next_network',?1)", params![(self.clock)() + delay as f64])
.map_err(sql)?;
Ok(())
}
/// Handle one report file; returns its delivery state.
pub fn process(&self, path: &Path) -> Result<String> {
let Some(key) = path.file_stem().and_then(|s| s.to_str()).filter(|k| valid_key(k)) else {
return Ok("ignored".into());
};
let report = match read_report(path) {
Ok(r) => r,
Err(_) => {
write_status(&self.spool, key, "failed", None)?;
return Ok("failed".into());
}
};
self.db
.execute(
"INSERT OR IGNORE INTO deliveries(key,digest,marker,state) VALUES(?1,?2,?3,'queued')",
params![key, report.digest, report.marker],
)
.map_err(sql)?;
let (digest, row_state, number, next_try): (String, String, Option<i64>, f64) = self
.db
.query_row("SELECT digest, state, number, next_try FROM deliveries WHERE key=?1", params![key], |r| {
Ok((r.get(0)?, r.get(1)?, r.get(2)?, r.get(3)?))
})
.map_err(sql)?;
let number = number.map(|n| n as u64);
if digest != report.digest {
// Never replace an existing delivery or publish edited content under the same ID.
write_status(&self.spool, key, "failed", None)?;
return Ok("changed".into());
}
if matches!(row_state.as_str(), "created" | "failed" | "uncertain") {
write_status(&self.spool, key, &row_state, number)?;
return Ok(row_state);
}
if next_try > (self.clock)() {
write_status(&self.spool, key, &row_state, None)?;
return Ok(row_state);
}
let gate: Option<f64> = self
.db
.query_row("SELECT value FROM settings WHERE key='next_network'", [], |r| r.get(0))
.optional()
.map_err(sql)?;
if gate.is_some_and(|g| g > (self.clock)()) {
write_status(&self.spool, key, &row_state, None)?;
return Ok(row_state);
}
self.set_network_gate(5)?;
// A crash after this point needs review: the service's duplicate cache can reset on deploy.
self.db
.execute("UPDATE deliveries SET state='posting', attempted=?1 WHERE key=?2", params![(self.clock)(), key])
.map_err(sql)?;
match self.service.create(&report.title, &report.body) {
Ok(n) => {
self.set_state(key, "created", Some(n), 0)?;
Ok("created".into())
}
Err(failure) => {
let (state, delay) = match failure {
Failure::Limited(d) | Failure::Pending(d) => ("queued", d),
Failure::Blocked(d) => ("blocked", d),
Failure::Invalid => ("failed", 300),
Failure::Uncertain => ("uncertain", 300),
};
self.set_state(key, state, None, delay)?;
if let Failure::Limited(d) | Failure::Blocked(d) = failure {
self.set_network_gate(d)?;
}
Ok(state.into())
}
}
}
/// One pass over the spool, in name order.
pub fn pass(&self) -> Result<()> {
let mut reports: Vec<PathBuf> = std::fs::read_dir(&self.spool)?
.flatten()
.map(|e| e.path())
.filter(|p| p.extension().is_some_and(|x| x == "report"))
.collect();
reports.sort();
for path in reports {
self.process(&path)?;
}
Ok(())
}
}
fn sql(e: rusqlite::Error) -> Error {
Error::Invalid(format!("The bug-report journal failed ({e})."))
}
/// `relay-worker`: deliver reports until the supervisor asks the relay to stop (`.state/stop-relay`).
pub fn worker(root: &Path) -> Result<()> {
let spool = root.join("BugReport/reports");
std::fs::create_dir_all(&spool)?;
let _lock = state::FileLock::try_acquire(&spool.join("relay.lock"))?
.ok_or_else(|| Error::Invalid("Another bug-report relay is already using this spool.".into()))?;
let key = std::env::var("COA_BUGREPORT_API_KEY").unwrap_or_else(|_| DEFAULT_API_KEY.into());
let relay = Relay::open(&spool, ReportService::new(SERVICE_URL, &key)?)?;
state::record(root, "relay-ready", std::process::id())?;
println!("Bug-report relay ready. Waiting for in-game reports.");
let stop = state::dir(root).join("stop-relay");
while !stop.exists() {
relay.pass()?;
for _ in 0..10 {
if stop.exists() {
return Ok(());
}
std::thread::sleep(Duration::from_millis(500));
}
}
Ok(())
}
#[cfg(test)]
mod tests {
use super::*;
use std::sync::{Arc, Mutex};
type Answers = Arc<Mutex<Vec<std::result::Result<u64, Failure>>>>;
struct Fake(Answers, Arc<Mutex<u32>>);
impl Service for Fake {
fn create(&self, _: &str, _: &str) -> std::result::Result<u64, Failure> {
*self.1.lock().unwrap() += 1;
self.0.lock().unwrap().remove(0)
}
}
fn report(spool: &Path, key: &str, text: &str) -> PathBuf {
let p = spool.join(format!("{key}.report"));
std::fs::write(&p, text).unwrap();
p
}
#[test]
fn keys_follow_the_world_format() {
assert!(valid_key("1-0123456789abcdef"));
assert!(valid_key("4294967295-0123456789abcdef0123456789abcdef0123456789abcdef"));
for bad in ["0-0123456789abcdef", "1-0123456789abcde", "1-0123456789ABCDEF", "12345678901-0123456789abcdef", "x"] {
assert!(!valid_key(bad), "{bad}");
}
}
#[test]
fn service_answers_map_like_relay_py() {
let ok = format!(r#"{{"status":"created","issue_number":12,"issue_url":"https://github.com/{REPOSITORY}/issues/12"}}"#);
let cases: Vec<(u16, Option<&str>, Option<&[u8]>, std::result::Result<u64, Failure>)> = vec![
(201, None, Some(ok.as_bytes()), Ok(12)),
(200, None, Some(ok.as_bytes()), Ok(12)),
(201, None, Some(br#"{"status":"created","issue_number":12,"issue_url":"https://evil/12"}"#), Err(Failure::Uncertain)),
(201, None, Some(br#"{"status":"created","issue_number":0,"issue_url":"x"}"#), Err(Failure::Uncertain)),
(201, None, Some(b"[1]"), Err(Failure::Uncertain)),
(201, None, None, Err(Failure::Uncertain)),
(202, Some("7"), Some(br#"{"status":"pending"}"#), Err(Failure::Pending(7))),
(202, None, Some(br#"{"status":"pending"}"#), Err(Failure::Pending(2))),
(202, None, Some(br#"{"status":"other"}"#), Err(Failure::Uncertain)),
(429, Some("999999"), None, Err(Failure::Limited(86400))),
(429, Some("0"), None, Err(Failure::Limited(1))),
(429, Some("soon"), None, Err(Failure::Limited(300))),
(422, None, None, Err(Failure::Invalid)),
(302, None, None, Err(Failure::Blocked(300))),
(401, None, None, Err(Failure::Blocked(300))),
(503, Some("30"), Some(br#"{"status":"failed","error":"github_access_denied"}"#), Err(Failure::Blocked(30))),
(503, None, Some(b"{}"), Err(Failure::Uncertain)),
(500, None, None, Err(Failure::Uncertain)),
];
for (i, (status, retry, body, expected)) in cases.into_iter().enumerate() {
assert_eq!(classify(status, retry, body), expected, "case {i}");
}
assert!(json_object(Some(&vec![b' '; MAX_RESPONSE + 1])).is_none(), "oversized answers are refused");
assert!(ReportService::new(SERVICE_URL, "has space").is_err());
assert!(ReportService::new(SERVICE_URL, "coa_key").is_ok());
}
#[test]
fn a_report_is_checked_and_identified_like_relay_py() {
let d = tempfile::tempdir().unwrap();
let p = report(d.path(), "7-0123456789abcdef", "COABUG1\r\nBroken quest\r\nThe NPC is missing.\r\n");
let r = read_report(&p).unwrap();
assert_eq!(r.title, "Broken quest");
assert_eq!(r.body, "The NPC is missing.\n");
assert_eq!(r.digest, hex(&Sha256::digest(std::fs::read(&p).unwrap())));
assert!(r.marker.starts_with("<!-- coa-report:") && r.marker.len() == 16 + 64 + 4);
for bad in ["COABUG2\nTitle\nBody", "COABUG1\nab\nBody", "COABUG1\nTitle\n \n", "COABUG1\nTi\u{7}tle\nBody", "COABUG1\nTitle"] {
std::fs::write(&p, bad).unwrap();
assert!(read_report(&p).is_err(), "{bad:?}");
}
}
#[test]
fn deliveries_follow_the_journal() {
let d = tempfile::tempdir().unwrap();
let spool = d.path();
let t = Arc::new(Mutex::new(1000.0f64));
let calls = Arc::new(Mutex::new(0));
let answers: Answers = Arc::new(Mutex::new(vec![Err(Failure::Limited(60)), Ok(42)]));
let clock = t.clone();
let relay = Relay::with_clock(spool, Fake(answers, calls.clone()), Box::new(move || *clock.lock().unwrap())).unwrap();
let p = report(spool, "7-0123456789abcdef", "COABUG1\nBroken quest\nThe NPC is missing.\n");
let status = || std::fs::read_to_string(spool.join("7-0123456789abcdef.status")).unwrap();
assert_eq!(relay.process(&p).unwrap(), "queued", "429 keeps it queued");
assert_eq!(status(), "queued\n");
assert_eq!(relay.process(&p).unwrap(), "queued", "not before its retry time");
assert_eq!(*calls.lock().unwrap(), 1);
*t.lock().unwrap() += 61.0;
assert_eq!(relay.process(&p).unwrap(), "created");
assert_eq!(status(), "created|42\n");
assert_eq!(relay.process(&p).unwrap(), "created", "never sent twice");
assert_eq!(*calls.lock().unwrap(), 2);
std::fs::write(&p, "COABUG1\nBroken quest\nEdited.\n").unwrap();
assert_eq!(relay.process(&p).unwrap(), "changed");
relay
.db
.execute("INSERT INTO deliveries(key,digest,marker,state) VALUES('8-0123456789abcdef','x','m','posting')", [])
.unwrap();
drop(relay);
let reopened = Relay::open(spool, Fake(Arc::new(Mutex::new(vec![])), calls.clone())).unwrap();
let state: String =
reopened.db.query_row("SELECT state FROM deliveries WHERE key='8-0123456789abcdef'", [], |r| r.get(0)).unwrap();
assert_eq!(state, "uncertain", "an interrupted post is never retried");
}
#[test]
fn a_second_worker_cannot_take_the_spool() {
let d = tempfile::tempdir().unwrap();
let first = state::FileLock::try_acquire(&d.path().join("relay.lock")).unwrap();
assert!(first.is_some());
assert!(state::FileLock::try_acquire(&d.path().join("relay.lock")).unwrap().is_none());
drop(first);
assert!(state::FileLock::try_acquire(&d.path().join("relay.lock")).unwrap().is_some());
}
}
+367
View File
@@ -0,0 +1,367 @@
//! `prepare`: the configuration files a repack runs with, rendered from `Settings/*.template` and
//! `Settings/repack.json` (`manage.py prepare()`), byte for byte the same.
use std::path::{Path, PathBuf};
use crate::error::{Error, Result};
use crate::launcher::{settings::Settings, state};
/// Services whose running process blocks moving the folder or changing ports.
const SERVICES: [&str; 5] = ["mysql", "auth", "world", "supervisor", "relay"];
/// The root as the servers see it: forward slashes, and the short (8.3) form when the real one has non-Latin
/// letters, which MySQL and the servers do not read reliably from their config files.
pub fn native_root(root: &Path) -> Result<String> {
let mut value = root.to_string_lossy().into_owned();
if !value.is_ascii() {
if let Some(short) = sys::short_path(root) {
value = short;
}
}
if !value.is_ascii() {
return Err(Error::Invalid(
"Extract the repack to a path with Latin letters, such as C:\\Games\\CoA-Repack.".into(),
));
}
Ok(value.replace('\\', "/"))
}
/// Text as Python's text mode reads it: strict UTF-8, Windows and old Mac line ends turned into "\n".
fn read_text(path: &Path) -> Result<String> {
let bytes = std::fs::read(path)?;
let text = String::from_utf8(bytes).map_err(|_| Error::Invalid(format!("{} is not UTF-8 text.", path.display())))?;
Ok(text.replace("\r\n", "\n").replace('\r', "\n"))
}
/// Text written as Python's text mode writes it on Windows: "\n" becomes "\r\n".
fn windows_text(text: &str) -> Vec<u8> {
if cfg!(windows) {
text.replace('\n', "\r\n").into_bytes()
} else {
text.as_bytes().to_vec()
}
}
fn placeholders(line: &str) -> Vec<String> {
let mut out = Vec::new();
let bytes = line.as_bytes();
let mut i = 0;
while i < bytes.len() {
if bytes[i] == b'@' {
let mut j = i + 1;
while j < bytes.len() && (bytes[j].is_ascii_alphabetic() || bytes[j] == b'_') {
j += 1;
}
if j < bytes.len() && j > i + 1 && bytes[j] == b'@' {
out.push(line[i..=j].to_string());
i = j + 1;
continue;
}
}
i += 1;
}
out
}
fn credentials(root: &Path) -> Result<(String, String)> {
let v: serde_json::Value = crate::fsx::read_json(&root.join("Settings/database.json"))?;
let good = |k: &str| {
v.get(k)
.and_then(|x| x.as_str())
.filter(|s| s.len() == 48 && s.bytes().all(|b| b.is_ascii_digit() || (b'a'..=b'f').contains(&b)))
.map(str::to_string)
};
match (good("rootPassword"), good("appPassword")) {
(Some(r), Some(a)) => Ok((r, a)),
_ => Err(Error::Invalid("Invalid packaged database configuration.".into())),
}
}
/// Render every file the repack's services read. Refuses while a service runs and the folder or the ports
/// changed since the last render.
pub fn prepare(root: &Path, config: &Settings) -> Result<Vec<PathBuf>> {
let base = native_root(root)?;
let signature = serde_json::json!({
"root": root.to_string_lossy(),
"ports": serde_json::Value::Object(config.port_map()),
});
let previous = state::dir(root).join("configuration.json");
if previous.exists() {
let recorded: Option<serde_json::Value> = crate::fsx::read_json(&previous).ok();
if recorded.as_ref() != Some(&signature) && SERVICES.iter().any(|s| state::running(root, s).is_some()) {
return Err(Error::Invalid("Stop this repack before moving its folder or changing its ports.".into()));
}
}
let (root_password, app_password) = credentials(root)?;
for folder in ["Core/configs/modules", "Core/Logs", "BugReport/reports", "BugReport/Logs", "mysql/logs", ".state"] {
std::fs::create_dir_all(root.join(folder))?;
}
let mysql_port = config.mysql_port;
let mut values: Vec<(&str, String)> = vec![
("DATA", format!("{base}/Data")),
("LOGS", format!("{base}/Core/Logs")),
("ASCENSION_DBC", format!("{base}/Data/dbc/Ascension")),
("MYSQL_EXE", format!("{base}/mysql/bin/mysql.exe")),
("AUTH_PORT", config.auth_port.to_string()),
("WORLD_PORT", config.world_port.to_string()),
("RA_PORT", config.ra_port.to_string()),
];
for (key, db) in [
("LoginDatabaseInfo", "acore_auth"),
("WorldDatabaseInfo", config.realm.world_db),
("CharacterDatabaseInfo", config.realm.characters_db),
] {
values.push((key, format!("127.0.0.1;{mysql_port};acore;{app_password};{db}")));
}
let mut written = Vec::new();
for (name, target) in [
("authserver.conf", "Core/configs/authserver.conf"),
("worldserver.conf", "Core/configs/worldserver.conf"),
("mod_ascension_compat.conf", "Core/configs/modules/mod_ascension_compat.conf"),
] {
let mut text = read_text(&root.join("Settings").join(format!("{name}.template")))?;
for (key, value) in &values {
text = text.replace(&format!("@{key}@"), value);
}
let mut unresolved: Vec<String> = text
.split('\n')
.filter(|l| !l.trim().is_empty() && !l.trim_start().starts_with('#'))
.flat_map(placeholders)
.collect();
unresolved.sort();
unresolved.dedup();
if !unresolved.is_empty() {
return Err(Error::Service(
crate::error::ErrorCode::InvalidConfigValue,
format!("An unresolved placeholder remains in Settings/{name}.template: {}", unresolved.join(", ")),
));
}
// these three keep "\n" (Python wrote them with newline="\n")
std::fs::write(root.join(target), text.as_bytes())?;
written.push(root.join(target));
}
let custom = custom_mysql_options(root);
let files: [(&str, String); 3] = [
(
"Core/configs/modules/coa_bugreport.conf",
format!(
"# Managed by the repack launcher. Enabled whenever worldserver starts.\nCoABugReport.Enable = 1\nCoABugReport.SpoolDirectory = \"{base}/BugReport/reports\"\nCoABugReport.CooldownSeconds = 120\n"
),
),
(
"mysql/my.ini",
format!(
"[mysqld]\nbasedir=\"{base}/mysql\"\ndatadir=\"{base}/mysql/data\"\nport={mysql_port}\nbind-address=127.0.0.1\nmysqlx=0\ncharacter-set-server=utf8mb4\ncollation-server=utf8mb4_unicode_ci\nmax_allowed_packet=128M\ninnodb_buffer_pool_size=256M\nskip-log-bin\nlog-error=\"{base}/mysql/logs/mysql-error.log\"\npid-file=\"{base}/mysql/mysql.pid\"\n{custom}"
),
),
(
"mysql/admin-client.ini",
format!(
"[client]\nuser=root\npassword={root_password}\nhost=127.0.0.1\nport={mysql_port}\nprotocol=tcp\ndefault-character-set=utf8mb4\n"
),
),
];
for (rel, text) in files {
std::fs::write(root.join(rel), windows_text(&text))?;
written.push(root.join(rel));
}
state::write_json(&previous, &signature)?;
Ok(written)
}
/// The owner's file of extra MySQL options; the launcher rewrites `mysql/my.ini` at every start.
pub const CUSTOM_MYSQL: &str = "Settings/mysql-custom.ini";
/// The owner's MySQL options as written, and the lines a start will add to `[mysqld]`.
#[derive(Debug, serde::Serialize)]
#[serde(rename_all = "camelCase")]
pub struct CustomMysql {
pub text: String,
pub applied: String,
}
pub fn read_custom_mysql(root: &Path) -> CustomMysql {
let text = std::fs::read(root.join(CUSTOM_MYSQL))
.map(|b| String::from_utf8_lossy(&b).into_owned())
.unwrap_or_default();
CustomMysql { text, applied: custom_mysql_options(root) }
}
/// Save the owner's MySQL options; they apply at the next start of the database.
pub fn write_custom_mysql(root: &Path, text: &str) -> Result<CustomMysql> {
if text.len() > 16 * 1024 || text.contains(char::from(0)) {
return Err(Error::Invalid("The MySQL options must be plain text of at most 16 KB.".into()));
}
crate::fsx::atomic_write(&root.join(CUSTOM_MYSQL), text.replace("\r\n", "\n").as_bytes())?;
Ok(read_custom_mysql(root))
}
/// Options the server cannot run without, which only the launcher sets.
const MANAGED_MYSQL_OPTIONS: [&str; 10] = [
"basedir",
"datadir",
"port",
"bind-address",
"mysqlx",
"log-error",
"pid-file",
"socket",
"skip-networking",
"defaults-file",
];
/// `name = value` lines of the owner's file (outside any section or in `[mysqld]`), as lines for `[mysqld]`.
/// Comments, other sections, `!include` and the options the launcher manages are left out.
pub fn custom_mysql_options(root: &Path) -> String {
let Ok(bytes) = std::fs::read(root.join(CUSTOM_MYSQL)) else {
return String::new();
};
let text = String::from_utf8_lossy(&bytes);
let mut in_mysqld = true;
let mut out = String::new();
for line in text.trim_start_matches('\u{feff}').lines() {
let line = line.trim();
if line.is_empty() || line.starts_with('#') || line.starts_with(';') {
continue;
}
if line.starts_with('[') {
in_mysqld = line.eq_ignore_ascii_case("[mysqld]");
continue;
}
if !in_mysqld || line.starts_with('!') {
continue;
}
let name = line
.split('=')
.next()
.unwrap_or("")
.trim()
.to_ascii_lowercase()
.replace('_', "-");
let name = name.strip_prefix("loose-").unwrap_or(&name);
if name.is_empty() || MANAGED_MYSQL_OPTIONS.contains(&name) {
continue;
}
out.push_str(line);
out.push('\n');
}
out
}
#[cfg(windows)]
mod sys {
use std::os::windows::ffi::OsStrExt;
use std::path::Path;
use windows_sys::Win32::Storage::FileSystem::GetShortPathNameW;
pub fn short_path(path: &Path) -> Option<String> {
let wide: Vec<u16> = path.as_os_str().encode_wide().chain(Some(0)).collect();
let mut buf = vec![0u16; 32768];
let n = unsafe { GetShortPathNameW(wide.as_ptr(), buf.as_mut_ptr(), buf.len() as u32) };
(n > 0 && (n as usize) < buf.len()).then(|| String::from_utf16_lossy(&buf[..n as usize]))
}
}
#[cfg(not(windows))]
mod sys {
pub fn short_path(_: &std::path::Path) -> Option<String> {
None
}
}
#[cfg(test)]
mod tests {
use super::*;
pub(crate) fn fixture(root: &Path) {
let w = |rel: &str, text: &[u8]| {
let p = root.join(rel);
std::fs::create_dir_all(p.parent().unwrap()).unwrap();
std::fs::write(p, text).unwrap();
};
w("Settings/repack.json", br#"{"authPort": 3724, "mysqlPort": 3307, "raPassword": "e0c39beaa5c14128", "raPort": 3443, "raUsername": "COAMANAGER", "worldPort": 8085}"#);
w("Settings/database.json", format!(r#"{{"rootPassword": "{}", "appPassword": "{}"}}"#, "a".repeat(48), "0123456789abcdef".repeat(3)).as_bytes());
w("Settings/authserver.conf.template", b"[authserver]\r\nLoginDatabaseInfo = \"@LoginDatabaseInfo@\"\r\nRealmServerPort = @AUTH_PORT@\r\nLogsDir = \"@LOGS@\"\r\n# @NOT_A_VALUE@ in a comment is fine\r\n");
w("Settings/worldserver.conf.template", "[worldserver]\nDataDir = \"@DATA@\"\nWorldServerPort = @WORLD_PORT@\nRa.Port = @RA_PORT@\nWorldDatabaseInfo = \"@WorldDatabaseInfo@\"\nCharacterDatabaseInfo = \"@CharacterDatabaseInfo@\"\nMySQLExecutable = \"@MYSQL_EXE@\"\nMotd = \"Ünïcode stays\"\n".as_bytes());
w("Settings/mod_ascension_compat.conf.template", b"Ascension.DbcDir = \"@ASCENSION_DBC@\"\rOld.Mac = 1\r");
}
#[test]
fn the_owners_mysql_options_are_kept_except_the_managed_ones() {
let d = tempfile::tempdir().unwrap();
std::fs::create_dir_all(d.path().join("Settings")).unwrap();
std::fs::write(
d.path().join(CUSTOM_MYSQL),
"\u{feff}# tuning\ninnodb_buffer_pool_size = 2G\nport=3999\nloose_bind_address=0.0.0.0\n!include C:/x.ini\n[client]\nuser=evil\n[mysqld]\nmax_connections=500\nDATADIR=D:/elsewhere\n",
)
.unwrap();
assert_eq!(
custom_mysql_options(d.path()),
"innodb_buffer_pool_size = 2G\nmax_connections=500\n"
);
assert_eq!(custom_mysql_options(&d.path().join("missing")), "");
}
#[test]
fn placeholders_left_outside_comments_are_refused() {
let d = tempfile::tempdir().unwrap();
fixture(d.path());
std::fs::write(d.path().join("Settings/worldserver.conf.template"), "A = @UNKNOWN@\n").unwrap();
let cfg = Settings::load(d.path(), 0).unwrap();
let err = prepare(d.path(), &cfg).unwrap_err().to_string();
assert!(err.contains("worldserver.conf.template: @UNKNOWN@"), "{err}");
}
#[test]
fn a_bad_password_file_is_refused() {
let d = tempfile::tempdir().unwrap();
fixture(d.path());
std::fs::write(d.path().join("Settings/database.json"), r#"{"rootPassword":"short","appPassword":"x"}"#).unwrap();
let cfg = Settings::load(d.path(), 0).unwrap();
assert!(prepare(d.path(), &cfg).unwrap_err().to_string().contains("Invalid packaged database configuration"));
}
/// Byte-for-byte the same files as the Python launcher. COA_MANAGE_PY = a manage.py to compare with (taken from
/// coa-server-build); skipped without it.
#[test]
fn renders_exactly_what_manage_py_renders() {
let Ok(manage) = std::env::var("COA_MANAGE_PY") else { return };
let python = std::env::var("COA_PYTHON").unwrap_or_else(|_| "python".into());
let rust = tempfile::tempdir().unwrap();
let py = tempfile::tempdir().unwrap();
for d in [rust.path(), py.path()] {
fixture(d);
}
std::fs::create_dir_all(py.path().join("Scripts")).unwrap();
std::fs::copy(&manage, py.path().join("Scripts/manage.py")).unwrap();
// manage.py imports squid_playerbots lazily; prepare does not need it.
let out = std::process::Command::new(&python)
.args(["-I", "-B"])
.arg(py.path().join("Scripts/manage.py"))
.arg("prepare")
.output()
.unwrap();
assert!(out.status.success(), "{}{}", String::from_utf8_lossy(&out.stdout), String::from_utf8_lossy(&out.stderr));
let cfg = Settings::load(rust.path(), 0).unwrap();
let written = prepare(rust.path(), &cfg).unwrap();
let root_text = |p: &Path, base: &Path| {
let n = native_root(base).unwrap();
String::from_utf8(std::fs::read(p).unwrap()).unwrap().replace(&n, "<ROOT>")
};
for file in &written {
let rel = file.strip_prefix(rust.path()).unwrap();
assert_eq!(
root_text(file, rust.path()),
root_text(&py.path().join(rel), py.path()),
"{} differs",
rel.display()
);
}
let sig = |base: &Path| -> serde_json::Value {
let mut v: serde_json::Value = crate::fsx::read_json(&base.join(".state/configuration.json")).unwrap();
v["root"] = serde_json::Value::Null;
v
};
assert_eq!(sig(rust.path()), sig(py.path()));
}
}
+162
View File
@@ -0,0 +1,162 @@
//! Restarts on a schedule (#202): once a day at the owner's local time, the world supervisor asks the world to
//! restart with an in-game countdown, waits for it to exit with AzerothCore's restart code and starts it again.
//! The database and the auth server keep running.
use std::path::{Path, PathBuf};
use std::time::Duration;
use chrono::{Local, NaiveDateTime, NaiveTime, Timelike};
use serde::{Deserialize, Serialize};
use crate::error::{Error, Result};
const FILE: &str = "Settings/restart-schedule.json";
/// Present while a scheduled restart is under way, so a world that is briefly down is not taken for a crash.
const UNDER_WAY: &str = ".state/scheduled-restart";
/// The exit code of `server restart` (AzerothCore's `RESTART_EXIT_CODE`).
pub const RESTART_EXIT_CODE: i32 = 2;
/// A restart missed by more than this (the computer slept, the world started late) waits for the next day.
const LATE: Duration = Duration::from_secs(15 * 60);
/// A world that has not come back within this time no longer counts as restarting.
const UNDER_WAY_LIMIT: Duration = Duration::from_secs(45 * 60);
#[derive(Debug, Clone, PartialEq, Eq, Serialize, Deserialize)]
#[serde(rename_all = "camelCase")]
pub struct RestartSchedule {
pub enabled: bool,
/// Local time, `HH:MM`.
pub time: String,
/// The in-game countdown before the restart, in minutes (1-60).
pub warning_minutes: u32,
}
impl Default for RestartSchedule {
fn default() -> Self {
Self {
enabled: false,
time: "05:00".into(),
warning_minutes: 5,
}
}
}
impl RestartSchedule {
fn at(&self) -> Option<NaiveTime> {
NaiveTime::parse_from_str(self.time.trim(), "%H:%M").ok()
}
fn validate(&self) -> Result<()> {
if self.at().is_none() {
return Err(Error::Invalid("The restart time must be HH:MM, for example 05:00.".into()));
}
if !(1..=60).contains(&self.warning_minutes) {
return Err(Error::Invalid("The restart warning must be 1 to 60 minutes.".into()));
}
Ok(())
}
/// The scheduled moment of `now`'s day, when a restart is due at `now` for a world started at `started`:
/// the moment has passed by less than [`LATE`] and the world was already running before it.
pub fn due(&self, now: NaiveDateTime, started: NaiveDateTime) -> Option<NaiveDateTime> {
if !self.enabled {
return None;
}
let moment = now.date().and_time(self.at()?);
let late = now.signed_duration_since(moment).to_std().ok()?;
(late <= LATE && started < moment).then_some(moment)
}
}
/// The folder whose schedule a world follows: an extra world (`<server>/.realms/<name>`) follows its server's.
fn owner(root: &Path) -> PathBuf {
if crate::launcher::settings::is_extra_world(root) {
if let Some(main) = root.parent().and_then(Path::parent) {
return main.to_path_buf();
}
}
root.to_path_buf()
}
pub fn load(root: &Path) -> RestartSchedule {
crate::fsx::read_json(&owner(root).join(FILE)).unwrap_or_default()
}
pub fn save(root: &Path, schedule: &RestartSchedule) -> Result<RestartSchedule> {
let mut schedule = schedule.clone();
schedule.time = schedule.time.trim().to_string();
if schedule.enabled {
schedule.validate()?;
} else if schedule.at().is_none() {
schedule.time = RestartSchedule::default().time;
}
crate::fsx::atomic_write_json(&owner(root).join(FILE), &schedule)?;
Ok(schedule)
}
pub fn now() -> NaiveDateTime {
Local::now().naive_local().with_nanosecond(0).unwrap_or_else(|| Local::now().naive_local())
}
pub fn mark_under_way(root: &Path) -> Result<()> {
let path = root.join(UNDER_WAY);
if let Some(parent) = path.parent() {
std::fs::create_dir_all(parent)?;
}
std::fs::write(path, b"")?;
Ok(())
}
pub fn clear_under_way(root: &Path) {
let _ = std::fs::remove_file(root.join(UNDER_WAY));
}
/// A scheduled restart of this world is under way (its world may be down for a few minutes).
pub fn under_way(root: &Path) -> bool {
std::fs::metadata(root.join(UNDER_WAY))
.and_then(|m| m.modified())
.is_ok_and(|t| t.elapsed().is_ok_and(|age| age < UNDER_WAY_LIMIT))
}
#[cfg(test)]
mod tests {
use super::*;
fn at(text: &str) -> NaiveDateTime {
NaiveDateTime::parse_from_str(text, "%Y-%m-%d %H:%M").unwrap()
}
#[test]
fn a_restart_is_due_once_after_its_time_for_a_world_that_ran_before_it() {
let s = RestartSchedule { enabled: true, time: "05:00".into(), warning_minutes: 5 };
let started = at("2026-11-14 20:00");
assert_eq!(s.due(at("2026-11-15 04:59"), started), None);
assert_eq!(s.due(at("2026-11-15 05:00"), started), Some(at("2026-11-15 05:00")));
assert_eq!(s.due(at("2026-11-15 05:14"), started), Some(at("2026-11-15 05:00")));
assert_eq!(s.due(at("2026-11-15 05:16"), started), None, "missed by too much");
// The world that came back at 05:06 is not restarted again that day.
assert_eq!(s.due(at("2026-11-15 05:10"), at("2026-11-15 05:06")), None);
assert_eq!(s.due(at("2026-11-16 05:01"), at("2026-11-15 05:06")), Some(at("2026-11-16 05:00")));
let off = RestartSchedule { enabled: false, ..s };
assert_eq!(off.due(at("2026-11-15 05:00"), started), None);
}
#[test]
fn schedules_are_validated_and_extra_worlds_follow_their_server() {
let d = tempfile::tempdir().unwrap();
assert_eq!(load(d.path()), RestartSchedule::default());
let bad = RestartSchedule { enabled: true, time: "25:00".into(), warning_minutes: 5 };
assert!(save(d.path(), &bad).is_err());
let quiet = RestartSchedule { enabled: true, time: "05:00".into(), warning_minutes: 0 };
assert!(save(d.path(), &quiet).is_err());
let good = RestartSchedule { enabled: true, time: " 04:30 ".into(), warning_minutes: 10 };
assert_eq!(save(d.path(), &good).unwrap().time, "04:30");
let extra = d.path().join(".realms/secondary");
std::fs::create_dir_all(&extra).unwrap();
assert!(load(&extra).enabled);
assert!(!under_way(d.path()));
mark_under_way(d.path()).unwrap();
assert!(under_way(d.path()));
clear_under_way(d.path());
assert!(!under_way(d.path()));
}
}
+768
View File
@@ -0,0 +1,768 @@
//! Starting, checking and stopping the services of one repack: MySQL, authserver, worldserver
//! (`manage.py start_mysql`, `start_auth`, `stop_all` and their helpers), with the same rules.
use std::net::{SocketAddr, TcpStream};
use std::path::{Path, PathBuf};
use std::process::{Command, Stdio};
use std::time::{Duration, Instant};
use crate::error::{Error, ErrorCode, Result};
use crate::launcher::{settings::Settings, state};
use crate::process::ProcessIdentity;
pub type Progress<'a> = &'a dyn Fn(&str);
const CREATE_NO_WINDOW: u32 = 0x0800_0000;
const CREATE_NEW_PROCESS_GROUP: u32 = 0x0000_0200;
fn hidden(cmd: &mut Command) -> &mut Command {
#[cfg(windows)]
{
use std::os::windows::process::CommandExt;
cmd.creation_flags(CREATE_NO_WINDOW | CREATE_NEW_PROCESS_GROUP);
}
cmd
}
/// Start `exe` with its output appended to `log`, and record it as `name`. `env_remove` are variables of this
/// process the service must not see.
pub fn spawn(root: &Path, name: &str, exe: &Path, args: &[&str], cwd: &Path, log: &Path, env_remove: &[String]) -> Result<ProcessIdentity> {
let child = crate::launcher::spawn::start(exe, args, cwd, log, env_remove)?;
state::record(root, name, child.pid)
}
// ---------------------------------------------------------------------------------------------------------------
// Ports
// ---------------------------------------------------------------------------------------------------------------
/// What keeps a new server off a port.
#[derive(Debug, Clone, PartialEq, Eq)]
pub enum PortBlock {
/// Processes listen on it.
Owned(Vec<u32>),
/// Windows keeps it in an excluded range (Hyper-V, WSL and Docker reserve such ranges); waiting never helps.
Reserved(u16, u16),
/// Windows still refuses it after the wait (a stopped process' socket, or an owner the table does not show).
Unavailable(i32),
}
/// Wait (up to `wait`) until `port` can be bound by a new server. A port with a listening owner or inside a
/// Windows excluded range is reported at once; a port Windows still holds for a stopped process (a PID-zero row)
/// is waited for. The test bind is exclusive (`SO_EXCLUSIVEADDRUSE`), never a shared one.
pub fn port_block(port: u16, wait: Duration, progress: Progress) -> std::result::Result<(), PortBlock> {
let deadline = Instant::now() + wait;
let mut announced = false;
let mut reserved: Option<Vec<(u16, u16)>> = None;
loop {
let mut owners: Vec<u32> = sys::tcp_rows_v4()
.into_iter()
.filter(|r| r.state == sys::LISTEN && r.local_port == port)
.map(|r| r.pid)
.collect();
owners.sort_unstable();
owners.dedup();
if owners.iter().any(|p| *p != 0) {
return Err(PortBlock::Owned(owners));
}
match sys::exclusive_bind(port) {
Ok(()) => return Ok(()),
Err(code) if code == 10013 || code == 10048 => {
let ranges = reserved.get_or_insert_with(sys::excluded_ranges);
if let Some((start, end)) = ranges.iter().copied().find(|(s, e)| (*s..=*e).contains(&port)) {
return Err(PortBlock::Reserved(start, end));
}
if Instant::now() >= deadline {
return Err(PortBlock::Unavailable(code));
}
if !announced {
progress(&format!("Waiting for Windows to release port {port}..."));
announced = true;
}
std::thread::sleep(Duration::from_millis(250));
}
Err(code) => return Err(PortBlock::Unavailable(code)),
}
}
}
fn port_error(port: u16, block: PortBlock) -> Error {
match block {
PortBlock::Owned(owners) => {
let list: Vec<String> = owners.iter().map(u32::to_string).collect();
Error::Service(
ErrorCode::PortInUse,
format!("Port {port} is already used (PID {}). Stop the other server or change Settings/repack.json.", list.join(", ")),
)
}
PortBlock::Reserved(start, end) => Error::Service(
ErrorCode::PortInUse,
format!(
"Port {port} is reserved by Windows (excluded range {start}-{end}; Hyper-V, WSL and Docker reserve such ranges). Choose another port in Settings/repack.json, or restart the Windows NAT service as administrator (net stop winnat, then net start winnat)."
),
),
PortBlock::Unavailable(code) if code == 10013 || code == 10048 => Error::Invalid(format!(
"Port {port} remains unavailable after 30 seconds (Windows bind error {code}). No process was stopped. Retry after the previous database shutdown has finished, or check the Windows port reservation."
)),
PortBlock::Unavailable(code) => Error::Invalid(format!("Port {port} cannot be checked (Windows error {code}).")),
}
}
/// [`port_block`] with up to 30 s of waiting, as an error a person can act on.
pub fn ensure_free(port: u16, progress: Progress) -> Result<()> {
port_block(port, Duration::from_secs(30), progress).map_err(|block| port_error(port, block))
}
/// The ports of this server's other services and extra worlds, which the database must not take.
fn ports_in_use_by_server(root: &Path, cfg: &Settings) -> Vec<u16> {
let mut ports = vec![cfg.auth_port, cfg.world_port, cfg.ra_port];
for tree in crate::multiworld::Tree::ALL {
let other = crate::multiworld::tree_root(root, tree);
if let Ok(other) = Settings::load(&other, 0) {
ports.extend([other.world_port, other.ra_port, other.auth_port]);
}
}
ports
}
/// Before the database starts: when its port is reserved by Windows or held by a program that is not this
/// server's MySQL, move the database to a free port and record it in `Settings/repack.json`. Only this server's
/// own services connect to MySQL (players never do), and every start renders their configs from that file, so
/// the move needs nothing else. Returns the new port, or `None` when the configured one is usable.
pub fn relocate_database_port(root: &Path, cfg: &Settings, offset: i32, progress: Progress) -> Result<Option<u16>> {
if cfg.shared_database || offset != 0 || state::running(root, "mysql").is_some() {
return Ok(None);
}
let block = match port_block(cfg.mysql_port, Duration::from_secs(30), progress) {
Ok(()) => return Ok(None),
Err(block) => block,
};
let ours = root.join("mysql/bin/mysqld.exe");
if let PortBlock::Owned(owners) = &block {
// This server's own database without a record: never start a second one on the same data.
let same = |pid: &u32| {
crate::process::identity(*pid).is_some_and(|p| same_file(Path::new(&p.exe), &ours))
};
if owners.iter().any(same) {
return Err(port_error(cfg.mysql_port, block));
}
}
let taken = ports_in_use_by_server(root, cfg);
let reserved = sys::excluded_ranges();
let candidate = (cfg.mysql_port.saturating_add(1)..=cfg.mysql_port.saturating_add(400))
.chain(33070..=33470)
.filter(|p| *p > 1024)
.find(|p| {
!taken.contains(p)
&& !reserved.iter().any(|(s, e)| (*s..=*e).contains(p))
&& port_block(*p, Duration::ZERO, &|_| {}).is_ok()
});
let Some(port) = candidate else {
return Err(port_error(cfg.mysql_port, block));
};
let reason = match &block {
PortBlock::Owned(_) => "used by another program",
PortBlock::Reserved(..) => "reserved by Windows",
PortBlock::Unavailable(_) => "unavailable",
};
let path = root.join("Settings/repack.json");
let mut raw = cfg.raw.clone();
raw.insert("mysqlPort".into(), port.into());
crate::fsx::atomic_write_json(&path, &serde_json::Value::Object(raw))?;
tracing::warn!(old = cfg.mysql_port, new = port, reason, "database moved to a free port");
progress(&format!("Port {} is {reason}; the database now uses port {port}.", cfg.mysql_port));
Ok(Some(port))
}
fn same_file(a: &Path, b: &Path) -> bool {
match (std::fs::canonicalize(a), std::fs::canonicalize(b)) {
(Ok(a), Ok(b)) => a.to_string_lossy().eq_ignore_ascii_case(&b.to_string_lossy()),
_ => false,
}
}
/// The ranges of `netsh interface ipv4 show excludedportrange protocol=tcp`: every line that starts with two
/// port numbers (the headers are translated, the numbers are not).
pub(crate) fn parse_excluded_ranges(text: &str) -> Vec<(u16, u16)> {
text.lines()
.filter_map(|line| {
let mut parts = line.split_whitespace();
let start = parts.next()?.parse::<u16>().ok()?;
let end = parts.next()?.parse::<u16>().ok()?;
(start <= end).then_some((start, end))
})
.collect()
}
/// Is the recorded process of `name` serving `port`? Its listener row is the evidence; when a system does not
/// show the owner of a listener, the server side of a fresh loopback connection is (never for MySQL, whose
/// listener has always been visible and which should not get stray connections).
pub fn ready(root: &Path, name: &str, port: u16) -> bool {
let Some(record) = state::running(root, name) else { return false };
let listening = sys::tcp_rows_v4().iter().any(|r| r.state == sys::LISTEN && r.local_port == port && r.pid == record.pid);
if listening {
return crate::process::is_alive(&record);
}
if name == "mysql" {
return false;
}
accepted_by(port, record.pid) && crate::process::is_alive(&record)
}
/// Connect to 127.0.0.1:`port` and check that exactly one established server-side row, owned by `pid`, answers
/// that connection.
fn accepted_by(port: u16, pid: u32) -> bool {
let addr: SocketAddr = ([127, 0, 0, 1], port).into();
let Ok(client) = TcpStream::connect_timeout(&addr, Duration::from_millis(500)) else { return false };
let Ok(mine) = client.local_addr().map(|a| a.port()) else { return false };
let me = std::process::id();
let rows: Vec<sys::TcpRow> = sys::tcp_rows_v4()
.into_iter()
.chain(sys::tcp_rows_v6())
.filter(|r| r.remote_port == mine && r.remote_loopback && !(r.local_port == mine && r.pid == me))
.collect();
rows.len() == 1 && rows[0].state == sys::ESTABLISHED && rows[0].pid == pid
}
pub fn wait_ready(root: &Path, name: &str, port: u16, seconds: u64) -> Result<()> {
let until = Instant::now() + Duration::from_secs(seconds);
while Instant::now() < until {
if ready(root, name, port) {
return Ok(());
}
if state::running(root, name).is_none() {
return Err(Error::Service(ErrorCode::StartupFailed, format!("{name} stopped during startup. Check its log.")));
}
std::thread::sleep(Duration::from_millis(500));
}
Err(Error::Service(
ErrorCode::StartupFailed,
format!("{name} is still starting: its expected TCP listener on port {port} was not found; check its log."),
))
}
// ---------------------------------------------------------------------------------------------------------------
// MySQL client
// ---------------------------------------------------------------------------------------------------------------
/// Run SQL (or a `mysqladmin` command) with the repack's own client and administrator login.
pub fn mysql(root: &Path, sql: Option<&str>, admin: Option<&str>) -> Result<String> {
let exe = root.join(if admin.is_some() { "mysql/bin/mysqladmin.exe" } else { "mysql/bin/mysql.exe" });
let defaults = format!("--defaults-file={}", root.join("mysql/admin-client.ini").display());
let mut cmd = Command::new(exe);
hidden(&mut cmd).arg(defaults);
match admin {
Some(a) => cmd.arg(a),
None => cmd.args(["--batch", "--skip-column-names"]),
};
let payload = sql.map(|s| s.as_bytes().to_vec());
let timeout = if payload.as_ref().is_some_and(|p| p.len() > 1024 * 1024) { 900 } else { 90 };
cmd.stdin(if payload.is_some() { Stdio::piped() } else { Stdio::null() }).stdout(Stdio::piped()).stderr(Stdio::piped());
let mut child = cmd.spawn()?;
if let (Some(data), Some(mut stdin)) = (payload, child.stdin.take()) {
std::thread::spawn(move || {
use std::io::Write;
let _ = stdin.write_all(&data);
});
}
// Both outputs are read while the client runs: a full pipe would stop it (and look like a timeout).
let read = |pipe: Option<Box<dyn std::io::Read + Send>>| {
std::thread::spawn(move || {
let mut buf = Vec::new();
if let Some(mut p) = pipe {
let _ = p.read_to_end(&mut buf);
}
buf
})
};
let out_reader = read(child.stdout.take().map(|p| Box::new(p) as Box<dyn std::io::Read + Send>));
let err_reader = read(child.stderr.take().map(|p| Box::new(p) as Box<dyn std::io::Read + Send>));
let started = Instant::now();
let failed = |stderr: &[u8]| {
let text = String::from_utf8_lossy(stderr);
let detail = text.lines().rev().find(|l| !l.trim().is_empty()).unwrap_or("").trim().to_string();
let mut message = "The repack database command failed; check mysql/logs/mysql-error.log.".to_string();
if !detail.is_empty() {
message.push_str(&format!(" ({detail})"));
}
Error::Invalid(message)
};
let status = loop {
if let Some(status) = child.try_wait()? {
break status;
}
if started.elapsed() > Duration::from_secs(timeout) {
let _ = child.kill();
let _ = child.wait();
let _ = out_reader.join();
return Err(failed(b"timed out"));
}
std::thread::sleep(Duration::from_millis(50));
};
let stdout = out_reader.join().unwrap_or_default();
let stderr = err_reader.join().unwrap_or_default();
if !status.success() {
return Err(failed(&stderr));
}
Ok(String::from_utf8_lossy(&stdout).trim().to_string())
}
// ---------------------------------------------------------------------------------------------------------------
// Start and stop
// ---------------------------------------------------------------------------------------------------------------
pub fn start_mysql(root: &Path, cfg: &Settings, progress: Progress) -> Result<()> {
if cfg.shared_database {
// An extra world uses the main folder's database; it must already run.
return mysql(root, None, Some("ping")).map(|_| ()).map_err(|e| {
Error::Service(ErrorCode::DatabaseNotRunning, format!("The main server's database is not running. {e}"))
});
}
if state::running(root, "mysql").is_some() {
wait_ready(root, "mysql", cfg.mysql_port, 300)?;
mysql(root, None, Some("ping"))?;
progress("MySQL is already running.");
return Ok(());
}
ensure_free(cfg.mysql_port, progress)?;
if !root.join("mysql/data/mysql").is_dir() {
return Err(Error::Service(ErrorCode::ServerFilesIncomplete, "The packaged database is missing. Extract the complete repack.".into()));
}
progress("Starting MySQL...");
let ini = format!("--defaults-file={}", root.join("mysql/my.ini").display());
spawn(root, "mysql", &root.join("mysql/bin/mysqld.exe"), &[&ini, "--no-monitor"], &root.join("mysql"), &root.join("mysql/logs/startup.log"), &cfg.env_remove)?;
wait_ready(root, "mysql", cfg.mysql_port, 300)?;
mysql(root, None, Some("ping"))?;
mysql(
root,
Some(&format!(
"UPDATE acore_auth.realmlist SET name={},address='127.0.0.1',localAddress='127.0.0.1',port={} WHERE id={};",
crate::realm_names::sql_literal(&cfg.realm.name), cfg.world_port, cfg.realm.id
)),
None,
)?;
Ok(())
}
pub fn start_auth(root: &Path, cfg: &Settings, progress: Progress) -> Result<()> {
start_mysql(root, cfg, progress)?;
if state::running(root, "auth").is_some() {
wait_ready(root, "auth", cfg.auth_port, 60)?;
progress("Authserver is already running.");
return Ok(());
}
ensure_free(cfg.auth_port, progress)?;
// An interrupted world startup can leave flag 3, which authserver excludes.
mysql(root, Some(&format!("UPDATE acore_auth.realmlist SET flag=0 WHERE id={};", cfg.realm.id)), None)?;
progress("Starting authserver...");
spawn(root, "auth", &root.join("Core/authserver.exe"), &["-c", "configs/authserver.conf"], &root.join("Core"), &root.join("Core/Logs/auth-console.log"), &cfg.env_remove)?;
wait_ready(root, "auth", cfg.auth_port, 60)
}
/// Stop the recorded process, only if it is still that process.
pub fn terminate(record: &ProcessIdentity) -> Result<()> {
if !crate::process::is_alive(record) {
return Ok(());
}
sys::terminate(record)
}
pub fn wait_stopped(record: &ProcessIdentity, seconds: u64) -> bool {
let until = Instant::now() + Duration::from_secs(seconds);
while crate::process::is_alive(record) && Instant::now() < until {
std::thread::sleep(Duration::from_millis(250));
}
!crate::process::is_alive(record)
}
/// The recorded world, when it is this folder's own `Core/worldserver.exe` (never stop a process only because a
/// record names it).
fn owned_world(root: &Path) -> Result<Option<ProcessIdentity>> {
let Some(world) = state::running(root, "world") else { return Ok(None) };
let expected = root.join("Core/worldserver.exe");
let same = std::fs::canonicalize(&world.exe).ok().zip(std::fs::canonicalize(&expected).ok()).is_some_and(|(a, b)| a == b);
if !same {
return Err(Error::Invalid("World process ownership could not be verified; the database was left running.".into()));
}
Ok(Some(world))
}
/// Ask the world's console for a graceful shutdown. False when the console is not this world's or does not answer.
fn ask_shutdown(root: &Path, cfg: &Settings) -> bool {
ready(root, "world", cfg.ra_port)
&& crate::ra::Ra::connect_to(cfg.ra_port, &cfg.ra_username, &cfg.ra_password)
.and_then(|ra| ra.send_without_answer("server shutdown 1s 0"))
.is_ok()
}
/// Stop this folder's world without its console (unsaved progress since the last save is lost).
fn stop_world_process(world: &ProcessIdentity) -> Result<()> {
terminate(world).map_err(|_| Error::Invalid("Worldserver could not be stopped safely; its database was left running.".into()))?;
if !wait_stopped(world, 90) {
return Err(Error::Invalid("Worldserver is still stopping; its database was left running.".into()));
}
Ok(())
}
/// Stop the world at once, then everything else as [`stop_all`] does. Only when the user asked for it.
pub fn force_stop_all(root: &Path, cfg: &Settings, progress: Progress) -> Result<()> {
if let Some(world) = owned_world(root)? {
stop_world_process(&world)?;
progress("Force-stopped this server's verified world process; unsaved progress may be lost.");
}
stop_all(root, cfg, progress)
}
/// Stop everything of this repack, world first (gracefully through its console), its database last. An extra
/// world leaves the shared database alone.
pub fn stop_all(root: &Path, cfg: &Settings, progress: Progress) -> Result<()> {
if let Some(world) = owned_world(root)? {
if ask_shutdown(root, cfg) {
progress("Graceful world shutdown requested.");
} else {
progress("World console unavailable; stopping this repack's recorded world process.");
stop_world_process(&world)?;
}
// A console request can be lost (seen when a client disconnected at once). While the world still runs
// and its console still answers, it has not begun to stop: ask again. Asking twice is harmless.
let mut stopped = wait_stopped(&world, 15);
for _ in 0..2 {
if stopped {
break;
}
if ask_shutdown(root, cfg) {
progress("The world has not begun to stop; shutdown requested again.");
}
stopped = wait_stopped(&world, 15);
}
if !stopped && !wait_stopped(&world, 45) {
return Err(Error::Invalid("Worldserver is still stopping; its database has been left running.".into()));
}
}
if let Some(supervisor) = state::running(root, "supervisor") {
if !wait_stopped(&supervisor, 45) {
return Err(Error::Invalid("The report relay is still finishing a request. Try Stop All again shortly.".into()));
}
}
if let Some(relay) = state::running(root, "relay") {
std::fs::write(state::dir(root).join("stop-relay"), b"")?;
if !wait_stopped(&relay, 40) {
return Err(Error::Invalid("The report relay did not finish; it was left running for recovery.".into()));
}
}
if let Some(auth) = state::running(root, "auth") {
terminate(&auth)?;
if !wait_stopped(&auth, 10) {
return Err(Error::Invalid("Authserver did not stop.".into()));
}
}
if let Some(database) = state::running(root, "mysql").filter(|_| !cfg.shared_database) {
let shutdown = mysql(root, None, Some("shutdown"));
if !wait_stopped(&database, 60) {
shutdown?;
return Err(Error::Invalid("MySQL is still stopping; wait before copying the repack.".into()));
}
}
progress("All services from this repack are stopped. It is safe to move or copy this folder.");
Ok(())
}
/// Which services run (`manage.py status-json`).
pub fn status(root: &Path) -> serde_json::Value {
let mut out = serde_json::Map::new();
for name in ["mysql", "auth", "world", "relay"] {
out.insert(name.into(), state::running(root, name).is_some().into());
}
let debug: bool = crate::fsx::read_json::<serde_json::Value>(&state::dir(root).join("debug-logs.json"))
.ok()
.and_then(|v| v.get("enabled").and_then(|e| e.as_bool()))
.unwrap_or(false);
out.insert("debugLogs".into(), debug.into());
serde_json::Value::Object(out)
}
pub fn log_path(root: &Path, name: &str) -> PathBuf {
match name {
"mysql" => root.join("mysql/logs/startup.log"),
"auth" => root.join("Core/Logs/auth-console.log"),
"world" => root.join("Core/Logs/world-console.log"),
"supervisor" => root.join("Core/Logs/supervisor.log"),
_ => root.join("BugReport/Logs/relay.log"),
}
}
// ---------------------------------------------------------------------------------------------------------------
// Windows
// ---------------------------------------------------------------------------------------------------------------
#[cfg(windows)]
mod sys {
use crate::error::{Error, Result};
use crate::process::ProcessIdentity;
use windows_sys::Win32::Foundation::CloseHandle;
use windows_sys::Win32::NetworkManagement::IpHelper::GetExtendedTcpTable;
use windows_sys::Win32::Networking::WinSock::{setsockopt, SOL_SOCKET, SO_EXCLUSIVEADDRUSE};
use windows_sys::Win32::System::Threading::{OpenProcess, TerminateProcess, PROCESS_QUERY_LIMITED_INFORMATION, PROCESS_TERMINATE};
pub const LISTEN: u32 = 2;
pub const ESTABLISHED: u32 = 5;
pub struct TcpRow {
pub state: u32,
pub local_port: u16,
pub remote_port: u16,
pub remote_loopback: bool,
pub pid: u32,
}
fn table(af: u32) -> Vec<u8> {
const TCP_TABLE_OWNER_PID_ALL: i32 = 5;
let mut size = 0u32;
let mut buf: Vec<u8> = Vec::new();
for _ in 0..4 {
let code = unsafe {
GetExtendedTcpTable(
if buf.is_empty() { std::ptr::null_mut() } else { buf.as_mut_ptr().cast() },
&mut size,
0,
af,
TCP_TABLE_OWNER_PID_ALL,
0,
)
};
match code {
0 if !buf.is_empty() => return buf,
0 | 122 => buf = vec![0u8; size as usize + 4096],
_ => return Vec::new(),
}
}
Vec::new()
}
fn u32_at(b: &[u8], o: usize) -> u32 {
u32::from_le_bytes(b[o..o + 4].try_into().unwrap())
}
pub fn tcp_rows_v4() -> Vec<TcpRow> {
let b = table(2);
let mut out = Vec::new();
if b.len() < 4 {
return out;
}
for i in 0..u32_at(&b, 0) as usize {
let o = 4 + 24 * i;
if o + 24 > b.len() {
break;
}
let remote = u32_at(&b, o + 12).to_le_bytes();
out.push(TcpRow {
state: u32_at(&b, o),
local_port: u16::from_be((u32_at(&b, o + 8) & 0xFFFF) as u16),
remote_port: u16::from_be((u32_at(&b, o + 16) & 0xFFFF) as u16),
remote_loopback: remote == [127, 0, 0, 1],
pid: u32_at(&b, o + 20),
});
}
out
}
pub fn tcp_rows_v6() -> Vec<TcpRow> {
let b = table(23);
let mut out = Vec::new();
if b.len() < 4 {
return out;
}
// MIB_TCP6ROW_OWNER_PID: local addr 16, scope 4, local port 4, remote addr 16, scope 4, remote port 4, state 4, pid 4
for i in 0..u32_at(&b, 0) as usize {
let o = 4 + 56 * i;
if o + 56 > b.len() {
break;
}
let remote = &b[o + 24..o + 40];
let mapped_loopback = remote[..10].iter().all(|x| *x == 0) && remote[10] == 0xff && remote[11] == 0xff && remote[12..] == [127, 0, 0, 1];
out.push(TcpRow {
state: u32_at(&b, o + 48),
local_port: u16::from_be((u32_at(&b, o + 20) & 0xFFFF) as u16),
remote_port: u16::from_be((u32_at(&b, o + 44) & 0xFFFF) as u16),
remote_loopback: mapped_loopback,
pid: u32_at(&b, o + 52),
});
}
out
}
/// Bind 0.0.0.0:port exclusively and release it. Err carries the Windows socket error.
/// Windows' excluded TCP port ranges, read with the system's own netsh (never one from PATH or the server).
pub fn excluded_ranges() -> Vec<(u16, u16)> {
use std::os::windows::process::CommandExt;
let mut directory = vec![0u16; 32768];
let length = unsafe {
windows_sys::Win32::System::SystemInformation::GetSystemDirectoryW(directory.as_mut_ptr(), directory.len() as u32)
} as usize;
if length == 0 || length >= directory.len() {
return Vec::new();
}
let netsh = std::path::PathBuf::from(String::from_utf16_lossy(&directory[..length])).join("netsh.exe");
let output = std::process::Command::new(netsh)
.args(["interface", "ipv4", "show", "excludedportrange", "protocol=tcp"])
.stdin(std::process::Stdio::null())
.stderr(std::process::Stdio::null())
.creation_flags(super::CREATE_NO_WINDOW)
.output();
match output {
Ok(out) if out.status.success() => super::parse_excluded_ranges(&String::from_utf8_lossy(&out.stdout)),
_ => Vec::new(),
}
}
pub fn exclusive_bind(port: u16) -> std::result::Result<(), i32> {
use socket2::{Domain, Socket, Type};
use std::os::windows::io::AsRawSocket;
let socket = Socket::new(Domain::IPV4, Type::STREAM, None).map_err(|e| e.raw_os_error().unwrap_or(-1))?;
let one: i32 = 1;
let set = unsafe {
setsockopt(socket.as_raw_socket() as _, SOL_SOCKET, SO_EXCLUSIVEADDRUSE, (&one as *const i32).cast(), 4)
};
if set != 0 {
return Err(std::io::Error::last_os_error().raw_os_error().unwrap_or(-1));
}
let addr: std::net::SocketAddr = ([0, 0, 0, 0], port).into();
socket.bind(&addr.into()).map_err(|e| e.raw_os_error().unwrap_or(-1))
}
pub fn terminate(record: &ProcessIdentity) -> Result<()> {
unsafe {
let h = OpenProcess(PROCESS_TERMINATE | PROCESS_QUERY_LIMITED_INFORMATION, 0, record.pid);
if h.is_null() {
return Err(Error::Invalid("Unable to stop the repack process.".into()));
}
let same = crate::process::is_alive(record);
let ok = same && TerminateProcess(h, 0) != 0;
CloseHandle(h);
if !ok {
return Err(Error::Invalid("The process changed while stopping it.".into()));
}
}
Ok(())
}
}
#[cfg(not(windows))]
mod sys {
use crate::error::{Error, Result};
use crate::process::ProcessIdentity;
pub const LISTEN: u32 = 2;
pub const ESTABLISHED: u32 = 5;
pub struct TcpRow {
pub state: u32,
pub local_port: u16,
pub remote_port: u16,
pub remote_loopback: bool,
pub pid: u32,
}
pub fn tcp_rows_v4() -> Vec<TcpRow> {
Vec::new()
}
pub fn tcp_rows_v6() -> Vec<TcpRow> {
Vec::new()
}
pub fn exclusive_bind(_: u16) -> std::result::Result<(), i32> {
Ok(())
}
pub fn excluded_ranges() -> Vec<(u16, u16)> {
Vec::new()
}
pub fn terminate(_: &ProcessIdentity) -> Result<()> {
Err(Error::Invalid("not supported".into()))
}
}
#[cfg(test)]
mod tests {
use super::*;
#[test]
fn excluded_ranges_are_read_from_translated_netsh_output() {
let english = "\r\nProtocol tcp Port Exclusion Ranges\r\n\r\nStart Port End Port\r\n---------- --------\r\n 3250 3349\r\n 50000 50059 *\r\n\r\n* - Administered port exclusions.\r\n";
assert_eq!(parse_excluded_ranges(english), vec![(3250, 3349), (50000, 50059)]);
let russian = "\r\nПротокол tcp Диапазоны исключения портов\r\n\r\nНачальный порт Конечный порт\r\n---------- --------\r\n 50000 50059 *\r\n\r\n* — управляемые исключения портов.\r\n";
assert_eq!(parse_excluded_ranges(russian), vec![(50000, 50059)]);
assert!(parse_excluded_ranges("").is_empty());
}
fn repack(dir: &Path, mysql: u16) {
std::fs::create_dir_all(dir.join("Settings")).unwrap();
std::fs::write(
dir.join("Settings/repack.json"),
format!(r#"{{"mysqlPort":{mysql},"authPort":3724,"worldPort":8085,"raPort":3443,"raUsername":"U","raPassword":"P"}}"#),
)
.unwrap();
}
#[test]
fn a_taken_database_port_moves_to_a_free_one_and_is_recorded() {
let d = tempfile::tempdir().unwrap();
let held = std::net::TcpListener::bind("0.0.0.0:0").unwrap();
let port = held.local_addr().unwrap().port();
repack(d.path(), port);
let cfg = Settings::load(d.path(), 0).unwrap();
let said = std::cell::RefCell::new(Vec::new());
let moved = relocate_database_port(d.path(), &cfg, 0, &|line| said.borrow_mut().push(line.to_string()))
.unwrap()
.expect("moved");
assert_ne!(moved, port);
let again = Settings::load(d.path(), 0).unwrap();
assert_eq!(again.mysql_port, moved);
assert_eq!((again.auth_port, again.ra_username.as_str()), (3724, "U"), "other keys are kept");
assert!(said.borrow().iter().any(|l| l.contains("used by another program")), "{said:?}");
// The new port is usable: nothing moves on the next start.
assert_eq!(relocate_database_port(d.path(), &again, 0, &|_| {}).unwrap(), None);
}
#[test]
fn extra_worlds_and_shifted_test_ports_never_move_the_database() {
let d = tempfile::tempdir().unwrap();
let held = std::net::TcpListener::bind("0.0.0.0:0").unwrap();
let port = held.local_addr().unwrap().port();
repack(d.path(), port);
let cfg = Settings::load(d.path(), 0).unwrap();
let shared = Settings { shared_database: true, ..cfg.clone() };
assert_eq!(relocate_database_port(d.path(), &shared, 0, &|_| {}).unwrap(), None);
assert_eq!(relocate_database_port(d.path(), &cfg, 5, &|_| {}).unwrap(), None);
assert_eq!(Settings::load(d.path(), 0).unwrap().mysql_port, port);
}
#[test]
fn a_port_with_a_listener_is_refused_and_a_free_one_passes() {
let held = std::net::TcpListener::bind("0.0.0.0:0").unwrap();
let port = held.local_addr().unwrap().port();
let err = ensure_free(port, &|_| {}).unwrap_err().to_string();
assert!(err.contains(&format!("Port {port} is already used (PID {}", std::process::id())), "{err}");
drop(held);
ensure_free(port, &|_| {}).unwrap();
}
#[test]
fn a_service_is_ready_only_on_its_own_port() {
let d = tempfile::tempdir().unwrap();
let held = std::net::TcpListener::bind("127.0.0.1:0").unwrap();
let port = held.local_addr().unwrap().port();
assert!(!ready(d.path(), "auth", port), "no record yet");
state::record(d.path(), "auth", std::process::id()).unwrap();
assert!(ready(d.path(), "auth", port));
// A port nobody listens on now (port + 1 may belong to a test running in parallel in this process).
let other = std::net::TcpListener::bind("127.0.0.1:0").unwrap();
let free = other.local_addr().unwrap().port();
drop(other);
assert!(!ready(d.path(), "auth", free));
}
#[test]
fn status_reads_the_records() {
let d = tempfile::tempdir().unwrap();
state::record(d.path(), "mysql", std::process::id()).unwrap();
let s = status(d.path());
assert_eq!(s["mysql"], true);
assert_eq!(s["world"], false);
assert_eq!(s["debugLogs"], false);
}
}
+172
View File
@@ -0,0 +1,172 @@
//! `Settings/repack.json`: ports and the console login of one repack (`manage.py settings()`).
use std::path::Path;
use crate::error::{Error, Result};
pub const PORT_KEYS: [&str; 4] = ["mysqlPort", "authPort", "worldPort", "raPort"];
/// The realm a folder runs: its row in `acore_auth.realmlist` and its two game databases.
///
/// Without `Settings/realm-profile.json` this is what the repack launcher always did (realm 1 "AzerothCore" on
/// `acore_world`/`acore_characters`). With it, the active profile decides, as the Manager's realm patch of
/// `manage.py` did.
#[derive(Debug, Clone, PartialEq, Eq)]
pub struct Realm {
pub id: u32,
pub name: String,
pub world_db: &'static str,
pub characters_db: &'static str,
}
impl Realm {
pub fn load(root: &Path) -> Result<Realm> {
let path = root.join("Settings/realm-profile.json");
let (id, name, world_db, characters_db) = if !path.exists() {
(1, "AzerothCore", "acore_world", "acore_characters")
} else {
let v: serde_json::Value = crate::fsx::read_json(&path)?;
match v.get("active").and_then(|a| a.as_str()).unwrap_or("coa") {
"wildcard" => (2, "Wildcard", "acore_world_wildcard", "acore_characters_wildcard"),
"reborn" => (3, "Warcraft Reborn", "acore_world_reborn", "acore_characters_reborn"),
_ => (1, "Conquest of Azeroth", "acore_world", "acore_characters"),
}
};
// The owner's own name for this realm, when one was chosen in the Manager.
let name = crate::realm_names::name_or(root, id, name);
Ok(Realm { id, name, world_db, characters_db })
}
}
/// An extra world of a server (`<server>/.realms/<name>`): it shares the main folder's database and never
/// starts or stops it.
pub fn is_extra_world(root: &Path) -> bool {
root.parent().and_then(|p| p.file_name()).is_some_and(|n| n == ".realms")
}
#[derive(Debug, Clone, PartialEq, Eq)]
pub struct Settings {
pub mysql_port: u16,
pub auth_port: u16,
pub world_port: u16,
pub ra_port: u16,
pub ra_username: String,
pub ra_password: String,
pub realm: Realm,
/// The database belongs to the main folder of this server (an extra world): it is only checked, never
/// started.
pub shared_database: bool,
/// Environment variables the started services must not see (for example a port override of the caller).
pub env_remove: Vec<String>,
/// The whole document, for keys this code does not know (kept when it is written back).
pub raw: serde_json::Map<String, serde_json::Value>,
}
impl Settings {
/// Read `Settings/repack.json`, with every port moved by `offset` (a second world of the same server runs on
/// shifted ports). The same checks as `manage.py`: integer ports in 1025..65535 after the offset, all
/// different.
pub fn load(root: &Path, offset: i32) -> Result<Settings> {
let bytes = std::fs::read(root.join("Settings/repack.json"))?;
let text = String::from_utf8_lossy(&bytes);
let text = text.strip_prefix('\u{feff}').unwrap_or(&text);
let raw: serde_json::Map<String, serde_json::Value> =
serde_json::from_str(text).map_err(|e| Error::Invalid(format!("Settings/repack.json: {e}")))?;
let mut ports = [0u16; 4];
for (i, key) in PORT_KEYS.iter().enumerate() {
// Python's `type(value) is not int` refuses booleans and floats alike.
let value = raw.get(*key).and_then(|v| v.as_i64()).filter(|_| raw[*key].is_i64() || raw[*key].is_u64());
let shifted = value.map(|v| v + i64::from(offset));
match shifted {
Some(p) if p > 1024 && p < 65536 => ports[i] = p as u16,
_ => return Err(Error::Service(crate::error::ErrorCode::InvalidConfigValue, "Invalid port in Settings/repack.json".into())),
}
}
let mut unique = ports.to_vec();
unique.sort_unstable();
unique.dedup();
if unique.len() != 4 {
return Err(Error::Invalid("Each service needs a different port.".into()));
}
let text_of = |k: &str| raw.get(k).and_then(|v| v.as_str()).unwrap_or_default().to_string();
Ok(Settings {
mysql_port: ports[0],
auth_port: ports[1],
world_port: ports[2],
ra_port: ports[3],
ra_username: text_of("raUsername"),
ra_password: text_of("raPassword"),
realm: Realm::load(root)?,
shared_database: is_extra_world(root),
env_remove: Vec::new(),
raw,
})
}
/// `{"mysqlPort": .., "authPort": .., "worldPort": .., "raPort": ..}` as `manage.py` records it in
/// `.state/configuration.json` (the keys of repack.json ending in "Port", in the file's order).
pub fn port_map(&self) -> serde_json::Map<String, serde_json::Value> {
let shifted = [self.mysql_port, self.auth_port, self.world_port, self.ra_port];
let mut out = serde_json::Map::new();
for key in self.raw.keys().filter(|k| k.ends_with("Port")) {
let value = PORT_KEYS
.iter()
.position(|p| p == key)
.map(|i| serde_json::Value::from(shifted[i]))
.unwrap_or_else(|| self.raw[key].clone());
out.insert(key.clone(), value);
}
out
}
}
#[cfg(test)]
mod tests {
use super::*;
fn write(dir: &Path, text: &str) {
std::fs::create_dir_all(dir.join("Settings")).unwrap();
std::fs::write(dir.join("Settings/repack.json"), text).unwrap();
}
#[test]
fn ports_are_checked_like_the_python_launcher() {
let d = tempfile::tempdir().unwrap();
write(d.path(), r#"{"mysqlPort":3307,"authPort":3724,"worldPort":8085,"raPort":3443,"raUsername":"U","raPassword":"P"}"#);
let s = Settings::load(d.path(), 0).unwrap();
assert_eq!((s.mysql_port, s.auth_port, s.world_port, s.ra_port), (3307, 3724, 8085, 3443));
assert_eq!(s.ra_username, "U");
let shifted = Settings::load(d.path(), 10).unwrap();
assert_eq!(shifted.world_port, 8095);
assert_eq!(shifted.port_map()["worldPort"], serde_json::json!(8095));
for bad in [
r#"{"mysqlPort":1024,"authPort":3724,"worldPort":8085,"raPort":3443}"#,
r#"{"mysqlPort":"3307","authPort":3724,"worldPort":8085,"raPort":3443}"#,
r#"{"mysqlPort":3307.0,"authPort":3724,"worldPort":8085,"raPort":3443}"#,
r#"{"mysqlPort":true,"authPort":3724,"worldPort":8085,"raPort":3443}"#,
r#"{"mysqlPort":3307,"authPort":3307,"worldPort":8085,"raPort":3443}"#,
r#"{"authPort":3724,"worldPort":8085,"raPort":3443}"#,
] {
write(d.path(), bad);
assert!(Settings::load(d.path(), 0).is_err(), "{bad}");
}
write(d.path(), "\u{feff}{\"mysqlPort\":3307,\"authPort\":3724,\"worldPort\":8085,\"raPort\":65535}");
assert!(Settings::load(d.path(), 1).is_err(), "65536 after the offset");
assert!(Settings::load(d.path(), 0).is_ok(), "a byte order mark is accepted");
}
#[test]
fn the_realm_follows_the_active_profile() {
let d = tempfile::tempdir().unwrap();
assert_eq!(Realm::load(d.path()).unwrap().name, "AzerothCore");
std::fs::create_dir_all(d.path().join("Settings")).unwrap();
for (active, id, db) in [("coa", 1, "acore_world"), ("wildcard", 2, "acore_world_wildcard"), ("reborn", 3, "acore_world_reborn")] {
std::fs::write(d.path().join("Settings/realm-profile.json"), format!("{{\"active\":\"{active}\"}}")).unwrap();
let r = Realm::load(d.path()).unwrap();
assert_eq!((r.id, r.world_db), (id, db));
}
assert!(is_extra_world(&d.path().join(".realms/secondary")));
assert!(!is_extra_world(d.path()));
}
}
Binary file not shown.
+398
View File
@@ -0,0 +1,398 @@
//! SQUID Playerbots on a repack (`Scripts/squid_playerbots.py`): the bot modules must not both run, how long a
//! SQUID world may take to start, and its database, provisioned before the world starts.
//!
//! The SQL journals are the ones the Python script keeps, unchanged: `coa_squid_migrations(path, sha256)` and
//! `coa_squid_pending(path, sha256)` in every target schema, and the SQUID installer's `coa_bots_installed`.
use std::collections::{BTreeMap, BTreeSet};
use std::path::{Path, PathBuf};
use sha1::Digest as _;
use crate::error::{Error, Result};
/// `key = value` lines of a module config (comments and quotes dropped), as `options()` reads them.
pub fn options(path: &Path) -> BTreeMap<String, String> {
let mut out = BTreeMap::new();
let Ok(bytes) = std::fs::read(path) else { return out };
let text = String::from_utf8_lossy(&bytes);
let text = text.strip_prefix('\u{feff}').unwrap_or(&text);
for line in text.lines() {
let line = line.trim_start();
let Some((key, rest)) = line.split_once('=') else { continue };
let key = key.trim_end();
if key.is_empty() || key.starts_with('#') || key.contains(char::is_whitespace) {
continue;
}
let value = rest.split('#').next().unwrap_or("").trim();
out.insert(key.to_string(), value.trim_matches('"').to_string());
}
out
}
/// A secondary world shares the primary's package files.
pub fn package_root(root: &Path) -> PathBuf {
let secondary = root.file_name().is_some_and(|n| n == "secondary")
&& root.parent().and_then(|p| p.file_name()).is_some_and(|n| n == ".realms");
if secondary {
root.parent().and_then(Path::parent).map(Path::to_path_buf).unwrap_or_else(|| root.to_path_buf())
} else {
root.to_path_buf()
}
}
pub fn module_options(root: &Path, name: &str) -> (PathBuf, BTreeMap<String, String>) {
let folder = root.join("Core/configs/modules");
let active = folder.join(name);
let mut path = if active.exists() { active } else { folder.join(format!("{name}.dist")) };
if !path.exists() && name == "playerbots.conf" {
path = package_root(root).join("Core/configs/modules/playerbots.conf.dist");
}
let values = options(&path);
(path, values)
}
/// Invalid booleans count as the modules' compiled default: enabled.
pub fn enabled(values: &BTreeMap<String, String>, key: &str) -> bool {
!matches!(values.get(key).map(|v| v.to_ascii_lowercase()).as_deref(), Some("0" | "false" | "no" | "off"))
}
pub fn validate_bots(root: &Path) -> Result<()> {
let (a, av) = module_options(root, "mod_coa_playerbots.conf");
let (b, bv) = module_options(root, "playerbots.conf");
if a.exists() && b.exists() && enabled(&av, "CoaBots.Enable") && enabled(&bv, "AiPlayerbot.Enabled") {
return Err(Error::Invalid(
"CoA Companions and SQUID Playerbots cannot both be enabled. Disable one bot module in Modules or its config.".into(),
));
}
Ok(())
}
/// Seconds a world may take to open its port: SQUID loads its bots first.
pub fn startup_timeout(root: &Path) -> u64 {
let (path, values) = module_options(root, "playerbots.conf");
if path.exists() && enabled(&values, "AiPlayerbot.Enabled") {
1500
} else {
180
}
}
/// Replace (or append) `key = value` lines; the file is written with "\n" line ends.
pub fn set_options(path: &Path, values: &[(&str, String)]) -> Result<()> {
let bytes = std::fs::read(path)?;
let text = String::from_utf8_lossy(&bytes);
let mut text = text.strip_prefix('\u{feff}').unwrap_or(&text).replace("\r\n", "\n");
for (key, value) in values {
let line = format!("{key} = {value}");
let mut found = false;
let lines: Vec<String> = text
.split('\n')
.map(|l| {
let t = l.trim_start();
let matches = t.strip_prefix(key).is_some_and(|rest| rest.trim_start().starts_with('='));
if matches {
found = true;
line.clone()
} else {
l.to_string()
}
})
.collect();
text = lines.join("\n");
if !found {
text.push('\n');
text.push_str(&line);
text.push('\n');
}
}
crate::fsx::atomic_write(path, text.as_bytes())
}
fn valid_relative(rel: &str) -> bool {
!rel.is_empty() && rel.bytes().all(|b| b.is_ascii_alphanumeric() || matches!(b, b'_' | b'.' | b'/' | b'-'))
}
/// Table names a base file creates (`CREATE TABLE [IF NOT EXISTS] name`).
fn created_tables(sql: &str) -> BTreeSet<String> {
let mut out = BTreeSet::new();
let upper = sql.to_ascii_uppercase();
let mut from = 0;
while let Some(i) = upper[from..].find("CREATE") {
let start = from + i + "CREATE".len();
from = start;
let rest = &sql[start..];
let mut words = rest.split_whitespace();
if !words.next().is_some_and(|w| w.eq_ignore_ascii_case("TABLE")) {
continue;
}
let mut name = words.next().unwrap_or("");
if name.eq_ignore_ascii_case("IF") {
let _ = words.next(); // NOT
let _ = words.next(); // EXISTS
name = words.next().unwrap_or("");
}
let name: String = name.trim_start_matches('`').chars().take_while(|c| c.is_ascii_alphanumeric() || *c == '_').collect();
if !name.is_empty() {
out.insert(name);
}
}
out
}
fn sha256_hex(bytes: &[u8]) -> String {
crate::fsx::sha256_bytes(bytes)
}
fn sha1_hex(bytes: &[u8]) -> String {
let mut h = sha1::Sha1::new();
h.update(bytes);
h.finalize().iter().map(|b| format!("{b:02x}")).collect()
}
fn rows(text: &str) -> Vec<(String, String)> {
text.lines().filter_map(|r| r.split_once('\t')).map(|(a, b)| (a.to_string(), b.to_string())).collect()
}
/// Provision an enabled SQUID without replaying imported base tables (`prepare_playerbots`). `mysql(sql)` runs
/// SQL with the repack's administrator login and returns its output.
pub fn prepare_playerbots(root: &Path, mysql_port: u16, mysql: &dyn Fn(&str) -> Result<String>, progress: &dyn Fn(&str)) -> Result<()> {
let (mut path, values) = module_options(root, "playerbots.conf");
if !path.exists() || !enabled(&values, "AiPlayerbot.Enabled") {
return Ok(());
}
validate_bots(root)?;
let sql_root = package_root(root).join("Extras/SquidPlayerbots/sql");
if !sql_root.join("playerbots/base").is_dir() {
return Err(Error::Invalid("SQUID Playerbots database files are missing. Repair the server installation.".into()));
}
let world = options(&root.join("Core/configs/worldserver.conf"));
let mut schemas: Vec<(&str, String)> = Vec::new();
for (kind, key) in [("characters", "CharacterDatabaseInfo"), ("world", "WorldDatabaseInfo")] {
let schema = world.get(key).and_then(|v| v.rsplit(';').next()).unwrap_or("").to_string();
let ok = matches!(schema.as_str(), "acore_world" | "acore_characters" | "acore_world_wildcard" | "acore_characters_wildcard");
if !ok {
return Err(Error::Invalid("Unsupported world/characters database for SQUID Playerbots.".into()));
}
schemas.push((kind, schema));
}
schemas.push(("playerbots", "acore_playerbots".into()));
let list = |schema: &str| -> Result<BTreeSet<String>> {
Ok(mysql(&format!("SELECT TABLE_NAME FROM information_schema.TABLES WHERE TABLE_SCHEMA='{schema}';"))?
.lines()
.map(str::to_string)
.collect())
};
let existing_playerbots = list("acore_playerbots")?;
let bookkeeping = ["updates", "updates_include", "version_db_playerbots", "coa_squid_migrations", "coa_bots_installed", "coa_squid_pending"];
let data_tables: Vec<&String> = existing_playerbots.iter().filter(|t| !bookkeeping.contains(&t.as_str())).collect();
let mut installer_history = BTreeSet::new();
if existing_playerbots.contains("coa_bots_installed") {
for name in mysql("SELECT file FROM `acore_playerbots`.coa_bots_installed;")?.lines() {
let mut n = name.replace('\\', "/");
while n.contains("//") {
n = n.replace("//", "/");
}
let n = n.trim_matches('/').to_string();
if n.to_ascii_lowercase().ends_with(".sql") {
installer_history.insert(n);
}
}
}
let mut tables: BTreeMap<&str, BTreeSet<String>> = BTreeMap::new();
let mut histories: BTreeMap<&str, BTreeMap<String, String>> = BTreeMap::new();
let mut ledgers: BTreeMap<&str, BTreeMap<String, String>> = BTreeMap::new();
for (kind, schema) in &schemas {
let t = if *kind == "playerbots" { existing_playerbots.clone() } else { list(schema)? };
if t.contains("coa_squid_pending") {
let pending = mysql(&format!("SELECT path FROM `{schema}`.coa_squid_pending;"))?;
let pending = pending.trim();
if !pending.is_empty() {
return Err(Error::Invalid(format!(
"A SQUID base import was interrupted. Restore the database backup or repair the incomplete import before continuing; no SQL was applied: {pending}"
)));
}
}
let mut history = BTreeMap::new();
if t.contains("updates") {
for (name, digest) in rows(&mysql(&format!("SELECT name,hash FROM `{schema}`.updates;"))?) {
history.insert(name, digest.to_ascii_lowercase());
}
}
let mut ledger = BTreeMap::new();
if t.contains("coa_squid_migrations") {
for (name, digest) in rows(&mysql(&format!("SELECT path,sha256 FROM `{schema}`.coa_squid_migrations;"))?) {
ledger.insert(name, digest);
}
}
tables.insert(kind, t);
histories.insert(kind, history);
ledgers.insert(kind, ledger);
}
if !data_tables.is_empty() && installer_history.is_empty() && histories["playerbots"].is_empty() && ledgers["playerbots"].is_empty() {
for table in data_tables {
let quoted = table.replace('`', "``");
if mysql(&format!("SELECT EXISTS(SELECT 1 FROM `acore_playerbots`.`{quoted}` LIMIT 1);"))?.trim() == "1" {
return Err(Error::Invalid(
"Existing SQUID data has no recorded installation history. Repair the imported database history before continuing; no SQL was applied.".into(),
));
}
}
}
mysql("CREATE DATABASE IF NOT EXISTS acore_playerbots CHARACTER SET utf8mb4 COLLATE utf8mb4_unicode_ci;")?;
for host in ["localhost", "127.0.0.1"] {
mysql(&format!("GRANT ALL PRIVILEGES ON acore_playerbots.* TO 'acore'@'{host}';"))?;
}
let (_, password) = crate::db::credentials(root)?;
if password.len() != 48 || !password.bytes().all(|b| b.is_ascii_digit() || (b'a'..=b'f').contains(&b)) {
return Err(Error::Invalid("Invalid packaged database configuration.".into()));
}
if path.file_name().is_some_and(|n| n.to_string_lossy().ends_with(".dist")) {
let active = root.join("Core/configs/modules/playerbots.conf");
std::fs::create_dir_all(active.parent().unwrap())?;
std::fs::write(&active, std::fs::read(&path)?)?;
path = active;
}
set_options(
&path,
&[
("PlayerbotsDatabaseInfo", format!("\"127.0.0.1;{mysql_port};acore;{password};acore_playerbots\"")),
("Playerbots.Updates.EnableDatabases", "0".into()),
],
)?;
for (kind, schema) in &schemas {
mysql(&format!("CREATE TABLE IF NOT EXISTS `{schema}`.coa_squid_migrations (path VARCHAR(240) PRIMARY KEY, sha256 CHAR(64) NOT NULL);"))?;
mysql(&format!("CREATE TABLE IF NOT EXISTS `{schema}`.coa_squid_pending (path VARCHAR(240) PRIMARY KEY, sha256 CHAR(64) NOT NULL);"))?;
let history = &histories[kind];
let recorded = ledgers[kind].clone();
for stage in ["base", "updates", "custom"] {
let mut sources: Vec<PathBuf> = std::fs::read_dir(sql_root.join(kind).join(stage))
.map(|rd| rd.flatten().map(|e| e.path()).filter(|p| p.extension().is_some_and(|e| e == "sql")).collect())
.unwrap_or_default();
sources.sort();
for source in sources {
let relative = source.strip_prefix(&sql_root).unwrap_or(&source).to_string_lossy().replace('\\', "/");
if !valid_relative(&relative) {
return Err(Error::Invalid("Invalid SQUID SQL filename.".into()));
}
let bytes = std::fs::read(&source)?;
let digest = sha256_hex(&bytes);
if let Some(previous) = recorded.get(&relative) {
if *previous != digest {
return Err(Error::Invalid(format!("A previously applied SQUID database migration changed: {relative}")));
}
if stage != "base" {
continue;
}
}
let ledger_sql = if recorded.contains_key(&relative) {
String::new()
} else {
format!("INSERT INTO `{schema}`.coa_squid_migrations VALUES ('{relative}','{digest}');")
};
let text = String::from_utf8_lossy(&bytes);
let text = text.strip_prefix('\u{feff}').unwrap_or(&text).to_string();
if stage == "base" {
let definitions = created_tables(&text);
let present: BTreeSet<String> = definitions.intersection(&tables[kind]).cloned().collect();
if !present.is_empty() && present != definitions {
return Err(Error::Invalid(format!("SQUID base file has only some of its tables. Repair the incomplete database before continuing: {relative}")));
}
if definitions.is_empty() {
return Err(Error::Invalid(format!("SQUID base file has no recognizable table definitions; repair is required: {relative}")));
}
if present == definitions {
if !ledger_sql.is_empty() {
mysql(&ledger_sql)?;
}
continue;
}
mysql(&format!("INSERT INTO `{schema}`.coa_squid_pending VALUES ('{relative}','{digest}'); COMMIT;"))?;
let complete = format!("DELETE FROM `{schema}`.coa_squid_pending WHERE path='{relative}' AND sha256='{digest}'; COMMIT;");
progress(&format!("Importing SQUID {relative} into {schema} ({} bytes); large imports may take several minutes...", bytes.len()));
mysql(&format!("USE `{schema}`;\n{text}\n{ledger_sql}\n{complete}")).map_err(|_| {
Error::Invalid(format!(
"SQUID import failed: {relative} in {schema}. The world server was not started. The incomplete import is recorded; restore a database backup or repair that import before retrying."
))
})?;
progress(&format!("Imported SQUID {relative}."));
if let Some(t) = tables.get_mut(kind) {
t.extend(definitions);
}
continue;
}
if installer_history.iter().any(|n| *n == relative || n.ends_with(&format!("/{relative}"))) {
mysql(&ledger_sql)?;
continue;
}
let file_name = source.file_name().unwrap_or_default().to_string_lossy().into_owned();
if let Some(upstream) = history.get(&file_name) {
let lf = String::from_utf8_lossy(&bytes).replace("\r\n", "\n");
let accepted = [sha1_hex(&bytes), sha1_hex(lf.as_bytes())];
if !upstream.is_empty() && !accepted.contains(upstream) {
return Err(Error::Invalid(format!("SQUID update history does not match the shipped SQL: {relative}")));
}
mysql(&ledger_sql)?;
continue;
}
mysql(&format!("USE `{schema}`;\n{text}\n{ledger_sql}"))?;
}
}
}
Ok(())
}
#[cfg(test)]
mod tests {
use super::*;
#[test]
fn config_lines_are_read_like_the_python_script() {
let d = tempfile::tempdir().unwrap();
let p = d.path().join("playerbots.conf");
std::fs::write(&p, "\u{feff}# comment = 1\nAiPlayerbot.Enabled = 0 # off\n Key.Two=\"quoted\"\nnot a line\nEmpty =\n").unwrap();
let o = options(&p);
assert_eq!(o.get("AiPlayerbot.Enabled").map(String::as_str), Some("0"));
assert_eq!(o.get("Key.Two").map(String::as_str), Some("quoted"));
assert_eq!(o.get("Empty").map(String::as_str), Some(""));
assert!(!o.contains_key("#"));
assert!(!enabled(&o, "AiPlayerbot.Enabled"));
assert!(enabled(&o, "Missing"));
}
#[test]
fn both_bot_modules_on_is_refused_and_squid_gets_a_long_startup() {
let d = tempfile::tempdir().unwrap();
let m = d.path().join("Core/configs/modules");
std::fs::create_dir_all(&m).unwrap();
std::fs::write(m.join("mod_coa_playerbots.conf"), "CoaBots.Enable = 1\n").unwrap();
std::fs::write(m.join("playerbots.conf.dist"), "AiPlayerbot.Enabled = 1\n").unwrap();
assert!(validate_bots(d.path()).is_err());
assert_eq!(startup_timeout(d.path()), 1500);
std::fs::write(m.join("playerbots.conf"), "AiPlayerbot.Enabled = 0\n").unwrap();
validate_bots(d.path()).unwrap();
assert_eq!(startup_timeout(d.path()), 180);
}
#[test]
fn options_are_replaced_or_appended() {
let d = tempfile::tempdir().unwrap();
let p = d.path().join("playerbots.conf");
std::fs::write(&p, "A = 1\r\n Playerbots.Updates.EnableDatabases = 1\r\n").unwrap();
set_options(&p, &[("Playerbots.Updates.EnableDatabases", "0".into()), ("PlayerbotsDatabaseInfo", "\"x\"".into())]).unwrap();
assert_eq!(std::fs::read_to_string(&p).unwrap(), "A = 1\nPlayerbots.Updates.EnableDatabases = 0\n\nPlayerbotsDatabaseInfo = \"x\"\n");
}
#[test]
fn base_tables_are_found() {
let t = created_tables("CREATE TABLE IF NOT EXISTS `ai_playerbot_names` (\n id int);\ncreate table playerbots_random_bots(x int);\n-- CREATE INDEX i ON t(x);");
assert_eq!(t, ["ai_playerbot_names".to_string(), "playerbots_random_bots".to_string()].into_iter().collect());
}
#[test]
fn a_secondary_world_uses_the_primary_package() {
assert_eq!(package_root(Path::new("C:/S/.realms/secondary")), Path::new("C:/S"));
assert_eq!(package_root(Path::new("C:/S")), Path::new("C:/S"));
}
}
+198
View File
@@ -0,0 +1,198 @@
//! `.state/`: which processes belong to this repack, and the one-action-at-a-time lock.
use std::fs::{File, OpenOptions};
use std::io::{Seek, SeekFrom, Write};
use std::path::{Path, PathBuf};
use std::time::{Duration, Instant};
use crate::error::{Error, Result};
use crate::fsx;
use crate::process::{self, ProcessIdentity};
pub fn dir(root: &Path) -> PathBuf {
root.join(".state")
}
/// Written like `manage.py atomic_json`: two-space JSON and a newline, now flushed to disk before it replaces
/// the old file.
pub fn write_json(path: &Path, value: &impl serde::Serialize) -> Result<()> {
let mut text = serde_json::to_string_pretty(value)?;
text.push('\n');
fsx::atomic_write(path, text.as_bytes())
}
/// The recorded process of `name` when it is still that process (same executable and start time). A missing,
/// empty or damaged record is no process: `manage.py` failed on those, and every later start with it.
pub fn running(root: &Path, name: &str) -> Option<ProcessIdentity> {
let record = process::read_state_record(root, name)?;
process::is_alive(&record).then_some(record)
}
/// Record the process `pid` as `name`. Fails when it has already exited.
pub fn record(root: &Path, name: &str, pid: u32) -> Result<ProcessIdentity> {
let identity = process::identity(pid)
.ok_or_else(|| Error::Invalid(format!("{name} exited during startup; check its log.")))?;
write_json(&dir(root).join(format!("{name}.json")), &identity)?;
Ok(identity)
}
/// Held while one start/stop action runs. Byte 0 of `.state/control.lock` is locked, exactly the region
/// `msvcrt.locking(fd, LK_NBLCK, 1)` locks in `manage.py`, so a Python launcher and this one exclude each other.
pub struct ControlLock {
file: File,
owner: PathBuf,
}
impl ControlLock {
/// Wait up to `wait` for the lock. `action` is recorded for whoever waits next ("start-all", ...).
pub fn acquire(root: &Path, action: &str, wait: Duration, progress: &dyn Fn(&str)) -> Result<ControlLock> {
let state = dir(root);
std::fs::create_dir_all(&state)?;
let mut file = OpenOptions::new().read(true).append(true).create(true).open(state.join("control.lock"))?;
if file.seek(SeekFrom::End(0))? == 0 {
file.write_all(b"0")?;
file.flush()?;
}
let owner = state.join("control-owner.json");
let deadline = Instant::now() + wait;
let mut announced = false;
loop {
if sys::try_lock(&file)? {
break;
}
let detail = match fsx::read_json::<serde_json::Value>(&owner) {
Ok(v) if v.get("pid").is_some() && v.get("action").is_some() => {
format!(" PID {}, action {}.", v["pid"], v["action"].as_str().unwrap_or(""))
}
_ => " Owner information is unavailable.".into(),
};
if Instant::now() >= deadline {
return Err(Error::Service(crate::error::ErrorCode::OperationInProgress, format!("Another start/stop action is in progress.{detail}")));
}
if !announced {
progress(&format!("Waiting for the current server action.{detail}"));
announced = true;
}
std::thread::sleep(Duration::from_millis(250));
}
let started = std::time::SystemTime::now()
.duration_since(std::time::UNIX_EPOCH)
.map(|d| d.as_secs_f64())
.unwrap_or(0.0);
let lock = ControlLock { file, owner };
write_json(
&lock.owner,
&serde_json::json!({ "pid": std::process::id(), "action": action, "started": started }),
)?;
Ok(lock)
}
}
/// Byte 0 of a file locked while held (`msvcrt.locking`), for example the bug-report relay's `relay.lock`.
pub struct FileLock {
file: File,
}
impl FileLock {
/// Take the lock, or `None` when another process (or handle) holds it.
pub fn try_acquire(path: &Path) -> Result<Option<FileLock>> {
let mut file = OpenOptions::new().read(true).append(true).create(true).open(path)?;
if file.seek(SeekFrom::End(0))? == 0 {
file.write_all(b"0")?;
file.flush()?;
}
Ok(sys::try_lock(&file)?.then_some(FileLock { file }))
}
}
impl Drop for FileLock {
fn drop(&mut self) {
sys::unlock(&self.file);
}
}
impl Drop for ControlLock {
fn drop(&mut self) {
let _ = std::fs::remove_file(&self.owner);
sys::unlock(&self.file);
}
}
#[cfg(windows)]
mod sys {
use std::fs::File;
use std::os::windows::io::AsRawHandle;
use windows_sys::Win32::Storage::FileSystem::{LockFile, UnlockFile};
/// `LockFile` on byte 0, length 1: the call `msvcrt.locking` makes. Non-blocking.
pub fn try_lock(file: &File) -> std::io::Result<bool> {
let ok = unsafe { LockFile(file.as_raw_handle() as _, 0, 0, 1, 0) };
if ok != 0 {
return Ok(true);
}
let err = std::io::Error::last_os_error();
// ERROR_LOCK_VIOLATION (33): someone else holds it.
if err.raw_os_error() == Some(33) {
Ok(false)
} else {
Err(err)
}
}
pub fn unlock(file: &File) {
unsafe {
UnlockFile(file.as_raw_handle() as _, 0, 0, 1, 0);
}
}
}
#[cfg(not(windows))]
mod sys {
use std::fs::File;
pub fn try_lock(_: &File) -> std::io::Result<bool> {
Ok(true)
}
pub fn unlock(_: &File) {}
}
#[cfg(test)]
mod tests {
use super::*;
#[test]
fn a_damaged_record_is_no_process() {
let d = tempfile::tempdir().unwrap();
std::fs::create_dir_all(dir(d.path())).unwrap();
std::fs::write(dir(d.path()).join("mysql.json"), [0u8; 116]).unwrap();
assert!(running(d.path(), "mysql").is_none());
std::fs::write(dir(d.path()).join("auth.json"), b"").unwrap();
assert!(running(d.path(), "auth").is_none());
}
#[test]
fn this_process_is_recorded_and_found_running() {
let d = tempfile::tempdir().unwrap();
let me = record(d.path(), "probe", std::process::id()).unwrap();
assert_eq!(running(d.path(), "probe"), Some(me));
let text = std::fs::read_to_string(dir(d.path()).join("probe.json")).unwrap();
assert!(text.starts_with("{\n \"pid\": ") && text.ends_with("}\n"), "{text}");
}
#[test]
fn one_action_at_a_time() {
let d = tempfile::tempdir().unwrap();
let first = ControlLock::acquire(d.path(), "start-all", Duration::from_secs(1), &|_| {}).unwrap();
let owner: serde_json::Value = fsx::read_json(&dir(d.path()).join("control-owner.json")).unwrap();
assert_eq!(owner["action"], "start-all");
let said = std::sync::Mutex::new(Vec::new());
let second = ControlLock::acquire(d.path(), "stop-all", Duration::from_millis(600), &|m| said.lock().unwrap().push(m.to_string()));
if cfg!(windows) {
let err = second.err().expect("the second action waits and gives up").to_string();
assert!(err.contains("Another start/stop action is in progress") && err.contains("start-all"), "{err}");
assert_eq!(said.lock().unwrap().len(), 1);
}
drop(first);
assert!(!dir(d.path()).join("control-owner.json").exists());
ControlLock::acquire(d.path(), "stop-all", Duration::from_secs(1), &|_| {}).unwrap();
}
}
+346
View File
@@ -0,0 +1,346 @@
//! The world server and the bug-report relay beside it (`manage.py start_world`, `watch_world`, `wait_relay`),
//! and the detailed-logging switch (`debug_logs`).
//!
//! A world is started through a supervisor process that outlives the caller: it starts `worldserver.exe`, keeps
//! the relay running while the world runs, and stops the relay when the world ends. The supervisor is
//! `coa-launcher.exe watch-world`, or `manage.py watch-world` on a repack that does not ship it yet (both write
//! the same records). The relay itself is still the Python `BugReport/relay.py`, run through the repack's
//! Python, until it is ported too.
use std::path::{Path, PathBuf};
use std::time::{Duration, Instant};
use crate::error::{Error, ErrorCode, Result};
use crate::launcher::services::{self, ensure_free, mysql, spawn, start_mysql, wait_ready, Progress};
use crate::launcher::spawn::Proc;
use crate::launcher::{schedule, settings::Settings, squid, state};
fn stop_relay_flag(root: &Path) -> std::path::PathBuf {
state::dir(root).join("stop-relay")
}
/// The relay is up and has finished starting (it records itself as `relay-ready` once it serves).
pub fn wait_relay(root: &Path) -> Result<()> {
let until = Instant::now() + Duration::from_secs(20);
while Instant::now() < until {
if let (Some(relay), Some(ready)) = (state::running(root, "relay"), state::running(root, "relay-ready")) {
if relay == ready {
return Ok(());
}
}
std::thread::sleep(Duration::from_millis(250));
}
Err(Error::Invalid("Bug-report relay is not ready; check BugReport/Logs/relay.log.".into()))
}
/// The process that runs `watch-world` for a started world.
#[derive(Debug, Clone)]
pub enum Supervisor {
/// `coa-launcher.exe` (this crate's launcher).
Launcher(PathBuf),
/// The repack's Python with `Scripts/manage.py`.
Python { python: PathBuf, script: PathBuf },
}
impl Supervisor {
/// The supervisor a repack ships: `Scripts/coa-launcher.exe` when present, otherwise its Python launcher.
pub fn of(root: &Path) -> Result<Supervisor> {
let exe = root.join("Scripts/coa-launcher.exe");
if exe.is_file() {
return Ok(Supervisor::Launcher(exe));
}
let python = squid::package_root(root).join("Runtime/python/python.exe");
let script = root.join("Scripts/manage.py");
if python.is_file() && script.is_file() {
return Ok(Supervisor::Python { python, script });
}
Err(Error::Service(
ErrorCode::ServerFilesIncomplete,
"This server has no world supervisor (Scripts/coa-launcher.exe or Scripts/manage.py). Repair its program files.".into(),
))
}
}
/// How long a world may take to open both of its listeners, together: slow worlds (many bots, a cold disk) are
/// common, and the limit must not depend on the bot module.
const WORLD_STARTUP_SECONDS: u64 = 1500;
/// Wait until the world's console answers a command (it can listen before it accepts logins).
fn wait_console(root: &Path, cfg: &Settings, until: Instant) -> Result<()> {
let mut last = String::new();
while Instant::now() < until {
if state::running(root, "world").is_none() {
return Err(Error::Service(
ErrorCode::StartupFailed,
"World startup failed: worldserver stopped before its console accepted commands.".into(),
));
}
match crate::ra::Ra::connect_to(cfg.ra_port, &cfg.ra_username, &cfg.ra_password).and_then(|mut ra| ra.run("server info")) {
Ok(_) => return Ok(()),
Err(e) => last = e.to_string(),
}
std::thread::sleep(Duration::from_millis(500));
}
Err(Error::Service(ErrorCode::StartupFailed, format!("World startup failed: its console is still starting. {last}")))
}
fn seconds_until(until: Instant) -> u64 {
until.saturating_duration_since(Instant::now()).as_secs()
}
/// Start the world (and its database, unless it is shared), and wait until its console accepts commands.
pub fn start_world(root: &Path, cfg: &Settings, offset: i32, supervisor: &Supervisor, progress: Progress) -> Result<()> {
start_mysql(root, cfg, progress)?;
squid::validate_bots(root)?;
let until = Instant::now() + Duration::from_secs(squid::startup_timeout(root).max(WORLD_STARTUP_SECONDS));
if state::running(root, "world").is_some() {
if state::running(root, "supervisor").is_none() {
return Err(Error::Service(
ErrorCode::WorldserverAlreadyRunning,
"Worldserver has no repack supervisor. Use Stop_All_Server.bat before restarting it.".into(),
));
}
wait_ready(root, "world", cfg.world_port, seconds_until(until))?;
wait_relay(root)?;
wait_console(root, cfg, until)?;
progress("Worldserver and bug-report relay are already running.");
return Ok(());
}
ensure_free(cfg.world_port, progress)?;
ensure_free(cfg.ra_port, progress)?;
if state::running(root, "supervisor").is_some() || state::running(root, "relay").is_some() {
return Err(Error::Service(
ErrorCode::OperationInProgress,
"The previous world/relay shutdown is still finishing. Try again shortly.".into(),
));
}
squid::prepare_playerbots(root, cfg.mysql_port, &|sql| mysql(root, Some(sql), None), progress)?;
progress("Starting worldserver and its bug-report relay...");
let _ = std::fs::remove_file(stop_relay_flag(root));
let offset_text = offset.to_string();
let root_text = root.to_string_lossy().into_owned();
let log = root.join("Core/Logs/supervisor.log");
match supervisor {
Supervisor::Launcher(exe) => {
spawn(root, "supervisor", exe, &["--root", &root_text, "--port-offset", &offset_text, "watch-world"], root, &log, &cfg.env_remove)?
}
Supervisor::Python { python, script } => {
let script = script.to_string_lossy().into_owned();
spawn(root, "supervisor", python, &["-B", &script, "--port-offset", &offset_text, "watch-world"], root, &log, &cfg.env_remove)?
}
};
let first = Instant::now() + Duration::from_secs(20);
while state::running(root, "world").is_none() && Instant::now() < first {
if state::running(root, "supervisor").is_none() {
return Err(Error::Service(ErrorCode::StartupFailed, "World startup failed; check Core/Logs/supervisor.log.".into()));
}
std::thread::sleep(Duration::from_millis(250));
}
wait_ready(root, "world", cfg.world_port, seconds_until(until))?;
wait_ready(root, "world", cfg.ra_port, seconds_until(until))?;
wait_relay(root)?;
wait_console(root, cfg, until)?;
progress("Worldserver and automatic bug reporting are ready.");
Ok(())
}
fn spawn_child(root: &Path, name: &str, exe: &Path, args: &[&str], cwd: &Path, log: &Path) -> Result<Proc> {
// The supervisor was started with the environment its services should have.
let child = crate::launcher::spawn::start(exe, args, cwd, log, &[])?;
state::record(root, name, child.pid)?;
Ok(child)
}
/// The relay worker: `coa-launcher relay-worker` when the supervisor is the launcher (`launcher`), otherwise the
/// repack's Python running `Scripts/manage.py relay-worker` (BugReport/relay.py).
fn spawn_relay(root: &Path, launcher: Option<&Path>) -> Result<Proc> {
let log = root.join("BugReport/Logs/relay.log");
if let Some(exe) = launcher {
let root_text = root.to_string_lossy().into_owned();
return spawn_child(root, "relay", exe, &["--root", &root_text, "relay-worker"], root, &log);
}
let python = squid::package_root(root).join("Runtime/python/python.exe");
let manage = root.join("Scripts/manage.py");
if !python.is_file() || !manage.is_file() {
return Err(Error::Invalid("The bug-report relay needs the repack's Python and Scripts/manage.py.".into()));
}
let manage = manage.to_string_lossy().into_owned();
spawn_child(root, "relay", &python, &["-B", &manage, "relay-worker"], root, &root.join("BugReport/Logs/relay.log"))
}
/// The supervisor (`watch-world`): run the world, keep the relay alive while it runs, stop the relay after it.
/// `launcher` is the launcher executable that runs the relay (`None`: the Python relay). At the owner's scheduled
/// time it asks the world to restart with an in-game countdown and starts it again when it exits for that.
pub fn watch_world(root: &Path, launcher: Option<&Path>, offset: i32, log: Progress) -> Result<()> {
squid::validate_bots(root)?;
let mut relay: Option<Proc> = None;
loop {
let world = spawn_child(root, "world", &root.join("Core/worldserver.exe"), &["-c", "configs/worldserver.conf"], &root.join("Core"), &root.join("Core/Logs/world-console.log"))?;
let started = schedule::now();
let mut requested = false;
let mut last_check: Option<Instant> = None;
let code = loop {
if let Some(code) = world.try_wait() {
break code;
}
let dead = relay.as_ref().is_none_or(|r| r.try_wait().is_some());
if dead {
match spawn_relay(root, launcher) {
Ok(r) => relay = Some(r),
Err(e) => {
log(&format!("Report relay could not start ({e}); retrying."));
std::thread::sleep(Duration::from_secs(5));
continue;
}
}
}
if last_check.is_none_or(|t| t.elapsed() >= Duration::from_secs(30)) {
last_check = Some(Instant::now());
if schedule::under_way(root) && !requested {
// The world that a scheduled restart started again is back once it accepts connections.
if Settings::load(root, offset).is_ok_and(|cfg| services::ready(root, "world", cfg.world_port)) {
schedule::clear_under_way(root);
}
}
if !requested {
let plan = schedule::load(root);
if plan.due(schedule::now(), started).is_some() {
let seconds = plan.warning_minutes * 60;
let asked = Settings::load(root, offset).and_then(|cfg| {
crate::ra::Ra::connect_to(cfg.ra_port, &cfg.ra_username, &cfg.ra_password)
.and_then(|mut ra| ra.run(&format!("server restart {seconds}")))
});
match asked {
Ok(_) => {
schedule::mark_under_way(root)?;
requested = true;
log(&format!("Scheduled restart: the world restarts in {} minutes.", plan.warning_minutes));
}
Err(e) => log(&format!("Scheduled restart could not be requested ({e}); retrying.")),
}
}
}
}
std::thread::sleep(Duration::from_secs(2));
};
if requested && code == schedule::RESTART_EXIT_CODE as u32 {
log("Scheduled restart: starting the world again.");
if let Err(e) = squid::validate_bots(root) {
schedule::clear_under_way(root);
return Err(e);
}
continue;
}
schedule::clear_under_way(root);
break;
}
std::fs::write(stop_relay_flag(root), b"")?;
if let Some(r) = relay {
let until = Instant::now() + Duration::from_secs(40);
while r.try_wait().is_none() && Instant::now() < until {
std::thread::sleep(Duration::from_millis(250));
}
if r.try_wait().is_none() {
// An interrupted POST stays uncertain in the relay's journal; it is not resent.
if let Some(record) = state::running(root, "relay") {
services::terminate(&record)?;
}
}
}
Ok(())
}
// ---------------------------------------------------------------------------------------------------------------
// Detailed logging (Debug_Logs_On.bat / Debug_Logs_Off.bat)
// ---------------------------------------------------------------------------------------------------------------
const DEBUG_TEMPLATES: [&str; 2] = ["worldserver.conf.template", "authserver.conf.template"];
/// One template line with every logger forced to Trace and the console/server appenders to the most detail.
fn debug_line(line: &str) -> String {
let body = line.strip_prefix('#').unwrap_or(line).trim_start();
for appender in ["Appender.Console", "Appender.Server"] {
if let Some(rest) = body.strip_prefix(appender).and_then(|r| r.strip_prefix('=')) {
let parts: Vec<&str> = rest.splitn(4, ',').collect();
if parts.len() == 4 && parts[..3].iter().all(|p| !p.is_empty() && p.bytes().all(|b| b.is_ascii_digit())) {
return format!("{appender}={},6,7,{}", parts[0], parts[3]);
}
}
}
if let Some(rest) = body.strip_prefix("Logger.") {
if let Some((name, value)) = rest.split_once('=') {
if !name.is_empty() && name.bytes().all(|b| b.is_ascii_alphanumeric() || b == b'_' || b == b'.') {
if let Some((level, tail)) = value.split_once(',') {
if !level.is_empty() && level.bytes().all(|b| b.is_ascii_digit()) {
return format!("Logger.{name}=6,{tail}");
}
}
}
}
}
let t = line.trim_end();
if let Some(v) = t.strip_prefix("Log.Async.Enable") {
let v = v.trim_start();
if let Some(n) = v.strip_prefix('=') {
let n = n.trim();
if !n.is_empty() && n.bytes().all(|b| b.is_ascii_digit()) {
return "Log.Async.Enable = 1".into();
}
}
}
line.to_string()
}
/// Turn detailed logging on or off (the templates; services apply it at their next start). Returns the changed
/// templates.
pub fn debug_logs(root: &Path, enable: bool) -> Result<Vec<String>> {
let mut changed = Vec::new();
for name in DEBUG_TEMPLATES {
let path = root.join("Settings").join(name);
let original = root.join("Settings").join(format!("{name}.original"));
if !original.exists() {
std::fs::write(&original, std::fs::read(&path)?)?;
}
let new_bytes = if enable {
let text = String::from_utf8(std::fs::read(&original)?).map_err(|_| Error::Invalid(format!("{name} is not UTF-8.")))?;
let newline = if text.contains("\r\n") { "\r\n" } else { "\n" };
let mut out = text.lines().map(debug_line).collect::<Vec<_>>().join(newline);
if text.ends_with('\n') {
out.push_str(newline);
}
out.into_bytes()
} else {
std::fs::read(&original)?
};
if std::fs::read(&path)? != new_bytes {
std::fs::write(&path, &new_bytes)?;
changed.push(name.to_string());
}
}
state::write_json(&state::dir(root).join("debug-logs.json"), &serde_json::json!({ "enabled": enable }))?;
Ok(changed)
}
#[cfg(test)]
mod tests {
use super::*;
#[test]
fn detailed_logging_rewrites_loggers_and_restores_the_original() {
let d = tempfile::tempdir().unwrap();
std::fs::create_dir_all(d.path().join("Settings")).unwrap();
let world = "Appender.Console=1,3,0\r\nAppender.Server=2,2,0,Server.log,w\r\n#Logger.module=4,Console Server\r\nLogger.root=5,Console Server\r\nLog.Async.Enable = 0\r\nOther = 1\r\n";
std::fs::write(d.path().join("Settings/worldserver.conf.template"), world).unwrap();
std::fs::write(d.path().join("Settings/authserver.conf.template"), "Logger.root=2,Console\n").unwrap();
let changed = debug_logs(d.path(), true).unwrap();
assert_eq!(changed.len(), 2);
assert_eq!(
std::fs::read_to_string(d.path().join("Settings/worldserver.conf.template")).unwrap(),
"Appender.Console=1,3,0\r\nAppender.Server=2,6,7,Server.log,w\r\nLogger.module=6,Console Server\r\nLogger.root=6,Console Server\r\nLog.Async.Enable = 1\r\nOther = 1\r\n"
);
assert_eq!(debug_logs(d.path(), true).unwrap().len(), 0, "already on");
debug_logs(d.path(), false).unwrap();
assert_eq!(std::fs::read_to_string(d.path().join("Settings/worldserver.conf.template")).unwrap(), world);
assert_eq!(services::status(d.path())["debugLogs"], false);
}
}
-85
View File
@@ -1,85 +0,0 @@
import runpy
import sys
import time
from pathlib import Path
script = sys.argv[1]
sys.path.insert(0, str(Path(script).resolve().parent))
sys.argv = sys.argv[1:]
launcher = runpy.run_path(script, run_name="coa_manager_launcher")
original_wait = launcher["wait_ready"]
world_deadline = None
def wait_ready(name, port, seconds=180):
global world_deadline
if name == "mysql":
seconds = max(seconds, 300)
elif name == "world":
# Both game and console listeners belong to one startup, including on old repacks.
# Ordinary CoA worlds can load slowly too; this must not depend on SQUID.
if world_deadline is None:
world_deadline = time.monotonic() + max(seconds, 1500)
seconds = max(0, world_deadline - time.monotonic())
return original_wait(name, port, seconds)
launcher["start_mysql"].__globals__["wait_ready"] = wait_ready
if sys.argv[1] in ("stop-all", "force-stop-all"):
shutdown = launcher["stop_all"].__globals__
class UnsafeShutdown(Exception):
pass
def stop_owned_world(world):
expected = Path(script).resolve().parents[1] / "Core" / "worldserver.exe"
if Path(world.get("exe", "")) != expected or not shutdown["same_process"](world):
raise UnsafeShutdown("World process ownership could not be verified; the database was left running.")
try:
shutdown["terminate"](world)
except (OSError, RuntimeError) as error:
raise UnsafeShutdown("Worldserver could not be stopped safely; its database was left running.") from error
if not shutdown["wait_stopped"](world, 90):
raise UnsafeShutdown("Worldserver is still stopping; its database was left running.")
if "ra" in shutdown:
original_ra = shutdown["ra"]
def shutdown_command(command, config):
try:
return original_ra(command, config)
except (OSError, RuntimeError):
if not command.startswith("server shutdown "):
raise
world = shutdown["process"]("world")
if not world:
return "Worldserver has already stopped."
stop_owned_world(world)
return "Stopped this server's recorded world process without its unavailable console."
shutdown["ra"] = shutdown_command
config = launcher["settings"]()
with launcher["control_lock"]():
if sys.argv[1] == "force-stop-all":
world = shutdown["process"]("world")
if world:
stop_owned_world(world)
print("Force-stopped this server's verified world process; unsaved progress may be lost.", flush=True)
launcher["stop_all"](config)
else:
launcher["main"]()
if sys.argv[1] in ("start-all", "start-world"):
config = launcher["settings"]()
deadline = world_deadline if world_deadline is not None else time.monotonic() + 1500
last_error = None
while time.monotonic() < deadline:
if not launcher["process"]("world"):
raise RuntimeError("World startup failed: worldserver stopped before its console accepted commands.")
try:
launcher["ra"]("server info", config)
print("World console is accepting commands.", flush=True)
break
except (OSError, RuntimeError) as error:
last_error = error
time.sleep(0.5)
else:
raise RuntimeError(f"World startup failed: its console is still starting. {last_error}")
+222
View File
@@ -0,0 +1,222 @@
//! `Scripts/manage.py` as Managers up to 0.9.10 edited it.
//!
//! Those Managers ran the repack's Python launcher themselves and changed its text: an import fix for their bridge
//! and a realm-profile patch (database and realm row of the active realm). This Manager starts servers with
//! [`crate::launcher`] and never edits the file; it only has to recognise those edits, so that an update or a file
//! check treats a file one of them changed as unmodified. Nothing here writes a file.
use crate::error::{Error, Result};
const LAUNCHER_REALM_REPLACEMENTS: &[(&str, &str)] = &[
("(\"WorldDatabaseInfo\", \"acore_world\")", "(\"WorldDatabaseInfo\", \"acore_world_wildcard\" if coa_realm() == 'wildcard' else \"acore_world\")"),
("(\"CharacterDatabaseInfo\", \"acore_characters\")", "(\"CharacterDatabaseInfo\", \"acore_characters_wildcard\" if coa_realm() == 'wildcard' else \"acore_characters\")"),
("SET name='AzerothCore',address=", "SET name='{coa_realm_name()}',address="),
("WHERE id=1;", "WHERE id={coa_realm_id()};"),
("mysql(\"UPDATE acore_auth.realmlist SET flag=0", "mysql(f\"UPDATE acore_auth.realmlist SET flag=0"),
];
const LAUNCHER_REALM_INSERT: &str = "# coa-manager-realm-profiles-v1\ndef coa_realm():\n path = ROOT / 'Settings/realm-profile.json'\n return json.loads(path.read_text(encoding='utf-8')).get('active', 'coa') if path.exists() else 'coa'\n\ndef coa_realm_id():\n return 2 if coa_realm() == 'wildcard' else 1\n\ndef coa_realm_name():\n return 'Wildcard' if coa_realm() == 'wildcard' else 'Conquest of Azeroth'\n\n";
fn launcher_insert() -> String {
LAUNCHER_REALM_INSERT
.replace("profiles-v1", "profiles-v2")
.replace(
"return 2 if",
"return 3 if coa_realm() == 'reborn' else 2 if",
)
.replace(
"return 'Wildcard' if",
"return 'Warcraft Reborn' if coa_realm() == 'reborn' else 'Wildcard' if",
)
}
fn launcher_replacements() -> Vec<(&'static str, String)> {
LAUNCHER_REALM_REPLACEMENTS.iter().map(|(from, to)| (*from, to
.replace("\"acore_world_wildcard\" if", "\"acore_world_reborn\" if coa_realm() == 'reborn' else \"acore_world_wildcard\" if")
.replace("\"acore_characters_wildcard\" if", "\"acore_characters_reborn\" if coa_realm() == 'reborn' else \"acore_characters_wildcard\" if"))).collect()
}
/// The realm-profile patch older Managers wrote.
pub(crate) fn patch_launcher(source: &str) -> Result<String> {
if source.contains("# coa-manager-realm-profiles-v2") {
return Ok(source.into());
}
if source.contains("# coa-manager-realm-profiles-v1") {
let original = unpatch_launcher(source)
.ok_or_else(|| Error::Invalid("Unrecognised realm launcher patch.".into()))?;
return patch_launcher(&original);
}
let mut out = source.to_string();
for (from, to) in launcher_replacements() {
if !out.contains(from) {
return Err(Error::Invalid(
"This launcher does not support realm profiles. Update the server package first."
.into(),
));
}
out = out.replace(from, &to);
}
// Insert before the entry point so ROOT, json and functions are all defined when called.
let marker = "if __name__ == \"__main__\":";
if !out.contains(marker) {
return Err(Error::Invalid(
"Unrecognised server launcher entry point.".into(),
));
}
Ok(out.replace(marker, &format!("{}{marker}", launcher_insert())))
}
/// Reverse only our exact realm transformation; callers must verify the recovered original hash.
pub(crate) fn unpatch_launcher(source: &str) -> Option<String> {
let (insert, replacements) = if source.contains(&launcher_insert()) {
(launcher_insert(), launcher_replacements())
} else if source.contains(LAUNCHER_REALM_INSERT) {
(
LAUNCHER_REALM_INSERT.into(),
LAUNCHER_REALM_REPLACEMENTS
.iter()
.map(|(a, b)| (*a, b.to_string()))
.collect(),
)
} else {
return None;
};
let mut original = source.replacen(&insert, "", 1);
for (from, to) in &replacements {
original = original.replace(to, from);
}
let mut check = original.clone();
for (from, to) in &replacements {
check = check.replace(from, to);
}
check = check.replace(
"if __name__ == \"__main__\":",
&format!("{insert}if __name__ == \"__main__\":"),
);
(check == source).then_some(original)
}
/// The import fix older Managers wrote (needed to run manage.py through their bridge).
pub(crate) fn patch_launcher_imports(text: &str) -> Result<String> {
let line = "sys.path.insert(0, str(Path(__file__).resolve().parent))";
if !text.contains("from squid_playerbots import") || text.contains(line) {
return Ok(text.into());
}
let root = "ROOT = Path(__file__).resolve().parents[1]";
if !text.contains(root) || !text.lines().any(|line| line.trim() == "import sys") {
return Err(Error::Invalid(
"The server launcher cannot load its integration scripts. Repair its program files."
.into(),
));
}
Ok(text.replacen(root, &format!("{root}\n{line}"), 1))
}
pub(crate) fn launcher_matches(signed: &str, actual: &[u8]) -> bool {
if signed.as_bytes() == actual {
return true;
}
if patch_launcher_imports(signed).is_ok_and(|s| s.as_bytes() == actual) {
return true;
}
patch_launcher(signed).is_ok_and(|s| {
s.as_bytes() == actual || patch_launcher_imports(&s).is_ok_and(|p| p.as_bytes() == actual)
})
}
/// Recover legacy metadata only when undoing supported Manager edits reproduces the recorded hash.
pub(crate) fn launcher_matches_recorded(recorded: &str, actual: &[u8]) -> bool {
let Ok(text) = std::str::from_utf8(actual) else {
return false;
};
let without_import = text.replacen(
"ROOT = Path(__file__).resolve().parents[1]\nsys.path.insert(0, str(Path(__file__).resolve().parent))",
"ROOT = Path(__file__).resolve().parents[1]", 1,
);
for candidate in [
Some(without_import.clone()),
unpatch_launcher(&without_import),
]
.into_iter()
.flatten()
{
if crate::fsx::sha256_bytes(candidate.as_bytes()).eq_ignore_ascii_case(recorded)
&& launcher_matches(&candidate, actual)
{
return true;
}
}
false
}
#[cfg(test)]
mod tests {
use super::*;
use crate::fsx;
use std::collections::BTreeMap;
use std::fs;
#[test]
fn old_launcher_upgrades_and_both_patch_versions_are_reversible() {
let original = "(\"WorldDatabaseInfo\", \"acore_world\")\n(\"CharacterDatabaseInfo\", \"acore_characters\")\nSET name='AzerothCore',address=\nWHERE id=1;\nmysql(\"UPDATE acore_auth.realmlist SET flag=0\nif __name__ == \"__main__\":\n";
let mut old = original.to_string();
for (from, to) in LAUNCHER_REALM_REPLACEMENTS {
old = old.replace(from, to);
}
old = old.replace(
"if __name__ == \"__main__\":",
&format!("{LAUNCHER_REALM_INSERT}if __name__ == \"__main__\":"),
);
assert_eq!(unpatch_launcher(&old).as_deref(), Some(original));
let new = patch_launcher(&old).unwrap();
assert!(new.contains("acore_world_reborn"));
assert!(new.contains("return 3 if coa_realm() == 'reborn'"));
assert!(new.contains("return 'Warcraft Reborn' if"));
assert_eq!(patch_launcher(&new).unwrap(), new);
assert_eq!(unpatch_launcher(&new).as_deref(), Some(original));
}
#[test]
fn unknown_launcher_is_refused_without_partial_patching() {
assert!(patch_launcher("print('custom launcher')").is_err());
}
#[test]
fn launcher_import_fix_is_idempotent_and_retains_other_code() {
let text = "import sys\nROOT = Path(__file__).resolve().parents[1]\nfrom squid_playerbots import validate_bots\ncustom = 42\n";
let fixed = patch_launcher_imports(text).unwrap();
assert!(fixed.contains("sys.path.insert(0, str(Path(__file__).resolve().parent))"));
assert!(fixed.ends_with("custom = 42\n"));
assert_eq!(patch_launcher_imports(&fixed).unwrap(), fixed);
}
#[test]
fn a_launcher_patched_by_an_older_manager_stays_pristine_but_external_edits_conflict() {
let d = tempfile::tempdir().unwrap();
let root = d.path().join("server");
let source = "(\"WorldDatabaseInfo\", \"acore_world\")\n(\"CharacterDatabaseInfo\", \"acore_characters\")\nSET name='AzerothCore',address=\nWHERE id=1;\nmysql(\"UPDATE acore_auth.realmlist SET flag=0\nif __name__ == \"__main__\":\n";
fsx::atomic_write(&root.join("Scripts/manage.py"), source.as_bytes()).unwrap();
// What an older Manager left: the realm patch applied and its hash recorded as the pristine one.
let patched = patch_launcher(source).unwrap();
fsx::atomic_write(&root.join("Scripts/manage.py"), patched.as_bytes()).unwrap();
let mut meta = crate::registry::InstallMeta::new(crate::registry::InstallKind::New, &root);
meta.original_hashes.insert("Scripts/manage.py".into(), fsx::sha256_bytes(patched.as_bytes()));
crate::registry::MetaDir::create(&root, &meta).unwrap();
assert!(crate::diag::verify_managed(&root, &meta).is_empty());
let manifest: crate::manifest::Manifest = serde_json::from_value(serde_json::json!({
"schema": 1, "kind": "update", "version": "2.0.0", "core": {"commit": null}, "builtAt": "fixture", "minManagerVersion": "0.1.0",
"files": [{"path":"Scripts/manage.py","sha256":fsx::sha256_bytes(b"next release"),"size":12,"owner":"core","policy":"replace"}]
})).unwrap();
assert_eq!(
crate::update::plan(&root, &meta, &manifest, &BTreeMap::new(), None).unwrap()[0].action,
crate::update::Action::Replace
);
let mut modified = fs::read(root.join("Scripts/manage.py")).unwrap();
modified.extend_from_slice(b"# custom edit\n");
fsx::atomic_write(&root.join("Scripts/manage.py"), &modified).unwrap();
assert_eq!(
crate::update::plan(&root, &meta, &manifest, &BTreeMap::new(), None).unwrap()[0].action,
crate::update::Action::Conflict
);
}
}
+4
View File
@@ -9,6 +9,7 @@
pub mod accounts;
pub mod allsettings;
pub mod addons;
pub mod backup;
pub mod channels;
pub mod character_start_check;
@@ -28,6 +29,7 @@ pub mod diag;
pub mod docker;
pub mod download;
pub mod driver;
pub mod legacy_launcher;
pub mod error;
pub mod firewall;
pub mod friends;
@@ -36,6 +38,7 @@ pub mod glue_config;
pub mod health;
pub mod install;
pub mod layout;
pub mod launcher;
pub mod logging;
pub mod server_logging;
pub mod manifest;
@@ -54,6 +57,7 @@ pub mod ra;
pub mod race_availability;
pub mod realm_registry;
pub mod realmlist;
pub mod realm_names;
pub mod realms;
pub mod registry;
pub mod release;
+58 -1
View File
@@ -48,6 +48,10 @@ pub struct Entry {
/// Not shown on the Modules page; its settings are offered elsewhere (a server setting card).
#[serde(default)]
pub hidden: bool,
/// A part of another module, switched and set up inside that module's settings (Custom Races V2 brings
/// subclasses and the /dev menu).
#[serde(default)]
pub part_of: Option<String>,
}
fn yes() -> bool {
@@ -111,6 +115,7 @@ pub struct ModuleView {
pub page: Option<String>,
pub hidden: bool,
pub compatibility: String,
pub part_of: Option<String>,
}
pub fn list(root: &Path) -> Vec<ModuleView> {
@@ -171,6 +176,32 @@ fn installed_module_commits(root: &Path) -> BTreeMap<String, String> {
Default::default()
}
/// The companion bots of this server build play Wildcard and Warcraft Reborn: their bot profiles for the standard
/// classes are in the world server or its bots plugin. Older builds only know Conquest of Azeroth characters.
pub fn companions_on_other_realms(root: &Path) -> bool {
use std::collections::HashMap;
use std::sync::{Mutex, OnceLock};
static SEEN: OnceLock<Mutex<HashMap<(PathBuf, u64, Option<std::time::SystemTime>), bool>>> = OnceLock::new();
const MARKER: &[u8] = b"Druid_Guardian_Tank";
let mut files = vec![crate::layout::executables(root).0];
if let Ok(plugins) = fs::read_dir(root.join("Core/plugins")) {
files.extend(plugins.flatten().map(|e| e.path()).filter(|p| p.extension().is_some_and(|x| x.eq_ignore_ascii_case("dll"))));
}
files.into_iter().any(|file| {
let Ok(meta) = fs::metadata(&file) else { return false };
let key = (file.clone(), meta.len(), meta.modified().ok());
let seen = SEEN.get_or_init(Mutex::default);
if let Some(found) = seen.lock().ok().and_then(|s| s.get(&key).copied()) {
return found;
}
let found = fs::read(&file).is_ok_and(|bytes| bytes.windows(MARKER.len()).any(|w| w == MARKER));
if let Ok(mut s) = seen.lock() {
s.insert(key, found);
}
found
})
}
fn list_in(cat: &[Entry], root: &Path) -> Vec<ModuleView> {
let installed_commits = installed_module_commits(root);
let wildcard = crate::realms::state(root)
@@ -203,7 +234,9 @@ fn list_in(cat: &[Entry], root: &Path) -> Vec<ModuleView> {
.map(|enabled| !enabled)
.unwrap_or(true);
let blocked = dependency_missing
|| (wildcard && matches!(e.id.as_str(), "companions" | "playerbots" | "dungeon-clear"));
|| (wildcard
&& (matches!(e.id.as_str(), "playerbots" | "dungeon-clear")
|| (e.id == "companions" && !companions_on_other_realms(root))));
let version = if e.id == "playerbots" {
crate::squid::release(root).map(|release| {
[
@@ -256,6 +289,7 @@ fn list_in(cat: &[Entry], root: &Path) -> Vec<ModuleView> {
icon: e.icon,
page: e.page,
hidden: e.hidden,
part_of: e.part_of,
}
})
.collect()
@@ -716,6 +750,27 @@ mod tests {
assert!(meta.join("backups").exists());
}
#[test]
fn companions_open_on_other_realms_only_with_a_build_that_plays_them() {
let temp = tempfile::tempdir().unwrap();
let root = temp.path().join("server");
fs::create_dir_all(dir(&root)).unwrap();
fs::create_dir_all(root.join("Settings")).unwrap();
fs::write(root.join("Settings/realm-profile.json"), r#"{"active":"wildcard","wildcard_created":true}"#).unwrap();
for e in catalog().iter().filter(|e| matches!(e.id.as_str(), "companions" | "playerbots")) {
fs::write(dir(&root).join(format!("{}.dist", e.conf)), format!("{} = 0\n", e.enable_key)).unwrap();
}
let exe = crate::layout::executables(&root).0;
fs::write(&exe, b"an old world server").unwrap();
let view = |id: &str| list(&root).into_iter().find(|m| m.id == id).unwrap();
assert_eq!(view("companions").compatibility, "unsupported");
fs::write(&exe, b"profiles ... Druid_Guardian_Tank ... a new world server").unwrap();
assert!(companions_on_other_realms(&root));
assert_eq!(view("companions").compatibility, "experimental");
assert!(view("companions").switchable);
assert_eq!(view("playerbots").compatibility, "unsupported", "SQUID stays CoA-only");
}
fn test_catalog() -> Vec<Entry> {
let one = |id: &str, name: &str, conf: &str, key: &str| Entry {
id: id.into(),
@@ -734,6 +789,7 @@ mod tests {
icon: String::new(),
page: None,
hidden: false,
part_of: None,
};
vec![
one(
@@ -1379,6 +1435,7 @@ mod tests {
icon: String::new(),
page: None,
hidden: false,
part_of: None,
};
let cat = vec![compat];
let v = list_in(&cat, &root).remove(0);
+70 -28
View File
@@ -97,6 +97,58 @@ pub fn world_root(main: &Path, mode: Mode) -> PathBuf {
.map_or_else(|| main.to_path_buf(), |t| tree_root(main, t))
}
#[derive(Debug, Clone)]
pub struct BotOperationTarget {
pub world_root: PathBuf,
pub chars_db: &'static str,
pub ra_port: u16,
pub running: bool,
pub realm: Mode,
}
pub fn resolve_bot_operation_target(main: &Path, realm: Mode) -> Result<BotOperationTarget> {
let state = realms::state(main)?;
let chars_db = realm.schema("characters")?;
if realm == state.active {
let ports = crate::layout::read_ports(main);
let ra_port = ports.ra;
let status = process::observe(main, &ports);
let running = status.world.state != ServiceState::Stopped;
return Ok(BotOperationTarget {
world_root: main.to_path_buf(),
chars_db,
ra_port,
running,
realm,
});
}
let tree = Tree::ALL
.into_iter()
.find(|t| t.enabled(&state) && t.mode(state.active) == realm)
.ok_or_else(|| Error::Invalid(format!("Realm {} is not enabled in multiworld configuration.", realm.label())))?;
let root = tree_root(main, tree);
if !root.exists() {
return Err(Error::Invalid(format!("Multiworld directory for {} does not exist: {}", realm.label(), root.display())));
}
let ports = crate::layout::read_ports(&root);
let (_, default_ra) = tree.ports(&state);
let ra_port = if ports.ra != 0 { ports.ra } else { default_ra.unwrap_or(3444) };
let status = process::observe(&root, &ports);
let running = status.world.state != ServiceState::Stopped;
Ok(BotOperationTarget {
world_root: root,
chars_db,
ra_port,
running,
realm,
})
}
/// Any of the extra worlds is running or still stopping.
pub fn is_running(main: &Path) -> bool {
Tree::ALL.into_iter().any(|t| tree_running(main, t))
@@ -176,7 +228,6 @@ fn set_tree(main: &Path, tree: Tree, enabled: bool) -> Result<realms::View> {
}
}
}
secondary_launcher(&fs::read_to_string(main.join("Scripts/manage.py"))?)?;
}
let status = process::observe(main, &crate::layout::read_ports(main));
if status.world.state != ServiceState::Stopped
@@ -262,6 +313,12 @@ fn prepare(main: &Path, tree: Tree) -> Result<PathBuf> {
&fsx::ensure_within(&second, &second.join("Core/reference"))?,
)?;
}
if main.join("Core/plugins").is_dir() {
copy_tree(
&main.join("Core/plugins"),
&fsx::ensure_within(&second, &second.join("Core/plugins"))?,
)?;
}
for entry in fs::read_dir(main.join("Core"))? {
let entry = entry?;
if entry.file_type()?.is_file()
@@ -349,25 +406,18 @@ fn prepare(main: &Path, tree: Tree) -> Result<PathBuf> {
..Default::default()
},
)?;
let source = fs::read_to_string(main.join("Scripts/manage.py"))?;
let source = secondary_launcher(&source)?;
fsx::atomic_write(&second.join("Scripts/manage.py"), source.as_bytes())?;
Ok(second)
}
fn secondary_launcher(source: &str) -> Result<String> {
let marker = "def start_world(config, offset):\n start_mysql(config)";
let source = source.replace("\r\n", "\n");
if !source.contains(marker) {
return Err(Error::Invalid(
"The launcher does not support a shared database world. Update the server first."
.into(),
));
// The world supervisor and the bug-report relay of the extra world (the launcher itself runs in the Manager
// and knows that this world shares the main database).
for script in ["Scripts/coa-launcher.exe", "Scripts/manage.py"] {
let target = second.join(script);
if main.join(script).is_file() {
fs::create_dir_all(second.join("Scripts"))?;
fsx::atomic_write(&target, &fs::read(main.join(script))?)?;
} else if target.exists() {
fs::remove_file(&target)?;
}
}
Ok(source.replace(
marker,
"def start_world(config, offset):\n mysql(admin=\"ping\")",
))
Ok(second)
}
fn start_tree(main: &Path, tree: Tree) -> Result<()> {
@@ -408,7 +458,7 @@ pub fn start(main: &Path) -> Result<()> {
fn stop_tree(main: &Path, tree: Tree) -> Result<()> {
let second = tree_root(main, tree);
if !second.join("Scripts/manage.py").exists() {
if !second.join("Settings/repack.json").exists() {
if tree_running(main, tree) {
return Err(Error::Invalid(format!(
"The running {}'s launcher is missing. The shared database was left running.",
@@ -505,12 +555,4 @@ mod tests {
assert!(err.contains(expected), "{err}");
assert!(!realms::state(t.path()).unwrap().with_reborn);
}
#[test]
fn secondary_never_starts_the_shared_database() {
let patched = secondary_launcher("def start_world(config, offset):\r\n start_mysql(config)\r\n wait_ready('world', 8086)\r\n").unwrap();
assert!(patched.contains("mysql(admin=\"ping\")"));
assert!(!patched.contains("start_mysql(config)"));
assert!(secondary_launcher("def start_world(): pass").is_err());
}
}
+27 -10
View File
@@ -49,17 +49,19 @@ fn parse_counts(out: &str) -> Result<Population> {
})
}
/// Read-only query with the game's own database account. Requires the database to be running.
/// Read-only query with the game's own database account. Routes automatically to the active realm's characters database.
pub fn query(root: &Path) -> Result<Population> {
let db = Db::from_repack(root, Account::App)?;
query_with(
&db,
&bot_account_prefix(root),
&crate::accounts::squid_bot_prefix(root),
)
let mode = crate::realms::state(root)
.map(|s| s.active)
.unwrap_or(crate::realms::Mode::Coa);
query_for_realm(root, mode)
}
fn counts_sql(prefix: &str, squid_prefix: &str) -> Result<String> {
counts_sql_for_db("acore_characters", prefix, squid_prefix)
}
pub fn counts_sql_for_db(chars_db: &str, prefix: &str, squid_prefix: &str) -> Result<String> {
if [prefix, squid_prefix]
.iter()
.any(|prefix| prefix.is_empty() || !prefix.chars().all(|c| c.is_ascii_alphanumeric()))
@@ -74,9 +76,9 @@ fn counts_sql(prefix: &str, squid_prefix: &str) -> Result<String> {
let bots =
format!("(UPPER(a.username) LIKE '{prefix}%' OR UPPER(a.username) LIKE '{squid_prefix}%')");
Ok(format!(
"SELECT (SELECT COUNT(*) FROM acore_characters.characters WHERE online=1), \
(SELECT COUNT(*) FROM acore_characters.characters c JOIN acore_auth.account a ON a.id=c.account WHERE c.online=1 AND {bots}), \
(SELECT COUNT(*) FROM acore_characters.characters c JOIN acore_auth.account a ON a.id=c.account WHERE {bots});"
"SELECT (SELECT COUNT(*) FROM {chars_db}.characters WHERE online=1), \
(SELECT COUNT(*) FROM {chars_db}.characters c JOIN acore_auth.account a ON a.id=c.account WHERE c.online=1 AND {bots}), \
(SELECT COUNT(*) FROM {chars_db}.characters c JOIN acore_auth.account a ON a.id=c.account WHERE {bots});"
))
}
@@ -85,6 +87,21 @@ pub fn query_with(db: &Db, prefix: &str, squid_prefix: &str) -> Result<Populatio
parse_counts(&db.query(&counts_sql(prefix, squid_prefix)?)?)
}
pub fn query_for_schema(db: &Db, chars_db: &str, prefix: &str, squid_prefix: &str) -> Result<Population> {
parse_counts(&db.query(&counts_sql_for_db(chars_db, prefix, squid_prefix)?)?)
}
pub fn query_for_realm(root: &Path, mode: crate::realms::Mode) -> Result<Population> {
let db = Db::from_repack(root, Account::App)?;
let schema = mode.schema("characters")?;
query_for_schema(
&db,
schema,
&bot_account_prefix(root),
&crate::accounts::squid_bot_prefix(root),
)
}
#[derive(Debug, Clone, Serialize)]
pub struct Hardware {
pub cores: u32,
+79 -1
View File
@@ -58,6 +58,23 @@ impl Ra {
Self::connect_to(read_ports(root).ra, &cfg.ra_username, &cfg.ra_password)
}
/// Connect to the loopback RA port of the target realm world server.
pub fn connect_target(main: &Path, realm: Option<crate::realms::Mode>) -> Result<Ra> {
let mode = realm.unwrap_or_else(|| {
crate::realms::view(main).map(|v| v.active).unwrap_or_default()
});
let target = crate::multiworld::resolve_bot_operation_target(main, mode)?;
if !target.running {
return Err(Error::Invalid(format!(
"Realm {} worldserver is stopped; cannot execute online bot operation.",
target.realm.label()
)));
}
let cfg: RaSettings = fsx::read_json(&main.join("Settings/repack.json"))
.map_err(|_| Error::Invalid("The server console settings could not be read.".into()))?;
Self::connect_to(target.ra_port, &cfg.ra_username, &cfg.ra_password)
}
pub fn connect_to(port: u16, user: &str, password: &str) -> Result<Ra> {
let addr: SocketAddr = ([127, 0, 0, 1], port).into();
let mut stream =
@@ -87,7 +104,28 @@ impl Ra {
let c = crate::console::check_command(cmd)?;
self.command(c)
}
/// Send a command whose answer does not matter (`server shutdown`). The reply is still read (up to the next
/// prompt, the end of the connection, or a few seconds): closing a socket that holds unread data resets the
/// connection, and the server can then drop the command it has not processed yet.
pub fn send_without_answer(mut self, cmd: &str) -> Result<()> {
let c = crate::console::check_command(cmd)?;
self.stream.write_all(format!("{c}\r\n").as_bytes())?;
self.stream.flush()?;
self.stream.set_read_timeout(Some(Duration::from_secs(10)))?;
let mut seen = Vec::new();
let mut buf = [0u8; 4096];
while let Ok(n) = self.stream.read(&mut buf) {
if n == 0 {
break;
}
seen.extend_from_slice(&buf[..n]);
if seen.ends_with(b"AC>") || seen.len() > 1 << 20 {
break;
}
}
let _ = self.stream.shutdown(std::net::Shutdown::Both);
Ok(())
}
fn command(&mut self, cmd: &str) -> Result<String> {
debug_assert!(!cmd.contains(['\r', '\n']));
self.stream.write_all(format!("{cmd}\r\n").as_bytes())?;
@@ -235,6 +273,11 @@ impl Ra {
Ok(out.lines().last().unwrap_or("").to_string())
}
/// Delete the companion bots of custom races (RaceID above 11), every other bot stays. Returns how many.
pub fn purge_custom_race_bots(&mut self) -> Result<u32> {
Ok(first_number(&self.bot_command("botcmd purgecustomraces")?))
}
/// Ask the bot module to create `count` leveling bots (throttled by the module itself). Only a number is sent.
pub fn spawn_bots(&mut self, count: u32) -> Result<String> {
if !(1..=2000).contains(&count) {
@@ -249,6 +292,41 @@ impl Ra {
Ok(out.lines().last().unwrap_or("").to_string())
}
/// Ask the bot module to spawn a fleet of bots of specific race and level (.botcmd spawnfleet <race> <level>).
pub fn spawn_fleet(&mut self, race: u8, level: u8) -> Result<String> {
let out = self.bot_command(&format!("botcmd spawnfleet {race} {level}"))?;
Ok(out.lines().last().unwrap_or("").to_string())
}
pub fn spawn_custom(
&mut self,
count: u32,
level: u8,
class_id: Option<u8>,
spec_id: Option<u32>,
archetype: Option<&str>,
) -> Result<String> {
let c = class_id.unwrap_or(0);
let s = spec_id.unwrap_or(0);
let a = archetype.unwrap_or("").trim();
let mut cmd = format!("botcmd spawncustom {count} {level}");
if !a.is_empty() {
cmd.push_str(&format!(" {c} {s} {a}"));
} else if s > 0 {
cmd.push_str(&format!(" {c} {s}"));
} else if c > 0 {
cmd.push_str(&format!(" {c}"));
}
let out = self.bot_command(&cmd)?;
Ok(out.lines().last().unwrap_or("").to_string())
}
/// Bring all offline bots online gradually (.botcmd loginall).
pub fn login_all(&mut self) -> Result<String> {
let out = self.bot_command("botcmd loginall")?;
Ok(out.lines().last().unwrap_or("").to_string())
}
/// Set a new password for an existing account.
pub fn set_account_password(&mut self, name: &str, password: &str) -> Result<()> {
validate_account(name, password)?;
+171
View File
@@ -269,9 +269,95 @@ pub fn save(
),
]),
)?;
write_snapshot(root, &current.catalog_sha256, &current.races)?;
status(root)
}
/// Every race catalog (`ChrRaces.dbc` of the custom races overlay) a server build has shipped, by SHA-256:
/// RaceID -> name. Generated from the core repository's history of the overlay.
const SHIPPED_CATALOGS: &str = include_str!("race_catalogs.json");
/// The names of the catalog a restriction was saved against, written by every save.
const SNAPSHOT: &str = "Settings/race-catalog.json";
#[derive(serde::Deserialize, Serialize)]
struct Snapshot {
sha256: String,
races: BTreeMap<u32, String>,
}
/// RaceID -> name of the catalog with `hash`: this server's own snapshot, or a catalog a build shipped.
fn names_of(root: &Path, hash: &str) -> Option<BTreeMap<u32, String>> {
if let Ok(snapshot) = crate::fsx::read_json::<Snapshot>(&root.join(SNAPSHOT)) {
if snapshot.sha256.eq_ignore_ascii_case(hash) {
return Some(snapshot.races);
}
}
#[derive(serde::Deserialize)]
struct Shipped {
catalogs: BTreeMap<String, BTreeMap<u32, String>>,
}
let shipped: Shipped = serde_json::from_str(SHIPPED_CATALOGS).ok()?;
shipped.catalogs.get(&hash.to_ascii_lowercase()).cloned()
}
fn write_snapshot(root: &Path, hash: &str, races: &[Race]) -> Result<()> {
crate::fsx::atomic_write_json(
&root.join(SNAPSHOT),
&Snapshot {
sha256: hash.to_string(),
races: races.iter().map(|race| (race.id, race.name.clone())).collect(),
},
)
}
/// A server update that only adds races keeps the owner's restriction. The worldserver ignores a restriction
/// saved against another catalog (and with it the whole custom races switch), so before a start: when every
/// disabled race still has its RaceID and name in the new catalog, the restriction is bound to the new catalog.
/// Anything else (an unknown old catalog, a renamed or missing race) is left for the owner to review. Returns
/// whether the restriction was bound again.
pub fn rebind_unchanged(root: &Path) -> Result<bool> {
let conf_path = root.join(CONF);
let Ok(conf_bytes) = fs::read(&conf_path) else {
return Ok(false);
};
let mut conf = ConfFile::parse_bytes(&conf_bytes)?;
let configured = parse_ids(conf.get(KEY).unwrap_or(""))?;
let saved = conf
.get(CATALOG_KEY)
.unwrap_or("")
.trim()
.trim_matches('"')
.to_ascii_lowercase();
if configured.is_empty() || saved.is_empty() {
return Ok(false);
}
let Ok(bytes) = fs::read(dbc_path(root)?) else {
return Ok(false);
};
let current = hex::encode(Sha256::digest(&bytes));
if saved == current {
return Ok(false);
}
let races = catalog(&bytes)?;
let Some(before) = names_of(root, &saved) else {
tracing::warn!("race restriction saved against an unknown catalog; it needs the owner's review");
return Ok(false);
};
let now: BTreeMap<u32, &str> = races.iter().map(|race| (race.id, race.name.as_str())).collect();
let unchanged = configured
.iter()
.all(|id| before.get(id).is_some_and(|name| now.get(id) == Some(&name.as_str())));
if !unchanged {
tracing::warn!("a restricted race changed in the new catalog; the restriction needs the owner's review");
return Ok(false);
}
conf.set(CATALOG_KEY, &format!("\"{current}\""), &[]);
crate::fsx::atomic_write(&conf_path, conf.to_text().as_bytes())?;
write_snapshot(root, &current, &races)?;
tracing::info!(races = configured.len(), "race restriction kept for the updated race catalog");
Ok(true)
}
#[cfg(test)]
mod tests {
use super::*;
@@ -292,6 +378,91 @@ mod tests {
bytes
}
fn catalog_of(rows: &[(u32, &str)]) -> Vec<u8> {
let mut strings = vec![0u8];
let mut offsets = Vec::new();
for (_, name) in rows {
offsets.push(strings.len() as u32);
strings.extend(name.as_bytes());
strings.push(0);
}
let mut bytes = b"WDBC".to_vec();
for value in [rows.len() as u32, 69, 276, strings.len() as u32] {
bytes.extend(value.to_le_bytes());
}
for ((id, _), offset) in rows.iter().zip(offsets) {
let mut row = vec![0; 276];
row[..4].copy_from_slice(&id.to_le_bytes());
row[56..60].copy_from_slice(&offset.to_le_bytes());
bytes.extend(row);
}
bytes.extend(strings);
bytes
}
fn restricted_server(catalog: &[u8], disabled: &str, saved_hash: &str) -> tempfile::TempDir {
let d = tempfile::tempdir().unwrap();
fs::create_dir_all(d.path().join("Data/dbc_races")).unwrap();
fs::create_dir_all(d.path().join("Core/configs/modules")).unwrap();
fs::write(d.path().join("Data/dbc_races/ChrRaces.dbc"), catalog).unwrap();
fs::write(
d.path().join(CONF),
format!("CoACustomRaces.Enable = 1\nCoACustomRaces.DisabledRaceIds = \"{disabled}\"\nCoACustomRaces.DisabledRaceCatalogSha256 = \"{saved_hash}\"\n"),
)
.unwrap();
d
}
fn sha(bytes: &[u8]) -> String {
hex::encode(Sha256::digest(bytes))
}
#[test]
fn a_catalog_that_only_adds_races_keeps_the_restriction() {
let old = catalog_of(&[(83, "Vulpera"), (97, "Gnoll")]);
let new = catalog_of(&[(83, "Vulpera"), (97, "Gnoll"), (120, "Nerubian")]);
let d = restricted_server(&new, "83", &sha(&old));
write_snapshot(d.path(), &sha(&old), &catalog(&old).unwrap()).unwrap();
assert!(rebind_unchanged(d.path()).unwrap());
let conf = ConfFile::parse_bytes(&fs::read(d.path().join(CONF)).unwrap()).unwrap();
assert_eq!(conf.get(KEY), Some("\"83\""));
assert_eq!(
conf.get(CATALOG_KEY).map(|h| h.trim_matches('"').to_string()),
Some(sha(&new))
);
assert_eq!(conf.get("CoACustomRaces.Enable"), Some("1"));
assert!(!rebind_unchanged(d.path()).unwrap(), "already bound");
}
#[test]
fn a_renamed_race_or_unknown_catalog_waits_for_review() {
let old = catalog_of(&[(83, "Thin Human"), (97, "Gnoll")]);
let renamed = catalog_of(&[(83, "Forgotten"), (97, "Gnoll")]);
let d = restricted_server(&renamed, "83", &sha(&old));
write_snapshot(d.path(), &sha(&old), &catalog(&old).unwrap()).unwrap();
assert!(!rebind_unchanged(d.path()).unwrap());
let unknown = restricted_server(&renamed, "97", &"ab".repeat(32));
assert!(!rebind_unchanged(unknown.path()).unwrap());
// Nothing is restricted: nothing to bind.
let empty = restricted_server(&renamed, "", &sha(&old));
assert!(!rebind_unchanged(empty.path()).unwrap());
}
#[test]
fn the_shipped_catalogs_include_1_9_2_and_v2_with_stable_ids() {
let shipped: serde_json::Value = serde_json::from_str(SHIPPED_CATALOGS).unwrap();
let catalogs = shipped["catalogs"].as_object().unwrap();
let size = |c: &serde_json::Value| c.as_object().unwrap().len();
assert!(catalogs.values().any(|c| size(c) == 95), "1.9.2 has 95 races");
let v2: Vec<_> = catalogs.values().filter(|c| size(c) == 112).collect();
assert_eq!(v2.len(), 1, "V2 has 112 races");
for old in catalogs.values().filter(|c| size(c) == 95) {
for (id, name) in old.as_object().unwrap() {
assert_eq!(&v2[0][id], name, "race {id}");
}
}
}
#[test]
fn catalog_preserves_ids_and_excludes_stock_and_nonplayable() {
let mut bytes = dbc();
+639
View File
@@ -0,0 +1,639 @@
{
"catalogs": {
"0f9e05112d56609a87f0b1900be88f8130a8fcb24ee4acae585f1fd8d9144bf0": {
"1": "Human",
"10": "Blood Elf",
"100": "Drakonid",
"103": "Grummle",
"11": "Draenei",
"12": "Zandalari Troll",
"13": "Worgen",
"14": "High Elf",
"15": "Tuskarr",
"16": "Kul Tiran",
"17": "Taunka",
"18": "Vrykul",
"19": "Vulpera",
"2": "Orc",
"20": "Pandaren",
"21": "Naga",
"22": "Broken",
"23": "Fel Orc",
"24": "Forest Troll",
"25": "Ice Troll",
"26": "Skeleton",
"27": "Earthen",
"28": "Drakkari Troll",
"29": "Pandaren",
"3": "Dwarf",
"30": "Murloc",
"31": "Murloc",
"32": "Thin Human",
"33": "Thin Human",
"34": "Fel Orc",
"35": "Naga",
"36": "Broken",
"37": "Skeleton",
"38": "Vrykul",
"39": "Tuskarr",
"4": "Night Elf",
"40": "Forest Troll",
"41": "Taunka",
"42": "Northrend Skeleton",
"43": "Ice Troll",
"44": "Drakkari Troll",
"45": "Leper Troll",
"46": "Troglodyte",
"47": "Alpha Worgen",
"48": "Dark Iron Dwarf",
"49": "Mag'har Orc",
"5": "Undead",
"50": "Furbolg",
"51": "Undead Gnome",
"52": "Orc",
"53": "Ogre",
"54": "Dracthyr",
"55": "Eredar",
"56": "Harpy",
"57": "Alpha Goblin",
"58": "Dracthyr",
"59": "Void Elf",
"6": "Tauren",
"60": "Illidari Blood Elf",
"61": "Illidari Night Elf",
"62": "Lightforged Draenei",
"63": "Nightborne",
"65": "Test Race",
"66": "Highmountain Tauren",
"67": "Mechagnome",
"68": "Earthen",
"69": "Earthen",
"7": "Gnome",
"70": "Haranir",
"71": "Haranir",
"72": "Windshaper Skyborne",
"74": "Vulpera",
"77": "High Order Skyborne",
"78": "Jinyu",
"79": "Arakkoa",
"8": "Troll",
"80": "Darkfallen",
"81": "Darkfallen",
"82": "Sethrak",
"83": "Gnoll",
"9": "Goblin",
"97": "Saberon",
"98": "Drakonid",
"99": "Drakkin"
},
"358503359af5b05d16a76f61bab77b5c6221c792bcb0e11793eba8e279689ff7": {
"1": "Human",
"10": "Blood Elf",
"11": "Draenei",
"12": "Zandalari Troll",
"13": "Worgen",
"14": "High Elf",
"15": "Tuskarr",
"16": "Kul Tiran",
"17": "Taunka",
"18": "Vrykul",
"19": "Vulpera",
"2": "Orc",
"20": "Pandaren",
"21": "Naga",
"22": "Broken",
"23": "Fel Orc",
"24": "Forest Troll",
"25": "Ice Troll",
"26": "Skeleton",
"27": "Earthen",
"28": "Drakkari Troll",
"29": "Pandaren",
"3": "Dwarf",
"30": "Murloc",
"31": "Murloc",
"32": "Thin Human",
"33": "Thin Human",
"34": "Fel Orc",
"35": "Naga",
"36": "Broken",
"37": "Skeleton",
"38": "Vrykul",
"39": "Tuskarr",
"4": "Night Elf",
"40": "Forest Troll",
"41": "Taunka",
"42": "Northrend Skeleton",
"43": "Ice Troll",
"44": "Drakkari Troll",
"45": "Leper Troll",
"46": "Troglodyte",
"47": "Alpha Worgen",
"48": "Dark Iron Dwarf",
"49": "Mag'har Orc",
"5": "Undead",
"50": "Furbolg",
"51": "Undead Gnome",
"52": "Orc",
"53": "Ogre",
"54": "Dracthyr",
"55": "Eredar",
"56": "Harpy",
"57": "Alpha Goblin",
"58": "Dracthyr",
"59": "Void Elf",
"6": "Tauren",
"60": "Illidari Blood Elf",
"61": "Illidari Night Elf",
"62": "Lightforged Draenei",
"63": "Nightborne",
"65": "Test Race",
"66": "Highmountain Tauren",
"67": "Mechagnome",
"68": "Earthen",
"69": "Earthen",
"7": "Gnome",
"70": "Haranir",
"71": "Haranir",
"72": "Windshaper Skyborne",
"74": "Vulpera",
"77": "High Order Skyborne",
"78": "Jinyu",
"8": "Troll",
"80": "Darkfallen",
"81": "Darkfallen",
"82": "Sethrak",
"83": "Gnoll",
"9": "Goblin",
"97": "Saberon"
},
"6ad3ac1ad6ef7f32ed347e979cd1667bb5393d7a0967a859e5ba3cfa2a5d04c7": {
"1": "Human",
"10": "Blood Elf",
"100": "Drakonid",
"101": "Venthyr",
"102": "Centaur",
"103": "Grummle",
"104": "Slime Giant",
"106": "Mantid",
"107": "Kyrian",
"109": "Ethereal",
"11": "Draenei",
"110": "Sylvari",
"112": "Hozen",
"12": "Zandalari Troll",
"13": "Worgen",
"14": "High Elf",
"15": "Tuskarr",
"16": "Kul Tiran",
"17": "Taunka",
"18": "Vrykul",
"19": "Vulpera",
"2": "Orc",
"20": "Pandaren",
"21": "Naga",
"22": "Broken",
"23": "Fel Orc",
"24": "Forest Troll",
"25": "Ice Troll",
"26": "Skeleton",
"27": "Earthen",
"28": "Drakkari Troll",
"29": "Pandaren",
"3": "Dwarf",
"30": "Murloc",
"31": "Murloc",
"32": "Forgotten",
"33": "Forgotten",
"34": "Fel Orc",
"35": "Naga",
"36": "Broken",
"37": "Skeleton",
"38": "Vrykul",
"39": "Tuskarr",
"4": "Night Elf",
"40": "Forest Troll",
"41": "Taunka",
"42": "Northrend Skeleton",
"43": "Ice Troll",
"44": "Drakkari Troll",
"45": "Leper Troll",
"46": "Troglodyte",
"47": "Alpha Worgen",
"48": "Dark Iron Dwarf",
"49": "Mag'har Orc",
"5": "Undead",
"50": "Furbolg",
"51": "Undead Gnome",
"52": "Orc",
"53": "Ogre",
"54": "Dracthyr",
"55": "Eredar",
"56": "Harpy",
"57": "Alpha Goblin",
"58": "Dracthyr",
"59": "Void Elf",
"6": "Tauren",
"60": "Illidari Blood Elf",
"61": "Illidari Night Elf",
"62": "Lightforged Draenei",
"63": "Nightborne",
"65": "Test Race",
"66": "Highmountain Tauren",
"67": "Mechagnome",
"68": "Earthen",
"69": "Earthen",
"7": "Gnome",
"70": "Haranir",
"71": "Haranir",
"72": "Windshaper Skyborne",
"74": "Vulpera",
"75": "Centaur",
"77": "High Order Skyborne",
"78": "Jinyu",
"79": "Arakkoa",
"8": "Troll",
"80": "Darkfallen",
"81": "Darkfallen",
"82": "Sethrak",
"83": "Gnoll",
"87": "Faceless One",
"9": "Goblin",
"90": "Banshee",
"97": "Saberon",
"98": "Drakonid",
"99": "Drakkin"
},
"833e18c0f0550d400e78ee5db00bd65bf86d051861fe6b795c0539e3fd9f125d": {
"1": "Human",
"10": "Blood Elf",
"11": "Draenei",
"12": "Zandalari Troll",
"13": "Worgen",
"14": "High Elf",
"15": "Tuskarr",
"16": "Kul Tiran",
"17": "Taunka",
"18": "Vrykul",
"19": "Vulpera",
"2": "Orc",
"20": "Pandaren",
"21": "Naga",
"22": "Broken",
"23": "Fel Orc",
"24": "Forest Troll",
"25": "Ice Troll",
"26": "Skeleton",
"27": "Earthen",
"28": "Drakkari Troll",
"29": "Pandaren",
"3": "Dwarf",
"30": "Murloc",
"31": "Murloc",
"32": "Thin Human",
"33": "Thin Human",
"34": "Fel Orc",
"35": "Naga",
"36": "Broken",
"37": "Skeleton",
"38": "Vrykul",
"39": "Tuskarr",
"4": "Night Elf",
"40": "Forest Troll",
"41": "Taunka",
"42": "Northrend Skeleton",
"43": "Ice Troll",
"44": "Drakkari Troll",
"45": "Leper Troll",
"46": "Troglodyte",
"47": "Alpha Worgen",
"48": "Dark Iron Dwarf",
"49": "Mag'har Orc",
"5": "Undead",
"50": "Furbolg",
"51": "Undead Gnome",
"52": "Orc",
"53": "Ogre",
"54": "Dracthyr",
"55": "Eredar",
"56": "Harpy",
"57": "Alpha Goblin",
"58": "Dracthyr",
"59": "Void Elf",
"6": "Tauren",
"60": "Illidari Blood Elf",
"61": "Illidari Night Elf",
"62": "Lightforged Draenei",
"63": "Nightborne",
"65": "Test Race",
"66": "Highmountain Tauren",
"67": "Mechagnome",
"68": "Earthen",
"69": "Earthen",
"7": "Gnome",
"70": "Haranir",
"71": "Haranir",
"72": "Windshaper Skyborne",
"74": "Vulpera",
"77": "High Order Skyborne",
"8": "Troll",
"9": "Goblin"
},
"9a49163b9a330d844f0add5a2023f538b828bd5c57d6ecbb3cd5b4196930c5da": {
"1": "Human",
"10": "Blood Elf",
"103": "Grummle",
"11": "Draenei",
"12": "Zandalari Troll",
"13": "Worgen",
"14": "High Elf",
"15": "Tuskarr",
"16": "Kul Tiran",
"17": "Taunka",
"18": "Vrykul",
"19": "Vulpera",
"2": "Orc",
"20": "Pandaren",
"21": "Naga",
"22": "Broken",
"23": "Fel Orc",
"24": "Forest Troll",
"25": "Ice Troll",
"26": "Skeleton",
"27": "Earthen",
"28": "Drakkari Troll",
"29": "Pandaren",
"3": "Dwarf",
"30": "Murloc",
"31": "Murloc",
"32": "Thin Human",
"33": "Thin Human",
"34": "Fel Orc",
"35": "Naga",
"36": "Broken",
"37": "Skeleton",
"38": "Vrykul",
"39": "Tuskarr",
"4": "Night Elf",
"40": "Forest Troll",
"41": "Taunka",
"42": "Northrend Skeleton",
"43": "Ice Troll",
"44": "Drakkari Troll",
"45": "Leper Troll",
"46": "Troglodyte",
"47": "Alpha Worgen",
"48": "Dark Iron Dwarf",
"49": "Mag'har Orc",
"5": "Undead",
"50": "Furbolg",
"51": "Undead Gnome",
"52": "Orc",
"53": "Ogre",
"54": "Dracthyr",
"55": "Eredar",
"56": "Harpy",
"57": "Alpha Goblin",
"58": "Dracthyr",
"59": "Void Elf",
"6": "Tauren",
"60": "Illidari Blood Elf",
"61": "Illidari Night Elf",
"62": "Lightforged Draenei",
"63": "Nightborne",
"65": "Test Race",
"66": "Highmountain Tauren",
"67": "Mechagnome",
"68": "Earthen",
"69": "Earthen",
"7": "Gnome",
"70": "Haranir",
"71": "Haranir",
"72": "Windshaper Skyborne",
"74": "Vulpera",
"77": "High Order Skyborne",
"78": "Jinyu",
"79": "Arakkoa",
"8": "Troll",
"80": "Darkfallen",
"81": "Darkfallen",
"82": "Sethrak",
"83": "Gnoll",
"9": "Goblin",
"97": "Saberon"
},
"b78635b08bf0bd63d2898fce97c1fb162c8a9c41632703172eefa88bae79061f": {
"1": "Human",
"10": "Blood Elf",
"100": "Drakonid",
"101": "Venthyr",
"102": "Centaur",
"103": "Grummle",
"104": "Slime Giant",
"106": "Mantid",
"107": "Kyrian",
"109": "Ethereal",
"11": "Draenei",
"110": "Sylvari",
"112": "Hozen",
"12": "Zandalari Troll",
"13": "Worgen",
"14": "High Elf",
"15": "Tuskarr",
"16": "Kul Tiran",
"17": "Taunka",
"18": "Vrykul",
"19": "Vulpera",
"2": "Orc",
"20": "Pandaren",
"21": "Naga",
"22": "Broken",
"23": "Fel Orc",
"24": "Forest Troll",
"25": "Ice Troll",
"26": "Skeleton",
"27": "Earthen",
"28": "Drakkari Troll",
"29": "Pandaren",
"3": "Dwarf",
"30": "Murloc",
"31": "Murloc",
"32": "Forgotten",
"33": "Forgotten",
"34": "Fel Orc",
"35": "Naga",
"36": "Broken",
"37": "Skeleton",
"38": "Vrykul",
"39": "Tuskarr",
"4": "Night Elf",
"40": "Forest Troll",
"41": "Taunka",
"42": "Northrend Skeleton",
"43": "Ice Troll",
"44": "Drakkari Troll",
"45": "Leper Troll",
"46": "Troglodyte",
"47": "Alpha Worgen",
"48": "Dark Iron Dwarf",
"49": "Mag'har Orc",
"5": "Undead",
"50": "Furbolg",
"51": "Undead Gnome",
"52": "Orc",
"53": "Ogre",
"54": "Dracthyr",
"55": "Eredar",
"56": "Harpy",
"57": "Alpha Goblin",
"58": "Dracthyr",
"59": "Void Elf",
"6": "Tauren",
"60": "Illidari Blood Elf",
"61": "Illidari Night Elf",
"62": "Lightforged Draenei",
"63": "Nightborne",
"65": "Test Race",
"66": "Highmountain Tauren",
"67": "Mechagnome",
"68": "Earthen",
"69": "Earthen",
"7": "Gnome",
"70": "Haranir",
"71": "Haranir",
"72": "Windshaper Skyborne",
"74": "Vulpera",
"75": "Centaur",
"77": "High Order Skyborne",
"78": "Jinyu",
"79": "Arakkoa",
"8": "Troll",
"80": "Darkfallen",
"81": "Darkfallen",
"82": "Sethrak",
"83": "Gnoll",
"87": "Faceless One",
"9": "Goblin",
"90": "Banshee",
"97": "Saberon",
"98": "Drakonid",
"99": "Drakkin"
},
"bff09e612ba44567a5c7d928562d6261755504dc8948daa334e675bf49b54938": {
"1": "Human",
"10": "Blood Elf",
"100": "Drakonid",
"101": "Venthyr",
"102": "Centaur",
"103": "Grummle",
"104": "Slime Giant",
"105": "Gilgoblin",
"106": "Mantid",
"107": "Kyrian",
"109": "Ethereal",
"11": "Draenei",
"110": "Sylvari",
"111": "Sporeling",
"112": "Hozen",
"114": "Stormforged",
"118": "Elune's Chosen",
"119": "Mo'arg",
"12": "Zandalari Troll",
"120": "Nerubian",
"122": "Lich",
"123": "Mogu",
"125": "Lost One",
"13": "Worgen",
"14": "High Elf",
"15": "Tuskarr",
"16": "Kul Tiran",
"17": "Taunka",
"18": "Vrykul",
"19": "Vulpera",
"2": "Orc",
"20": "Pandaren",
"21": "Naga",
"22": "Broken",
"23": "Fel Orc",
"24": "Forest Troll",
"25": "Ice Troll",
"26": "Skeleton",
"27": "Earthen",
"28": "Drakkari Troll",
"29": "Pandaren",
"3": "Dwarf",
"30": "Murloc",
"31": "Murloc",
"32": "Forgotten",
"33": "Forgotten",
"34": "Fel Orc",
"35": "Naga",
"36": "Broken",
"37": "Skeleton",
"38": "Vrykul",
"39": "Tuskarr",
"4": "Night Elf",
"40": "Forest Troll",
"41": "Taunka",
"42": "Northrend Skeleton",
"43": "Ice Troll",
"44": "Drakkari Troll",
"45": "Leper Troll",
"46": "Troglodyte",
"47": "Alpha Worgen",
"48": "Dark Iron Dwarf",
"49": "Mag'har Orc",
"5": "Undead",
"50": "Furbolg",
"51": "Undead Gnome",
"52": "Orc",
"53": "Ogre",
"54": "Dracthyr",
"55": "Eredar",
"56": "Harpy",
"57": "Alpha Goblin",
"58": "Dracthyr",
"59": "Void Elf",
"6": "Tauren",
"60": "Illidari Blood Elf",
"61": "Illidari Night Elf",
"62": "Lightforged Draenei",
"63": "Nightborne",
"65": "Test Race",
"66": "Highmountain Tauren",
"67": "Mechagnome",
"68": "Earthen",
"69": "Earthen",
"7": "Gnome",
"70": "Haranir",
"71": "Haranir",
"72": "Windshaper Skyborne",
"74": "Vulpera",
"75": "Centaur",
"77": "High Order Skyborne",
"78": "Jinyu",
"79": "Arakkoa",
"8": "Troll",
"80": "Darkfallen",
"81": "Darkfallen",
"82": "Sethrak",
"83": "Gnoll",
"85": "Two-Headed Ogre",
"86": "Sureki",
"87": "Faceless One",
"88": "Qiraji",
"89": "Dreadlord",
"9": "Goblin",
"90": "Banshee",
"91": "Titan",
"92": "Wretched",
"93": "Fungarian",
"96": "Thin Human",
"97": "Saberon",
"98": "Drakonid",
"99": "Drakkin"
}
},
"schema": 1,
"source": "Corfirean/azerothcore-wotlk-coa modules/mod-coa-custom-races/data/dbc/ChrRaces.dbc"
}
+216
View File
@@ -0,0 +1,216 @@
//! The names players see in the realm list, chosen by the server owner.
//!
//! The launcher writes `acore_auth.realmlist.name` at every start, so a name typed into the database (or into
//! an old `manage.py`) did not last. The owner's choice lives in `Settings/realm-names.json` of the server's main
//! folder, keyed by realm id, and every start and every realm-list setup uses it; extra worlds read their main
//! folder's file.
use std::collections::BTreeMap;
use std::path::{Path, PathBuf};
use serde::{Deserialize, Serialize};
use crate::error::{Error, Result};
use crate::fsx;
const FILE: &str = "Settings/realm-names.json";
/// `acore_auth.realmlist.name` is `varchar(32)`.
pub const MAX_CHARS: usize = 32;
#[derive(Debug, Default, Serialize, Deserialize)]
struct Names {
#[serde(default)]
names: BTreeMap<u32, String>,
}
/// The folder that owns the names: an extra world (`<server>/.realms/<name>`) belongs to `<server>`.
fn main_folder(root: &Path) -> PathBuf {
if crate::launcher::settings::is_extra_world(root) {
if let Some(main) = root.parent().and_then(Path::parent) {
return main.to_path_buf();
}
}
root.to_path_buf()
}
fn read(root: &Path) -> Names {
let path = main_folder(root).join(FILE);
if !path.is_file() {
return Names::default();
}
match fsx::read_json(&path) {
Ok(names) => names,
Err(error) => {
tracing::warn!(%error, "realm names could not be read; the default names are used");
Names::default()
}
}
}
/// A trimmed name the realm list can hold: 1 to 32 characters, no control characters.
pub fn validate(name: &str) -> Result<String> {
let name = name.trim();
if name.is_empty() {
return Err(Error::Invalid("The realm name cannot be empty.".into()));
}
if name.chars().count() > MAX_CHARS {
return Err(Error::Invalid(format!(
"The realm name can have at most {MAX_CHARS} characters."
)));
}
// The game client stores the realm as `SET realmName "<name>"` in Config.wtf.
if name.chars().any(|c| c.is_control() || c == '"') {
return Err(Error::Invalid(
"The realm name cannot contain quotation marks or control characters.".into(),
));
}
Ok(name.to_string())
}
/// The owner's name for realm `id`, if one was chosen.
pub fn custom(root: &Path, id: u32) -> Option<String> {
read(root)
.names
.remove(&id)
.and_then(|name| validate(&name).ok())
}
/// The name realm `id` shows: the owner's choice, or `default`.
pub fn name_or(root: &Path, id: u32, default: &str) -> String {
custom(root, id).unwrap_or_else(|| default.to_string())
}
/// The name the realm of `mode` shows.
pub fn for_mode(root: &Path, mode: crate::realms::Mode) -> String {
name_or(root, mode.realm_id(), mode.label())
}
/// Every chosen name.
pub fn all(root: &Path) -> BTreeMap<u32, String> {
read(root)
.names
.into_iter()
.filter_map(|(id, name)| validate(&name).ok().map(|name| (id, name)))
.collect()
}
/// Choose a name for realm `id`; `None` (or an empty name) returns it to its default.
pub fn set(root: &Path, id: u32, name: Option<&str>) -> Result<Option<String>> {
let mut names = read(root);
let chosen = match name.map(str::trim).filter(|n| !n.is_empty()) {
Some(name) => Some(validate(name)?),
None => None,
};
match &chosen {
Some(name) => names.names.insert(id, name.clone()),
None => names.names.remove(&id),
};
fsx::atomic_write_json(&main_folder(root).join(FILE), &names)?;
Ok(chosen)
}
/// A realm of this server and the name it shows.
#[derive(Debug, Clone, Serialize, PartialEq, Eq)]
#[serde(rename_all = "camelCase")]
pub struct RealmName {
pub id: u32,
pub name: String,
pub default_name: String,
pub custom: bool,
}
/// The realms of a server with their names: Conquest of Azeroth (or the plain repack's "AzerothCore") and the
/// Wildcard and Warcraft Reborn realms that were created.
pub fn list(root: &Path) -> Result<Vec<RealmName>> {
let main = main_folder(root);
let mut realms: Vec<(u32, &'static str)> = Vec::new();
if main.join("Settings/realm-profile.json").exists() {
let state = crate::realms::state(&main)?;
realms.extend(state.modes().into_iter().map(|m| (m.realm_id(), m.label())));
} else {
realms.push((1, "AzerothCore"));
}
realms.sort_unstable();
realms.dedup();
Ok(realms
.into_iter()
.map(|(id, default)| {
let custom = custom(&main, id);
RealmName {
id,
name: custom.clone().unwrap_or_else(|| default.to_string()),
default_name: default.to_string(),
custom: custom.is_some(),
}
})
.collect())
}
/// Choose a name and, when the database runs, write it to the realm list at once (the auth server shows it
/// within its realm refresh interval). Returns the realms with their names.
pub fn rename(root: &Path, id: u32, name: Option<&str>) -> Result<Vec<RealmName>> {
let main = main_folder(root);
let known = list(&main)?;
let realm = known
.iter()
.find(|r| r.id == id)
.ok_or_else(|| Error::Invalid(format!("This server has no realm {id}.")))?;
let shown = set(&main, id, name)?.unwrap_or_else(|| realm.default_name.clone());
crate::backup::with_running_database(&main, |db| {
db.query(&format!(
"UPDATE acore_auth.realmlist SET name={} WHERE id={id};",
sql_literal(&shown)
))
.map(|_| ())
})?;
list(&main)
}
/// `text` as a MySQL string literal (quotes and backslashes escaped).
pub fn sql_literal(text: &str) -> String {
let mut out = String::with_capacity(text.len() + 2);
out.push('\'');
for c in text.chars() {
match c {
'\'' => out.push_str("''"),
'\\' => out.push_str("\\\\"),
c => out.push(c),
}
}
out.push('\'');
out
}
#[cfg(test)]
mod tests {
use super::*;
#[test]
fn names_are_validated_trimmed_and_reset() {
let d = tempfile::tempdir().unwrap();
assert_eq!(name_or(d.path(), 1, "Conquest of Azeroth"), "Conquest of Azeroth");
assert_eq!(set(d.path(), 1, Some(" Owner's Realm ")).unwrap().as_deref(), Some("Owner's Realm"));
assert_eq!(name_or(d.path(), 1, "x"), "Owner's Realm");
assert!(set(d.path(), 2, Some(&"a".repeat(33))).is_err());
assert!(set(d.path(), 2, Some("bad\nname")).is_err());
assert_eq!(set(d.path(), 2, Some("Царство")).unwrap().as_deref(), Some("Царство"));
assert_eq!(all(d.path()).len(), 2);
assert_eq!(set(d.path(), 1, Some(" ")).unwrap(), None);
assert_eq!(name_or(d.path(), 1, "Conquest of Azeroth"), "Conquest of Azeroth");
}
#[test]
fn an_extra_world_reads_its_main_folders_names() {
let d = tempfile::tempdir().unwrap();
set(d.path(), 2, Some("Wild Side")).unwrap();
let extra = d.path().join(".realms/secondary");
std::fs::create_dir_all(&extra).unwrap();
assert_eq!(custom(&extra, 2).as_deref(), Some("Wild Side"));
}
#[test]
fn names_are_safe_in_sql() {
assert_eq!(sql_literal(r"O'Neil \ realm"), r"'O''Neil \\ realm'");
}
}
+42 -251
View File
@@ -185,8 +185,20 @@ pub fn view(root: &Path) -> Result<View> {
}
pub fn guard_module(root: &Path, id: &str) -> Result<()> {
if state(root)?.active != Mode::Coa && matches!(id, "companions" | "playerbots") {
return Err(Error::Invalid("Bot class mechanics have not been validated for this realm. This module is unavailable on this realm.".into()));
let s = state(root)?;
if matches!(id, "companions" | "playerbots") {
if let Ok(v) = view(root) {
if s.active == Mode::Wildcard && !v.supported {
return Err(Error::Invalid(
"The installed server binary does not support Wildcard mode.".into(),
));
}
if s.active == Mode::Reborn && !v.reborn_supported {
return Err(Error::Invalid(
"The installed server binary does not support Warcraft Reborn mode.".into(),
));
}
}
}
Ok(())
}
@@ -296,20 +308,14 @@ fn wildcard_configs(mut files: Files) -> Result<Files> {
}
}
}
for (key, value) in [("CoaBots.Enable", "0"), ("CoaBots.AutoLoginOnStartup", "0")] {
set(
&mut files,
"Core/configs/modules/mod_coa_playerbots.conf",
key,
value,
)?;
// Preserve existing CoaBots.Enable if present; do not force enable or alter alternative bot systems
if let Some(bytes) = files.get("Core/configs/modules/mod_coa_playerbots.conf") {
if let Ok(conf) = ConfFile::parse_bytes(bytes) {
if conf.get("CoaBots.Enable") == Some("1") {
set(&mut files, "Core/configs/modules/mod_coa_playerbots.conf", "CoaBots.Enable", "1")?;
}
}
}
set(
&mut files,
"Core/configs/modules/playerbots.conf",
"AiPlayerbot.Enabled",
"0",
)?;
Ok(files)
}
@@ -337,20 +343,14 @@ fn reborn_configs(mut files: Files) -> Result<Files> {
set(&mut files, path, "RealmID", "3")?;
}
}
for (key, value) in [("CoaBots.Enable", "0"), ("CoaBots.AutoLoginOnStartup", "0")] {
set(
&mut files,
"Core/configs/modules/mod_coa_playerbots.conf",
key,
value,
)?;
// Preserve existing CoaBots.Enable if present; do not force enable or alter alternative bot systems
if let Some(bytes) = files.get("Core/configs/modules/mod_coa_playerbots.conf") {
if let Ok(conf) = ConfFile::parse_bytes(bytes) {
if conf.get("CoaBots.Enable") == Some("1") {
set(&mut files, "Core/configs/modules/mod_coa_playerbots.conf", "CoaBots.Enable", "1")?;
}
}
}
set(
&mut files,
"Core/configs/modules/playerbots.conf",
"AiPlayerbot.Enabled",
"0",
)?;
Ok(files)
}
@@ -534,8 +534,6 @@ pub fn ensure_created(root: &Path, mode: Mode) -> Result<()> {
"Update the server to a build with Warcraft Reborn support first.".into(),
));
}
// Verify launcher support before creating databases, as selecting a realm does.
prepare_launcher(root)?;
let before = configs(root)?;
create_realm(root, &mut s, mode, &before)
}
@@ -565,8 +563,6 @@ pub fn select(root: &Path, mode: Mode) -> Result<View> {
"Disable the realms that start together before switching realms.".into(),
));
}
// Verify launcher support before creating databases or changing the selected realm.
prepare_launcher(root)?;
let before = configs(root)?;
fsx::atomic_write_json(&snapshot(root, s.active), &before)?;
create_realm(root, &mut s, mode, &before)?;
@@ -608,125 +604,6 @@ pub fn select(root: &Path, mode: Mode) -> Result<View> {
view(root)
}
/// Adapt the bundled launcher's canonical schema and realm choices without changing its supervision logic.
pub fn prepare_launcher(root: &Path) -> Result<()> {
// A Docker server has no launcher to adapt: the Docker backend reads the active realm itself.
if crate::docker::is_docker(root) {
return Ok(());
}
let path = root.join("Scripts/manage.py");
let source = fs::read_to_string(&path)?;
let patched = patch_launcher(&source)?;
if patched != source {
fsx::atomic_write(&path, patched.as_bytes())?;
// A Manager-owned transformation is still pristine for subsequent updates and file checks.
if let Ok(dir) = crate::registry::metadata_dir_for(root) {
if let Ok((_, mut meta)) = crate::registry::MetaDir::open(&dir) {
if meta
.original_hashes
.get("Scripts/manage.py")
.is_some_and(|hash| hash == &fsx::sha256_bytes(source.as_bytes()))
{
meta.original_hashes.insert(
"Scripts/manage.py".into(),
fsx::sha256_bytes(patched.as_bytes()),
);
fsx::atomic_write_json(&dir.join("install.json"), &meta)?;
}
}
}
}
Ok(())
}
const LAUNCHER_REALM_REPLACEMENTS: &[(&str, &str)] = &[
("(\"WorldDatabaseInfo\", \"acore_world\")", "(\"WorldDatabaseInfo\", \"acore_world_wildcard\" if coa_realm() == 'wildcard' else \"acore_world\")"),
("(\"CharacterDatabaseInfo\", \"acore_characters\")", "(\"CharacterDatabaseInfo\", \"acore_characters_wildcard\" if coa_realm() == 'wildcard' else \"acore_characters\")"),
("SET name='AzerothCore',address=", "SET name='{coa_realm_name()}',address="),
("WHERE id=1;", "WHERE id={coa_realm_id()};"),
("mysql(\"UPDATE acore_auth.realmlist SET flag=0", "mysql(f\"UPDATE acore_auth.realmlist SET flag=0"),
];
const LAUNCHER_REALM_INSERT: &str = "# coa-manager-realm-profiles-v1\ndef coa_realm():\n path = ROOT / 'Settings/realm-profile.json'\n return json.loads(path.read_text(encoding='utf-8')).get('active', 'coa') if path.exists() else 'coa'\n\ndef coa_realm_id():\n return 2 if coa_realm() == 'wildcard' else 1\n\ndef coa_realm_name():\n return 'Wildcard' if coa_realm() == 'wildcard' else 'Conquest of Azeroth'\n\n";
fn launcher_insert() -> String {
LAUNCHER_REALM_INSERT
.replace("profiles-v1", "profiles-v2")
.replace(
"return 2 if",
"return 3 if coa_realm() == 'reborn' else 2 if",
)
.replace(
"return 'Wildcard' if",
"return 'Warcraft Reborn' if coa_realm() == 'reborn' else 'Wildcard' if",
)
}
fn launcher_replacements() -> Vec<(&'static str, String)> {
LAUNCHER_REALM_REPLACEMENTS.iter().map(|(from, to)| (*from, to
.replace("\"acore_world_wildcard\" if", "\"acore_world_reborn\" if coa_realm() == 'reborn' else \"acore_world_wildcard\" if")
.replace("\"acore_characters_wildcard\" if", "\"acore_characters_reborn\" if coa_realm() == 'reborn' else \"acore_characters_wildcard\" if"))).collect()
}
pub(crate) fn patch_launcher(source: &str) -> Result<String> {
if source.contains("# coa-manager-realm-profiles-v2") {
return Ok(source.into());
}
if source.contains("# coa-manager-realm-profiles-v1") {
let original = unpatch_launcher(source)
.ok_or_else(|| Error::Invalid("Unrecognised realm launcher patch.".into()))?;
return patch_launcher(&original);
}
let mut out = source.to_string();
for (from, to) in launcher_replacements() {
if !out.contains(from) {
return Err(Error::Invalid(
"This launcher does not support realm profiles. Update the server package first."
.into(),
));
}
out = out.replace(from, &to);
}
// Insert before the entry point so ROOT, json and functions are all defined when called.
let marker = "if __name__ == \"__main__\":";
if !out.contains(marker) {
return Err(Error::Invalid(
"Unrecognised server launcher entry point.".into(),
));
}
Ok(out.replace(marker, &format!("{}{marker}", launcher_insert())))
}
/// Reverse only our exact realm transformation; callers must verify the recovered original hash.
pub(crate) fn unpatch_launcher(source: &str) -> Option<String> {
let (insert, replacements) = if source.contains(&launcher_insert()) {
(launcher_insert(), launcher_replacements())
} else if source.contains(LAUNCHER_REALM_INSERT) {
(
LAUNCHER_REALM_INSERT.into(),
LAUNCHER_REALM_REPLACEMENTS
.iter()
.map(|(a, b)| (*a, b.to_string()))
.collect(),
)
} else {
return None;
};
let mut original = source.replacen(&insert, "", 1);
for (from, to) in &replacements {
original = original.replace(to, from);
}
let mut check = original.clone();
for (from, to) in &replacements {
check = check.replace(from, to);
}
check = check.replace(
"if __name__ == \"__main__\":",
&format!("{insert}if __name__ == \"__main__\":"),
);
(check == source).then_some(original)
}
/// The character-creation model the world server advertises for a realm. Every realm has its own database and its own
/// entry on Overview, so it advertises exactly one model: a list such as `"coa wcr"` would let players create
/// Warcraft Reborn characters in the Conquest of Azeroth realm.
@@ -770,7 +647,6 @@ pub fn before_start(root: &Path) -> Result<()> {
if !root.join(STATE).exists() {
return Ok(());
}
prepare_launcher(root)?;
if s.simultaneous && !view(root)?.supported {
return Err(Error::Invalid(
"The installed server build does not support simultaneous Wildcard startup.".into(),
@@ -805,19 +681,7 @@ pub fn before_start(root: &Path) -> Result<()> {
"The installed server build does not support Wildcard.".into(),
));
}
let path = root.join("Core/configs/modules/mod_coa_playerbots.conf");
let mut conf = ConfFile::parse_bytes(&fs::read(&path)?)?;
conf.set("CoaBots.Enable", "0", &[]);
fsx::atomic_write(&path, conf.to_text().as_bytes())?;
let path = root.join("Core/configs/modules/playerbots.conf");
let bytes = if path.exists() {
fs::read(&path)?
} else {
b"[worldserver]\n".to_vec()
};
let mut conf = ConfFile::parse_bytes(&bytes)?;
conf.set("AiPlayerbot.Enabled", "0", &[]);
fsx::atomic_write(&path, conf.to_text().as_bytes())?;
// Multi-realm Playerbots 1.0: bots are supported and enabled on all realms
}
Ok(())
}
@@ -831,8 +695,8 @@ pub fn setup_realmlist(root: &Path) -> Result<()> {
let port = layout::read_ports(root).world;
for mode in s.modes().into_iter().filter(|m| *m != Mode::Coa) {
let id = mode.realm_id();
let name = mode.label();
db.query(&format!("INSERT INTO acore_auth.realmlist (id,name,address,localAddress,localSubnetMask,port,icon,flag,timezone,gamebuild) SELECT {id},'{name}',address,localAddress,localSubnetMask,{port},icon,2,timezone,gamebuild FROM acore_auth.realmlist WHERE id=1 ON DUPLICATE KEY UPDATE port={port};"))?;
let name = crate::realm_names::sql_literal(&crate::realm_names::name_or(root, id, mode.label()));
db.query(&format!("INSERT INTO acore_auth.realmlist (id,name,address,localAddress,localSubnetMask,port,icon,flag,timezone,gamebuild) SELECT {id},{name},address,localAddress,localSubnetMask,{port},icon,2,timezone,gamebuild FROM acore_auth.realmlist WHERE id=1 ON DUPLICATE KEY UPDATE port={port},name={name};"))?;
}
let ids = s
.modes()
@@ -937,11 +801,12 @@ mod tests {
.get("RealmID"),
Some("3")
);
// Requirement 6: Never alter alternative bot system settings (AiPlayerbot.Enabled) without explicit user choice
assert_eq!(
ConfFile::parse_bytes(&reborn["Core/configs/modules/playerbots.conf"])
.unwrap()
.get("AiPlayerbot.Enabled"),
Some("0")
Some("1")
);
write_configs(t.path(), &reborn).unwrap();
write_configs(t.path(), &coa).unwrap();
@@ -955,8 +820,8 @@ mod tests {
},
)
.unwrap();
assert!(guard_module(t.path(), "companions").is_err());
assert!(guard_module(t.path(), "playerbots").is_err());
assert!(guard_module(t.path(), "companions").is_ok());
assert!(guard_module(t.path(), "playerbots").is_ok());
assert!(guard_module(t.path(), "content-scaling").is_ok());
}
@@ -1107,26 +972,6 @@ CoA.GameModeMask = 0
assert!(!v.supported);
}
#[test]
fn old_launcher_upgrades_and_both_patch_versions_are_reversible() {
let original = "(\"WorldDatabaseInfo\", \"acore_world\")\n(\"CharacterDatabaseInfo\", \"acore_characters\")\nSET name='AzerothCore',address=\nWHERE id=1;\nmysql(\"UPDATE acore_auth.realmlist SET flag=0\nif __name__ == \"__main__\":\n";
let mut old = original.to_string();
for (from, to) in LAUNCHER_REALM_REPLACEMENTS {
old = old.replace(from, to);
}
old = old.replace(
"if __name__ == \"__main__\":",
&format!("{LAUNCHER_REALM_INSERT}if __name__ == \"__main__\":"),
);
assert_eq!(unpatch_launcher(&old).as_deref(), Some(original));
let new = patch_launcher(&old).unwrap();
assert!(new.contains("acore_world_reborn"));
assert!(new.contains("return 3 if coa_realm() == 'reborn'"));
assert!(new.contains("return 'Warcraft Reborn' if"));
assert_eq!(patch_launcher(&new).unwrap(), new);
assert_eq!(unpatch_launcher(&new).as_deref(), Some(original));
}
#[test]
fn a_docker_server_is_checked_for_wildcard_support_in_its_own_binary() {
let d = tempfile::tempdir().unwrap();
@@ -1157,20 +1002,6 @@ CoA.GameModeMask = 0
assert!(view(d.path()).unwrap().supported);
}
#[test]
fn a_docker_server_has_no_launcher_to_adapt() {
let d = tempfile::tempdir().unwrap();
fs::create_dir_all(d.path().join("Settings")).unwrap();
// No Scripts/manage.py anywhere: on a repack this fails, on a Docker server there is nothing to do.
assert!(prepare_launcher(d.path()).is_err());
fs::write(
d.path().join("Settings/docker.json"),
br#"{"project":"t1"}"#,
)
.unwrap();
prepare_launcher(d.path()).unwrap();
}
#[test]
fn fresh_wildcard_disables_bots_and_preserves_scaling() {
let mut f = Files::new();
@@ -1178,6 +1009,10 @@ CoA.GameModeMask = 0
"Core/configs/modules/mod-coa-content-scaling.conf".into(),
b"[worldserver]\nCoAContentScaling.Enable = 1\n".to_vec(),
);
f.insert(
"Core/configs/modules/mod_coa_playerbots.conf".into(),
b"[worldserver]\nCoaBots.Enable = 1\n".to_vec(),
);
f.insert(
"Settings/worldserver.conf.template".into(),
b"[worldserver]\nRealmID = 1\n".to_vec(),
@@ -1188,7 +1023,7 @@ CoA.GameModeMask = 0
f["Core/configs/modules/mod-coa-content-scaling.conf"]
);
let c = ConfFile::parse_bytes(&w["Core/configs/modules/mod_coa_playerbots.conf"]).unwrap();
assert_eq!(c.get("CoaBots.Enable"), Some("0"));
assert_eq!(c.get("CoaBots.Enable"), Some("1"));
assert_eq!(
ConfFile::parse_bytes(&w["Settings/worldserver.conf.template"])
.unwrap()
@@ -1260,52 +1095,8 @@ CoA.GameModeMask = 0
},
)
.unwrap();
assert!(crate::modules::set_enabled(t.path(), t.path(), "companions", true).is_err());
assert!(crate::config::save(
t.path(),
t.path(),
crate::config::Scope::Bots,
&BTreeMap::new()
)
.is_err());
assert!(guard_module(t.path(), "companions").is_ok());
assert!(guard_module(t.path(), "playerbots").is_ok());
assert!(guard_module(t.path(), "content-scaling").is_ok());
}
#[test]
fn unknown_launcher_is_refused_without_partial_patching() {
assert!(patch_launcher("print('custom launcher')").is_err());
}
#[test]
fn managed_launcher_patch_remains_pristine_but_external_edits_conflict() {
let d = tempfile::tempdir().unwrap();
let root = d.path().join("server");
let source = "(\"WorldDatabaseInfo\", \"acore_world\")\n(\"CharacterDatabaseInfo\", \"acore_characters\")\nSET name='AzerothCore',address=\nWHERE id=1;\nmysql(\"UPDATE acore_auth.realmlist SET flag=0\nif __name__ == \"__main__\":\n";
fsx::atomic_write(&root.join("Scripts/manage.py"), source.as_bytes()).unwrap();
let mut meta = crate::registry::InstallMeta::new(crate::registry::InstallKind::New, &root);
meta.original_hashes.insert(
"Scripts/manage.py".into(),
fsx::sha256_bytes(source.as_bytes()),
);
let dir = crate::registry::MetaDir::create(&root, &meta).unwrap();
prepare_launcher(&root).unwrap();
let (_, meta) = crate::registry::MetaDir::open(&dir.root).unwrap();
assert!(crate::diag::verify_managed(&root, &meta).is_empty());
let manifest: crate::manifest::Manifest = serde_json::from_value(serde_json::json!({
"schema": 1, "kind": "update", "version": "2.0.0", "core": {"commit": null}, "builtAt": "fixture", "minManagerVersion": "0.1.0",
"files": [{"path":"Scripts/manage.py","sha256":fsx::sha256_bytes(b"next release"),"size":12,"owner":"core","policy":"replace"}]
})).unwrap();
assert_eq!(
crate::update::plan(&root, &meta, &manifest, &BTreeMap::new(), None).unwrap()[0].action,
crate::update::Action::Replace
);
let mut modified = fs::read(root.join("Scripts/manage.py")).unwrap();
modified.extend_from_slice(b"# custom edit\n");
fsx::atomic_write(&root.join("Scripts/manage.py"), &modified).unwrap();
prepare_launcher(&root).unwrap();
assert_eq!(
crate::update::plan(&root, &meta, &manifest, &BTreeMap::new(), None).unwrap()[0].action,
crate::update::Action::Conflict
);
}
}
+14
View File
@@ -7,6 +7,10 @@ use std::path::{Path, PathBuf};
pub struct Profile {
pub host: String,
pub client_path: Option<String>,
/// The listed server `host` belongs to, when the player joined it through the server list: its account is
/// filled into the game's login box at every Play.
#[serde(default, skip_serializing_if = "Option::is_none")]
pub realm: Option<String>,
}
pub fn load(dir: &Path) -> Result<Profile> {
@@ -43,12 +47,21 @@ pub fn save(dir: &Path, profile: &Profile) -> Result<()> {
#[cfg(test)]
mod tests {
use super::*;
#[test]
fn a_profile_from_before_the_realm_field_still_loads() {
let d = tempfile::tempdir().unwrap();
std::fs::write(d.path().join("connection.json"), br#"{"host":"1.2.3.4","client_path":null}"#).unwrap();
let p = load(d.path()).unwrap();
assert_eq!((p.host.as_str(), p.realm), ("1.2.3.4", None));
}
#[test]
fn connection_needs_no_server_and_survives_restart() {
let dir = tempfile::tempdir().unwrap();
let profile = Profile {
host: "192.168.1.10".into(),
client_path: None,
realm: None,
};
save(dir.path(), &profile).unwrap();
assert_eq!(load(dir.path()).unwrap().host, profile.host);
@@ -70,6 +83,7 @@ mod tests {
let profile = Profile {
host: "192.168.1.10".into(),
client_path: Some(game.to_string_lossy().into()),
realm: None,
};
save(dir.path(), &profile).unwrap();
assert!(
+8 -8
View File
@@ -403,7 +403,7 @@ pub fn plan(
match (fs::read_to_string(tree.join(&f.path)), fs::read(&target)) {
(Ok(signed), Ok(actual)) => {
fsx::sha256_bytes(signed.as_bytes()) == f.sha256
&& crate::driver::launcher_matches(&signed, &actual)
&& crate::legacy_launcher::launcher_matches(&signed, &actual)
}
_ => false,
}
@@ -418,7 +418,7 @@ pub fn plan(
let manager_launcher = f.path == "Scripts/manage.py"
&& recorded.is_some_and(|hash| {
fs::read(&target).is_ok_and(|bytes| {
crate::driver::launcher_matches_recorded(hash, &bytes)
crate::legacy_launcher::launcher_matches_recorded(hash, &bytes)
})
});
if f.path == "Core/worldserver.exe"
@@ -614,7 +614,7 @@ fn launcher_already_integrated(
if meta.original_hashes.get(&file.path) != Some(&fsx::sha256_bytes(&actual)) {
return Ok(false);
}
Ok(crate::driver::launcher_matches_recorded(
Ok(crate::legacy_launcher::launcher_matches_recorded(
&file.sha256,
&actual,
))
@@ -968,7 +968,7 @@ fn finish(
fs::read_to_string(tree.join(&op.path)),
fs::read(root.join(&op.path)),
) {
(Ok(signed), Ok(actual)) if crate::driver::launcher_matches(&signed, &actual) => {
(Ok(signed), Ok(actual)) if crate::legacy_launcher::launcher_matches(&signed, &actual) => {
fsx::sha256_bytes(&actual)
}
_ => op.new_sha256.clone(),
@@ -1060,7 +1060,7 @@ pub fn retry_validation(
&& fs::read_to_string(dir.join("tree").join(&op.path))
.ok()
.filter(|s| fsx::sha256_bytes(s.as_bytes()) == file.sha256)
.is_some_and(|s| crate::driver::launcher_matches(&s, &bytes));
.is_some_and(|s| crate::legacy_launcher::launcher_matches(&s, &bytes));
if actual != file.sha256 && !launcher {
return Err(Error::Invalid(format!(
"{} changed since the update was applied; use repair or rollback.",
@@ -2347,9 +2347,9 @@ mod tests {
fn legacy_launcher_world(import_patch: bool) -> World {
let w = world(&[("Scripts/manage.py", b"new release launcher")], false);
let mut source = crate::realms::patch_launcher(LEGACY_LAUNCHER).unwrap();
let mut source = crate::legacy_launcher::patch_launcher(LEGACY_LAUNCHER).unwrap();
if import_patch {
source = crate::driver::patch_launcher_imports(&source).unwrap();
source = crate::legacy_launcher::patch_launcher_imports(&source).unwrap();
}
write(&w.root, "Scripts/manage.py", source.as_bytes());
let (_, mut meta) = MetaDir::open(&w.meta).unwrap();
@@ -2576,7 +2576,7 @@ mod tests {
let w = world(&[("Scripts/manage.py", source)], false);
run(&w, &Fake::ok(), BTreeMap::new(), None).unwrap();
let integrated =
crate::driver::patch_launcher_imports(std::str::from_utf8(source).unwrap()).unwrap();
crate::legacy_launcher::patch_launcher_imports(std::str::from_utf8(source).unwrap()).unwrap();
write(&w.root, "Scripts/manage.py", integrated.as_bytes());
let (_, mut meta) = MetaDir::open(&w.meta).unwrap();
meta.original_hashes.insert(
+15
View File
@@ -0,0 +1,15 @@
[package]
name = "coa-launcher"
description = "The CoA repack launcher (Start_All_Server.bat and friends) without Python"
version.workspace = true
edition.workspace = true
license.workspace = true
[[bin]]
name = "coa-launcher"
path = "src/main.rs"
[dependencies]
coa-core = { path = "../coa-core" }
serde_json = "1"
windows-sys = { version = "0.60", features = ["Win32_Foundation", "Win32_System_Console"] }
+222
View File
@@ -0,0 +1,222 @@
//! `coa-launcher.exe`: the repack launcher, the same commands as `Scripts/manage.py`.
//!
//! It lives in `<server>/Scripts/` next to manage.py (the server folder is its parent), or takes `--root <folder>`.
//! Errors are printed as `ERROR: <message>` on stderr with exit code 1, exactly like manage.py, because the
//! Manager reads them.
use std::io::{BufRead, Write};
use std::path::{Path, PathBuf};
use std::time::Duration;
use coa_core::launcher::ops::{self, Action};
use coa_core::launcher::{services, settings::Settings, state, world};
const ACTIONS: [&str; 18] = [
"start-all", "start-mysql", "start-auth", "start-world", "stop-all", "force-stop-all", "status", "status-json", "create-account",
"create-account-once", "console", "ra-once", "prepare", "watch-world", "relay-worker", "debug-logs-on",
"debug-logs-off", "debug-logs-status",
];
fn say(text: &str) {
println!("{text}");
let _ = std::io::stdout().flush();
}
fn usage() -> String {
format!("usage: coa-launcher [--root <server>] [--port-offset N] {{{}}}", ACTIONS.join(","))
}
struct Args {
root: PathBuf,
offset: i32,
action: String,
}
fn parse() -> Result<Args, String> {
let mut root: Option<PathBuf> = None;
let mut offset = 0;
let mut action = None;
let mut it = std::env::args().skip(1);
while let Some(a) = it.next() {
match a.as_str() {
"--root" => root = Some(PathBuf::from(it.next().ok_or_else(usage)?)),
"--port-offset" => offset = it.next().and_then(|v| v.parse().ok()).ok_or_else(usage)?,
_ if ACTIONS.contains(&a.as_str()) && action.is_none() => action = Some(a),
_ => return Err(usage()),
}
}
let root = match root {
Some(r) => r,
None => {
// <server>/Scripts/coa-launcher.exe -> <server>
let exe = std::env::current_exe().map_err(|e| e.to_string())?;
exe.parent().and_then(Path::parent).map(Path::to_path_buf).ok_or("cannot find the server folder")?
}
};
Ok(Args { root, offset, action: action.ok_or_else(usage)? })
}
fn read_line(prompt: &str) -> std::io::Result<String> {
print!("{prompt}");
std::io::stdout().flush()?;
let mut line = String::new();
std::io::stdin().lock().read_line(&mut line)?;
Ok(line.trim_end_matches(['\r', '\n']).to_string())
}
/// Read a line without showing it (passwords).
fn read_secret(prompt: &str) -> std::io::Result<String> {
#[cfg(windows)]
unsafe {
use windows_sys::Win32::System::Console::{GetConsoleMode, GetStdHandle, SetConsoleMode, ENABLE_ECHO_INPUT, STD_INPUT_HANDLE};
let h = GetStdHandle(STD_INPUT_HANDLE);
let mut mode = 0;
if GetConsoleMode(h, &mut mode) != 0 {
SetConsoleMode(h, mode & !ENABLE_ECHO_INPUT);
let line = read_line(prompt);
SetConsoleMode(h, mode);
println!();
return line;
}
}
read_line(prompt)
}
fn valid_login(text: &str) -> bool {
(1..=16).contains(&text.len()) && text.bytes().all(|b| b.is_ascii_alphanumeric())
}
fn ra(cfg: &Settings, root: &Path, command: &str) -> Result<String, String> {
if !services::ready(root, "world", cfg.ra_port) {
return Err("Start this repack's worldserver first.".into());
}
let mut console = coa_core::ra::Ra::connect_to(cfg.ra_port, &cfg.ra_username, &cfg.ra_password).map_err(|e| e.to_string())?;
console.run(command).map_err(|e| e.to_string())
}
fn run(args: Args) -> Result<(), String> {
let root = args.root.as_path();
let e = |x: coa_core::Error| x.to_string();
match args.action.as_str() {
"watch-world" => {
let me = std::env::current_exe().map_err(|x| x.to_string())?;
return world::watch_world(root, Some(&me), args.offset, &|m| say(m)).map_err(e);
}
"relay-worker" => return coa_core::launcher::relay::worker(root).map_err(e),
"debug-logs-status" => {
let on = services::status(root)["debugLogs"].as_bool().unwrap_or(false);
say(&format!("Detailed server logging is {}.", if on { "ON" } else { "off" }));
if on {
say("Every AzerothCore logger is forced to Trace level in Core/Logs (Server.log, Auth.log, world-console.log, auth-console.log). Expect much larger, faster-growing log files.");
}
say("Run Debug_Logs_On.bat / Debug_Logs_Off.bat, then restart the affected service(s) to apply.");
return Ok(());
}
"debug-logs-on" | "debug-logs-off" => {
let on = args.action == "debug-logs-on";
let changed = {
let _lock = state::ControlLock::acquire(root, &args.action, Duration::from_secs(30), &|m| say(m)).map_err(e)?;
world::debug_logs(root, on).map_err(e)?
};
if changed.is_empty() {
say(&format!("Detailed logging was already {}.", if on { "on" } else { "off" }));
} else {
say(&format!("{} detailed logging in: {}", if on { "Enabled" } else { "Restored" }, changed.join(", ")));
}
say("Restart the affected service(s) (Stop_All_Server.bat then Start_All_Server.bat) to apply this.");
return Ok(());
}
_ => {}
}
let cfg = Settings::load(root, args.offset).map_err(e)?;
match args.action.as_str() {
"console" => {
say("World console. Enter a server command, or exit to close this window.");
loop {
let command = read_line("AC> ").map_err(|x| x.to_string())?;
let command = command.trim();
if command.eq_ignore_ascii_case("exit") || command.eq_ignore_ascii_case("quit") {
return Ok(());
}
if !command.is_empty() {
say(&ra(&cfg, root, command)?);
}
}
}
"create-account" => {
let name = read_line("New account name (letters and digits, up to 16): ").map_err(|x| x.to_string())?;
let name = name.trim();
let password = read_secret("New account password (letters and digits, up to 16): ").map_err(|x| x.to_string())?;
let again = read_secret("Repeat password: ").map_err(|x| x.to_string())?;
if !valid_login(name) || !valid_login(&password) {
return Err("Use 1-16 letters or digits for the account name and password.".into());
}
if password != again {
return Err("Passwords do not match.".into());
}
say(&ra(&cfg, root, &format!("account create {name} {password}"))?);
if read_line("Give this account GM permissions? [y/N]: ").map_err(|x| x.to_string())?.trim().eq_ignore_ascii_case("y") {
say(&ra(&cfg, root, &format!("account set gmlevel {name} 3 -1"))?);
}
return Ok(());
}
"ra-once" => {
let command = read_line("").map_err(|x| x.to_string())?;
let command = command.trim();
if command.is_empty() {
return Err("No command given.".into());
}
say(&ra(&cfg, root, command)?);
return Ok(());
}
"create-account-once" => {
let line = read_line("").map_err(|x| x.to_string())?;
let request: serde_json::Value = serde_json::from_str(&line).map_err(|x| x.to_string())?;
let name = request.get("username").and_then(|v| v.as_str()).unwrap_or("").trim().to_string();
let password = request.get("password").and_then(|v| v.as_str()).unwrap_or("").to_string();
if !valid_login(&name) || !valid_login(&password) {
return Err("Use 1-16 letters or digits for the account name and password.".into());
}
let mut messages = vec![ra(&cfg, root, &format!("account create {name} {password}"))?];
if request.get("gm").and_then(|v| v.as_bool()).unwrap_or(false) {
messages.push(ra(&cfg, root, &format!("account set gmlevel {name} 3 -1"))?);
}
say(&serde_json::json!({ "messages": messages }).to_string());
return Ok(());
}
_ => {}
}
match args.action.as_str() {
"status" | "status-json" => {
let _lock = state::ControlLock::acquire(root, &args.action, Duration::from_secs(30), &|m| say(m)).map_err(e)?;
if args.action == "status-json" {
say(&services::status(root).to_string());
} else {
for name in ["mysql", "auth", "world", "relay"] {
let line = match state::running(root, name) {
Some(r) => format!("{name:12} running (PID {})", r.pid),
None => format!("{name:12} stopped"),
};
say(&line);
}
}
return Ok(());
}
_ => {}
}
let action = Action::parse(&args.action).ok_or_else(usage)?;
let me = world::Supervisor::Launcher(std::env::current_exe().map_err(|x| x.to_string())?);
ops::run(root, &cfg, args.offset, action, Some(&me), &|m| say(m)).map_err(e)?;
if args.action.starts_with("start-") {
say("Use Stop_All_Server.bat to shut down this repack safely.");
}
Ok(())
}
fn main() {
let result = parse().and_then(run);
if let Err(message) = result {
eprintln!("ERROR: {message}");
std::process::exit(1);
}
}
+42
View File
@@ -165,6 +165,48 @@
"enable_key": "CoACustomRaces.Enable",
"default_on": false
},
{
"id": "subclass",
"name": "Subclasses and Hero Races",
"description": {
"en": "Part of Custom Races V2: a second class for the Thin Twins and the Two-Headed Ogre, and two players sharing one character.",
"ru": "Часть Custom Races V2: второй класс для Хрупких близнецов и Двуглавого огра и один персонаж на двух игроков.",
"de": "Teil von Custom Races V2: eine zweite Klasse für die Dünnen Zwillinge und die Zweiköpfige Ogerin sowie zwei Spieler an einer Figur.",
"fr": "Partie de Custom Races V2 : une seconde classe pour les Jumeaux maigres et l'Ogre à deux têtes, et deux joueurs pour un personnage.",
"es": "Parte de Custom Races V2: una segunda clase para los Gemelos delgados y el Ogro de dos cabezas, y dos jugadores en un personaje.",
"zh": "Custom Races V2 的一部分:为瘦弱双子和双头食人魔提供第二职业,并允许两名玩家共用一个角色。"
},
"repo": "https://github.com/Corfirean/azerothcore-wotlk-coa",
"conf": "mod_subclass.conf",
"switchable": true,
"status": "early",
"icon": "races",
"enable_key": "Subclass.Enable",
"default_on": true,
"part_of": "custom-races",
"hidden": true
},
{
"id": "dev-menu",
"name": "Dev Menu",
"description": {
"en": "Part of Custom Races V2: the in-game /dev editor for game masters (NPCs, items).",
"ru": "Часть Custom Races V2: внутриигровой редактор /dev для гейм-мастеров (НПС, предметы).",
"de": "Teil von Custom Races V2: der /dev-Editor im Spiel für Spielleiter (NPCs, Gegenstände).",
"fr": "Partie de Custom Races V2 : l'éditeur /dev en jeu pour les maîtres du jeu (PNJ, objets).",
"es": "Parte de Custom Races V2: el editor /dev del juego para los máster (PNJ, objetos).",
"zh": "Custom Races V2 的一部分:供游戏管理员使用的游戏内 /dev 编辑器(NPC、物品)。"
},
"repo": "https://github.com/Corfirean/azerothcore-wotlk-coa",
"conf": "mod_ilusixn_devmenu.conf",
"switchable": true,
"status": "early",
"icon": "sparkles",
"enable_key": "DevMenu.Enable",
"default_on": true,
"part_of": "custom-races",
"hidden": true
},
{
"id": "time-is-time",
"name": "TimeIsTime",
+2 -2
View File
@@ -1,12 +1,12 @@
{
"name": "coa-server-manager",
"version": "0.9.13",
"version": "0.9.14",
"lockfileVersion": 3,
"requires": true,
"packages": {
"": {
"name": "coa-server-manager",
"version": "0.9.13",
"version": "0.9.14",
"dependencies": {
"@tauri-apps/api": "^2.12.0",
"@tauri-apps/plugin-dialog": "^2.8.0",
+1 -1
View File
@@ -1,7 +1,7 @@
{
"name": "coa-server-manager",
"private": true,
"version": "0.9.13",
"version": "0.9.14",
"license": "AGPL-3.0-only",
"type": "module",
"scripts": {
+1
View File
@@ -24,3 +24,4 @@ coa-core = { path = "../crates/coa-core" }
coa-registry-proto = { path = "../crates/coa-registry-proto" }
coa-control-proto = { path = "../crates/coa-control-proto" }
tracing = "0.1"
uuid = { version = "1", features = ["v4"] }
+1
View File
@@ -439,6 +439,7 @@ pub(crate) async fn join_realm(
let mut profile = coa_core::remote_client::load(&dir)
.map_err(|e| fail("other", e.to_string()))?;
profile.host = host;
profile.realm = Some(realm.clone());
coa_core::remote_client::save(&dir, &profile)
.map_err(|e| fail("launch", e.to_string()))?;
super::play(state, REMOTE_CLIENT_ID.to_string())
+420 -92
View File
@@ -240,6 +240,7 @@ async fn portable_launch(
let mut profile =
coa_core::remote_client::load(&dir).map_err(|e| other(e.into()))?;
profile.host = address;
profile.realm = Some(realm.clone());
coa_core::remote_client::save(&dir, &profile).map_err(|e| other(e.into()))?;
if let Some(ref cp) = profile.client_path {
if let Ok(pc) = control_cmds::player(&state) {
@@ -350,6 +351,8 @@ struct StatusView {
observed: Observed,
busy: bool,
path_exists: bool,
/// A scheduled restart is under way: a world that is down for a few minutes did not crash.
scheduled_restart: bool,
}
/// Where the Manager keeps its own state (server list, logs). `%LOCALAPPDATA%` on Windows, the XDG data folder elsewhere.
@@ -548,9 +551,12 @@ async fn server_status(
let root = path_of(&state, &id)?;
let busy = state.busy.lock().map(|b| b.contains(&id)).unwrap_or(false);
let path_exists = root.is_dir();
let observed = tauri::async_runtime::spawn_blocking(move || {
let (observed, scheduled_restart) = tauri::async_runtime::spawn_blocking(move || {
let ports = layout::read_ports(&root);
process::observe(&root, &ports)
(
process::observe(&root, &ports),
coa_core::launcher::schedule::under_way(&root),
)
})
.await
.map_err(|e| Error::Invalid(e.to_string()))?;
@@ -558,6 +564,7 @@ async fn server_status(
observed,
busy,
path_exists,
scheduled_restart,
})
}
@@ -620,25 +627,53 @@ async fn start_server(
let out = blocking(move || driver::run(&root, Verb::StartAll)).await?;
if out.ok {
if let Ok(root) = path_of(&state, &id) {
// Companions requested while the server was stopped are created now (once; a failure is only logged).
// Companions requested while the server was stopped are reconciled and created now per realm.
let r = root.clone();
let instance_id = id.clone();
let _ = tauri::async_runtime::spawn_blocking(move || -> Result<()> {
if coa_core::realms::guard_module(&r, "companions").is_err() {
return Ok(());
}
let pending = meta_dir(&r)?.join("companions.pending.json");
if let Ok(v) = coa_core::fsx::read_json::<serde_json::Value>(&pending) {
let _ = std::fs::remove_file(&pending);
let n = v["count"].as_u64().unwrap_or(0) as u32;
if n > 0 {
let made = coa_core::db::Db::from_repack(&r, coa_core::db::Account::Admin)
.and_then(|db| coa_core::companions::ensure_templates(&db));
if let Err(e) = made
.and_then(|_| Ra::connect(&r))
.and_then(|mut ra| ra.spawn_bots(n))
{
tracing::warn!("pending companions were not created: {e}");
let meta = meta_dir(&r)?;
if let Err(e) = coa_core::companions::migrate_legacy_pending_job(&meta, &instance_id) {
tracing::warn!("failed to migrate legacy pending companions job: {e}");
}
for mode in [
coa_core::realms::Mode::Coa,
coa_core::realms::Mode::Wildcard,
coa_core::realms::Mode::Reborn,
] {
let target = match coa_core::multiworld::resolve_bot_operation_target(&r, mode) {
Ok(t) => t,
Err(e) => {
tracing::warn!("cannot resolve target for realm {}: {e}", mode.name());
continue;
}
};
let r_snap = r.clone();
let chars_db = target.chars_db;
let r_ra = r.clone();
let res = coa_core::companions::process_pending_job_with(
&meta,
mode,
&instance_id,
target.running,
|since_guid| {
let admin_db = coa_core::db::Db::from_repack(&r_snap, coa_core::db::Account::Admin)?;
let _ = coa_core::companions::ensure_templates_for_schema(&admin_db, chars_db);
coa_core::companions::query_bot_db_snapshot(&r_snap, &admin_db, chars_db, since_guid)
},
|delta, job| {
let mut ra = Ra::connect_target(&r_ra, Some(mode))?;
if let Some(lvl) = job.level {
ra.spawn_custom(delta, lvl, job.class_id, job.spec_id, job.build_id.as_deref())
} else {
ra.spawn_bots(delta)
}
},
);
if let Err(e) = res {
tracing::warn!("pending companions for realm {} failed during reconciliation: {e}", mode.name());
}
}
Ok(())
@@ -1217,7 +1252,11 @@ async fn realm_select(
let view = coa_core::realms::select(&root, mode)?;
let (dir, meta) = install_meta(&root)?;
if let Some(client) = meta.client_path {
coa_core::client::sync_realm(std::path::Path::new(&client), &dir, view.active)?;
coa_core::client::sync_realm_named(
std::path::Path::new(&client),
&dir,
&coa_core::realm_names::for_mode(&root, view.active),
)?;
}
if restart {
let out = driver::run(&root, Verb::StartAll)?;
@@ -1234,6 +1273,90 @@ async fn realm_select(
result
}
#[derive(serde::Serialize)]
struct RestartScheduleView {
schedule: coa_core::launcher::schedule::RestartSchedule,
/// The server ships the Rust world supervisor that carries out the schedule.
supported: bool,
}
#[tauri::command]
async fn restart_schedule(
state: State<'_, AppState>,
id: String,
) -> std::result::Result<RestartScheduleView, UiError> {
let root = path_of(&state, &id)?;
blocking(move || {
Ok(RestartScheduleView {
schedule: coa_core::launcher::schedule::load(&root),
supported: root.join("Scripts/coa-launcher.exe").is_file(),
})
})
.await
}
/// Restart the world every day at the owner's local time; the running supervisor reads it within a minute.
#[tauri::command]
async fn restart_schedule_save(
state: State<'_, AppState>,
id: String,
schedule: coa_core::launcher::schedule::RestartSchedule,
) -> std::result::Result<RestartScheduleView, UiError> {
let root = path_of(&state, &id)?;
let _guard = BusyGuard::acquire(&state, &id)?;
blocking(move || {
Ok(RestartScheduleView {
schedule: coa_core::launcher::schedule::save(&root, &schedule)?,
supported: root.join("Scripts/coa-launcher.exe").is_file(),
})
})
.await
}
#[tauri::command]
async fn mysql_custom(
state: State<'_, AppState>,
id: String,
) -> std::result::Result<coa_core::launcher::render::CustomMysql, UiError> {
let root = path_of(&state, &id)?;
blocking(move || Ok(coa_core::launcher::render::read_custom_mysql(&root))).await
}
/// The owner's own MySQL options (Settings/mysql-custom.ini); they apply at the next start of the database.
#[tauri::command]
async fn mysql_custom_save(
state: State<'_, AppState>,
id: String,
text: String,
) -> std::result::Result<coa_core::launcher::render::CustomMysql, UiError> {
let root = path_of(&state, &id)?;
let _guard = BusyGuard::acquire(&state, &id)?;
blocking(move || coa_core::launcher::render::write_custom_mysql(&root, &text)).await
}
#[tauri::command]
async fn realm_names(
state: State<'_, AppState>,
id: String,
) -> std::result::Result<Vec<coa_core::realm_names::RealmName>, UiError> {
let root = path_of(&state, &id)?;
blocking(move || coa_core::realm_names::list(&root)).await
}
/// Rename a realm (`None` brings back its default name). The realm list changes at once when the database runs,
/// and the linked game client selects the new name on the next Play.
#[tauri::command]
async fn realm_rename(
state: State<'_, AppState>,
id: String,
realm_id: u32,
name: Option<String>,
) -> std::result::Result<Vec<coa_core::realm_names::RealmName>, UiError> {
let root = path_of(&state, &id)?;
let _guard = BusyGuard::acquire(&state, &id)?;
blocking(move || coa_core::realm_names::rename(&root, realm_id, name.as_deref())).await
}
#[tauri::command]
async fn realm_simultaneous(
state: State<'_, AppState>,
@@ -1384,6 +1507,68 @@ async fn custom_races_install(
result
}
#[tauri::command]
async fn custom_race_characters(
state: State<'_, AppState>,
id: String,
) -> std::result::Result<Option<coa_core::custom_races::CustomRaceCharacters>, UiError> {
let root = path_of(&state, &id)?;
blocking(move || coa_core::custom_races::custom_race_characters(&root)).await
}
/// Delete the companion bots of custom races through the running world's console. Returns how many.
#[tauri::command]
async fn purge_custom_race_bots(
state: State<'_, AppState>,
id: String,
) -> std::result::Result<u32, UiError> {
let root = path_of(&state, &id)?;
let _guard = BusyGuard::acquire(&state, &id)?;
blocking(move || {
let o = coa_core::process::observe(&root, &layout::read_ports(&root));
if o.world.state != coa_core::process::ServiceState::Running {
return Err(Error::Invalid("Start the server to delete bots.".into()));
}
Ra::connect(&root)?.purge_custom_race_bots()
})
.await
}
#[tauri::command]
async fn addons_list(
state: State<'_, AppState>,
id: String,
) -> std::result::Result<Vec<coa_core::addons::AddonView>, UiError> {
let ctx = client_context(&state, &id)?;
blocking(move || coa_core::addons::list(&ctx.require()?)).await
}
/// Install or update a catalog addon in the linked game client (pinned commit, every file checked).
#[tauri::command]
async fn addons_install(
state: State<'_, AppState>,
id: String,
addon: String,
) -> std::result::Result<Vec<coa_core::addons::AddonView>, UiError> {
let ctx = client_context(&state, &id)?;
let _guard = BusyGuard::acquire(&state, &id)?;
let cancel = begin_client_job(&state)?;
let result = blocking(move || coa_core::addons::install(&ctx.require()?, &addon, &cancel)).await;
end_client_job(&state);
result
}
#[tauri::command]
async fn addons_remove(
state: State<'_, AppState>,
id: String,
addon: String,
) -> std::result::Result<Vec<coa_core::addons::AddonView>, UiError> {
let ctx = client_context(&state, &id)?;
let _guard = BusyGuard::acquire(&state, &id)?;
blocking(move || coa_core::addons::remove(&ctx.require()?, &addon)).await
}
#[tauri::command]
async fn custom_races_uninstall(
state: State<'_, AppState>,
@@ -1697,6 +1882,7 @@ async fn retry_update_validation(
async fn get_population(
state: State<'_, AppState>,
id: String,
realm: Option<coa_core::realms::Mode>,
) -> std::result::Result<Option<coa_core::population::Population>, UiError> {
let root = path_of(&state, &id)?;
Ok(tauri::async_runtime::spawn_blocking(move || {
@@ -1704,12 +1890,48 @@ async fn get_population(
if o.mysql.state != coa_core::process::ServiceState::Running {
return None;
}
coa_core::population::query(&root).ok()
if let Some(mode) = realm {
coa_core::population::query_for_realm(&root, mode).ok()
} else {
coa_core::population::query(&root).ok()
}
})
.await
.unwrap_or(None))
}
#[tauri::command]
async fn companions_login_all(
state: State<'_, AppState>,
id: String,
realm: Option<coa_core::realms::Mode>,
) -> std::result::Result<String, UiError> {
let root = path_of(&state, &id)?;
let _guard = BusyGuard::acquire(&state, &id)?;
blocking(move || {
let mut ra = Ra::connect_target(&root, realm)?;
ra.login_all()
})
.await
}
#[tauri::command]
async fn companions_spawn_fleet(
state: State<'_, AppState>,
id: String,
race: u8,
level: u8,
realm: Option<coa_core::realms::Mode>,
) -> std::result::Result<String, UiError> {
let root = path_of(&state, &id)?;
let _guard = BusyGuard::acquire(&state, &id)?;
blocking(move || {
let mut ra = Ra::connect_target(&root, realm)?;
ra.spawn_fleet(race, level)
})
.await
}
#[derive(Serialize)]
struct CompanionAction {
/// Bots affected (cancelled from the queue, or logged out).
@@ -1720,12 +1942,31 @@ struct CompanionAction {
async fn companions_stop_spawning(
state: State<'_, AppState>,
id: String,
realm: Option<coa_core::realms::Mode>,
) -> std::result::Result<CompanionAction, UiError> {
let root = path_of(&state, &id)?;
blocking(move || {
Ok(CompanionAction {
count: Ra::connect(&root)?.cancel_spawning()?,
})
let mode = realm.unwrap_or_else(|| {
coa_core::realms::view(&root).map(|v| v.active).unwrap_or_default()
});
let meta = meta_dir(&root)?;
let cancelled_pending = coa_core::companions::cancel_pending_job(&meta, mode.name())
.ok()
.flatten();
match Ra::connect_target(&root, Some(mode)).and_then(|mut ra| ra.cancel_spawning()) {
Ok(ra_cancelled) => Ok(CompanionAction {
count: ra_cancelled + cancelled_pending.map(|j| j.remaining_count()).unwrap_or(0),
}),
Err(e) => {
if let Some(job) = cancelled_pending {
Ok(CompanionAction {
count: job.remaining_count(),
})
} else {
Err(e)
}
}
}
})
.await
}
@@ -1734,12 +1975,12 @@ async fn companions_stop_spawning(
async fn companions_take_offline(
state: State<'_, AppState>,
id: String,
realm: Option<coa_core::realms::Mode>,
) -> std::result::Result<CompanionAction, UiError> {
let root = path_of(&state, &id)?;
let _guard = BusyGuard::acquire(&state, &id)?;
blocking(move || {
let mut ra = Ra::connect(&root)?;
// Anything still waiting to be created must not come back right after.
let mut ra = Ra::connect_target(&root, realm)?;
let _ = ra.cancel_spawning();
Ok(CompanionAction {
count: ra.despawn_all()?,
@@ -1748,13 +1989,12 @@ async fn companions_take_offline(
.await
}
/// Log `count` randomly chosen online companions out to lower the load. Uses the per-bot command that every server
/// build has, so it works on older builds too.
#[tauri::command]
async fn companions_despawn_some(
state: State<'_, AppState>,
id: String,
count: u32,
realm: Option<coa_core::realms::Mode>,
) -> std::result::Result<CompanionAction, UiError> {
let root = path_of(&state, &id)?;
let _guard = BusyGuard::acquire(&state, &id)?;
@@ -1762,13 +2002,18 @@ async fn companions_despawn_some(
if !(1..=5000).contains(&count) {
return Err(Error::Invalid("Choose a number between 1 and 5000.".into()));
}
let mode = realm.unwrap_or_else(|| {
coa_core::realms::view(&root).map(|v| v.active).unwrap_or_default()
});
let target = coa_core::multiworld::resolve_bot_operation_target(&root, mode)?;
let prefix = coa_core::population::bot_account_prefix(&root).to_uppercase();
let db = coa_core::db::Db::from_repack(&root, coa_core::db::Account::App)?;
let rows = db.query(&format!(
"SELECT c.guid FROM acore_characters.characters c JOIN acore_auth.account a ON a.id=c.account WHERE c.online=1 AND UPPER(a.username) LIKE '{prefix}%' ORDER BY RAND() LIMIT {count};"
"SELECT c.guid FROM {}.characters c JOIN acore_auth.account a ON a.id=c.account WHERE c.online=1 AND UPPER(a.username) LIKE '{prefix}%' ORDER BY RAND() LIMIT {count};",
target.chars_db
))?;
let guids: Vec<u64> = rows.lines().filter_map(|l| l.trim().parse().ok()).collect();
let mut ra = Ra::connect(&root)?;
let mut ra = Ra::connect_target(&root, Some(mode))?;
let mut done = 0;
for g in guids {
if ra.despawn_bot(g).unwrap_or(false) {
@@ -1780,31 +2025,36 @@ async fn companions_despawn_some(
.await
}
/// Delete every companion for good. A recovery point of the characters and accounts is saved first.
#[tauri::command]
async fn companions_delete_all(
app: AppHandle,
state: State<'_, AppState>,
id: String,
realm: Option<coa_core::realms::Mode>,
) -> std::result::Result<CompanionAction, UiError> {
let root = path_of(&state, &id)?;
let _guard = BusyGuard::acquire(&state, &id)?;
blocking(move || {
let mode = realm.unwrap_or_else(|| {
coa_core::realms::view(&root).map(|v| v.active).unwrap_or_default()
});
let target = coa_core::multiworld::resolve_bot_operation_target(&root, mode)?;
let meta = meta_dir(&root)?;
backup::create(
&root,
&meta,
Kind::Quick,
Trigger::BeforeDangerousChange,
Some("before deleting all companions".into()),
Some(format!("before deleting all {} companions", target.realm.label())),
&|step| {
let _ = app.emit("backup-progress", step);
},
)?;
let before = coa_core::population::query(&root)
let before = coa_core::population::query_for_realm(&root, mode)
.map(|p| p.bots_total)
.unwrap_or(0);
let mut ra = Ra::connect(&root)?;
let _ = coa_core::companions::cancel_pending_job(&meta, mode.name());
let mut ra = Ra::connect_target(&root, Some(mode))?;
let _ = ra.cancel_spawning();
ra.purge_all()?;
Ok(CompanionAction { count: before })
@@ -1860,6 +2110,11 @@ async fn add_companions(
state: State<'_, AppState>,
id: String,
count: u32,
realm: Option<coa_core::realms::Mode>,
level: Option<u8>,
class_id: Option<u8>,
spec_id: Option<u32>,
archetype: Option<String>,
) -> std::result::Result<CompanionsResult, UiError> {
let root = path_of(&state, &id)?;
let _guard = BusyGuard::acquire(&state, &id)?;
@@ -1869,81 +2124,84 @@ async fn add_companions(
"Choose between 1 and 2000 companions.".into(),
));
}
let mode = realm.unwrap_or_else(|| {
coa_core::realms::view(&root).map(|v| v.active).unwrap_or_default()
});
coa_core::companions::validate_spawn_request(
mode,
count,
level,
class_id,
spec_id,
archetype.as_deref(),
)?;
let target = coa_core::multiworld::resolve_bot_operation_target(&root, mode)?;
if mode == coa_core::realms::Mode::Wildcard {
if let Some(ref arch_id) = archetype {
if !arch_id.trim().is_empty() {
let db = coa_core::db::Db::from_repack(&root, coa_core::db::Account::Admin)?;
let archetypes = coa_core::companions::list_wildcard_archetypes(&db, target.chars_db)?;
if !archetypes.iter().any(|a| a.id.eq_ignore_ascii_case(arch_id.trim())) {
return Err(Error::Invalid(format!(
"Unknown Wildcard build UUID '{}' in {}.coa_build_creator.",
arch_id.trim(),
target.chars_db
)));
}
}
}
}
let meta = meta_dir(&root)?;
let mut changes = BTreeMap::new();
changes.insert("CoaBots.AutoLoginOnStartup".to_string(), Value::Bool(true));
// Every companion, old and new, should come back at the next start, so the start-up limit only ever grows here.
let existing_max = config::load(&root, Scope::Bots)
.ok()
.and_then(|v| {
v.settings
.iter()
.find(|s| s.meta.key == "CoaBots.AutoLogin.MaxCount")
.and_then(|s| s.value.as_u64())
})
let existing_cfg = config::load(&target.world_root, Scope::Bots)?;
let existing_max = existing_cfg
.settings
.iter()
.find(|s| s.meta.key == "CoaBots.AutoLogin.MaxCount")
.and_then(|s| s.value.as_u64())
.unwrap_or(0) as u32;
let already = coa_core::population::query(&root)
let already = coa_core::population::query_for_realm(&root, mode)
.map(|p| p.bots_total)
.unwrap_or(0);
changes.insert(
"CoaBots.AutoLogin.MaxCount".to_string(),
Value::from(existing_max.max(already + count).min(5000)),
);
config::save(&root, &meta, Scope::Bots, &changes)?;
let o = coa_core::process::observe(&root, &layout::read_ports(&root));
// Large batches while the server is stopped: create them in the database right now, fully equipped.
if o.world.state == coa_core::process::ServiceState::Stopped
&& o.auth.state == coa_core::process::ServiceState::Stopped
&& count >= coa_core::companions::OFFLINE_MIN
&& coa_core::companions::offline_factory(&root).is_some()
{
let started_db = o.mysql.state != coa_core::process::ServiceState::Running;
if started_db {
let out = driver::run(&root, Verb::StartMysql)?;
if !out.ok {
return Err(Error::Invalid("The database could not be started.".into()));
}
}
let made = (|| -> Result<()> {
coa_core::companions::ensure_templates(&coa_core::db::Db::from_repack(
&root,
coa_core::db::Account::Admin,
)?)?;
coa_core::companions::offline_create(
&root,
&meta.join("logs").join("companions-offline.log"),
count,
)?;
Ok(())
})();
if started_db {
let _ = driver::run(&root, Verb::StopAll);
}
made?;
tracing::info!(count, "companions created offline");
return Ok(CompanionsResult {
spawned: None,
created: Some(count),
baseline: None,
});
}
config::save(&target.world_root, &meta, Scope::Bots, &changes)?;
let mut baseline = None;
let spawned = if o.world.state == coa_core::process::ServiceState::Running {
// Older servers have no template characters to copy bots from: add them first.
coa_core::companions::ensure_templates(&coa_core::db::Db::from_repack(
&root,
coa_core::db::Account::Admin,
)?)?;
baseline = coa_core::population::query(&root)
let spawned = if target.running {
if let Ok(admin_db) = coa_core::db::Db::from_repack(&root, coa_core::db::Account::Admin) {
let _ = coa_core::companions::ensure_templates_for_schema(&admin_db, target.chars_db);
}
baseline = coa_core::population::query_for_realm(&root, mode)
.ok()
.map(|p| p.bots_total);
Some(Ra::connect(&root)?.spawn_bots(count)?)
let mut ra = Ra::connect_target(&root, Some(mode))?;
if let Some(lvl) = level {
Some(ra.spawn_custom(count, lvl, class_id, spec_id, archetype.as_deref())?)
} else {
Some(ra.spawn_bots(count)?)
}
} else {
// The server is stopped: creating bots needs it running, so remember the request and do it after the next start.
coa_core::fsx::atomic_write_json(
&meta.join("companions.pending.json"),
&serde_json::json!({ "count": count }),
)?;
let _ = coa_core::companions::migrate_legacy_pending_job(&meta, &id);
let mut job = coa_core::companions::CompanionsPendingJob::new(
&id,
mode.name(),
count,
level,
class_id,
spec_id,
archetype.clone(),
);
if let Ok(admin_db) = coa_core::db::Db::from_repack(&root, coa_core::db::Account::Admin) {
if let Ok(snap) = coa_core::companions::query_bot_db_snapshot(&root, &admin_db, target.chars_db, None) {
job.baseline_bot_count = Some(snap.bot_count);
job.baseline_max_guid = Some(snap.max_guid);
}
}
coa_core::companions::save_pending_job(&meta, mode.name(), &job)?;
None
};
tracing::info!(count, spawned = spawned.is_some(), "companions requested");
@@ -1956,6 +2214,27 @@ async fn add_companions(
.await
}
#[tauri::command]
async fn get_wildcard_archetypes(
state: State<'_, AppState>,
id: String,
) -> std::result::Result<Vec<coa_core::companions::WildcardArchetypeDto>, UiError> {
let root = path_of(&state, &id)?;
blocking(move || {
let db = coa_core::db::Db::from_repack(&root, coa_core::db::Account::Admin)?;
let target = coa_core::multiworld::resolve_bot_operation_target(&root, coa_core::realms::Mode::Wildcard)
.unwrap_or_else(|_| coa_core::multiworld::BotOperationTarget {
world_root: root.clone(),
chars_db: "acore_characters_wildcard",
ra_port: 3444,
running: false,
realm: coa_core::realms::Mode::Wildcard,
});
Ok(coa_core::companions::list_wildcard_archetypes(&db, target.chars_db)?)
})
.await
}
const REMOTE_CLIENT_ID: &str = "@remote-client";
fn remote_dir() -> PathBuf {
@@ -1982,6 +2261,10 @@ fn remote_connect(
if host.is_empty() {
return Err(Error::Invalid("Enter the host's IP address or hostname.".into()).into());
}
if profile.host != host {
// A host typed by hand is not the listed server whose account was remembered.
profile.realm = None;
}
profile.host = host.into();
coa_core::remote_client::save(&dir, &profile)?;
Ok(profile)
@@ -2382,6 +2665,15 @@ async fn play(
if id == REMOTE_CLIENT_ID {
let ctx = client_context(&state, &id)?;
let client = ctx.require()?;
// The account the Manager made (or linked) on that listed server goes into the login box at every Play,
// also when another server's account was used in between.
let login = coa_core::remote_client::load(&remote_dir())
.ok()
.and_then(|profile| profile.realm)
.and_then(|realm| {
let pc = control_cmds::player(&state).ok()?;
pc.credentials(&control_cmds::realm_id(&realm).ok()?).ok()?
});
return blocking(move || {
if ctx.host.is_empty() {
return Err(Error::Invalid(
@@ -2392,6 +2684,12 @@ async fn play(
return Err(Error::Invalid("The game is already running.".into()));
}
coa_core::client::begin_realmlist_override(&client, &ctx.dir, &ctx.host)?;
if let Some(creds) = &login {
let _ = coa_core::glue_config::prefill_login(&client, &creds.username, &creds.password);
}
if window_preferences::clear_cache_on_play(&data_dir()) {
let _ = coa_core::client::clear_game_cache(&client);
}
coa_core::client::launch(&client)?;
let client_c = client.clone();
let meta_c = ctx.dir.clone();
@@ -2427,7 +2725,8 @@ async fn play(
}
blocking(move || {
let mode = coa_core::realms::state(&root)?.active;
if !coa_core::client::sync_realm(&client, &dir, mode)? {
let realm = coa_core::realm_names::for_mode(&root, mode);
if !coa_core::client::sync_realm_named(&client, &dir, &realm)? {
return Err(Error::Invalid(
"Close the game client before pressing Play so its selected realm can be updated."
.into(),
@@ -2437,6 +2736,9 @@ async fn play(
if existing.is_empty() {
let _ = coa_core::glue_config::prefill_login(&client, "local", "local");
}
if window_preferences::clear_cache_on_play(&data_dir()) {
let _ = coa_core::client::clear_game_cache(&client);
}
coa_core::client::launch(&client)?;
Ok(DriverOutcome {
ok: true,
@@ -2903,6 +3205,16 @@ fn set_close_to_tray(enabled: bool) -> std::result::Result<(), UiError> {
Ok(window_preferences::save(&data_dir(), enabled)?)
}
#[tauri::command]
fn clear_game_cache_on_play() -> bool {
window_preferences::clear_cache_on_play(&data_dir())
}
#[tauri::command]
fn set_clear_game_cache_on_play(enabled: bool) -> std::result::Result<(), UiError> {
Ok(window_preferences::save_clear_cache_on_play(&data_dir(), enabled)?)
}
fn show_main_window(app: &AppHandle) {
let handle = app.clone();
if let Err(error) = app.run_on_main_thread(move || {
@@ -2981,6 +3293,19 @@ pub fn run() {
realm_select,
realm_simultaneous,
realm_with_reborn,
realm_names,
realm_rename,
mysql_custom,
mysql_custom_save,
restart_schedule,
restart_schedule_save,
clear_game_cache_on_play,
set_clear_game_cache_on_play,
custom_race_characters,
purge_custom_race_bots,
addons_list,
addons_install,
addons_remove,
check_database,
repair_server,
module_set_enabled,
@@ -3006,10 +3331,13 @@ pub fn run() {
companions_take_offline,
companions_delete_all,
companions_despawn_some,
companions_login_all,
companions_spawn_fleet,
open_link,
report_targets,
companion_sizes,
add_companions,
get_wildcard_archetypes,
remote_connection,
remote_connect,
client_info,
+12
View File
@@ -11,3 +11,15 @@ pub fn close_to_tray(dir: &Path) -> coa_core::Result<bool> {
pub fn save(dir: &Path, enabled: bool) -> coa_core::Result<()> {
coa_core::fsx::atomic_write_json(&dir.join("close-to-tray.json"), &enabled)
}
/// Clear the game's cache of server data before every Play (on unless the player turned it off).
pub fn clear_cache_on_play(dir: &Path) -> bool {
std::fs::read(dir.join("clear-game-cache.json"))
.ok()
.and_then(|bytes| serde_json::from_slice(&bytes).ok())
.unwrap_or(true)
}
pub fn save_clear_cache_on_play(dir: &Path, enabled: bool) -> coa_core::Result<()> {
coa_core::fsx::atomic_write_json(&dir.join("clear-game-cache.json"), &enabled)
}
+1 -1
View File
@@ -1,7 +1,7 @@
{
"$schema": "https://schema.tauri.app/config/2",
"productName": "CoA Server Manager",
"version": "0.9.13",
"version": "0.9.14",
"identifier": "com.coa.servermanager",
"build": {
"beforeDevCommand": "npm run dev",
+5
View File
@@ -49,3 +49,8 @@ Manager 0.9.13 refreshes the bundled server history through 0.261114.106 from
canonical build commit `3308e3a957cd9fd1a2cd145a7f023f2cf521c54c` on 2026-11-15.
The reviewed upcoming Manager and server records (Custom Races V2, 213 server notes)
carry translations in all five languages.
Manager 0.9.14 refreshes the bundled server history through 0.261115.110 from
canonical build commit `45c013be9ade3001581e5201cacda6cd6bb6b01c` on 2026-11-16.
The reviewed upcoming Manager (12 notes) and server (6 notes) records
carry translations in all five languages.
+100 -10
View File
@@ -40,7 +40,19 @@
"Update and recovery checks use the temporary login port even with a Windows override": "Проверка обновления и восстановления использует временный порт входа даже при переопределении в Windows",
"Custom Races patch installation recovers from interrupted downloads": "Установка патчей дополнительных рас восстанавливается после прерывания загрузки",
"Settings for how much help bots get in dungeons and raids": "Настройки того, насколько ботам помогать в подземельях и рейдах",
"The custom races client is updated to Custom Races V2": "Клиент пользовательских рас обновлён до Custom Races V2"
"The custom races client is updated to Custom Races V2": "Клиент пользовательских рас обновлён до Custom Races V2",
"Install community addons from the Manager": "Аддоны сообщества устанавливаются прямо из Manager",
"Old item and creature data is cleared before every Play": "Устаревшие данные о предметах и существах очищаются перед каждым запуском",
"Turning the custom races client patch on or off takes seconds again": "Клиентский патч кастомных рас снова включается и выключается за секунды",
"The database moves to a free port when Windows reserves or another program takes 3307": "База данных переходит на свободный порт, если 3307 зарезервирован Windows или занят другой программой",
"Your own MySQL settings survive restarts and updates": "Свои настройки MySQL сохраняются после перезапусков и обновлений",
"Disabled custom races stay disabled after a server update that adds races": "Отключённые кастомные расы остаются отключёнными после обновления сервера, добавляющего расы",
"Rename your realms in the Manager": "Реалмы можно переименовать в Manager",
"The account for a friend's server is in the login box at every Play": "Аккаунт для сервера друга подставляется в окно входа при каждом запуске",
"Restart the world every day at a chosen time": "Ежедневный перезапуск мира в выбранное время",
"Switches for the Custom Races V2 subclasses, Hero Races and the /dev menu": "Переключатели подклассов, героических рас и меню /dev из Custom Races V2",
"Companion bots on Wildcard and Warcraft Reborn": "Боты-компаньоны на Wildcard и Warcraft Reborn",
"The Custom Races card tells which characters stay out while races are off": "Карточка Custom Races показывает, какие персонажи не войдут в мир, пока расы выключены"
},
"de": {
"Choose Parallel or Global level scaling in module settings": "Parallele oder globale Levelskalierung in den Moduleinstellungen wählen",
@@ -82,7 +94,19 @@
"Update and recovery checks use the temporary login port even with a Windows override": "Update- und Wiederherstellungsprüfungen verwenden den temporären Anmeldeport auch bei einer Windows-Vorgabe",
"Custom Races patch installation recovers from interrupted downloads": "Die Installation zusätzlicher Völker setzt unterbrochene Downloads fort",
"Settings for how much help bots get in dungeons and raids": "Einstellungen, wie viel Hilfe Bots in Dungeons und Schlachtzügen erhalten",
"The custom races client is updated to Custom Races V2": "Der Client für eigene Völker wird auf Custom Races V2 aktualisiert"
"The custom races client is updated to Custom Races V2": "Der Client für eigene Völker wird auf Custom Races V2 aktualisiert",
"Install community addons from the Manager": "Community-Addons direkt aus dem Manager installieren",
"Old item and creature data is cleared before every Play": "Veraltete Gegenstands- und Kreaturdaten werden vor jedem Start gelöscht",
"Turning the custom races client patch on or off takes seconds again": "Der Client-Patch für eigene Völker lässt sich wieder in Sekunden ein- und ausschalten",
"The database moves to a free port when Windows reserves or another program takes 3307": "Die Datenbank weicht auf einen freien Port aus, wenn Windows 3307 reserviert oder ein anderes Programm ihn belegt",
"Your own MySQL settings survive restarts and updates": "Eigene MySQL-Einstellungen bleiben nach Neustarts und Updates erhalten",
"Disabled custom races stay disabled after a server update that adds races": "Deaktivierte eigene Völker bleiben nach einem Server-Update mit neuen Völkern deaktiviert",
"Rename your realms in the Manager": "Realms im Manager umbenennen",
"The account for a friend's server is in the login box at every Play": "Das Konto für den Server eines Freundes steht bei jedem Start im Anmeldefeld",
"Restart the world every day at a chosen time": "Die Welt täglich zu einer gewählten Uhrzeit neu starten",
"Switches for the Custom Races V2 subclasses, Hero Races and the /dev menu": "Schalter für die Unterklassen, Heldenvölker und das /dev-Menü von Custom Races V2",
"Companion bots on Wildcard and Warcraft Reborn": "Begleiter-Bots auf Wildcard und Warcraft Reborn",
"The Custom Races card tells which characters stay out while races are off": "Die Custom-Races-Karte zeigt, welche Figuren draußen bleiben, solange die Völker aus sind"
},
"fr": {
"Choose Parallel or Global level scaling in module settings": "Choisissez une progression parallèle ou globale des niveaux dans les paramètres du module",
@@ -124,7 +148,19 @@
"Update and recovery checks use the temporary login port even with a Windows override": "Les contrôles de mise à jour et de restauration utilisent le port de connexion temporaire même si Windows en impose un autre",
"Custom Races patch installation recovers from interrupted downloads": "L’installation des races supplémentaires reprend les téléchargements interrompus",
"Settings for how much help bots get in dungeons and raids": "Réglages de l'aide accordée aux bots en donjon et en raid",
"The custom races client is updated to Custom Races V2": "Le client des races personnalisées passe à Custom Races V2"
"The custom races client is updated to Custom Races V2": "Le client des races personnalisées passe à Custom Races V2",
"Install community addons from the Manager": "Installez des addons de la communauté depuis le Manager",
"Old item and creature data is cleared before every Play": "Les anciennes données d'objets et de créatures sont effacées avant chaque lancement",
"Turning the custom races client patch on or off takes seconds again": "Activer ou désactiver le patch client des races personnalisées reprend quelques secondes",
"The database moves to a free port when Windows reserves or another program takes 3307": "La base de données passe sur un port libre si Windows réserve le 3307 ou si un autre programme l'utilise",
"Your own MySQL settings survive restarts and updates": "Vos réglages MySQL survivent aux redémarrages et aux mises à jour",
"Disabled custom races stay disabled after a server update that adds races": "Les races personnalisées désactivées le restent après une mise à jour du serveur qui ajoute des races",
"Rename your realms in the Manager": "Renommez vos royaumes dans le Manager",
"The account for a friend's server is in the login box at every Play": "Le compte du serveur d'un ami est rempli à chaque lancement",
"Restart the world every day at a chosen time": "Redémarrez le monde chaque jour à l'heure choisie",
"Switches for the Custom Races V2 subclasses, Hero Races and the /dev menu": "Interrupteurs pour les sous-classes, races héroïques et le menu /dev de Custom Races V2",
"Companion bots on Wildcard and Warcraft Reborn": "Bots compagnons sur Wildcard et Warcraft Reborn",
"The Custom Races card tells which characters stay out while races are off": "La carte Custom Races indique quels personnages restent hors du monde quand les races sont désactivées"
},
"es": {
"Choose Parallel or Global level scaling in module settings": "Elige escalado de nivel paralelo o global en los ajustes del módulo",
@@ -166,7 +202,19 @@
"Update and recovery checks use the temporary login port even with a Windows override": "Las comprobaciones de actualización y recuperación usan el puerto temporal de acceso aunque Windows indique otro",
"Custom Races patch installation recovers from interrupted downloads": "La instalación de razas adicionales se recupera de descargas interrumpidas",
"Settings for how much help bots get in dungeons and raids": "Ajustes de cuánta ayuda reciben los bots en mazmorras y bandas",
"The custom races client is updated to Custom Races V2": "El cliente de razas personalizadas se actualiza a Custom Races V2"
"The custom races client is updated to Custom Races V2": "El cliente de razas personalizadas se actualiza a Custom Races V2",
"Install community addons from the Manager": "Instala addons de la comunidad desde el Manager",
"Old item and creature data is cleared before every Play": "Los datos antiguos de objetos y criaturas se borran antes de cada partida",
"Turning the custom races client patch on or off takes seconds again": "Activar o desactivar el parche de cliente de razas personalizadas vuelve a tardar segundos",
"The database moves to a free port when Windows reserves or another program takes 3307": "La base de datos pasa a un puerto libre si Windows reserva el 3307 u otro programa lo ocupa",
"Your own MySQL settings survive restarts and updates": "Tus ajustes de MySQL se mantienen tras reinicios y actualizaciones",
"Disabled custom races stay disabled after a server update that adds races": "Las razas personalizadas desactivadas siguen desactivadas tras una actualización del servidor que añade razas",
"Rename your realms in the Manager": "Cambia el nombre de tus reinos en el Manager",
"The account for a friend's server is in the login box at every Play": "La cuenta del servidor de un amigo aparece en el inicio de sesión en cada partida",
"Restart the world every day at a chosen time": "Reinicia el mundo cada día a la hora elegida",
"Switches for the Custom Races V2 subclasses, Hero Races and the /dev menu": "Interruptores para las subclases, razas heroicas y el menú /dev de Custom Races V2",
"Companion bots on Wildcard and Warcraft Reborn": "Bots acompañantes en Wildcard y Warcraft Reborn",
"The Custom Races card tells which characters stay out while races are off": "La tarjeta Custom Races indica qué personajes quedan fuera mientras las razas están desactivadas"
},
"zh": {
"Choose Parallel or Global level scaling in module settings": "在模块设置中选择并行或全局等级缩放",
@@ -208,7 +256,19 @@
"Update and recovery checks use the temporary login port even with a Windows override": "即使 Windows 指定了其他端口,更新和恢复检查也会使用临时登录端口",
"Custom Races patch installation recovers from interrupted downloads": "自定义种族补丁安装可从中断的下载中恢复",
"Settings for how much help bots get in dungeons and raids": "设置机器人在地下城和团队副本中获得多少加成",
"The custom races client is updated to Custom Races V2": "自定义种族客户端已更新至 Custom Races V2"
"The custom races client is updated to Custom Races V2": "自定义种族客户端已更新至 Custom Races V2",
"Install community addons from the Manager": "可在 Manager 中安装社区插件",
"Old item and creature data is cleared before every Play": "每次启动前清除过时的物品和生物数据",
"Turning the custom races client patch on or off takes seconds again": "自定义种族客户端补丁的开关再次只需几秒",
"The database moves to a free port when Windows reserves or another program takes 3307": "当 3307 被 Windows 保留或被其他程序占用时,数据库会改用空闲端口",
"Your own MySQL settings survive restarts and updates": "自定义 MySQL 设置在重启和更新后保留",
"Disabled custom races stay disabled after a server update that adds races": "服务器更新新增种族后,已禁用的自定义种族保持禁用",
"Rename your realms in the Manager": "可在 Manager 中重命名服务器",
"The account for a friend's server is in the login box at every Play": "每次启动时都会自动填入朋友服务器的账号",
"Restart the world every day at a chosen time": "每天在选定时间重启世界",
"Switches for the Custom Races V2 subclasses, Hero Races and the /dev menu": "Custom Races V2 副职业、英雄种族和 /dev 菜单的开关",
"Companion bots on Wildcard and Warcraft Reborn": "Wildcard 和 Warcraft Reborn 上的伙伴机器人",
"The Custom Races card tells which characters stay out while races are off": "Custom Races 卡片会显示种族关闭时哪些角色无法进入世界"
}
},
"server": {
@@ -498,7 +558,13 @@
"The character sheet of a Two-Players head shows the other head's class": "Лист персонажа головы Two-Players показывает класс второй головы",
"Two-Players Ogres can fit a carried mount in a window and share the fit": "Огры Two-Players могут подогнать переносимого маунта в окне и поделиться подгонкой",
"Custom Races V2 with 17 new races, subclasses and the Fading Island": "Custom Races V2: 17 новых рас, подклассы и Fading Island",
"Updated Custom Races to 2.0": "Custom Races обновлён до 2.0"
"Updated Custom Races to 2.0": "Custom Races обновлён до 2.0",
"Custom races stay on when an update changes the race catalog": "Кастомные расы остаются включёнными, когда обновление меняет каталог рас",
"Server support for companion bots on Wildcard and Warcraft Reborn": "Сервер поддерживает ботов-компаньонов на Wildcard и Warcraft Reborn",
"Custom-race characters stay out of the world while custom races are off": "Персонажи кастомных рас не входят в мир, пока кастомные расы выключены",
"Companion bots play Wildcard and Warcraft Reborn": "Боты-компаньоны играют на Wildcard и Warcraft Reborn",
"Stopping the server no longer leaves the world running now and then": "Остановка сервера больше не оставляет мир работающим время от времени",
"The server includes a native launcher for the world supervisor": "В сервер входит нативный лаунчер для супервизора мира"
},
"de": {
"Restrict new characters by custom race without changing existing characters": "Neue Charaktere nach zusätzlichem Volk beschränken, ohne bestehende Charaktere zu ändern",
@@ -786,7 +852,13 @@
"The character sheet of a Two-Players head shows the other head's class": "Der Charakterbogen eines Two-Players-Kopfes zeigt die Klasse des anderen Kopfes",
"Two-Players Ogres can fit a carried mount in a window and share the fit": "Two-Players-Oger können ein getragenes Reittier in einem Fenster anpassen und die Anpassung teilen",
"Custom Races V2 with 17 new races, subclasses and the Fading Island": "Custom Races V2 mit 17 neuen Völkern, Unterklassen und der Fading Island",
"Updated Custom Races to 2.0": "Custom Races auf 2.0 aktualisiert"
"Updated Custom Races to 2.0": "Custom Races auf 2.0 aktualisiert",
"Custom races stay on when an update changes the race catalog": "Eigene Völker bleiben aktiv, wenn ein Update den Völkerkatalog ändert",
"Server support for companion bots on Wildcard and Warcraft Reborn": "Serverunterstützung für Begleiter-Bots auf Wildcard und Warcraft Reborn",
"Custom-race characters stay out of the world while custom races are off": "Figuren eigener Völker bleiben der Welt fern, solange eigene Völker aus sind",
"Companion bots play Wildcard and Warcraft Reborn": "Begleiter-Bots spielen Wildcard und Warcraft Reborn",
"Stopping the server no longer leaves the world running now and then": "Das Stoppen des Servers lässt die Welt nicht mehr gelegentlich weiterlaufen",
"The server includes a native launcher for the world supervisor": "Der Server enthält einen nativen Launcher für die Weltüberwachung"
},
"fr": {
"Restrict new characters by custom race without changing existing characters": "Restreignez les races supplémentaires des nouveaux personnages sans modifier les personnages existants",
@@ -1074,7 +1146,13 @@
"The character sheet of a Two-Players head shows the other head's class": "La fiche de personnage d'une tête Two-Players affiche la classe de l'autre tête",
"Two-Players Ogres can fit a carried mount in a window and share the fit": "Les ogres Two-Players peuvent ajuster une monture portée dans une fenêtre et partager l'ajustement",
"Custom Races V2 with 17 new races, subclasses and the Fading Island": "Custom Races V2 avec 17 nouvelles races, les sous-classes et la Fading Island",
"Updated Custom Races to 2.0": "Custom Races passe en version 2.0"
"Updated Custom Races to 2.0": "Custom Races passe en version 2.0",
"Custom races stay on when an update changes the race catalog": "Les races personnalisées restent actives quand une mise à jour change le catalogue des races",
"Server support for companion bots on Wildcard and Warcraft Reborn": "Prise en charge serveur des bots compagnons sur Wildcard et Warcraft Reborn",
"Custom-race characters stay out of the world while custom races are off": "Les personnages de races personnalisées restent hors du monde quand ces races sont désactivées",
"Companion bots play Wildcard and Warcraft Reborn": "Les bots compagnons jouent en Wildcard et Warcraft Reborn",
"Stopping the server no longer leaves the world running now and then": "Arrêter le serveur ne laisse plus parfois le monde tourner",
"The server includes a native launcher for the world supervisor": "Le serveur inclut un lanceur natif pour le superviseur du monde"
},
"es": {
"Restrict new characters by custom race without changing existing characters": "Restringe las razas adicionales de personajes nuevos sin modificar los existentes",
@@ -1362,7 +1440,13 @@
"The character sheet of a Two-Players head shows the other head's class": "La hoja de personaje de una cabeza Two-Players muestra la clase de la otra cabeza",
"Two-Players Ogres can fit a carried mount in a window and share the fit": "Los ogros Two-Players pueden ajustar una montura transportada en una ventana y compartir el ajuste",
"Custom Races V2 with 17 new races, subclasses and the Fading Island": "Custom Races V2 con 17 razas nuevas, subclases y la Fading Island",
"Updated Custom Races to 2.0": "Custom Races se actualiza a 2.0"
"Updated Custom Races to 2.0": "Custom Races se actualiza a 2.0",
"Custom races stay on when an update changes the race catalog": "Las razas personalizadas siguen activas cuando una actualización cambia el catálogo de razas",
"Server support for companion bots on Wildcard and Warcraft Reborn": "Soporte del servidor para bots acompañantes en Wildcard y Warcraft Reborn",
"Custom-race characters stay out of the world while custom races are off": "Los personajes de razas personalizadas quedan fuera del mundo mientras esas razas están desactivadas",
"Companion bots play Wildcard and Warcraft Reborn": "Los bots acompañantes juegan en Wildcard y Warcraft Reborn",
"Stopping the server no longer leaves the world running now and then": "Detener el servidor ya no deja el mundo en marcha de vez en cuando",
"The server includes a native launcher for the world supervisor": "El servidor incluye un lanzador nativo para el supervisor del mundo"
},
"zh": {
"Restrict new characters by custom race without changing existing characters": "限制新角色可选的自定义种族,不影响现有角色",
@@ -1650,7 +1734,13 @@
"The character sheet of a Two-Players head shows the other head's class": "Two-Players 头的角色面板会显示另一个头的职业",
"Two-Players Ogres can fit a carried mount in a window and share the fit": "Two-Players 食人魔可以在窗口中调整携带的坐骑并共享调整结果",
"Custom Races V2 with 17 new races, subclasses and the Fading Island": "Custom Races V2:17 个新种族、副职业和 Fading Island",
"Updated Custom Races to 2.0": "已将 Custom Races 更新至 2.0"
"Updated Custom Races to 2.0": "已将 Custom Races 更新至 2.0",
"Custom races stay on when an update changes the race catalog": "更新改变种族目录时,自定义种族保持开启",
"Server support for companion bots on Wildcard and Warcraft Reborn": "服务器支持 Wildcard 和 Warcraft Reborn 上的伙伴机器人",
"Custom-race characters stay out of the world while custom races are off": "自定义种族关闭时,该类角色无法进入世界",
"Companion bots play Wildcard and Warcraft Reborn": "伙伴机器人可在 Wildcard 和 Warcraft Reborn 中游戏",
"Stopping the server no longer leaves the world running now and then": "停止服务器时不再偶尔让世界继续运行",
"The server includes a native launcher for the world supervisor": "服务器附带用于世界监管程序的原生启动器"
}
}
}
+431
View File
@@ -1988,6 +1988,437 @@
},
"experimentalFeatures": [],
"compare": "https://github.com/Corfirean/coa-server-build/compare/server-0.261108.95...server-0.261114.106"
},
{
"tag": "server-0.261115.110",
"version": "0.261115.110",
"date": "2026-11-15",
"url": "https://github.com/Corfirean/coa-server-build/releases/tag/server-0.261115.110",
"notes": [
"Test build of the subclass module for two-headed Ogres",
"Thin Twins can earn a subclass through their own quest, the Bravery Badge",
"A two-headed Ogre's ranged subclass can shoot at point-blank range",
"Ogres have a new racial, Tolerance",
"Standard-class Ogres and Thin Humans start with only their own class kit",
"Helmets sit on the Thin Human's head instead of his chest",
"LiveMon shows live damage, healing, crowd control and subclass combo statistics",
"Standard-class Ogres and Thin Twins can take a CoA class as their subclass",
"Thin Human and Two-Headed Ogre are now their own playable races",
"Subclassed relic users can hold a relic beside a ranged weapon",
"Server options to limit subclassing or turn the two subclass races off",
"A standard subclass brings its whole basic kit, skills and weapons",
"Two-Headed Ogres and Thin Humans with a standard class can now pick a subclass",
"Thin Humans find more gold with the Hand-Me-Downs racial",
"Two-Headed Ogres wear helmets on both heads",
"Flying mounts no longer fly in Kalimdor and the Eastern Kingdoms",
"LiveMon's character tab can be closed and goes away for deleted characters",
"Classic classes can be limited to their Wrath of the Lich King abilities",
"Dual Wield shows once in the spellbook",
"Two-Headed Ogres get Subclass Bar 1 for the other head's spells",
"Subclass forms leave Two-Headed Ogres in their own body and turn the twin brother instead",
"CoA subclass trees show their specialization painting in the subclass tab",
"Characters with a subclass no longer get Dual Specialization",
"You can hold only one subclass book and one insight at a time",
"Thin Humans and Two-Headed Ogres get the quests of their starting zone",
"The Bravery Badge and the Book of Origins look and read like a badge and a book",
"Ghost Wolf and Travel Form turn the whole ogre, and the twin brother rides the beast",
"Standard-class mains can spend points in their subclass trees and reset main talents",
"Your subclass's trainer can reset only your subclass talents",
"The Thin Human's cape lies along his back instead of sticking out like a board",
"The twin brother finishes pointing before hopping off and readies his weapon with you",
"The twin brother fights with his melee weapon up close and sits close behind you on mounts",
"The twin brother copies your pose on hover discs, carpets and other unusual mounts",
"Two-Headed Ogres sit in cars and keep their mace drawn after a shot",
"Two-Headed Ogres fight with a weapon in one hand and a gun in the other",
"The Ogre's Agree or Disagree racial now shows what it will do next",
"The Thin Twins' brother turns into a worgen in every subclass Cursed Form",
"Leaps and charges ordered for the Thin Twins' brother move him instead of you",
"CoA classes taken as a subclass get their class mechanics",
"Thin Twins and Two-Headed Ogres keep their weapons in a subclass Cursed Form",
"Hovering a Guardian standard no longer causes a Lua error",
"LiveMon shows specialization names instead of their signature spells",
"Ogre eyes are picked by colour, with a Blind checkbox for each eye",
"Two-headed ogres no longer keep casting after a subclass spell with a cast time",
"Two-headed ogres cast every subclass spell with the left arm",
"The other half only shoots when you attack a target out of melee reach",
"The other head raises her hand while casting and your presses come first",
"Saving talent changes no longer fails for characters with a subclass",
"The second-way quest no longer pops up at level 20",
"Every race can create the standard classes the creation screen offers again",
"Subclass Bar 1 shows cooldowns, charges and casts like a normal action bar",
"Subclass Bar 1 refills itself when you change subclass",
"Subclass Bar 1 appears as soon as you choose a subclass",
"Subclass Bar 1 works like an action bar and can live in Bartender4",
"A subclass can never be the character's own class",
"New characters no longer inherit the subclass of a deleted character",
"Sun Cleric, Barbarian, Bloodmage and Cultist subclass resources use the game's own orbs",
"Shapeshifting no longer takes away the twin brother or the subclass",
"A subclass specialization now teaches the ability its passive promises",
"Subclass stances and forms appear only on the subclass stance bar",
"Subclass vows, auras and formations move to the subclass stance bar",
"The Thin Human's cape rests on his shoulders and moves with them",
"The twin brother gets a real spot in cars and rides along in passenger seats",
"The twin brother puts his weapons away while he wears a subclass shape",
"The Thin Twins' brother now shows the flash and glow of subclass forms",
"The twin brother sneaks along in stealth instead of staying behind",
"The stance button takes a Thin Twin out of a form his brother wears again",
"The Two-Head and Two-Thins tabs show one wide background and the right class icon",
"The Two-Head and Two-Thins trees use the game's own talent nodes",
"Agree or Disagree takes one spellbook slot that changes name and icon",
"Subclass talent trees no longer let you spend more points than you have",
"Your brother stays at your side when you melee with a bow equipped",
"A melee brother stays on your target and keeps fighting",
"The Two-Headed Ogre twists her body less while her other head casts",
"Thin Twins and Two-Headed Ogres are Hero Races that need a level 60 character",
"The Two-Headed Ogre's portrait shows both heads instead of her body",
"Your other half's spells break your stealth, and Running Wild ends when you stealth",
"Spells your other half casts now trigger the class's talents and resources",
"Your other half takes the subclass's Cat, Bear and stance forms on their own",
"Your other head or brother can no longer finish a cast while you run",
"The other head's hand glows while she casts",
"With Play Easy on, your other half uses abilities that cost health",
"New racial passives explain the shared and split resource pools",
"The dressing room works for races without their own background, no extra addon needed",
"Your brother climbs onto your Travel Form or wolf even after a fight",
"When your brother uses Running Wild, you ride on his back",
"In Running Wild you ride on your brother's shoulders",
"Your weapons no longer go missing after a Running Wild ride",
"When both halves use the same resource, their pool is twice as big",
"The subclass window shows every CoA class's own background at full strength",
"You can rearrange Subclass Bar 1 during combat without an error",
"Your other head or brother has a cast bar of their own",
"Choice talents in the subclass window show as one node with two options",
"SpellActivationOverlay can light up Subclass Bar 1",
"Your subclass's resource now shows as an extra bar under your portrait",
"Your other half's resource bar keeps its value when you log out and back in",
"Rage, energy and runic power subclasses now get and use their resource",
"Subclass resource orbs only appear when your subclass specialization can fill them",
"Your subclass specialization comes with its first class talent learned",
"Your main class's key stat now also powers your subclass",
"Subclass talents follow the paths and point requirements of their tree",
"Your summons follow your brother while he walks beside you",
"Your brother rides on the back of your Travel Form cat and moves with it",
"Dressing your twin in the wardrobe no longer causes an addon error",
"Your brother rides on your back in Wargstride",
"A Bloodmage subclass's Cursed Form no longer replaces your own action bar",
"Pressing an active subclass stance or form again turns it off",
"Character select shows your subclass under your class",
"The Two-Headed Ogre's second head no longer pokes through hats",
"Two-Headed Ogres keep aiming between shots instead of idling",
"Two-Headed Ogres who shoot rest their gun on the shoulder when not firing",
"Two-Headed Ogres who shoot themselves aim and fire their gun with the right hand",
"Two-Headed Ogres who shoot fire their bullets from the gun hand",
"The wardrobe shows a Two-Headed Ogre's applied look and her saved outfits apply again",
"The second head's quest mark floats over her head in cities and inns",
"Subclass Bar 1 no longer fills up with Throw, Shoot, Wand and Auto Attack",
"Abilities you learn from your subclass no longer land on your own action bars",
"A caster Two-Headed Ogre keeps her staff in hand while her second head shoots",
"A Two-Headed Ogre's staff keeps its size when she puts it on her back",
"A shooting subclass starts Auto Shot on right-click without logging out first",
"A Hunter subclass keeps Auto Shot going while the main head casts or moves",
"Weapons and armor from a subclass stay usable after logging in again",
"Two-Headed Ogres are Horde again and Thin Twins share Forgotten race rules",
"Thin Humans and Two-Headed Ogres can no longer be created as Hero",
"The Two-Headed Ogre stays in her combat stance between attacks",
"The second-head tab only shows for Two-Headed Ogres and Thin Twins",
"Thin Twins capes no longer show their inside at the shoulders",
"Thin Twins keep short hair under hats",
"Thin Twins keep their face, cape and hat fit with CoA Custom 1.9.2",
"Thin Twins show their class gear in character creation",
"Two-Headed Ogre capes drape over her back",
"CoA Custom 1.9.5 races work on the subclass server",
"With Play easy, cowboy the brother leaves a spent timed form",
"The Two-Headed Ogre casts with a raised fist before her face",
"The second-head client patch is now patch-ZZZZT.MPQ",
"Dual Wield shows once in the spellbook, whichever class teaches it",
"The subclass addon keeps working when the Twins or Ogre are renamed",
"The subclass name shows only on the character tab",
"The Thin Twins' Accursed brother keeps his distance until he takes his cursed form",
"The Thin Twins' brother follows a form's cost, cooldown and duration",
"The Thin Twins' own mana bar no longer flickers",
"Witch Hunter Vault now springs over in a handspring instead of a jump",
"The Twins brother keeps his timed form and no longer takes forms a spell forbids",
"The Twins brother faces his target, leaps in and leaves a form to heal you",
"With Play easy, cowboy, the brother uses his timed forms in a fight",
"Original races no longer look broken in the 64-bit client's character creation",
"Subclasses get their specialization's free passives, like the Pyromancer's draconic form",
"The subclass cast bar no longer gets stuck and can always be Alt-dragged",
"Pick-one talents in the subclass window no longer overlap their neighbours",
"Subclass spells get their rank upgrades, resources and class mechanics",
"Subclass talents that replace a spell now replace it for the subclass too",
"The Thin Twins keep their own hairstyle under hats",
"The Twins brother takes the look of the cursed form he actually uses",
"The Twins brother stands beside you at character select in his own clothes",
"The Twins brother climbs down from your back before taking a form",
"Spells the Twins brother casts no longer play a cast animation on you",
"The Thin Twins brother is now your mirror image",
"The Thin Twins brother can have his own face, hair style and beard",
"A script builds the original races' Vault patches from your own client files",
"The subclass client patch is now built after the release's own patches",
"The mirrored Thin Twins brother is built from the current Thin Twins model",
"Pressing your subclass mount again dismounts you",
"Removing a subclass dismisses the pet it let you summon",
"Removing a Warlock or Paladin subclass no longer unlearns your mounts",
"Removing a subclass no longer leaves its spells in your spellbook",
"A Starcaller subclass shows Lunar Phase as CoA's moon",
"Your twin's or other head's pet gets its own movable pet bar",
"A Ranged Head stands still while the Melee Head is offline",
"A bot plays the missing head of a Two-Players ogre",
"A Ranged Head keeps an echo of its deleted Melee Head's gear",
"Two-Players ogres hold books, pouches and orbs forward in the off hand",
"Two-Players ogres can pair up as Melee Head and Ranged Head",
"Paired Two-Players heads share one body",
"SquidBots Lite no longer prints \"Command 'dc status' does not exist\" at login",
"The subclass action bar no longer causes a blocked-action error in combat",
"Two-Players heads split their abilities into melee for the body and ranged for the rider",
"Two-Players heads gain Agree or Disagree stacks when they fight together",
"Two-Players heads can only be CoA classes",
"The Ranged Head's gear slots are frozen in ice and can no longer be dragged",
"Two-Players heads find the abilities they borrow on their own bar",
"Two-Players ogres can Bonk Heads! together once the heads have agreed long enough",
"Abilities lent between Two-Players heads follow each head's respecs and new spells",
"Two-Players ogres can use Mutate Me! to take the eyes-everywhere look and back",
"A Two-Players ogre fills one party spot and enters dungeons as one player",
"A Two-Players ogre joins a party only when there is room for both heads",
"A Ranged Head's own frame now stands for the shared Two-Players body",
"The Two-Players Ranged Head shares the body's health and both heads get full kill XP",
"The Two-Players Ranged Head shares the body's gear",
"Two-Players heads split quest gold, share one resource pool and keep their head's specs",
"Mobs attacked by the Two-Players Ranged Head now fight the body",
"Two-Players Twins: the second brother rides piggyback on the first, visible as himself",
"Bot plans panel shows what your group's bots are doing and lets you pick their next quest",
"Questing bots do all their quests in one area before moving on",
"The Twins' second brother keeps and wears his own gear on his brother's back",
"A Two-Players twin can call his brother to his side until another player joins him",
"Agree now raises spell and ranged hit too, not only melee hit",
"Two-Players ogres drop their mount when either head attacks",
"The other head's abilities now go on your own action bars",
"A bot body keeps questing, looting and resting after a fight instead of standing still",
"A bot body's SquidBots menu now opens from a button on your own player frame",
"Character select shows a Two-Players head's joined name and its partner's class",
"The Ranged Head now goes into and out of Dungeon Finder dungeons with the body",
"Two-Players can be switched off with Subclass.TwoPlayers.Enable",
"The other head's abilities only cost you resources when they actually go off",
"Character select shows a Two-Players ogre in his Mutate Me look",
"The Ranged Head gets the enchant, gem and suffix stats of the shared gear",
"The Ranged Head of a Two-Headed Ogre no longer pops out of the body at logout",
"A Ranged Head and its bot body are in one party again, so party chat and bot orders work",
"A bot riding as the Ranged Head no longer rests, roams or makes the body sit down",
"The character sheet of a Two-Players head shows the other head's class",
"Two-Players Ogres can fit a carried mount in a window and share the fit",
"Custom Races V2 with 17 new races, subclasses and the Fading Island",
"Updated Custom Races to 2.0"
],
"snapshot": "d3d10476d144d2a701a5a122f1f249ff8219f7a6324e007cb3e153d4628973f7",
"components": {
"upstream": {
"repository": "jealous-sound/azerothcore-wotlk-coa",
"ref": "96afaf0f51cc4b37f1eba282bffb1c5aab353de6",
"sha": "96afaf0f51cc4b37f1eba282bffb1c5aab353de6"
},
"core": {
"repository": "Corfirean/azerothcore-wotlk-coa",
"ref": "9740ced5c41806115d851ab37ab34f28e1e8b712",
"sha": "9740ced5c41806115d851ab37ab34f28e1e8b712"
},
"bots": {
"repository": "Corfirean/mod-coa-playerbots",
"ref": "30a5a555f56fda8f4ccad14be8438bd0532d85b9",
"sha": "30a5a555f56fda8f4ccad14be8438bd0532d85b9"
},
"scaling": {
"repository": "Corfirean/mod-coa-content-scaling",
"ref": "3c2febf636bd09087bb278e381b975271a70fdf6",
"sha": "3c2febf636bd09087bb278e381b975271a70fdf6"
},
"manager": {
"repository": "Corfirean/coa-server-manager",
"ref": "d3527312803fb5a3e1cd48e01496645a8bbc9dcf",
"sha": "d3527312803fb5a3e1cd48e01496645a8bbc9dcf"
},
"races": {
"repository": "ilusixn/CustomRacesCoa",
"ref": "coa-custom-2.0",
"sha": "dae0c661f7197bafd0a42d80866fa8709b3792c9",
"assets": [
{
"name": "CoA-Custom-Races-V2-Credits.csv",
"size": 5487,
"digest": "sha256:9afb0b777498d14601476bed7ce82a449ce2b80af5dae107f7309081c1936882",
"url": "https://github.com/ilusixn/CustomRacesCoa/releases/download/coa-custom-2.0/CoA-Custom-Races-V2-Credits.csv"
},
{
"name": "CoA-Custom-Races-V2-Credits.xlsx",
"size": 10129,
"digest": "sha256:d24b51f42870e9ab370279e37ea1cd894b7a208cb8960548c0f465222d50c850",
"url": "https://github.com/ilusixn/CustomRacesCoa/releases/download/coa-custom-2.0/CoA-Custom-Races-V2-Credits.xlsx"
},
{
"name": "CoA-Custom-V2-Client-1.zip",
"size": 1513021586,
"digest": "sha256:a9dd51ed2d90fb048d549602f40f5429d56e2df0df5606a38781b358fa369568",
"url": "https://github.com/ilusixn/CustomRacesCoa/releases/download/coa-custom-2.0/CoA-Custom-V2-Client-1.zip"
},
{
"name": "CoA-Custom-V2-Client-2.zip",
"size": 1198283005,
"digest": "sha256:ab084a55509ccbcc2977a06dd0c01fa879973a1892baaacaeb3ff52f3dfc750e",
"url": "https://github.com/ilusixn/CustomRacesCoa/releases/download/coa-custom-2.0/CoA-Custom-V2-Client-2.zip"
},
{
"name": "CoA-Custom-V2-Client-3.zip",
"size": 1671130705,
"digest": "sha256:0af34199f0739ce086adb0371d3de7c1a0f5ca9c62ecde6b0efe9286e33874a8",
"url": "https://github.com/ilusixn/CustomRacesCoa/releases/download/coa-custom-2.0/CoA-Custom-V2-Client-3.zip"
},
{
"name": "CoA-Custom-V2-Client-4.zip",
"size": 502385128,
"digest": "sha256:e0bd87172af989fa50a8e2b08ba4321c72b6265047482f051a1db3b80d55bcaa",
"url": "https://github.com/ilusixn/CustomRacesCoa/releases/download/coa-custom-2.0/CoA-Custom-V2-Client-4.zip"
},
{
"name": "CoA-Custom-V2-Client-5.zip",
"size": 168079711,
"digest": "sha256:73364ad1b58c6342641a848a3b20a835472834f600416606be1470386774ca78",
"url": "https://github.com/ilusixn/CustomRacesCoa/releases/download/coa-custom-2.0/CoA-Custom-V2-Client-5.zip"
},
{
"name": "CoA-Custom-V2-Client-6.zip",
"size": 1881526537,
"digest": "sha256:91db79b7b451856fa9e45daea52e0fe1c04676653dd8a88e6627f04ee7b47759",
"url": "https://github.com/ilusixn/CustomRacesCoa/releases/download/coa-custom-2.0/CoA-Custom-V2-Client-6.zip"
},
{
"name": "CoA-Custom-V2-Client-7.zip",
"size": 734725114,
"digest": "sha256:4c5532d775d206a3b913a6111040bb96b95c683b74c08a6131ed9f38db8e2b39",
"url": "https://github.com/ilusixn/CustomRacesCoa/releases/download/coa-custom-2.0/CoA-Custom-V2-Client-7.zip"
},
{
"name": "CoA-Custom-V2-Client-8.zip",
"size": 734216670,
"digest": "sha256:bdaa1d047e8767bd5715f1e8465d116220597d9c135a43e2dda02e12ce2e5526",
"url": "https://github.com/ilusixn/CustomRacesCoa/releases/download/coa-custom-2.0/CoA-Custom-V2-Client-8.zip"
},
{
"name": "CoA-Custom-V2-Client-9.zip",
"size": 195235400,
"digest": "sha256:0764893543084a12d15578fe734f66ba4519740794a6b3b3a38a08594c38c640",
"url": "https://github.com/ilusixn/CustomRacesCoa/releases/download/coa-custom-2.0/CoA-Custom-V2-Client-9.zip"
},
{
"name": "CoA-Custom-V2-Server.zip",
"size": 63983587,
"digest": "sha256:8970d61eea40f53cea4c27481edd85d2b2647cd32eb88932e0077da3b4a77d23",
"url": "https://github.com/ilusixn/CustomRacesCoa/releases/download/coa-custom-2.0/CoA-Custom-V2-Server.zip"
},
{
"name": "creation-screen.png",
"size": 2139517,
"digest": "sha256:84c3144f34ef8015e8612e412da03383241124d58e36c703eeb2a525096a5795",
"url": "https://github.com/ilusixn/CustomRacesCoa/releases/download/coa-custom-2.0/creation-screen.png"
},
{
"name": "INSTALL-GUIDE.txt",
"size": 2504,
"digest": "sha256:da402117a90a60a029fdce9a94125ddd28b386a73f37c180992befca57e9f13a",
"url": "https://github.com/ilusixn/CustomRacesCoa/releases/download/coa-custom-2.0/INSTALL-GUIDE.txt"
},
{
"name": "PATCH-NOTES-V2.txt",
"size": 4388,
"digest": "sha256:82901d54b1f13cd8b2e7a73a7c2fdc3e237f8090c332729bc553818834fe27d0",
"url": "https://github.com/ilusixn/CustomRacesCoa/releases/download/coa-custom-2.0/PATCH-NOTES-V2.txt"
},
{
"name": "RACES.md",
"size": 8629,
"digest": "sha256:1e7a9aaee354b07924a8cdda5e4dbffe4cad88f215d68efb74d8d0832403422d",
"url": "https://github.com/ilusixn/CustomRacesCoa/releases/download/coa-custom-2.0/RACES.md"
},
{
"name": "SHA256SUMS.txt",
"size": 938,
"digest": "sha256:a68591f04d661b558523133f99411fd4a7e32f1b45f79f977bb0989246f11179",
"url": "https://github.com/ilusixn/CustomRacesCoa/releases/download/coa-custom-2.0/SHA256SUMS.txt"
},
{
"name": "showcase.mp4",
"size": 81658913,
"digest": "sha256:a3d4b4f561bb12dcc91da562c5ee79157143f4b67997479edb2152b27b925a2a",
"url": "https://github.com/ilusixn/CustomRacesCoa/releases/download/coa-custom-2.0/showcase.mp4"
}
],
"server": [
{
"repository": "stefanw1337/azerothcore-wotlk-coa",
"branch": "stefanw1337-subclassing-test",
"sha": "ccea52d17a27482784e705e9cc913b68dedd9f85"
}
],
"provenance": [
{
"repository": "ilusixn/Fading-Islands-Restore",
"sha": "e150de1cb496314af752e98021e57ca93d5d799d",
"used": "server/core-patches"
},
{
"repository": "ilusixn/Custom-Race-3.3.5a",
"sha": "ac907655bd43dec2eff1b4ff509f7fb574325c58",
"used": "server/core racials"
},
{
"repository": "ilusixn/ilusixn-dev-menu",
"sha": "ea50a8533a3402c69c8773677db1027ec1180d2c",
"used": "modules/mod-ilusixn-devmenu"
}
]
},
"squid": {
"repository": "Zyth45/mod-playerbots",
"ref": "v3.0",
"sha": "4ef5ed9ebe75a330de7df19639a042391e037e15",
"patch": "patches/squid-coa-validation.patch",
"patchSha256": "2cc45bc6555d5bb3e91728840f9de6e73c002c73b270a37732a1499956241c5f"
},
"build": {
"repository": "Corfirean/coa-server-build",
"ref": "9a122d049e8be457444389e9756936bcdb4e7ef5",
"sha": "9a122d049e8be457444389e9756936bcdb4e7ef5"
},
"dungeon-clear": {
"repository": "Zyth45/mod-dungeon-clear",
"sha": "6efb59eae96bcc0730fc083314dd28d55970bbf4",
"patch": "patches/dungeon-clear-coa-validation.patch",
"patchSha256": "2845d389422e3a59e5c186ecf54b03f64f1dcc22cdef15729b60c354ae72cd6f",
"ref": "6efb59eae96bcc0730fc083314dd28d55970bbf4"
},
"navigation": {
"repository": "Corfirean/azerothcore-wotlk-coa",
"ref": "8b44099f480af0b69c6dfc697e4d388e865e9ffc",
"sha": "8b44099f480af0b69c6dfc697e4d388e865e9ffc",
"sourceRelease": "navigation-20261012",
"manifestSha256": "7f28600735f115792e79a5e8d1c8d78a83a8f5ed14a090c6d87268e49c2bb683",
"archiveSha256": "aa1347a095f85af44b4f592270a0e9314954801fda4578f0147f847e32c24a60",
"assets": [
{
"name": "navigation.zip.001",
"size": 1500000000,
"sha256": "e3a93903fc8155ee0d92db399ec426769c360bef87c44c07beb7e21cfd892c18",
"url": "https://github.com/Corfirean/coa-server-build/releases/download/navigation-20261012/navigation.zip.001"
},
{
"name": "navigation.zip.002",
"size": 1377006470,
"sha256": "c1af26ba7f83676278613076c357c4da0a11cfa6ae1ff00003479057c4864471",
"url": "https://github.com/Corfirean/coa-server-build/releases/download/navigation-20261012/navigation.zip.002"
}
]
}
},
"experimentalFeatures": [],
"compare": "https://github.com/Corfirean/coa-server-build/compare/server-0.261114.106...server-0.261115.110"
}
]
}
+12 -1
View File
@@ -1,6 +1,7 @@
// Dev-only: lets the UI run in a plain browser for visual review. Never bundled in production builds.
import { auctionCategories, auctionQualities } from "../lib/moduleSettings";
import moduleCatalog from "../../modules/catalog.json";
import addonCatalog from "../../addons/catalog.json";
import botsSchema from "../../schemas/bots.json";
import serverSchema from "../../schemas/server.json";
import botsPresets from "../../schemas/presets/bots.json";
@@ -29,6 +30,8 @@ export {};
(window as any).__TAURI_INTERNALS__ = {
transformCallback: (cb: unknown)=>cb, unregisterCallback(){}, convertFileSrc:(x: unknown)=>x,
invoke: async (cmd: string, args?: any)=>{
if(cmd==="clear_game_cache_on_play") return localStorage.getItem("demo-clear-cache")!=="0";
if(cmd==="set_clear_game_cache_on_play"){localStorage.setItem("demo-clear-cache",args.enabled?"1":"0");return;}
if(cmd==="close_to_tray") return localStorage.getItem("demo-close-tray")==="1";
if(cmd==="set_close_to_tray"){localStorage.setItem("demo-close-tray",args.enabled?"1":"0");return;}
if(cmd==="client_graphics") return JSON.parse(localStorage.getItem("demo-graphics")??'{"dxvk_disabled":false,"enhancements_disabled":false}');
@@ -39,6 +42,12 @@ export {};
if(cmd==="pending_update") return null;
if(cmd==="plugin:app|version") return "0.8.2";
if(cmd==="release_history") throw new Error("Offline demo: using bundled notes");
if(cmd==="addons_list"||cmd==="addons_install"||cmd==="addons_remove"){const w=window as any;w.__addons=w.__addons??{dragonui:"old"};if(cmd==="addons_install"){await new Promise(r=>setTimeout(r,700));w.__addons[args.addon]="new";}if(cmd==="addons_remove")delete w.__addons[args.addon];return addonCatalog.addons.map((a:any)=>({id:a.id,name:a.name,description:a.description,author:a.author,license:a.license,needs:a.needs??null,repo:a.repo,size:a.files.reduce((s:number,f:any)=>s+f.size,0),installed:a.id in w.__addons,updateAvailable:w.__addons[a.id]==="old",foreignFolders:a.id==="coacombat"&&!(a.id in w.__addons)?["CoACombat"]:[],bundled:null as string|null})).concat([{id:"coa-dev-menu",name:"CoA Dev Menu",description:{en:"The in-game /dev editor for game masters.",ru:"Внутриигровой редактор /dev для гейм-мастеров. Ставится вместе с клиентским патчем Custom Races V2 и включается вместе с ним."},author:"ilusixn",license:"see repository",needs:null,repo:"https://github.com/ilusixn/ilusixn-dev-menu",size:0,installed:true,updateAvailable:false,foreignFolders:[],bundled:"custom-races"}]);}
if(cmd==="custom_race_characters") return {players:2,companionBots:14,squidBots:0};
if(cmd==="purge_custom_race_bots"){await new Promise(r=>setTimeout(r,500));return 14;}
if(cmd==="restart_schedule"||cmd==="restart_schedule_save"){const w=window as any;w.__sched=w.__sched??{enabled:false,time:"05:00",warningMinutes:5};if(cmd==="restart_schedule_save"){const s=args.schedule;if(s.enabled&&!/^([01]\d|2[0-3]):[0-5]\d$/.test(s.time))throw new Error("The restart time must be HH:MM, for example 05:00.");w.__sched={...s};}return {schedule:w.__sched,supported:true};}
if(cmd==="mysql_custom"||cmd==="mysql_custom_save"){const w=window as any;if(cmd==="mysql_custom_save")w.__my=args.text;const text:string=w.__my??"";const applied=text.split("\n").map((l:string)=>l.trim()).filter((l:string)=>l&&!l.startsWith("#")&&!/^(port|datadir|basedir|bind[-_]address)\b/i.test(l)).map((l:string)=>l+"\n").join("");return {text,applied};}
if(cmd==="realm_names"||cmd==="realm_rename"){const w=window as any;w.__rn=w.__rn??{};const defs:[number,string][]=[[1,"Conquest of Azeroth"],[2,"Wildcard"]];if(cmd==="realm_rename"){await new Promise(r=>setTimeout(r,300));const n=(args.name??"").trim();if(n.length>32||n.includes('"'))throw new Error("The realm name can have at most 32 characters.");if(n)w.__rn[args.realmId]=n;else delete w.__rn[args.realmId];}return defs.map(([id,d])=>({id,name:w.__rn[id]??d,defaultName:d,custom:id in w.__rn}));}
if(cmd==="realm_profiles") return {active:realm,wildcard_created:wildcardCreated,reborn_created:rebornCreated,reborn_supported:true,supported:true,recovery_pending:false,simultaneous,secondary_world_port:simultaneous?8086:null,secondary_running:simultaneous&&running,with_reborn:withReborn,reborn_world_port:withReborn?8087:null,reborn_running:withReborn&&running};
if(cmd==="realm_simultaneous") { if(running) throw new Error("Stop both realms before changing simultaneous startup."); simultaneous=args.enabled; wildcardCreated ||= simultaneous; return {active:realm,wildcard_created:wildcardCreated,reborn_created:rebornCreated,reborn_supported:true,supported:true,recovery_pending:false,simultaneous,secondary_world_port:simultaneous?8086:null,secondary_running:false,with_reborn:withReborn,reborn_world_port:withReborn?8087:null,reborn_running:false}; }
if(cmd==="realm_with_reborn") { if(running) throw new Error("Stop all realms before changing which realms start together."); withReborn=args.enabled; rebornCreated ||= withReborn; return {active:realm,wildcard_created:wildcardCreated,reborn_created:rebornCreated,reborn_supported:true,supported:true,recovery_pending:false,simultaneous,secondary_world_port:simultaneous?8086:null,secondary_running:false,with_reborn:withReborn,reborn_world_port:withReborn?8087:null,reborn_running:false}; }
@@ -84,13 +93,15 @@ export {};
if(cmd==="realmlist_save"){const w=window as any;const rl=w.__rl;if(args.profileId){const p=rl.profiles.find((x: any)=>x.id===args.profileId);p.name=args.name;p.data=args.data;return p;}if(rl.profiles.some((x: any)=>x.name.toLowerCase()===String(args.name).toLowerCase()))throw {human:{code:"unknown",title:"",message:"",actions:[]},technical:"A realmlist with that name already exists."};const p={id:String(args.name).toLowerCase().replace(/[^a-z0-9]+/g,"-"),name:args.name,data:(/\s/.test(args.data.trim())?args.data.trim():"set realmlist "+args.data.trim())+"\r\n"};rl.profiles.push(p);return p;}
if(cmd==="realmlist_delete"){const rl=(window as any).__rl;rl.profiles=rl.profiles.filter((x: any)=>x.id!==args.profileId);return null;}
if(cmd==="account_delete") return null;
if(cmd==="modules_list") return [{id:"companions",name:"CoA Companions",description:{en:"Companion bots for groups, dungeons and your guild.",ru:"Боты-компаньоны для групп, подземелий и гильдии."},repo:"https://github.com/Corfirean/mod-coa-playerbots",installed:true,enabled:modState["companions"],switchable:true,status:"beta",icon:"bot",page:"bots"},{id:"content-scaling",name:"Content Scaling",description:{en:"Scales dungeons and raids to your group, with solo modes.",ru:"Подстраивает подземелья и рейды под вашу группу, есть соло-режимы."},repo:"https://github.com/Corfirean/mod-coa-content-scaling",installed:true,enabled:modState["content-scaling"],switchable:true,status:"early",icon:"scaling",page:null},{id:"tbc-content",name:"TBC Content",description:{en:"Outland dungeons and raids, scaled to your level range.",ru:"Подземелья и рейды Запределья, подогнанные под ваши уровни."},repo:"https://github.com/Corfirean/mod-coa-content-scaling/tree/main/content-packs/mod-coa-tbc-content",installed:true,enabled:modState["tbc-content"],switchable:true,status:"early",icon:"tbc",page:null},{id:"wotlk-content",name:"WotLK Content",description:{en:"Northrend dungeons and raids, scaled to your level range.",ru:"Подземелья и рейды Нордскола, подогнанные под ваши уровни."},repo:"https://github.com/Corfirean/mod-coa-content-scaling/tree/main/content-packs/mod-coa-wotlk-content",installed:true,enabled:modState["wotlk-content"],switchable:true,status:"early",icon:"wotlk",page:null},{id:"ah-bot",name:"Auction House Bot",description:{en:"Fills the auction house with realistic, adjustable listings.",ru:"Наполняет аукцион реалистичными настраиваемыми лотами."},repo:"https://github.com/Corfirean/azerothcore-wotlk-coa",installed:true,enabled:modState["ah-bot"] ?? false,switchable:true,status:"early",icon:"gavel",page:null,hidden:false},{id:"npc-enchanter",name:"NPC Enchanter",description:{en:"An NPC that enchants your gear for you.",ru:"НПС, который зачаровывает ваше снаряжение."},repo:"https://github.com/azerothcore/mod-npc-enchanter",installed:true,enabled:modState["npc-enchanter"],switchable:true,status:"early",icon:"sparkles",page:null,hidden:false},{id:"playerbots",name:"SQUID's Playerbots",description:{en:"An alternative bot system with random bots and full AI.",ru:"Альтернативная система ботов со случайными ботами и полным ИИ."},repo:"https://github.com/Zyth45/mod-playerbots",installed:true,enabled:modState["playerbots"] ?? false,switchable:true,status:"early",icon:"swords",page:"bots",hidden:false},{id:"client-compat",name:"Client compatibility",description:{en:"Client-server link and appearance unlocks.",ru:"Связь клиента с сервером и разблокировка внешних видов."},repo:"https://github.com/Corfirean/azerothcore-wotlk-coa",installed:true,enabled:modState["client-compat"],switchable:false,status:"release",icon:"plug",page:null,hidden:true}, ...moduleCatalog.modules.filter(m => m.id === "time-is-time").map(m => ({...m, installed:true, enabled:modState[m.id] ?? true, switchable:true, page:null, hidden:false}))].map(m => ({...m, has_settings: !["tbc-content", "wotlk-content"].includes(m.id), compatibility: realm !== "coa" ? (["companions", "playerbots"].includes(m.id) ? "unsupported" : m.id === "client-compat" ? "compatible" : "experimental") : "compatible", switchable: realm !== "coa" && ["companions", "playerbots"].includes(m.id) ? false : m.switchable}));
if(cmd==="modules_list") return [{id:"companions",name:"CoA Companions",description:{en:"Companion bots for groups, dungeons and your guild.",ru:"Боты-компаньоны для групп, подземелий и гильдии."},repo:"https://github.com/Corfirean/mod-coa-playerbots",installed:true,enabled:modState["companions"],switchable:true,status:"beta",icon:"bot",page:"bots"},{id:"content-scaling",name:"Content Scaling",description:{en:"Scales dungeons and raids to your group, with solo modes.",ru:"Подстраивает подземелья и рейды под вашу группу, есть соло-режимы."},repo:"https://github.com/Corfirean/mod-coa-content-scaling",installed:true,enabled:modState["content-scaling"],switchable:true,status:"early",icon:"scaling",page:null},{id:"tbc-content",name:"TBC Content",description:{en:"Outland dungeons and raids, scaled to your level range.",ru:"Подземелья и рейды Запределья, подогнанные под ваши уровни."},repo:"https://github.com/Corfirean/mod-coa-content-scaling/tree/main/content-packs/mod-coa-tbc-content",installed:true,enabled:modState["tbc-content"],switchable:true,status:"early",icon:"tbc",page:null},{id:"wotlk-content",name:"WotLK Content",description:{en:"Northrend dungeons and raids, scaled to your level range.",ru:"Подземелья и рейды Нордскола, подогнанные под ваши уровни."},repo:"https://github.com/Corfirean/mod-coa-content-scaling/tree/main/content-packs/mod-coa-wotlk-content",installed:true,enabled:modState["wotlk-content"],switchable:true,status:"early",icon:"wotlk",page:null},{id:"ah-bot",name:"Auction House Bot",description:{en:"Fills the auction house with realistic, adjustable listings.",ru:"Наполняет аукцион реалистичными настраиваемыми лотами."},repo:"https://github.com/Corfirean/azerothcore-wotlk-coa",installed:true,enabled:modState["ah-bot"] ?? false,switchable:true,status:"early",icon:"gavel",page:null,hidden:false},{id:"npc-enchanter",name:"NPC Enchanter",description:{en:"An NPC that enchants your gear for you.",ru:"НПС, который зачаровывает ваше снаряжение."},repo:"https://github.com/azerothcore/mod-npc-enchanter",installed:true,enabled:modState["npc-enchanter"],switchable:true,status:"early",icon:"sparkles",page:null,hidden:false},{id:"playerbots",name:"SQUID's Playerbots",description:{en:"An alternative bot system with random bots and full AI.",ru:"Альтернативная система ботов со случайными ботами и полным ИИ."},repo:"https://github.com/Zyth45/mod-playerbots",installed:true,enabled:modState["playerbots"] ?? false,switchable:true,status:"early",icon:"swords",page:"bots",hidden:false},{id:"client-compat",name:"Client compatibility",description:{en:"Client-server link and appearance unlocks.",ru:"Связь клиента с сервером и разблокировка внешних видов."},repo:"https://github.com/Corfirean/azerothcore-wotlk-coa",installed:true,enabled:modState["client-compat"],switchable:false,status:"release",icon:"plug",page:null,hidden:true}, ...moduleCatalog.modules.filter(m => ["time-is-time", "custom-races", "subclass", "dev-menu"].includes(m.id)).map(m => ({...m, installed:true, enabled:modState[m.id] ?? true, switchable:true, page:null, hidden:(m as any).hidden ?? false}))].map(m => ({...m, has_settings: !["tbc-content", "wotlk-content"].includes(m.id), compatibility: realm !== "coa" ? (["companions", "playerbots"].includes(m.id) ? "unsupported" : m.id === "client-compat" ? "compatible" : "experimental") : "compatible", switchable: realm !== "coa" && ["companions", "playerbots"].includes(m.id) ? false : m.switchable}));
if(cmd==="module_set_enabled"){ if(args.enabled && ["companions","playerbots"].includes(args.module) && modState[args.module === "companions" ? "playerbots" : "companions"]) throw {human:{code:"bot_modules_conflict",title:"",message:"",actions:[]},technical:"Only one bot system may be enabled."}; modState[args.module]=args.enabled; return null; }
if(cmd==="all_settings") return [{key:"Visibility.Distance.Continents",value:"100",default:"90",doc:"Description: Visibility distance on continents. Range: 45-250 Default: 90",changed:true},{key:"Death.SicknessLevel",value:"11",default:"11",doc:"Description: Character level up to which characters get resurrection sickness. Default: 11",changed:false},{key:"Rate.Drop.Item.Epic",value:"3",default:"1",doc:"Description: Drop rates for money and items based on quality. Default: 1",changed:true},{key:"Instance.ResetTimeHour",value:"4",default:"4",doc:"Description: Hour of the day when the global instance reset occurs. Range: 0-23 Default: 4 - (04:00 AM)",changed:false},{key:"PlayerLimit",value:"1000",default:"1000",doc:"Description: Maximum number of players in the world.",changed:false}];
if(cmd==="all_settings_save") return Object.keys(args&&args.changes||{});
if(cmd==="module_settings" && args.module==="client-compat") return [{key:"CoA.UnlockLocalAppearanceCatalog",value:"1",default:"1",doc:""},{key:"CoA.UnlockAllVanity",value:"1",default:"1",doc:""},{key:"CoA.AutoCollectAppearances",value:"0",default:"1",doc:""},{key:"CoA.LearnOwnedCompanions",value:"1",default:"1",doc:""},{key:"CoA.MaxRidingFromStart",value:"1",default:"1",doc:""}];
if(cmd==="module_settings"){
const S:Record<string,{key:string;value:string;default:string;doc:string}[]>={
"subclass": [["Subclass.Enable","1"],["Subclass.MinLevel","20"],["Subclass.ThinHuman.Enable","1"],["Subclass.TwoHeadedOgre.Enable","1"],["Subclass.TwoPlayers.Enable","1"],["Subclass.StandardClasses","0"],["Subclass.StandardMains","0"],["Subclass.HeroRaces.RequiredLevel","60"],["Subclass.BookDropChance","5"]].map(([key,value])=>({key,value,default:value,doc:"Option of mod-subclass."})),
"dev-menu": [{key:"DevMenu.Enable",value:"1",default:"1",doc:"Answer the addon's requests."},{key:"DevMenu.MinSecurity",value:"2",default:"2",doc:"Lowest account security level allowed to use the menu."},{key:"DevMenu.Items.FirstId",value:"0",default:"0",doc:"First id of the item ids the Create an item tab uses."}],
"time-is-time": [{key:"TimeIsTime.Enable",value:"1",default:"1",doc:""},{key:"TimeIsTime.Announce",value:"1",default:"1",doc:""},{key:"TimeIsTime.SpeedRate",value:"1.0",default:"1.0",doc:""},{key:"TimeIsTime.TimeStart",value:"0",default:"0",doc:""},{key:"TimeIsTime.HourOffset",value:"0.0",default:"0.0",doc:""}],
"npc-enchanter":[{key:"Enchanter.Enable",value:"1",default:"1",doc:"Enable the module."},{key:"Enchanter.Announce",value:"0",default:"0",doc:"Announce the module when the player logs in."},{key:"Enchanter.CostCopper",value:"0",default:"0",doc:"What one enchantment costs, in copper (10000 = 1 gold). 0 = free."},{key:"Enchanter.MessageTimer",value:"60000",default:"60000",doc:"How often the NPC emotes, in milliseconds."}],
"playerbots":[{"key": "AiPlayerbot.RandomBotAutologin", "value": "1", "default": "1", "doc": ""}, {"key": "AiPlayerbot.MinRandomBots", "value": "500", "default": "500", "doc": ""}, {"key": "AiPlayerbot.MaxRandomBots", "value": "500", "default": "500", "doc": ""}, {"key": "AiPlayerbot.RandomBotAccountCount", "value": "0", "default": "0", "doc": ""}, {"key": "AiPlayerbot.RandomBotMinLevel", "value": "1", "default": "1", "doc": ""}, {"key": "AiPlayerbot.RandomBotMaxLevel", "value": "60", "default": "60", "doc": ""}, {"key": "AiPlayerbot.SyncLevelWithPlayers", "value": "0", "default": "0", "doc": ""}, {"key": "AiPlayerbot.RandomBotInvitePlayer", "value": "0", "default": "0", "doc": ""}, {"key": "AiPlayerbot.RandomBotJoinLfg", "value": "1", "default": "1", "doc": ""}, {"key": "AiPlayerbot.RandomBotJoinBG", "value": "1", "default": "1", "doc": ""}, {"key": "AiPlayerbot.RandomBotAutoJoinBG", "value": "0", "default": "0", "doc": ""}, {"key": "AiPlayerbot.RandomBotTalk", "value": "1", "default": "1", "doc": ""}, {"key": "AiPlayerbot.RandomBotEmote", "value": "0", "default": "0", "doc": ""}, {"key": "AiPlayerbot.RandomBotSuggestDungeons", "value": "1", "default": "1", "doc": ""}, {"key": "AiPlayerbot.CoaClassesOnly", "value": "1", "default": "1", "doc": ""}, {"key": "AiPlayerbot.CoaSmartHeal", "value": "1", "default": "1", "doc": ""}, {"key": "AiPlayerbot.CoaSmartTank", "value": "1", "default": "1", "doc": ""}, {"key": "AiPlayerbot.CoaSpecRotations", "value": "1", "default": "1", "doc": ""}, {"key": "AiPlayerbot.CoaInterruptCoordination", "value": "1", "default": "1", "doc": ""}, {"key": "AiPlayerbot.MaxAddedBots", "value": "40", "default": "40", "doc": ""}, {"key": "AiPlayerbot.BotAutologin", "value": "0", "default": "0", "doc": ""}, {"key": "AiPlayerbot.DisabledWithoutRealPlayer", "value": "0", "default": "0", "doc": ""}, {"key": "AiPlayerbot.AddClassCommand", "value": "1", "default": "1", "doc": ""}, {"key": "AiPlayerbot.KeepAltsInGroup", "value": "0", "default": "0", "doc": ""}, {"key": "AiPlayerbot.CoaRecruitSameFaction", "value": "1", "default": "1", "doc": ""}, {"key": "AiPlayerbot.CoaLfgBots", "value": "1", "default": "1", "doc": ""}, {"key": "AiPlayerbot.RandomBotXPRate", "value": "1.0", "default": "1.0", "doc": ""}, {"key": "AiPlayerbot.FollowDistance", "value": "1.5", "default": "1.5", "doc": ""}, {"key": "AiPlayerbot.Enabled", "value": "0", "default": "0", "doc": ""}, {"key": "AiPlayerbot.RandomBotAccountPrefix", "value": "\"rndbot\"", "default": "\"rndbot\"", "doc": ""}, {"key": "AiPlayerbot.RandomBotUpdateInterval", "value": "20", "default": "20", "doc": ""}],
+38
View File
@@ -773,6 +773,44 @@ const de: Partial<Record<keyof typeof en, string>> = {
"overview.reportBtn": "Diagnose sammeln und melden",
// Realmlist switcher and modules page
"mysql.title": "MySQL-Einstellungen",
"mysql.hint": "Eigene MySQL-Optionen, eine Zeile name = wert. Sie werden bei jedem Start der Datenbank zu my.ini hinzugefügt und bleiben nach Updates erhalten. Port, Adressen und Datenpfade verwaltet der Manager; hier werden sie ignoriert.",
"mysql.save": "Speichern",
"mysql.saved": "Gespeichert; Server neu starten, um sie anzuwenden.",
"mysql.applied": "Angewandte Optionen: {count}",
"sched.title": "Geplanter Neustart",
"sched.enable": "Die Welt jeden Tag neu starten",
"sched.time": "Uhrzeit",
"sched.warning": "Vorwarnung (Minuten)",
"sched.hint": "Die Welt startet zu dieser Uhrzeit dieses Computers neu, mit einem Countdown im Spielchat; die Datenbank läuft weiter, Spieler melden sich danach wieder an. Ein laufender Server übernimmt die neue Zeit innerhalb einer Minute.",
"sched.save": "Speichern",
"sched.saved": "Gespeichert.",
"sched.unsupported": "Dieser Server kann das noch nicht: Aktualisiere ihn auf einen Build mit dem neuen Launcher.",
"client.clearCache": "Spiel-Cache vor jedem Start leeren",
"client.clearCacheHint": "Das Spiel merkt sich Kreaturen, Gegenstände und Quests vom Server (Cache/WDB). Nach einem Server-Update zeigen sie sonst alte Namen und Werte; der Cache füllt sich in Sekunden wieder.",
"addons.withServer": "Kommt mit dem Server und wird mit ihm aktualisiert.",
"addons.withRaces": "Mit dem Client-Patch Custom Races V2 installiert und mit ihm geschaltet; der Manager installiert ihn nicht separat.",
"addons.withRacesMissing": "Kommt mit dem Client-Patch Custom Races V2 (Module, Custom Races); installiere den Patch, um ihn zu bekommen.",
"addons.title": "Addons",
"addons.hint": "Community-Addons für Conquest of Azeroth. Jedes kommt in einer geprüften Version vom GitHub seines Autors; jede Datei wird vor der Installation in Interface/AddOns geprüft. Schließe zuerst das Spiel.",
"addons.by": "von {author}",
"addons.installed": "Installiert",
"addons.update": "Update verfügbar",
"addons.needsSquid": "Für SQUID's Playerbots.",
"addons.foreign": "Ein Ordner {folders} ist schon da; er wird nach AddOns/.coa-addons-backup verschoben.",
"addons.doInstall": "Installieren",
"addons.doUpdate": "Aktualisieren",
"addons.doRemove": "Entfernen",
"races.offCharacters": "Eigene Völker sind aus: {players} Spielerfigur(en) und {bots} Bot(s) eigener Völker bleiben der Welt fern, bis sie wieder an sind (ein Client ohne Patch würde bei ihnen abstürzen).",
"races.purgeBots": "{n} Begleiter-Bot(s) eigener Völker löschen",
"races.purged": "{n} Bot(s) eigener Völker gelöscht.",
"realm.namesTitle": "Realmnamen",
"realm.namesHint": "So heißt der Realm in der Realmliste der Spieler. Ein laufender Server zeigt den Namen sofort, und er bleibt nach Updates erhalten.",
"realm.nameSave": "Speichern",
"realm.nameReset": "Standardname",
"realm.nameDefault": "Standard: {name}",
"realm.nameSaved": "Gespeichert.",
"realm.nameQuotes": "Anführungszeichen sind nicht erlaubt: Der Spielclient speichert den Namen in Anführungszeichen.",
"realm.profileLabel": "Realm",
"realm.switching": "Realm wird gewechselt…",
"realm.rebornCreate": "Warcraft-Reborn-Realm erstellen",
+38
View File
@@ -57,6 +57,44 @@ const en = {
"remote.hostInstead": "Host my own server",
"welcome.roleSubtitle": "How would you like to play?",
"mysql.title": "MySQL settings",
"mysql.hint": "Your own MySQL options, one name = value per line. They are added to my.ini at every start of the database and stay after updates. The port, addresses and data paths are managed by the Manager and ignored here.",
"mysql.save": "Save",
"mysql.saved": "Saved; restart the server to apply.",
"mysql.applied": "Options applied: {count}",
"sched.title": "Scheduled restart",
"sched.enable": "Restart the world every day",
"sched.time": "Time",
"sched.warning": "Warning (minutes)",
"sched.hint": "The world restarts at this time of this computer with a countdown in the game chat; the database keeps running and players log in again after it. A minute after saving, the running server follows the new time.",
"sched.save": "Save",
"sched.saved": "Saved.",
"sched.unsupported": "This server cannot do it yet: update the server to a build with the new launcher.",
"client.clearCache": "Clear the game cache before every Play",
"client.clearCacheHint": "The game remembers creatures, items and quests it got from a server (Cache/WDB). After a server update they can show old names and stats; the cache fills again within seconds.",
"addons.withServer": "Comes with the server and is updated with it.",
"addons.withRaces": "Installed with the Custom Races V2 client patch and switched with it; the Manager does not install it separately.",
"addons.withRacesMissing": "Comes with the Custom Races V2 client patch (Modules, Custom Races); install the patch to get it.",
"addons.title": "Addons",
"addons.hint": "Community addons for Conquest of Azeroth. Each comes from its author's GitHub at a checked version; every file is verified before it is installed into Interface/AddOns. Close the game first.",
"addons.by": "by {author}",
"addons.installed": "Installed",
"addons.update": "Update available",
"addons.needsSquid": "For SQUID's Playerbots.",
"addons.foreign": "A folder named {folders} is already there; it will be moved to AddOns/.coa-addons-backup.",
"addons.doInstall": "Install",
"addons.doUpdate": "Update",
"addons.doRemove": "Remove",
"races.offCharacters": "Custom races are off: {players} player character(s) and {bots} bot(s) of custom races stay out of the world until they are on again (a game client without the patch would crash on them).",
"races.purgeBots": "Delete the {n} companion bot(s) of custom races",
"races.purged": "Deleted {n} bot(s) of custom races.",
"realm.namesTitle": "Realm names",
"realm.namesHint": "The name players see in the realm list. A running server shows it at once, and it stays after updates.",
"realm.nameSave": "Save",
"realm.nameReset": "Default name",
"realm.nameDefault": "Default: {name}",
"realm.nameSaved": "Saved.",
"realm.nameQuotes": "Quotation marks are not allowed: the game client stores the name in quotes.",
"realm.profileLabel": "Realm",
"realm.startupTitle": "Realm startup",
"realm.secondWorld": "Second world",
+38
View File
@@ -773,6 +773,44 @@ const es: Partial<Record<keyof typeof en, string>> = {
"overview.reportBtn": "Reunir el diagnóstico y avisar",
// Realmlist switcher and modules page
"mysql.title": "Ajustes de MySQL",
"mysql.hint": "Tus propias opciones de MySQL, una línea nombre = valor. Se añaden a my.ini en cada inicio de la base de datos y se mantienen tras las actualizaciones. El puerto, las direcciones y las rutas de datos los gestiona el Manager y aquí se ignoran.",
"mysql.save": "Guardar",
"mysql.saved": "Guardado; reinicia el servidor para aplicarlo.",
"mysql.applied": "Opciones aplicadas: {count}",
"sched.title": "Reinicio programado",
"sched.enable": "Reiniciar el mundo cada día",
"sched.time": "Hora",
"sched.warning": "Aviso (minutos)",
"sched.hint": "El mundo se reinicia a esta hora de este ordenador con una cuenta atrás en el chat del juego; la base de datos sigue en marcha y los jugadores vuelven a entrar después. Un servidor en marcha sigue la nueva hora en menos de un minuto.",
"sched.save": "Guardar",
"sched.saved": "Guardado.",
"sched.unsupported": "Este servidor aún no puede hacerlo: actualízalo a una versión con el nuevo lanzador.",
"client.clearCache": "Vaciar la caché del juego antes de cada inicio",
"client.clearCacheHint": "El juego recuerda criaturas, objetos y misiones recibidos del servidor (Cache/WDB). Tras actualizar el servidor pueden mostrar nombres y estadísticas antiguos; la caché se llena de nuevo en segundos.",
"addons.withServer": "Viene con el servidor y se actualiza con él.",
"addons.withRaces": "Instalado con el parche de cliente Custom Races V2 y activado con él; el Manager no lo instala por separado.",
"addons.withRacesMissing": "Viene con el parche de cliente Custom Races V2 (Módulos, Custom Races); instala el parche para tenerlo.",
"addons.title": "Addons",
"addons.hint": "Addons de la comunidad para Conquest of Azeroth. Cada uno viene del GitHub de su autor en una versión comprobada; cada archivo se verifica antes de instalarlo en Interface/AddOns. Cierra antes el juego.",
"addons.by": "de {author}",
"addons.installed": "Instalado",
"addons.update": "Actualización disponible",
"addons.needsSquid": "Para SQUID's Playerbots.",
"addons.foreign": "Ya hay una carpeta {folders}; se moverá a AddOns/.coa-addons-backup.",
"addons.doInstall": "Instalar",
"addons.doUpdate": "Actualizar",
"addons.doRemove": "Quitar",
"races.offCharacters": "Las razas personalizadas están desactivadas: {players} personaje(s) de jugadores y {bots} bot(s) de esas razas quedan fuera del mundo hasta reactivarlas (un cliente sin el parche se cerraría al verlos).",
"races.purgeBots": "Borrar los {n} bot(s) acompañantes de razas personalizadas",
"races.purged": "Borrados {n} bot(s) de razas personalizadas.",
"realm.namesTitle": "Nombres de los reinos",
"realm.namesHint": "El nombre que ven los jugadores en la lista de reinos. Un servidor en marcha lo muestra al instante y se mantiene tras las actualizaciones.",
"realm.nameSave": "Guardar",
"realm.nameReset": "Nombre predeterminado",
"realm.nameDefault": "Predeterminado: {name}",
"realm.nameSaved": "Guardado.",
"realm.nameQuotes": "No se permiten comillas: el cliente del juego guarda el nombre entre comillas.",
"realm.profileLabel": "Reino",
"realm.switching": "Cambiando de reino…",
"realm.rebornCreate": "Crear reino Warcraft Reborn",
+38
View File
@@ -773,6 +773,44 @@ const fr: Partial<Record<keyof typeof en, string>> = {
"overview.reportBtn": "Rassembler le diagnostic et signaler",
// Realmlist switcher and modules page
"mysql.title": "Paramètres MySQL",
"mysql.hint": "Vos propres options MySQL, une ligne nom = valeur. Elles sont ajoutées à my.ini à chaque démarrage de la base et restent après les mises à jour. Le port, les adresses et les chemins de données sont gérés par le Manager et ignorés ici.",
"mysql.save": "Enregistrer",
"mysql.saved": "Enregistré ; redémarrez le serveur pour appliquer.",
"mysql.applied": "Options appliquées : {count}",
"sched.title": "Redémarrage planifié",
"sched.enable": "Redémarrer le monde chaque jour",
"sched.time": "Heure",
"sched.warning": "Avertissement (minutes)",
"sched.hint": "Le monde redémarre à cette heure de cet ordinateur avec un compte à rebours dans le chat du jeu ; la base de données continue de tourner et les joueurs se reconnectent ensuite. Un serveur en marche suit la nouvelle heure en moins d'une minute.",
"sched.save": "Enregistrer",
"sched.saved": "Enregistré.",
"sched.unsupported": "Ce serveur ne le permet pas encore : mettez-le à jour vers une version avec le nouveau lanceur.",
"client.clearCache": "Vider le cache du jeu avant chaque lancement",
"client.clearCacheHint": "Le jeu garde les créatures, objets et quêtes reçus du serveur (Cache/WDB). Après une mise à jour du serveur, ils peuvent montrer d'anciens noms et statistiques ; le cache se remplit en quelques secondes.",
"addons.withServer": "Fourni avec le serveur et mis à jour avec lui.",
"addons.withRaces": "Installé avec le patch client Custom Races V2 et activé avec lui ; le Manager ne l'installe pas séparément.",
"addons.withRacesMissing": "Fourni avec le patch client Custom Races V2 (Modules, Custom Races) ; installez le patch pour l'obtenir.",
"addons.title": "Addons",
"addons.hint": "Addons de la communauté pour Conquest of Azeroth. Chacun vient du GitHub de son auteur dans une version vérifiée ; chaque fichier est contrôlé avant l'installation dans Interface/AddOns. Fermez d'abord le jeu.",
"addons.by": "par {author}",
"addons.installed": "Installé",
"addons.update": "Mise à jour disponible",
"addons.needsSquid": "Pour SQUID's Playerbots.",
"addons.foreign": "Un dossier {folders} existe déjà ; il sera déplacé vers AddOns/.coa-addons-backup.",
"addons.doInstall": "Installer",
"addons.doUpdate": "Mettre à jour",
"addons.doRemove": "Supprimer",
"races.offCharacters": "Les races personnalisées sont désactivées : {players} personnage(s) de joueurs et {bots} bot(s) de ces races restent hors du monde jusqu'à leur réactivation (un client sans le patch planterait en les voyant).",
"races.purgeBots": "Supprimer les {n} bot(s) compagnons de races personnalisées",
"races.purged": "{n} bot(s) de races personnalisées supprimé(s).",
"realm.namesTitle": "Noms des royaumes",
"realm.namesHint": "Le nom que les joueurs voient dans la liste des royaumes. Un serveur en marche l'affiche aussitôt, et il reste après les mises à jour.",
"realm.nameSave": "Enregistrer",
"realm.nameReset": "Nom par défaut",
"realm.nameDefault": "Par défaut : {name}",
"realm.nameSaved": "Enregistré.",
"realm.nameQuotes": "Les guillemets ne sont pas autorisés : le client du jeu enregistre le nom entre guillemets.",
"realm.profileLabel": "Royaume",
"realm.switching": "Changement de royaume…",
"realm.rebornCreate": "Créer le royaume Warcraft Reborn",
+38
View File
@@ -60,6 +60,44 @@ const ru: Partial<Record<keyof typeof en, string>> = {
"remote.hostInstead": "Создать свой сервер",
"welcome.roleSubtitle": "Как вы хотите играть?",
"mysql.title": "Настройки MySQL",
"mysql.hint": "Свои параметры MySQL, по одному «имя = значение» в строке. Они добавляются в my.ini при каждом запуске базы и сохраняются после обновлений. Порт, адреса и пути к данным задаёт Manager, здесь они игнорируются.",
"mysql.save": "Сохранить",
"mysql.saved": "Сохранено; перезапустите сервер, чтобы применить.",
"mysql.applied": "Применяется параметров: {count}",
"sched.title": "Перезапуск по расписанию",
"sched.enable": "Перезапускать мир каждый день",
"sched.time": "Время",
"sched.warning": "Предупреждение (минуты)",
"sched.hint": "Мир перезапускается в это время этого компьютера, с обратным отсчётом в игровом чате; база данных продолжает работать, игроки заходят снова после перезапуска. Работающий сервер подхватывает новое время в течение минуты.",
"sched.save": "Сохранить",
"sched.saved": "Сохранено.",
"sched.unsupported": "Этот сервер пока так не умеет: обновите его до сборки с новым лаунчером.",
"client.clearCache": "Очищать кэш игры перед каждым запуском",
"client.clearCacheHint": "Игра запоминает существ, предметы и задания, полученные от сервера (Cache/WDB). После обновления сервера там остаются старые названия и характеристики; кэш снова заполняется за секунды.",
"addons.withServer": "Поставляется вместе с сервером и обновляется вместе с ним.",
"addons.withRaces": "Установлен вместе с клиентским патчем Custom Races V2 и включается вместе с ним; отдельно Manager его не ставит.",
"addons.withRacesMissing": "Поставляется с клиентским патчем Custom Races V2 (Модули → Custom Races); установите патч, чтобы он появился.",
"addons.title": "Аддоны",
"addons.hint": "Аддоны сообщества для Conquest of Azeroth. Каждый берётся с GitHub автора в проверенной версии; перед установкой в Interface/AddOns проверяется каждый файл. Сначала закройте игру.",
"addons.by": "автор: {author}",
"addons.installed": "Установлен",
"addons.update": "Есть обновление",
"addons.needsSquid": "Для SQUID's Playerbots.",
"addons.foreign": "Папка {folders} уже есть; она будет перенесена в AddOns/.coa-addons-backup.",
"addons.doInstall": "Установить",
"addons.doUpdate": "Обновить",
"addons.doRemove": "Удалить",
"races.offCharacters": "Кастомные расы выключены: {players} персонаж(ей) игроков и {bots} бот(ов) кастомных рас не входят в мир, пока расы снова не включены (клиент без патча падал бы при виде их).",
"races.purgeBots": "Удалить ботов-компаньонов кастомных рас: {n}",
"races.purged": "Удалено ботов кастомных рас: {n}.",
"realm.namesTitle": "Названия реалмов",
"realm.namesHint": "Так реалм называется в списке реалмов у игроков. Работающий сервер показывает новое название сразу, и оно сохраняется после обновлений.",
"realm.nameSave": "Сохранить",
"realm.nameReset": "Стандартное название",
"realm.nameDefault": "По умолчанию: {name}",
"realm.nameSaved": "Сохранено.",
"realm.nameQuotes": "Кавычки нельзя: клиент игры хранит название в кавычках.",
"realm.profileLabel": "Реалм",
"realm.startupTitle": "Запуск реалмов",
"realm.secondWorld": "Второй мир",
+38
View File
@@ -58,6 +58,44 @@ const zh = {
"remote.hostInstead": "搭建自己的服务器",
"welcome.roleSubtitle": "你想如何游玩?",
"mysql.title": "MySQL 设置",
"mysql.hint": "自定义 MySQL 选项,每行一个“名称 = 值”。每次数据库启动时都会加入 my.ini,更新后也会保留。端口、地址和数据路径由 Manager 管理,此处会被忽略。",
"mysql.save": "保存",
"mysql.saved": "已保存;重启服务器后生效。",
"mysql.applied": "生效的选项:{count}",
"sched.title": "定时重启",
"sched.enable": "每天重启世界",
"sched.time": "时间",
"sched.warning": "提前警告(分钟)",
"sched.hint": "世界会在本机的这个时间重启,并在游戏聊天中倒计时;数据库保持运行,玩家在重启后重新登录。正在运行的服务器会在一分钟内采用新时间。",
"sched.save": "保存",
"sched.saved": "已保存。",
"sched.unsupported": "此服务器暂不支持:请将服务器更新到带有新启动器的版本。",
"client.clearCache": "每次启动前清空游戏缓存",
"client.clearCacheHint": "游戏会保存从服务器获得的生物、物品和任务(Cache/WDB)。服务器更新后,这些缓存可能显示旧的名称和属性;缓存会在几秒内重新生成。",
"addons.withServer": "随服务器提供,并随服务器一起更新。",
"addons.withRaces": "随 Custom Races V2 客户端补丁安装并一起开关;Manager 不会单独安装它。",
"addons.withRacesMissing": "随 Custom Races V2 客户端补丁提供(模块 → Custom Races);安装补丁后即可获得。",
"addons.title": "插件",
"addons.hint": "Conquest of Azeroth 的社区插件。每个插件都来自作者的 GitHub 的已核验版本;安装到 Interface/AddOns 前会逐个校验文件。请先关闭游戏。",
"addons.by": "作者:{author}",
"addons.installed": "已安装",
"addons.update": "有可用更新",
"addons.needsSquid": "用于 SQUID's Playerbots。",
"addons.foreign": "已存在名为 {folders} 的文件夹;它会被移到 AddOns/.coa-addons-backup。",
"addons.doInstall": "安装",
"addons.doUpdate": "更新",
"addons.doRemove": "移除",
"races.offCharacters": "自定义种族已关闭:{players} 个玩家角色和 {bots} 个自定义种族机器人在重新开启前不会进入世界(没有补丁的游戏客户端看到它们会崩溃)。",
"races.purgeBots": "删除 {n} 个自定义种族的伙伴机器人",
"races.purged": "已删除 {n} 个自定义种族机器人。",
"realm.namesTitle": "服务器名称",
"realm.namesHint": "玩家在服务器列表中看到的名称。运行中的服务器会立即显示新名称,更新后也会保留。",
"realm.nameSave": "保存",
"realm.nameReset": "默认名称",
"realm.nameDefault": "默认:{name}",
"realm.nameSaved": "已保存。",
"realm.nameQuotes": "不能使用引号:游戏客户端用引号保存名称。",
"realm.profileLabel": "服务器",
"realm.switching": "正在切换服务器…",
"realm.rebornCreate": "创建 Warcraft Reborn 服务器",
+57 -6
View File
@@ -54,9 +54,16 @@ export interface StatusView {
observed: { mysql: ServiceStatus; auth: ServiceStatus; world: ServiceStatus; secondary_world?: ServiceStatus | null; reborn_world?: ServiceStatus | null };
busy: boolean;
path_exists: boolean;
scheduled_restart?: boolean;
}
export type RealmMode = "coa" | "wildcard" | "reborn";
export interface CustomRaceCharacters { players: number; companionBots: number; squidBots: number }
export interface AddonView { id: string; name: string; description: Record<string, string>; author: string; license: string; needs: string | null; repo: string; size: number; installed: boolean; updateAvailable: boolean; foreignFolders: string[]; bundled?: string | null }
export interface RestartSchedule { enabled: boolean; time: string; warningMinutes: number }
export interface RestartScheduleView { schedule: RestartSchedule; supported: boolean }
export interface CustomMysql { text: string; applied: string }
export interface RealmName { id: number; name: string; defaultName: string; custom: boolean }
export interface RealmProfiles { active: RealmMode; wildcard_created: boolean; reborn_created: boolean; reborn_supported: boolean; supported: boolean; recovery_pending: boolean; simultaneous: boolean; secondary_world_port: number | null; secondary_running: boolean; with_reborn: boolean; reborn_world_port: number | null; reborn_running: boolean }
export interface DatabaseCheck {
realm: RealmMode;
@@ -230,6 +237,7 @@ export interface ModuleView {
/** not shown on the Modules page */
hidden: boolean;
compatibility?: "compatible" | "experimental" | "unsupported" | "requires-squid";
part_of?: string | null;
}
export interface ModuleSetting {
@@ -353,6 +361,16 @@ export interface CompanionSizes {
sizes: { id: string; title: string; bots: number; warning: string | null }[];
}
export interface WildcardArchetypeDto {
id: string;
name: string;
roles: number;
primary_stat: number;
author: string;
difficulty: number;
category: number;
}
export interface ClientInfo {
path: string;
executable: string;
@@ -486,6 +504,19 @@ export const api = {
realmProfiles: (id: string) => invoke<RealmProfiles>("realm_profiles", { id }),
realmSelect: (id: string, mode: RealmMode, restart: boolean) => invoke<RealmProfiles>("realm_select", { id, mode, restart }),
realmSimultaneous: (id: string, enabled: boolean) => invoke<RealmProfiles>("realm_simultaneous", { id, enabled }),
customRaceCharacters: (id: string) => invoke<CustomRaceCharacters | null>("custom_race_characters", { id }),
purgeCustomRaceBots: (id: string) => invoke<number>("purge_custom_race_bots", { id }),
addonsList: (id: string) => invoke<AddonView[]>("addons_list", { id }),
addonsInstall: (id: string, addon: string) => invoke<AddonView[]>("addons_install", { id, addon }),
addonsRemove: (id: string, addon: string) => invoke<AddonView[]>("addons_remove", { id, addon }),
clearGameCacheOnPlay: () => invoke<boolean>("clear_game_cache_on_play"),
setClearGameCacheOnPlay: (enabled: boolean) => invoke<void>("set_clear_game_cache_on_play", { enabled }),
restartSchedule: (id: string) => invoke<RestartScheduleView>("restart_schedule", { id }),
restartScheduleSave: (id: string, schedule: RestartSchedule) => invoke<RestartScheduleView>("restart_schedule_save", { id, schedule }),
mysqlCustom: (id: string) => invoke<CustomMysql>("mysql_custom", { id }),
mysqlCustomSave: (id: string, text: string) => invoke<CustomMysql>("mysql_custom_save", { id, text }),
realmNames: (id: string) => invoke<RealmName[]>("realm_names", { id }),
realmRename: (id: string, realmId: number, name: string | null) => invoke<RealmName[]>("realm_rename", { id, realmId, name }),
realmWithReborn: (id: string, enabled: boolean) => invoke<RealmProfiles>("realm_with_reborn", { id, enabled }),
checkDatabase: (id: string) => invoke<DatabaseCheck[]>("check_database", { id }),
repairServer: (id: string) => invoke<RepairReport>("repair_server", { id }),
@@ -553,15 +584,35 @@ export const api = {
invoke<{ txn: UpdateTxn; preexisting_character_count?: number }>("apply_update", { id, source: source ?? null, resolutions }),
rollbackUpdate: (id: string, txn: string) => invoke<UpdateTxn>("rollback_update", { id, txn }),
retryUpdateValidation: (id: string, txn: string) => invoke<UpdateTxn>("retry_update_validation", { id, txn }),
population: (id: string) => invoke<Population | null>("get_population", { id }),
stopSpawning: (id: string) => invoke<{ count: number }>("companions_stop_spawning", { id }),
takeOffline: (id: string) => invoke<{ count: number }>("companions_take_offline", { id }),
despawnSome: (id: string, count: number) => invoke<{ count: number }>("companions_despawn_some", { id, count }),
deleteAllCompanions: (id: string) => invoke<{ count: number }>("companions_delete_all", { id }),
population: (id: string, realm?: RealmMode) => invoke<Population | null>("get_population", { id, realm: realm ?? null }),
stopSpawning: (id: string, realm?: RealmMode) => invoke<{ count: number }>("companions_stop_spawning", { id, realm: realm ?? null }),
takeOffline: (id: string, realm?: RealmMode) => invoke<{ count: number }>("companions_take_offline", { id, realm: realm ?? null }),
despawnSome: (id: string, count: number, realm?: RealmMode) => invoke<{ count: number }>("companions_despawn_some", { id, count, realm: realm ?? null }),
deleteAllCompanions: (id: string, realm?: RealmMode) => invoke<{ count: number }>("companions_delete_all", { id, realm: realm ?? null }),
loginAllCompanions: (id: string, realm?: RealmMode) => invoke<string>("companions_login_all", { id, realm: realm ?? null }),
spawnBotFleet: (id: string, race: number, level: number, realm?: RealmMode) => invoke<string>("companions_spawn_fleet", { id, race, level, realm: realm ?? null }),
openLink: (url: string) => invoke<void>("open_link", { url }),
performance: (id: string) => invoke<Performance | null>("get_performance", { id }),
companionSizes: () => invoke<CompanionSizes>("companion_sizes"),
addCompanions: (id: string, count: number) => invoke<{ spawned: string | null; created: number | null; baseline: number | null }>("add_companions", { id, count }),
addCompanions: (
id: string,
count: number,
realm?: RealmMode,
level?: number,
classId?: number,
specId?: number,
archetype?: string
) =>
invoke<{ spawned: string | null; created: number | null; baseline: number | null }>("add_companions", {
id,
count,
realm: realm ?? null,
level: level ?? null,
class_id: classId ?? null,
spec_id: specId ?? null,
archetype: archetype ?? null,
}),
getWildcardArchetypes: (id: string) => invoke<WildcardArchetypeDto[]>("get_wildcard_archetypes", { id }),
clientGraphics: (id: string) => invoke<{ dxvk_disabled: boolean; enhancements_disabled: boolean }>("client_graphics", { id }),
clientSetGraphics: (id: string, name: string, disabled: boolean) => invoke<{ dxvk_disabled: boolean; enhancements_disabled: boolean }>("client_set_graphics", { id, name, disabled }),
clientInfo: (id: string) => invoke<ClientInfo | null>("client_info", { id }),
+8
View File
@@ -97,6 +97,14 @@ for (const [key, title, desc] of [
] as [string, string[], string[]][]) add(`Enchanter.${key}`, "int", title, desc, { min: 0, advanced: true });
for (let n = 1; n <= 3; n++) add(`EC.P${n}`, "string", [`NPC phrase ${n}`, `Реплика НПС ${n}`, `NPC-Satz ${n}`, `Phrase du PNJ ${n}`, `Frase del PNJ ${n}`, `NPC台词 ${n}`], ["Text spoken by the NPC. Keep the enclosing quotes.", "Текст реплики НПС. Сохраните кавычки вокруг текста.", "Gesprochener Text. Anführungszeichen beibehalten.", "Texte prononcé. Conservez les guillemets.", "Texto hablado. Conserva las comillas.", "NPC发言内容,请保留外层引号。"], { advanced: true });
add("Subclass.ThinHuman.Enable", "bool", ["Thin Twins race", "Раса «Хрупкие близнецы»", "Volk der Dünnen Zwillinge", "Race des Jumeaux maigres", "Raza de los Gemelos delgados", "瘦弱双子种族"], ["Off refuses new characters of this race; existing ones lose the brother and any subclass at their next login.", "Выключено — новых персонажей этой расы создать нельзя; у существующих при следующем входе пропадают брат и подкласс.", "Aus verweigert neue Figuren dieses Volkes; vorhandene verlieren beim nächsten Login den Bruder und eine Unterklasse.", "Désactivé refuse les nouveaux personnages de cette race ; les existants perdent le frère et la sous-classe à la prochaine connexion.", "Desactivado rechaza personajes nuevos de esta raza; los existentes pierden al hermano y la subclase al volver a entrar.", "关闭后不能创建此种族的新角色;现有角色在下次登录时失去兄弟和副职业。"]);
add("Subclass.TwoHeadedOgre.Enable", "bool", ["Two-Headed Ogre race", "Раса «Двуглавый огр»", "Volk der Zweiköpfigen Oger", "Race de l'Ogre à deux têtes", "Raza del Ogro de dos cabezas", "双头食人魔种族"], ["Off refuses new characters of this race; existing ones lose the second head and any subclass at their next login.", "Выключено — новых персонажей этой расы создать нельзя; у существующих при следующем входе пропадают вторая голова и подкласс.", "Aus verweigert neue Figuren dieses Volkes; vorhandene verlieren beim nächsten Login den zweiten Kopf und eine Unterklasse.", "Désactivé refuse les nouveaux personnages de cette race ; les existants perdent la seconde tête et la sous-classe à la prochaine connexion.", "Desactivado rechaza personajes nuevos de esta raza; los existentes pierden la segunda cabeza y la subclase al volver a entrar.", "关闭后不能创建此种族的新角色;现有角色在下次登录时失去第二个头和副职业。"]);
add("Subclass.TwoPlayers.Enable", "bool", ["Two players, one character", "Два игрока на одного персонажа", "Zwei Spieler, eine Figur", "Deux joueurs, un personnage", "Dos jugadores, un personaje", "两名玩家共用一个角色"], ["Two players share one Two-Headed Ogre or one pair of Twins. Off: no new pairs, and existing pairs play as single characters.", "Два игрока делят одного Двуглавого огра или пару близнецов. Выключено — новых пар нет, существующие играют как обычные персонажи.", "Zwei Spieler teilen sich einen Zweiköpfigen Oger oder ein Zwillingspaar. Aus: keine neuen Paare, bestehende spielen als einzelne Figuren.", "Deux joueurs partagent un Ogre à deux têtes ou une paire de Jumeaux. Désactivé : plus de nouvelles paires, les existantes jouent en solo.", "Dos jugadores comparten un Ogro de dos cabezas o una pareja de Gemelos. Desactivado: no hay parejas nuevas y las existentes juegan por separado.", "两名玩家共用一个双头食人魔或一对双子。关闭后不能组成新配对,现有配对按单人角色游戏。"]);
add("Subclass.MinLevel", "int", ["Subclass from level", "Подкласс с уровня", "Unterklasse ab Stufe", "Sous-classe dès le niveau", "Subclase desde el nivel", "副职业开放等级"], ["The level from which the borrowed class trees open.", "Уровень, с которого открываются деревья второго класса.", "Stufe, ab der die geliehenen Klassenbäume öffnen.", "Niveau à partir duquel les arbres de la classe empruntée s'ouvrent.", "Nivel a partir del cual se abren los árboles de la clase prestada.", "借用职业天赋树开放的等级。"], {"min": 1, "max": 80});
add("Subclass.StandardClasses", "bool", ["Offer standard classes as subclass", "Стандартные классы как подкласс", "Standardklassen als Unterklasse", "Classes standard en sous-classe", "Clases estándar como subclase", "提供标准职业作为副职业"], ["Class trainers also offer Warrior ... Druid as the subclass. Off keeps CoA classes only.", "Учителя классов предлагают как подкласс и Воина … Друида. Выключено — только классы CoA.", "Klassenlehrer bieten auch Krieger … Druide als Unterklasse an. Aus: nur CoA-Klassen.", "Les maîtres de classe proposent aussi Guerrier … Druide en sous-classe. Désactivé : classes CoA seulement.", "Los instructores también ofrecen Guerrero … Druida como subclase. Desactivado: solo clases de CoA.", "职业训练师也提供战士……德鲁伊作为副职业。关闭则仅限 CoA 职业。"], {"advanced": true});
add("Subclass.StandardMains", "bool", ["Standard classes at character creation", "Стандартные классы при создании", "Standardklassen bei der Erstellung", "Classes standard à la création", "Clases estándar al crear", "创建角色时提供标准职业"], ["Open Warrior ... Druid on the creation screen of a CoA realm for races with start data.", "Открывает Воина … Друида на экране создания в реалме CoA для рас со стартовыми данными.", "Öffnet Krieger … Druide im Erstellungsbildschirm eines CoA-Realms für Völker mit Startdaten.", "Ouvre Guerrier … Druide à la création sur un royaume CoA pour les races ayant des données de départ.", "Abre Guerrero … Druida en la creación de un reino CoA para razas con datos de inicio.", "在 CoA 服务器的创建界面为有起始数据的种族开放战士……德鲁伊。"], {"advanced": true});
add("Subclass.HeroRaces.RequiredLevel", "int", ["Hero Races need a character of level", "Героические расы: нужен персонаж уровня", "Heldenvölker brauchen eine Figur der Stufe", "Races héroïques : personnage requis de niveau", "Razas heroicas: personaje necesario de nivel", "英雄种族需要的角色等级"], ["Like the Death Knight, the Thin Twins and the Two-Headed Ogre need a character of this level on the account first. 0 removes the requirement.", "Как для рыцаря смерти: Хрупким близнецам и Двуглавому огру нужен персонаж этого уровня на аккаунте. 0 — без условия.", "Wie beim Todesritter brauchen die Dünnen Zwillinge und die Zweiköpfige Ogerin zuerst eine Figur dieser Stufe auf dem Konto. 0 hebt die Bedingung auf.", "Comme le chevalier de la mort, les Jumeaux maigres et l'Ogre à deux têtes exigent d'abord un personnage de ce niveau sur le compte. 0 supprime la condition.", "Como el caballero de la muerte, los Gemelos delgados y el Ogro de dos cabezas necesitan antes un personaje de este nivel en la cuenta. 0 quita el requisito.", "与死亡骑士一样,瘦弱双子和双头食人魔需要账号中先有此等级的角色。0 表示无要求。"], {"min": 0, "max": 80});
add("DevMenu.MinSecurity", "enum", ["Who may use /dev", "Кому доступно /dev", "Wer /dev nutzen darf", "Qui peut utiliser /dev", "Quién puede usar /dev", "谁可以使用 /dev"], ["The lowest account security level allowed to open the menu.", "Минимальный уровень прав аккаунта, которому доступно меню.", "Niedrigste Kontosicherheitsstufe, die das Menü öffnen darf.", "Niveau de sécurité de compte minimal autorisé à ouvrir le menu.", "Nivel de seguridad mínimo de la cuenta para abrir el menú.", "可打开该菜单的最低账号权限等级。"], {"options": [{"value": "2", "label": ["Game masters", "Гейм-мастера", "Spielleiter", "Maîtres du jeu", "Másteres", "游戏管理员"]}, {"value": "3", "label": ["Administrators", "Администраторы", "Administratoren", "Administrateurs", "Administradores", "管理员"]}]});
add("CoACustomRaces.BotsEnable", "bool",
["Bots can be custom races", "Боты кастомных рас", "Bots benutzerdefinierter Völker", "Bots de races personnalisées", "Bots de razas personalizadas", "允许机器人为自定义种族"],
[
+78
View File
@@ -0,0 +1,78 @@
import { useEffect, useState } from "react";
import { ExternalLink, Loader2 } from "lucide-react";
import { api, asUiError, type AddonView, type ClientInfo } from "@/lib/api";
import { Button } from "@/components/ui/button";
import { useI18n } from "@/i18n";
function megabytes(bytes: number): string {
return (bytes / 1024 / 1024).toFixed(bytes < 10 * 1024 * 1024 ? 1 : 0);
}
/** Addons from the Manager's catalog: each pinned to a commit of its author's repository and checked file by file. */
export function AddonCatalog({ serverId, companions, onCompanionsInstalled }: { serverId: string; companions?: ClientInfo["addon"] | null; onCompanionsInstalled?: () => void }) {
const { t, locale } = useI18n();
const [addons, setAddons] = useState<AddonView[] | null>(null);
const [working, setWorking] = useState<string | null>(null);
const [error, setError] = useState<string | null>(null);
useEffect(() => {
let alive = true;
void api.addonsList(serverId).then(list => { if (alive) setAddons(list); }).catch(e => { if (alive) setError(asUiError(e).technical); });
return () => { alive = false; };
}, [serverId]);
async function run(id: string, action: "install" | "remove") {
setWorking(id); setError(null);
try { setAddons(await (action === "install" ? api.addonsInstall : api.addonsRemove)(serverId, id)); }
catch (e) { setError(asUiError(e).technical); }
finally { setWorking(null); }
}
async function installCompanions() {
setWorking("coa-companions"); setError(null);
try { await api.installAddon(serverId); onCompanionsInstalled?.(); }
catch (e) { setError(asUiError(e).technical); }
finally { setWorking(null); }
}
return <div className="mt-5 border-t border-line pt-4">
<h3 className="text-sm font-semibold">{t("addons.title")}</h3>
<p className="mt-1 text-xs text-muted">{t("addons.hint")}</p>
<ul className="mt-3 space-y-3">
{companions && <li className="rounded-md border border-line p-3">
<div className="flex flex-wrap items-center gap-2">
<span className="font-medium">CoA Companions (CoABotUI)</span>
{companions.installed && companions.up_to_date !== false && <span className="text-xs text-ok">{companions.version ? t("client.installedVersion", { v: companions.version }) : t("addons.installed")}</span>}
{companions.up_to_date === false && <span className="text-xs text-warn">{t("addons.update")}</span>}
</div>
<p className="mt-1 text-sm text-muted">{t("client.addonWhat")}</p>
<p className="mt-1 text-xs text-muted">{t("addons.withServer")}</p>
{(!companions.installed || companions.up_to_date === false) && <div className="mt-2"><Button size="sm" disabled={working !== null} onClick={() => void installCompanions()}>
{working === "coa-companions" && <Loader2 className="h-4 w-4 animate-spin" aria-hidden />}
{companions.installed ? t("addons.doUpdate") : t("addons.doInstall")}
</Button></div>}
</li>}
{addons?.map(a => <li key={a.id} className="rounded-md border border-line p-3">
<div className="flex flex-wrap items-center gap-2">
<span className="font-medium">{a.name}</span>
<span className="text-xs text-muted">{t("addons.by", { author: a.author })}{a.size > 0 ? ` · ${megabytes(a.size)} MB` : ""}</span>
{a.installed && !a.updateAvailable && <span className="text-xs text-ok">{t("addons.installed")}</span>}
{a.updateAvailable && <span className="text-xs text-warn">{t("addons.update")}</span>}
<button type="button" className="ml-auto text-muted hover:text-ink" title={a.repo} aria-label={`GitHub: ${a.name}`} onClick={() => void api.openLink(a.repo)}><ExternalLink className="h-4 w-4" aria-hidden /></button>
</div>
<p className="mt-1 text-sm text-muted">{a.description[locale] ?? a.description.en}</p>
{a.needs === "playerbots" && <p className="mt-1 text-xs text-muted">{t("addons.needsSquid")}</p>}
{a.bundled === "custom-races" && <p className="mt-1 text-xs text-muted">{a.installed ? t("addons.withRaces") : t("addons.withRacesMissing")}</p>}
{a.foreignFolders.length > 0 && !a.installed && <p className="mt-1 text-xs text-warn">{t("addons.foreign", { folders: a.foreignFolders.join(", ") })}</p>}
{!a.bundled && <div className="mt-2 flex gap-2">
{(!a.installed || a.updateAvailable) && <Button size="sm" disabled={working !== null} onClick={() => void run(a.id, "install")}>
{working === a.id && <Loader2 className="h-4 w-4 animate-spin" aria-hidden />}
{a.updateAvailable ? t("addons.doUpdate") : t("addons.doInstall")}
</Button>}
{a.installed && <Button size="sm" variant="ghost" disabled={working !== null} onClick={() => void run(a.id, "remove")}>{t("addons.doRemove")}</Button>}
</div>}
</li>)}
</ul>
{error && <p className="mt-2 text-sm text-bad" role="alert">{error}</p>}
</div>;
}
+2 -8
View File
@@ -4,6 +4,7 @@ import { open } from "@tauri-apps/plugin-dialog";
import { api, asUiError, type ClientInfo, type ClientStatus, type UiError } from "@/lib/api";
import { checkClient } from "@/lib/clientUpdate";
import { ClientGraphics } from "./ClientGraphics";
import { AddonCatalog } from "./AddonCatalog";
import { ClientDialog, type ClientDialogMode } from "@/screens/ClientDialog";
import { Button } from "@/components/ui/button";
import { Card } from "@/components/ui/card";
@@ -85,18 +86,11 @@ export function ClientCard({ serverId, remote = false }: { serverId: string; rem
: t("client.versionUntracked")}
{status?.update_available && <span className="ml-2 text-warn">{t("client.updateAvailable")}</span>}
</dd>
{!remote && <>
<dt className="text-muted">{t("client.addon")}</dt>
<dd>
{info.addon.installed ? (info.addon.version ? t("client.installedVersion", { v: info.addon.version }) : t("client.installed")) : t("client.addonNotInstalled")}
{info.addon.up_to_date === false && <span className="ml-2 text-warn">{t("client.updateAvailable")}</span>}
<span className="mt-1 block text-xs text-muted">{t("client.addonWhat")}</span>
</dd>
</>}
<dt className="text-muted">{t("client.otherAddons")}</dt>
<dd>{t("client.leftAsIs", { n: info.other_addons })}</dd>
</dl>
<ClientGraphics key={info.path} serverId={serverId} />
<AddonCatalog key={"addons-" + info.path} serverId={serverId} companions={remote ? null : info.addon} onCompanionsInstalled={() => void refresh()} />
{!remote && (
<label className="mt-4 flex cursor-pointer items-center gap-2 text-sm">
<input type="checkbox" checked={playAfter} onChange={(e) => setPlayAfter(e.target.checked)} className="h-4 w-4 accent-[#c9a24a]" />
+8
View File
@@ -9,6 +9,12 @@ export function ClientGraphics({ serverId }: { serverId: string }) {
const [busy, setBusy] = useState(false);
const [error, setError] = useState<string | null>(null);
useEffect(() => { void api.clientGraphics(serverId).then(setState).catch(e => setError(asUiError(e).technical)); }, [serverId]);
const [clearCache, setClearCache] = useState<boolean | null>(null);
useEffect(() => { void api.clearGameCacheOnPlay().then(setClearCache).catch(() => setClearCache(true)); }, []);
async function changeClearCache(on: boolean) {
setClearCache(on);
try { await api.setClearGameCacheOnPlay(on); } catch (e) { setClearCache(!on); setError(asUiError(e).technical); }
}
async function change(name: string, disabled: boolean) {
setBusy(true); setError(null);
try { setState(await api.clientSetGraphics(serverId, name, disabled)); await checkClient(serverId); }
@@ -19,6 +25,8 @@ export function ClientGraphics({ serverId }: { serverId: string }) {
<label className="flex items-center gap-2 text-sm"><input type="checkbox" checked={state?.dxvk_disabled ?? false} disabled={!state || busy} onChange={e => void change("d3d9.dll", e.target.checked)} />{t("client.graphics.dxvk")}</label>
<label className="flex items-center gap-2 text-sm"><input type="checkbox" checked={state?.enhancements_disabled ?? false} disabled={!state || busy} onChange={e => void change("dxgi.dll", e.target.checked)} />{t("client.graphics.enhancements")}</label>
<p className="text-xs text-muted">{t("client.graphics.hint")}</p>
<label className="flex items-center gap-2 text-sm"><input type="checkbox" checked={clearCache ?? true} disabled={clearCache === null} onChange={e => void changeClearCache(e.target.checked)} />{t("client.clearCache")}</label>
<p className="text-xs text-muted">{t("client.clearCacheHint")}</p>
{error && <p className="text-sm text-bad" role="alert">{error}</p>}
</div>;
}
+712 -159
View File
@@ -1,30 +1,125 @@
import { useEffect, useState } from "react";
import { Loader2 } from "lucide-react";
import { api, asUiError, type CompanionSizes, type Population, type UiError } from "@/lib/api";
import {
Loader2,
Bot,
CheckCircle2,
AlertCircle,
RefreshCw,
Power,
Users,
Database,
} from "lucide-react";
import {
api,
asUiError,
type Population,
type RealmMode,
type RealmProfiles,
type UiError,
type WildcardArchetypeDto,
} from "@/lib/api";
import { Button } from "@/components/ui/button";
import { Card } from "@/components/ui/card";
import { hasKey, useHuman, useT, type Key } from "@/i18n";
import { useHuman, useT } from "@/i18n";
function formatRole(roles: number): string {
const parts: string[] = [];
if (roles & 1) parts.push("Tank");
if (roles & 2) parts.push("Melee");
if (roles & 4) parts.push("Ranged");
if (roles & 8) parts.push("Healer");
return parts.join("/") || "DPS";
}
function formatStat(stat: number): string {
switch (stat) {
case 0: return "Strength";
case 1: return "Agility";
case 2: return "Stamina";
case 3: return "Intellect";
case 4: return "Spirit";
default: return "All";
}
}
export function CompanionsCard({ serverId }: { serverId: string }) {
const t = useT();
const human = useHuman();
const [sizes, setSizes] = useState<CompanionSizes | null>(null);
// Realm & Environment state
const [profiles, setProfiles] = useState<RealmProfiles | null>(null);
const [selectedRealm, setSelectedRealm] = useState<RealmMode>("coa");
const [pop, setPop] = useState<Population | null>(null);
const [running, setRunning] = useState(false);
const [choice, setChoice] = useState<string>("small");
const [custom, setCustom] = useState("100");
// Fleet Configuration state
const [spawnMode, setSpawnMode] = useState<"population" | "fleet">("population");
const [countChoice, setCountChoice] = useState<string>("50");
const [customCount, setCustomCount] = useState<string>("50");
const [targetLevel, setTargetLevel] = useState<number>(80);
const [selectedClass, setSelectedClass] = useState<string>("all");
const [selectedRole, setSelectedRole] = useState<string>("all");
const [selectedArchetype, setSelectedArchetype] = useState<string>("all");
const [wildcardArchetypes, setWildcardArchetypes] = useState<WildcardArchetypeDto[]>([]);
// Operational state
const [busy, setBusy] = useState(false);
const [error, setError] = useState<UiError | null>(null);
const [note, setNote] = useState<string | null>(null);
// Start-up login: how many existing bots the server brings online by itself every time it starts.
const [job, setJob] = useState<{ baseline: number; target: number; since: number } | null>(null);
// Startup Auto-Login settings
const [autoOn, setAutoOn] = useState(true);
const [autoMax, setAutoMax] = useState("");
// A creation that is still in progress on the running server: how many existed before and how many were asked for.
const [job, setJob] = useState<{ baseline: number; target: number; since: number } | null>(null);
const [startNote, setStartNote] = useState<string | null>(null);
const [startBusy, setStartBusy] = useState(false);
const [despawnN, setDespawnN] = useState("10");
const activeServerRealm = profiles?.active ?? "coa";
const isViewingActiveRealm = selectedRealm === activeServerRealm;
const isRealmOperational = isViewingActiveRealm || running;
const maxLevelForRealm = 60;
// Load realm profiles
const loadProfiles = async () => {
try {
const r = await api.realmProfiles(serverId);
setProfiles(r);
if (!selectedRealm) {
setSelectedRealm(r.active);
}
} catch {
// ignore
}
};
useEffect(() => {
void loadProfiles();
}, [serverId]);
// Adjust target level if realm changed
useEffect(() => {
if (targetLevel > maxLevelForRealm) {
setTargetLevel(maxLevelForRealm);
}
}, [selectedRealm, maxLevelForRealm, targetLevel]);
// Load wildcard archetypes dynamically from target characters db
useEffect(() => {
if (selectedRealm === "wildcard") {
api.getWildcardArchetypes(serverId)
.then((archs) => setWildcardArchetypes(archs))
.catch(() => {});
if (selectedClass === "all") {
setSelectedClass("10");
}
} else {
setSelectedArchetype("all");
}
}, [serverId, selectedRealm]);
// Load startup settings
useEffect(() => {
void api
.settings(serverId, "bots")
@@ -40,6 +135,46 @@ export function CompanionsCard({ serverId }: { serverId: string }) {
const maxNum = Number(autoMax);
const maxValid = autoMax.trim() !== "" && Number.isInteger(maxNum) && maxNum >= 0 && maxNum <= 5000;
// Polling population
const fetchPopulation = async () => {
const s = await api.status(serverId).catch(() => null);
if (!s) return;
const up = s.observed.world.state === "running";
setRunning(up);
if (up) {
const p = await api.population(serverId, selectedRealm).catch(() => null);
setPop(p);
} else {
setPop(null);
}
};
useEffect(() => {
let alive = true;
const poll = async () => {
if (!alive) return;
await fetchPopulation();
};
void poll();
const interval = setInterval(poll, job ? 1500 : 4000);
return () => {
alive = false;
clearInterval(interval);
};
}, [serverId, selectedRealm, job !== null]); // eslint-disable-line react-hooks/exhaustive-deps
const done = job && pop ? Math.max(0, Math.min(job.target, pop.bots_total - job.baseline)) : 0;
useEffect(() => {
if (!job) return;
if ((pop && done >= job.target) || !running) {
if (pop && done >= job.target) setNote(t("comp.progressDone", { n: job.target }));
setJob(null);
}
}, [done, running]); // eslint-disable-line react-hooks/exhaustive-deps
const count = countChoice === "custom" ? Number(customCount) : Number(countChoice);
const valid = Number.isInteger(count) && count >= 1 && count <= 2000;
async function act(fn: () => Promise<string>) {
setBusy(true);
setError(null);
@@ -52,45 +187,128 @@ export function CompanionsCard({ serverId }: { serverId: string }) {
}
}
// Primary action: Spawn bots / fleet
const handleSpawn = async () => {
if (!valid) return;
setBusy(true);
setError(null);
setNote(null);
try {
if (spawnMode === "fleet") {
const race = 1;
const out = await api.spawnBotFleet(serverId, race, targetLevel, selectedRealm);
setNote(out || `Spawned level ${targetLevel} fleet`);
} else {
const classNum = selectedClass !== "all" ? parseInt(selectedClass, 10) : (selectedRealm === "wildcard" ? 10 : undefined);
let specNum: number | undefined = undefined;
if (selectedRole === "tank") {
if (selectedRealm === "reborn") {
specNum = (classNum === 7 || classNum === 9 || classNum === 11) ? 4 : (classNum === 2 ? 2 : classNum === 1 ? 3 : 1);
} else if (selectedRealm === "wildcard") {
specNum = 1;
}
} else if (selectedRole === "healer") {
if (selectedRealm === "reborn") {
specNum = (classNum === 2 || classNum === 5) ? 1 : (classNum === 7 || classNum === 11 ? 3 : 1);
} else if (selectedRealm === "wildcard") {
specNum = 2;
}
}
const archStr = selectedArchetype !== "all" ? selectedArchetype : undefined;
const r = await api.addCompanions(serverId, count, selectedRealm, targetLevel, classNum, specNum, archStr);
if (r.spawned && r.baseline !== null) {
setJob({ baseline: r.baseline, target: count, since: Date.now() });
}
setNote(
r.created
? t("comp.offlineDone", { n: r.created })
: r.spawned
? t("comp.spawned", { n: count })
: t("comp.saved", { n: count })
);
}
await fetchPopulation();
} catch (e) {
setError(asUiError(e));
} finally {
setBusy(false);
}
};
// Bring offline bots online
const handleLoginAll = () =>
act(async () => {
const out = await api.loginAllCompanions(serverId, selectedRealm);
await fetchPopulation();
return out || "All available offline bots queued for login.";
});
// Stop queued creations
const stopCreating = () =>
act(async () => {
const r = await api.stopSpawning(serverId);
const r = await api.stopSpawning(serverId, selectedRealm);
setJob(null);
await fetchPopulation();
return t("comp.stopped", { n: r.count });
});
// Take online bots offline
const takeOffline = () => {
if (!window.confirm(t("comp.offlineConfirm"))) return;
void act(async () => {
const r = await api.takeOffline(serverId);
const r = await api.takeOffline(serverId, selectedRealm);
setJob(null);
await fetchPopulation();
return t("comp.offlineDone2", { n: r.count });
});
};
// Despawn batch
const dn = Number(despawnN);
const dnValid = Number.isInteger(dn) && dn >= 1 && dn <= 5000;
const despawnSome = () =>
act(async () => {
const r = await api.despawnSome(serverId, dn);
const r = await api.despawnSome(serverId, dn, selectedRealm);
await fetchPopulation();
return t("comp.despawnSomeDone", { n: r.count });
});
// Delete all bots in realm
const deleteAll = () => {
if (!window.confirm(t("comp.deleteConfirm", { n: pop?.bots_total ?? 0 }))) return;
void act(async () => {
await api.deleteAllCompanions(serverId);
await api.deleteAllCompanions(serverId, selectedRealm);
setJob(null);
await fetchPopulation();
return t("comp.deleteDone");
});
};
// Switch server realm
const switchServerRealm = async (mode: RealmMode) => {
if (!window.confirm(`Switch server active realm to ${mode.toUpperCase()} and restart?`)) return;
setBusy(true);
try {
await api.realmSelect(serverId, mode, true);
await loadProfiles();
setSelectedRealm(mode);
} catch (e) {
setError(asUiError(e));
} finally {
setBusy(false);
}
};
// Save auto startup settings
async function saveStart() {
setStartBusy(true);
setError(null);
setStartNote(null);
try {
await api.save(serverId, "bots", { "CoaBots.AutoLoginOnStartup": autoOn, "CoaBots.AutoLogin.MaxCount": maxNum });
await api.save(serverId, "bots", {
"CoaBots.AutoLoginOnStartup": autoOn,
"CoaBots.AutoLogin.MaxCount": maxNum,
});
setStartNote(t("comp.startSaved"));
} catch (e) {
setError(asUiError(e));
@@ -99,181 +317,516 @@ export function CompanionsCard({ serverId }: { serverId: string }) {
}
}
useEffect(() => {
void api.companionSizes().then(setSizes);
let alive = true;
const poll = async () => {
const s = await api.status(serverId).catch(() => null);
if (!alive || !s) return;
const up = s.observed.world.state === "running";
setRunning(up);
setPop(up ? await api.population(serverId).catch(() => null) : null);
};
void poll();
// Faster while companions are being created, so the progress bar moves.
const t = setInterval(poll, job ? 1500 : 4000);
return () => {
alive = false;
clearInterval(t);
};
}, [serverId, job !== null]); // eslint-disable-line react-hooks/exhaustive-deps
// Database schema name for selected realm
const dbSchema =
selectedRealm === "coa"
? "acore_characters"
: selectedRealm === "wildcard"
? "acore_characters_wildcard"
: "acore_characters_reborn";
const done = job && pop ? Math.max(0, Math.min(job.target, pop.bots_total - job.baseline)) : 0;
useEffect(() => {
if (!job) return;
// Finished, or the server went away, or nothing new appeared for two minutes.
if ((pop && done >= job.target) || !running) {
if (pop && done >= job.target) setNote(t("comp.progressDone", { n: job.target }));
setJob(null);
}
}, [done, running]); // eslint-disable-line react-hooks/exhaustive-deps
// The backend describes a size's warning in English; show the translated text for the two known kinds.
const warningFor = (size?: { bots: number; warning: string | null }) => {
if (!size?.warning) return null;
return size.warning.startsWith(`${size.bots} companions`)
? t("comp.warnHardware", { n: size.bots, cores: sizes?.hardware.cores ?? "?", ram: sizes ? sizes.hardware.ram_gb.toFixed(0) : "?" })
: t("comp.warnMemory");
};
const count = choice === "custom" ? Number(custom) : (sizes?.sizes.find((s) => s.id === choice)?.bots ?? 0);
const warning = choice === "custom" ? (count > 500 ? t("comp.largeWarning") : null) : (warningFor(sizes?.sizes.find((s) => s.id === choice)));
const valid = Number.isInteger(count) && count >= 1 && count <= 2000;
async function add() {
setBusy(true);
setError(null);
setNote(null);
try {
const r = await api.addCompanions(serverId, count);
if (r.spawned && r.baseline !== null) setJob({ baseline: r.baseline, target: count, since: Date.now() });
setNote(r.created ? t("comp.offlineDone", { n: r.created }) : r.spawned ? t("comp.spawned", { n: count }) : t("comp.saved", { n: count }));
} catch (e) {
setError(asUiError(e));
} finally {
setBusy(false);
}
}
// Binary compatibility check
const isBinaryCompatible =
selectedRealm === "coa" ||
(selectedRealm === "wildcard" && (profiles?.supported ?? true)) ||
(selectedRealm === "reborn" && (profiles?.reborn_supported ?? true));
return (
<Card className="mt-6 p-6">
<h2 className="font-semibold">{t("comp.title")}</h2>
<p className="mt-1 text-sm text-muted">
{pop
? t("comp.population", { online: pop.bots_online, total: pop.bots_total })
: running
? t("comp.reading")
: t("comp.startToSee")}
</p>
<fieldset className="mt-4">
<legend className="text-sm text-muted">{t("comp.wantMore")}</legend>
<div className="mt-2 flex flex-wrap gap-2">
{sizes?.sizes.map((s) => (
<label key={s.id} className={`cursor-pointer rounded-md border px-3 py-2 text-sm ${choice === s.id ? "border-gold bg-gold/10" : "border-line hover:bg-white/5"}`}>
<input type="radio" name="size" className="sr-only" checked={choice === s.id} onChange={() => setChoice(s.id)} />
{hasKey(`comp.size.${s.id}`) ? t(`comp.size.${s.id}` as Key) : s.title} <span className="text-muted">· {s.bots}</span>
</label>
))}
<label className={`cursor-pointer rounded-md border px-3 py-2 text-sm ${choice === "custom" ? "border-gold bg-gold/10" : "border-line hover:bg-white/5"}`}>
<input type="radio" name="size" className="sr-only" checked={choice === "custom"} onChange={() => setChoice("custom")} />
{t("comp.custom")}
</label>
{choice === "custom" && (
<input aria-label={t("comp.numberLabel")} value={custom} onChange={(e) => setCustom(e.target.value)} inputMode="numeric" className="w-24 rounded-md border border-line bg-bg px-3 py-2 text-right text-sm outline-none focus:border-gold" />
)}
<Card className="mt-6 p-6 space-y-6">
{/* Header & Realm Switcher */}
<div>
<div className="flex flex-wrap items-center justify-between gap-3">
<div className="flex items-center gap-2">
<Bot className="h-6 w-6 text-gold" />
<h2 className="text-xl font-bold tracking-tight">{t("comp.title")}</h2>
</div>
<div className="flex items-center gap-2">
<span className="text-xs text-muted flex items-center gap-1">
<Database className="h-3.5 w-3.5" />
DB: <code className="text-gold">{dbSchema}</code>
</span>
</div>
</div>
</fieldset>
{warning && <p className="mt-3 text-sm text-warn" role="status">{warning}</p>}
{sizes && <p className="mt-2 text-xs text-muted">{t("comp.hardware", { cores: sizes.hardware.cores, ram: sizes.hardware.ram_gb.toFixed(0) })}</p>}
<div className="mt-4 flex items-center gap-3">
<Button variant="primary" disabled={busy || !valid || job !== null} onClick={() => void add()}>
{busy && <Loader2 className="h-4 w-4 animate-spin" aria-hidden />}
{valid ? t("comp.add", { n: count }) : t("comp.addPlain")}
</Button>
{!running && <span className="text-xs text-muted">{t("comp.stoppedHint")}</span>}
{/* Realm Navigation Tabs */}
<div className="mt-4 flex flex-wrap gap-2 border-b border-line pb-3">
{(["coa", "wildcard", "reborn"] as RealmMode[]).map((mode) => {
const isSelected = selectedRealm === mode;
const isActive = activeServerRealm === mode;
const label =
mode === "coa"
? "Conquest of Azeroth"
: mode === "wildcard"
? "Wildcard (Hero)"
: "Warcraft Reborn";
return (
<button
key={mode}
type="button"
onClick={() => setSelectedRealm(mode)}
className={`flex items-center gap-2 rounded-lg px-4 py-2 text-sm font-medium transition-colors ${
isSelected
? "bg-gold/20 text-gold border border-gold/40 shadow-sm"
: "border border-line hover:bg-white/5 text-muted hover:text-white"
}`}
>
<span>{label}</span>
{isActive && (
<span className="rounded bg-ok/20 px-1.5 py-0.5 text-[10px] font-semibold text-ok uppercase">
Active Server
</span>
)}
</button>
);
})}
</div>
</div>
{busy && !running && count >= 100 && (
<div className="mt-3">
<p className="text-sm text-muted" role="status">{t("comp.progressOffline", { n: count })}</p>
<div className="mt-2 h-2 overflow-hidden rounded-full bg-white/10" role="progressbar" aria-busy="true">
<div className="h-full w-full animate-pulse rounded-full bg-gold/70" />
{/* Binary Compatibility & Realm Mode Warning */}
{!isBinaryCompatible && (
<div className="rounded-lg border border-bad/40 bg-bad/10 p-4 text-sm text-bad flex items-start gap-3">
<AlertCircle className="h-5 w-5 shrink-0 mt-0.5" />
<div>
<div className="font-semibold">Binary Compatibility Warning</div>
<p className="mt-1 text-xs text-bad/90">
The currently running server core binary does not have full multi-realm support enabled
for <strong>{selectedRealm.toUpperCase()}</strong>. Automated bot features may be restricted.
</p>
</div>
</div>
)}
{job && (
<div className="mt-3">
<div className="flex justify-between text-sm">
<span role="status">{t("comp.progress", { done, target: job.target })}</span>
<span className="text-muted">{Math.round((done / job.target) * 100)}%</span>
</div>
<div className="mt-2 h-2 overflow-hidden rounded-full bg-white/10" role="progressbar" aria-valuenow={done} aria-valuemin={0} aria-valuemax={job.target}>
<div className="h-full rounded-full bg-gold transition-[width] duration-500" style={{ width: `${(done / job.target) * 100}%` }} />
</div>
{done === 0 && Date.now() - job.since > 20000 && <p className="mt-1 text-xs text-muted">{t("comp.progressStalled")}</p>}
<Button className="mt-2" size="sm" variant="ghost" disabled={busy} onClick={() => void stopCreating()}>
{t("comp.stop")}
{/* Active Realm Switch Helper */}
{!isViewingActiveRealm && (
<div className="rounded-lg border border-warn/40 bg-warn/10 p-3 text-sm flex items-center justify-between gap-3">
<span className="text-warn text-xs">
Viewing <strong>{selectedRealm.toUpperCase()}</strong> bots, but the worldserver is currently running in{" "}
<strong>{activeServerRealm.toUpperCase()}</strong> mode.
</span>
<Button
size="sm"
variant="secondary"
disabled={busy}
onClick={() => void switchServerRealm(selectedRealm)}
>
Switch Server to {selectedRealm.toUpperCase()}
</Button>
</div>
)}
{note && !job && <p className="mt-3 text-sm text-ok" role="status">{note}</p>}
{running && pop && pop.bots_total > 0 && (
<div className="mt-5 border-t border-line pt-4">
<h3 className="text-sm font-semibold">{t("comp.manageTitle")}</h3>
<div className="mt-2 flex flex-wrap items-center gap-2 text-sm">
<label htmlFor="despawn-n" className="text-muted">{t("comp.despawnCount")}</label>
{/* Realm Population Dashboard */}
<div className="grid grid-cols-2 sm:grid-cols-4 gap-3">
<div className="rounded-lg border border-line bg-bg/50 p-3">
<div className="text-xs text-muted flex items-center gap-1.5">
<Bot className="h-3.5 w-3.5 text-gold" />
Bots Online
</div>
<div className="mt-1 text-2xl font-bold text-white">
{running && pop ? pop.bots_online : "—"}
</div>
</div>
<div className="rounded-lg border border-line bg-bg/50 p-3">
<div className="text-xs text-muted flex items-center gap-1.5">
<Users className="h-3.5 w-3.5 text-gold" />
Total Fleet
</div>
<div className="mt-1 text-2xl font-bold text-white">
{pop ? pop.bots_total : "—"}
</div>
</div>
<div className="rounded-lg border border-line bg-bg/50 p-3">
<div className="text-xs text-muted flex items-center gap-1.5">
<CheckCircle2 className="h-3.5 w-3.5 text-ok" />
Players Online
</div>
<div className="mt-1 text-2xl font-bold text-white">
{running && pop ? pop.players_online : "—"}
</div>
</div>
<div className="rounded-lg border border-line bg-bg/50 p-3 flex flex-col justify-between">
<div className="text-xs text-muted flex items-center justify-between">
<span>Status</span>
<button
onClick={() => void fetchPopulation()}
title="Refresh"
className="text-muted hover:text-white"
>
<RefreshCw className="h-3 w-3" />
</button>
</div>
<div className="text-sm font-medium">
{running ? (
<span className="text-ok flex items-center gap-1">
<span className="h-2 w-2 rounded-full bg-ok animate-pulse" /> Running
</span>
) : (
<span className="text-muted">Offline</span>
)}
</div>
</div>
</div>
{/* Fleet Configuration & Spawning Section */}
<div className="border-t border-line pt-5 space-y-4">
<div className="flex items-center justify-between">
<h3 className="font-semibold text-sm tracking-wide uppercase text-muted">
Fleet Deployment Controls
</h3>
<div className="flex rounded-md border border-line p-0.5 text-xs">
<button
type="button"
onClick={() => setSpawnMode("population")}
className={`px-2.5 py-1 rounded transition-colors ${
spawnMode === "population" ? "bg-gold/20 text-gold font-medium" : "text-muted hover:text-white"
}`}
>
Batch Population
</button>
<button
type="button"
onClick={() => setSpawnMode("fleet")}
className={`px-2.5 py-1 rounded transition-colors ${
spawnMode === "fleet" ? "bg-gold/20 text-gold font-medium" : "text-muted hover:text-white"
}`}
>
Synchronous Fleet
</button>
</div>
</div>
{/* Count Selector */}
{spawnMode === "population" && (
<div>
<label className="text-xs text-muted">Fleet Size (Number of Bots)</label>
<div className="mt-2 flex flex-wrap gap-2">
{["10", "25", "50", "100", "250", "500"].map((n) => (
<button
key={n}
type="button"
onClick={() => setCountChoice(n)}
className={`rounded-md border px-3 py-1.5 text-sm transition-colors ${
countChoice === n
? "border-gold bg-gold/15 text-gold font-medium"
: "border-line hover:bg-white/5 text-muted"
}`}
>
{n}
</button>
))}
<button
type="button"
onClick={() => setCountChoice("custom")}
className={`rounded-md border px-3 py-1.5 text-sm transition-colors ${
countChoice === "custom"
? "border-gold bg-gold/15 text-gold font-medium"
: "border-line hover:bg-white/5 text-muted"
}`}
>
Custom
</button>
{countChoice === "custom" && (
<input
type="number"
min="1"
max="2000"
value={customCount}
onChange={(e) => setCustomCount(e.target.value)}
className="w-24 rounded-md border border-line bg-bg px-3 py-1.5 text-right text-sm outline-none focus:border-gold"
/>
)}
</div>
</div>
)}
{/* Fleet Specific Settings: Level, Class, Role, Archetype */}
<div className="grid grid-cols-1 sm:grid-cols-2 lg:grid-cols-4 gap-3">
{/* Target Level */}
<div>
<label className="text-xs text-muted">
{spawnMode === "fleet" ? "Fleet Level" : "Max Level Cap"} (1 - {maxLevelForRealm})
</label>
<input
type="number"
min="1"
max={maxLevelForRealm}
value={targetLevel}
onChange={(e) => setTargetLevel(Math.max(1, Math.min(maxLevelForRealm, Number(e.target.value))))}
className="mt-1.5 w-full rounded-md border border-line bg-bg px-3 py-1.5 text-sm outline-none focus:border-gold"
/>
</div>
{/* Class Filter */}
<div>
<label className="text-xs text-muted">Class Focus</label>
<select
value={selectedClass}
onChange={(e) => setSelectedClass(e.target.value)}
className="mt-1.5 w-full rounded-md border border-line bg-bg px-3 py-1.5 text-sm outline-none focus:border-gold"
>
<option value="all">All Realm Classes</option>
{selectedRealm === "coa" && (
<>
<option value="12">Barbarian</option>
<option value="13">Witch Doctor</option>
<option value="14">Felsworn</option>
<option value="15">Witch Hunter</option>
<option value="16">Stormbringer</option>
<option value="17">Knight of Xoroth</option>
<option value="18">Guardian</option>
<option value="19">Templar</option>
<option value="20">Bloodmage</option>
<option value="21">Ranger</option>
<option value="22">Chronomancer</option>
<option value="23">Necromancer</option>
<option value="24">Pyromancer</option>
<option value="25">Cultist</option>
<option value="26">Starcaller</option>
<option value="27">Tinker</option>
<option value="28">Venomancer</option>
<option value="29">Reaper</option>
<option value="30">Sun Cleric</option>
<option value="31">Runemaster</option>
<option value="32">Primalist</option>
</>
)}
{selectedRealm === "wildcard" && (
<option value="10">Hero (Freepick)</option>
)}
{selectedRealm === "reborn" && (
<>
<option value="1">Warrior</option>
<option value="2">Paladin</option>
<option value="3">Hunter</option>
<option value="4">Rogue</option>
<option value="5">Priest</option>
<option value="6">Death Knight</option>
<option value="7">Shaman</option>
<option value="8">Mage</option>
<option value="9">Warlock</option>
<option value="11">Druid</option>
</>
)}
</select>
</div>
{/* Role Filter */}
<div>
<label className="text-xs text-muted">Combat Role</label>
<select
value={selectedRole}
onChange={(e) => setSelectedRole(e.target.value)}
className="mt-1.5 w-full rounded-md border border-line bg-bg px-3 py-1.5 text-sm outline-none focus:border-gold"
>
<option value="all">All Roles</option>
<option value="tank">Tank</option>
<option value="healer">Healer</option>
<option value="melee">Melee DPS</option>
<option value="ranged">Ranged Physical DPS</option>
<option value="caster">Caster DPS</option>
</select>
</div>
{/* Archetype Filter */}
<div>
<label className="text-xs text-muted">Archetype / Build</label>
<select
value={selectedArchetype}
onChange={(e) => setSelectedArchetype(e.target.value)}
className="mt-1.5 w-full rounded-md border border-line bg-bg px-3 py-1.5 text-sm outline-none focus:border-gold"
>
<option value="all">Auto / Integral Archetype</option>
{selectedRealm === "wildcard" && (
<>
{wildcardArchetypes.map((b) => (
<option key={b.id} value={b.id}>
{b.name} ({formatRole(b.roles)}) [{formatStat(b.primary_stat)}]
</option>
))}
</>
)}
{selectedRealm === "reborn" && (
<>
<option value="spiritguard">Spirit Guard Shaman (Tank)</option>
<option value="darkapoth">Dark Apotheosis Warlock (Tank)</option>
<option value="guardianbear">Guardian Bear Druid (Tank)</option>
<option value="protpal">Protection Paladin (Tank)</option>
<option value="protwar">Protection Warrior (Tank)</option>
<option value="holypriest">Holy Priest (Healer)</option>
<option value="restodruid">Restoration Druid / Shaman</option>
</>
)}
{selectedRealm === "coa" && (
<option value="class_spec">Class Mastery Specialization</option>
)}
</select>
</div>
</div>
{/* Deployment Actions */}
<div className="flex flex-wrap items-center gap-3 pt-2">
<Button
variant="primary"
disabled={busy || !valid || job !== null || !isRealmOperational}
onClick={() => void handleSpawn()}
>
{busy && <Loader2 className="h-4 w-4 animate-spin mr-2" />}
{spawnMode === "fleet"
? `Spawn Level ${targetLevel} Fleet`
: `Deploy ${valid ? count : ""} Bots`}
</Button>
{running && pop && pop.bots_total > pop.bots_online && (
<Button
variant="secondary"
disabled={busy || job !== null || !isRealmOperational}
onClick={() => void handleLoginAll()}
title="Bring all created bots online"
>
<Power className="h-4 w-4 mr-1.5 text-ok" />
Bring All Online ({pop.bots_total - pop.bots_online} idle)
</Button>
)}
{!running && (
<span className="text-xs text-muted">
Server stopped: bots will be created directly in DB or queued for startup.
</span>
)}
</div>
{/* Progress Bar during active spawn */}
{job && (
<div className="rounded-lg border border-line bg-bg/40 p-4 space-y-2">
<div className="flex justify-between text-sm">
<span className="font-medium">
Creating bots: {done} / {job.target}
</span>
<span className="text-gold font-bold">
{Math.round((done / job.target) * 100)}%
</span>
</div>
<div className="h-2 overflow-hidden rounded-full bg-white/10">
<div
className="h-full rounded-full bg-gold transition-[width] duration-300"
style={{ width: `${(done / job.target) * 100}%` }}
/>
</div>
<div className="flex justify-between items-center pt-1">
<span className="text-xs text-muted">
Paced creation prevents server stalls and guarantees full talent/gear setup.
</span>
<Button size="sm" variant="ghost" disabled={busy} onClick={() => void stopCreating()}>
Cancel Queue
</Button>
</div>
</div>
)}
{note && !job && (
<p className="text-sm text-ok flex items-center gap-1.5">
<CheckCircle2 className="h-4 w-4 shrink-0" />
{note}
</p>
)}
</div>
{/* Online Fleet Management (Despawn, Purge) */}
{running && pop && pop.bots_total > 0 && isViewingActiveRealm && (
<div className="border-t border-line pt-5 space-y-3">
<h3 className="font-semibold text-sm tracking-wide uppercase text-muted">
Online Fleet Management
</h3>
<div className="flex flex-wrap items-center gap-3 text-sm">
<label htmlFor="despawn-n" className="text-muted text-xs">
Despawn Batch:
</label>
<input
id="despawn-n"
value={despawnN}
onChange={(e) => setDespawnN(e.target.value)}
inputMode="numeric"
aria-invalid={!dnValid}
className="w-20 rounded-md border border-line bg-bg px-3 py-1.5 text-right outline-none focus:border-gold"
className="w-20 rounded-md border border-line bg-bg px-2.5 py-1 text-right text-sm outline-none focus:border-gold"
/>
<Button size="sm" variant="secondary" disabled={busy || !dnValid} onClick={() => void despawnSome()}>
{t("comp.despawnSome", { n: dnValid ? dn : "…" })}
<Button
size="sm"
variant="secondary"
disabled={busy || !dnValid}
onClick={() => void despawnSome()}
>
Despawn {dnValid ? dn : "…"} Bots
</Button>
</div>
<p className="mt-1 text-xs text-muted">{t("comp.despawnHint")}</p>
<div className="mt-3 flex flex-wrap gap-2">
<Button size="sm" variant="secondary" disabled={busy} onClick={takeOffline}>
{t("comp.offline")}
Take All Offline
</Button>
<Button size="sm" variant="ghost" className="text-bad hover:text-bad" disabled={busy} onClick={deleteAll}>
{t("comp.delete")}
<Button
size="sm"
variant="ghost"
className="text-bad hover:text-bad ml-auto"
disabled={busy}
onClick={deleteAll}
>
Purge Entire Fleet ({pop.bots_total})
</Button>
</div>
</div>
)}
<div className="mt-5 border-t border-line pt-4">
<h3 className="text-sm font-semibold">{t("comp.startTitle")}</h3>
<label className="mt-2 flex cursor-pointer items-center gap-2 text-sm">
<input type="checkbox" checked={autoOn} onChange={(e) => setAutoOn(e.target.checked)} />
{t("comp.startAuto")}
</label>
<div className="mt-2 flex flex-wrap items-center gap-2 text-sm">
<label htmlFor="start-max" className="text-muted">{t("comp.startCount")}</label>
<input
id="start-max"
value={autoMax}
onChange={(e) => setAutoMax(e.target.value)}
inputMode="numeric"
disabled={!autoOn}
aria-invalid={!maxValid}
className="w-24 rounded-md border border-line bg-bg px-3 py-1.5 text-right outline-none focus:border-gold disabled:opacity-40"
/>
<Button size="sm" variant="secondary" disabled={startBusy || (autoOn && !maxValid)} onClick={() => void saveStart()}>
{t("comp.startSave")}
</Button>
{/* Startup Auto-Login Configuration */}
<div className="border-t border-line pt-5 space-y-3">
<h3 className="font-semibold text-sm tracking-wide uppercase text-muted">
Persistent Startup Fleet
</h3>
<p className="text-xs text-muted">
Configure how many bots automatically log into the world whenever the server launches.
</p>
<div className="flex flex-wrap items-center gap-4 text-sm">
<label className="flex cursor-pointer items-center gap-2">
<input
type="checkbox"
checked={autoOn}
onChange={(e) => setAutoOn(e.target.checked)}
className="rounded border-line text-gold focus:ring-gold"
/>
<span>Enable Auto-Login on Server Startup</span>
</label>
<div className="flex items-center gap-2">
<label htmlFor="start-max" className="text-xs text-muted">
Startup Limit:
</label>
<input
id="start-max"
value={autoMax}
onChange={(e) => setAutoMax(e.target.value)}
inputMode="numeric"
disabled={!autoOn}
aria-invalid={!maxValid}
className="w-24 rounded-md border border-line bg-bg px-2.5 py-1 text-right text-sm outline-none focus:border-gold disabled:opacity-40"
/>
<Button
size="sm"
variant="secondary"
disabled={startBusy || (autoOn && !maxValid)}
onClick={() => void saveStart()}
>
Save Setting
</Button>
</div>
</div>
{autoOn && !maxValid && autoMax !== "" && <p className="mt-1 text-xs text-warn">{t("comp.startInvalid")}</p>}
<p className="mt-1 text-xs text-muted">{t("comp.startHint")}</p>
{startNote && <p className="mt-2 text-sm text-ok" role="status">{startNote}</p>}
{startNote && <p className="text-xs text-ok">{startNote}</p>}
</div>
{error && <p className="mt-3 text-sm text-bad" role="alert">{error.human.code === "unknown" ? error.technical : human(error.human).message}</p>}
{error && (
<div className="rounded-md border border-bad/40 bg-bad/10 p-3 text-sm text-bad flex items-center gap-2">
<AlertCircle className="h-4 w-4 shrink-0" />
<span>{error.human.code === "unknown" ? error.technical : human(error.human).message}</span>
</div>
)}
</Card>
);
}
+43 -2
View File
@@ -1,7 +1,7 @@
import { Fragment, useCallback, useEffect, useRef, useState, type ComponentType, type ReactNode } from "react";
import { listen } from "@tauri-apps/api/event";
import { Bot, Clock, Flame, Gavel, Loader2, Plug, Puzzle, Scaling, Settings2, Snowflake, Sparkles, Swords, Users, type LucideProps } from "lucide-react";
import { api, asUiError, type CustomRacesClientStatus, type CustomRacesProgress, type ModuleSetting, type ModuleView, type UiError } from "@/lib/api";
import { api, asUiError, type CustomRacesClientStatus, CustomRaceCharacters, type CustomRacesProgress, type ModuleSetting, type ModuleView, type UiError } from "@/lib/api";
import { cn } from "@/lib/utils";
import { Button } from "@/components/ui/button";
import { Card } from "@/components/ui/card";
@@ -87,12 +87,16 @@ export function ModulesPage({ serverId, onChanged, onRegisterGuard }: { serverId
const { t, locale } = useI18n();
const human = useHuman();
const [modules, setModules] = useState<ModuleView[] | null>(null);
const [parts, setParts] = useState<ModuleView[]>([]);
const [open, setOpen] = useState<string | null>(null);
const [error, setError] = useState<UiError | null>(null);
const toggleLock = useRef(false);
const [toggling, setToggling] = useState<string | null>(null);
const [changed, setChanged] = useState(false);
const [racesPatchStatus, setRacesPatchStatus] = useState<CustomRacesClientStatus | null>(null);
const [raceChars, setRaceChars] = useState<CustomRaceCharacters | null>(null);
const [purging, setPurging] = useState(false);
const [purged, setPurged] = useState<number | null>(null);
const [racesInstalling, setRacesInstalling] = useState(false);
const [racesProgress, setRacesProgress] = useState<CustomRacesProgress | null>(null);
@@ -103,6 +107,7 @@ export function ModulesPage({ serverId, onChanged, onRegisterGuard }: { serverId
} catch {
// ignore
}
setRaceChars(await api.customRaceCharacters(serverId).catch(() => null));
}, [serverId]);
const [guard, setGuard] = useState<UnsavedChangesGuard | null>(null);
const [racesGuard, setRacesGuard] = useState<UnsavedChangesGuard | null>(null);
@@ -119,7 +124,9 @@ export function ModulesPage({ serverId, onChanged, onRegisterGuard }: { serverId
const load = useCallback(async () => {
try {
setModules((await api.modulesList(serverId)).filter((m) => !m.hidden));
const all = await api.modulesList(serverId);
setModules(all.filter((m) => !m.hidden));
setParts(all.filter((m) => m.part_of));
await loadRacesStatus();
} catch (e) {
setError(asUiError(e));
@@ -238,6 +245,18 @@ export function ModulesPage({ serverId, onChanged, onRegisterGuard }: { serverId
{m.id === "custom-races" && (
<div className="w-full">
{!m.enabled && raceChars && raceChars.players + raceChars.companionBots + raceChars.squidBots > 0 && (
<div className="mb-2 rounded-md border border-warn/40 bg-warn/5 p-2 text-xs" role="status">
<p>{t("races.offCharacters", { players: raceChars.players, bots: raceChars.companionBots + raceChars.squidBots })}</p>
{raceChars.companionBots > 0 && <Button size="sm" variant="ghost" className="mt-1 h-auto whitespace-normal py-1 text-left" disabled={purging} onClick={() => void (async () => {
setPurging(true); setError(null);
try { setPurged(await api.purgeCustomRaceBots(serverId)); await loadRacesStatus(); }
catch (e) { setError(asUiError(e)); }
finally { setPurging(false); }
})()}>{purging && <Loader2 className="h-3.5 w-3.5 animate-spin" aria-hidden />}{t("races.purgeBots", { n: raceChars.companionBots })}</Button>}
</div>
)}
{purged !== null && <p className="mb-2 text-xs text-ok" role="status">{t("races.purged", { n: purged })}</p>}
<p className="text-xs text-muted">{locale === "ru" ? "Установленная версия патча клиента: " : "Installed client patch version: "}{racesPatchStatus?.version ?? (locale === "ru" ? "не записана" : "not recorded")}</p>
{racesInstalling && racesProgress ? (
<div className="rounded-lg border border-gold/30 bg-gold/5 p-3">
@@ -328,6 +347,28 @@ export function ModulesPage({ serverId, onChanged, onRegisterGuard }: { serverId
{selected.id === "custom-races" && <RaceAvailabilitySettings serverId={serverId}
blocked={racesInstalling || toggling !== null} onSaved={() => setChanged(true)}
onRegisterGuard={setRacesGuard} />}
{parts.filter(p => p.part_of === selected.id && p.installed).map(p => (
<section key={p.id} className="mt-6 border-t border-line pt-5" aria-label={p.name}>
<div className="flex items-start justify-between gap-4">
<div>
<h3 className="font-semibold">{p.name}</h3>
<p className="mt-1 text-sm text-muted">{p.description[locale] ?? p.description.en}</p>
</div>
{p.switchable && <button
role="switch"
aria-checked={p.enabled}
aria-label={t("mod.switch", { name: p.name })}
aria-busy={toggling === p.id}
disabled={toggling !== null || racesInstalling}
onClick={() => void toggle(p)}
className={cn("relative mt-1 h-6 w-11 shrink-0 cursor-pointer rounded-full transition-colors", p.enabled ? "bg-gold" : "bg-white/15")}
>
<span className={cn("absolute top-0.5 h-5 w-5 rounded-full bg-white transition-all", p.enabled ? "left-[22px]" : "left-0.5")} />
</button>}
</div>
{p.enabled && p.has_settings && <ModuleSettings serverId={serverId} module={p} onSaved={() => setChanged(true)} />}
</section>
))}
</SettingsPanel>
)}
</Fragment>
+48
View File
@@ -0,0 +1,48 @@
import { useEffect, useState } from "react";
import { api, asUiError, type CustomMysql } from "@/lib/api";
import { Card } from "@/components/ui/card";
import { Button } from "@/components/ui/button";
import { useT } from "@/i18n";
/** The owner's own MySQL options (#103): kept in Settings/mysql-custom.ini and added to my.ini at every start. */
export function MySqlSettings({ serverId }: { serverId: string }) {
const t = useT();
const [saved, setSaved] = useState<CustomMysql | null>(null);
const [draft, setDraft] = useState("");
const [busy, setBusy] = useState(false);
const [done, setDone] = useState(false);
const [error, setError] = useState<string | null>(null);
useEffect(() => {
let alive = true;
void api.mysqlCustom(serverId).then(v => { if (alive) { setSaved(v); setDraft(v.text); } }).catch(e => { if (alive) setError(asUiError(e).technical); });
return () => { alive = false; };
}, [serverId]);
async function save() {
setBusy(true); setError(null); setDone(false);
try { const v = await api.mysqlCustomSave(serverId, draft); setSaved(v); setDraft(v.text); setDone(true); }
catch (e) { setError(asUiError(e).technical); }
finally { setBusy(false); }
}
const applied = saved?.applied.trim() ? saved.applied.trim().split("\n").length : 0;
return <Card className="mt-6 p-6" aria-busy={busy}>
<h2 className="font-semibold">{t("mysql.title")}</h2>
<p className="mt-1 text-sm text-muted">{t("mysql.hint")}</p>
<textarea
className="selectable mt-3 h-36 w-full rounded border border-line bg-bg p-3 font-mono text-xs text-ink outline-none focus:border-gold"
spellCheck={false}
placeholder={"innodb_buffer_pool_size = 1G\nmax_connections = 300"}
aria-label={t("mysql.title")}
value={draft}
disabled={busy || !saved}
onChange={e => { setDraft(e.target.value); setDone(false); }}
/>
<div className="mt-3 flex flex-wrap items-center gap-3">
<Button size="sm" disabled={busy || !saved || draft === saved.text} onClick={() => void save()}>{t("mysql.save")}</Button>
<span className="text-xs text-muted">{t("mysql.applied", { count: applied })}{done ? ` · ${t("mysql.saved")}` : ""}</span>
</div>
{error && <p className="mt-3 text-sm text-bad" role="alert">{error}</p>}
</Card>;
}
+1 -1
View File
@@ -228,7 +228,7 @@ export function Overview({ server, companions = true, onForget, onOpenUpdates, o
} else {
if (alive.current) setPop(null);
if (
lifecycle.observe(false, actionRef.current !== null, serverUpdateBlocksRestart(server.id))
lifecycle.observe(false, actionRef.current !== null || s.scheduled_restart === true, serverUpdateBlocksRestart(server.id))
) {
setHasCrashHistory(true);
const now = Date.now();
+60
View File
@@ -0,0 +1,60 @@
import { useEffect, useState } from "react";
import { api, asUiError, type RealmName } from "@/lib/api";
import { Card } from "@/components/ui/card";
import { Button } from "@/components/ui/button";
import { useT } from "@/i18n";
const MAX_CHARS = 32;
export function RealmNameSettings({ serverId }: { serverId: string }) {
const t = useT();
const [realms, setRealms] = useState<RealmName[] | null>(null);
const [drafts, setDrafts] = useState<Record<number, string>>({});
const [busy, setBusy] = useState(false);
const [saved, setSaved] = useState<number | null>(null);
const [error, setError] = useState<string | null>(null);
function show(list: RealmName[]) {
setRealms(list);
setDrafts(Object.fromEntries(list.map(r => [r.id, r.name])));
}
useEffect(() => {
let alive = true;
void api.realmNames(serverId).then(list => { if (alive) show(list); }).catch(e => { if (alive) setError(asUiError(e).technical); });
return () => { alive = false; };
}, [serverId]);
async function rename(id: number, name: string | null) {
setBusy(true); setError(null); setSaved(null);
try { show(await api.realmRename(serverId, id, name)); setSaved(id); }
catch (e) { setError(asUiError(e).technical); }
finally { setBusy(false); }
}
return <Card className="mt-6 p-6" aria-busy={busy}>
<h2 className="font-semibold">{t("realm.namesTitle")}</h2>
<p className="mt-1 text-sm text-muted">{t("realm.namesHint")}</p>
{realms?.map(r => {
const draft = drafts[r.id] ?? r.name;
const invalid = draft.trim().length === 0 || draft.trim().length > MAX_CHARS || draft.includes('"');
return <div key={r.id} className="mt-4">
<div className="flex flex-wrap items-center gap-2">
<input
className="min-w-0 flex-1 rounded border border-line bg-bg px-3 py-1.5 text-sm text-ink outline-none focus:border-gold"
value={draft}
maxLength={MAX_CHARS}
aria-label={t("realm.nameDefault", { name: r.defaultName })}
disabled={busy}
onChange={e => setDrafts(d => ({ ...d, [r.id]: e.target.value }))}
/>
<Button size="sm" disabled={busy || invalid || draft.trim() === r.name} onClick={() => void rename(r.id, draft)}>{t("realm.nameSave")}</Button>
{r.custom && <Button size="sm" variant="ghost" disabled={busy} onClick={() => void rename(r.id, null)}>{t("realm.nameReset")}</Button>}
</div>
<p className="mt-1 text-xs text-muted">{t("realm.nameDefault", { name: r.defaultName })}{saved === r.id ? ` · ${t("realm.nameSaved")}` : ""}</p>
{draft.includes('"') && <p className="mt-1 text-xs text-warn">{t("realm.nameQuotes")}</p>}
</div>;
})}
{error && <p className="mt-3 text-sm text-bad" role="alert">{error}</p>}
</Card>;
}
+57
View File
@@ -0,0 +1,57 @@
import { useEffect, useState } from "react";
import { api, asUiError, type RestartSchedule } from "@/lib/api";
import { Card } from "@/components/ui/card";
import { Button } from "@/components/ui/button";
import { useT } from "@/i18n";
/** A daily world restart at a chosen local time, with an in-game countdown (#202). */
export function RestartScheduleSettings({ serverId }: { serverId: string }) {
const t = useT();
const [saved, setSaved] = useState<RestartSchedule | null>(null);
const [draft, setDraft] = useState<RestartSchedule>({ enabled: false, time: "05:00", warningMinutes: 5 });
const [supported, setSupported] = useState(true);
const [busy, setBusy] = useState(false);
const [done, setDone] = useState(false);
const [error, setError] = useState<string | null>(null);
useEffect(() => {
let alive = true;
void api.restartSchedule(serverId).then(v => { if (alive) { setSaved(v.schedule); setDraft(v.schedule); setSupported(v.supported); } }).catch(e => { if (alive) setError(asUiError(e).technical); });
return () => { alive = false; };
}, [serverId]);
async function save() {
setBusy(true); setError(null); setDone(false);
try { const v = await api.restartScheduleSave(serverId, draft); setSaved(v.schedule); setDraft(v.schedule); setSupported(v.supported); setDone(true); }
catch (e) { setError(asUiError(e).technical); }
finally { setBusy(false); }
}
const changed = !!saved && JSON.stringify(saved) !== JSON.stringify(draft);
const minutesOk = Number.isInteger(draft.warningMinutes) && draft.warningMinutes >= 1 && draft.warningMinutes <= 60;
const input = "rounded border border-line bg-bg px-2 py-1 text-sm text-ink outline-none focus:border-gold";
return <Card className="mt-6 p-6" aria-busy={busy}>
<h2 className="font-semibold">{t("sched.title")}</h2>
<label className="mt-3 flex cursor-pointer items-center gap-3">
<input type="checkbox" className="h-4 w-4 accent-[#c9a24a]" checked={draft.enabled} disabled={busy || !saved} onChange={e => { setDraft(d => ({ ...d, enabled: e.target.checked })); setDone(false); }} />
<span className="text-sm font-medium">{t("sched.enable")}</span>
</label>
<div className="mt-3 flex flex-wrap items-center gap-4 text-sm">
<label className="flex items-center gap-2">
<span>{t("sched.time")}</span>
<input type="time" className={input} value={draft.time} disabled={busy || !draft.enabled} onChange={e => { setDraft(d => ({ ...d, time: e.target.value })); setDone(false); }} />
</label>
<label className="flex items-center gap-2">
<span>{t("sched.warning")}</span>
<input type="number" min={1} max={60} step={1} className={`${input} w-20`} value={draft.warningMinutes} disabled={busy || !draft.enabled} onChange={e => { setDraft(d => ({ ...d, warningMinutes: Number(e.target.value) })); setDone(false); }} />
</label>
</div>
<p className="mt-2 text-sm text-muted">{t("sched.hint")}</p>
{!supported && <p className="mt-2 text-sm text-warn">{t("sched.unsupported")}</p>}
<div className="mt-3 flex items-center gap-3">
<Button size="sm" disabled={busy || !changed || (draft.enabled && !minutesOk)} onClick={() => void save()}>{t("sched.save")}</Button>
{done && <span className="text-xs text-muted">{t("sched.saved")}</span>}
</div>
{error && <p className="mt-3 text-sm text-bad" role="alert">{error}</p>}
</Card>;
}
+5 -2
View File
@@ -12,6 +12,9 @@ import { ReleaseHistory, type HistorySelection } from "./ReleaseHistory";
import { ClientCard } from "./ClientCard";
import { GameDataCard } from "./GameDataCard";
import { RealmStartupSettings } from "./RealmStartupSettings";
import { RealmNameSettings } from "./RealmNameSettings";
import { MySqlSettings } from "./MySqlSettings";
import { RestartScheduleSettings } from "./RestartScheduleSettings";
import { AutoRestartSettings } from "./AutoRestartSettings";
import { DiagnosticsCard } from "./DiagnosticsCard";
import { RepairCard } from "./RepairCard";
@@ -50,9 +53,9 @@ export function SettingsHome({ serverId, path, onForget }: { serverId: string; s
<button onClick={() => setSection("client")} className="mt-5 flex w-full cursor-pointer items-center justify-between gap-3 rounded-lg border border-line px-5 py-4 text-left text-sm hover:bg-white/5"><span>{t("settings.clientLink")}</span><span aria-hidden>→</span></button>
<ReleaseHistory selection={history} onSelect={setHistory} />
</div>
<div hidden={section !== "startup"} className="max-w-3xl"><RealmStartupSettings serverId={serverId} /><AutoRestartSettings serverId={serverId} /></div>
<div hidden={section !== "startup"} className="max-w-3xl"><RealmNameSettings serverId={serverId} /><RealmStartupSettings serverId={serverId} /><AutoRestartSettings serverId={serverId} /><RestartScheduleSettings serverId={serverId} /></div>
<div hidden={section !== "client"} className="max-w-3xl"><ClientCard serverId={serverId} /><GameDataCard serverId={serverId} /></div>
<div hidden={section !== "service"} className="max-w-3xl"><ServerLoggingSettings serverId={serverId} /><DiagnosticsCard serverId={serverId} /><RepairCard serverId={serverId} /><RemoveServerCard serverId={serverId} path={path} onForget={onForget} /></div>
<div hidden={section !== "service"} className="max-w-3xl"><ServerLoggingSettings serverId={serverId} /><MySqlSettings serverId={serverId} /><DiagnosticsCard serverId={serverId} /><RepairCard serverId={serverId} /><RemoveServerCard serverId={serverId} path={path} onForget={onForget} /></div>
<div hidden={section !== "interface"} className="max-w-3xl"><Card className="mt-6 p-6"><h2 className="font-semibold">{t("settings.language")}</h2><p className="mt-1 text-sm text-muted">{t("settings.languageHint")}</p><LanguagePicker className="mt-4" /></Card><WindowSettings /><PublicServerSettings /></div>
</div>;
}
+14 -3
View File
@@ -1,6 +1,17 @@
{
"version": "0.9.13",
"version": "0.9.14",
"notes": [
"The custom races client is updated to Custom Races V2"
"Install community addons from the Manager",
"Old item and creature data is cleared before every Play",
"Turning the custom races client patch on or off takes seconds again",
"The database moves to a free port when Windows reserves or another program takes 3307",
"Your own MySQL settings survive restarts and updates",
"Disabled custom races stay disabled after a server update that adds races",
"Rename your realms in the Manager",
"The account for a friend's server is in the login box at every Play",
"Restart the world every day at a chosen time",
"Switches for the Custom Races V2 subclasses, Hero Races and the /dev menu",
"Companion bots on Wildcard and Warcraft Reborn",
"The Custom Races card tells which characters stay out while races are off"
]
}
}
+10 -217
View File
@@ -2,7 +2,7 @@
"components": {
"core": {
"repository": "Corfirean/azerothcore-wotlk-coa",
"sha": "9740ced5c41806115d851ab37ab34f28e1e8b712"
"sha": "30003e18ab44198ee6f2d819c3047bf6a80631f6"
},
"upstream": {
"repository": "jealous-sound/azerothcore-wotlk-coa",
@@ -10,7 +10,7 @@
},
"bots": {
"repository": "Corfirean/mod-coa-playerbots",
"sha": "30a5a555f56fda8f4ccad14be8438bd0532d85b9"
"sha": "178a7fde6abe1c3c8813d338073b2c83835da497"
},
"scaling": {
"repository": "Corfirean/mod-coa-content-scaling",
@@ -18,7 +18,7 @@
},
"build": {
"repository": "Corfirean/coa-server-build",
"sha": "9a122d049e8be457444389e9756936bcdb4e7ef5"
"sha": "087ca17c4eb2c0ef218d84dd77f37263ee4ed7ee"
},
"squid": {
"repository": "Zyth45/mod-playerbots",
@@ -32,218 +32,11 @@
}
},
"notes": [
"Test build of the subclass module for two-headed Ogres",
"Thin Twins can earn a subclass through their own quest, the Bravery Badge",
"A two-headed Ogre's ranged subclass can shoot at point-blank range",
"Ogres have a new racial, Tolerance",
"Standard-class Ogres and Thin Humans start with only their own class kit",
"Helmets sit on the Thin Human's head instead of his chest",
"LiveMon shows live damage, healing, crowd control and subclass combo statistics",
"Standard-class Ogres and Thin Twins can take a CoA class as their subclass",
"Thin Human and Two-Headed Ogre are now their own playable races",
"Subclassed relic users can hold a relic beside a ranged weapon",
"Server options to limit subclassing or turn the two subclass races off",
"A standard subclass brings its whole basic kit, skills and weapons",
"Two-Headed Ogres and Thin Humans with a standard class can now pick a subclass",
"Thin Humans find more gold with the Hand-Me-Downs racial",
"Two-Headed Ogres wear helmets on both heads",
"Flying mounts no longer fly in Kalimdor and the Eastern Kingdoms",
"LiveMon's character tab can be closed and goes away for deleted characters",
"Classic classes can be limited to their Wrath of the Lich King abilities",
"Dual Wield shows once in the spellbook",
"Two-Headed Ogres get Subclass Bar 1 for the other head's spells",
"Subclass forms leave Two-Headed Ogres in their own body and turn the twin brother instead",
"CoA subclass trees show their specialization painting in the subclass tab",
"Characters with a subclass no longer get Dual Specialization",
"You can hold only one subclass book and one insight at a time",
"Thin Humans and Two-Headed Ogres get the quests of their starting zone",
"The Bravery Badge and the Book of Origins look and read like a badge and a book",
"Ghost Wolf and Travel Form turn the whole ogre, and the twin brother rides the beast",
"Standard-class mains can spend points in their subclass trees and reset main talents",
"Your subclass's trainer can reset only your subclass talents",
"The Thin Human's cape lies along his back instead of sticking out like a board",
"The twin brother finishes pointing before hopping off and readies his weapon with you",
"The twin brother fights with his melee weapon up close and sits close behind you on mounts",
"The twin brother copies your pose on hover discs, carpets and other unusual mounts",
"Two-Headed Ogres sit in cars and keep their mace drawn after a shot",
"Two-Headed Ogres fight with a weapon in one hand and a gun in the other",
"The Ogre's Agree or Disagree racial now shows what it will do next",
"The Thin Twins' brother turns into a worgen in every subclass Cursed Form",
"Leaps and charges ordered for the Thin Twins' brother move him instead of you",
"CoA classes taken as a subclass get their class mechanics",
"Thin Twins and Two-Headed Ogres keep their weapons in a subclass Cursed Form",
"Hovering a Guardian standard no longer causes a Lua error",
"LiveMon shows specialization names instead of their signature spells",
"Ogre eyes are picked by colour, with a Blind checkbox for each eye",
"Two-headed ogres no longer keep casting after a subclass spell with a cast time",
"Two-headed ogres cast every subclass spell with the left arm",
"The other half only shoots when you attack a target out of melee reach",
"The other head raises her hand while casting and your presses come first",
"Saving talent changes no longer fails for characters with a subclass",
"The second-way quest no longer pops up at level 20",
"Every race can create the standard classes the creation screen offers again",
"Subclass Bar 1 shows cooldowns, charges and casts like a normal action bar",
"Subclass Bar 1 refills itself when you change subclass",
"Subclass Bar 1 appears as soon as you choose a subclass",
"Subclass Bar 1 works like an action bar and can live in Bartender4",
"A subclass can never be the character's own class",
"New characters no longer inherit the subclass of a deleted character",
"Sun Cleric, Barbarian, Bloodmage and Cultist subclass resources use the game's own orbs",
"Shapeshifting no longer takes away the twin brother or the subclass",
"A subclass specialization now teaches the ability its passive promises",
"Subclass stances and forms appear only on the subclass stance bar",
"Subclass vows, auras and formations move to the subclass stance bar",
"The Thin Human's cape rests on his shoulders and moves with them",
"The twin brother gets a real spot in cars and rides along in passenger seats",
"The twin brother puts his weapons away while he wears a subclass shape",
"The Thin Twins' brother now shows the flash and glow of subclass forms",
"The twin brother sneaks along in stealth instead of staying behind",
"The stance button takes a Thin Twin out of a form his brother wears again",
"The Two-Head and Two-Thins tabs show one wide background and the right class icon",
"The Two-Head and Two-Thins trees use the game's own talent nodes",
"Agree or Disagree takes one spellbook slot that changes name and icon",
"Subclass talent trees no longer let you spend more points than you have",
"Your brother stays at your side when you melee with a bow equipped",
"A melee brother stays on your target and keeps fighting",
"The Two-Headed Ogre twists her body less while her other head casts",
"Thin Twins and Two-Headed Ogres are Hero Races that need a level 60 character",
"The Two-Headed Ogre's portrait shows both heads instead of her body",
"Your other half's spells break your stealth, and Running Wild ends when you stealth",
"Spells your other half casts now trigger the class's talents and resources",
"Your other half takes the subclass's Cat, Bear and stance forms on their own",
"Your other head or brother can no longer finish a cast while you run",
"The other head's hand glows while she casts",
"With Play Easy on, your other half uses abilities that cost health",
"New racial passives explain the shared and split resource pools",
"The dressing room works for races without their own background, no extra addon needed",
"Your brother climbs onto your Travel Form or wolf even after a fight",
"When your brother uses Running Wild, you ride on his back",
"In Running Wild you ride on your brother's shoulders",
"Your weapons no longer go missing after a Running Wild ride",
"When both halves use the same resource, their pool is twice as big",
"The subclass window shows every CoA class's own background at full strength",
"You can rearrange Subclass Bar 1 during combat without an error",
"Your other head or brother has a cast bar of their own",
"Choice talents in the subclass window show as one node with two options",
"SpellActivationOverlay can light up Subclass Bar 1",
"Your subclass's resource now shows as an extra bar under your portrait",
"Your other half's resource bar keeps its value when you log out and back in",
"Rage, energy and runic power subclasses now get and use their resource",
"Subclass resource orbs only appear when your subclass specialization can fill them",
"Your subclass specialization comes with its first class talent learned",
"Your main class's key stat now also powers your subclass",
"Subclass talents follow the paths and point requirements of their tree",
"Your summons follow your brother while he walks beside you",
"Your brother rides on the back of your Travel Form cat and moves with it",
"Dressing your twin in the wardrobe no longer causes an addon error",
"Your brother rides on your back in Wargstride",
"A Bloodmage subclass's Cursed Form no longer replaces your own action bar",
"Pressing an active subclass stance or form again turns it off",
"Character select shows your subclass under your class",
"The Two-Headed Ogre's second head no longer pokes through hats",
"Two-Headed Ogres keep aiming between shots instead of idling",
"Two-Headed Ogres who shoot rest their gun on the shoulder when not firing",
"Two-Headed Ogres who shoot themselves aim and fire their gun with the right hand",
"Two-Headed Ogres who shoot fire their bullets from the gun hand",
"The wardrobe shows a Two-Headed Ogre's applied look and her saved outfits apply again",
"The second head's quest mark floats over her head in cities and inns",
"Subclass Bar 1 no longer fills up with Throw, Shoot, Wand and Auto Attack",
"Abilities you learn from your subclass no longer land on your own action bars",
"A caster Two-Headed Ogre keeps her staff in hand while her second head shoots",
"A Two-Headed Ogre's staff keeps its size when she puts it on her back",
"A shooting subclass starts Auto Shot on right-click without logging out first",
"A Hunter subclass keeps Auto Shot going while the main head casts or moves",
"Weapons and armor from a subclass stay usable after logging in again",
"Two-Headed Ogres are Horde again and Thin Twins share Forgotten race rules",
"Thin Humans and Two-Headed Ogres can no longer be created as Hero",
"The Two-Headed Ogre stays in her combat stance between attacks",
"The second-head tab only shows for Two-Headed Ogres and Thin Twins",
"Thin Twins capes no longer show their inside at the shoulders",
"Thin Twins keep short hair under hats",
"Thin Twins keep their face, cape and hat fit with CoA Custom 1.9.2",
"Thin Twins show their class gear in character creation",
"Two-Headed Ogre capes drape over her back",
"CoA Custom 1.9.5 races work on the subclass server",
"With Play easy, cowboy the brother leaves a spent timed form",
"The Two-Headed Ogre casts with a raised fist before her face",
"The second-head client patch is now patch-ZZZZT.MPQ",
"Dual Wield shows once in the spellbook, whichever class teaches it",
"The subclass addon keeps working when the Twins or Ogre are renamed",
"The subclass name shows only on the character tab",
"The Thin Twins' Accursed brother keeps his distance until he takes his cursed form",
"The Thin Twins' brother follows a form's cost, cooldown and duration",
"The Thin Twins' own mana bar no longer flickers",
"Witch Hunter Vault now springs over in a handspring instead of a jump",
"The Twins brother keeps his timed form and no longer takes forms a spell forbids",
"The Twins brother faces his target, leaps in and leaves a form to heal you",
"With Play easy, cowboy, the brother uses his timed forms in a fight",
"Original races no longer look broken in the 64-bit client's character creation",
"Subclasses get their specialization's free passives, like the Pyromancer's draconic form",
"The subclass cast bar no longer gets stuck and can always be Alt-dragged",
"Pick-one talents in the subclass window no longer overlap their neighbours",
"Subclass spells get their rank upgrades, resources and class mechanics",
"Subclass talents that replace a spell now replace it for the subclass too",
"The Thin Twins keep their own hairstyle under hats",
"The Twins brother takes the look of the cursed form he actually uses",
"The Twins brother stands beside you at character select in his own clothes",
"The Twins brother climbs down from your back before taking a form",
"Spells the Twins brother casts no longer play a cast animation on you",
"The Thin Twins brother is now your mirror image",
"The Thin Twins brother can have his own face, hair style and beard",
"A script builds the original races' Vault patches from your own client files",
"The subclass client patch is now built after the release's own patches",
"The mirrored Thin Twins brother is built from the current Thin Twins model",
"Pressing your subclass mount again dismounts you",
"Removing a subclass dismisses the pet it let you summon",
"Removing a Warlock or Paladin subclass no longer unlearns your mounts",
"Removing a subclass no longer leaves its spells in your spellbook",
"A Starcaller subclass shows Lunar Phase as CoA's moon",
"Your twin's or other head's pet gets its own movable pet bar",
"A Ranged Head stands still while the Melee Head is offline",
"A bot plays the missing head of a Two-Players ogre",
"A Ranged Head keeps an echo of its deleted Melee Head's gear",
"Two-Players ogres hold books, pouches and orbs forward in the off hand",
"Two-Players ogres can pair up as Melee Head and Ranged Head",
"Paired Two-Players heads share one body",
"SquidBots Lite no longer prints \"Command 'dc status' does not exist\" at login",
"The subclass action bar no longer causes a blocked-action error in combat",
"Two-Players heads split their abilities into melee for the body and ranged for the rider",
"Two-Players heads gain Agree or Disagree stacks when they fight together",
"Two-Players heads can only be CoA classes",
"The Ranged Head's gear slots are frozen in ice and can no longer be dragged",
"Two-Players heads find the abilities they borrow on their own bar",
"Two-Players ogres can Bonk Heads! together once the heads have agreed long enough",
"Abilities lent between Two-Players heads follow each head's respecs and new spells",
"Two-Players ogres can use Mutate Me! to take the eyes-everywhere look and back",
"A Two-Players ogre fills one party spot and enters dungeons as one player",
"A Two-Players ogre joins a party only when there is room for both heads",
"A Ranged Head's own frame now stands for the shared Two-Players body",
"The Two-Players Ranged Head shares the body's health and both heads get full kill XP",
"The Two-Players Ranged Head shares the body's gear",
"Two-Players heads split quest gold, share one resource pool and keep their head's specs",
"Mobs attacked by the Two-Players Ranged Head now fight the body",
"Two-Players Twins: the second brother rides piggyback on the first, visible as himself",
"Bot plans panel shows what your group's bots are doing and lets you pick their next quest",
"Questing bots do all their quests in one area before moving on",
"The Twins' second brother keeps and wears his own gear on his brother's back",
"A Two-Players twin can call his brother to his side until another player joins him",
"Agree now raises spell and ranged hit too, not only melee hit",
"Two-Players ogres drop their mount when either head attacks",
"The other head's abilities now go on your own action bars",
"A bot body keeps questing, looting and resting after a fight instead of standing still",
"A bot body's SquidBots menu now opens from a button on your own player frame",
"Character select shows a Two-Players head's joined name and its partner's class",
"The Ranged Head now goes into and out of Dungeon Finder dungeons with the body",
"Two-Players can be switched off with Subclass.TwoPlayers.Enable",
"The other head's abilities only cost you resources when they actually go off",
"Character select shows a Two-Players ogre in his Mutate Me look",
"The Ranged Head gets the enchant, gem and suffix stats of the shared gear",
"The Ranged Head of a Two-Headed Ogre no longer pops out of the body at logout",
"A Ranged Head and its bot body are in one party again, so party chat and bot orders work",
"A bot riding as the Ranged Head no longer rests, roams or makes the body sit down",
"The character sheet of a Two-Players head shows the other head's class",
"Two-Players Ogres can fit a carried mount in a window and share the fit",
"Custom Races V2 with 17 new races, subclasses and the Fading Island",
"Updated Custom Races to 2.0"
"Custom races stay on when an update changes the race catalog",
"Server support for companion bots on Wildcard and Warcraft Reborn",
"Custom-race characters stay out of the world while custom races are off",
"Companion bots play Wildcard and Warcraft Reborn",
"Stopping the server no longer leaves the world running now and then",
"The server includes a native launcher for the world supervisor"
]
}
}
-223
View File
@@ -1,223 +0,0 @@
import pathlib
import runpy
import sys
import tempfile
import unittest
import time
from unittest.mock import patch
BRIDGE = pathlib.Path(__file__).resolve().parents[1] / 'crates/coa-core/src/launcher_bridge.py'
class LauncherBridgeTests(unittest.TestCase):
def launch(self, action, body):
with tempfile.TemporaryDirectory() as directory:
script = pathlib.Path(directory) / 'Scripts/manage.py'
script.parent.mkdir()
script.write_text(body, encoding='utf8')
original = runpy.run_path
def capture(*args, **kwargs):
self.launcher = original(*args, **kwargs)
return self.launcher
with patch.object(sys, 'argv', ['bridge', str(script), action]), patch.object(runpy, 'run_path', side_effect=capture):
return original(str(BRIDGE))
def shutdown_fixture(self, *, console_error='RuntimeError', stopped=True, foreign=False, same=True, modern=False, terminate_error=False):
return f'''
from pathlib import Path
from contextlib import nullcontext
calls = []
world = {{'pid': 123, 'created': 456, 'exe': str(Path(__file__).resolve().parents[1] / {'"foreign.exe"' if foreign else '"Core/worldserver.exe"'})}}
def wait_ready(*args): pass
def start_mysql(): raise AssertionError('must not start')
def main(): raise AssertionError('must not prepare')
def settings(): return {{}}
def control_lock(): return nullcontext()
def process(name): return world if name == 'world' else None
def same_process(record): return {same!r}
def ra(command, config):
calls.append('console')
{'raise '+console_error+'("Start this repack worldserver first")' if console_error else 'return "Graceful shutdown"'}
def terminate(record):
assert record is world
calls.append('terminate')
{'raise RuntimeError("identity changed")' if terminate_error else 'pass'}
def wait_stopped(record, seconds):
assert record is world
calls.append('wait')
return {stopped!r}
def stop_all(config):
record = process('world')
if record:
if {modern!r}:
try: ra('server shutdown 1s 0', config)
except (OSError, RuntimeError): terminate(record)
else:
ra('server shutdown 1s 0', config)
if not wait_stopped(record, 60): raise RuntimeError('world still alive')
calls.append('mysql-shutdown')
'''
def test_unavailable_console_in_restored_legacy_launcher_stops_owned_world_before_mysql(self):
for error in ['RuntimeError', 'OSError']:
with self.subTest(error=error):
result = self.launch('stop-all', self.shutdown_fixture(console_error=error))
self.assertEqual(result['launcher']['calls'], ['console', 'terminate', 'wait', 'wait', 'mysql-shutdown'])
def test_force_stop_terminates_only_the_owned_world_before_mysql(self):
body = self.shutdown_fixture(console_error=None)
body = body.replace("return world if name == 'world' else None", "return world if name == 'world' and 'terminate' not in calls else None")
result = self.launch('force-stop-all', body)
self.assertEqual(result['launcher']['calls'], ['terminate', 'wait', 'mysql-shutdown'])
def test_force_stop_rejects_foreign_or_reused_pids_and_a_world_that_stays_alive(self):
for options, message in [({'foreign': True}, 'ownership could not be verified'),
({'same': False}, 'ownership could not be verified'),
({'stopped': False}, 'database was left running')]:
with self.subTest(options=options):
with self.assertRaisesRegex(Exception, message):
self.launch('force-stop-all', self.shutdown_fixture(**options))
self.assertNotIn('mysql-shutdown', self.launcher['calls'])
def test_healthy_console_keeps_graceful_shutdown(self):
result = self.launch('stop-all', self.shutdown_fixture(console_error=None))
self.assertEqual(result['launcher']['calls'], ['console', 'wait', 'mysql-shutdown'])
def test_foreign_or_reused_process_is_never_terminated_even_by_a_modern_launcher_catch(self):
for modern in [False, True]:
for identity in [{'foreign': True}, {'same': False}]:
with self.subTest(modern=modern, **identity):
with self.assertRaisesRegex(Exception, 'ownership could not be verified'):
self.launch('stop-all', self.shutdown_fixture(modern=modern, **identity))
self.assertEqual(self.launcher['calls'], ['console'])
def test_world_that_stays_alive_blocks_database_shutdown(self):
for modern in [False, True]:
with self.subTest(modern=modern):
with self.assertRaisesRegex(Exception, 'database was left running'):
self.launch('stop-all', self.shutdown_fixture(stopped=False, modern=modern))
self.assertEqual(self.launcher['calls'], ['console', 'terminate', 'wait'])
def test_termination_identity_failure_leaves_mysql_untouched(self):
for modern in [False, True]:
with self.subTest(modern=modern):
with self.assertRaisesRegex(Exception, 'could not be stopped safely'):
self.launch('stop-all', self.shutdown_fixture(terminate_error=True, modern=modern))
self.assertEqual(self.launcher['calls'], ['console', 'terminate'])
def test_slow_mysql_gets_time_to_finish_but_other_waits_are_unchanged(self):
result = self.launch('start-mysql', '''
calls = []
def wait_ready(name, port, seconds=180):
calls.append((name, seconds))
if name == 'mysql' and seconds < 162:
raise RuntimeError('mysql is still starting')
def start_mysql():
wait_ready('mysql', 12345, 60)
def main():
start_mysql()
wait_ready('world', 23456, 180)
wait_ready('mysql', 12345, 900)
''')
calls = result['launcher']['calls']
self.assertEqual(calls[0], ('mysql', 300))
self.assertEqual(calls[2], ('mysql', 900))
self.assertEqual(calls[1][0], 'world')
self.assertAlmostEqual(calls[1][1], 1500, delta=1)
def world_start(self, *, game_at=420, console_at=480, dies_at=None, requested=180):
clock = [0.0]
def sleep(seconds): clock[0] += seconds
body = f'''
import time
calls = []
dies_at = {dies_at!r}
def wait_ready(name, port, seconds=180):
until = time.monotonic() + seconds
while time.monotonic() < until:
if dies_at is not None and time.monotonic() >= dies_at:
raise RuntimeError('world stopped during startup')
if time.monotonic() >= ({game_at!r} if port == 1 else {console_at!r}):
calls.append(port)
return
time.sleep(0.5)
raise RuntimeError('world is still starting')
def start_mysql(): pass
def settings(): return {{}}
def process(name): return {{'pid': 1}}
def ra(command, config): return 'server info ready'
def main():
wait_ready('world', 1, {requested})
wait_ready('world', 2, {requested})
'''
with patch('time.monotonic', side_effect=lambda: clock[0]), patch('time.sleep', side_effect=sleep):
result = self.launch('start-all', body)
return clock[0], result['launcher']['calls']
def test_open_ports_do_not_finish_startup_until_commands_are_processed(self):
clock = [0.0]
def sleep(seconds): clock[0] += seconds
body = """
import time
calls=[]
def wait_ready(*args): pass
def start_mysql(): pass
def settings(): return {}
def process(name): return {'pid': 1}
def ra(command, config):
calls.append(command)
if time.monotonic() < 5: raise TimeoutError('main loop is loading')
return 'ready'
def main():
wait_ready('world',1)
wait_ready('world',2)
"""
with patch('time.monotonic', side_effect=lambda: clock[0]), patch('time.sleep', side_effect=sleep):
result=self.launch('start-all',body)
self.assertEqual(clock[0],5)
self.assertEqual(set(result['launcher']['calls']),{'server info'})
def test_world_death_after_ports_open_is_a_startup_failure(self):
body="""
def wait_ready(*args): pass
def start_mysql(): pass
def settings(): return {}
def process(name): return None
def main(): pass
"""
with self.assertRaisesRegex(RuntimeError,'stopped before its console accepted'):
self.launch('start-world',body)
def test_legacy_coa_world_waits_for_both_ports_after_three_minutes(self):
elapsed, calls = self.world_start()
self.assertEqual((elapsed, calls), (480, [1, 2]))
def test_console_wait_shares_the_world_deadline(self):
with self.assertRaisesRegex(RuntimeError, 'still starting'):
self.world_start(game_at=1490, console_at=1510)
self.assertEqual(self.launcher['calls'], [1])
def test_world_exit_is_reported_without_waiting_out_the_extended_budget(self):
with self.assertRaisesRegex(RuntimeError, 'stopped during startup'):
self.world_start(dies_at=12)
self.assertEqual(self.launcher['calls'], [])
def test_existing_longer_world_timeout_is_preserved(self):
self.assertEqual(self.world_start(game_at=1600, console_at=1700, requested=1800), (1700, [1, 2]))
def test_stop_dispatch_does_not_prepare_or_start_anything(self):
result = self.launch('stop-all', '''
from contextlib import nullcontext
calls = []
def wait_ready(*args): raise AssertionError('must not wait')
def start_mysql(): raise AssertionError('must not start')
def main(): raise AssertionError('must not prepare')
def settings(): return {'mysqlPort': 12345}
def control_lock(): return nullcontext()
def stop_all(config): calls.append(config['mysqlPort'])
''')
self.assertEqual(result['launcher']['calls'], [12345])
if __name__ == '__main__':
unittest.main()