mirror of
https://github.com/Corfirean/coa-server-manager.git
synced 2026-11-19 03:25:56 +00:00
Compare commits
40
Commits
| Author | SHA1 | Date | |
|---|---|---|---|
|
|
f0950c99ca | ||
|
|
d86a1676fe | ||
|
|
53a05820c8 | ||
|
|
58c976a388 | ||
|
|
35c4d03bdc | ||
|
|
c45f962d02 | ||
|
|
f52bd8ba5f | ||
|
|
247159e56c | ||
|
|
cdd5be2365 | ||
|
|
7e170744bf | ||
|
|
10daa9b74d | ||
|
|
ed7bf7262b | ||
|
|
7c866b116d | ||
|
|
cfea54e203 | ||
|
|
57aa97da8a | ||
|
|
b9f89a4ae4 | ||
|
|
6fd2130fc4 | ||
|
|
346d97ee89 | ||
|
|
10a6744192 | ||
|
|
7557b347c5 | ||
|
|
2abd64dfe2 | ||
|
|
9ae5fb471b | ||
|
|
59036867d7 | ||
|
|
949614f11a | ||
|
|
9ee0e9f6af | ||
|
|
3405c89fe8 | ||
|
|
4c4d39f1de | ||
|
|
b101c79e96 | ||
|
|
3b7f77d92e | ||
|
|
0589722e71 | ||
|
|
a3717c08bb | ||
|
|
dc2bffc57e | ||
|
|
e34ab45443 | ||
|
|
40f9feab84 | ||
|
|
5b16842720 | ||
|
|
02843bb6d1 | ||
|
|
a9ab7ced7e | ||
|
|
77318895ae | ||
|
|
115c57f54e | ||
|
|
94fd5fb5b9 |
No files matched your search
@@ -4,3 +4,5 @@ dist
|
||||
*.log
|
||||
.env
|
||||
src-tauri/gen
|
||||
# Disposable database fixtures and private recovery data
|
||||
.cache/
|
||||
Generated
+3
-3
@@ -491,7 +491,7 @@ dependencies = [
|
||||
|
||||
[[package]]
|
||||
name = "coa-core"
|
||||
version = "0.6.12"
|
||||
version = "0.6.15"
|
||||
dependencies = [
|
||||
"base64 0.22.1",
|
||||
"chrono",
|
||||
@@ -520,7 +520,7 @@ dependencies = [
|
||||
|
||||
[[package]]
|
||||
name = "coa-release"
|
||||
version = "0.6.12"
|
||||
version = "0.6.15"
|
||||
dependencies = [
|
||||
"chrono",
|
||||
"coa-core",
|
||||
@@ -529,7 +529,7 @@ dependencies = [
|
||||
|
||||
[[package]]
|
||||
name = "coa-server-manager"
|
||||
version = "0.6.12"
|
||||
version = "0.6.15"
|
||||
dependencies = [
|
||||
"coa-core",
|
||||
"serde",
|
||||
|
||||
+1
-1
@@ -3,7 +3,7 @@ resolver = "2"
|
||||
members = ["crates/coa-core", "crates/coa-release", "src-tauri"]
|
||||
|
||||
[workspace.package]
|
||||
version = "0.6.12"
|
||||
version = "0.6.15"
|
||||
edition = "2021"
|
||||
license = "AGPL-3.0-only"
|
||||
|
||||
|
||||
@@ -0,0 +1,7 @@
|
||||
---
|
||||
area: manager
|
||||
type: added
|
||||
audience: admins
|
||||
title: Linux Docker servers follow Settings, sharing and backups (experimental)
|
||||
---
|
||||
Experimental. Settings the Docker backend fixes are hidden, friends sharing and logs work, the game data folder can be changed, and the realm no longer shows offline after a start.
|
||||
@@ -0,0 +1,7 @@
|
||||
---
|
||||
area: manager
|
||||
type: changed
|
||||
audience: admins
|
||||
title: Failed server startup after an update automatically restores the previous version
|
||||
---
|
||||
The Manager restores server files and databases, then checks the recovered server. If recovery cannot be confirmed, it preserves the recovery point and blocks further startup until the problem is resolved.
|
||||
@@ -0,0 +1,7 @@
|
||||
---
|
||||
area: manager
|
||||
type: fixed
|
||||
audience: admins
|
||||
title: Windows update recovery preserves database procedures triggers and views
|
||||
---
|
||||
A verified copy of stopped MySQL restores all databases and accounts together. Interrupted restoration can be retried, and the replaced database directory is retained.
|
||||
@@ -0,0 +1,7 @@
|
||||
---
|
||||
area: manager
|
||||
type: fixed
|
||||
audience: admins
|
||||
title: Custom races bot setting synchronizes Playerbots excluded race lists
|
||||
---
|
||||
The "Bots can be custom races" setting now configures AiPlayerbot.ExcludedBotRaces in playerbots.conf. Off excludes all added races (recommended), while on allows stable added races (experimental).
|
||||
@@ -0,0 +1,7 @@
|
||||
---
|
||||
area: manager
|
||||
type: fixed
|
||||
audience: admins
|
||||
title: Blocked updates identify database objects that prevent automatic recovery
|
||||
---
|
||||
Diagnostics include the complete list of unsupported database objects across the recovery point, helping resolve update failures without removing user data.
|
||||
@@ -0,0 +1,7 @@
|
||||
---
|
||||
area: manager
|
||||
type: added
|
||||
audience: admins
|
||||
title: Updates can follow signed channels that select a complete server release
|
||||
---
|
||||
The Manager checks the channel signature and downloads every package part from the same release. Existing installations continue using the previous download source until the new channel is published.
|
||||
@@ -0,0 +1,7 @@
|
||||
---
|
||||
area: manager
|
||||
type: fixed
|
||||
audience: admins
|
||||
title: Server updates check startup privately before allowing players to connect
|
||||
---
|
||||
Startup checks use temporary local ports. Original settings are restored before opening the server, and interrupted checks retain a recovery journal.
|
||||
@@ -0,0 +1,7 @@
|
||||
---
|
||||
area: manager
|
||||
type: fixed
|
||||
audience: admins
|
||||
title: Updates repair missing database defaults from the verified release schema
|
||||
---
|
||||
Only missing literal defaults are restored when column properties match. Existing rows, custom defaults, types and nullability are preserved; unresolved incompatibilities still block the update.
|
||||
@@ -0,0 +1,7 @@
|
||||
---
|
||||
area: manager
|
||||
type: fixed
|
||||
audience: admins
|
||||
title: Server updates no longer replay module installation scripts on existing databases
|
||||
---
|
||||
Update packages contain incremental SQL only. Module table initialization and seed scripts remain available when preparing a clean installation, preventing existing content from being reset during updates.
|
||||
@@ -0,0 +1,7 @@
|
||||
---
|
||||
area: manager
|
||||
type: added
|
||||
audience: admins
|
||||
title: Windows server updates are tested on a private copy before changing your installation
|
||||
---
|
||||
The Manager tests migrations and server startup using your databases and configurations. A failed rehearsal leaves the installed server unchanged and preserves a diagnostic report.
|
||||
@@ -0,0 +1,7 @@
|
||||
---
|
||||
area: manager
|
||||
type: added
|
||||
audience: admins
|
||||
title: Server updates can require a tested combination of platform and installed version
|
||||
---
|
||||
Signed release metadata identifies core and module revisions, supported starting versions and database contracts. Incompatible packages are rejected before shutdown; changed schema contracts and incompatible databases block installation before migration.
|
||||
@@ -0,0 +1,7 @@
|
||||
---
|
||||
area: manager
|
||||
type: fixed
|
||||
audience: admins
|
||||
title: Failed database checks keep a complete report after rollback
|
||||
---
|
||||
Schema errors show readable default values and save every detected difference for troubleshooting, including after the server is restored.
|
||||
@@ -0,0 +1,7 @@
|
||||
---
|
||||
area: manager
|
||||
type: added
|
||||
audience: players
|
||||
title: Players can install custom race patches when connecting to a friend
|
||||
---
|
||||
Install the custom race client patch directly from the Game client section without hosting a server.
|
||||
@@ -0,0 +1,7 @@
|
||||
---
|
||||
area: manager
|
||||
type: fixed
|
||||
audience: admins
|
||||
title: Large server updates no longer repeatedly rewrite the recovery journal
|
||||
---
|
||||
Updates containing rebuilt navigation data now prepare all recovery copies before replacing files. Interrupted updates remain recoverable without rewriting the full journal for every file.
|
||||
@@ -0,0 +1,7 @@
|
||||
---
|
||||
area: manager
|
||||
type: fixed
|
||||
audience: admins
|
||||
title: Normalize rehearsal server roots to prevent Windows path prefix errors
|
||||
---
|
||||
Server update rehearsals now canonicalize the installation root before collecting files, resolving a "prefix not found" error during rehearsal preparation on Windows.
|
||||
@@ -27,6 +27,7 @@ fn exercise(root: &Path) -> Result<()> {
|
||||
MetaDir::create(root, &installed)?;
|
||||
backup::with_database(root, |db| {
|
||||
db.query("CREATE TABLE acore_characters.manager_recovery_probe (id INT); INSERT INTO acore_characters.manager_recovery_probe VALUES (42); CREATE TABLE acore_world.manager_recovery_probe (id INT); INSERT INTO acore_world.manager_recovery_probe VALUES (43);")?;
|
||||
db.query("CREATE VIEW acore_characters.manager_recovery_view AS SELECT id FROM acore_characters.manager_recovery_probe; CREATE TRIGGER acore_characters.manager_recovery_trigger BEFORE INSERT ON acore_characters.manager_recovery_probe FOR EACH ROW SET NEW.id=NEW.id+1; CREATE PROCEDURE acore_characters.manager_recovery_proc() SELECT id FROM acore_characters.manager_recovery_probe;")?;
|
||||
Ok(())
|
||||
})?;
|
||||
let source = root.join("fixture-update-source");
|
||||
@@ -54,13 +55,15 @@ fn exercise(root: &Path) -> Result<()> {
|
||||
cancel: Cancel::default(), resolutions: BTreeMap::new(), env: &env, fail_after_ops: None,
|
||||
}, &|step, pct| println!("{pct}% {step}" )).unwrap_err();
|
||||
assert!(error.to_string().contains("probe_world"), "{error}");
|
||||
assert!(error.to_string().contains("were restored"), "{error}");
|
||||
assert!(error.to_string().contains("private update rehearsal failed"), "{error}");
|
||||
assert!(!root.join("Core/recovery-probe.txt").exists());
|
||||
assert!(update::unfinished(&meta).is_none());
|
||||
assert_eq!(MetaDir::open(&meta)?.1.core.version.as_deref(), Some("1.0.0"));
|
||||
backup::with_database(root, |db| {
|
||||
assert_eq!(db.query("SELECT id FROM acore_characters.manager_recovery_probe;")?, "42");
|
||||
assert_eq!(db.query("SELECT id FROM acore_world.manager_recovery_probe;")?, "43");
|
||||
assert_eq!(db.query("SELECT id FROM acore_characters.manager_recovery_view;")?, "42");
|
||||
assert_eq!(db.recovery_objects("acore_characters")?.iter().filter(|object| object["name"].as_str().is_some_and(|name| name.starts_with("manager_recovery_"))).count(), 3);
|
||||
assert!(!coa_core::migrations::status(db, &manifest.migrations)?.iter().any(|m| m.status == coa_core::migrations::Status::Applied));
|
||||
Ok(())
|
||||
})?;
|
||||
@@ -68,6 +71,6 @@ fn exercise(root: &Path) -> Result<()> {
|
||||
let point = backup::list(&meta).into_iter().find(|p| p.trigger == backup::Trigger::BeforeUpdate).ok_or_else(|| Error::Invalid("missing backup".into()))?;
|
||||
env.restore_snapshot(&point.id)?;
|
||||
assert_eq!(Db::from_repack(root, Account::Admin)?.realm(), coa_core::realms::Mode::Coa);
|
||||
println!("PASS: failed SQL restored world, characters, ledger, files and version; repeated recovery succeeded");
|
||||
println!("PASS: private rehearsal caught failed SQL before changing the installed world, characters, ledger, objects, files or version; complete recovery succeeded");
|
||||
Ok(())
|
||||
}
|
||||
@@ -67,6 +67,8 @@ pub struct RecoveryPoint {
|
||||
pub components: Vec<Component>,
|
||||
#[serde(default)]
|
||||
pub realm: crate::realms::Mode,
|
||||
#[serde(default, skip_serializing_if = "Option::is_none")]
|
||||
pub(crate) mysql_snapshot: Option<crate::mysql_snapshot::Snapshot>,
|
||||
}
|
||||
|
||||
const LOCATION_FILE: &str = "backup-location.json";
|
||||
@@ -210,7 +212,7 @@ pub fn config_files(root: &Path) -> Vec<String> {
|
||||
for e in rd.flatten() {
|
||||
let n = e.file_name().to_string_lossy().to_string();
|
||||
// database.json holds generated database passwords; it is launcher state, not configuration.
|
||||
if e.path().is_file() && (n.contains(".template") || n == "repack.json") {
|
||||
if e.path().is_file() && (n.contains(".template") || n == "repack.json" || n == "docker.json") {
|
||||
out.push(format!("Settings/{n}"));
|
||||
}
|
||||
}
|
||||
@@ -334,6 +336,16 @@ pub fn create(root: &Path, meta: &Path, kind: Kind, trigger: Trigger, label: Opt
|
||||
return Err(e);
|
||||
}
|
||||
};
|
||||
let mysql_snapshot = if kind == Kind::Full && trigger == Trigger::BeforeUpdate && cfg!(windows) && !crate::docker::is_docker(root) {
|
||||
progress("Saving a complete stopped MySQL recovery copy");
|
||||
match crate::mysql_snapshot::capture(root, &partial) {
|
||||
Ok(snapshot) => Some(snapshot),
|
||||
Err(error) => {
|
||||
if let Ok(owned) = fsx::ensure_within(&backups_dir(meta), &partial) { let _ = fs::remove_dir_all(owned); }
|
||||
return Err(error);
|
||||
}
|
||||
}
|
||||
} else { None };
|
||||
let point = RecoveryPoint {
|
||||
realm: crate::realms::state(root)?.active,
|
||||
schema: 1,
|
||||
@@ -344,6 +356,7 @@ pub fn create(root: &Path, meta: &Path, kind: Kind, trigger: Trigger, label: Opt
|
||||
created_at: chrono::Utc::now().to_rfc3339(),
|
||||
manager_version: crate::MANAGER_VERSION.into(),
|
||||
components,
|
||||
mysql_snapshot,
|
||||
};
|
||||
fsx::atomic_write_json(&partial.join("backup.json"), &point)?;
|
||||
fs::rename(&partial, &final_dir)?;
|
||||
@@ -375,6 +388,9 @@ pub fn verify(meta: &Path, id: &str) -> Result<VerifyReport> {
|
||||
let point = get(meta, id)?;
|
||||
let dir = point_dir(meta, id)?;
|
||||
let mut problems = Vec::new();
|
||||
if let Some(snapshot) = &point.mysql_snapshot {
|
||||
if let Err(error) = crate::mysql_snapshot::verify(&dir, snapshot) { problems.push(error.to_string()); }
|
||||
}
|
||||
let mut names = std::collections::BTreeSet::new();
|
||||
let mut schemas = std::collections::BTreeSet::new();
|
||||
for c in &point.components {
|
||||
|
||||
@@ -0,0 +1,86 @@
|
||||
//! Signed channel pointers select one immutable package for an entire transaction.
|
||||
use serde::{Deserialize, Serialize};
|
||||
use crate::{Error, Result};
|
||||
use crate::pkgsource::{fetch_small, Source};
|
||||
|
||||
#[derive(Debug, Serialize, Deserialize)]
|
||||
#[serde(rename_all = "camelCase", deny_unknown_fields)]
|
||||
pub struct Pointer {
|
||||
pub schema: u32,
|
||||
pub channel: String,
|
||||
pub version: String,
|
||||
pub release_tag: String,
|
||||
pub snapshot: String,
|
||||
}
|
||||
|
||||
#[derive(Deserialize, Serialize)]
|
||||
#[serde(deny_unknown_fields)]
|
||||
pub struct Envelope {
|
||||
pub payload: String,
|
||||
pub signature: String,
|
||||
}
|
||||
|
||||
pub fn verify(bytes: &[u8], channel: &str, key: &str) -> Result<Pointer> {
|
||||
let envelope: Envelope = serde_json::from_slice(bytes).map_err(|e| Error::InvalidManifest(e.to_string()))?;
|
||||
crate::signing::verify(envelope.payload.as_bytes(), &envelope.signature, key)?;
|
||||
let pointer: Pointer = serde_json::from_str(&envelope.payload).map_err(|e| Error::InvalidManifest(e.to_string()))?;
|
||||
if pointer.schema != 1 || pointer.channel != channel
|
||||
|| pointer.release_tag != format!("server-{}", pointer.version)
|
||||
|| pointer.version.is_empty()
|
||||
|| !pointer.version.bytes().all(|b| b.is_ascii_digit() || b == b'.')
|
||||
|| pointer.snapshot.len() != 64
|
||||
|| !pointer.snapshot.bytes().all(|b| b.is_ascii_hexdigit()) {
|
||||
return Err(Error::InvalidManifest("Invalid channel pointer".into()));
|
||||
}
|
||||
Ok(pointer)
|
||||
}
|
||||
|
||||
pub fn resolve(channel: &str) -> Result<Source> {
|
||||
if channel != "stable" && channel != "edge" {
|
||||
return Err(Error::InvalidManifest("Unknown release channel".into()));
|
||||
}
|
||||
let source = Source::Url("https://raw.githubusercontent.com/Corfirean/coa-server-build/channels".into());
|
||||
let bytes = fetch_small(&source, &format!("{channel}.json"))?;
|
||||
let pointer = verify(&bytes, channel, crate::signing::EMBEDDED_PUBLIC_KEY)?;
|
||||
Ok(Source::Url(format!("https://github.com/Corfirean/coa-server-build/releases/download/{}", pointer.release_tag)))
|
||||
}
|
||||
|
||||
pub fn sign(pointer: &Pointer, seed: &str) -> Result<Vec<u8>> {
|
||||
use base64::{engine::general_purpose::STANDARD, Engine};
|
||||
use ed25519_dalek::{Signer, SigningKey};
|
||||
let seed: [u8; 32] = STANDARD.decode(seed.trim()).map_err(|_| Error::Invalid("Invalid signing key".into()))?
|
||||
.try_into().map_err(|_| Error::Invalid("Invalid signing key length".into()))?;
|
||||
let payload = serde_json::to_string(pointer).map_err(|e| Error::Invalid(e.to_string()))?;
|
||||
let signature = STANDARD.encode(SigningKey::from_bytes(&seed).sign(payload.as_bytes()).to_bytes());
|
||||
let bytes = serde_json::to_vec(&Envelope { payload, signature }).map_err(|e| Error::Invalid(e.to_string()))?;
|
||||
verify(&bytes, &pointer.channel, crate::signing::EMBEDDED_PUBLIC_KEY)?;
|
||||
Ok(bytes)
|
||||
}
|
||||
|
||||
#[cfg(test)]
|
||||
mod tests {
|
||||
use super::*;
|
||||
use base64::{engine::general_purpose::STANDARD, Engine};
|
||||
use ed25519_dalek::{Signer, SigningKey};
|
||||
|
||||
fn signed(pointer: &Pointer) -> (Vec<u8>, String) {
|
||||
let sk = SigningKey::from_bytes(&[17; 32]);
|
||||
let payload = serde_json::to_string(pointer).unwrap();
|
||||
let signature = STANDARD.encode(sk.sign(payload.as_bytes()).to_bytes());
|
||||
(serde_json::to_vec(&Envelope { payload, signature }).unwrap(), STANDARD.encode(sk.verifying_key().to_bytes()))
|
||||
}
|
||||
|
||||
#[test]
|
||||
fn verifies_identity_signature_and_immutable_tag() {
|
||||
let mut p = Pointer { schema: 1, channel: "stable".into(), version: "0.261010.40".into(), release_tag: "server-0.261010.40".into(), snapshot: "a".repeat(64) };
|
||||
let (bytes, key) = signed(&p);
|
||||
assert_eq!(verify(&bytes, "stable", &key).unwrap().version, p.version);
|
||||
assert!(verify(&bytes, "edge", &key).is_err());
|
||||
let mut changed: Envelope = serde_json::from_slice(&bytes).unwrap();
|
||||
changed.payload = changed.payload.replace("40", "41");
|
||||
assert!(verify(&serde_json::to_vec(&changed).unwrap(), "stable", &key).is_err());
|
||||
p.release_tag = "stable".into();
|
||||
let (bytes, key) = signed(&p);
|
||||
assert!(verify(&bytes, "stable", &key).is_err());
|
||||
}
|
||||
}
|
||||
@@ -10,7 +10,7 @@ use crate::backup;
|
||||
use crate::error::{Error, Result};
|
||||
use crate::fsx;
|
||||
use crate::migrations::{apply_pending, status, Status};
|
||||
use crate::release::{collect_bots_sql, collect_core_sql};
|
||||
use crate::release::{collect_bots_sql, collect_core_install_sql};
|
||||
|
||||
pub struct Params<'a> {
|
||||
pub repack: &'a Path,
|
||||
@@ -177,7 +177,7 @@ pub fn build(p: &Params, say: &dyn Fn(&str)) -> Result<()> {
|
||||
}
|
||||
fsx::atomic_write_json(&repack_json, &cfg)?;
|
||||
|
||||
let mut sql = collect_core_sql(p.core)?;
|
||||
let mut sql = collect_core_install_sql(p.core)?;
|
||||
if let Some(b) = p.bots {
|
||||
sql.extend(collect_bots_sql(b)?);
|
||||
}
|
||||
@@ -294,7 +294,7 @@ mod tests {
|
||||
|
||||
#[test]
|
||||
fn scaffolding_keeps_the_launcher_and_drops_runtime_state_and_live_data() {
|
||||
for keep in ["Runtime/python/python.exe", "Scripts/manage.py", "Settings/worldserver.conf.template", "mysql/bin/mysqld.exe", "mysql/share/english/errmsg.sys", "BugReport/relay.py", "Core/libssl-3-x64.dll", "README.txt"] {
|
||||
for keep in ["Runtime/python/python.exe", "Scripts/manage.py", "Settings/worldserver.conf.template", "mysql/bin/mysqld.exe", "mysql/share/english/errmsg.sys", "mysql/lib/private/icudt.dat", "BugReport/relay.py", "Core/libssl-3-x64.dll", "README.txt"] {
|
||||
assert!(scaffolding(keep), "{keep}");
|
||||
}
|
||||
for drop in [".state/world.json", "mysql/data/acore_world/x.ibd", "mysql/logs/error.log", "Core/worldserver.exe", "Core/Logs/Server.log", "BugReport/reports/a.json", "Source/server-source.zip", "Scripts/__pycache__/x.pyc", "Testing/notes.md", "mysql/data.7z"] {
|
||||
|
||||
@@ -206,6 +206,10 @@ pub fn drift(root: &Path) -> Result<Vec<String>> {
|
||||
}
|
||||
|
||||
pub fn load(root: &Path, scope: Scope) -> Result<SettingsView> {
|
||||
// A Docker server that was added but never started has no active world configuration yet; create it from its template.
|
||||
if scope == Scope::Server && crate::docker::is_docker(root) {
|
||||
let _ = crate::docker::ensure_main_configs(root);
|
||||
}
|
||||
let schema = scope.schema();
|
||||
let t = targets(root, scope)?;
|
||||
let conf = load_conf(&t.read)?;
|
||||
@@ -213,9 +217,12 @@ pub fn load(root: &Path, scope: Scope) -> Result<SettingsView> {
|
||||
let known: BTreeSet<&str> = schema.settings.iter().map(|s| s.key.as_str()).collect();
|
||||
let unknown_keys = conf.entries().filter(|(k, _)| !known.contains(k)).count();
|
||||
|
||||
// On a Docker server some settings are fixed by the backend (environment beats the file): not offered.
|
||||
let docker = scope == Scope::Server && crate::docker::is_docker(root);
|
||||
let settings = schema
|
||||
.settings
|
||||
.iter()
|
||||
.filter(|s| !(docker && crate::docker::managed_setting(&s.key)))
|
||||
.map(|s| {
|
||||
let raw = conf.get(&s.key);
|
||||
let (value, problem) = match raw {
|
||||
@@ -286,11 +293,19 @@ pub fn validate(root: &Path, scope: Scope, changes: &BTreeMap<String, Value>) ->
|
||||
let schema = scope.schema();
|
||||
let mut errors = Vec::new();
|
||||
let mut raws = BTreeMap::new();
|
||||
let docker = scope == Scope::Server && crate::docker::is_docker(root);
|
||||
for (key, value) in changes {
|
||||
match schema.get(key) {
|
||||
None => errors.push(FieldError { key: key.clone(), message: "is not a setting the Manager can change".into() }),
|
||||
Some(_) if docker && crate::docker::managed_setting(key) => {
|
||||
errors.push(FieldError { key: key.clone(), message: "is set by the Docker backend; changing it in the file would have no effect".into() })
|
||||
}
|
||||
Some(s) => match s.to_raw(value) {
|
||||
Ok(raw) => {
|
||||
if let Some(problem) = crate::docker::setting_problem(key, &raw).filter(|_| crate::docker::is_docker(root)) {
|
||||
errors.push(FieldError { key: key.clone(), message: problem.into() });
|
||||
continue;
|
||||
}
|
||||
raws.insert(key.clone(), raw);
|
||||
}
|
||||
Err(m) => errors.push(FieldError { key: key.clone(), message: m }),
|
||||
@@ -736,6 +751,26 @@ Spellbook.New = 5
|
||||
assert!(list_snapshots(&meta).is_empty(), "no snapshot for a rejected save");
|
||||
}
|
||||
|
||||
#[test]
|
||||
fn a_docker_server_is_not_offered_the_settings_its_backend_fixes() {
|
||||
let (_d, root, meta) = fixture();
|
||||
let keys = |root: &Path| load(root, Scope::Server).unwrap().settings.into_iter().map(|s| s.meta.key).collect::<Vec<_>>();
|
||||
for k in ["Ra.Enable", "Ra.IP", "Updates.EnableDatabases", "PlayerLimit"] {
|
||||
assert!(keys(&root).iter().any(|x| x == k), "a repack offers {k}");
|
||||
}
|
||||
fs::write(root.join("Settings/docker.json"), br#"{"project":"t1"}"#).unwrap();
|
||||
let docker = keys(&root);
|
||||
for k in ["Ra.Enable", "Ra.IP", "Updates.EnableDatabases"] {
|
||||
assert!(!docker.iter().any(|x| x == k), "a Docker server does not offer {k}: the containers' environment beats the file");
|
||||
}
|
||||
assert!(docker.iter().any(|x| x == "PlayerLimit"), "everything else is still offered");
|
||||
// Forcing a change through is refused and says why, instead of being saved and ignored.
|
||||
let err = save(&root, &meta, Scope::Server, &set(&[("Ra.Enable", json!(0))])).unwrap_err().to_string();
|
||||
assert!(err.contains("Docker backend"), "{err}");
|
||||
assert!(!fs::read_to_string(root.join("Core/configs/worldserver.conf")).unwrap().contains("Ra.Enable = 0"));
|
||||
save(&root, &meta, Scope::Server, &set(&[("PlayerLimit", json!(77))])).unwrap();
|
||||
}
|
||||
|
||||
#[test]
|
||||
fn missing_key_is_appended_and_noop_saves_do_nothing() {
|
||||
let (_d, root, meta) = fixture();
|
||||
|
||||
@@ -51,6 +51,19 @@ fn classify(l: &str) -> Level {
|
||||
}
|
||||
}
|
||||
|
||||
/// The last `max_lines` lines of some text (after filtering), classified and redacted like the lines of a log file.
|
||||
pub fn lines_from_text(text: &str, filter: Option<&str>, max_lines: usize) -> Vec<Line> {
|
||||
let needle = filter.map(str::to_lowercase).filter(|n| !n.is_empty());
|
||||
let out: Vec<Line> = text
|
||||
.lines()
|
||||
.filter(|l| !l.trim().is_empty())
|
||||
.filter(|l| needle.as_ref().map(|n| l.to_lowercase().contains(n)).unwrap_or(true))
|
||||
.map(|l| Line { level: classify(l), text: crate::diag::redact(l) })
|
||||
.collect();
|
||||
let skip = out.len().saturating_sub(max_lines);
|
||||
out.into_iter().skip(skip).collect()
|
||||
}
|
||||
|
||||
/// The last `max_lines` lines (after filtering) from the last ~512 KB of a log. Works on multi-gigabyte files.
|
||||
pub fn tail(path: &Path, filter: Option<&str>, max_lines: usize) -> Result<Vec<Line>> {
|
||||
const WINDOW: u64 = 512 * 1024;
|
||||
|
||||
@@ -54,6 +54,85 @@ pub const RACE_MPQS: &[&str] = &[
|
||||
"patch-ZZR.MPQ",
|
||||
];
|
||||
|
||||
pub const EXCLUDED_BOT_RACES_RECOMMENDED: &str =
|
||||
"19,27,32,33,34,35,36,37,38,39,40,41,42,43,44,45,46,47,48,49,50,51,52,53,54,55,56,57,58,59,60,61,62,63,64,65,66,67,68,69,70,71,72,73,74,75,76,77,78,79,80,81,82,83,84,85,86,87,88,89,90,91,92,93,94,95,96,97,98,99,100,101,102,103,104,105,106,107,108,109,110,111,112,113,114,115,116,117,118,119,120,121,122,123,124,125,126,127,128";
|
||||
|
||||
pub const EXCLUDED_BOT_RACES_EXPERIMENTAL: &str =
|
||||
"16,19,27,32,50,52,53,65,66,67,68,69,70,71,72,74,77,80,81";
|
||||
|
||||
/// Finds all active playerbots.conf files on this server (root, coa-bots folder, and secondary realm).
|
||||
pub fn playerbots_conf_paths(root: &Path) -> Vec<PathBuf> {
|
||||
let mut paths = Vec::new();
|
||||
let candidates = [
|
||||
root.join("Core/configs/modules/playerbots.conf"),
|
||||
root.join("coa-bots/Core/configs/modules/playerbots.conf"),
|
||||
root.join("coa-bots/core/configs/modules/playerbots.conf"),
|
||||
crate::multiworld::root(root).join("Core/configs/modules/playerbots.conf"),
|
||||
];
|
||||
for path in candidates {
|
||||
if path.is_file() {
|
||||
paths.push(path);
|
||||
}
|
||||
}
|
||||
if paths.is_empty() {
|
||||
for dist in [
|
||||
root.join("Core/configs/modules/playerbots.conf.dist"),
|
||||
root.join("coa-bots/Core/configs/modules/playerbots.conf.dist"),
|
||||
] {
|
||||
if dist.is_file() {
|
||||
let target = dist.with_extension("");
|
||||
if fs::copy(&dist, &target).is_ok() {
|
||||
paths.push(target);
|
||||
break;
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
paths
|
||||
}
|
||||
|
||||
/// Checks whether playerbots are configured to allow custom races.
|
||||
/// Returns true if AiPlayerbot.ExcludedBotRaces exists and does not exclude general custom races.
|
||||
pub fn is_bot_custom_races_allowed(root: &Path) -> Option<bool> {
|
||||
for path in playerbots_conf_paths(root) {
|
||||
if let Ok(bytes) = fs::read(&path) {
|
||||
if let Ok(conf) = crate::config::parser::ConfFile::parse_bytes(&bytes) {
|
||||
if let Some(val) = conf.get("AiPlayerbot.ExcludedBotRaces") {
|
||||
let clean = val.trim().trim_matches(['"', '\'']);
|
||||
return Some(!clean.contains("33") && !clean.contains("128"));
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
None
|
||||
}
|
||||
|
||||
/// Sets AiPlayerbot.ExcludedBotRaces in all discovered playerbots.conf files.
|
||||
pub fn sync_bot_races_config(root: &Path, allow_custom_races: bool) -> Result<()> {
|
||||
let excluded = if allow_custom_races {
|
||||
EXCLUDED_BOT_RACES_EXPERIMENTAL
|
||||
} else {
|
||||
EXCLUDED_BOT_RACES_RECOMMENDED
|
||||
};
|
||||
for path in playerbots_conf_paths(root) {
|
||||
if let Ok(bytes) = fs::read(&path) {
|
||||
if let Ok(mut conf) = crate::config::parser::ConfFile::parse_bytes(&bytes) {
|
||||
conf.set(
|
||||
"AiPlayerbot.ExcludedBotRaces",
|
||||
&format!("\"{excluded}\""),
|
||||
&[
|
||||
"CoA Custom: races new random bots never get",
|
||||
"Off (recommended): excludes all added races",
|
||||
"On (experimental): allows stable added races",
|
||||
],
|
||||
);
|
||||
fsx::atomic_write(&path, conf.to_text().as_bytes())?;
|
||||
}
|
||||
}
|
||||
}
|
||||
Ok(())
|
||||
}
|
||||
|
||||
#[derive(Debug, Clone, Copy, PartialEq, Eq, Serialize, Deserialize)]
|
||||
#[serde(rename_all = "kebab-case")]
|
||||
pub enum ClientPatchState {
|
||||
|
||||
@@ -247,6 +247,13 @@ impl Db {
|
||||
self.query(&sql)?.trim().parse().map_err(|_| Error::Invalid("unexpected reply".into()))
|
||||
}
|
||||
|
||||
pub fn recovery_objects(&self, schema: &str) -> Result<Vec<serde_json::Value>> {
|
||||
let schema = self.realm_schema(schema);
|
||||
if !ident_ok(schema) { return Err(Error::Invalid("bad schema name".into())); }
|
||||
let sql = format!("SELECT routine_type,HEX(routine_name) FROM information_schema.routines WHERE routine_schema='{schema}' UNION ALL SELECT 'TRIGGER',HEX(trigger_name) FROM information_schema.triggers WHERE trigger_schema='{schema}' UNION ALL SELECT 'VIEW',HEX(table_name) FROM information_schema.views WHERE table_schema='{schema}' ORDER BY 1,2;");
|
||||
parse_recovery_objects(&schema, &self.query(&sql)?)
|
||||
}
|
||||
|
||||
/// Consistent dump of one schema, zstd-compressed to `out`. Returns (compressed bytes, sha256 of the file).
|
||||
pub fn dump_to(&self, schema: &str, out: &Path) -> Result<(u64, String)> {
|
||||
let schema = self.realm_schema(schema);
|
||||
@@ -334,6 +341,18 @@ impl Db {
|
||||
}
|
||||
}
|
||||
|
||||
fn parse_recovery_objects(schema: &str, text: &str) -> Result<Vec<serde_json::Value>> {
|
||||
text.lines().filter(|line| !line.is_empty()).map(|line| {
|
||||
let (kind, name) = line.split_once('\t').ok_or_else(|| Error::Invalid("unexpected database object reply".into()))?;
|
||||
if !matches!(kind, "PROCEDURE" | "FUNCTION" | "TRIGGER" | "VIEW") {
|
||||
return Err(Error::Invalid("unexpected database object type".into()));
|
||||
}
|
||||
let name = hex::decode(name).ok().and_then(|bytes| String::from_utf8(bytes).ok())
|
||||
.filter(|name| !name.is_empty()).ok_or_else(|| Error::Invalid("unexpected database object name".into()))?;
|
||||
Ok(serde_json::json!({ "database": schema, "kind": kind, "name": name }))
|
||||
}).collect()
|
||||
}
|
||||
|
||||
/// Name of the service account the Manager uses for the server console (RA). Accounts are stored upper-case.
|
||||
pub const SERVICE_ACCOUNT: &str = "COAMANAGER";
|
||||
|
||||
@@ -421,6 +440,19 @@ mod tests {
|
||||
const ROOT_PW: &str = "rootpw-ZZ1";
|
||||
const APP_PW: &str = "apppw-QQ2";
|
||||
|
||||
#[test]
|
||||
fn recovery_object_names_preserve_unicode_and_delimiters() {
|
||||
let name = "view\tперсонажи\n";
|
||||
let text = format!("VIEW\t{}\nTRIGGER\t74726967676572\n", hex::encode(name));
|
||||
let objects = parse_recovery_objects("acore_characters", &text).unwrap();
|
||||
assert_eq!(objects.len(), 2);
|
||||
assert_eq!(objects[0]["name"], name);
|
||||
assert_eq!(objects[1]["kind"], "TRIGGER");
|
||||
assert!(parse_recovery_objects("test", "VIEW\tzz").is_err());
|
||||
assert!(parse_recovery_objects("test", "UNKNOWN\t61").is_err());
|
||||
assert!(parse_recovery_objects("test", "VIEW").is_err());
|
||||
}
|
||||
|
||||
fn folder(docker: bool) -> (tempfile::TempDir, PathBuf) {
|
||||
let d = tempfile::tempdir().unwrap();
|
||||
let root = d.path().join("srv");
|
||||
|
||||
@@ -109,7 +109,8 @@ pub fn run(root: &Path, meta: &InstallMeta) -> Report {
|
||||
c.push(if crate::client::detect(Path::new(path), None).is_some() { check("client", "Game client", Level::Ok, path.clone()) } else { check("client", "Game client", Level::Warn, "The saved game folder was not found; choose it again in Settings.") });
|
||||
}
|
||||
|
||||
let exposed: Vec<&str> = crate::net::exposure(&ports).iter().filter(|e| (e.what == "database" || e.what == "server console") && e.reachable_from_network).map(|e| e.what).collect();
|
||||
let exposure = if crate::docker::is_docker(root) { crate::docker::exposure(root, &ports) } else { crate::net::exposure(&ports) };
|
||||
let exposed: Vec<&str> = exposure.iter().filter(|e| (e.what == "database" || e.what == "server console") && e.reachable_from_network).map(|e| e.what).collect();
|
||||
c.push(if exposed.is_empty() { check("exposure", "Private services", Level::Ok, "Database and server console are not reachable from the network.") } else { check("exposure", "Private services", Level::Fail, format!("Reachable from the network: {}.", exposed.join(", "))) });
|
||||
|
||||
let problems = c.iter().filter(|x| x.level != Level::Ok).count();
|
||||
@@ -401,6 +402,19 @@ pub fn export_package(root: &Path, meta_dir: &Path, manager_log: &Path, meta: &I
|
||||
add("processes.txt", processes_report(root, &ports).as_bytes())?;
|
||||
|
||||
// The newest update journals: the state of each update and the reason it failed.
|
||||
for (path, size, _) in newest_files(&meta_dir.join("diagnostics"), "json", usize::MAX)
|
||||
.into_iter().filter(|(path, _, _)| path.file_name().is_some_and(|name| {
|
||||
let name = name.to_string_lossy();
|
||||
name.starts_with("schema-validation-") || name.starts_with("database-recovery-")
|
||||
|| name.starts_with("database-rehearsal-") || name.starts_with("database-restore-")
|
||||
|| name.starts_with("database-repair-")
|
||||
})).take(10) {
|
||||
if size <= 4 * 1024 * 1024 {
|
||||
if let Ok(text) = fs::read_to_string(&path) {
|
||||
add(&format!("schema/{}", path.file_name().unwrap().to_string_lossy()), redact_json(&text).as_bytes())?;
|
||||
}
|
||||
}
|
||||
}
|
||||
let mut journals: Vec<_> = fs::read_dir(meta_dir.join("updates")).into_iter().flatten().flatten()
|
||||
.filter(|e| e.file_type().is_ok_and(|t| t.is_dir()) && e.file_name().to_string_lossy().chars().all(|c| c.is_ascii_alphanumeric() || matches!(c, '-' | '_')))
|
||||
.collect();
|
||||
@@ -451,16 +465,53 @@ pub fn stamp() -> String {
|
||||
chrono::Local::now().format("%Y%m%d-%H%M%S").to_string()
|
||||
}
|
||||
|
||||
#[cfg(windows)]
|
||||
pub fn desktop_or_temp() -> PathBuf {
|
||||
let d = std::env::var_os("USERPROFILE").map(PathBuf::from).unwrap_or_else(std::env::temp_dir).join("Desktop");
|
||||
if d.is_dir() { d } else { std::env::temp_dir() }
|
||||
}
|
||||
|
||||
/// Where a file meant for the person goes on Linux: the desktop folder they have (the XDG user directories file names it), else
|
||||
/// `~/Desktop`, else `~/Downloads`, else the temporary folder.
|
||||
#[cfg(not(windows))]
|
||||
pub fn desktop_or_temp() -> PathBuf {
|
||||
let Some(home) = std::env::var_os("HOME").map(PathBuf::from) else { return std::env::temp_dir() };
|
||||
let dirs = std::fs::read_to_string(home.join(".config/user-dirs.dirs")).ok();
|
||||
pick_desktop(&home, dirs.as_deref(), &|p| p.is_dir())
|
||||
}
|
||||
|
||||
#[cfg(not(windows))]
|
||||
fn pick_desktop(home: &Path, user_dirs: Option<&str>, exists: &dyn Fn(&Path) -> bool) -> PathBuf {
|
||||
let named = user_dirs.and_then(|t| {
|
||||
t.lines().find_map(|l| {
|
||||
let v = l.trim().strip_prefix("XDG_DESKTOP_DIR=")?.trim_matches('"');
|
||||
Some(PathBuf::from(v.replace("$HOME", &home.to_string_lossy())))
|
||||
})
|
||||
});
|
||||
// A user without a desktop sets XDG_DESKTOP_DIR to the home folder itself: that is not a place to drop files into.
|
||||
[named, Some(home.join("Desktop")), Some(home.join("Downloads"))].into_iter().flatten().filter(|p| p != home).find(|p| exists(p)).unwrap_or_else(std::env::temp_dir)
|
||||
}
|
||||
|
||||
#[cfg(test)]
|
||||
mod tests {
|
||||
use super::*;
|
||||
use crate::registry::{InstallKind, InstallMeta};
|
||||
|
||||
#[cfg(not(windows))]
|
||||
#[test]
|
||||
fn the_desktop_folder_on_linux_follows_the_users_own_directories() {
|
||||
let home = Path::new("/home/ana");
|
||||
let only = |wanted: &'static [&'static str]| move |p: &Path| wanted.contains(&p.to_str().unwrap());
|
||||
let dirs = "# comment\nXDG_DOWNLOAD_DIR=\"$HOME/Downloads\"\nXDG_DESKTOP_DIR=\"$HOME/Bureau\"\n";
|
||||
assert_eq!(pick_desktop(home, Some(dirs), &only(&["/home/ana/Bureau", "/home/ana/Desktop"])), PathBuf::from("/home/ana/Bureau"));
|
||||
assert_eq!(pick_desktop(home, None, &only(&["/home/ana/Desktop"])), PathBuf::from("/home/ana/Desktop"));
|
||||
assert_eq!(pick_desktop(home, Some(dirs), &only(&["/home/ana/Downloads"])), PathBuf::from("/home/ana/Downloads"));
|
||||
assert_eq!(pick_desktop(home, None, &only(&[])), std::env::temp_dir());
|
||||
// No desktop: the user directories file names the home folder itself.
|
||||
let none = "XDG_DESKTOP_DIR=\"$HOME/\"\n";
|
||||
assert_eq!(pick_desktop(home, Some(none), &only(&["/home/ana", "/home/ana/Downloads"])), PathBuf::from("/home/ana/Downloads"));
|
||||
}
|
||||
|
||||
#[test]
|
||||
fn repeated_config_warnings_are_folded() {
|
||||
let t = "start
|
||||
@@ -586,6 +637,9 @@ real error
|
||||
fs::write(root.join("Core/configs/worldserver.conf"), "LoginDatabaseInfo = \"127.0.0.1;3307;acore;SECRETPW;auth\"\nRate.XP.Kill = 1\n").unwrap();
|
||||
let meta_dir = d.path().join("srv.manager");
|
||||
fs::create_dir_all(&meta_dir).unwrap();
|
||||
fs::create_dir_all(meta_dir.join("diagnostics")).unwrap();
|
||||
fs::write(meta_dir.join("diagnostics/schema-validation-CoA-test.json"), r#"{"problems":[{"table":"creature_display_preset","column":"display_id","detail":"default mismatch"}],"password":"schema-secret"}"#).unwrap();
|
||||
fs::write(meta_dir.join("diagnostics/database-recovery-test.json"), r#"{"objects":[{"database":"acore_characters","kind":"TRIGGER","name":"user_character_trigger"}],"password":"recovery-secret"}"#).unwrap();
|
||||
let meta = InstallMeta::new(InstallKind::Imported, &root);
|
||||
let report = run(&root, &meta);
|
||||
let zip_path = d.path().join("diag.zip");
|
||||
@@ -600,6 +654,10 @@ real error
|
||||
}
|
||||
assert!(all.contains("boom") && all.contains("Rate.XP.Kill"), "keys and ordinary log lines are included");
|
||||
assert!(all.contains("v1.8") && all.contains("48c4786a"));
|
||||
assert!(all.contains("creature_display_preset") && all.contains("default mismatch"));
|
||||
assert!(!all.contains("schema-secret"));
|
||||
assert!(all.contains("user_character_trigger") && all.contains("acore_characters"));
|
||||
assert!(!all.contains("recovery-secret"));
|
||||
assert!(!all.contains("hunter2") && !all.contains("SECRETPW") && !all.contains("upstream-secret"));
|
||||
}
|
||||
}
|
||||
@@ -112,7 +112,7 @@ pub fn preflight(dest: &Path, data_dir: &Path, needed_bytes: u64, registry: &Reg
|
||||
Preflight { ok: problems.is_empty(), problems, free_bytes }
|
||||
}
|
||||
|
||||
fn data_problems(data_dir: &Path) -> Vec<crate::install::Problem> {
|
||||
pub(crate) fn data_problems(data_dir: &Path) -> Vec<crate::install::Problem> {
|
||||
let s = data_dir.to_string_lossy();
|
||||
if !data_dir.is_absolute() || s.contains(':') {
|
||||
return vec![problem("data_path", "Choose the game data folder with its full path, without a colon in it.")];
|
||||
|
||||
@@ -242,6 +242,10 @@ fn start(d: &dyn Docker, root: &Path, cfg: &Config, with_game: bool, log: &mut L
|
||||
run_container(d, &call, &n.world, log)?;
|
||||
}
|
||||
wait_listening(d, cfg, &n.world, ports.world, WORLD_WAIT, log)?;
|
||||
// The core leaves with code 2 for `server restart` and expects a supervisor to start it again (the repack has one). Docker
|
||||
// does that for any non-zero exit, but only once the server has come up: a start that fails must stay failed, not loop.
|
||||
// A stop by `docker stop` or `server shutdown` (code 0) is never restarted.
|
||||
let _ = docker(d, &["update", "--restart", "on-failure:3", &n.world], QUICK);
|
||||
|
||||
if !state.get(&n.auth).is_some_and(Container::running) {
|
||||
remove(d, &n.auth);
|
||||
@@ -251,9 +255,26 @@ fn start(d: &dyn Docker, root: &Path, cfg: &Config, with_game: bool, log: &mut L
|
||||
run_container(d, &call, &n.auth, log)?;
|
||||
}
|
||||
wait_listening(d, cfg, &n.auth, ports.auth, AUTH_WAIT, log)?;
|
||||
mark_realm_online(d, &n, &secrets, realm, log);
|
||||
Ok(())
|
||||
}
|
||||
|
||||
/// The auth server marks every realm offline when it starts, and the world server (already up, see the order above) only
|
||||
/// puts itself back after its next uptime update, ten minutes later by default: until then the client shows "Realm is
|
||||
/// Offline". The world is known to be listening here, so say so for the realm it serves. The other realm of a Wildcard
|
||||
/// install keeps the offline flag it is given on purpose (`realms::setup_realmlist`).
|
||||
fn mark_realm_online(d: &dyn Docker, n: &Names, secrets: &Secrets, realm: crate::realms::Mode, log: &mut Log) {
|
||||
let sql = format!("UPDATE acore_auth.realmlist SET flag = flag & ~2 WHERE id = {};", realm.realm_id());
|
||||
let mut call = Call::new(&["exec", "-i", "-e", "MYSQL_PWD", &n.db, "mysql", "--user=root", "--protocol=tcp", "--host=127.0.0.1"], QUICK);
|
||||
call.env = vec![("MYSQL_PWD".into(), secrets.root.clone())];
|
||||
call.stdin = Some(sql.as_bytes());
|
||||
match d.run(&call) {
|
||||
Ok(o) if o.ok() => {}
|
||||
Ok(o) => log.say(format!("the realm could not be marked online: {}", o.text().trim())),
|
||||
Err(e) => log.say(format!("the realm could not be marked online: {e}")),
|
||||
}
|
||||
}
|
||||
|
||||
fn remove(d: &dyn Docker, name: &str) {
|
||||
// A stopped container of the same name is replaced, so its settings always match the files on disk.
|
||||
let _ = d.run(&Call::new(&["rm", "-f", name], QUICK));
|
||||
@@ -388,6 +409,21 @@ fn database_env(s: &Secrets, world: bool, realm: crate::realms::Mode) -> Vec<(St
|
||||
env
|
||||
}
|
||||
|
||||
/// Every setting variable (`AC_...`) the containers get, for the check that the screens know which settings are fixed.
|
||||
#[cfg(test)]
|
||||
pub(crate) fn forced_variables() -> Vec<String> {
|
||||
let cfg = Config { project: "t".into(), bind_address: "127.0.0.1".into(), mysql_image: "mysql:8.4".into(), data_dir: None, mysql_data: None };
|
||||
let n = cfg.names();
|
||||
let mut found = Vec::new();
|
||||
for kind in [GameKind::World, GameKind::Auth] {
|
||||
let args = game_args(&cfg, &n, kind, Path::new("/s"), Path::new("/d"), 1, 2, None);
|
||||
found.extend(args.iter().filter_map(|a| a.strip_prefix("AC_").map(|rest| format!("AC_{}", rest.split('=').next().unwrap()))));
|
||||
}
|
||||
found.sort();
|
||||
found.dedup();
|
||||
found
|
||||
}
|
||||
|
||||
/// Realm profiles are only in play once a profile has been chosen on this server (`Settings/realm-profile.json`).
|
||||
fn prepare_realm(root: &Path, log: &mut Log) -> Step<crate::realms::Mode> {
|
||||
let fail_with = |e: crate::error::Error| Failure { code: ErrorCode::StartupFailed, output: e.to_string() };
|
||||
@@ -670,6 +706,8 @@ mod tests {
|
||||
}
|
||||
out(0, "containerid\n", "")
|
||||
}
|
||||
["update", "--restart", _, _] => out(0, "", ""),
|
||||
["exec", ..] => out(0, "", ""),
|
||||
["stop", "--time", _, name] => {
|
||||
self.running.borrow_mut().remove(*name);
|
||||
self.exited.borrow_mut().insert(name.to_string(), (0, false));
|
||||
@@ -712,6 +750,10 @@ mod tests {
|
||||
assert!(at("network create") < at("run --detach"), "database comes first");
|
||||
let runs: Vec<String> = sim.calls_of("run").iter().map(|c| c.args[c.args.iter().position(|x| x == "--name").unwrap() + 1].clone()).collect();
|
||||
assert_eq!(runs, ["coa-t1-db", "coa-t1-world", "coa-t1-auth"], "database, then world, then auth");
|
||||
let exec = sim.calls_of("exec");
|
||||
assert_eq!(exec.len(), 1, "the realm is marked online once the auth server is up");
|
||||
assert!(exec[0].stdin && exec[0].env == [("MYSQL_PWD".to_string(), ROOT_PW.to_string())]);
|
||||
assert!(!exec[0].args.iter().any(|a| a.contains(ROOT_PW)), "the password is not on the command line");
|
||||
assert!(at("build") < verbs.iter().rposition(|v| v.starts_with("run")).unwrap(), "the runtime image exists before the game servers");
|
||||
assert!(sim.calls_of("build")[0].stdin, "the Dockerfile travels on stdin");
|
||||
}
|
||||
@@ -757,6 +799,21 @@ mod tests {
|
||||
assert!(!plain.iter().any(|a| a == "--lower-case-table-names=1" || a == "--user"));
|
||||
}
|
||||
|
||||
#[test]
|
||||
fn the_world_server_is_started_again_when_it_restarts_itself_but_only_once_it_is_up() {
|
||||
let (_d, root) = server("t1");
|
||||
let sim = Sim::new();
|
||||
assert!(start_all(&sim, &root).ok);
|
||||
let world_run = sim.calls_of("run").into_iter().find(|c| c.args.iter().any(|a| a == "coa-t1-world")).unwrap();
|
||||
assert!(!world_run.args.iter().any(|a| a == "--restart"), "no restart while it is still starting");
|
||||
let updates = sim.calls_of("update");
|
||||
assert_eq!(updates.len(), 1);
|
||||
assert_eq!(updates[0].args, ["update", "--restart", "on-failure:3", "coa-t1-world"]);
|
||||
let verbs = sim.verbs();
|
||||
let pos = |p: &str| verbs.iter().position(|v| v.starts_with(p)).unwrap();
|
||||
assert!(pos("run --detach") < pos("update"), "after the container exists and listens");
|
||||
}
|
||||
|
||||
#[test]
|
||||
fn the_containers_use_the_databases_of_the_selected_realm() {
|
||||
let s = Secrets { root: "r".into(), app: "apppw".into() };
|
||||
|
||||
@@ -0,0 +1,72 @@
|
||||
//! The database of a Docker server has no log file in the server folder: MySQL writes to its container's output.
|
||||
|
||||
use super::cli::{Call, Docker, SystemDocker};
|
||||
use super::Config;
|
||||
use crate::console::Line;
|
||||
use crate::error::{Error, Result};
|
||||
use std::path::Path;
|
||||
use std::time::Duration;
|
||||
|
||||
/// The last lines MySQL wrote (what `docker logs` returns), filtered and classified like the lines of a log file.
|
||||
pub fn database_log(root: &Path, filter: Option<&str>, max_lines: usize) -> Result<Vec<Line>> {
|
||||
database_log_with(&SystemDocker, root, filter, max_lines)
|
||||
}
|
||||
|
||||
pub fn database_log_with(d: &dyn Docker, root: &Path, filter: Option<&str>, max_lines: usize) -> Result<Vec<Line>> {
|
||||
let name = Config::load(root)?.names().db;
|
||||
// Ask for more than wanted: the filter may drop most of them.
|
||||
let tail = (max_lines * 4).clamp(200, 8000).to_string();
|
||||
let out = d.run(&Call::new(&["logs", "--tail", &tail, &name], Duration::from_secs(20)))?;
|
||||
if !out.ok() {
|
||||
return Err(Error::Invalid("This log does not exist yet.".into()));
|
||||
}
|
||||
// MySQL writes to the error stream.
|
||||
Ok(crate::console::lines_from_text(&format!("{}\n{}", out.stderr, out.stdout), filter, max_lines))
|
||||
}
|
||||
|
||||
#[cfg(test)]
|
||||
mod tests {
|
||||
use super::*;
|
||||
use crate::docker::cli::Output;
|
||||
use std::cell::RefCell;
|
||||
|
||||
struct Fake {
|
||||
out: Output,
|
||||
calls: RefCell<Vec<Vec<String>>>,
|
||||
}
|
||||
|
||||
impl Docker for Fake {
|
||||
fn run(&self, call: &Call) -> Result<Output> {
|
||||
self.calls.borrow_mut().push(call.args.clone());
|
||||
Ok(self.out.clone())
|
||||
}
|
||||
}
|
||||
|
||||
fn root() -> (tempfile::TempDir, std::path::PathBuf) {
|
||||
let d = tempfile::tempdir().unwrap();
|
||||
let root = d.path().join("srv");
|
||||
std::fs::create_dir_all(root.join("Settings")).unwrap();
|
||||
std::fs::write(root.join("Settings/docker.json"), r#"{"project":"t1"}"#).unwrap();
|
||||
(d, root)
|
||||
}
|
||||
|
||||
#[test]
|
||||
fn the_database_log_is_what_the_container_printed() {
|
||||
let (_d, root) = root();
|
||||
let fake = Fake { out: Output { code: Some(0), stdout: "2026-10-04T10:00:00Z [System] ready\n".into(), stderr: "2026-10-04T10:00:01Z [ERROR] [MY-010] boom\n2026-10-04T10:00:02Z [Warning] slow\n".into() }, calls: Default::default() };
|
||||
let lines = database_log_with(&fake, &root, None, 100).unwrap();
|
||||
assert_eq!(fake.calls.borrow()[0][..2], ["logs", "--tail"]);
|
||||
assert_eq!(fake.calls.borrow()[0].last().unwrap(), "coa-t1-db");
|
||||
assert_eq!(lines.len(), 3);
|
||||
assert!(lines.iter().any(|l| l.text.contains("boom") && l.level == crate::console::Level::Error));
|
||||
let only = database_log_with(&fake, &root, Some("slow"), 100).unwrap();
|
||||
assert_eq!(only.len(), 1);
|
||||
}
|
||||
|
||||
#[test]
|
||||
fn a_database_that_never_ran_has_no_log_yet() {
|
||||
let (_d, root) = root();
|
||||
let fake = Fake { out: Output { code: Some(1), stdout: String::new(), stderr: "Error: No such container: coa-t1-db".into() }, calls: Default::default() };
|
||||
assert!(database_log_with(&fake, &root, None, 10).unwrap_err().to_string().contains("does not exist yet"));
|
||||
}
|
||||
}
|
||||
@@ -18,9 +18,12 @@ mod cli;
|
||||
pub mod fixture;
|
||||
pub mod install;
|
||||
mod lifecycle;
|
||||
pub mod logs;
|
||||
pub mod sharing;
|
||||
|
||||
pub use cli::{Call, Docker, Output, SystemDocker};
|
||||
pub use lifecycle::{check_docker, observe, observe_with, run, run_with};
|
||||
pub use sharing::{bind_is_open, exposure, set_open};
|
||||
pub(crate) use lifecycle::destroy;
|
||||
|
||||
use std::net::IpAddr;
|
||||
@@ -140,6 +143,84 @@ pub fn ensure_main_configs(root: &Path) -> Result<Vec<String>> {
|
||||
Ok(created)
|
||||
}
|
||||
|
||||
/// Settings the Docker backend gives the containers as environment variables. The core reads `AC_<KEY>` before the
|
||||
/// configuration file, so a value written to the file for one of these keys is silently ignored. They are what makes the
|
||||
/// containers work (where things are inside them, listening on every interface, the console, no built-in database
|
||||
/// updater, the databases); the owner has no use for them and the screens do not offer them.
|
||||
pub(crate) const FORCED_KEYS: [&str; 12] = [
|
||||
"BindIP",
|
||||
"WorldServerPort",
|
||||
"RealmServerPort",
|
||||
"LogsDir",
|
||||
"DataDir",
|
||||
"Updates.EnableDatabases",
|
||||
"Ra.Enable",
|
||||
"Ra.IP",
|
||||
"Ra.Port",
|
||||
"LoginDatabaseInfo",
|
||||
"WorldDatabaseInfo",
|
||||
"CharacterDatabaseInfo",
|
||||
];
|
||||
|
||||
/// Is this setting fixed by the Docker backend (see `FORCED_KEYS`)?
|
||||
pub fn managed_setting(key: &str) -> bool {
|
||||
FORCED_KEYS.iter().any(|k| k.eq_ignore_ascii_case(key))
|
||||
}
|
||||
|
||||
/// The environment variable the core reads for a setting: `AC_` and the key in upper snake case, a `_` between a lower-case
|
||||
/// letter and a capital, and at letter / digit boundaries (the core's `IniKeyToEnvVarKey`).
|
||||
#[cfg(test)]
|
||||
pub(crate) fn env_name(key: &str) -> String {
|
||||
let chars: Vec<char> = key.chars().collect();
|
||||
let mut out = String::from("AC_");
|
||||
for (i, &c) in chars.iter().enumerate() {
|
||||
if matches!(c, ' ' | '.' | '-') {
|
||||
out.push('_');
|
||||
continue;
|
||||
}
|
||||
out.push(c.to_ascii_uppercase());
|
||||
if let Some(&next) = chars.get(i + 1) {
|
||||
let split = (!c.is_ascii_uppercase() && next.is_ascii_uppercase()) || (!c.is_ascii_digit() && next.is_ascii_digit()) || (c.is_ascii_digit() && !next.is_ascii_digit() && !matches!(next, ' ' | '.' | '-'));
|
||||
if split {
|
||||
out.push('_');
|
||||
}
|
||||
}
|
||||
}
|
||||
out
|
||||
}
|
||||
|
||||
/// The folder mounted as the game data of this Docker server.
|
||||
pub fn game_data_dir(root: &Path) -> Result<std::path::PathBuf> {
|
||||
Ok(Config::load(root)?.data_path(root))
|
||||
}
|
||||
|
||||
/// Point a Docker server at another game data folder (used in place, read-only). The containers are recreated at the next
|
||||
/// start, so the servers must be stopped: a running one keeps the folder it has.
|
||||
pub fn set_game_data(root: &Path, path: &Path) -> Result<()> {
|
||||
let problems = install::data_problems(path);
|
||||
if !problems.is_empty() {
|
||||
return Err(Error::Invalid(problems.iter().map(|p| p.message.clone()).collect::<Vec<_>>().join(" ")));
|
||||
}
|
||||
let observed = crate::process::observe(root, &crate::layout::read_ports(root));
|
||||
let busy = |s: &crate::process::ServiceStatus| matches!(s.state, crate::process::ServiceState::Running | crate::process::ServiceState::Starting | crate::process::ServiceState::Stopping);
|
||||
if busy(&observed.world) || busy(&observed.auth) {
|
||||
return Err(Error::Invalid("Stop the server before changing the game data folder.".into()));
|
||||
}
|
||||
let mut cfg = Config::load(root)?;
|
||||
cfg.data_dir = Some(path.to_string_lossy().into_owned());
|
||||
cfg.validate()?;
|
||||
fsx::atomic_write_json(&root.join(MARKER), &cfg)
|
||||
}
|
||||
|
||||
/// A reason a value cannot work on a Docker server, for settings that name a path: the server runs in a container that sees only
|
||||
/// its own `Core` folder (as `/srv/core`, its working directory), so a path elsewhere on this computer does not exist for it.
|
||||
pub fn setting_problem(key: &str, raw: &str) -> Option<&'static str> {
|
||||
let raw = raw.trim().trim_matches('"');
|
||||
let outside = Path::new(raw).is_absolute() && !raw.starts_with("/srv/core/");
|
||||
(key.eq_ignore_ascii_case("CoaBots.TalentBuildsPath") && !raw.is_empty() && outside)
|
||||
.then_some("must be a path inside the server's Core folder (for example reference/ascensionsidekick-level-builds.json), because the server runs in a container that cannot see other folders")
|
||||
}
|
||||
|
||||
/// Name of the runtime image: it follows the content of its Dockerfile, so changing the libraries builds a new image.
|
||||
pub(crate) fn runtime_image() -> String {
|
||||
format!("coa-runtime:{}", &fsx::sha256_bytes(RUNTIME_DOCKERFILE.as_bytes())[..12])
|
||||
@@ -206,6 +287,66 @@ mod tests {
|
||||
use super::*;
|
||||
use std::fs;
|
||||
|
||||
#[cfg(unix)]
|
||||
#[test]
|
||||
fn the_game_data_folder_can_be_changed_when_the_servers_are_stopped() {
|
||||
let d = tempfile::tempdir().unwrap();
|
||||
let root = d.path().join("srv");
|
||||
std::fs::create_dir_all(root.join("Settings")).unwrap();
|
||||
std::fs::write(root.join(MARKER), r#"{"project":"t1","dataDir":"/old/data"}"#).unwrap();
|
||||
let good = d.path().join("data");
|
||||
std::fs::create_dir_all(good.join("dbc")).unwrap();
|
||||
std::fs::create_dir_all(good.join("maps")).unwrap();
|
||||
assert_eq!(game_data_dir(&root).unwrap(), std::path::PathBuf::from("/old/data"));
|
||||
set_game_data(&root, &good).unwrap();
|
||||
assert_eq!(game_data_dir(&root).unwrap(), good);
|
||||
assert_eq!(Config::load(&root).unwrap().project, "t1", "the other settings are kept");
|
||||
// A folder that does not look like game data is refused and nothing changes.
|
||||
let empty = d.path().join("empty");
|
||||
std::fs::create_dir_all(&empty).unwrap();
|
||||
assert!(set_game_data(&root, &empty).is_err());
|
||||
assert_eq!(game_data_dir(&root).unwrap(), good);
|
||||
assert!(set_game_data(&root, std::path::Path::new("relative/dir")).is_err());
|
||||
}
|
||||
|
||||
#[cfg(unix)]
|
||||
#[test]
|
||||
fn a_path_outside_the_core_folder_is_refused_for_a_docker_server() {
|
||||
let key = "CoaBots.TalentBuildsPath";
|
||||
assert!(setting_problem(key, "reference/builds.json").is_none());
|
||||
assert!(setting_problem(key, "").is_none());
|
||||
assert!(setting_problem(key, "\"/srv/core/reference/builds.json\"").is_none());
|
||||
assert!(setting_problem(key, "/home/ana/builds.json").is_some());
|
||||
assert!(setting_problem("Rate.XP.Kill", "/home/ana/x").is_none(), "only settings that name a path");
|
||||
}
|
||||
|
||||
#[test]
|
||||
fn setting_names_become_the_variables_the_core_reads() {
|
||||
for (key, var) in [
|
||||
("BindIP", "AC_BIND_IP"),
|
||||
("Ra.Enable", "AC_RA_ENABLE"),
|
||||
("Ra.IP", "AC_RA_IP"),
|
||||
("Updates.EnableDatabases", "AC_UPDATES_ENABLE_DATABASES"),
|
||||
("WorldServerPort", "AC_WORLD_SERVER_PORT"),
|
||||
("LoginDatabaseInfo", "AC_LOGIN_DATABASE_INFO"),
|
||||
("DataDir", "AC_DATA_DIR"),
|
||||
("Dynamic.XP.Reminder.Interval", "AC_DYNAMIC_XP_REMINDER_INTERVAL"),
|
||||
("EtherealBazaar.Enable", "AC_ETHEREAL_BAZAAR_ENABLE"),
|
||||
] {
|
||||
assert_eq!(env_name(key), var, "{key}");
|
||||
}
|
||||
}
|
||||
|
||||
#[test]
|
||||
fn the_settings_called_managed_are_exactly_the_variables_the_containers_get() {
|
||||
// If a variable is added to the containers without being listed here (or the other way round), a screen would
|
||||
// offer a setting that does nothing, or hide one that works.
|
||||
let given: std::collections::BTreeSet<String> = lifecycle::forced_variables().into_iter().collect();
|
||||
let listed: std::collections::BTreeSet<String> = FORCED_KEYS.iter().map(|k| env_name(k)).collect();
|
||||
assert_eq!(given, listed);
|
||||
assert!(managed_setting("ra.enable") && managed_setting("Updates.EnableDatabases") && !managed_setting("PlayerLimit"));
|
||||
}
|
||||
|
||||
#[test]
|
||||
fn the_main_configs_are_created_from_their_templates_and_never_overwritten() {
|
||||
let d = tempfile::tempdir().unwrap();
|
||||
|
||||
@@ -0,0 +1,149 @@
|
||||
//! Sharing a Docker server with friends. Who can reach the game is decided by the address the container ports are
|
||||
//! published on (`bindAddress` in `Settings/docker.json`): `127.0.0.1` is this computer only, anything else is the network.
|
||||
//! The `BindIP` of the configuration files is forced to `0.0.0.0` inside the containers and changes nothing, so the
|
||||
//! repack's way of opening the servers (editing `BindIP`) is replaced here. The database is never published and the server
|
||||
//! console is only ever published on the loopback address.
|
||||
|
||||
use std::fs;
|
||||
use std::net::IpAddr;
|
||||
use std::path::{Path, PathBuf};
|
||||
|
||||
use super::{Config, MARKER};
|
||||
use crate::config::parser::ConfFile;
|
||||
use crate::config::{take_snapshot, Scope};
|
||||
use crate::error::Result;
|
||||
use crate::fsx;
|
||||
use crate::layout::Ports;
|
||||
use crate::net::Exposure;
|
||||
use crate::process::{ServiceState, ServiceStatus};
|
||||
|
||||
fn is_open(cfg: &Config) -> bool {
|
||||
cfg.bind_address.parse::<IpAddr>().map(|ip| !ip.is_loopback()).unwrap_or(false)
|
||||
}
|
||||
|
||||
/// Whether the login and world servers are published beyond this computer.
|
||||
pub fn bind_is_open(root: &Path) -> bool {
|
||||
Config::load(root).map(|c| is_open(&c)).unwrap_or(false)
|
||||
}
|
||||
|
||||
/// Publish the login and world servers beyond this computer (`0.0.0.0`) or only on it (`127.0.0.1`). An address the owner chose
|
||||
/// by hand (for example one network card) is kept when opening. Returns true if anything changed, which needs a restart of
|
||||
/// the containers. The old files are snapshotted.
|
||||
pub fn set_open(root: &Path, meta: &Path, open: bool) -> Result<bool> {
|
||||
let mut cfg = Config::load(root)?;
|
||||
let mut originals: Vec<(PathBuf, Vec<u8>)> = Vec::new();
|
||||
let mut changed = false;
|
||||
if is_open(&cfg) != open {
|
||||
originals.push((root.join(MARKER), fs::read(root.join(MARKER))?));
|
||||
cfg.bind_address = if open { "0.0.0.0" } else { "127.0.0.1" }.into();
|
||||
changed = true;
|
||||
}
|
||||
// Friends connect from other addresses, and the server only applies the CoA client protocol to loopback unless remote clients
|
||||
// are allowed; opening switches that on (closing leaves it, it only matters while the servers listen beyond this computer).
|
||||
let coa_conf = root.join("Core/configs/modules/coa.conf");
|
||||
let mut coa_edit = None;
|
||||
if open {
|
||||
if let Ok(bytes) = fs::read(&coa_conf) {
|
||||
let mut conf = ConfFile::parse_bytes(&bytes)?;
|
||||
if conf.get("CoA.AllowRemoteClients").map(str::trim) != Some("1") {
|
||||
conf.set("CoA.AllowRemoteClients", "1", &["Set by CoA Server Manager together with the friends mode"]);
|
||||
originals.push((coa_conf.clone(), bytes));
|
||||
coa_edit = Some(conf.to_text());
|
||||
}
|
||||
}
|
||||
}
|
||||
if !changed && coa_edit.is_none() {
|
||||
return Ok(false);
|
||||
}
|
||||
take_snapshot(meta, Scope::Server, if open { "before opening the servers to friends" } else { "before closing the servers to friends" }, &originals)?;
|
||||
if changed {
|
||||
fsx::atomic_write_json(&root.join(MARKER), &cfg)?;
|
||||
}
|
||||
let remote_changed = coa_edit.is_some();
|
||||
if let Some(text) = coa_edit {
|
||||
fsx::atomic_write(&coa_conf, text.as_bytes())?;
|
||||
}
|
||||
Ok(changed || remote_changed)
|
||||
}
|
||||
|
||||
/// What each service can be reached from, computed from how the containers publish their ports: the database is never published,
|
||||
/// the console only on the loopback address, the game servers on `bindAddress`.
|
||||
pub fn exposure(root: &Path, ports: &Ports) -> Vec<Exposure> {
|
||||
let open = bind_is_open(root);
|
||||
let observed = crate::process::observe(root, ports);
|
||||
let up = |s: &ServiceStatus| matches!(s.state, ServiceState::Running | ServiceState::Starting);
|
||||
vec![
|
||||
Exposure { port: ports.mysql, what: "database", listening: up(&observed.mysql), reachable_from_network: false },
|
||||
Exposure { port: ports.ra, what: "server console", listening: up(&observed.world), reachable_from_network: false },
|
||||
Exposure { port: ports.auth, what: "login server", listening: up(&observed.auth), reachable_from_network: open && up(&observed.auth) },
|
||||
Exposure { port: ports.world, what: "game world", listening: up(&observed.world), reachable_from_network: open && up(&observed.world) },
|
||||
]
|
||||
}
|
||||
|
||||
#[cfg(test)]
|
||||
mod tests {
|
||||
use super::*;
|
||||
|
||||
fn server(bind: Option<&str>) -> (tempfile::TempDir, PathBuf, PathBuf) {
|
||||
let d = tempfile::tempdir().unwrap();
|
||||
let root = d.path().join("srv");
|
||||
let meta = d.path().join("srv.manager");
|
||||
fs::create_dir_all(root.join("Settings")).unwrap();
|
||||
fs::create_dir_all(root.join("Core/configs/modules")).unwrap();
|
||||
fs::create_dir_all(&meta).unwrap();
|
||||
let extra = bind.map(|b| format!(r#","bindAddress":"{b}""#)).unwrap_or_default();
|
||||
fs::write(root.join(MARKER), format!(r#"{{"project":"t1"{extra}}}"#)).unwrap();
|
||||
fs::write(root.join("Core/configs/modules/coa.conf"), "CoA.Enable = 1\n").unwrap();
|
||||
(d, root, meta)
|
||||
}
|
||||
|
||||
#[test]
|
||||
fn opening_and_closing_changes_the_published_address_and_allows_remote_clients() {
|
||||
let (_d, root, meta) = server(None);
|
||||
assert!(!bind_is_open(&root));
|
||||
assert!(set_open(&root, &meta, true).unwrap(), "a restart is needed");
|
||||
assert!(bind_is_open(&root));
|
||||
assert_eq!(Config::load(&root).unwrap().bind_address, "0.0.0.0");
|
||||
assert!(fs::read_to_string(root.join("Core/configs/modules/coa.conf")).unwrap().contains("CoA.AllowRemoteClients = 1"));
|
||||
assert!(!set_open(&root, &meta, true).unwrap(), "nothing left to change");
|
||||
assert!(set_open(&root, &meta, false).unwrap());
|
||||
assert!(!bind_is_open(&root));
|
||||
assert_eq!(Config::load(&root).unwrap().bind_address, "127.0.0.1");
|
||||
}
|
||||
|
||||
#[test]
|
||||
fn enabling_remote_client_protocol_requires_restart_even_when_ports_are_open() {
|
||||
let (_d, root, meta) = server(Some("0.0.0.0"));
|
||||
fs::write(root.join("Core/configs/modules/coa.conf"), "CoA.Enable = 1\nCoA.AllowRemoteClients = 0\n").unwrap();
|
||||
assert!(set_open(&root, &meta, true).unwrap());
|
||||
assert_eq!(Config::load(&root).unwrap().bind_address, "0.0.0.0");
|
||||
assert!(!set_open(&root, &meta, true).unwrap());
|
||||
}
|
||||
|
||||
#[test]
|
||||
fn an_address_chosen_by_hand_is_kept_when_opening_and_other_settings_survive() {
|
||||
let (_d, root, meta) = server(Some("192.168.1.20"));
|
||||
assert!(bind_is_open(&root), "any address but the loopback is the network");
|
||||
set_open(&root, &meta, true).unwrap();
|
||||
let cfg = Config::load(&root).unwrap();
|
||||
assert_eq!(cfg.bind_address, "192.168.1.20");
|
||||
assert_eq!(cfg.project, "t1");
|
||||
}
|
||||
|
||||
#[test]
|
||||
fn the_old_settings_are_snapshotted_before_a_change() {
|
||||
let (_d, root, meta) = server(None);
|
||||
set_open(&root, &meta, true).unwrap();
|
||||
assert_eq!(crate::config::list_snapshots(&meta).len(), 1);
|
||||
}
|
||||
|
||||
#[test]
|
||||
fn the_database_and_the_console_are_never_reported_reachable() {
|
||||
let (_d, root, _meta) = server(Some("0.0.0.0"));
|
||||
let rows = exposure(&root, &Ports::default());
|
||||
let by = |what: &str| rows.iter().find(|e| e.what == what).unwrap();
|
||||
assert!(!by("database").reachable_from_network && !by("server console").reachable_from_network);
|
||||
// Nothing runs in this test (docker is not asked to start anything), so nothing is reachable yet.
|
||||
assert!(rows.iter().all(|e| !e.reachable_from_network));
|
||||
}
|
||||
}
|
||||
@@ -55,6 +55,7 @@ pub enum ErrorCode {
|
||||
OperationInProgress,
|
||||
StartupFailed,
|
||||
DockerUnavailable,
|
||||
GameDataMismatch,
|
||||
HashMismatch,
|
||||
PathRejected,
|
||||
PackageNotPublished,
|
||||
@@ -138,6 +139,11 @@ impl ErrorCode {
|
||||
"This server runs in Docker. Install Docker, start it, and make sure your user account may use it, then try again.",
|
||||
&[Retry, ShowDetails],
|
||||
),
|
||||
ErrorCode::GameDataMismatch => (
|
||||
"The game data folder is not the CoA set",
|
||||
"The server stopped because the DBC files in the game data folder are not the ones of the Conquest of Azeroth client. Choose the folder that holds the CoA data (Settings > Game data folder), then start again.",
|
||||
&[ShowDetails],
|
||||
),
|
||||
ErrorCode::HashMismatch => (
|
||||
"A downloaded file is damaged",
|
||||
"The file did not match its checksum and was not used.",
|
||||
|
||||
@@ -80,6 +80,9 @@ fn bind_targets(root: &Path) -> Vec<PathBuf> {
|
||||
|
||||
/// Whether the configuration currently lets other computers reach the login and world servers.
|
||||
pub fn bind_is_open(root: &Path) -> bool {
|
||||
if crate::docker::is_docker(root) {
|
||||
return crate::docker::bind_is_open(root);
|
||||
}
|
||||
let files = bind_targets(root);
|
||||
!files.is_empty()
|
||||
&& files
|
||||
@@ -90,6 +93,9 @@ pub fn bind_is_open(root: &Path) -> bool {
|
||||
/// Open (`0.0.0.0`) or close (`127.0.0.1`) the login and world servers to other computers. The database and the server
|
||||
/// console are never touched. Returns true if anything changed (a restart is then needed). The old files are snapshotted.
|
||||
pub fn set_open(root: &Path, meta: &Path, open: bool) -> Result<bool> {
|
||||
if crate::docker::is_docker(root) {
|
||||
return crate::docker::set_open(root, meta, open);
|
||||
}
|
||||
let want = if open { "\"0.0.0.0\"" } else { "\"127.0.0.1\"" };
|
||||
let mut originals = Vec::new();
|
||||
let mut edits = Vec::new();
|
||||
|
||||
@@ -25,6 +25,8 @@ pub fn diagnose(text: &str) -> Option<ErrorCode> {
|
||||
Some(ErrorCode::DatabaseNotRunning)
|
||||
} else if l.contains("address already in use") || l.contains("could not bind") || l.contains("only one usage of each socket") {
|
||||
Some(ErrorCode::PortInUse)
|
||||
} else if l.contains("does not hold the coa client dbc set") || l.contains("_outdated_ dbc data") {
|
||||
Some(ErrorCode::GameDataMismatch)
|
||||
} else if l.contains("config::loadfile") && l.contains("failed open file") && l.contains("worldserver.conf") {
|
||||
Some(ErrorCode::ServerFilesIncomplete)
|
||||
} else {
|
||||
@@ -57,6 +59,13 @@ pub fn diagnose_installation(root: &Path) -> Option<ErrorCode> {
|
||||
mod tests {
|
||||
use super::*;
|
||||
|
||||
#[test]
|
||||
fn a_game_data_folder_without_the_coa_dbc_set_is_named_as_such() {
|
||||
let log = "Using DataDir /srv/data/\nSpellAffect.dbc not found in /srv/data/dbc/\nDataDir does not hold the CoA client DBC set. Install it with apps/coa-dbc/client_dbc.py.";
|
||||
assert_eq!(diagnose(log), Some(ErrorCode::GameDataMismatch));
|
||||
assert_eq!(diagnose("You have _outdated_ DBC data. Please extract correct versions from current using client."), Some(ErrorCode::GameDataMismatch));
|
||||
}
|
||||
|
||||
#[test]
|
||||
fn recognises_missing_migrations() {
|
||||
let log = "ERROR [sql.sql] [1146] Table 'acore_world.coa_boss' doesn't exist\nFATAL [sql.sql] Your database structure is not up to date.";
|
||||
|
||||
@@ -44,9 +44,12 @@ pub mod release;
|
||||
pub mod report;
|
||||
pub mod release_schema;
|
||||
pub mod update;
|
||||
mod update_isolation;
|
||||
mod mysql_snapshot;
|
||||
pub mod wine;
|
||||
pub mod upnp;
|
||||
pub mod signing;
|
||||
pub mod channels;
|
||||
pub mod srp6;
|
||||
|
||||
pub use error::{Error, ErrorCode, Result};
|
||||
|
||||
@@ -78,9 +78,31 @@ pub struct Revision {
|
||||
pub commit: Option<String>,
|
||||
}
|
||||
|
||||
#[derive(Debug, Clone, Serialize, Deserialize)]
|
||||
#[serde(rename_all = "camelCase", deny_unknown_fields)]
|
||||
pub struct SourceDatabase {
|
||||
pub manifest_sha256: String,
|
||||
pub schema_sha256: Option<String>,
|
||||
}
|
||||
|
||||
#[derive(Debug, Clone, Serialize, Deserialize)]
|
||||
#[serde(rename_all = "camelCase", deny_unknown_fields)]
|
||||
pub struct Compatibility {
|
||||
pub schema: u32,
|
||||
pub platform: String,
|
||||
pub core_commit: String,
|
||||
pub module_commits: std::collections::BTreeMap<String, String>,
|
||||
pub client_patch_version: String,
|
||||
pub source_versions: Vec<String>,
|
||||
#[serde(default, skip_serializing_if = "std::collections::BTreeMap::is_empty")]
|
||||
pub source_databases: std::collections::BTreeMap<String, SourceDatabase>,
|
||||
}
|
||||
|
||||
#[derive(Debug, Clone, Serialize, Deserialize)]
|
||||
#[serde(rename_all = "camelCase")]
|
||||
pub struct Manifest {
|
||||
#[serde(default, skip_serializing_if = "Option::is_none")]
|
||||
pub compatibility: Option<Compatibility>,
|
||||
pub schema: u32,
|
||||
pub kind: Kind,
|
||||
pub version: String,
|
||||
@@ -136,6 +158,26 @@ impl Manifest {
|
||||
if parse_version(&self.min_manager_version).is_none() {
|
||||
return bad(format!("bad minManagerVersion {:?}", self.min_manager_version));
|
||||
}
|
||||
if let Some(c) = &self.compatibility {
|
||||
if parse_version(&self.min_manager_version).is_none_or(|v| v < (0, 6, 13)) {
|
||||
return bad("Release compatibility matrices require Manager 0.6.13 or newer".into());
|
||||
}
|
||||
if c.schema != 1 || !matches!(c.platform.as_str(), "windows-x86_64" | "linux-x86_64")
|
||||
|| !is_commit(&c.core_commit) || self.core.commit.as_deref() != Some(&c.core_commit)
|
||||
|| c.module_commits.is_empty() || c.module_commits.values().any(|sha| !is_commit(sha))
|
||||
|| self.bots.as_ref().and_then(|r| r.commit.as_ref()).is_some_and(|sha| c.module_commits.get("bots") != Some(sha))
|
||||
|| parse_version(&c.client_patch_version).is_none()
|
||||
|| c.source_versions.is_empty() || c.source_versions.iter().any(|v| parse_version(v).is_none())
|
||||
|| c.source_versions.iter().collect::<HashSet<_>>().len() != c.source_versions.len() {
|
||||
return bad("Invalid release compatibility matrix".into());
|
||||
}
|
||||
if !c.source_databases.is_empty() && (c.source_databases.len() != c.source_versions.len()
|
||||
|| c.source_versions.iter().any(|v| !c.source_databases.contains_key(v))
|
||||
|| c.source_databases.values().any(|s| !is_sha256(&s.manifest_sha256)
|
||||
|| s.schema_sha256.as_ref().is_some_and(|sha| !is_sha256(sha)))) {
|
||||
return bad("Invalid source database compatibility".into());
|
||||
}
|
||||
}
|
||||
for migration in &self.migrations {
|
||||
if !is_sha256(&migration.sha256) || migration.compatible_sha256.iter().any(|h| !is_sha256(h) || h == &"0".repeat(64)) {
|
||||
return bad(format!("{}: invalid migration checksum compatibility", migration.id));
|
||||
@@ -232,6 +274,53 @@ mod tests {
|
||||
assert!(!m.compatible_with_manager("0.0.9"));
|
||||
}
|
||||
|
||||
#[test]
|
||||
fn compatibility_matrix_binds_core_and_requires_tested_sources() {
|
||||
let mut m = Manifest::parse(sample("").as_bytes()).unwrap();
|
||||
m.min_manager_version = "0.6.13".into();
|
||||
m.compatibility = Some(Compatibility { schema: 1, platform: "windows-x86_64".into(),
|
||||
core_commit: "a".repeat(40), module_commits: [("squid".into(), "b".repeat(40))].into(),
|
||||
source_databases: Default::default(), client_patch_version: "1.5.1".into(), source_versions: vec!["0.261010.32".into()] });
|
||||
m.validate().unwrap();
|
||||
m.compatibility.as_mut().unwrap().core_commit = "c".repeat(40);
|
||||
assert!(m.validate().is_err());
|
||||
m.compatibility.as_mut().unwrap().core_commit = "a".repeat(40);
|
||||
m.compatibility.as_mut().unwrap().source_versions.clear();
|
||||
assert!(m.validate().is_err());
|
||||
}
|
||||
|
||||
#[test]
|
||||
fn compatibility_cannot_claim_a_different_packaged_bot_revision() {
|
||||
let mut m = Manifest::parse(sample("").as_bytes()).unwrap();
|
||||
m.min_manager_version = "0.6.13".into();
|
||||
m.bots = Some(Revision { commit: Some("b".repeat(40)) });
|
||||
m.compatibility = Some(Compatibility { schema: 1, platform: "windows-x86_64".into(),
|
||||
core_commit: "a".repeat(40), module_commits: [("bots".into(), "c".repeat(40))].into(),
|
||||
source_databases: Default::default(), client_patch_version: "1.5.1".into(), source_versions: vec!["0.2.0".into()] });
|
||||
assert!(m.validate().is_err());
|
||||
m.compatibility.as_mut().unwrap().module_commits.insert("bots".into(), "b".repeat(40));
|
||||
m.validate().unwrap();
|
||||
m.compatibility.as_mut().unwrap().source_versions.push("0.2.0".into());
|
||||
assert!(m.validate().is_err());
|
||||
}
|
||||
|
||||
#[test]
|
||||
fn source_database_contracts_must_cover_the_exact_upgrade_versions() {
|
||||
let mut m = Manifest::parse(sample("").as_bytes()).unwrap();
|
||||
m.min_manager_version = "0.6.13".into();
|
||||
m.compatibility = Some(Compatibility { schema: 1, platform: "windows-x86_64".into(),
|
||||
core_commit: "a".repeat(40), module_commits: [("squid".into(), "b".repeat(40))].into(),
|
||||
client_patch_version: "1.5.1".into(), source_versions: vec!["0.2.0".into()],
|
||||
source_databases: [("0.2.0".into(), SourceDatabase { manifest_sha256: "a".repeat(64), schema_sha256: None })].into() });
|
||||
m.validate().unwrap();
|
||||
m.compatibility.as_mut().unwrap().source_databases.get_mut("0.2.0").unwrap().schema_sha256 = Some("bad".into());
|
||||
assert!(m.validate().is_err());
|
||||
let c = m.compatibility.as_mut().unwrap();
|
||||
c.source_databases.get_mut("0.2.0").unwrap().schema_sha256 = None;
|
||||
c.source_versions = vec!["0.2.1".into()];
|
||||
assert!(m.validate().is_err());
|
||||
}
|
||||
|
||||
#[test]
|
||||
fn rejects_traversal_bad_hash_duplicates_and_short_commit() {
|
||||
let ok = "b".repeat(64);
|
||||
|
||||
@@ -214,6 +214,16 @@ pub fn set_enabled(root: &Path, meta: &Path, id: &str, on: bool) -> Result<()> {
|
||||
}
|
||||
}
|
||||
}
|
||||
if !on {
|
||||
let _ = crate::custom_races::sync_bot_races_config(root, false);
|
||||
} else {
|
||||
let allow = crate::custom_races::is_bot_custom_races_allowed(root).unwrap_or_else(|| {
|
||||
read(&dir(root).join("coa_custom_races.conf"))
|
||||
.and_then(|c| c.get("CoACustomRaces.BotsEnable").map(truthy))
|
||||
.unwrap_or(false)
|
||||
});
|
||||
let _ = crate::custom_races::sync_bot_races_config(root, allow);
|
||||
}
|
||||
}
|
||||
set_enabled_in(&catalog(), root, meta, id, on)
|
||||
}
|
||||
@@ -290,14 +300,27 @@ fn settings_in(cat: &[Entry], root: &Path, id: &str) -> Result<Vec<Setting>> {
|
||||
}
|
||||
}
|
||||
}
|
||||
let bot_custom_races_allowed = if id == "custom-races" {
|
||||
crate::custom_races::is_bot_custom_races_allowed(root)
|
||||
} else {
|
||||
None
|
||||
};
|
||||
Ok(effective
|
||||
.entries()
|
||||
.map(|(k, v)| Setting {
|
||||
key: k.to_string(),
|
||||
value: fields.get(k).and_then(|field| field.default_if_missing.as_ref()).filter(|_| active.get(k).is_none()).and_then(crate::squid::scalar).unwrap_or_else(|| v.to_string()),
|
||||
default: fields.get(k).and_then(|field| crate::squid::scalar(&field.default)).or_else(|| dist.as_ref().and_then(|d| d.get(k)).map(str::to_string)),
|
||||
field: fields.get(k).cloned(),
|
||||
doc: dist.as_ref().map(|d| d.doc_for(k)).filter(|d| !d.is_empty()).unwrap_or_else(|| active.doc_for(k)).join(" "),
|
||||
.map(|(k, v)| {
|
||||
let mut val = fields.get(k).and_then(|field| field.default_if_missing.as_ref()).filter(|_| active.get(k).is_none()).and_then(crate::squid::scalar).unwrap_or_else(|| v.to_string());
|
||||
if k == "CoACustomRaces.BotsEnable" {
|
||||
if let Some(allowed) = bot_custom_races_allowed {
|
||||
val = if allowed { "1".into() } else { "0".into() };
|
||||
}
|
||||
}
|
||||
Setting {
|
||||
key: k.to_string(),
|
||||
value: val,
|
||||
default: fields.get(k).and_then(|field| crate::squid::scalar(&field.default)).or_else(|| dist.as_ref().and_then(|d| d.get(k)).map(str::to_string)),
|
||||
field: fields.get(k).cloned(),
|
||||
doc: dist.as_ref().map(|d| d.doc_for(k)).filter(|d| !d.is_empty()).unwrap_or_else(|| active.doc_for(k)).join(" "),
|
||||
}
|
||||
})
|
||||
.collect())
|
||||
}
|
||||
@@ -353,6 +376,12 @@ fn save_settings_in(cat: &[Entry], root: &Path, meta: &Path, id: &str, changes:
|
||||
changed.push((key.clone(), value.to_string()));
|
||||
}
|
||||
}
|
||||
if id == "custom-races" {
|
||||
if let Some(bots_enable) = changes.get("CoACustomRaces.BotsEnable") {
|
||||
let allow = truthy(bots_enable);
|
||||
crate::custom_races::sync_bot_races_config(root, allow)?;
|
||||
}
|
||||
}
|
||||
if changed.is_empty() {
|
||||
return Ok(Vec::new());
|
||||
}
|
||||
@@ -672,4 +701,39 @@ mod tests {
|
||||
assert!(fs::read_to_string(dir(&root).join("war_games.conf")).unwrap().contains("WarGames.Enable = 0"));
|
||||
assert!(!list_in(&cat, &root).into_iter().find(|m| m.id == "war-games").unwrap().enabled);
|
||||
}
|
||||
#[test]
|
||||
fn custom_races_bot_settings_synchronize_playerbots_conf() {
|
||||
let d = tempfile::tempdir().unwrap();
|
||||
let (root, meta) = server(d.path());
|
||||
let cat = catalog();
|
||||
fs::write(dir(&root).join("coa_custom_races.conf.dist"), "CoACustomRaces.Enable = 1\nCoACustomRaces.BotsEnable = 0\n").unwrap();
|
||||
fs::write(dir(&root).join("coa_custom_races.conf"), "CoACustomRaces.Enable = 1\nCoACustomRaces.BotsEnable = 0\n").unwrap();
|
||||
fs::write(dir(&root).join("playerbots.conf"), "AiPlayerbot.Enabled = 1\n").unwrap();
|
||||
|
||||
// 1. Initially CoACustomRaces.BotsEnable is 0
|
||||
let s = settings_in(&cat, &root, "custom-races").unwrap();
|
||||
assert_eq!(s.iter().find(|s| s.key == "CoACustomRaces.BotsEnable").unwrap().value, "0");
|
||||
|
||||
// 2. Enable bots for custom races: should write experimental exclusions to playerbots.conf
|
||||
let change_on = BTreeMap::from([("CoACustomRaces.BotsEnable".into(), "1".into())]);
|
||||
assert_eq!(save_settings_in(&cat, &root, &meta, "custom-races", &change_on).unwrap(), ["CoACustomRaces.BotsEnable"]);
|
||||
let pb = fs::read_to_string(dir(&root).join("playerbots.conf")).unwrap();
|
||||
assert!(pb.contains("AiPlayerbot.ExcludedBotRaces"));
|
||||
assert!(pb.contains(crate::custom_races::EXCLUDED_BOT_RACES_EXPERIMENTAL));
|
||||
|
||||
// Settings view now sees "1"
|
||||
let s = settings_in(&cat, &root, "custom-races").unwrap();
|
||||
assert_eq!(s.iter().find(|s| s.key == "CoACustomRaces.BotsEnable").unwrap().value, "1");
|
||||
|
||||
// 3. Disable bots for custom races: should write recommended exclusions to playerbots.conf
|
||||
let change_off = BTreeMap::from([("CoACustomRaces.BotsEnable".into(), "0".into())]);
|
||||
assert_eq!(save_settings_in(&cat, &root, &meta, "custom-races", &change_off).unwrap(), ["CoACustomRaces.BotsEnable"]);
|
||||
let pb = fs::read_to_string(dir(&root).join("playerbots.conf")).unwrap();
|
||||
assert!(pb.contains(crate::custom_races::EXCLUDED_BOT_RACES_RECOMMENDED));
|
||||
|
||||
// Settings view now sees "0"
|
||||
let s = settings_in(&cat, &root, "custom-races").unwrap();
|
||||
assert_eq!(s.iter().find(|s| s.key == "CoACustomRaces.BotsEnable").unwrap().value, "0");
|
||||
}
|
||||
}
|
||||
|
||||
@@ -0,0 +1,493 @@
|
||||
use std::{collections::{BTreeMap, BTreeSet}, fs, path::{Path, PathBuf}};
|
||||
use std::io::{BufReader, BufWriter, Write};
|
||||
use serde::{Deserialize, Serialize};
|
||||
use crate::{fsx, Error, Result};
|
||||
|
||||
#[derive(Debug, Clone, Serialize, Deserialize)]
|
||||
#[serde(deny_unknown_fields)]
|
||||
pub(crate) struct Snapshot {
|
||||
pub path: String,
|
||||
pub files: BTreeMap<String, String>,
|
||||
pub directories: BTreeSet<String>,
|
||||
pub server_sha256: String,
|
||||
#[serde(default)]
|
||||
pub bytes: u64,
|
||||
#[serde(default, skip_serializing_if = "Option::is_none")]
|
||||
pub archive_sha256: Option<String>,
|
||||
#[serde(default)]
|
||||
pub expanded_bytes: u64,
|
||||
}
|
||||
|
||||
fn reject_link(metadata: &fs::Metadata) -> Result<()> {
|
||||
let linked = metadata.file_type().is_symlink();
|
||||
#[cfg(windows)] let linked = { use std::os::windows::fs::MetadataExt; linked || metadata.file_attributes() & 0x400 != 0 };
|
||||
if linked { return Err(Error::Invalid("Recovery copies cannot follow symbolic links or junctions.".into())); }
|
||||
Ok(())
|
||||
}
|
||||
|
||||
fn directories(root: &Path) -> Result<BTreeSet<String>> {
|
||||
let canonical = fsx::canonicalize_lenient(root)?;
|
||||
let root = canonical.as_path();
|
||||
let mut result = BTreeSet::new();
|
||||
let mut pending = vec![root.to_path_buf()];
|
||||
while let Some(directory) = pending.pop() {
|
||||
for entry in fs::read_dir(directory)? {
|
||||
let entry = entry?;
|
||||
reject_link(&fs::symlink_metadata(entry.path())?)?;
|
||||
let path = fsx::ensure_within(root, &entry.path())?;
|
||||
if entry.file_type()?.is_dir() {
|
||||
let relative = path.strip_prefix(root).map_err(|e| Error::Invalid(e.to_string()))?.to_string_lossy().replace('\\', "/");
|
||||
result.insert(relative);
|
||||
pending.push(path);
|
||||
}
|
||||
}
|
||||
}
|
||||
Ok(result)
|
||||
}
|
||||
|
||||
fn copy_snapshot(point: &Path, snapshot: &Snapshot, target: &Path) -> Result<()> {
|
||||
if snapshot.archive_sha256.is_some() {
|
||||
verify(point, snapshot)?;
|
||||
if target.exists() { return Err(Error::Invalid("The recovery destination already exists.".into())); }
|
||||
let parent = target.parent().ok_or_else(|| Error::Invalid("Invalid recovery destination.".into()))?;
|
||||
fs::create_dir_all(parent)?;
|
||||
fsx::require_space(parent, snapshot.expanded_bytes)?;
|
||||
fs::create_dir(target)?;
|
||||
let input = fsx::ensure_within(point, &fsx::safe_join(point, &snapshot.path)?)?;
|
||||
let decoder = zstd::Decoder::new(BufReader::new(fs::File::open(input)?))?;
|
||||
let mut archive = tar::Archive::new(decoder);
|
||||
let mut seen = BTreeSet::new();
|
||||
let mut expanded = 0u64;
|
||||
for entry in archive.entries()? {
|
||||
let mut entry = entry?;
|
||||
let name = entry.path()?.to_string_lossy().trim_end_matches('/').to_string();
|
||||
if !seen.insert(name.clone()) { return Err(Error::Invalid("Duplicate entry in MySQL recovery archive.".into())); }
|
||||
let output = fsx::ensure_within(target, &fsx::safe_join(target, &name)?)?;
|
||||
if entry.header().entry_type().is_dir() && snapshot.directories.contains(&name) {
|
||||
fs::create_dir_all(output)?;
|
||||
} else if entry.header().entry_type().is_file() && snapshot.files.contains_key(&name) {
|
||||
expanded = expanded.checked_add(entry.size()).filter(|bytes| *bytes <= snapshot.expanded_bytes)
|
||||
.ok_or_else(|| Error::Invalid("MySQL recovery archive exceeds its declared size.".into()))?;
|
||||
fs::create_dir_all(output.parent().unwrap())?;
|
||||
let mut file = fs::OpenOptions::new().write(true).create_new(true).open(output)?;
|
||||
if std::io::copy(&mut entry, &mut file)? != entry.size() { return Err(Error::Invalid("Truncated MySQL recovery file.".into())); }
|
||||
file.flush()?;
|
||||
} else { return Err(Error::Invalid("Unexpected entry in MySQL recovery archive.".into())); }
|
||||
}
|
||||
if expanded != snapshot.expanded_bytes || inventory(target)? != snapshot.files {
|
||||
return Err(Error::Invalid("MySQL recovery files failed verification.".into()));
|
||||
}
|
||||
} else { copy_verified(&point.join(&snapshot.path), target, &snapshot.files)?; }
|
||||
for directory in &snapshot.directories {
|
||||
fs::create_dir_all(fsx::ensure_within(target, &fsx::safe_join(target, directory)?)?)?;
|
||||
}
|
||||
if directories(target)? != snapshot.directories { return Err(Error::Invalid("The recovery directory inventory differs.".into())); }
|
||||
Ok(())
|
||||
}
|
||||
|
||||
fn compress(source: &Path, point: &Path, snapshot: &mut Snapshot) -> Result<()> {
|
||||
snapshot.path = "mysql-data.tar.zst".into();
|
||||
let path = fsx::safe_join(point, &snapshot.path)?;
|
||||
fs::create_dir_all(point)?;
|
||||
fsx::require_space(point, snapshot.expanded_bytes)?;
|
||||
let file = fs::OpenOptions::new().write(true).create_new(true).open(&path)?;
|
||||
let encoder = zstd::Encoder::new(BufWriter::new(file), 3)?;
|
||||
let mut archive = tar::Builder::new(encoder);
|
||||
for directory in &snapshot.directories {
|
||||
archive.append_dir(directory, fsx::ensure_within(source, &fsx::safe_join(source, directory)?)?)?;
|
||||
}
|
||||
for name in snapshot.files.keys() {
|
||||
let input = fsx::ensure_within(source, &fsx::safe_join(source, name)?)?;
|
||||
archive.append_file(name, &mut fs::File::open(input)?)?;
|
||||
}
|
||||
archive.into_inner()?.finish()?.flush()?;
|
||||
snapshot.archive_sha256 = Some(fsx::sha256_file(&path)?);
|
||||
snapshot.bytes = fs::metadata(path)?.len();
|
||||
Ok(())
|
||||
}
|
||||
|
||||
pub(crate) fn inventory(root: &Path) -> Result<BTreeMap<String, String>> {
|
||||
let canonical = fsx::canonicalize_lenient(root)?;
|
||||
let root = canonical.as_path();
|
||||
let mut files = BTreeMap::new();
|
||||
let mut directories = vec![root.to_path_buf()];
|
||||
while let Some(directory) = directories.pop() {
|
||||
for entry in fs::read_dir(directory)? {
|
||||
let entry = entry?;
|
||||
let metadata = fs::symlink_metadata(entry.path())?;
|
||||
let path = fsx::ensure_within(root, &entry.path())?;
|
||||
reject_link(&metadata)?;
|
||||
if metadata.is_dir() { directories.push(path); continue; }
|
||||
if !metadata.is_file() { return Err(Error::Invalid("Unsupported database snapshot file.".into())); }
|
||||
let relative = path.strip_prefix(root).map_err(|e| Error::Invalid(e.to_string()))?.to_string_lossy().replace('\\', "/");
|
||||
fsx::safe_join(root, &relative)?;
|
||||
if relative.ends_with(".isl") { return Err(Error::Invalid("External MySQL tablespaces require a separate recovery method.".into())); }
|
||||
files.insert(relative, fsx::sha256_file(&path)?);
|
||||
}
|
||||
}
|
||||
Ok(files)
|
||||
}
|
||||
|
||||
pub(crate) fn copy_verified(source: &Path, target: &Path, files: &BTreeMap<String, String>) -> Result<()> {
|
||||
if target.exists() { return Err(Error::Invalid("Database snapshot destination already exists.".into())); }
|
||||
let bytes = files.keys().try_fold(0u64, |total, name| -> Result<u64> {
|
||||
let path = fsx::ensure_within(source, &fsx::safe_join(source, name)?)?;
|
||||
total.checked_add(fs::metadata(path)?.len()).ok_or_else(|| Error::Invalid("Snapshot size overflow.".into()))
|
||||
})?;
|
||||
let parent = target.parent().ok_or_else(|| Error::Invalid("Invalid snapshot destination.".into()))?;
|
||||
fs::create_dir_all(parent)?;
|
||||
fsx::require_space(parent, bytes)?;
|
||||
fs::create_dir(target)?;
|
||||
for (relative, expected) in files {
|
||||
let source_file = fsx::ensure_within(source, &fsx::safe_join(source, relative)?)?;
|
||||
let target_file = fsx::ensure_within(target, &fsx::safe_join(target, relative)?)?;
|
||||
fs::create_dir_all(target_file.parent().unwrap())?;
|
||||
fs::copy(&source_file, &target_file)?;
|
||||
if fsx::sha256_file(&target_file)? != *expected { return Err(Error::Invalid(format!("Database snapshot file {relative} failed verification."))); }
|
||||
}
|
||||
if inventory(target)? != *files { return Err(Error::Invalid("Database snapshot inventory differs.".into())); }
|
||||
Ok(())
|
||||
}
|
||||
|
||||
pub(crate) fn stop(root: &Path) -> Result<()> {
|
||||
let observed = crate::process::observe(root, &crate::layout::read_ports(root));
|
||||
if [observed.mysql.state, observed.auth.state, observed.world.state].iter().all(|state| *state == crate::process::ServiceState::Stopped)
|
||||
&& !crate::multiworld::is_running(root) { return Ok(()); }
|
||||
let outcome = crate::driver::run(root, crate::driver::Verb::StopAll)?;
|
||||
let status = crate::process::observe(root, &crate::layout::read_ports(root));
|
||||
if !outcome.ok || [status.mysql.state, status.auth.state, status.world.state].iter().any(|state| *state != crate::process::ServiceState::Stopped)
|
||||
|| crate::multiworld::is_running(root) {
|
||||
return Err(Error::Invalid("The complete server must be stopped before copying or restoring MySQL.".into()));
|
||||
}
|
||||
Ok(())
|
||||
}
|
||||
|
||||
pub(crate) fn stop_previous_rehearsals(meta: &Path) -> Result<()> {
|
||||
let location = meta.join("rehearsals");
|
||||
if !location.exists() { return Ok(()); }
|
||||
for entry in fs::read_dir(&location)? {
|
||||
let entry = entry?;
|
||||
let name = entry.file_name().to_string_lossy().into_owned();
|
||||
if name.len() != 32 || !name.bytes().all(|byte| byte.is_ascii_hexdigit()) { continue; }
|
||||
let fixture = fsx::ensure_within(&location, &entry.path().join("server"))?;
|
||||
let metadata = crate::registry::metadata_dir_for(&fixture)?;
|
||||
if !metadata.join("install.json").is_file() { continue; }
|
||||
let (_, installed) = crate::registry::MetaDir::open(&metadata)?;
|
||||
if fsx::canonicalize_lenient(Path::new(&installed.server_path))? != fsx::canonicalize_lenient(&fixture)? {
|
||||
return Err(Error::Invalid("The interrupted rehearsal metadata does not match its private server.".into()));
|
||||
}
|
||||
stop(&fixture)?;
|
||||
}
|
||||
Ok(())
|
||||
}
|
||||
|
||||
pub(crate) fn capture(root: &Path, partial: &Path) -> Result<Snapshot> {
|
||||
if crate::docker::is_docker(root) || !cfg!(windows) { return Err(Error::Invalid("Cold MySQL snapshots require a Windows repack.".into())); }
|
||||
crate::backup::with_database(root, |db| {
|
||||
if db.query("SELECT COUNT(*) FROM performance_schema.replication_connection_configuration;")?.trim() != "0" {
|
||||
return Err(Error::Invalid("A replicated MySQL instance requires a separate isolated recovery method.".into()));
|
||||
}
|
||||
let data = fsx::ensure_within(root, &root.join("mysql/data"))?;
|
||||
for path in db.query("SELECT PATH FROM information_schema.INNODB_DATAFILES;")?.lines() {
|
||||
fsx::ensure_within(&data, &data.join(path))?;
|
||||
}
|
||||
Ok(())
|
||||
})?;
|
||||
stop(root)?;
|
||||
let data = fsx::ensure_within(root, &root.join("mysql/data"))?;
|
||||
if !data.join("mysql").is_dir() || !data.join("ibdata1").is_file() {
|
||||
return Err(Error::Invalid("The bundled MySQL data directory is incomplete.".into()));
|
||||
}
|
||||
let files = inventory(&data)?;
|
||||
let bytes = files.keys().try_fold(0u64, |total, file| -> Result<u64> {
|
||||
total.checked_add(fs::metadata(fsx::safe_join(&data, file)?)?.len()).ok_or_else(|| Error::Invalid("Snapshot size overflow.".into()))
|
||||
})?;
|
||||
let mut snapshot = Snapshot { path: "mysql-data".into(), files, directories:directories(&data)?, server_sha256: fsx::sha256_file(&root.join("mysql/bin/mysqld.exe"))?, bytes, expanded_bytes:bytes, archive_sha256:None };
|
||||
compress(&data, partial, &mut snapshot)?;
|
||||
verify(partial, &snapshot)?;
|
||||
Ok(snapshot)
|
||||
}
|
||||
|
||||
pub(crate) fn verify(point: &Path, snapshot: &Snapshot) -> Result<()> {
|
||||
if snapshot.files.is_empty() || snapshot.server_sha256.len() != 64 {
|
||||
return Err(Error::Invalid("Invalid cold MySQL recovery inventory.".into()));
|
||||
}
|
||||
let data = fsx::ensure_within(point, &fsx::safe_join(point, &snapshot.path)?)?;
|
||||
if let Some(hash) = &snapshot.archive_sha256 {
|
||||
if snapshot.path != "mysql-data.tar.zst" || snapshot.expanded_bytes == 0 || fsx::sha256_file(&data)? != *hash {
|
||||
return Err(Error::Invalid("The compressed MySQL recovery copy is damaged.".into()));
|
||||
}
|
||||
for name in snapshot.files.keys().chain(snapshot.directories.iter()) { fsx::safe_join(point, name)?; }
|
||||
return Ok(());
|
||||
}
|
||||
if snapshot.path != "mysql-data" { return Err(Error::Invalid("Unsupported MySQL recovery format.".into())); }
|
||||
if inventory(&data)? != snapshot.files { return Err(Error::Invalid("The cold MySQL recovery copy is damaged or incomplete.".into())); }
|
||||
if directories(&data)? != snapshot.directories { return Err(Error::Invalid("The cold MySQL recovery directories are incomplete.".into())); }
|
||||
Ok(())
|
||||
}
|
||||
|
||||
pub(crate) fn rehearsal_copy(root: &Path, meta: &Path, point: &Path, snapshot: &Snapshot) -> Result<PathBuf> {
|
||||
verify(point, snapshot)?;
|
||||
let canonical = fsx::canonicalize_lenient(root)?;
|
||||
let root = canonical.as_path();
|
||||
let destination = meta.join("rehearsals").join(uuid::Uuid::new_v4().simple().to_string()).join("server");
|
||||
let mut files = BTreeMap::new();
|
||||
let mut directories = vec![root.to_path_buf()];
|
||||
while let Some(directory) = directories.pop() {
|
||||
for entry in fs::read_dir(directory)? {
|
||||
let entry = entry?;
|
||||
let raw = entry.path();
|
||||
let relative = raw.strip_prefix(root).map_err(|e| Error::Invalid(e.to_string()))?.to_string_lossy().replace('\\', "/");
|
||||
let lower = relative.to_ascii_lowercase();
|
||||
let first = lower.split('/').next().unwrap();
|
||||
if entry.file_type()?.is_dir() && !relative.contains('/')
|
||||
&& !["core", "data", "scripts", "settings", "runtime", "mysql", ".realms", "bugreport", "extras", "licenses"].contains(&first) { continue; }
|
||||
if lower == "mysql/data" || lower.starts_with("mysql/data-")
|
||||
|| lower.split('/').any(|part| part == ".state")
|
||||
|| lower == "bugreport/reports" || lower == "core/logs" || lower == "mysql/logs" { continue; }
|
||||
let metadata = fs::symlink_metadata(&raw)?;
|
||||
reject_link(&metadata)?;
|
||||
let path = fsx::ensure_within(root, &raw)?;
|
||||
if metadata.is_dir() { directories.push(path); }
|
||||
else if metadata.is_file() { files.insert(relative, fsx::sha256_file(&path)?); }
|
||||
else { return Err(Error::Invalid("Unsupported rehearsal file.".into())); }
|
||||
}
|
||||
}
|
||||
copy_verified(root, &destination, &files)?;
|
||||
copy_snapshot(point, snapshot, &destination.join("mysql/data"))?;
|
||||
let (_, mut installed) = crate::registry::MetaDir::open(meta)?;
|
||||
installed.id = uuid::Uuid::new_v4().to_string();
|
||||
installed.server_path = destination.to_string_lossy().into_owned();
|
||||
installed.client_path = None;
|
||||
crate::registry::MetaDir::create(&destination, &installed)?;
|
||||
Ok(destination)
|
||||
}
|
||||
|
||||
pub(crate) fn isolate_connections(root: &Path) -> Result<()> {
|
||||
for relative in ["Settings/worldserver.conf.template", "Settings/authserver.conf.template", "Core/configs/worldserver.conf", "Core/configs/authserver.conf"] {
|
||||
let path = fsx::ensure_within(root, &root.join(relative))?;
|
||||
if !path.is_file() {
|
||||
if relative.ends_with(".template") { return Err(Error::Invalid("The private update copy lacks connection templates.".into())); }
|
||||
continue;
|
||||
}
|
||||
let mut config = crate::config::parser::ConfFile::parse_bytes(&fs::read(&path)?)?;
|
||||
for key in ["LoginDatabaseInfo", "WorldDatabaseInfo", "CharacterDatabaseInfo"] {
|
||||
if relative.contains("worldserver") || key == "LoginDatabaseInfo" {
|
||||
config.set(key, &format!("\"@{key}@\""), &[]);
|
||||
}
|
||||
}
|
||||
config.set("BindIP", "\"127.0.0.1\"", &[]);
|
||||
if relative.contains("worldserver") {
|
||||
config.set("Ra.IP", "\"127.0.0.1\"", &[]);
|
||||
config.set("DataDir", "\"@DATA@\"", &[]);
|
||||
}
|
||||
fsx::atomic_write(&path, config.to_text().as_bytes())?;
|
||||
}
|
||||
Ok(())
|
||||
}
|
||||
|
||||
pub(crate) fn unchanged(root: &Path, snapshot: &Snapshot) -> Result<()> {
|
||||
let data = fsx::ensure_within(root, &root.join("mysql/data"))?;
|
||||
if inventory(&data)? != snapshot.files || directories(&data)? != snapshot.directories {
|
||||
return Err(Error::Invalid("The installed database changed during the private rehearsal. Retry after stopping other database access.".into()));
|
||||
}
|
||||
Ok(())
|
||||
}
|
||||
|
||||
pub(crate) fn validate_connections(templates: &Path, installation: &Path) -> Result<()> {
|
||||
let port = crate::layout::read_ports(installation).mysql.to_string();
|
||||
let (_, password) = crate::db::credentials(installation)?;
|
||||
let realm = crate::realms::state(installation)?.active;
|
||||
for relative in ["Settings/worldserver.conf.template", "Settings/authserver.conf.template"] {
|
||||
let path = fsx::ensure_within(templates, &templates.join(relative))?;
|
||||
let config = crate::config::parser::ConfFile::parse_bytes(&fs::read(path)?)?;
|
||||
for (key, kind) in [("LoginDatabaseInfo", "auth"), ("WorldDatabaseInfo", "world"), ("CharacterDatabaseInfo", "characters")] {
|
||||
if relative.contains("authserver") && kind != "auth" { continue; }
|
||||
let value = config.get(key).ok_or_else(|| Error::Invalid(format!("The update cannot isolate the missing {key} connection.")))?.trim().trim_matches('"');
|
||||
if value == format!("@{key}@") { continue; }
|
||||
let fields: Vec<_> = value.split(';').collect();
|
||||
if fields.len() != 5 || !matches!(fields[0], "127.0.0.1" | "localhost") || fields[1] != port || fields[2] != "acore" || fields[3] != password || fields[4] != realm.schema(kind)? {
|
||||
return Err(Error::Invalid(format!("The {key} connection does not use this repack's bundled database. A private update cannot safely qualify an external database.")));
|
||||
}
|
||||
}
|
||||
}
|
||||
Ok(())
|
||||
}
|
||||
|
||||
// Keep the replaced data directory. If interrupted between renames, a retry can install a new verified copy.
|
||||
pub(crate) fn swap(root: &Path, meta: &Path, point: &Path, snapshot: &Snapshot, fail_after_move: bool) -> Result<PathBuf> {
|
||||
verify(point, snapshot)?;
|
||||
if fsx::sha256_file(&root.join("mysql/bin/mysqld.exe"))? != snapshot.server_sha256 {
|
||||
return Err(Error::Invalid("The MySQL executable differs from the recovery point.".into()));
|
||||
}
|
||||
let mysql = fsx::ensure_within(root, &root.join("mysql"))?;
|
||||
let token = uuid::Uuid::new_v4().simple().to_string();
|
||||
let staging = fsx::ensure_within(&mysql, &mysql.join(format!("data-restore-{token}")))?;
|
||||
let previous = fsx::ensure_within(&mysql, &mysql.join(format!("data-before-restore-{token}")))?;
|
||||
let live = fsx::ensure_within(&mysql, &mysql.join("data"))?;
|
||||
copy_snapshot(point, snapshot, &staging)?;
|
||||
let journal = meta.join("diagnostics").join(format!("database-restore-{token}.json"));
|
||||
fsx::atomic_write_json(&journal, &serde_json::json!({"schema":1,"state":"prepared","previous":previous,"staging":staging}))?;
|
||||
if live.exists() { fs::rename(&live, &previous)?; }
|
||||
if fail_after_move { return Err(Error::Invalid("Simulated interruption after saving the previous MySQL directory.".into())); }
|
||||
fs::rename(&staging, &live)?;
|
||||
fsx::atomic_write_json(&journal, &serde_json::json!({"schema":1,"state":"restored","previous":previous}))?;
|
||||
Ok(previous)
|
||||
}
|
||||
|
||||
#[cfg(test)]
|
||||
mod tests {
|
||||
use super::*;
|
||||
#[cfg(windows)]
|
||||
#[test]
|
||||
#[ignore = "requires COA_MYSQL_TEST_BIN pointing to the bundled MySQL tools"]
|
||||
fn real_mysql_restores_objects_users_rows_and_missing_defaults() {
|
||||
use std::process::{Child, Command, Stdio};
|
||||
use std::os::windows::process::CommandExt;
|
||||
struct Server(Child);
|
||||
impl Drop for Server { fn drop(&mut self) { let _ = self.0.kill(); let _ = self.0.wait(); } }
|
||||
let bin = PathBuf::from(std::env::var("COA_MYSQL_TEST_BIN").unwrap());
|
||||
let temp = tempfile::tempdir().unwrap();
|
||||
let root = temp.path().join("server");
|
||||
let meta = temp.path().join("metadata");
|
||||
let point = temp.path().join("point");
|
||||
copy_verified(&bin, &root.join("mysql/bin"), &inventory(&bin).unwrap()).unwrap();
|
||||
let data = root.join("mysql/data");
|
||||
let executable = root.join("mysql/bin/mysqld.exe");
|
||||
let initialized = Command::new(&executable).args(["--no-defaults", "--initialize-insecure"])
|
||||
.arg(format!("--datadir={}", data.display())).creation_flags(0x0800_0000).output().unwrap();
|
||||
assert!(initialized.status.success(), "{}", String::from_utf8_lossy(&initialized.stderr));
|
||||
let port = crate::install::free_port().unwrap();
|
||||
fsx::atomic_write_json(&root.join("Settings/repack.json"), &serde_json::json!({"mysqlPort":port})).unwrap();
|
||||
fsx::atomic_write_json(&root.join("Settings/database.json"), &serde_json::json!({"rootPassword":"","appPassword":""})).unwrap();
|
||||
let db = crate::db::Db::from_repack(&root, crate::db::Account::Admin).unwrap();
|
||||
let start = || {
|
||||
let server = Server(Command::new(&executable).args(["--no-defaults", "--bind-address=127.0.0.1", "--mysqlx=0", "--skip-log-bin"])
|
||||
.arg(format!("--datadir={}", data.display())).arg(format!("--port={port}"))
|
||||
.arg(format!("--log-error={}", root.join("mysql-test.log").display()))
|
||||
.stdout(Stdio::null()).stderr(Stdio::null()).creation_flags(0x0800_0000).spawn().unwrap());
|
||||
let deadline = std::time::Instant::now() + std::time::Duration::from_secs(60);
|
||||
while !db.ping() { assert!(std::time::Instant::now() < deadline, "{}", fs::read_to_string(root.join("mysql-test.log")).unwrap_or_default()); std::thread::sleep(std::time::Duration::from_millis(200)); }
|
||||
server
|
||||
};
|
||||
let mut server = start();
|
||||
db.query("CREATE DATABASE acore_characters; CREATE DATABASE acore_world; CREATE DATABASE acore_auth; CREATE TABLE acore_characters.probe(id INT PRIMARY KEY, note VARCHAR(40)); CREATE TABLE acore_world.probe(id INT NOT NULL DEFAULT 0); INSERT INTO acore_world.probe VALUES(43); CREATE TABLE acore_auth.probe(id INT); INSERT INTO acore_auth.probe VALUES(44); CREATE USER 'fixture_user'@'localhost' IDENTIFIED BY 'fixture'; CREATE TRIGGER acore_characters.probe_insert BEFORE INSERT ON acore_characters.probe FOR EACH ROW SET NEW.note='triggered'; INSERT INTO acore_characters.probe VALUES(42,'original'); CREATE VIEW acore_characters.probe_view AS SELECT c.id,w.id AS world_id FROM acore_characters.probe c CROSS JOIN acore_world.probe w; CREATE PROCEDURE acore_characters.probe_proc() SELECT id FROM acore_characters.probe; CREATE FUNCTION acore_characters.probe_func() RETURNS INT DETERMINISTIC RETURN 73;").unwrap();
|
||||
assert_eq!(db.recovery_objects("acore_characters").unwrap().len(), 4);
|
||||
crate::schema_check::capture(&db, &root).unwrap();
|
||||
let hash = fsx::sha256_file(&root.join(crate::schema_check::CONTRACT)).unwrap();
|
||||
db.query("ALTER TABLE acore_world.probe ALTER COLUMN id DROP DEFAULT;").unwrap();
|
||||
crate::schema_check::repair_missing_defaults(&db, &root, Some(&hash)).unwrap();
|
||||
assert_eq!(db.query("SELECT COLUMN_DEFAULT FROM information_schema.COLUMNS WHERE TABLE_SCHEMA='acore_world' AND TABLE_NAME='probe' AND COLUMN_NAME='id';").unwrap(), "0");
|
||||
assert_eq!(db.query("SELECT id FROM acore_world.probe;").unwrap(), "43");
|
||||
db.query("ALTER TABLE acore_world.probe ALTER COLUMN id SET DEFAULT 99;").unwrap();
|
||||
crate::schema_check::repair_missing_defaults(&db, &root, Some(&hash)).unwrap();
|
||||
assert_eq!(db.query("SELECT COLUMN_DEFAULT FROM information_schema.COLUMNS WHERE TABLE_SCHEMA='acore_world' AND TABLE_NAME='probe' AND COLUMN_NAME='id';").unwrap(), "99");
|
||||
db.query("SHUTDOWN;").unwrap(); server.0.wait().unwrap();
|
||||
let files = inventory(&data).unwrap();
|
||||
copy_verified(&data, &point.join("mysql-data"), &files).unwrap();
|
||||
let expanded_bytes = files.keys().map(|name| fs::metadata(data.join(name)).unwrap().len()).sum();
|
||||
let mut snapshot = Snapshot {path:"mysql-data".into(), files, directories:directories(&data).unwrap(), server_sha256:fsx::sha256_file(&executable).unwrap(), bytes:0, expanded_bytes, archive_sha256:None};
|
||||
for directory in &snapshot.directories { fs::create_dir_all(point.join("mysql-data").join(directory)).unwrap(); }
|
||||
compress(&data, &point, &mut snapshot).unwrap();
|
||||
let mut changed = start();
|
||||
db.query("DROP VIEW acore_characters.probe_view; DROP TRIGGER acore_characters.probe_insert; DROP PROCEDURE acore_characters.probe_proc; DROP FUNCTION acore_characters.probe_func; DELETE FROM acore_characters.probe; DROP USER 'fixture_user'@'localhost';").unwrap();
|
||||
db.query("SHUTDOWN;").unwrap(); changed.0.wait().unwrap();
|
||||
swap(&root, &meta, &point, &snapshot, false).unwrap();
|
||||
let mut restored = start();
|
||||
assert_eq!(db.recovery_objects("acore_characters").unwrap().len(), 4);
|
||||
assert_eq!(db.query("SELECT * FROM acore_characters.probe_view; CALL acore_characters.probe_proc(); SELECT acore_characters.probe_func(); SELECT COUNT(*) FROM mysql.user WHERE user='fixture_user';").unwrap().replace("\r\n", "\n"), "42\t43\n42\n73\n1");
|
||||
db.query("INSERT INTO acore_characters.probe VALUES(45,'check');").unwrap();
|
||||
assert_eq!(db.query("SELECT note FROM acore_characters.probe WHERE id=45;").unwrap(), "triggered");
|
||||
db.query("SHUTDOWN;").unwrap(); restored.0.wait().unwrap();
|
||||
}
|
||||
fn fixture() -> (tempfile::TempDir, PathBuf, PathBuf, PathBuf, Snapshot) {
|
||||
let temp = tempfile::tempdir().unwrap();
|
||||
let root = temp.path().join("server");
|
||||
let meta = temp.path().join("metadata");
|
||||
let point = temp.path().join("point");
|
||||
fsx::atomic_write(&root.join("mysql/bin/mysqld.exe"), b"same-engine").unwrap();
|
||||
fsx::atomic_write(&root.join("mysql/data/characters.ibd"), b"live").unwrap();
|
||||
fsx::atomic_write(&point.join("mysql-data/characters.ibd"), b"saved").unwrap();
|
||||
fs::create_dir_all(point.join("mysql-data/empty_schema")).unwrap();
|
||||
let snapshot = Snapshot { path:"mysql-data".into(), files:inventory(&point.join("mysql-data")).unwrap(), directories:directories(&point.join("mysql-data")).unwrap(), server_sha256:fsx::sha256_file(&root.join("mysql/bin/mysqld.exe")).unwrap(), bytes:5, expanded_bytes:5, archive_sha256:None };
|
||||
(temp, root, meta, point, snapshot)
|
||||
}
|
||||
#[test]
|
||||
fn interrupted_directory_swap_is_recoverable_and_keeps_previous_bytes() {
|
||||
let (_temp, root, meta, point, snapshot) = fixture();
|
||||
assert!(swap(&root, &meta, &point, &snapshot, true).is_err());
|
||||
assert!(!root.join("mysql/data").exists());
|
||||
let old = fs::read_dir(root.join("mysql")).unwrap().flatten().find(|e| e.file_name().to_string_lossy().starts_with("data-before-")).unwrap().path();
|
||||
assert_eq!(fs::read(old.join("characters.ibd")).unwrap(), b"live");
|
||||
swap(&root, &meta, &point, &snapshot, false).unwrap();
|
||||
assert_eq!(fs::read(root.join("mysql/data/characters.ibd")).unwrap(), b"saved");
|
||||
assert!(root.join("mysql/data/empty_schema").is_dir());
|
||||
}
|
||||
#[test]
|
||||
fn corrupt_or_different_engine_snapshots_do_not_move_live_data() {
|
||||
let (_temp, root, meta, point, snapshot) = fixture();
|
||||
fsx::atomic_write(&point.join("mysql-data/characters.ibd"), b"corrupt").unwrap();
|
||||
assert!(swap(&root, &meta, &point, &snapshot, false).is_err());
|
||||
assert_eq!(fs::read(root.join("mysql/data/characters.ibd")).unwrap(), b"live");
|
||||
fsx::atomic_write(&point.join("mysql-data/characters.ibd"), b"saved").unwrap();
|
||||
fsx::atomic_write(&root.join("mysql/bin/mysqld.exe"), b"new-engine").unwrap();
|
||||
assert!(swap(&root, &meta, &point, &snapshot, false).is_err());
|
||||
assert_eq!(fs::read(root.join("mysql/data/characters.ibd")).unwrap(), b"live");
|
||||
}
|
||||
#[test]
|
||||
fn compressed_snapshots_verify_every_file_and_reject_unlisted_entries() {
|
||||
let (_temp, root, meta, point, mut snapshot) = fixture();
|
||||
let source = point.join("mysql-data");
|
||||
compress(&source, &point, &mut snapshot).unwrap();
|
||||
assert!(snapshot.archive_sha256.is_some());
|
||||
swap(&root, &meta, &point, &snapshot, false).unwrap();
|
||||
assert_eq!(fs::read(root.join("mysql/data/characters.ibd")).unwrap(), b"saved");
|
||||
fsx::atomic_write(&root.join("mysql/data/characters.ibd"), b"preserve").unwrap();
|
||||
let archive_path = point.join(&snapshot.path);
|
||||
let encoder = zstd::Encoder::new(fs::File::create(&archive_path).unwrap(), 3).unwrap();
|
||||
let mut archive = tar::Builder::new(encoder);
|
||||
archive.append_file("unlisted.ibd", &mut fs::File::open(source.join("characters.ibd")).unwrap()).unwrap();
|
||||
archive.into_inner().unwrap().finish().unwrap();
|
||||
snapshot.archive_sha256 = Some(fsx::sha256_file(&archive_path).unwrap());
|
||||
assert!(swap(&root, &meta, &point, &snapshot, false).is_err());
|
||||
assert_eq!(fs::read(root.join("mysql/data/characters.ibd")).unwrap(), b"preserve");
|
||||
fsx::atomic_write(&archive_path, b"damaged").unwrap();
|
||||
assert!(verify(&point, &snapshot).is_err());
|
||||
}
|
||||
#[test]
|
||||
fn private_rehearsals_reject_external_database_connections() {
|
||||
let (_temp, root, _meta, _point, _snapshot) = fixture();
|
||||
fsx::atomic_write_json(&root.join("Settings/repack.json"), &serde_json::json!({"mysqlPort":3307})).unwrap();
|
||||
fsx::atomic_write_json(&root.join("Settings/database.json"), &serde_json::json!({"rootPassword":"test-root","appPassword":"test-app"})).unwrap();
|
||||
fsx::atomic_write(&root.join("Settings/worldserver.conf.template"), b"LoginDatabaseInfo = \"@LoginDatabaseInfo@\"\nWorldDatabaseInfo = \"@WorldDatabaseInfo@\"\nCharacterDatabaseInfo = \"@CharacterDatabaseInfo@\"\n").unwrap();
|
||||
fsx::atomic_write(&root.join("Settings/authserver.conf.template"), b"LoginDatabaseInfo = \"127.0.0.1;3307;acore;test-app;acore_auth\"\n").unwrap();
|
||||
validate_connections(&root, &root).unwrap();
|
||||
fsx::atomic_write(&root.join("Settings/authserver.conf.template"), b"LoginDatabaseInfo = \"192.0.2.1;3307;acore;test-app;acore_auth\"\n").unwrap();
|
||||
let error = validate_connections(&root, &root).unwrap_err().to_string();
|
||||
assert!(error.contains("external database"));
|
||||
assert!(!error.contains("test-app"));
|
||||
}
|
||||
#[test]
|
||||
fn a_changed_live_database_invalidates_the_rehearsal() {
|
||||
let (_temp, root, _meta, _point, snapshot) = fixture();
|
||||
assert!(unchanged(&root, &snapshot).is_err());
|
||||
fsx::atomic_write(&root.join("mysql/data/characters.ibd"), b"saved").unwrap();
|
||||
fs::create_dir_all(root.join("mysql/data/empty_schema")).unwrap();
|
||||
unchanged(&root, &snapshot).unwrap();
|
||||
fsx::atomic_write(&root.join("mysql/data/extra.ibd"), b"new data").unwrap();
|
||||
assert!(unchanged(&root, &snapshot).is_err());
|
||||
}
|
||||
|
||||
#[test]
|
||||
fn rehearsal_copy_succeeds_with_nested_directories_and_unnormalized_root() {
|
||||
let (_temp, root, meta, point, snapshot) = fixture();
|
||||
let meta_obj = crate::registry::InstallMeta::new(crate::registry::InstallKind::New, &root);
|
||||
fsx::atomic_write_json(&meta.join("install.json"), &meta_obj).unwrap();
|
||||
fsx::atomic_write(&root.join("Core/worldserver.exe"), b"exe").unwrap();
|
||||
fsx::atomic_write(&root.join("Core/configs/worldserver.conf"), b"conf").unwrap();
|
||||
fsx::atomic_write(&root.join("Settings/repack.json"), b"{}").unwrap();
|
||||
let dest = rehearsal_copy(&root, &meta, &point, &snapshot).unwrap();
|
||||
assert_eq!(fs::read(dest.join("Core/configs/worldserver.conf")).unwrap(), b"conf");
|
||||
assert_eq!(fs::read(dest.join("mysql/data/characters.ibd")).unwrap(), b"saved");
|
||||
}
|
||||
}
|
||||
@@ -217,6 +217,7 @@ pub fn build(src: &Path, out: &Path, opts: &BuildOptions, progress: &dyn Fn(&str
|
||||
split.close_current()?;
|
||||
|
||||
let manifest = Manifest {
|
||||
compatibility: None,
|
||||
schema: crate::manifest::SCHEMA,
|
||||
kind: opts.kind,
|
||||
version: opts.version.clone(),
|
||||
@@ -503,6 +504,7 @@ mod tests {
|
||||
fs::write(d.path().join(name), &bytes).unwrap();
|
||||
let ok_sha = fsx::sha256_bytes(b"data");
|
||||
let m = Manifest {
|
||||
compatibility: None,
|
||||
schema: 1,
|
||||
kind: Kind::Base,
|
||||
version: "0.1.0".into(),
|
||||
|
||||
@@ -71,7 +71,15 @@ pub fn hardware() -> Hardware {
|
||||
|
||||
#[cfg(not(windows))]
|
||||
pub fn hardware() -> Hardware {
|
||||
Hardware { cores: std::thread::available_parallelism().map(|n| n.get() as u32).unwrap_or(2), ram_gb: 8.0, free_ram_gb: 4.0 }
|
||||
let (total, free) = std::fs::read_to_string("/proc/meminfo").ok().and_then(|t| parse_meminfo(&t)).unwrap_or((8.0, 4.0));
|
||||
Hardware { cores: std::thread::available_parallelism().map(|n| n.get() as u32).unwrap_or(2), ram_gb: total, free_ram_gb: free }
|
||||
}
|
||||
|
||||
/// (total, available) memory in GB from the text of `/proc/meminfo`.
|
||||
#[cfg(not(windows))]
|
||||
fn parse_meminfo(text: &str) -> Option<(f64, f64)> {
|
||||
let kb = |key: &str| -> Option<f64> { text.lines().find_map(|l| l.strip_prefix(key)?.trim().strip_suffix("kB")?.trim().parse::<f64>().ok()) };
|
||||
Some((kb("MemTotal:")? / (1u64 << 20) as f64, kb("MemAvailable:")? / (1u64 << 20) as f64))
|
||||
}
|
||||
|
||||
#[derive(Debug, Clone, Serialize)]
|
||||
@@ -105,6 +113,16 @@ pub fn sizes(h: &Hardware) -> Vec<SizeOption> {
|
||||
mod tests {
|
||||
use super::*;
|
||||
|
||||
#[cfg(not(windows))]
|
||||
#[test]
|
||||
fn memory_is_read_from_proc_meminfo() {
|
||||
let t = "MemTotal: 65536000 kB\nMemFree: 1000000 kB\nMemAvailable: 16777216 kB\nBuffers: 1 kB\n";
|
||||
let (total, free) = parse_meminfo(t).unwrap();
|
||||
assert!((total - 62.5).abs() < 0.01 && (free - 16.0).abs() < 0.01, "{total} {free}");
|
||||
assert!(parse_meminfo("nothing useful").is_none());
|
||||
assert!(hardware().ram_gb > 0.0);
|
||||
}
|
||||
|
||||
#[test]
|
||||
fn parses_counts_and_never_goes_negative() {
|
||||
let p = parse_counts("12\t9\t400").unwrap();
|
||||
|
||||
@@ -44,8 +44,17 @@ fn introduction_rank(repo: &Path, pathspecs: &[&str]) -> std::collections::HashM
|
||||
rank
|
||||
}
|
||||
|
||||
/// Every SQL script of a core checkout (released + pending updates, module base and update scripts), in application order.
|
||||
/// Incremental SQL of a core checkout. Installation-only module bases must never be replayed on a live database.
|
||||
pub fn collect_core_sql(core: &Path) -> Result<Vec<SqlFile>> {
|
||||
collect_core_sql_mode(core, false)
|
||||
}
|
||||
|
||||
/// A clean installation also needs the module tables and initial seed data.
|
||||
pub fn collect_core_install_sql(core: &Path) -> Result<Vec<SqlFile>> {
|
||||
collect_core_sql_mode(core, true)
|
||||
}
|
||||
|
||||
fn collect_core_sql_mode(core: &Path, include_base: bool) -> Result<Vec<SqlFile>> {
|
||||
let mut out = Vec::new();
|
||||
let mut push = |db: &str, id: String, abs: PathBuf, origin: String| -> Result<()> {
|
||||
let sha256 = fsx::sha256_file(&abs)?;
|
||||
@@ -69,7 +78,7 @@ pub fn collect_core_sql(core: &Path) -> Result<Vec<SqlFile>> {
|
||||
let mname = name.replace('-', "_");
|
||||
for kind in ["auth", "characters", "world"] {
|
||||
let base = m.path().join(format!("data/sql/db-{kind}"));
|
||||
for f in sql_in(&base.join("base")) {
|
||||
for f in if include_base { sql_in(&base.join("base")) } else { vec![] } {
|
||||
let stem = f.file_stem().unwrap().to_string_lossy().into_owned();
|
||||
let rel = format!("modules/{name}/data/sql/db-{kind}/base/{}", f.file_name().unwrap().to_string_lossy());
|
||||
push(kind, format!("mod_{mname}__base__{stem}"), f, rel)?;
|
||||
@@ -144,6 +153,9 @@ fn walk(root: &Path, dir: &Path, out: &mut Vec<String>) -> Result<()> {
|
||||
|
||||
/// Build a cumulative update: every file of `tree` that differs from the base, plus every SQL script. Unsigned.
|
||||
pub fn pack_update(p: &UpdateParams, progress: &dyn Fn(&str)) -> Result<Manifest> {
|
||||
if let Some(file) = p.sql.iter().find(|file| file.id.starts_with("mod_") && file.id.contains("__base__")) {
|
||||
return Err(Error::Invalid(format!("Module installation SQL {} cannot be included in an update package.", file.id)));
|
||||
}
|
||||
let base: BTreeMap<String, &str> = p.base_manifest.files.iter().map(|f| (f.path.to_lowercase(), f.sha256.as_str())).collect();
|
||||
let work = p.out.with_file_name(format!("{}-staging", p.out.file_name().unwrap().to_string_lossy()));
|
||||
let _ = fs::remove_dir_all(&work);
|
||||
@@ -218,7 +230,7 @@ mod tests {
|
||||
write(c, "data/sql/updates/db_characters/2026_01_02_00.sql", "SELECT 3;");
|
||||
write(c, "modules/mod-x/data/sql/db-world/base/01_a.sql", "SELECT 4;");
|
||||
write(c, "modules/mod-x/data/sql/db-world/2026_02_02_00_b.sql", "SELECT 5;");
|
||||
let v = collect_core_sql(c).unwrap();
|
||||
let v = collect_core_install_sql(c).unwrap();
|
||||
let ids: Vec<(&str, &str)> = v.iter().map(|f| (f.db.as_str(), f.id.as_str())).collect();
|
||||
assert!(ids.contains(&("world", "2026_01_01_00")) && ids.contains(&("world", "rev_1")) && ids.contains(&("characters", "2026_01_02_00")));
|
||||
assert!(ids.contains(&("world", "mod_mod_x__base__01_a")) && ids.contains(&("world", "mod_mod_x__2026_02_02_00_b")));
|
||||
@@ -226,6 +238,27 @@ mod tests {
|
||||
let base_pos = ids.iter().position(|x| x.1 == "mod_mod_x__base__01_a").unwrap();
|
||||
let upd_pos = ids.iter().position(|x| x.1 == "mod_mod_x__2026_02_02_00_b").unwrap();
|
||||
assert!(base_pos < upd_pos, "a module's base script precedes its updates");
|
||||
let updates = collect_core_sql(c).unwrap();
|
||||
assert!(!updates.iter().any(|f| f.id.contains("__base__")));
|
||||
assert!(updates.iter().any(|f| f.id == "mod_mod_x__2026_02_02_00_b"));
|
||||
}
|
||||
|
||||
#[test]
|
||||
fn update_packaging_rejects_module_seed_sql_before_creating_output() {
|
||||
let d = tempfile::tempdir().unwrap();
|
||||
let base: Manifest = serde_json::from_value(serde_json::json!({
|
||||
"schema": 1, "kind": "base", "version": "1.0.0", "core": {"commit": null},
|
||||
"builtAt": "test", "minManagerVersion": "0.1.0", "files": []
|
||||
})).unwrap();
|
||||
let out = d.path().join("out");
|
||||
let sql = vec![SqlFile { db: "world".into(), id: "mod_mod_raid__base__03_boss_schedule".into(),
|
||||
origin: "modules/mod-raid/data/sql/db-world/base/03_boss_schedule.sql".into(),
|
||||
abs: d.path().join("seed.sql"), sha256: "a".repeat(64) }];
|
||||
let result = pack_update(&UpdateParams { tree: d.path(), base_manifest: &base, sql: &sql,
|
||||
out: &out, version: "1.1.0".into(), core_commit: None, bots_commit: None, part_size: 1024 }, &|_| {});
|
||||
assert!(result.unwrap_err().to_string().contains("installation SQL"));
|
||||
assert!(!out.exists());
|
||||
assert!(!d.path().join("out-staging").exists());
|
||||
}
|
||||
|
||||
#[test]
|
||||
|
||||
@@ -5,6 +5,90 @@ use crate::{backup, fsx, install, manifest::{Kind, Migration}, migrations, packa
|
||||
|
||||
const MARKER: &str = ".release-schema-fixture";
|
||||
|
||||
struct QualificationEnv<'a>(crate::update::RepackEnv<'a>);
|
||||
|
||||
impl crate::update::Env for QualificationEnv<'_> {
|
||||
fn activate(&self) -> Result<()> { Ok(()) }
|
||||
fn ensure_stopped(&self) -> Result<()> { self.0.ensure_stopped() }
|
||||
fn preflight(&self, manifest: &crate::manifest::Manifest) -> Result<()> { self.0.preflight(manifest) }
|
||||
fn snapshot(&self) -> Result<String> { self.0.snapshot() }
|
||||
fn verify_snapshot(&self, id: &str) -> Result<()> { self.0.verify_snapshot(id) }
|
||||
fn rehearse(&self, manifest: &crate::manifest::Manifest, tree: &Path, items: &[crate::update::PlanItem], point: &str) -> Result<()> { self.0.rehearse(manifest, tree, items, point) }
|
||||
fn restore_snapshot(&self, id: &str) -> Result<()> { self.0.restore_snapshot(id) }
|
||||
fn migrate(&self, manifest: &crate::manifest::Manifest, staged: &Path) -> Result<crate::migrations::ApplyReport> { self.0.migrate(manifest, staged) }
|
||||
fn validate(&self) -> Result<()> { self.0.validate() }
|
||||
fn validate_recovery(&self) -> Result<()> { self.0.validate_recovery() }
|
||||
fn recover_validation(&self) -> Result<()> { self.0.recover_validation() }
|
||||
fn automatic_rollback(&self) -> bool { true }
|
||||
// Health checks use the normal private validation; qualification never opens game ports after commit.
|
||||
}
|
||||
|
||||
pub fn qualify_upgrade(base: &Path, source: &Path, candidate: &Path, fixture: &Path, trusted_key: &str) -> Result<serde_json::Value> {
|
||||
use crate::update::Env;
|
||||
if !cfg!(windows) { return Err(Error::Invalid("Manager upgrade qualification requires a Windows fixture.".into())); }
|
||||
if fixture.exists() || !fixture.file_name().is_some_and(|name| name.to_string_lossy().starts_with("coa-schema-fixture-")) {
|
||||
return Err(Error::Invalid("Upgrade qualification requires a new disposable coa-schema-fixture-* directory.".into()));
|
||||
}
|
||||
let fixture_root = std::path::absolute(fixture)?;
|
||||
let fixture = fixture_root.as_path();
|
||||
let base_root = fsx::canonicalize_lenient(base)?;
|
||||
let base = base_root.as_path();
|
||||
let source_root = fsx::canonicalize_lenient(source)?;
|
||||
let source = source_root.as_path();
|
||||
let candidate_root = fsx::canonicalize_lenient(candidate)?;
|
||||
let candidate = candidate_root.as_path();
|
||||
let metadata = crate::registry::metadata_dir_for(fixture)?;
|
||||
if metadata.exists() { return Err(Error::Invalid("Upgrade fixture metadata already exists.".into())); }
|
||||
let (base_manifest, base_bytes) = pkgsource::fetch_manifest(&pkgsource::Source::Dir(base.into()), trusted_key)?;
|
||||
let (source_manifest, source_bytes) = pkgsource::fetch_manifest(&pkgsource::Source::Dir(source.into()), trusted_key)?;
|
||||
let (candidate_manifest, _) = pkgsource::fetch_manifest(&pkgsource::Source::Dir(candidate.into()), trusted_key)?;
|
||||
if candidate_manifest.kind != Kind::Update || !matches!(source_manifest.kind, Kind::Base | Kind::Update)
|
||||
|| (source_manifest.kind == Kind::Base && fsx::sha256_bytes(&base_bytes) != fsx::sha256_bytes(&source_bytes)) {
|
||||
return Err(Error::Invalid("Invalid source or candidate package for upgrade qualification.".into()));
|
||||
}
|
||||
extract_base(base, fixture, trusted_key)?;
|
||||
package::extract_selected(base, &base_manifest, fixture, &|path| path.starts_with("Data/"), &|_, _| {})?;
|
||||
let mut meta = crate::registry::InstallMeta::new(crate::registry::InstallKind::New, fixture);
|
||||
meta.core.version = Some(base_manifest.version.clone());
|
||||
meta.core.commit = base_manifest.core.commit.clone();
|
||||
meta.original_hashes = base_manifest.files.iter().map(|file| (file.path.clone(), file.sha256.clone())).collect();
|
||||
crate::registry::MetaDir::create(fixture, &meta)?;
|
||||
let env = QualificationEnv(crate::update::RepackEnv { root: fixture, meta_dir: &metadata });
|
||||
let apply = |package: &Path| -> Result<()> {
|
||||
let outcome = crate::update::apply(&crate::update::Params {
|
||||
root: fixture, meta_dir: &metadata, source: pkgsource::Source::Dir(package.into()),
|
||||
trusted_key, cancel: crate::download::Cancel::default(), resolutions: Default::default(),
|
||||
env: &env, fail_after_ops: None,
|
||||
}, &|_, _| {})?;
|
||||
if outcome.txn.state != crate::update::State::Committed {
|
||||
return Err(Error::Invalid("Upgrade qualification did not commit.".into()));
|
||||
}
|
||||
env.ensure_stopped()
|
||||
};
|
||||
install::with_scratch_ports(fixture, || {
|
||||
if source_manifest.kind == Kind::Update { apply(source)?; }
|
||||
let user_file = fixture.join("Core/configs/coa-qualification-user.conf");
|
||||
let user_bytes = b"Qualification.UserSetting = 7391\r\n";
|
||||
fsx::atomic_write(&user_file, user_bytes)?;
|
||||
apply(candidate)?;
|
||||
if std::fs::read(&user_file)?.as_slice() != user_bytes {
|
||||
return Err(Error::Invalid("The update changed a user configuration file.".into()));
|
||||
}
|
||||
let (_, installed) = crate::registry::MetaDir::open(&metadata)?;
|
||||
if installed.core.version.as_deref() != Some(candidate_manifest.version.as_str())
|
||||
|| crate::update_isolation::pending(&metadata) || crate::update::pending_checked(&metadata)?.is_some() {
|
||||
return Err(Error::Invalid("The update left inconsistent metadata or an unfinished transaction.".into()));
|
||||
}
|
||||
Ok(())
|
||||
})?;
|
||||
Ok(serde_json::json!({
|
||||
"schema": 1, "result": "passed", "fromVersion": source_manifest.version,
|
||||
"toVersion": candidate_manifest.version, "fromManifestSha256": fsx::sha256_bytes(&source_bytes),
|
||||
"fromSchemaSha256": source_manifest.files.iter().find(|file| file.path == schema_check::CONTRACT).map(|file| &file.sha256),
|
||||
"checks": ["manager-transaction", "private-user-database-rehearsal", "database-schema", "private-auth-world-startup", "existing-identities", "user-file-preservation"],
|
||||
}))
|
||||
}
|
||||
|
||||
pub fn collect(core: &Path, bots: Option<&Path>, repairs: Option<&Path>) -> Result<Vec<SqlFile>> {
|
||||
let mut files = release::collect_core_sql(core)?;
|
||||
if let Some(bots) = bots { files.extend(release::collect_bots_sql(bots)?); }
|
||||
@@ -72,6 +156,69 @@ pub fn capture_release(fixture: &Path, tree: &Path, sql: &[SqlFile]) -> Result<(
|
||||
}))
|
||||
}
|
||||
|
||||
pub fn validate_startup(fixture: &Path, tree: &Path, base: &Path, trusted_key: &str) -> Result<()> {
|
||||
use crate::update::Env;
|
||||
if !cfg!(windows) {
|
||||
return Err(Error::Invalid("Repack startup qualification requires a Windows runner.".into()));
|
||||
}
|
||||
if !fixture.file_name().is_some_and(|n| n.to_string_lossy().starts_with("coa-schema-fixture-"))
|
||||
|| std::fs::read(fixture.join(MARKER)).ok().as_deref() != Some(b"disposable release-schema fixture") {
|
||||
return Err(Error::Invalid("Startup qualification requires a disposable release-schema fixture.".into()));
|
||||
}
|
||||
let fixture_root = fsx::canonicalize_lenient(fixture)?;
|
||||
let fixture = fixture_root.as_path();
|
||||
let tree_root = fsx::canonicalize_lenient(tree)?;
|
||||
let tree = tree_root.as_path();
|
||||
let metadata = crate::registry::metadata_dir_for(fixture)?;
|
||||
if metadata.exists() { return Err(Error::Invalid("Startup fixture already has Manager metadata; use a fresh fixture.".into())); }
|
||||
schema_check::require_release_contract(tree)?;
|
||||
for name in ["worldserver.exe", "authserver.exe"] {
|
||||
if !tree.join("Core").join(name).is_file() {
|
||||
return Err(Error::Invalid(format!("Startup candidate is missing {name}.")));
|
||||
}
|
||||
}
|
||||
let (manifest, _) = pkgsource::fetch_manifest(&pkgsource::Source::Dir(base.into()), trusted_key)?;
|
||||
if manifest.kind != Kind::Base { return Err(Error::Invalid("Startup qualification requires a signed base package.".into())); }
|
||||
let mut directories = vec![tree.to_path_buf()];
|
||||
let mut files = Vec::new();
|
||||
while let Some(directory) = directories.pop() {
|
||||
for entry in std::fs::read_dir(directory)? {
|
||||
let entry = entry?;
|
||||
let kind = entry.file_type()?;
|
||||
if kind.is_symlink() { return Err(Error::Invalid("Startup release tree must not contain symbolic links.".into())); }
|
||||
let path = entry.path();
|
||||
fsx::ensure_within(tree, &path)?;
|
||||
if kind.is_dir() { directories.push(path); continue; }
|
||||
if !kind.is_file() { return Err(Error::Invalid("Startup release tree contains an unsupported file type.".into())); }
|
||||
let relative = path.strip_prefix(tree).map_err(|e| Error::Invalid(e.to_string()))?.to_path_buf();
|
||||
let first = relative.components().next().unwrap().as_os_str().to_string_lossy();
|
||||
if !matches!(first.as_ref(), "Core" | "Scripts" | "Data" | "Extras" | "Licenses") {
|
||||
return Err(Error::Invalid("Startup release tree contains installation-specific files.".into()));
|
||||
}
|
||||
fsx::ensure_within(fixture, &fixture.join(&relative))?;
|
||||
files.push(relative);
|
||||
}
|
||||
}
|
||||
package::extract_selected(base, &manifest, fixture, &|path| path.starts_with("Data/"), &|_, _| {})?;
|
||||
for relative in files {
|
||||
let target = fsx::ensure_within(fixture, &fixture.join(&relative))?;
|
||||
fsx::atomic_write(&target, &std::fs::read(tree.join(&relative))?)?;
|
||||
let expected = fsx::sha256_file(&tree.join(relative))?;
|
||||
if fsx::sha256_file(&target)? != expected {
|
||||
return Err(Error::Invalid("Startup candidate copy failed verification.".into()));
|
||||
}
|
||||
}
|
||||
let meta = crate::registry::InstallMeta::new(crate::registry::InstallKind::New, fixture);
|
||||
crate::registry::MetaDir::create(fixture, &meta)?;
|
||||
let env = crate::update::RepackEnv { root: fixture, meta_dir: &metadata };
|
||||
env.validate()?;
|
||||
env.ensure_stopped()?;
|
||||
if crate::update_isolation::pending(&metadata) {
|
||||
return Err(Error::Invalid("Startup qualification left unfinished isolated validation.".into()));
|
||||
}
|
||||
Ok(())
|
||||
}
|
||||
|
||||
pub fn verify_package(dir: &Path, trusted_key: &str) -> Result<()> {
|
||||
let (manifest, _) = pkgsource::fetch_manifest(&pkgsource::Source::Dir(dir.into()), trusted_key)?;
|
||||
if !manifest.files.iter().any(|f| f.path == schema_check::CONTRACT && f.size > 0) {
|
||||
@@ -83,12 +230,49 @@ pub fn verify_package(dir: &Path, trusted_key: &str) -> Result<()> {
|
||||
Ok(())
|
||||
}
|
||||
|
||||
pub fn verify_upgrade_fixture(dir: &Path, trusted_key: &str) -> Result<()> {
|
||||
let (manifest, _) = pkgsource::fetch_manifest(&pkgsource::Source::Dir(dir.into()), trusted_key)?;
|
||||
if !matches!(manifest.kind, Kind::Base | Kind::Update) {
|
||||
return Err(Error::Invalid("Upgrade fixtures must be base or server update packages.".into()));
|
||||
}
|
||||
let scratch = tempfile::tempdir()?;
|
||||
package::extract_selected(dir, &manifest, scratch.path(), &|path| path == schema_check::CONTRACT, &|_, _| {})?;
|
||||
if manifest.kind == Kind::Update || manifest.files.iter().any(|file| file.path == schema_check::CONTRACT) {
|
||||
schema_check::require_release_contract(scratch.path())?;
|
||||
}
|
||||
Ok(())
|
||||
}
|
||||
|
||||
#[cfg(test)]
|
||||
mod tests {
|
||||
use super::*;
|
||||
use base64::{engine::general_purpose::STANDARD, Engine};
|
||||
use ed25519_dalek::{Signer, SigningKey};
|
||||
|
||||
#[test]
|
||||
fn relative_startup_fixture_targets_replace_the_original_location() {
|
||||
let directory = tempfile::Builder::new().prefix("coa-schema-fixture-path-test-").tempdir_in(".").unwrap();
|
||||
let current = std::env::current_dir().unwrap();
|
||||
let relative = directory.path().strip_prefix(¤t).unwrap();
|
||||
fsx::atomic_write(&relative.join("Core/worldserver.exe"), b"old").unwrap();
|
||||
let root = fsx::canonicalize_lenient(relative).unwrap();
|
||||
let target = fsx::ensure_within(&root, &root.join("Core/worldserver.exe")).unwrap();
|
||||
fsx::atomic_write(&target, b"candidate").unwrap();
|
||||
assert_eq!(std::fs::read(relative.join("Core/worldserver.exe")).unwrap(), b"candidate");
|
||||
assert!(!root.join(relative).join("Core/worldserver.exe").exists());
|
||||
}
|
||||
|
||||
#[test]
|
||||
fn startup_qualification_refuses_real_server_folders_before_writes() {
|
||||
let directory = tempfile::tempdir().unwrap();
|
||||
let server = directory.path().join("live-server");
|
||||
std::fs::create_dir(&server).unwrap();
|
||||
fsx::atomic_write(&server.join("owner-data"), b"untouched").unwrap();
|
||||
assert!(validate_startup(&server, directory.path(), directory.path(), "unused").is_err());
|
||||
assert_eq!(std::fs::read(server.join("owner-data")).unwrap(), b"untouched");
|
||||
assert!(!crate::registry::metadata_dir_for(&server).unwrap().exists());
|
||||
}
|
||||
|
||||
#[test]
|
||||
fn signed_packages_must_carry_a_real_complete_schema_contract() {
|
||||
let dir = tempfile::tempdir().unwrap();
|
||||
@@ -127,6 +311,31 @@ mod tests {
|
||||
let dir = tempfile::tempdir().unwrap();
|
||||
assert!(extract_base(dir.path(), dir.path(), "irrelevant").is_err());
|
||||
assert!(capture_release(dir.path(), dir.path(), &[]).is_err());
|
||||
assert!(qualify_upgrade(dir.path(), dir.path(), dir.path(), dir.path(), "irrelevant").is_err());
|
||||
assert!(!dir.path().join(schema_check::CONTRACT).exists());
|
||||
}
|
||||
|
||||
#[test]
|
||||
fn only_legacy_base_fixtures_may_omit_the_schema_contract() {
|
||||
let dir = tempfile::tempdir().unwrap();
|
||||
let tree = dir.path().join("tree");
|
||||
let out = dir.path().join("package");
|
||||
fsx::atomic_write(&tree.join("Core/example.txt"), b"fixture").unwrap();
|
||||
let key = SigningKey::from_bytes(&[29; 32]);
|
||||
let public = STANDARD.encode(key.verifying_key().as_bytes());
|
||||
let options = package::BuildOptions { kind: Kind::Base, version: "0.2.0".into(), core_commit: None, bots_commit: None, built_at: "test".into(), part_size: 1024 * 1024, migrations: vec![] };
|
||||
package::build(&tree, &out, &options, &|_| {}).unwrap();
|
||||
let sign = || {
|
||||
let bytes = std::fs::read(out.join("manifest.json")).unwrap();
|
||||
fsx::atomic_write(&out.join("manifest.json.sig"), STANDARD.encode(key.sign(&bytes).to_bytes()).as_bytes()).unwrap();
|
||||
};
|
||||
sign();
|
||||
verify_upgrade_fixture(&out, &public).unwrap();
|
||||
assert!(verify_package(&out, &public).is_err());
|
||||
let mut manifest: serde_json::Value = fsx::read_json(&out.join("manifest.json")).unwrap();
|
||||
manifest["kind"] = "update".into();
|
||||
fsx::atomic_write_json(&out.join("manifest.json"), &manifest).unwrap();
|
||||
sign();
|
||||
assert!(verify_upgrade_fixture(&out, &public).is_err());
|
||||
}
|
||||
}
|
||||
@@ -39,6 +39,35 @@ pub fn require_release_contract(root: &Path) -> Result<Contract> {
|
||||
#[derive(Debug, Serialize)]
|
||||
pub struct Problem { pub database: String, pub table: String, pub column: String, pub detail: String }
|
||||
|
||||
/// Keep all differences for support; never change a database to match a contract automatically.
|
||||
pub fn check_with_report(db: &Db, root: &Path) -> Result<Vec<Problem>> {
|
||||
let problems = check(db, root)?;
|
||||
if problems.is_empty() { return Ok(problems); }
|
||||
let report = serde_json::json!({
|
||||
"schema": 1, "checkedAt": chrono::Utc::now().to_rfc3339(),
|
||||
"realm": db.realm().name(), "problems": problems,
|
||||
});
|
||||
let path = crate::registry::metadata_dir_for(root)?.join("diagnostics")
|
||||
.join(format!("schema-validation-{}-{}.json", db.realm().name(), uuid::Uuid::new_v4()));
|
||||
// A log write failure must neither hide the original mismatch nor accept an invalid schema.
|
||||
if let Err(error) = fsx::atomic_write_json(&path, &report) {
|
||||
tracing::warn!(%error, path = %path.display(), "Could not save database schema report");
|
||||
}
|
||||
Ok(problems)
|
||||
}
|
||||
|
||||
fn describe_signature(signature: &str) -> String {
|
||||
let fields: Vec<_> = signature.split('|').collect();
|
||||
if fields.len() != 4 { return signature.into(); }
|
||||
let decode = |value: &str| -> String {
|
||||
if value == "<NULL>" { return "no default".into(); }
|
||||
if value == "<NONE>" { return "none".into(); }
|
||||
hex::decode(value).ok().and_then(|bytes| String::from_utf8(bytes).ok())
|
||||
.map(|text| format!("{text:?}")).unwrap_or_else(|| value.into())
|
||||
};
|
||||
format!("type={}, nullable={}, default={}, extra={}", fields[0], fields[1], decode(fields[2]), decode(fields[3]))
|
||||
}
|
||||
|
||||
fn read_columns(db: &Db, kind: &str) -> Result<BTreeMap<String, BTreeMap<String, String>>> {
|
||||
let schema = db.realm_schema(crate::db::schema_of(kind)?);
|
||||
let text = db.query(&format!("SELECT TABLE_NAME,COLUMN_NAME,CONCAT(COLUMN_TYPE,'|',IS_NULLABLE,'|',IF(COLUMN_DEFAULT IS NULL,'<NULL>',HEX(COLUMN_DEFAULT)),'|',IF(EXTRA='','<NONE>',HEX(EXTRA))) FROM information_schema.COLUMNS WHERE TABLE_SCHEMA='{schema}' ORDER BY TABLE_NAME,ORDINAL_POSITION;"))?;
|
||||
@@ -56,6 +85,46 @@ pub fn capture(db: &Db, root: &Path) -> Result<()> {
|
||||
fsx::atomic_write_json(&root.join(CONTRACT), &Contract { schema: 1, columns })
|
||||
}
|
||||
|
||||
fn missing_default(expected: &str, actual: &str) -> Option<String> {
|
||||
let expected: Vec<_> = expected.split('|').collect();
|
||||
let actual: Vec<_> = actual.split('|').collect();
|
||||
if expected.len() != 4 || actual.len() != 4 || expected[0] != actual[0]
|
||||
|| expected[1] != "NO" || actual[1] != "NO" || expected[3] != "<NONE>" || actual[3] != "<NONE>"
|
||||
|| actual[2] != "<NULL>" || matches!(expected[2], "<NULL>" | "<NONE>") { return None; }
|
||||
String::from_utf8(hex::decode(expected[2]).ok()?).ok()
|
||||
}
|
||||
|
||||
/// Only restore a missing literal default from the exact signed target contract. Never alter data or custom defaults.
|
||||
pub(crate) fn repair_missing_defaults(db: &Db, root: &Path, signed_hash: Option<&str>) -> Result<()> {
|
||||
let Some(signed_hash) = signed_hash else { return Ok(()); };
|
||||
if fsx::sha256_file(&root.join(CONTRACT))? != signed_hash {
|
||||
return Err(crate::Error::Invalid("The target schema contract differs from the signed update.".into()));
|
||||
}
|
||||
let contract = require_release_contract(root)?;
|
||||
let mut repaired = Vec::new();
|
||||
let quote = |identifier: &str| format!("`{}`", identifier.replace('`', "``"));
|
||||
for (kind, tables) in &contract.columns {
|
||||
let schema = db.realm_schema(crate::db::schema_of(kind)?);
|
||||
let actual = read_columns(db, kind)?;
|
||||
let base_tables: BTreeSet<_> = db.tables(crate::db::schema_of(kind)?)?.into_iter().collect();
|
||||
for (table, columns) in tables {
|
||||
if !base_tables.contains(table) { continue; }
|
||||
if matches!(table.as_str(), "updates" | "updates_include" | "coa_manager_migrations") { continue; }
|
||||
for (column, expected) in columns {
|
||||
let Some(found) = actual.get(table).and_then(|columns| columns.get(column)) else { continue; };
|
||||
let Some(value) = missing_default(expected, found) else { continue; };
|
||||
db.query(&format!("SET SESSION sql_mode=CONCAT_WS(',',@@SESSION.sql_mode,'NO_BACKSLASH_ESCAPES'); ALTER TABLE {}.{} ALTER COLUMN {} SET DEFAULT '{}';", quote(schema), quote(table), quote(column), value.replace('\'', "''")))?;
|
||||
repaired.push(serde_json::json!({"database":schema,"table":table,"column":column,"action":"restore-missing-default"}));
|
||||
}
|
||||
}
|
||||
}
|
||||
if !repaired.is_empty() {
|
||||
let path = crate::registry::metadata_dir_for(root)?.join("diagnostics").join(format!("database-repair-{}.json", uuid::Uuid::new_v4()));
|
||||
fsx::atomic_write_json(&path, &serde_json::json!({"schema":1,"checkedAt":chrono::Utc::now().to_rfc3339(),"contractSha256":signed_hash,"repairs":repaired}))?;
|
||||
}
|
||||
Ok(())
|
||||
}
|
||||
|
||||
pub fn check(db: &Db, root: &Path) -> Result<Vec<Problem>> {
|
||||
let contract = if root.join(CONTRACT).is_file() {
|
||||
let contract: Contract = fsx::read_json(&root.join(CONTRACT))?;
|
||||
@@ -98,7 +167,7 @@ pub fn check(db: &Db, root: &Path) -> Result<Vec<Problem>> {
|
||||
for (column, want) in cols {
|
||||
let found = actual[table].get(column);
|
||||
if found.is_none() || (!want.is_empty() && found != Some(want)) {
|
||||
problems.push(Problem { database: kind.clone(), table: table.clone(), column: column.clone(), detail: found.map(|s| format!("Expected {want}, found {s}")).unwrap_or_else(|| "Missing column".into()) });
|
||||
problems.push(Problem { database: kind.clone(), table: table.clone(), column: column.clone(), detail: found.map(|s| format!("Expected {}, found {}", describe_signature(want), describe_signature(s))).unwrap_or_else(|| "Missing column".into()) });
|
||||
}
|
||||
}
|
||||
}
|
||||
@@ -146,6 +215,23 @@ fn missing_coa_starts(rows: &str) -> Vec<Problem> {
|
||||
#[cfg(test)]
|
||||
mod tests {
|
||||
use super::*;
|
||||
#[test]
|
||||
fn default_repair_only_accepts_missing_literal_defaults_without_other_schema_changes() {
|
||||
assert_eq!(missing_default("int unsigned|NO|30|<NONE>", "int unsigned|NO|<NULL>|<NONE>"), Some("0".into()));
|
||||
for actual in ["int unsigned|NO|3939|<NONE>", "int|NO|<NULL>|<NONE>", "int unsigned|YES|<NULL>|<NONE>", "int unsigned|NO|<NULL>|6175746f5f696e6372656d656e74"] {
|
||||
assert!(missing_default("int unsigned|NO|30|<NONE>", actual).is_none());
|
||||
}
|
||||
assert!(missing_default("timestamp|NO|43555252454e545f54494d455354414d50|44454641554c545f47454e455241544544", "timestamp|NO|<NULL>|<NONE>").is_none());
|
||||
assert!(missing_default("int|NO|zz|<NONE>", "int|NO|<NULL>|<NONE>").is_none());
|
||||
}
|
||||
|
||||
#[test]
|
||||
fn schema_defaults_are_readable_and_not_conflated() {
|
||||
assert_eq!(describe_signature("int unsigned|NO|30|<NONE>"), "type=int unsigned, nullable=NO, default=\"0\", extra=none");
|
||||
assert!(describe_signature("int unsigned|NO|<NULL>|<NONE>").contains("default=no default"));
|
||||
assert!(describe_signature("varchar(8)|YES||<NONE>").contains("default=\"\""));
|
||||
assert_eq!(describe_signature("legacy"), "legacy");
|
||||
}
|
||||
|
||||
#[test]
|
||||
fn a_release_cannot_use_a_partial_or_empty_schema_contract() {
|
||||
|
||||
+484
-75
@@ -85,9 +85,14 @@ fn legacy_databases_started() -> bool { true }
|
||||
|
||||
/// Everything the transaction needs from the outside world; tests provide a fake.
|
||||
pub trait Env {
|
||||
fn activate(&self) -> Result<()> { Ok(()) }
|
||||
fn recover_validation(&self) -> Result<()> { Ok(()) }
|
||||
fn automatic_rollback(&self) -> bool { false }
|
||||
fn validate_recovery(&self) -> Result<()> { self.validate() }
|
||||
fn ensure_stopped(&self) -> Result<()>;
|
||||
fn preflight(&self, _manifest: &Manifest) -> Result<()> { Ok(()) }
|
||||
fn verify_snapshot(&self, _id: &str) -> Result<()> { Ok(()) }
|
||||
fn rehearse(&self, _manifest: &Manifest, _tree: &Path, _items: &[PlanItem], _point: &str) -> Result<()> { Ok(()) }
|
||||
/// Create a recovery point for the databases and configuration; returns its id.
|
||||
fn snapshot(&self) -> Result<String>;
|
||||
fn restore_snapshot(&self, id: &str) -> Result<()>;
|
||||
@@ -177,6 +182,9 @@ pub fn unfinished(meta: &Path) -> Option<Txn> {
|
||||
}
|
||||
|
||||
pub fn ensure_recovered(meta: &Path) -> Result<()> {
|
||||
if crate::update_isolation::pending(meta) {
|
||||
return Err(Error::Invalid("Interrupted startup validation must be recovered before starting the server.".into()));
|
||||
}
|
||||
if let Some(t) = pending_checked(meta)? {
|
||||
return Err(Error::Invalid(format!("Resolve unfinished update {} before changing or starting the server.", t.id)));
|
||||
}
|
||||
@@ -360,6 +368,15 @@ fn launcher_already_integrated(root: &Path, meta_dir: &Path, meta: &InstallMeta,
|
||||
}
|
||||
|
||||
fn reject_downgrade(meta: &InstallMeta, manifest: &Manifest) -> Result<()> {
|
||||
if let Some(c) = &manifest.compatibility {
|
||||
let platform = if cfg!(windows) { "windows-x86_64" } else { "linux-x86_64" };
|
||||
if c.platform != platform {
|
||||
return Err(Error::Invalid(format!("This package targets {} rather than {platform}.", c.platform)));
|
||||
}
|
||||
if meta.core.version.as_ref().is_none_or(|version| !c.source_versions.contains(version)) {
|
||||
return Err(Error::Invalid("This server version is outside the release's tested compatibility matrix.".into()));
|
||||
}
|
||||
}
|
||||
if let Some(installed) = meta.core.version.as_deref() {
|
||||
if let (Some(have), Some(candidate)) = (crate::manifest::parse_version(installed), crate::manifest::parse_version(&manifest.version)) {
|
||||
if candidate < have {
|
||||
@@ -380,6 +397,11 @@ fn check_manifest(m: &Manifest) -> Result<()> {
|
||||
Ok(())
|
||||
}
|
||||
|
||||
pub fn validate_candidate(meta: &InstallMeta, manifest: &Manifest) -> Result<()> {
|
||||
check_manifest(manifest)?;
|
||||
reject_downgrade(meta, manifest)
|
||||
}
|
||||
|
||||
pub struct Params<'a> {
|
||||
pub root: &'a Path,
|
||||
pub meta_dir: &'a Path,
|
||||
@@ -472,6 +494,14 @@ pub fn apply(p: &Params, report: &dyn Fn(&str, u8)) -> Result<Outcome> {
|
||||
txn.recovery_point = Some(p.env.snapshot().map_err(|e| Error::Invalid(format!("The update was not applied because the safety backup failed: {e}")))?);
|
||||
let point_meta = crate::backup::point_json(meta_dir, txn.recovery_point.as_deref().unwrap())?;
|
||||
if point_meta.is_file() { txn.recovery_hashes.insert("@point".into(), fsx::sha256_file(&point_meta)?); }
|
||||
save(meta_dir, &txn)?;
|
||||
step(report, "Testing the update on a private copy of your server", 54);
|
||||
if let Err(error) = p.env.rehearse(&m, &tree, &items, txn.recovery_point.as_deref().unwrap()) {
|
||||
txn.state = State::Failed;
|
||||
txn.message = Some(format!("The private update rehearsal failed: {error}. The installed server was not updated."));
|
||||
save(meta_dir, &txn)?;
|
||||
return Err(Error::Invalid(txn.message.unwrap()));
|
||||
}
|
||||
|
||||
txn.ops = items
|
||||
.iter()
|
||||
@@ -495,7 +525,7 @@ pub fn apply(p: &Params, report: &dyn Fn(&str, u8)) -> Result<Outcome> {
|
||||
|
||||
// MySQL DDL can commit before a later statement fails. Restore the full recovery point on failure.
|
||||
let mut migrated = None;
|
||||
if !m.migrations.is_empty() {
|
||||
if !m.migrations.is_empty() || m.files.iter().any(|file| file.path == crate::schema_check::CONTRACT) {
|
||||
step(report, "Updating the database", 75);
|
||||
txn.databases_started = true;
|
||||
save(meta_dir, &txn)?;
|
||||
@@ -514,7 +544,14 @@ pub fn apply(p: &Params, report: &dyn Fn(&str, u8)) -> Result<Outcome> {
|
||||
}
|
||||
|
||||
step(report, "Starting the updated server", 85);
|
||||
// Core startup can apply SQL and write character data even when the package has no explicit migrations.
|
||||
txn.databases_started = true;
|
||||
save(meta_dir, &txn)?;
|
||||
if let Err(e) = p.env.validate() {
|
||||
if p.env.automatic_rollback() {
|
||||
return fail_after_apply(p, &mut txn, &before, &tree,
|
||||
format!("The updated server did not start correctly: {e}"), migrated);
|
||||
}
|
||||
txn.state = State::NeedsDecision;
|
||||
txn.message = Some(format!("The updated server did not start correctly: {e}"));
|
||||
save(meta_dir, &txn)?;
|
||||
@@ -522,6 +559,7 @@ pub fn apply(p: &Params, report: &dyn Fn(&str, u8)) -> Result<Outcome> {
|
||||
}
|
||||
|
||||
finish(root, meta_dir, &mut meta, &m, &tree, &mut txn)?;
|
||||
p.env.activate()?;
|
||||
step(report, "Done", 100);
|
||||
let _ = archive;
|
||||
Ok(Outcome { txn, migrations: migrated })
|
||||
@@ -594,17 +632,24 @@ pub fn retry_validation(root: &Path, meta_dir: &Path, id: &str, fallback: &Sourc
|
||||
}
|
||||
let (_, mut meta) = MetaDir::open(meta_dir)?;
|
||||
finish(root, meta_dir, &mut meta, &manifest, &dir.join("tree"), &mut txn)?;
|
||||
env.activate()?;
|
||||
Ok(txn)
|
||||
}
|
||||
|
||||
fn fail_after_apply(p: &Params, txn: &mut Txn, before: &Path, tree: &Path, why: String, report: Option<ApplyReport>) -> Result<Outcome> {
|
||||
tracing::error!(transaction = %txn.id, databases_started = txn.databases_started, "server update failed; restoring recovery point");
|
||||
let restored = restore_transaction(p.root, p.meta_dir, before, txn, p.env);
|
||||
let restored = restore_transaction(p.root, p.meta_dir, before, txn, p.env).and_then(|()| {
|
||||
if p.env.automatic_rollback() { p.env.validate_recovery() } else { Ok(()) }
|
||||
});
|
||||
if restored.is_err() { let _ = p.env.ensure_stopped(); }
|
||||
tracing::info!(transaction = %txn.id, recovered = restored.is_ok(), "server update recovery finished");
|
||||
txn.state = if restored.is_ok() { State::RolledBack } else { State::Failed };
|
||||
txn.message = Some(match &restored { Ok(()) => why.clone(), Err(e) => format!("{why} Recovery failed: {e}") });
|
||||
save(p.meta_dir, txn)?;
|
||||
if restored.is_ok() { let _ = fs::remove_dir_all(tree); }
|
||||
if restored.is_ok() {
|
||||
let _ = fs::remove_dir_all(tree);
|
||||
if p.env.automatic_rollback() { p.env.activate()?; }
|
||||
}
|
||||
let _ = report;
|
||||
Err(Error::Invalid(match restored {
|
||||
Ok(()) if txn.databases_started => format!("{why} The server files and databases were restored to the recovery point."),
|
||||
@@ -628,6 +673,7 @@ fn restore_transaction(root: &Path, meta: &Path, before: &Path, txn: &mut Txn, e
|
||||
}
|
||||
if !before.join("manager-install.json").is_file() { return Err(Error::Invalid("The saved installation metadata is missing; no restoration was started.".into())); }
|
||||
env.ensure_stopped()?;
|
||||
env.recover_validation()?;
|
||||
if txn.databases_started {
|
||||
let id = txn.recovery_point.as_deref().ok_or_else(|| Error::Invalid("The database recovery point is missing.".into()))?;
|
||||
env.restore_snapshot(id)?;
|
||||
@@ -641,6 +687,25 @@ fn restore_transaction(root: &Path, meta: &Path, before: &Path, txn: &mut Txn, e
|
||||
}
|
||||
|
||||
fn apply_ops(root: &Path, tree: &Path, before: &Path, files: &[FileEntry], txn: &mut Txn, meta_dir: &Path, fail_after: Option<usize>) -> Result<()> {
|
||||
if fail_after == Some(0) && !txn.ops.is_empty() {
|
||||
return Err(Error::Invalid("simulated failure".into()));
|
||||
}
|
||||
let entries: BTreeMap<_, _> = files.iter().map(|entry| (entry.path.as_str(), entry)).collect();
|
||||
// Prepare every recovery copy before changing any destination. One durable journal
|
||||
// can then cover the entire file phase: recovery restores old files even if their
|
||||
// replacement was not reached, and removes newly created files only by exact hash.
|
||||
// Rewriting the full journal twice per file makes large navigation updates quadratic.
|
||||
for op in &txn.ops {
|
||||
let target = fsx::ensure_within(root, &fsx::safe_join(root, &op.path)?)?;
|
||||
if op.had_previous {
|
||||
let keep = fsx::safe_join(before, &op.path)?;
|
||||
fs::create_dir_all(keep.parent().unwrap())?;
|
||||
fsx::atomic_write(&keep, &fs::read(&target)?)?;
|
||||
txn.recovery_hashes.insert(op.path.clone(), fsx::sha256_file(&keep)?);
|
||||
}
|
||||
}
|
||||
for op in &mut txn.ops { op.started = true; }
|
||||
save(meta_dir, txn)?;
|
||||
let mut completed = 0usize;
|
||||
for i in 0..txn.ops.len() {
|
||||
if fail_after == Some(completed) {
|
||||
@@ -649,17 +714,7 @@ fn apply_ops(root: &Path, tree: &Path, before: &Path, files: &[FileEntry], txn:
|
||||
let (path, action) = (txn.ops[i].path.clone(), txn.ops[i].action);
|
||||
let target = fsx::ensure_within(root, &fsx::safe_join(root, &path)?)?;
|
||||
let staged = fsx::safe_join(tree, &path)?;
|
||||
let entry = files.iter().find(|f| f.path == path).expect("listed");
|
||||
if target.is_file() {
|
||||
let keep = fsx::safe_join(before, &path)?;
|
||||
fs::create_dir_all(keep.parent().unwrap())?;
|
||||
fsx::atomic_write(&keep, &fs::read(&target)?)?;
|
||||
txn.recovery_hashes.insert(path.clone(), fsx::sha256_file(&keep)?);
|
||||
}
|
||||
// Journal only after the old bytes are safely saved; a crash during backup must not
|
||||
// turn an untouched file into a rollback operation with a missing saved copy.
|
||||
txn.ops[i].started = true;
|
||||
save(meta_dir, txn)?;
|
||||
let entry = entries.get(path.as_str()).expect("listed");
|
||||
fs::create_dir_all(target.parent().unwrap())?;
|
||||
match action {
|
||||
Action::Create | Action::Replace => {
|
||||
@@ -684,10 +739,9 @@ fn apply_ops(root: &Path, tree: &Path, before: &Path, files: &[FileEntry], txn:
|
||||
Action::Skip | Action::Conflict => {}
|
||||
}
|
||||
txn.ops[i].done = true;
|
||||
save(meta_dir, txn)?;
|
||||
completed += 1;
|
||||
}
|
||||
Ok(())
|
||||
save(meta_dir, txn)
|
||||
}
|
||||
|
||||
/// Put every touched file back the way it was. Files created by the update (no previous version) are removed only if
|
||||
@@ -815,13 +869,27 @@ impl RepackEnv<'_> {
|
||||
return Err(Error::Invalid("The update recovery point does not contain every required database and configuration.".into()));
|
||||
}
|
||||
if !crate::backup::verify(self.meta_dir, &point.id)?.ok { return Err(Error::Invalid("The recovery point failed verification.".into())); }
|
||||
if let Some(snapshot) = &point.mysql_snapshot {
|
||||
if fsx::sha256_file(&self.root.join("mysql/bin/mysqld.exe"))? != snapshot.server_sha256 {
|
||||
return Err(Error::Invalid("The MySQL executable differs from the recovery point.".into()));
|
||||
}
|
||||
return Ok(());
|
||||
}
|
||||
crate::backup::with_database(self.root, |db| {
|
||||
let db = db.clone().for_realm(crate::realms::Mode::Coa);
|
||||
let mut objects = Vec::new();
|
||||
for component in point.components.iter().filter(|c| c.sha256.is_some()) {
|
||||
let schema = if component.name.contains('-') || component.name == "playerbots" { crate::db::schema_of(&component.name)? } else { point.realm.schema(&component.name)? };
|
||||
if db.extra_objects(schema)? != 0 {
|
||||
return Err(Error::Invalid(format!("Database {schema} has routines, triggers or views that automatic recovery cannot restore. The update was not started.")));
|
||||
objects.extend(db.recovery_objects(schema)?);
|
||||
}
|
||||
if !objects.is_empty() {
|
||||
let path = self.meta_dir.join("diagnostics").join(format!("database-recovery-{}.json", uuid::Uuid::new_v4()));
|
||||
let report = serde_json::json!({ "schema": 1, "checkedAt": chrono::Utc::now().to_rfc3339(), "recoveryPoint": point.id, "objects": objects });
|
||||
if let Err(error) = fsx::atomic_write_json(&path, &report) {
|
||||
tracing::warn!(%error, "Could not save database recovery compatibility report");
|
||||
}
|
||||
let sample = objects.iter().take(3).map(|object| format!("{}.{} ({})", object["database"].as_str().unwrap_or("?"), object["name"].as_str().unwrap_or("?"), object["kind"].as_str().unwrap_or("?"))).collect::<Vec<_>>().join(", ");
|
||||
return Err(Error::Invalid(format!("Automatic recovery does not support {} database objects: {sample}. Export diagnostics for the complete list. The update was not started.", objects.len())));
|
||||
}
|
||||
Ok(())
|
||||
})
|
||||
@@ -839,7 +907,116 @@ impl RepackEnv<'_> {
|
||||
}
|
||||
|
||||
impl Env for RepackEnv<'_> {
|
||||
fn recover_validation(&self) -> Result<()> {
|
||||
crate::update_isolation::restore(self.root, self.meta_dir)
|
||||
}
|
||||
|
||||
fn activate(&self) -> Result<()> {
|
||||
ensure_recovered(self.meta_dir)?;
|
||||
let outcome = crate::driver::validate_update(self.root)?;
|
||||
if outcome.ok { Ok(()) } else {
|
||||
Err(Error::Invalid(format!("The update transaction finished, but the server could not start: {}", crate::driver::startup_failure(self.root, &outcome))))
|
||||
}
|
||||
}
|
||||
|
||||
fn automatic_rollback(&self) -> bool { true }
|
||||
fn rehearse(&self, manifest: &Manifest, tree: &Path, items: &[PlanItem], id: &str) -> Result<()> {
|
||||
if items.iter().any(|item| item.action != Action::Skip && item.path.to_ascii_lowercase().starts_with("mysql/")) {
|
||||
return Err(Error::Invalid("A server update cannot replace MySQL while using a cold recovery copy; a separate database engine upgrade is required.".into()));
|
||||
}
|
||||
let point = crate::backup::get(self.meta_dir, id)?;
|
||||
let Some(snapshot) = &point.mysql_snapshot else {
|
||||
// Docker uses its separate experimental release channel until its clone runner is qualified.
|
||||
if crate::docker::is_docker(self.root) { return Ok(()); }
|
||||
return Err(Error::Invalid("This installation has no complete MySQL recovery copy for an update rehearsal.".into()));
|
||||
};
|
||||
crate::mysql_snapshot::validate_connections(self.root, self.root)?;
|
||||
crate::mysql_snapshot::stop(self.root)?;
|
||||
let point_dir = crate::backup::point_json(self.meta_dir, id)?.parent().unwrap().to_path_buf();
|
||||
let fixture = crate::mysql_snapshot::rehearsal_copy(self.root, self.meta_dir, &point_dir, snapshot)?;
|
||||
let metadata = crate::registry::metadata_dir_for(&fixture)?;
|
||||
let env = RepackEnv { root: &fixture, meta_dir: &metadata };
|
||||
let result = crate::install::with_scratch_ports(&fixture, || {
|
||||
let mut txn = Txn { id: "rehearsal".into(), state: State::Applying, from_version: None,
|
||||
to_version: manifest.version.clone(), recovery_point: None, databases_started: false,
|
||||
ops: items.iter().filter(|item| item.action != Action::Skip).map(|item| Op {
|
||||
path: item.path.clone(), action: item.action, reason: item.reason.clone(),
|
||||
new_sha256: manifest.files.iter().find(|file| file.path == item.path).unwrap().sha256.clone(),
|
||||
had_previous: fsx::safe_join(&fixture, &item.path).is_ok_and(|path| path.is_file()), started:false, done:false,
|
||||
}).collect(), message:None, recovery_hashes:BTreeMap::new() };
|
||||
let before = txn_dir(&metadata, &txn.id)?.join("before");
|
||||
fs::create_dir_all(&before)?;
|
||||
apply_ops(&fixture, tree, &before, &manifest.files, &mut txn, &metadata, None)?;
|
||||
crate::mysql_snapshot::validate_connections(&fixture, self.root)?;
|
||||
crate::mysql_snapshot::isolate_connections(&fixture)?;
|
||||
let identities = crate::backup::with_database(&fixture, |db| {
|
||||
let identities = database_identities(db)?;
|
||||
let realms = crate::realms::state(&fixture)?;
|
||||
let mut modes = vec![realms.active];
|
||||
if realms.wildcard_created { modes.push(if realms.active == crate::realms::Mode::Coa { crate::realms::Mode::Wildcard } else { crate::realms::Mode::Coa }); }
|
||||
for (index, mode) in modes.into_iter().enumerate() {
|
||||
let db = db.clone().for_realm(mode);
|
||||
crate::schema_check::repair_missing_defaults(&db, &fixture, manifest.files.iter().find(|file| file.path == crate::schema_check::CONTRACT).map(|file| file.sha256.as_str()))?;
|
||||
let list: Vec<_> = manifest.migrations.iter().filter(|migration| index == 0 || migration.db != "auth").cloned().collect();
|
||||
let report = crate::migrations::apply_pending(&db, &list, &tree.join("_migrations"), &|| Ok("private rehearsal".into()))?;
|
||||
if let Some((migration, error)) = report.failed { return Err(Error::Invalid(format!("Rehearsal migration {migration} failed: {error}"))); }
|
||||
crate::schema_check::repair_missing_defaults(&db, &fixture, manifest.files.iter().find(|file| file.path == crate::schema_check::CONTRACT).map(|file| file.sha256.as_str()))?;
|
||||
}
|
||||
verify_database_identities(db, &identities)?;
|
||||
Ok(identities)
|
||||
})?;
|
||||
env.validate()?;
|
||||
crate::backup::with_database(&fixture, |db| verify_database_identities(db, &identities))?;
|
||||
env.ensure_stopped()
|
||||
});
|
||||
let stopped = crate::mysql_snapshot::stop(&fixture);
|
||||
let live_state = if result.is_ok() { crate::mysql_snapshot::stop(self.root).and_then(|()| crate::mysql_snapshot::unchanged(self.root, snapshot)) } else { Ok(()) };
|
||||
let logs: BTreeMap<_, _> = ["Core/Logs/auth-console.log", "Core/Logs/world-console.log", "Core/Logs/supervisor.log", "mysql/logs/mysql-error.log"].into_iter()
|
||||
.map(|path| (path, crate::diag::redact(&crate::health::tail(&fixture.join(path), 32768)))).collect();
|
||||
let mut schema_reports = Vec::<serde_json::Value>::new();
|
||||
if let Ok(entries) = fs::read_dir(metadata.join("diagnostics")) {
|
||||
for entry in entries.flatten().filter(|entry| entry.file_name().to_string_lossy().starts_with("schema-validation-")) {
|
||||
let path = fsx::ensure_within(&metadata, &entry.path())?;
|
||||
if fs::metadata(&path)?.len() <= 4 * 1024 * 1024 { schema_reports.push(fsx::read_json(&path)?); }
|
||||
}
|
||||
}
|
||||
let report = serde_json::json!({"schema":1,"checkedAt":chrono::Utc::now().to_rfc3339(),"toVersion":manifest.version,"recoveryPoint":id,
|
||||
"result":if result.is_ok() && stopped.is_ok() && live_state.is_ok() {"passed"} else {"failed"}, "error":result.as_ref().err().map(ToString::to_string), "stopError":stopped.as_ref().err().map(ToString::to_string), "liveStateError":live_state.as_ref().err().map(ToString::to_string), "logs":logs,"schemaReports":schema_reports,"fixture":fixture});
|
||||
let report_path = self.meta_dir.join("diagnostics").join(format!("database-rehearsal-{}.json", uuid::Uuid::new_v4()));
|
||||
fsx::atomic_write_json(&report_path, &report)?;
|
||||
stopped?;
|
||||
let parent = fixture.parent().unwrap();
|
||||
let owned = fsx::ensure_within(&self.meta_dir.join("rehearsals"), parent)?;
|
||||
fs::remove_dir_all(owned)?;
|
||||
live_state?;
|
||||
result
|
||||
}
|
||||
fn preflight(&self, manifest: &Manifest) -> Result<()> {
|
||||
crate::mysql_snapshot::stop_previous_rehearsals(self.meta_dir)?;
|
||||
if let Some(compatibility) = &manifest.compatibility {
|
||||
let (_, meta) = MetaDir::open(self.meta_dir)?;
|
||||
if let Some(source) = meta.core.version.as_ref().and_then(|v| compatibility.source_databases.get(v)) {
|
||||
if let Some(expected) = &source.schema_sha256 {
|
||||
let contract = self.root.join("Scripts/database-schema.json");
|
||||
if fsx::sha256_file(&contract)? != *expected {
|
||||
return Err(Error::Invalid("The installed database schema contract differs from the qualified upgrade source; repair the installation first.".into()));
|
||||
}
|
||||
}
|
||||
crate::backup::with_database(self.root, |db| {
|
||||
let mut modes = vec![crate::realms::Mode::Coa];
|
||||
if crate::realms::state(self.root)?.wildcard_created { modes.push(crate::realms::Mode::Wildcard); }
|
||||
for mode in modes {
|
||||
if let Some(problem) = crate::schema_check::check_with_report(&db.clone().for_realm(mode), self.root)?.first() {
|
||||
if crate::docker::is_docker(self.root) {
|
||||
return Err(Error::Invalid(format!("The installed {} database does not match its upgrade source: {}.{}: {}", mode.name(), problem.database, problem.table, problem.detail)));
|
||||
}
|
||||
tracing::warn!(realm = mode.name(), table = %problem.table, "Installed schema differs; the private candidate rehearsal must qualify this database");
|
||||
}
|
||||
}
|
||||
Ok(())
|
||||
})?;
|
||||
}
|
||||
}
|
||||
self.pending_migrations(manifest).map(|_| ())
|
||||
}
|
||||
|
||||
@@ -873,6 +1050,13 @@ impl Env for RepackEnv<'_> {
|
||||
if !["characters", "auth", "world", "configs"].iter().all(|name| point.components.iter().any(|c| c.name == *name)) || !crate::backup::verify(self.meta_dir, id)?.ok {
|
||||
return Err(Error::Invalid("The full database recovery point is incomplete or damaged.".into()));
|
||||
}
|
||||
if let Some(snapshot) = &point.mysql_snapshot {
|
||||
crate::mysql_snapshot::stop(self.root)?;
|
||||
let point_dir = crate::backup::point_json(self.meta_dir, id)?.parent().unwrap().to_path_buf();
|
||||
crate::mysql_snapshot::swap(self.root, self.meta_dir, &point_dir, snapshot, false)?;
|
||||
crate::backup::restore_configs(self.root, self.meta_dir, id)?;
|
||||
return Ok(());
|
||||
}
|
||||
for component in point.components.iter().filter(|c| c.sha256.is_some()) {
|
||||
crate::backup::restore_database(self.root, self.meta_dir, id, &component.name)?;
|
||||
}
|
||||
@@ -884,12 +1068,17 @@ impl Env for RepackEnv<'_> {
|
||||
let root = self.root;
|
||||
crate::backup::with_database(root, |db| {
|
||||
let realms = crate::realms::state(root)?;
|
||||
if let Some(contract) = manifest.files.iter().find(|file| file.path == crate::schema_check::CONTRACT) {
|
||||
self.migration_snapshot()?;
|
||||
crate::schema_check::repair_missing_defaults(db, root, Some(&contract.sha256))?;
|
||||
}
|
||||
let mut result = crate::migrations::apply_pending(db, &manifest.migrations, staged, &|| {
|
||||
self.migration_snapshot()
|
||||
})?;
|
||||
if realms.wildcard_created && result.failed.is_none() {
|
||||
let other = if realms.active == crate::realms::Mode::Coa { crate::realms::Mode::Wildcard } else { crate::realms::Mode::Coa };
|
||||
let other_db = db.clone().for_realm(other);
|
||||
crate::schema_check::repair_missing_defaults(&other_db, root, manifest.files.iter().find(|file| file.path == crate::schema_check::CONTRACT).map(|file| file.sha256.as_str()))?;
|
||||
let shared_snapshot = result.snapshot.clone();
|
||||
let migrations: Vec<_> = manifest.migrations.iter().filter(|m| m.db != "auth").cloned().collect();
|
||||
let extra = crate::migrations::apply_pending(&other_db, &migrations, staged, &|| {
|
||||
@@ -900,13 +1089,15 @@ impl Env for RepackEnv<'_> {
|
||||
result.failed = extra.failed;
|
||||
if result.snapshot.is_none() { result.snapshot = extra.snapshot; }
|
||||
if result.failed.is_none() {
|
||||
if let Some(p) = crate::schema_check::check(&other_db, root)?.first() {
|
||||
crate::schema_check::repair_missing_defaults(&other_db, root, manifest.files.iter().find(|file| file.path == crate::schema_check::CONTRACT).map(|file| file.sha256.as_str()))?;
|
||||
if let Some(p) = crate::schema_check::check_with_report(&other_db, root)?.first() {
|
||||
return Err(Error::Invalid(format!("Database validation failed on {}: {}.{}: {}", other.name(), p.table, p.column, p.detail)));
|
||||
}
|
||||
}
|
||||
}
|
||||
if result.failed.is_none() {
|
||||
let problems = crate::schema_check::check(db, root)?;
|
||||
crate::schema_check::repair_missing_defaults(db, root, manifest.files.iter().find(|file| file.path == crate::schema_check::CONTRACT).map(|file| file.sha256.as_str()))?;
|
||||
let problems = crate::schema_check::check_with_report(db, root)?;
|
||||
if let Some(p) = problems.first() {
|
||||
return Err(Error::Invalid(format!("Database validation failed: {}.{}.{}: {} ({} problems).", p.database, p.table, p.column, p.detail, problems.len())));
|
||||
}
|
||||
@@ -916,61 +1107,111 @@ impl Env for RepackEnv<'_> {
|
||||
}
|
||||
|
||||
fn validate(&self) -> Result<()> {
|
||||
use crate::process::{observe, ServiceState};
|
||||
crate::backup::with_database(self.root, |db| {
|
||||
let mut modes = vec![crate::realms::Mode::Coa];
|
||||
if crate::realms::state(self.root)?.wildcard_created { modes.push(crate::realms::Mode::Wildcard); }
|
||||
for mode in modes {
|
||||
if let Some(p) = crate::schema_check::check(&db.clone().for_realm(mode), self.root)?.first() {
|
||||
return Err(Error::Invalid(format!("Database validation failed on {}: {}.{}: {}", mode.name(), p.database, p.table, p.detail)));
|
||||
}
|
||||
}
|
||||
Ok(())
|
||||
})?;
|
||||
// The check start is the first start of the new build: give the module configs the settings the update added
|
||||
// (as a normal start does), or the server logs a "missing property" line for every one of them.
|
||||
match crate::registry::MetaDir::open(self.meta_dir) {
|
||||
Ok((_, meta)) if meta.kind == crate::registry::InstallKind::New => {
|
||||
let _ = crate::config::materialize_module_configs(self.root);
|
||||
}
|
||||
// An imported server gets the files it lacks (nothing it has is changed).
|
||||
_ => {
|
||||
let _ = crate::config::create_missing_module_configs(self.root);
|
||||
}
|
||||
}
|
||||
let started = match crate::driver::validate_update(self.root) {
|
||||
Ok(out) => out,
|
||||
Err(e) => {
|
||||
let _ = crate::driver::run(self.root, crate::driver::Verb::StopAll);
|
||||
return Err(e);
|
||||
}
|
||||
};
|
||||
let ports = crate::layout::read_ports(self.root);
|
||||
let healthy = started.ok && {
|
||||
let deadline = std::time::Instant::now() + std::time::Duration::from_secs(180);
|
||||
let mut ready_since = None;
|
||||
loop {
|
||||
let o = observe(self.root, &ports);
|
||||
if o.mysql.state == ServiceState::Running && o.auth.state == ServiceState::Running && o.world.state == ServiceState::Running && o.secondary_world.as_ref().is_none_or(|s| s.state == ServiceState::Running) {
|
||||
let since = ready_since.get_or_insert_with(std::time::Instant::now);
|
||||
if since.elapsed() >= std::time::Duration::from_secs(10) { break true; }
|
||||
} else {
|
||||
ready_since = None;
|
||||
}
|
||||
if std::time::Instant::now() > deadline {
|
||||
break false;
|
||||
}
|
||||
std::thread::sleep(std::time::Duration::from_secs(2));
|
||||
}
|
||||
};
|
||||
if healthy {
|
||||
return Ok(());
|
||||
}
|
||||
let cause = crate::driver::startup_failure(self.root, &started);
|
||||
// Leave the files unlocked so that a rollback can replace them.
|
||||
let _ = crate::driver::run(self.root, crate::driver::Verb::StopAll);
|
||||
Err(Error::Invalid(cause))
|
||||
self.validate_server(true)
|
||||
}
|
||||
|
||||
fn validate_recovery(&self) -> Result<()> {
|
||||
self.validate_server(false)
|
||||
}
|
||||
}
|
||||
|
||||
impl RepackEnv<'_> {
|
||||
fn validate_server(&self, check_schema: bool) -> Result<()> {
|
||||
let stopped = crate::driver::run(self.root, crate::driver::Verb::StopAll)?;
|
||||
if !stopped.ok { return Err(Error::Invalid("Could not stop the server before isolated validation.".into())); }
|
||||
self.ensure_stopped()?;
|
||||
self.recover_validation()?;
|
||||
let result = (|| -> Result<()> {
|
||||
crate::update_isolation::begin(self.root, self.meta_dir)?;
|
||||
use crate::process::{observe, ServiceState};
|
||||
if check_schema { crate::backup::with_database(self.root, |db| {
|
||||
let mut modes = vec![crate::realms::Mode::Coa];
|
||||
if crate::realms::state(self.root)?.wildcard_created { modes.push(crate::realms::Mode::Wildcard); }
|
||||
for mode in modes {
|
||||
if let Some(p) = crate::schema_check::check_with_report(&db.clone().for_realm(mode), self.root)?.first() {
|
||||
return Err(Error::Invalid(format!("Database validation failed on {}: {}.{}: {}", mode.name(), p.database, p.table, p.detail)));
|
||||
}
|
||||
}
|
||||
Ok(())
|
||||
})?; }
|
||||
// The check start is the first start of the new build: give the module configs the settings the update added
|
||||
// (as a normal start does), or the server logs a "missing property" line for every one of them.
|
||||
match crate::registry::MetaDir::open(self.meta_dir) {
|
||||
Ok((_, meta)) if meta.kind == crate::registry::InstallKind::New => {
|
||||
let _ = crate::config::materialize_module_configs(self.root);
|
||||
}
|
||||
// An imported server gets the files it lacks (nothing it has is changed).
|
||||
_ => {
|
||||
let _ = crate::config::create_missing_module_configs(self.root);
|
||||
}
|
||||
}
|
||||
let started = match crate::driver::validate_update(self.root) {
|
||||
Ok(out) => out,
|
||||
Err(e) => {
|
||||
let _ = crate::driver::run(self.root, crate::driver::Verb::StopAll);
|
||||
return Err(e);
|
||||
}
|
||||
};
|
||||
let ports = crate::layout::read_ports(self.root);
|
||||
let healthy = started.ok && {
|
||||
let deadline = std::time::Instant::now() + std::time::Duration::from_secs(180);
|
||||
let mut ready_since = None;
|
||||
loop {
|
||||
let o = observe(self.root, &ports);
|
||||
if o.mysql.state == ServiceState::Running && o.auth.state == ServiceState::Running && o.world.state == ServiceState::Running && o.secondary_world.as_ref().is_none_or(|s| s.state == ServiceState::Running) {
|
||||
let since = ready_since.get_or_insert_with(std::time::Instant::now);
|
||||
if since.elapsed() >= std::time::Duration::from_secs(10) { break true; }
|
||||
} else {
|
||||
ready_since = None;
|
||||
}
|
||||
if std::time::Instant::now() > deadline {
|
||||
break false;
|
||||
}
|
||||
std::thread::sleep(std::time::Duration::from_secs(2));
|
||||
}
|
||||
};
|
||||
if healthy {
|
||||
return Ok(());
|
||||
}
|
||||
let cause = crate::driver::startup_failure(self.root, &started);
|
||||
// Leave the files unlocked so that a rollback can replace them.
|
||||
let _ = crate::driver::run(self.root, crate::driver::Verb::StopAll);
|
||||
Err(Error::Invalid(cause))
|
||||
})();
|
||||
let stopped = crate::driver::run(self.root, crate::driver::Verb::StopAll)?;
|
||||
if !stopped.ok {
|
||||
return Err(Error::Invalid("Isolated validation could not stop the server; recovery configurations were preserved.".into()));
|
||||
}
|
||||
self.ensure_stopped()?;
|
||||
self.recover_validation()?;
|
||||
result
|
||||
}
|
||||
|
||||
}
|
||||
|
||||
fn database_identities(db: &crate::db::Db) -> Result<BTreeMap<String, std::collections::BTreeSet<String>>> {
|
||||
let db = db.clone().for_realm(crate::realms::Mode::Coa);
|
||||
let mut identities = BTreeMap::new();
|
||||
for (schema, table, columns) in [
|
||||
("acore_characters", "characters", "guid,account,HEX(name)"),
|
||||
("acore_characters_wildcard", "characters", "guid,account,HEX(name)"),
|
||||
("acore_auth", "account", "id,HEX(username)"),
|
||||
] {
|
||||
if !db.schema_exists(schema)? || !db.tables(schema)?.iter().any(|name| name == table) { continue; }
|
||||
let rows = db.query(&format!("SELECT {columns} FROM `{schema}`.`{table}`;"))?;
|
||||
identities.insert(schema.into(), rows.lines().map(str::to_string).collect());
|
||||
}
|
||||
Ok(identities)
|
||||
}
|
||||
|
||||
fn verify_database_identities(db: &crate::db::Db, before: &BTreeMap<String, std::collections::BTreeSet<String>>) -> Result<()> {
|
||||
let after = database_identities(db)?;
|
||||
for (schema, expected) in before {
|
||||
if after.get(schema).is_none_or(|actual| !expected.is_subset(actual)) {
|
||||
return Err(Error::Invalid(format!("The private update changed or removed existing character or account identities in {schema}.")));
|
||||
}
|
||||
}
|
||||
Ok(())
|
||||
}
|
||||
|
||||
#[cfg(test)]
|
||||
@@ -983,6 +1224,11 @@ mod tests {
|
||||
use std::cell::{Cell, RefCell};
|
||||
|
||||
struct Fake {
|
||||
activation_expected: RefCell<Option<(PathBuf, String)>>,
|
||||
activation_failed: Cell<bool>,
|
||||
activated: Cell<bool>,
|
||||
automatic_rollback: Cell<bool>,
|
||||
recovery_healthy: Cell<bool>,
|
||||
stopped: Cell<bool>,
|
||||
healthy: Cell<bool>,
|
||||
snapshot_ok: Cell<bool>,
|
||||
@@ -990,15 +1236,32 @@ mod tests {
|
||||
migrate_fail: Cell<bool>,
|
||||
preflight_fail: Cell<bool>,
|
||||
restore_fail: Cell<bool>,
|
||||
rehearsal_fail: Cell<bool>,
|
||||
}
|
||||
|
||||
impl Fake {
|
||||
fn ok() -> Fake {
|
||||
Fake { stopped: Cell::new(true), healthy: Cell::new(true), snapshot_ok: Cell::new(true), calls: Default::default(), migrate_fail: Cell::new(false), preflight_fail: Cell::new(false), restore_fail: Cell::new(false) }
|
||||
Fake { activation_expected: RefCell::new(None), activation_failed: Cell::new(false), activated: Cell::new(false), automatic_rollback: Cell::new(false), recovery_healthy: Cell::new(true), stopped: Cell::new(true), healthy: Cell::new(true), snapshot_ok: Cell::new(true), calls: Default::default(), migrate_fail: Cell::new(false), preflight_fail: Cell::new(false), restore_fail: Cell::new(false), rehearsal_fail: Cell::new(false) }
|
||||
}
|
||||
}
|
||||
|
||||
impl Env for Fake {
|
||||
fn rehearse(&self, _: &Manifest, _: &Path, _: &[PlanItem], _: &str) -> Result<()> {
|
||||
if self.rehearsal_fail.get() { Err(Error::Invalid("SQL failed in the private copy".into())) } else { Ok(()) }
|
||||
}
|
||||
fn activate(&self) -> Result<()> {
|
||||
if let Some((meta, version)) = self.activation_expected.borrow().as_ref() {
|
||||
ensure_recovered(meta)?;
|
||||
assert_eq!(MetaDir::open(meta)?.1.core.version.as_ref(), Some(version));
|
||||
}
|
||||
self.activated.set(true);
|
||||
if self.activation_failed.get() { Err(Error::Invalid("Public startup failed".into())) } else { Ok(()) }
|
||||
}
|
||||
fn automatic_rollback(&self) -> bool { self.automatic_rollback.get() }
|
||||
fn validate_recovery(&self) -> Result<()> {
|
||||
self.calls.borrow_mut().push("validate-recovery");
|
||||
if self.recovery_healthy.get() { Ok(()) } else { Err(Error::Invalid("Restored server is unhealthy".into())) }
|
||||
}
|
||||
fn preflight(&self, _: &Manifest) -> Result<()> {
|
||||
if self.preflight_fail.get() { Err(Error::Invalid("Conflicting migration history".into())) } else { Ok(()) }
|
||||
}
|
||||
@@ -1195,6 +1458,26 @@ mod tests {
|
||||
assert!(!w.root.join("Core/worldserver.exe.coa-new").exists());
|
||||
}
|
||||
|
||||
#[test]
|
||||
fn public_startup_requires_a_completed_transaction_and_saved_version() {
|
||||
let w = world(&[], false);
|
||||
let env = Fake::ok();
|
||||
*env.activation_expected.borrow_mut() = Some((w.meta.clone(), "2.0.0".into()));
|
||||
run(&w, &env, BTreeMap::new(), None).unwrap();
|
||||
assert!(env.activated.get());
|
||||
}
|
||||
|
||||
#[test]
|
||||
fn startup_failure_after_commit_does_not_restore_a_live_database() {
|
||||
let w = world(&[], true);
|
||||
let env = Fake::ok();
|
||||
env.activation_failed.set(true);
|
||||
assert!(run(&w, &env, BTreeMap::new(), None).is_err());
|
||||
assert!(ensure_recovered(&w.meta).is_ok());
|
||||
assert_eq!(MetaDir::open(&w.meta).unwrap().1.core.version.as_deref(), Some("2.0.0"));
|
||||
assert!(!env.calls.borrow().contains(&"restore-databases"));
|
||||
}
|
||||
|
||||
#[test]
|
||||
fn an_integrated_launcher_is_current_but_user_edits_and_new_package_bytes_are_not() {
|
||||
let source = b"import sys\nfrom pathlib import Path\nfrom squid_playerbots import configure\nROOT = Path(__file__).resolve().parents[1]\n";
|
||||
@@ -1269,6 +1552,46 @@ mod tests {
|
||||
assert_eq!(fs::read(saved).unwrap(), b"my-custom-build", "the replaced custom build is kept for rollback");
|
||||
}
|
||||
|
||||
#[test]
|
||||
fn power_loss_during_bulk_files_restores_written_and_unwritten_files() {
|
||||
let d = tempfile::tempdir().unwrap();
|
||||
let root = d.path().join("root");
|
||||
let meta = d.path().join("meta");
|
||||
let tree = d.path().join("tree");
|
||||
let before = meta.join("updates/bulk/before");
|
||||
let mut files = Vec::new();
|
||||
let mut ops = Vec::new();
|
||||
for (path, previous) in [("Data/maps/first.map", true), ("Data/maps/new.map", false), ("Data/maps/last.map", true)] {
|
||||
if previous { write(&root, path, b"old"); }
|
||||
write(&tree, path, b"new");
|
||||
let hash = fsx::sha256_file(&tree.join(path)).unwrap();
|
||||
files.push(FileEntry { path: path.into(), sha256: hash.clone(), size: 3, policy: ReplacePolicy::Replace, owner: crate::manifest::Owner::Core });
|
||||
ops.push(Op { path: path.into(), action: if previous { Action::Replace } else { Action::Create }, reason: None,
|
||||
new_sha256: hash, had_previous: previous, started: false, done: false });
|
||||
}
|
||||
let mut txn = Txn { id: "bulk".into(), state: State::Applying, from_version: Some("1".into()), to_version: "2".into(),
|
||||
recovery_point: None, databases_started: false, ops, message: None, recovery_hashes: BTreeMap::new() };
|
||||
fs::create_dir_all(before.parent().unwrap()).unwrap();
|
||||
assert!(apply_ops(&root, &tree, &before, &files, &mut txn, &meta, Some(2)).is_err());
|
||||
// A power loss sees the pre-write checkpoint, not the in-memory completed flags.
|
||||
let mut durable = load(&meta, "bulk").unwrap();
|
||||
assert!(durable.ops.iter().all(|op| op.started && !op.done));
|
||||
assert_eq!(fs::read(root.join("Data/maps/last.map")).unwrap(), b"old");
|
||||
restore_files(&root, &before, &mut durable).unwrap();
|
||||
assert_eq!(fs::read(root.join("Data/maps/first.map")).unwrap(), b"old");
|
||||
assert_eq!(fs::read(root.join("Data/maps/last.map")).unwrap(), b"old");
|
||||
assert!(!root.join("Data/maps/new.map").exists());
|
||||
// If preparing any recovery copy fails, no destination may be changed.
|
||||
for op in &mut durable.ops { op.started = false; op.done = false; }
|
||||
durable.recovery_hashes.clear();
|
||||
save(&meta, &durable).unwrap();
|
||||
fs::remove_file(root.join("Data/maps/last.map")).unwrap();
|
||||
assert!(apply_ops(&root, &tree, &before, &files, &mut durable, &meta, None).is_err());
|
||||
assert_eq!(fs::read(root.join("Data/maps/first.map")).unwrap(), b"old");
|
||||
assert!(!root.join("Data/maps/new.map").exists());
|
||||
assert!(load(&meta, "bulk").unwrap().ops.iter().all(|op| !op.started));
|
||||
}
|
||||
|
||||
#[test]
|
||||
fn failure_in_the_middle_of_applying_restores_every_file_byte_for_byte() {
|
||||
for fail_after in [0usize, 1, 2] {
|
||||
@@ -1304,6 +1627,75 @@ mod tests {
|
||||
assert!(rollback(&w.root, &w.meta, &out.txn.id, &env).is_err(), "already rolled back");
|
||||
}
|
||||
|
||||
#[test]
|
||||
fn automatic_health_failure_restores_databases_files_and_checks_recovery() {
|
||||
let w = world(&[], true);
|
||||
let env = Fake::ok();
|
||||
env.automatic_rollback.set(true);
|
||||
env.healthy.set(false);
|
||||
assert!(run(&w, &env, BTreeMap::new(), None).unwrap_err().to_string().contains("restored"));
|
||||
assert_eq!(read(&w, "Core/worldserver.exe"), b"world-v1");
|
||||
assert!(!w.root.join("Core/newfile.dll").exists());
|
||||
assert!(env.calls.borrow().contains(&"restore-databases"));
|
||||
assert!(env.calls.borrow().contains(&"validate-recovery"));
|
||||
assert!(unfinished(&w.meta).is_none());
|
||||
}
|
||||
|
||||
#[test]
|
||||
fn incompatible_source_or_platform_is_rejected_without_touching_installation() {
|
||||
let w = world(&[], false);
|
||||
let (_, meta) = MetaDir::open(&w.meta).unwrap();
|
||||
let mut manifest = Manifest::parse(&fs::read(w.pkg.join("manifest.json")).unwrap()).unwrap();
|
||||
manifest.min_manager_version = "0.6.13".into();
|
||||
manifest.core.commit = Some("a".repeat(40));
|
||||
manifest.compatibility = Some(crate::manifest::Compatibility { schema: 1,
|
||||
platform: if cfg!(windows) { "windows-x86_64" } else { "linux-x86_64" }.into(),
|
||||
core_commit: "a".repeat(40), module_commits: [("squid".into(), "b".repeat(40))].into(),
|
||||
source_databases: Default::default(), client_patch_version: "1.5.1".into(), source_versions: vec!["1.0.0".into()] });
|
||||
manifest.validate().unwrap();
|
||||
validate_candidate(&meta, &manifest).unwrap();
|
||||
manifest.compatibility.as_mut().unwrap().source_versions = vec!["0.9.0".into()];
|
||||
assert!(validate_candidate(&meta, &manifest).unwrap_err().to_string().contains("compatibility matrix"));
|
||||
manifest.compatibility.as_mut().unwrap().source_versions = vec!["1.0.0".into()];
|
||||
manifest.compatibility.as_mut().unwrap().platform = if cfg!(windows) { "linux-x86_64" } else { "windows-x86_64" }.into();
|
||||
assert!(validate_candidate(&meta, &manifest).unwrap_err().to_string().contains("targets"));
|
||||
assert_eq!(read(&w, "Core/worldserver.exe"), b"world-v1");
|
||||
assert!(unfinished(&w.meta).is_none());
|
||||
}
|
||||
|
||||
#[test]
|
||||
fn changed_installed_schema_contract_blocks_before_database_access() {
|
||||
let w = world(&[], false);
|
||||
write(&w.root, "Scripts/database-schema.json", b"modified schema contract");
|
||||
let mut manifest = Manifest::parse(&fs::read(w.pkg.join("manifest.json")).unwrap()).unwrap();
|
||||
manifest.compatibility = Some(crate::manifest::Compatibility { schema: 1,
|
||||
platform: "windows-x86_64".into(), core_commit: "a".repeat(40),
|
||||
module_commits: [("squid".into(), "b".repeat(40))].into(), client_patch_version: "1.5.1".into(),
|
||||
source_versions: vec!["1.0.0".into()],
|
||||
source_databases: [("1.0.0".into(), crate::manifest::SourceDatabase {
|
||||
manifest_sha256: "a".repeat(64), schema_sha256: Some("b".repeat(64)) })].into() });
|
||||
let env = RepackEnv { root: &w.root, meta_dir: &w.meta };
|
||||
let error = env.preflight(&manifest).unwrap_err().to_string();
|
||||
assert!(error.contains("schema contract differs"), "{error}");
|
||||
assert!(!w.root.join("Runtime/python/python.exe").exists());
|
||||
assert_eq!(read(&w, "Core/worldserver.exe"), b"world-v1");
|
||||
assert!(unfinished(&w.meta).is_none());
|
||||
}
|
||||
|
||||
#[test]
|
||||
fn unhealthy_restoration_preserves_recovery_and_blocks_startup() {
|
||||
let w = world(&[], true);
|
||||
let env = Fake::ok();
|
||||
env.automatic_rollback.set(true);
|
||||
env.healthy.set(false);
|
||||
env.recovery_healthy.set(false);
|
||||
assert!(run(&w, &env, BTreeMap::new(), None).unwrap_err().to_string().contains("Recovery failed"));
|
||||
let pending = unfinished(&w.meta).unwrap();
|
||||
assert_eq!(pending.state, State::Failed);
|
||||
assert!(txn_dir(&w.meta, &pending.id).unwrap().join("before").exists());
|
||||
assert!(ensure_recovered(&w.meta).is_err());
|
||||
}
|
||||
|
||||
#[test]
|
||||
fn retrying_startup_commits_without_reapplying_sql_or_restoring_databases() {
|
||||
let w = world(&[], true);
|
||||
@@ -1497,6 +1889,23 @@ mod tests {
|
||||
assert!(fs::read_dir(w.meta.join("updates")).unwrap().next().is_none());
|
||||
}
|
||||
|
||||
#[test]
|
||||
fn failed_rehearsal_preserves_installed_files_version_and_recovery_point() {
|
||||
let w = world(&[], true);
|
||||
let env = Fake::ok();
|
||||
env.rehearsal_fail.set(true);
|
||||
let original = fsx::sha256_file(&w.meta.join("install.json")).unwrap();
|
||||
let error = run(&w, &env, BTreeMap::new(), None).unwrap_err();
|
||||
assert!(error.to_string().contains("installed server was not updated"));
|
||||
assert_eq!(read(&w, "Core/worldserver.exe"), b"world-v1");
|
||||
assert_eq!(fsx::sha256_file(&w.meta.join("install.json")).unwrap(), original);
|
||||
assert_eq!(&*env.calls.borrow(), &["stop", "snapshot"]);
|
||||
assert!(pending_checked(&w.meta).unwrap().is_none());
|
||||
let journal = journals(&w.meta).unwrap().remove(0);
|
||||
assert_eq!(journal.recovery_point.as_deref(), Some("rp-1"));
|
||||
assert!(!journal.databases_started && journal.ops.is_empty());
|
||||
}
|
||||
|
||||
#[test]
|
||||
fn missing_and_semantically_corrupt_journals_block_operations() {
|
||||
let w = world(&[], false);
|
||||
|
||||
@@ -0,0 +1,163 @@
|
||||
use std::{collections::BTreeMap, fs, path::Path};
|
||||
use serde::{Deserialize, Serialize};
|
||||
use crate::{config::parser::ConfFile, fsx, Error, Result};
|
||||
|
||||
const FILES: &[&str] = &[
|
||||
"Settings/repack.json", "Settings/realm-profile.json",
|
||||
"Settings/worldserver.conf.template", "Settings/authserver.conf.template",
|
||||
"Core/configs/worldserver.conf", "Core/configs/authserver.conf",
|
||||
"Settings/realm-profiles/coa.json", "Settings/realm-profiles/wildcard.json",
|
||||
".realms/secondary/Settings/repack.json", ".realms/secondary/Settings/realm-profile.json",
|
||||
".realms/secondary/Settings/worldserver.conf.template", ".realms/secondary/Settings/authserver.conf.template",
|
||||
".realms/secondary/Core/configs/worldserver.conf", ".realms/secondary/Core/configs/authserver.conf",
|
||||
];
|
||||
|
||||
#[derive(Serialize, Deserialize)]
|
||||
#[serde(deny_unknown_fields)]
|
||||
struct Saved { bytes: Option<Vec<u8>>, sha256: Option<String> }
|
||||
|
||||
pub(crate) fn pending(meta: &Path) -> bool { meta.join("validation-configs.json").exists() }
|
||||
|
||||
pub(crate) fn begin(root: &Path, meta: &Path) -> Result<()> {
|
||||
if pending(meta) { return Err(Error::Invalid("Interrupted isolated validation must be recovered first.".into())); }
|
||||
let mut saved = BTreeMap::new();
|
||||
for rel in FILES {
|
||||
let path = fsx::ensure_within(root, &fsx::safe_join(root, rel)?)?;
|
||||
let bytes = if path.exists() { Some(fs::read(path)?) } else { None };
|
||||
let sha256 = bytes.as_ref().map(|b| fsx::sha256_bytes(b));
|
||||
saved.insert(*rel, Saved { bytes, sha256 });
|
||||
}
|
||||
let mut settings: serde_json::Value = fsx::read_json(&root.join("Settings/repack.json"))?;
|
||||
let mut realm: Option<serde_json::Value> = if root.join("Settings/realm-profile.json").exists() {
|
||||
Some(fsx::read_json(&root.join("Settings/realm-profile.json"))?)
|
||||
} else { None };
|
||||
let mut excluded: std::collections::BTreeSet<u64> = ["mysqlPort", "authPort", "worldPort", "raPort"].iter()
|
||||
.filter_map(|key| settings[*key].as_u64()).collect();
|
||||
if let Some(state) = &realm {
|
||||
excluded.extend(["secondary_world_port", "secondary_ra_port"].iter().filter_map(|key| state[*key].as_u64()));
|
||||
}
|
||||
let mut sockets = Vec::new();
|
||||
let mut reserve = || -> Result<u16> {
|
||||
loop {
|
||||
let socket = std::net::TcpListener::bind("127.0.0.1:0")?;
|
||||
let port = socket.local_addr()?.port();
|
||||
if excluded.insert(u64::from(port)) {
|
||||
sockets.push(socket);
|
||||
return Ok(port);
|
||||
}
|
||||
}
|
||||
};
|
||||
for key in ["authPort", "worldPort", "raPort"] { settings[key] = reserve()?.into(); }
|
||||
if let Some(state) = &mut realm {
|
||||
for key in ["secondary_world_port", "secondary_ra_port"] {
|
||||
state[key] = reserve()?.into();
|
||||
}
|
||||
}
|
||||
let mut configs = Vec::new();
|
||||
for rel in ["Settings/worldserver.conf.template", "Settings/authserver.conf.template", "Core/configs/worldserver.conf", "Core/configs/authserver.conf"] {
|
||||
let path = root.join(rel);
|
||||
if !path.exists() && rel.ends_with(".template") {
|
||||
return Err(Error::Invalid(format!("Cannot isolate validation without {rel}.")));
|
||||
}
|
||||
if path.exists() {
|
||||
let mut conf = ConfFile::parse_bytes(&fs::read(&path)?)?;
|
||||
conf.set("BindIP", "\"127.0.0.1\"", &[]);
|
||||
if rel.contains("worldserver") { conf.set("Ra.IP", "\"127.0.0.1\"", &[]); }
|
||||
configs.push((path, conf.to_text()));
|
||||
}
|
||||
}
|
||||
fsx::atomic_write_json(&meta.join("validation-configs.json"), &saved)?;
|
||||
fsx::atomic_write_json(&root.join("Settings/repack.json"), &settings)?;
|
||||
if let Some(state) = realm { fsx::atomic_write_json(&root.join("Settings/realm-profile.json"), &state)?; }
|
||||
for (path, text) in configs { fsx::atomic_write(&path, text.as_bytes())?; }
|
||||
Ok(())
|
||||
}
|
||||
|
||||
#[cfg(test)]
|
||||
mod tests {
|
||||
use super::*;
|
||||
|
||||
fn fixture() -> (tempfile::TempDir, std::path::PathBuf, std::path::PathBuf) {
|
||||
let dir = tempfile::tempdir().unwrap();
|
||||
let root = dir.path().join("server");
|
||||
let meta = dir.path().join("metadata");
|
||||
fs::create_dir_all(root.join("Settings")).unwrap();
|
||||
fs::create_dir_all(&meta).unwrap();
|
||||
fsx::atomic_write_json(&root.join(FILES[0]), &serde_json::json!({"mysqlPort":3306,"authPort":3724,"worldPort":8085,"raPort":3443})).unwrap();
|
||||
fsx::atomic_write_json(&root.join(FILES[1]), &serde_json::json!({"simultaneous":true,"secondary_world_port":8086,"secondary_ra_port":3444})).unwrap();
|
||||
for rel in [FILES[2], FILES[3]] {
|
||||
fsx::atomic_write(&root.join(rel), b"BindIP = \"0.0.0.0\"\r\nRa.IP = \"0.0.0.0\"\r\n").unwrap();
|
||||
}
|
||||
(dir, root, meta)
|
||||
}
|
||||
|
||||
#[test]
|
||||
fn interrupted_validation_restores_original_bytes_and_absent_files() {
|
||||
let (_dir, root, meta) = fixture();
|
||||
let original: Vec<_> = FILES.iter().map(|p| fs::read(root.join(p)).ok()).collect();
|
||||
begin(&root, &meta).unwrap();
|
||||
assert!(crate::update::ensure_recovered(&meta).is_err());
|
||||
assert!(begin(&root, &meta).is_err());
|
||||
let settings: serde_json::Value = fsx::read_json(&root.join(FILES[0])).unwrap();
|
||||
assert_eq!(settings["mysqlPort"], 3306);
|
||||
let realm: serde_json::Value = fsx::read_json(&root.join(FILES[1])).unwrap();
|
||||
let ports: std::collections::BTreeSet<_> = [settings["authPort"].as_u64(), settings["worldPort"].as_u64(), settings["raPort"].as_u64(), realm["secondary_world_port"].as_u64(), realm["secondary_ra_port"].as_u64()].into_iter().collect();
|
||||
assert_eq!(ports.len(), 5);
|
||||
let config = ConfFile::parse_bytes(&fs::read(root.join(FILES[2])).unwrap()).unwrap();
|
||||
assert_eq!(config.get("BindIP"), Some("\"127.0.0.1\""));
|
||||
fsx::atomic_write(&root.join(FILES[4]), b"rendered temporary configuration").unwrap();
|
||||
restore(&root, &meta).unwrap();
|
||||
for (rel, bytes) in FILES.iter().zip(original) { assert_eq!(fs::read(root.join(rel)).ok(), bytes); }
|
||||
assert!(!pending(&meta));
|
||||
restore(&root, &meta).unwrap();
|
||||
}
|
||||
|
||||
#[test]
|
||||
fn damaged_recovery_copy_blocks_all_restoration() {
|
||||
let (_dir, root, meta) = fixture();
|
||||
begin(&root, &meta).unwrap();
|
||||
let journal = meta.join("validation-configs.json");
|
||||
let mut saved: BTreeMap<String, Saved> = fsx::read_json(&journal).unwrap();
|
||||
saved.get_mut(FILES[0]).unwrap().bytes = Some(b"damaged".to_vec());
|
||||
fsx::atomic_write_json(&journal, &saved).unwrap();
|
||||
let before = fs::read(root.join(FILES[2])).unwrap();
|
||||
assert!(restore(&root, &meta).is_err());
|
||||
assert_eq!(fs::read(root.join(FILES[2])).unwrap(), before);
|
||||
assert!(pending(&meta));
|
||||
}
|
||||
|
||||
#[test]
|
||||
fn missing_template_fails_before_any_configuration_changes() {
|
||||
let (_dir, root, meta) = fixture();
|
||||
fs::remove_file(root.join(FILES[3])).unwrap();
|
||||
let before = fs::read(root.join(FILES[0])).unwrap();
|
||||
assert!(begin(&root, &meta).is_err());
|
||||
assert!(!pending(&meta));
|
||||
assert_eq!(fs::read(root.join(FILES[0])).unwrap(), before);
|
||||
}
|
||||
}
|
||||
|
||||
pub(crate) fn restore(root: &Path, meta: &Path) -> Result<()> {
|
||||
if !pending(meta) { return Ok(()); }
|
||||
let journal = meta.join("validation-configs.json");
|
||||
let saved: BTreeMap<String, Saved> = fsx::read_json(&journal)?;
|
||||
if saved.len() != FILES.len() || FILES.iter().any(|rel| !saved.contains_key(*rel)) {
|
||||
return Err(Error::Invalid("Isolated validation configuration journal is incomplete.".into()));
|
||||
}
|
||||
for (rel, file) in &saved {
|
||||
fsx::ensure_within(root, &fsx::safe_join(root, rel)?)?;
|
||||
if file.bytes.as_ref().map(|b| fsx::sha256_bytes(b)) != file.sha256 {
|
||||
return Err(Error::Invalid(format!("Isolated validation recovery copy {rel} is damaged.")));
|
||||
}
|
||||
}
|
||||
for (rel, file) in saved {
|
||||
let path = fsx::ensure_within(root, &fsx::safe_join(root, &rel)?)?;
|
||||
match file.bytes {
|
||||
Some(bytes) => fsx::atomic_write(&path, &bytes)?,
|
||||
None if path.exists() => fs::remove_file(path)?,
|
||||
None => {},
|
||||
}
|
||||
}
|
||||
fs::remove_file(journal)?;
|
||||
Ok(())
|
||||
}
|
||||
@@ -47,6 +47,36 @@ fn run() -> Result<(), String> {
|
||||
let e = |x: coa_core::Error| x.to_string();
|
||||
let part = a.get("part-size").and_then(|v| v.parse().ok()).unwrap_or(DEFAULT_PART_SIZE);
|
||||
match cmd.as_str() {
|
||||
"qualify-upgrade" => {
|
||||
let report = coa_core::release_schema::qualify_upgrade(
|
||||
&PathBuf::from(need(&a, "base")?), &PathBuf::from(need(&a, "source")?),
|
||||
&PathBuf::from(need(&a, "candidate")?), &PathBuf::from(need(&a, "fixture")?),
|
||||
coa_core::signing::EMBEDDED_PUBLIC_KEY,
|
||||
).map_err(e)?;
|
||||
coa_core::fsx::atomic_write_json(&PathBuf::from(need(&a, "report")?), &report).map_err(e)?;
|
||||
println!("Manager upgrade transaction passed isolated qualification");
|
||||
}
|
||||
"qualify-startup" => {
|
||||
coa_core::release_schema::validate_startup(
|
||||
&PathBuf::from(need(&a, "fixture")?), &PathBuf::from(need(&a, "tree")?),
|
||||
&PathBuf::from(need(&a, "base")?), coa_core::signing::EMBEDDED_PUBLIC_KEY,
|
||||
).map_err(e)?;
|
||||
println!("authserver and worldserver passed isolated startup qualification");
|
||||
}
|
||||
"verify-channel" => {
|
||||
let bytes = std::fs::read(need(&a, "file")?).map_err(|x| x.to_string())?;
|
||||
let pointer = coa_core::channels::verify(&bytes, need(&a, "channel")?, coa_core::signing::EMBEDDED_PUBLIC_KEY).map_err(e)?;
|
||||
println!("{}", serde_json::to_string(&pointer).map_err(|x| x.to_string())?);
|
||||
}
|
||||
"verify-manifest" => {
|
||||
let source = coa_core::pkgsource::Source::Dir(PathBuf::from(need(&a, "dir")?));
|
||||
let (manifest, _) = coa_core::pkgsource::fetch_manifest(&source, coa_core::signing::EMBEDDED_PUBLIC_KEY).map_err(e)?;
|
||||
println!("verified signed manifest {}", manifest.version);
|
||||
}
|
||||
"verify-upgrade-fixture" => {
|
||||
coa_core::release_schema::verify_upgrade_fixture(&PathBuf::from(need(&a, "dir")?), coa_core::signing::EMBEDDED_PUBLIC_KEY).map_err(e)?;
|
||||
println!("verified signed upgrade fixture and every archive file");
|
||||
}
|
||||
"extract-schema-base" => {
|
||||
coa_core::release_schema::extract_base(
|
||||
&PathBuf::from(need(&a, "package")?), &PathBuf::from(need(&a, "fixture")?),
|
||||
@@ -112,6 +142,16 @@ fn run() -> Result<(), String> {
|
||||
coa_core::release_schema::verify_package(&dir, coa_core::signing::EMBEDDED_PUBLIC_KEY).map_err(e)?;
|
||||
println!("signature, archive contents and database schema contract OK");
|
||||
}
|
||||
"sign-channel" => {
|
||||
let pointer = coa_core::channels::Pointer {
|
||||
schema: 1, channel: need(&a, "channel")?.clone(),
|
||||
version: need(&a, "version")?.clone(),
|
||||
release_tag: format!("server-{}", need(&a, "version")?),
|
||||
snapshot: need(&a, "snapshot")?.clone(),
|
||||
};
|
||||
let bytes = coa_core::channels::sign(&pointer, &signing_key()?).map_err(e)?;
|
||||
coa_core::fsx::atomic_write(&PathBuf::from(need(&a, "out")?), &bytes).map_err(e)?;
|
||||
}
|
||||
other => return Err(format!("unknown command {other}")),
|
||||
}
|
||||
Ok(())
|
||||
|
||||
@@ -422,6 +422,18 @@ hand over to `coa_core::docker`; nothing else needed to change for start, stop,
|
||||
DivxTac.dll deadlocks the world loading screen under wine-mono. `COA_PROTONPATH`, `COA_WINEPREFIX` or
|
||||
`client-launch.json` in the Manager's folder (`proton_path`, `prefix`, `runner`) override the detection. Whether the client
|
||||
runs is read from `/proc` (under Wine the command line holds the Windows form of the path). Output goes to `client.log`.
|
||||
* **Sharing with friends** (`docker/sharing.rs`): who can reach the game is decided by the address the container ports are
|
||||
published on, `bindAddress` in `docker.json`; the `BindIP` of the configuration files is forced to `0.0.0.0` inside the
|
||||
containers and changes nothing. Opening and closing therefore edit `bindAddress` (and set `CoA.AllowRemoteClients`), "servers
|
||||
open" and the exposure check are computed from it (the database is never published, the console only on `127.0.0.1`), and
|
||||
there is no firewall row on Linux. Settings the backend fixes (`docker::FORCED_KEYS`) are not offered; a test keeps that list
|
||||
equal to the variables the containers get. A world that restarts itself (exit code 2) is restarted by Docker once it has come
|
||||
up. The database console shows `docker logs`, and the file-based screens read Linux locations (the desktop folder from the
|
||||
user directories file, memory from `/proc/meminfo`, the distribution name for the problem report).
|
||||
* **Game data folder** (`docker::game_data_dir` / `set_game_data`, Settings card): `dataDir` in `docker.json` can be changed
|
||||
after the install, only while the world and auth are stopped, and only to a folder that passes the install checks. A world
|
||||
that stops with "does not hold the CoA client dbc set" is reported as `GameDataMismatch` (wrong data set: the standard one,
|
||||
not Conquest of Azeroth's) instead of a bare failure.
|
||||
* **Not done yet**: downloading the game data, updates, port conflict detection, the firewall and exposure checks, the
|
||||
Wildcard realm profiles, and the client under Wine/Proton.
|
||||
|
||||
|
||||
Generated
+2
-2
@@ -1,12 +1,12 @@
|
||||
{
|
||||
"name": "coa-server-manager",
|
||||
"version": "0.6.12",
|
||||
"version": "0.6.15",
|
||||
"lockfileVersion": 3,
|
||||
"requires": true,
|
||||
"packages": {
|
||||
"": {
|
||||
"name": "coa-server-manager",
|
||||
"version": "0.6.12",
|
||||
"version": "0.6.15",
|
||||
"dependencies": {
|
||||
"@tauri-apps/api": "^2.12.0",
|
||||
"@tauri-apps/plugin-dialog": "^2.8.0",
|
||||
|
||||
+1
-1
@@ -1,7 +1,7 @@
|
||||
{
|
||||
"name": "coa-server-manager",
|
||||
"private": true,
|
||||
"version": "0.6.12",
|
||||
"version": "0.6.15",
|
||||
"license": "AGPL-3.0-only",
|
||||
"type": "module",
|
||||
"scripts": {
|
||||
|
||||
+72
-19
@@ -39,12 +39,16 @@ struct AppState {
|
||||
/// Where signed update packages are published; override with COA_UPDATE_SOURCE (URL or local package folder).
|
||||
const DEFAULT_UPDATE_URL: &str = "https://github.com/Corfirean/coa-server-build/releases/download/stable";
|
||||
|
||||
fn update_source(custom: Option<String>) -> Source {
|
||||
fn update_source(custom: Option<String>) -> Result<Source> {
|
||||
let pick = custom.filter(|s| !s.trim().is_empty()).or_else(|| std::env::var("COA_UPDATE_SOURCE").ok());
|
||||
match pick {
|
||||
Some(p) if p.to_ascii_lowercase().starts_with("http") => Source::Url(p),
|
||||
Some(p) => Source::Dir(PathBuf::from(p)),
|
||||
None => Source::Url(DEFAULT_UPDATE_URL.into()),
|
||||
Some(p) if p.to_ascii_lowercase().starts_with("http") => Ok(Source::Url(p)),
|
||||
Some(p) => Ok(Source::Dir(PathBuf::from(p))),
|
||||
None => match coa_core::channels::resolve("stable") {
|
||||
Ok(source) => Ok(source),
|
||||
Err(Error::PackageNotPublished(_)) => Ok(Source::Url(DEFAULT_UPDATE_URL.into())),
|
||||
Err(error) => Err(error),
|
||||
},
|
||||
}
|
||||
}
|
||||
|
||||
@@ -106,6 +110,31 @@ fn summary(id: String, path: PathBuf) -> ServerSummary {
|
||||
ServerSummary { id, name, path: path.to_string_lossy().into_owned() }
|
||||
}
|
||||
|
||||
/// The game data folder of a Docker server; none for a repack, whose data is inside its own folder.
|
||||
#[tauri::command]
|
||||
fn game_data_folder(state: State<'_, AppState>, id: String) -> std::result::Result<Option<String>, UiError> {
|
||||
let root = path_of(&state, &id)?;
|
||||
if !coa_core::docker::is_docker(&root) {
|
||||
return Ok(None);
|
||||
}
|
||||
Ok(Some(coa_core::docker::game_data_dir(&root)?.to_string_lossy().into_owned()))
|
||||
}
|
||||
|
||||
/// Point a Docker server at another game data folder. The servers must be stopped.
|
||||
#[tauri::command]
|
||||
async fn set_game_data_folder(state: State<'_, AppState>, id: String, path: String) -> std::result::Result<String, UiError> {
|
||||
let root = path_of(&state, &id)?;
|
||||
let _guard = BusyGuard::acquire(&state, &id)?;
|
||||
blocking(move || {
|
||||
if !coa_core::docker::is_docker(&root) {
|
||||
return Err(Error::Invalid("The game data of this server is inside its folder.".into()));
|
||||
}
|
||||
coa_core::docker::set_game_data(&root, std::path::Path::new(&path))?;
|
||||
Ok(path)
|
||||
})
|
||||
.await
|
||||
}
|
||||
|
||||
#[tauri::command]
|
||||
fn default_install_dir() -> String {
|
||||
if platform::flavor() == Flavor::Docker {
|
||||
@@ -152,7 +181,9 @@ async fn add_server(state: State<'_, AppState>, path: String) -> std::result::Re
|
||||
meta.core.version = report.banner_revision.clone();
|
||||
meta.database.port = Some(report.ports.mysql);
|
||||
meta.database.schemas = report.database_schemas.clone();
|
||||
for (rel, exe) in [("Core/worldserver.exe", &report.worldserver), ("Core/authserver.exe", &report.authserver)] {
|
||||
// The executables are `worldserver.exe` in a repack and `worldserver` in a Docker server; the file check reads these names.
|
||||
let exe_names = if coa_core::docker::is_docker(std::path::Path::new(&report.path)) { ("Core/worldserver", "Core/authserver") } else { ("Core/worldserver.exe", "Core/authserver.exe") };
|
||||
for (rel, exe) in [(exe_names.0, &report.worldserver), (exe_names.1, &report.authserver)] {
|
||||
if let Some(e) = exe {
|
||||
meta.original_hashes.insert(rel.into(), e.sha256.clone());
|
||||
}
|
||||
@@ -645,7 +676,7 @@ async fn repair_server(app: AppHandle, state: State<'_, AppState>, id: String) -
|
||||
let _guard = BusyGuard::acquire(&state, &id)?;
|
||||
blocking(move || {
|
||||
let dir = meta_dir(&root)?;
|
||||
coa_core::repair::run(&root, &dir, &package_source(None), &update_source(None), coa_core::signing::EMBEDDED_PUBLIC_KEY, &|step,percent| {
|
||||
coa_core::repair::run(&root, &dir, &package_source(None), &update_source(None)?, coa_core::signing::EMBEDDED_PUBLIC_KEY, &|step,percent| {
|
||||
let _ = app.emit("repair-progress", serde_json::json!({ "id": id, "step": step, "percent": percent }));
|
||||
})
|
||||
}).await
|
||||
@@ -664,9 +695,9 @@ async fn module_set_enabled(state: State<'_, AppState>, id: String, module: Stri
|
||||
|
||||
#[tauri::command]
|
||||
async fn custom_races_status(state: State<'_, AppState>, id: String) -> std::result::Result<Option<coa_core::custom_races::ClientPatchStatus>, UiError> {
|
||||
let root = path_of(&state, &id)?;
|
||||
let ctx = client_context(&state, &id)?;
|
||||
blocking(move || {
|
||||
let client = linked_client(&root)?;
|
||||
let client = ctx.linked();
|
||||
Ok(client.as_deref().map(coa_core::custom_races::client_patch_status))
|
||||
})
|
||||
.await
|
||||
@@ -674,12 +705,12 @@ async fn custom_races_status(state: State<'_, AppState>, id: String) -> std::res
|
||||
|
||||
#[tauri::command]
|
||||
async fn custom_races_install(app: AppHandle, state: State<'_, AppState>, id: String) -> std::result::Result<(), UiError> {
|
||||
let root = path_of(&state, &id)?;
|
||||
let ctx = client_context(&state, &id)?;
|
||||
let _guard = BusyGuard::acquire(&state, &id)?;
|
||||
let cancel = begin_client_job(&state)?;
|
||||
let sid = id.clone();
|
||||
let result = blocking(move || {
|
||||
let client = linked_client(&root)?.ok_or_else(|| Error::Invalid("No game client is linked to this server.".into()))?;
|
||||
let client = ctx.require()?;
|
||||
coa_core::custom_races::install_client_patches(&client, &cancel, &|step, percent| {
|
||||
let _ = app.emit("custom-races-progress", serde_json::json!({
|
||||
"id": sid,
|
||||
@@ -687,7 +718,7 @@ async fn custom_races_install(app: AppHandle, state: State<'_, AppState>, id: St
|
||||
"percent": percent,
|
||||
}));
|
||||
})?;
|
||||
let enabled = coa_core::modules::list(&root).iter().any(|module| module.id == "custom-races" && module.enabled);
|
||||
let enabled = ctx.root.as_ref().map_or(true, |root| coa_core::modules::list(root).iter().any(|module| module.id == "custom-races" && module.enabled));
|
||||
coa_core::custom_races::set_client_patch_enabled(&client, enabled)
|
||||
})
|
||||
.await;
|
||||
@@ -797,11 +828,12 @@ fn install_meta(root: &std::path::Path) -> Result<(PathBuf, InstallMeta)> {
|
||||
#[tauri::command]
|
||||
async fn check_update(state: State<'_, AppState>, id: String, source: Option<String>, background: Option<bool>) -> std::result::Result<update::Preview, UiError> {
|
||||
let root = path_of(&state, &id)?;
|
||||
let src = update_source(source);
|
||||
|
||||
// The check that repeats every few minutes must not start and stop the database of a stopped server.
|
||||
let access = if background.unwrap_or(false) { update::DatabaseAccess::OnlyIfRunning } else { update::DatabaseAccess::Start };
|
||||
blocking(move || {
|
||||
let (_, meta) = install_meta(&root)?;
|
||||
let src = update_source(source)?;
|
||||
update::preview_with(&root, &meta, &src, coa_core::signing::EMBEDDED_PUBLIC_KEY, &Default::default(), access)
|
||||
})
|
||||
.await
|
||||
@@ -822,10 +854,13 @@ async fn apply_update(
|
||||
resolutions: BTreeMap<String, Resolution>,
|
||||
) -> std::result::Result<update::Outcome, UiError> {
|
||||
let root = path_of(&state, &id)?;
|
||||
let src = update_source(source);
|
||||
|
||||
let _guard = BusyGuard::acquire(&state, &id)?;
|
||||
blocking(move || {
|
||||
let (dir, _) = install_meta(&root)?;
|
||||
let src = update_source(source)?;
|
||||
let (dir, meta) = install_meta(&root)?;
|
||||
let (manifest, _) = coa_core::pkgsource::fetch_manifest(&src, coa_core::signing::EMBEDDED_PUBLIC_KEY)?;
|
||||
update::validate_candidate(&meta, &manifest)?;
|
||||
// Files cannot be replaced while the server runs: stop it first (gracefully), like the Stop button.
|
||||
let observed = coa_core::process::observe(&root, &layout::read_ports(&root));
|
||||
if observed.world.state != coa_core::process::ServiceState::Stopped || observed.auth.state != coa_core::process::ServiceState::Stopped || coa_core::multiworld::is_running(&root) {
|
||||
@@ -1366,7 +1401,7 @@ struct FriendsStatus {
|
||||
exposure: Vec<coa_core::net::Exposure>,
|
||||
/// The configuration lets other computers reach the login and world servers.
|
||||
servers_open: bool,
|
||||
firewall: coa_core::firewall::Status,
|
||||
firewall: Option<coa_core::firewall::Status>,
|
||||
tailscale: coa_core::net::Tailscale,
|
||||
server_running: bool,
|
||||
auth_port: u16,
|
||||
@@ -1411,7 +1446,18 @@ fn report_targets() -> Vec<coa_core::report::Target> {
|
||||
coa_core::report::targets()
|
||||
}
|
||||
|
||||
/// The distribution on Linux ("Linux (Arch Linux)"), from `/etc/os-release`; empty if it cannot be read.
|
||||
#[cfg(not(windows))]
|
||||
fn windows_version() -> String {
|
||||
std::fs::read_to_string("/etc/os-release")
|
||||
.ok()
|
||||
.and_then(|t| t.lines().find_map(|l| l.strip_prefix("PRETTY_NAME=").map(|v| v.trim_matches('"').to_string())))
|
||||
.map(|name| format!("Linux ({name})"))
|
||||
.unwrap_or_default()
|
||||
}
|
||||
|
||||
/// "Windows 11 (build 26200)" from `ver`; empty if it cannot be read.
|
||||
#[cfg(windows)]
|
||||
fn windows_version() -> String {
|
||||
let mut cmd = std::process::Command::new("cmd.exe");
|
||||
cmd.args(["/C", "ver"]);
|
||||
@@ -1460,9 +1506,10 @@ async fn friends_status(state: State<'_, AppState>, id: String) -> std::result::
|
||||
settings: coa_core::friends::load(&meta),
|
||||
lan_ip: automatic.map(|a| a.to_string()),
|
||||
lan_addresses: coa_core::net::lan_addresses(automatic).unwrap_or_default(),
|
||||
exposure: coa_core::net::exposure(&ports),
|
||||
exposure: if coa_core::docker::is_docker(&root) { coa_core::docker::exposure(&root, &ports) } else { coa_core::net::exposure(&ports) },
|
||||
servers_open: coa_core::friends::bind_is_open(&root),
|
||||
firewall: coa_core::firewall::status(),
|
||||
// The Windows firewall exists only on Windows; on Linux Docker publishes the ports itself.
|
||||
firewall: (platform::flavor() == Flavor::Repack).then(coa_core::firewall::status),
|
||||
tailscale: coa_core::net::tailscale(),
|
||||
server_running: coa_core::process::observe(&root, &ports).world.state == coa_core::process::ServiceState::Running,
|
||||
auth_port: ports.auth,
|
||||
@@ -1532,7 +1579,7 @@ async fn friends_enable(
|
||||
};
|
||||
let open = mode != Mode::Local;
|
||||
let changed = friends::set_open(&root, &meta, open)?;
|
||||
if open {
|
||||
if open && platform::flavor() == Flavor::Repack {
|
||||
coa_core::firewall::ensure_rules_with_secondary(&ports, secondary)?;
|
||||
}
|
||||
if mode == Mode::Direct && use_upnp {
|
||||
@@ -1565,7 +1612,7 @@ async fn friends_package(state: State<'_, AppState>, id: String) -> std::result:
|
||||
blocking(move || {
|
||||
let meta = meta_dir(&root)?;
|
||||
let host = coa_core::friends::load(&meta).host.ok_or_else(|| Error::Invalid("Choose how friends connect first.".into()))?;
|
||||
let desktop = std::env::var_os("USERPROFILE").map(PathBuf::from).unwrap_or_else(std::env::temp_dir).join("Desktop");
|
||||
let desktop = if platform::flavor() == Flavor::Docker { coa_core::diag::desktop_or_temp() } else { std::env::var_os("USERPROFILE").map(PathBuf::from).unwrap_or_else(std::env::temp_dir).join("Desktop") };
|
||||
let out = if desktop.is_dir() { desktop } else { std::env::temp_dir() }.join("CoA-Friend-Setup.zip");
|
||||
coa_core::friends::make_friend_package(&root, &host, true, &out)?;
|
||||
Ok(out.to_string_lossy().into_owned())
|
||||
@@ -1626,6 +1673,10 @@ async fn console_tail(
|
||||
) -> std::result::Result<Vec<coa_core::console::Line>, UiError> {
|
||||
let root = path_of(&state, &id)?;
|
||||
blocking(move || {
|
||||
// A Docker server's database writes to its container's output, not to a file.
|
||||
if coa_core::docker::is_docker(&root) && matches!(source, coa_core::console::Source::Database) {
|
||||
return coa_core::docker::logs::database_log(&root, filter.as_deref(), lines.unwrap_or(300).min(2000));
|
||||
}
|
||||
let path = coa_core::console::log_path(&root, &data_dir().join("logs").join("manager.log"), source);
|
||||
coa_core::console::tail(&path, filter.as_deref(), lines.unwrap_or(300).min(2000))
|
||||
})
|
||||
@@ -1662,6 +1713,8 @@ pub fn run() {
|
||||
.manage(AppState { registry: Registry::at(dir.join("installs.json")), busy: Mutex::new(HashSet::new()), install_cancel: Mutex::new(None), client_cancel: Mutex::new(None) })
|
||||
.invoke_handler(tauri::generate_handler![
|
||||
default_install_dir,
|
||||
game_data_folder,
|
||||
set_game_data_folder,
|
||||
install_environment,
|
||||
scan_server,
|
||||
add_server,
|
||||
|
||||
@@ -1,7 +1,7 @@
|
||||
{
|
||||
"$schema": "https://schema.tauri.app/config/2",
|
||||
"productName": "CoA Server Manager",
|
||||
"version": "0.6.12",
|
||||
"version": "0.6.15",
|
||||
"identifier": "com.coa.servermanager",
|
||||
"build": {
|
||||
"beforeDevCommand": "npm run dev",
|
||||
|
||||
@@ -92,6 +92,8 @@ export {};
|
||||
if(cmd==="open_link"){(window as any).__lastLink=args.url;return null;}
|
||||
if(cmd==="export_diagnostics") return "C:\\Users\\you\\Desktop\\CoA-Diagnostics-20261001-140000.zip";
|
||||
if(cmd==="list_crashes") return [];
|
||||
if(cmd==="game_data_folder") return new URLSearchParams(location.search).get("flavor")==="docker"?"/srv/coa/server-data":null;
|
||||
if(cmd==="set_game_data_folder") return args.path;
|
||||
if(cmd==="install_environment"){const docker=new URLSearchParams(location.search).get("flavor")==="docker";return docker?{flavor:"docker",default_dir:"/home/you/CoaServer",docker_problem:new URLSearchParams(location.search).has("nodocker")?"permission denied while trying to connect to the Docker daemon socket":null}:{flavor:"repack",default_dir:"C:\\Games\\CoA Server",docker_problem:null};}
|
||||
if(cmd==="install_preflight") return {ok:true,problems:[],free_bytes:210*2**30};
|
||||
if(cmd==="install_requirements") return {download_bytes:Math.round(5.9*2**30),unpacked_bytes:Math.round(11.4*2**30),version:"0.2.0"};
|
||||
|
||||
@@ -195,6 +195,7 @@ const de: Partial<Record<keyof typeof en, string>> = {
|
||||
"comp.saved": "Gespeichert. {n} Begleiter werden beim Serverstart erstellt.",
|
||||
|
||||
// Client
|
||||
"client.races.install": "Patch für benutzerdefinierte Völker installieren",
|
||||
"client.title": "Spielclient",
|
||||
"client.looking": "Suche …",
|
||||
"client.intro": "Sag dem Manager, wo dein Spiel installiert ist, um einen SPIELEN-Button zu erhalten. Deine Spieldateien werden nie geändert, außer der Serveradresse und dem Begleiter-Addon.",
|
||||
|
||||
@@ -101,6 +101,7 @@ const en = {
|
||||
"status.attention": "Needs attention",
|
||||
"status.running": "Running",
|
||||
"status.stopped": "Stopped",
|
||||
"status.crashed": "Stopped unexpectedly",
|
||||
|
||||
"btn.start": "START SERVER",
|
||||
"btn.stop": "STOP SERVER",
|
||||
@@ -143,6 +144,8 @@ const en = {
|
||||
"err.operation_in_progress.message": "The server is busy starting or stopping. Wait a moment and try again.",
|
||||
"err.startup_failed.title": "Server could not start",
|
||||
"err.startup_failed.message": "A service stopped while starting. Check the details for the cause.",
|
||||
"err.game_data_mismatch.title": "The game data folder is not the CoA set",
|
||||
"err.game_data_mismatch.message": "The server stopped because the DBC files in the game data folder are not the ones of the Conquest of Azeroth client. Choose the folder that holds the CoA data (Settings > Game data folder), then start again.",
|
||||
"err.docker_unavailable.title": "Docker is not available",
|
||||
"err.docker_unavailable.message": "This server runs in Docker. Install Docker, start it, and make sure your user account may use it, then try again.",
|
||||
"err.hash_mismatch.title": "A downloaded file is damaged",
|
||||
@@ -190,6 +193,11 @@ const en = {
|
||||
"install.localPkg": "Install from a local package folder instead of downloading",
|
||||
"install.localPkgHint": "(leave empty to download)",
|
||||
"install.button": "Install",
|
||||
"gamedata.title": "Game data folder",
|
||||
"gamedata.text": "The folder with the game's dbc, maps, vmaps and mmaps that this server reads. It is used where it is and never changed. It must be the Conquest of Azeroth set, not the standard one. Stop the server before changing it.",
|
||||
"gamedata.change": "Change…",
|
||||
"gamedata.dialog": "Choose the game data folder",
|
||||
"gamedata.saved": "Saved. It is used the next time the server starts.",
|
||||
"install.docker.title": "Docker is needed",
|
||||
"install.docker.text": "On Linux the server runs in Docker. Install Docker and start it, or allow your user to use it, then check again.",
|
||||
"install.docker.retry": "Check again",
|
||||
@@ -238,6 +246,7 @@ const en = {
|
||||
"comp.saved": "Saved. {n} companions will be created when the server starts.",
|
||||
|
||||
// Client
|
||||
"client.races.install": "Install custom race patch",
|
||||
"client.title": "Game client",
|
||||
"client.looking": "Looking…",
|
||||
"client.intro": "Tell Manager where your game is installed to get a PLAY button. Your game files are never changed except the server address and the companion addon.",
|
||||
|
||||
@@ -195,6 +195,7 @@ const es: Partial<Record<keyof typeof en, string>> = {
|
||||
"comp.saved": "Guardado. Se crearán {n} compañeros cuando se inicie el servidor.",
|
||||
|
||||
// Client
|
||||
"client.races.install": "Instalar parche de razas personalizadas",
|
||||
"client.title": "Cliente del juego",
|
||||
"client.looking": "Buscando…",
|
||||
"client.intro": "Indica al Manager dónde está instalado el juego para obtener un botón JUGAR. Tus archivos del juego nunca se modifican, salvo la dirección del servidor y el addon de compañeros.",
|
||||
|
||||
@@ -195,6 +195,7 @@ const fr: Partial<Record<keyof typeof en, string>> = {
|
||||
"comp.saved": "Enregistré. {n} compagnons seront créés au démarrage du serveur.",
|
||||
|
||||
// Client
|
||||
"client.races.install": "Installer le patch des races personnalisées",
|
||||
"client.title": "Client du jeu",
|
||||
"client.looking": "Recherche…",
|
||||
"client.intro": "Indiquez au Manager où le jeu est installé pour obtenir un bouton JOUER. Vos fichiers de jeu ne sont jamais modifiés, sauf l’adresse du serveur et l’addon des compagnons.",
|
||||
|
||||
@@ -228,6 +228,7 @@ const ru: Partial<Record<keyof typeof en, string>> = {
|
||||
"comp.saved": "Сохранено. Компаньоны ({n}) будут созданы при запуске сервера.",
|
||||
|
||||
// Client
|
||||
"client.races.install": "Установить патч кастомных рас",
|
||||
"client.title": "Клиент игры",
|
||||
"client.looking": "Ищу…",
|
||||
"client.intro": "Укажите, где установлена игра, чтобы появилась кнопка «Играть». Файлы игры не изменяются, кроме адреса сервера и аддона компаньонов.",
|
||||
|
||||
@@ -207,6 +207,7 @@ const zh = {
|
||||
"comp.saved": "已保存。{n} 名随从将在服务器启动时创建。",
|
||||
|
||||
// Client
|
||||
"client.races.install": "安装自定义种族补丁",
|
||||
"client.title": "游戏客户端",
|
||||
"client.looking": "正在寻找…",
|
||||
"client.intro": "指定游戏客户端安装路径即可启用“开始游戏”按钮。除服务器地址和随从插件外,你的游戏文件绝不会被修改。",
|
||||
|
||||
+6
-1
@@ -186,6 +186,7 @@ export interface RecoveryPoint {
|
||||
label: string | null;
|
||||
created_at: string;
|
||||
components: { name: string; path: string; bytes: number; tables: number | null; files: string[] | null }[];
|
||||
mysql_snapshot?: { bytes: number } | null;
|
||||
}
|
||||
|
||||
export interface DbRestore {
|
||||
@@ -419,7 +420,8 @@ export interface FriendsStatus {
|
||||
lan_addresses: LanAddress[];
|
||||
exposure: { port: number; what: string; reachable_from_network: boolean; listening: boolean }[];
|
||||
servers_open: boolean;
|
||||
firewall: { auth: boolean; world: boolean };
|
||||
/** null where there is no Windows firewall to ask about (Linux). */
|
||||
firewall: { auth: boolean; world: boolean } | null;
|
||||
tailscale: { installed: boolean; ip: string | null; connected: boolean };
|
||||
server_running: boolean;
|
||||
auth_port: number;
|
||||
@@ -496,6 +498,9 @@ export const api = {
|
||||
restoreConfigs: (id: string, backupId: string) => invoke<RecoveryPoint>("restore_backup_configs", { id, backupId }),
|
||||
restoreDatabase: (id: string, backupId: string, database: string) => invoke<DbRestore>("restore_backup_database", { id, backupId, database }),
|
||||
installEnvironment: () => invoke<InstallEnvironment>("install_environment"),
|
||||
/** The game data folder of a Docker server; null for a repack. */
|
||||
gameDataFolder: (id: string) => invoke<string | null>("game_data_folder", { id }),
|
||||
setGameDataFolder: (id: string, path: string) => invoke<string>("set_game_data_folder", { id, path }),
|
||||
installPreflight: (dest: string, needed?: number, gameData?: string) => invoke<Preflight>("install_preflight", { dest, needed: needed ?? null, gameData: gameData ?? null }),
|
||||
installRequirements: (pkg?: string) => invoke<InstallRequirements>("install_requirements", { package: pkg ?? null }),
|
||||
realmlistProfiles: (id: string) => invoke<{ profiles: RealmProfile[]; active: string | null }>("realmlist_profiles", { id }),
|
||||
|
||||
@@ -87,7 +87,14 @@ for (let n = 1; n <= 3; n++) add(`EC.P${n}`, "string", [`NPC phrase ${n}`, `Ре
|
||||
|
||||
add("CoACustomRaces.BotsEnable", "bool",
|
||||
["Bots can be custom races", "Боты кастомных рас", "Bots benutzerdefinierter Völker", "Bots de races personnalisées", "Bots de razas personalizadas", "允许机器人为自定义种族"],
|
||||
["Allow Playerbots to spawn as custom races.", "Разрешает ботам-игрокам появляться кастомными расами.", "Erlaubt Spieler-Bots, benutzerdefinierte Völker zu nutzen.", "Autorise les bots joueurs à s’incarner avec des races personnalisées.", "Permite a los bots jugadores crearse con razas personalizadas.", "允许玩家机器人扮演自定义种族。"]
|
||||
[
|
||||
"Allow Playerbots to spawn as custom races (experimental). Off excludes all custom races; on allows stable custom races.",
|
||||
"Разрешает ботам-игрокам появляться кастомными расами (экспериментально). Выключено — исключает все кастомные расы, включено — разрешает стабильные.",
|
||||
"Erlaubt Spieler-Bots, benutzerdefinierte Völker zu nutzen (experimentell). Aus schließt alle benutzerdefinierten Völker aus; An erlaubt stabile.",
|
||||
"Autorise les bots joueurs à s’incarner avec des races personnalisées (expérimental). Désactivé exclut toutes les races personnalisées ; activé autorise les stables.",
|
||||
"Permite a los bots jugadores crearse con razas personalizadas (experimental). Desactivado excluye todas las razas personalizadas; activado permite las estables.",
|
||||
"允许玩家机器人扮演自定义种族(实验性)。关闭将排除所有自定义种族,开启允许稳定的自定义种族。"
|
||||
]
|
||||
);
|
||||
|
||||
const ah = "AuctionHouseBot.";
|
||||
|
||||
@@ -198,7 +198,7 @@ export function BackupsPage({ serverId }: { serverId: string }) {
|
||||
<div>
|
||||
<p className="font-medium">{p.label && p.trigger === "manual" && p.label !== "e2e" ? p.label : trigger(p.trigger)}</p>
|
||||
<p className="text-sm text-muted">
|
||||
{w(p.created_at)} · {p.realm === "wildcard" ? "Wildcard" : "CoA"} · {t(`bk.kind.${p.kind}` as Key)} · {size(p.components.reduce((a, c) => a + c.bytes, 0))}
|
||||
{w(p.created_at)} · {p.realm === "wildcard" ? "Wildcard" : "CoA"} · {t(`bk.kind.${p.kind}` as Key)} · {size(p.components.reduce((a, c) => a + c.bytes, p.mysql_snapshot?.bytes ?? 0))}
|
||||
</p>
|
||||
</div>
|
||||
<div className="flex shrink-0 gap-1">
|
||||
|
||||
@@ -1,4 +1,5 @@
|
||||
import { useEffect, useState } from "react";
|
||||
import { listen } from "@tauri-apps/api/event";
|
||||
import { open } from "@tauri-apps/plugin-dialog";
|
||||
import { api, asUiError, type ClientInfo, type ClientStatus, type UiError } from "@/lib/api";
|
||||
import { checkClient } from "@/lib/clientUpdate";
|
||||
@@ -16,6 +17,7 @@ export function ClientCard({ serverId, remote = false }: { serverId: string; rem
|
||||
const [note, setNote] = useState<string | null>(null);
|
||||
const [busy, setBusy] = useState(false);
|
||||
const [status, setStatus] = useState<ClientStatus | null>(null);
|
||||
const [patchProgress, setPatchProgress] = useState<string | null>(null);
|
||||
const [dialog, setDialog] = useState<ClientDialogMode | null>(null);
|
||||
const [playAfter, setPlayAfter] = useStartAfterUpdate("client", serverId);
|
||||
|
||||
@@ -25,6 +27,10 @@ export function ClientCard({ serverId, remote = false }: { serverId: string; rem
|
||||
};
|
||||
useEffect(() => {
|
||||
void refresh();
|
||||
const unlisten = listen<{ id: string; step: string; percent: number }>("custom-races-progress", e => {
|
||||
if (e.payload.id === serverId) setPatchProgress(`${e.payload.step} (${Math.round(e.payload.percent * 100)}%)`);
|
||||
});
|
||||
return () => { void unlisten.then(f => f()); };
|
||||
}, [serverId]); // eslint-disable-line react-hooks/exhaustive-deps
|
||||
|
||||
async function run(fn: () => Promise<string | void>) {
|
||||
@@ -40,6 +46,7 @@ export function ClientCard({ serverId, remote = false }: { serverId: string; rem
|
||||
setError(asUiError(e));
|
||||
} finally {
|
||||
setBusy(false);
|
||||
setPatchProgress(null);
|
||||
}
|
||||
}
|
||||
|
||||
@@ -111,11 +118,13 @@ export function ClientCard({ serverId, remote = false }: { serverId: string; rem
|
||||
{status && !status.managed && (
|
||||
<Button size="sm" disabled={busy} onClick={() => setDialog("track")}>{t("client.track.button")}</Button>
|
||||
)}
|
||||
{remote && <Button size="sm" disabled={busy} onClick={() => void run(() => api.customRacesInstall(serverId))}>{t("client.races.install")}</Button>}
|
||||
<Button size="sm" variant="ghost" disabled={busy} onClick={() => void choose()}>{t("client.changeFolder")}</Button>
|
||||
<Button size="sm" variant="ghost" disabled={busy} onClick={() => setDialog("setup")}>{t("client.downloadInstead")}</Button>
|
||||
</div>
|
||||
</>
|
||||
)}
|
||||
{patchProgress && <p className="mt-3 text-sm text-muted" role="status">{patchProgress}</p>}
|
||||
{note && <p className="mt-3 text-sm text-ok" role="status">{note}</p>}
|
||||
{error && <p className="mt-3 text-sm text-bad" role="alert">{error.human.code === "unknown" ? error.technical : human(error.human).message}</p>}
|
||||
{dialog && (
|
||||
|
||||
@@ -170,7 +170,7 @@ export function FriendsPage({ serverId }: { serverId: string }) {
|
||||
<ul className="mt-2 divide-y divide-line">
|
||||
<Line ok={st.server_running}>{t("fr.st.running")}</Line>
|
||||
<Line ok={st.servers_open}>{t("fr.st.open")}</Line>
|
||||
<Line ok={st.firewall.auth && st.firewall.world}>{t("fr.st.firewall")}</Line>
|
||||
{st.firewall && <Line ok={st.firewall.auth && st.firewall.world}>{t("fr.st.firewall")}</Line>}
|
||||
<Line ok={st.exposure.filter((e) => e.what === "database" || e.what === "server console").every((e) => !e.reachable_from_network)}>
|
||||
{t("fr.st.private")}
|
||||
</Line>
|
||||
|
||||
@@ -0,0 +1,44 @@
|
||||
import { useEffect, useState } from "react";
|
||||
import { open } from "@tauri-apps/plugin-dialog";
|
||||
import { api, asUiError } from "@/lib/api";
|
||||
import { Button } from "@/components/ui/button";
|
||||
import { Card } from "@/components/ui/card";
|
||||
import { useT } from "@/i18n";
|
||||
|
||||
/** Where a Docker server reads the game data from. Not shown for a repack, which keeps its data in its own folder. */
|
||||
export function GameDataCard({ serverId }: { serverId: string }) {
|
||||
const t = useT();
|
||||
const [folder, setFolder] = useState<string | null>(null);
|
||||
const [message, setMessage] = useState<{ ok: boolean; text: string } | null>(null);
|
||||
|
||||
useEffect(() => {
|
||||
let alive = true;
|
||||
void api.gameDataFolder(serverId).then((f) => alive && setFolder(f)).catch(() => alive && setFolder(null));
|
||||
return () => { alive = false; };
|
||||
}, [serverId]);
|
||||
|
||||
if (folder === null) return null;
|
||||
|
||||
async function change() {
|
||||
const picked = await open({ directory: true, multiple: false, title: t("gamedata.dialog"), defaultPath: folder ?? undefined });
|
||||
if (typeof picked !== "string") return;
|
||||
try {
|
||||
setFolder(await api.setGameDataFolder(serverId, picked));
|
||||
setMessage({ ok: true, text: t("gamedata.saved") });
|
||||
} catch (e) {
|
||||
setMessage({ ok: false, text: asUiError(e).technical });
|
||||
}
|
||||
}
|
||||
|
||||
return (
|
||||
<Card className="mt-6 p-6">
|
||||
<h2 className="font-semibold">{t("gamedata.title")}</h2>
|
||||
<p className="mt-1 text-sm text-muted">{t("gamedata.text")}</p>
|
||||
<div className="mt-3 flex items-center gap-3">
|
||||
<code className="selectable min-w-0 flex-1 truncate rounded-md border border-line bg-card px-3 py-2 text-sm" title={folder}>{folder}</code>
|
||||
<Button onClick={() => void change()}>{t("gamedata.change")}</Button>
|
||||
</div>
|
||||
{message && <p className={message.ok ? "mt-2 text-sm text-ok" : "mt-2 text-sm text-bad"} role="status">{message.text}</p>}
|
||||
</Card>
|
||||
);
|
||||
}
|
||||
@@ -46,21 +46,22 @@ function Row({ label, s }: { label: string; s: ServiceStatus }) {
|
||||
const t = useT();
|
||||
const running = s.state === "running";
|
||||
const starting = s.state === "starting";
|
||||
const crashed = s.state === "crashed";
|
||||
return (
|
||||
<div className="flex items-center justify-between py-2.5">
|
||||
<span>{label}</span>
|
||||
<span
|
||||
className={cn("flex items-center gap-2 text-sm", running ? "text-ok" : starting ? "text-warn" : "text-muted")}
|
||||
className={cn("flex items-center gap-2 text-sm", running ? "text-ok" : starting || crashed ? "text-warn" : "text-muted")}
|
||||
role="status"
|
||||
>
|
||||
<span
|
||||
aria-hidden
|
||||
className={cn(
|
||||
"h-2 w-2 rounded-full",
|
||||
running ? "bg-ok" : starting ? "animate-[pulse-dot_1.2s_ease-in-out_infinite] bg-warn" : "bg-muted/50",
|
||||
running ? "bg-ok" : starting ? "animate-[pulse-dot_1.2s_ease-in-out_infinite] bg-warn" : crashed ? "bg-warn" : "bg-muted/50",
|
||||
)}
|
||||
/>
|
||||
{running ? t("status.running") : starting ? t("status.starting") : t("status.stopped")}
|
||||
{running ? t("status.running") : starting ? t("status.starting") : crashed ? t("status.crashed") : t("status.stopped")}
|
||||
</span>
|
||||
</div>
|
||||
);
|
||||
|
||||
@@ -7,6 +7,7 @@ import { api, asUiError, type UiError, type UpdatePreview, type UpdateTxn } from
|
||||
import { Button } from "@/components/ui/button";
|
||||
import { Card } from "@/components/ui/card";
|
||||
import { ClientCard } from "@/screens/ClientCard";
|
||||
import { GameDataCard } from "@/screens/GameDataCard";
|
||||
import { DiagnosticsCard } from "@/screens/DiagnosticsCard";
|
||||
import { AboutCard } from "@/screens/AboutCard";
|
||||
import { RemoveServerCard } from "@/screens/RemoveServerCard";
|
||||
@@ -174,6 +175,8 @@ export function SettingsHome({ serverId, path, onForget }: { serverId: string; p
|
||||
<RealmStartupSettings serverId={serverId} />
|
||||
<AutoRestartSettings serverId={serverId} />
|
||||
|
||||
<GameDataCard serverId={serverId} />
|
||||
|
||||
<DiagnosticsCard serverId={serverId} />
|
||||
<RepairCard key={serverId} serverId={serverId} />
|
||||
|
||||
|
||||
@@ -4,7 +4,8 @@ param(
|
||||
[string]$Source = 'C:\games\CoA-Repack',
|
||||
[string]$Target = 'C:\games\coa-fixture',
|
||||
[int]$PortBase = 13000,
|
||||
[string]$DatabaseArchive = ''
|
||||
[string]$DatabaseArchive = '',
|
||||
[switch]$CopyData
|
||||
)
|
||||
$ErrorActionPreference = 'Stop'
|
||||
if ((Resolve-Path $Source).Path -eq $Target) { throw 'source and target are the same' }
|
||||
@@ -32,7 +33,8 @@ if (-not $DatabaseArchive) { $DatabaseArchive = "$Source\mysql\data.7z" }
|
||||
& 'C:\Program Files\7-Zip\7z.exe' x $DatabaseArchive "-o$Target\mysql" -y | Out-Null
|
||||
if (-not (Test-Path "$Target\mysql\data\acore_characters")) { throw 'database extraction failed' }
|
||||
|
||||
New-Item -ItemType Junction -Path "$Target\Data" -Target "$Source\Data" | Out-Null
|
||||
if ($CopyData) { Copy-Tree 'Data' }
|
||||
else { New-Item -ItemType Junction -Path "$Target\Data" -Target "$Source\Data" | Out-Null }
|
||||
|
||||
$ports = @{ mysqlPort = $PortBase + 307; authPort = $PortBase + 724; worldPort = $PortBase + 85; raPort = $PortBase + 443 }
|
||||
$cfg = Get-Content "$Target\Settings\repack.json" -Raw | ConvertFrom-Json
|
||||
|
||||
@@ -0,0 +1,98 @@
|
||||
"""Exercise raid module initialization against disposable MySQL data only."""
|
||||
import argparse
|
||||
import socket
|
||||
import subprocess
|
||||
import tempfile
|
||||
import time
|
||||
from pathlib import Path
|
||||
|
||||
|
||||
def main():
|
||||
parser = argparse.ArgumentParser()
|
||||
parser.add_argument('--mysql-bin', required=True, type=Path)
|
||||
parser.add_argument('--core', required=True, type=Path)
|
||||
parser.add_argument('--before', required=True)
|
||||
parser.add_argument('--display-repair', type=Path)
|
||||
args = parser.parse_args()
|
||||
suffix = '.exe' if (args.mysql_bin / 'mysqld.exe').exists() else ''
|
||||
server = args.mysql_bin / ('mysqld' + suffix)
|
||||
client = args.mysql_bin / ('mysql' + suffix)
|
||||
admin = args.mysql_bin / ('mysqladmin' + suffix)
|
||||
relative = 'modules/mod-coa-raid-difficulty/data/sql/db-world/base/03_boss_schedule.sql'
|
||||
original = subprocess.check_output(['git', '-C', str(args.core), 'show', args.before + ':' + relative], text=True)
|
||||
current = (args.core / relative).read_text()
|
||||
split = (args.core / 'data/sql/updates/pending_db_world/rev_20261001_g1_molten_core_shazzrah_nova_area.sql').read_text()
|
||||
with tempfile.TemporaryDirectory(prefix='coa-module-sql-fixture-') as temp:
|
||||
data = Path(temp) / 'data'
|
||||
flags = subprocess.CREATE_NO_WINDOW if hasattr(subprocess, 'CREATE_NO_WINDOW') else 0
|
||||
subprocess.run([str(server), '--no-defaults', '--initialize-insecure', '--datadir=' + str(data)],
|
||||
check=True, capture_output=True, creationflags=flags)
|
||||
with socket.socket() as sock:
|
||||
sock.bind(('127.0.0.1', 0))
|
||||
port = sock.getsockname()[1]
|
||||
process = subprocess.Popen([str(server), '--no-defaults', '--datadir=' + str(data),
|
||||
'--bind-address=127.0.0.1', '--port=' + str(port), '--mysqlx=0',
|
||||
'--skip-log-bin', '--log-error=' + str(Path(temp) / 'mysql.log')],
|
||||
creationflags=flags, stdout=subprocess.DEVNULL, stderr=subprocess.DEVNULL)
|
||||
connection = ['--no-defaults', '--protocol=TCP', '--host=127.0.0.1', '--port=' + str(port), '--user=root']
|
||||
|
||||
def sql(statement, schema=None, check=True):
|
||||
result = subprocess.run([str(client), *connection, '--batch', '--skip-column-names', *([schema] if schema else [])],
|
||||
input=statement, text=True, capture_output=True, creationflags=flags)
|
||||
if check and result.returncode:
|
||||
raise RuntimeError(result.stderr)
|
||||
return result
|
||||
|
||||
try:
|
||||
deadline = time.monotonic() + 60
|
||||
while sql('SELECT 1;', check=False).returncode:
|
||||
if process.poll() is not None or time.monotonic() > deadline:
|
||||
raise RuntimeError('Disposable MySQL did not start: ' + (Path(temp) / 'mysql.log').read_text())
|
||||
time.sleep(0.5)
|
||||
regex = sql("SELECT REGEXP_LIKE(CONVERT(0xD0AF USING utf8mb4), '^[[:alpha:]]$'), REGEXP_REPLACE('abc123', '[0-9]+', '');").stdout.strip()
|
||||
assert regex == '1\tabc', regex
|
||||
print('PASS: packaged MySQL starts on fresh data and supports Unicode regular expressions')
|
||||
for schema in ('fresh', 'old', 'upgraded'):
|
||||
sql('CREATE DATABASE `' + schema + '`;')
|
||||
sql('CREATE TABLE creature_template (entry INT PRIMARY KEY, ScriptName VARCHAR(128));', schema)
|
||||
sql(original, 'old')
|
||||
sql('CREATE TABLE coa_spell_damage_info (spell_id INT); CREATE TABLE spell_script_names (spell_id INT, ScriptName VARCHAR(128));', 'old')
|
||||
sql(split, 'old')
|
||||
broken = sql(original, 'old', check=False)
|
||||
assert broken.returncode and '1136' in broken.stderr, broken.stderr
|
||||
sql(current, 'fresh')
|
||||
sql(current, 'fresh')
|
||||
sql(original, 'upgraded')
|
||||
sql(current, 'upgraded')
|
||||
for schema in ('fresh', 'upgraded'):
|
||||
count = sql("SELECT COUNT(*) FROM information_schema.columns WHERE table_schema=DATABASE() AND table_name='coa_boss_schedule';", schema).stdout.strip()
|
||||
assert count == '15', count
|
||||
effects = sql('SELECT effect_d0,effect_d1,effect_d2,effect_d3 FROM coa_boss_schedule WHERE entry=12264 AND idx=6;', schema).stdout.strip()
|
||||
assert effects == '2105613\t2105614\t2105615\t2105616', effects
|
||||
print('PASS: original SQL reproduces ERROR 1136 after migration; fixed SQL supports fresh, repeated and old-layout initialization')
|
||||
if args.display_repair:
|
||||
repair = args.display_repair.read_text()
|
||||
sql('CREATE DATABASE display_fixture;')
|
||||
sql(repair, 'display_fixture') # An absent table is not created by a default repair.
|
||||
sql('CREATE TABLE creature_display_preset (entry INT UNSIGNED NOT NULL, display_id INT UNSIGNED NOT NULL, PRIMARY KEY(entry,display_id)); INSERT INTO creature_display_preset VALUES(42,123);', 'display_fixture')
|
||||
before_rows = sql('SELECT * FROM creature_display_preset;', 'display_fixture').stdout
|
||||
sql(repair, 'display_fixture')
|
||||
sql(repair, 'display_fixture')
|
||||
default = sql("SELECT COLUMN_DEFAULT FROM information_schema.COLUMNS WHERE TABLE_SCHEMA=DATABASE() AND TABLE_NAME='creature_display_preset' AND COLUMN_NAME='display_id';", 'display_fixture').stdout.strip()
|
||||
assert default == '0', default
|
||||
assert sql('SELECT * FROM creature_display_preset;', 'display_fixture').stdout == before_rows
|
||||
sql('ALTER TABLE creature_display_preset ALTER COLUMN display_id SET DEFAULT 99;', 'display_fixture')
|
||||
sql(repair, 'display_fixture')
|
||||
assert sql("SELECT COLUMN_DEFAULT FROM information_schema.COLUMNS WHERE TABLE_SCHEMA=DATABASE() AND TABLE_NAME='creature_display_preset' AND COLUMN_NAME='display_id';", 'display_fixture').stdout.strip() == '99'
|
||||
print('PASS: display default repair is repeatable, keeps rows and custom defaults, and tolerates absent tables')
|
||||
finally:
|
||||
subprocess.run([str(admin), *connection, 'shutdown'], capture_output=True, creationflags=flags)
|
||||
try:
|
||||
process.wait(timeout=15)
|
||||
except subprocess.TimeoutExpired:
|
||||
process.kill()
|
||||
process.wait()
|
||||
|
||||
|
||||
if __name__ == '__main__':
|
||||
main()
|
||||
Reference in new issue
Block a user