Compare commits

..
21 changed files with 237 additions and 2 deletions

No files matched your search

@@ -0,0 +1,7 @@
---
area: manager
type: fixed
audience: admins
title: Allowing portable characters also prepares the server for portable sessions
---
Stop the server before enabling access for the first time. The Manager enables portable sessions in the effective module configuration and preserves the required database setting across restarts. Existing configuration is backed up.
+1
View File
@@ -2,6 +2,7 @@
pub mod merge;
pub mod parser;
pub mod portable;
pub mod schema;
use std::collections::{BTreeMap, BTreeSet};
+175
View File
@@ -0,0 +1,175 @@
//! Prepare the core side of the owner's portable-character opt-in.
use std::{fs, path::Path};
use super::{parser::ConfFile, take_snapshot, targets, Scope};
use crate::{fsx, Error, Result};
/// Configuration is changed only while the world is stopped. Disabling admission is
/// handled by the control service and must not disable an active session's core.
pub fn enable(root: &Path) -> Result<()> {
let meta = crate::registry::metadata_dir_for(root)?;
let _lock = crate::update::operation_lock_for(&meta, "configuring portable characters", false)?;
let module = root.join("Core/configs/modules/coa.conf");
let module_source = if module.is_file() {
module.clone()
} else {
root.join("Core/configs/modules/coa.conf.dist")
};
let bytes = fs::read(&module_source).map_err(|_| Error::Invalid(
"Update this server before enabling portable characters; its portable configuration is missing.".into()
))?;
let mut conf = ConfFile::parse_bytes(&bytes)?;
if conf.get("PortableSession.Enable").is_none() {
return Err(Error::Invalid("Update this server before enabling portable characters; its core configuration has no portable session support.".into()));
}
let mut writes = Vec::new();
if conf.get("PortableSession.Enable").map(str::trim) != Some("1")
|| conf.get("PortableImport.JobDir").map(str::trim) != Some("\"PortableImport\"")
|| !module.is_file()
{
conf.set(
"PortableSession.Enable",
"1",
&["Enabled by the realm owner's portable-character opt-in"],
);
conf.set(
"PortableImport.JobDir",
"\"PortableImport\"",
&["Shared working directory for the core and Manager"],
);
writes.push((
module.clone(),
module.is_file().then(|| bytes.clone()),
conf.to_text(),
));
}
for path in targets(root, Scope::Server)?.writes {
let bytes = fs::read(&path)?;
let mut conf = ConfFile::parse_bytes(&bytes)?;
if conf.get("CharacterDatabase.WorkerThreads").map(str::trim) != Some("1") {
conf.set(
"CharacterDatabase.WorkerThreads",
"1",
&["Portable sessions require ordered character database transactions"],
);
writes.push((path, Some(bytes), conf.to_text()));
}
}
if writes.is_empty() {
fs::create_dir_all(root.join("Core/PortableImport"))?;
return Ok(());
}
let observed = crate::process::observe(root, &crate::layout::read_ports(root));
if observed.world.state != crate::process::ServiceState::Stopped
|| observed.world.conflict.is_some()
|| std::net::TcpStream::connect_timeout(
&std::net::SocketAddr::from(([127, 0, 0, 1], crate::layout::read_ports(root).world)),
std::time::Duration::from_millis(100),
)
.is_ok()
|| crate::multiworld::is_running(root)
{
return Err(Error::Invalid("Stop this server, then enable portable characters and save again. The Manager must configure the core before its next start.".into()));
}
let originals = writes
.iter()
.filter_map(|(p, old, _)| old.clone().map(|bytes| (p.clone(), bytes)))
.collect::<Vec<_>>();
take_snapshot(
&meta,
Scope::Server,
"before enabling portable characters",
&originals,
)?;
for (index, (path, _, text)) in writes.iter().enumerate() {
if let Err(error) = fsx::atomic_write(path, text.as_bytes()) {
for (path, old, _) in writes.iter().take(index) {
if let Some(bytes) = old {
let _ = fsx::atomic_write(path, bytes);
} else {
let _ = fs::remove_file(path);
}
}
return Err(error);
}
}
fs::create_dir_all(root.join("Core/PortableImport"))?;
Ok(())
}
#[cfg(test)]
mod tests {
use super::*;
use tempfile::tempdir;
#[test]
fn portable_opt_in_updates_the_effective_module_and_survives_launcher_rendering() {
let temp = tempdir().unwrap();
let root = temp.path().join("realm");
fs::create_dir_all(root.join("Core/configs/modules")).unwrap();
fs::create_dir_all(root.join("Settings")).unwrap();
fs::write(
root.join("Settings/repack.json"),
r#"{"worldPort":49143,"authPort":49144,"mysqlPort":49145,"raPort":49146}"#,
)
.unwrap();
fs::write(
root.join("Core/configs/modules/coa.conf"),
"# Owner setting\nCoA.Enable = 1\nPortableSession.Enable = 0\n",
)
.unwrap();
for name in [
"Settings/worldserver.conf.template",
"Core/configs/worldserver.conf",
] {
fs::write(
root.join(name),
"CharacterDatabase.WorkerThreads = 3\nMaxPlayerLevel = 80\n",
)
.unwrap();
}
enable(&root).unwrap();
assert!(root.join("Core/PortableImport").is_dir());
let module = fs::read_to_string(root.join("Core/configs/modules/coa.conf")).unwrap();
assert!(
module.contains("# Owner setting") && module.contains("PortableSession.Enable = 1")
);
for name in [
"Settings/worldserver.conf.template",
"Core/configs/worldserver.conf",
] {
let text = fs::read_to_string(root.join(name)).unwrap();
assert!(
text.contains("CharacterDatabase.WorkerThreads = 1")
&& text.contains("MaxPlayerLevel = 80")
);
}
let snapshots =
super::super::list_snapshots(&crate::registry::metadata_dir_for(&root).unwrap());
assert_eq!(snapshots.len(), 1);
enable(&root).unwrap();
assert_eq!(
super::super::list_snapshots(&crate::registry::metadata_dir_for(&root).unwrap()).len(),
1
);
let listener = std::net::TcpListener::bind("127.0.0.1:0").unwrap();
fs::write(
root.join("Settings/repack.json"),
format!(
r#"{{"worldPort":{}}}"#,
listener.local_addr().unwrap().port()
),
)
.unwrap();
let disabled = "PortableSession.Enable = 0\n";
fs::write(root.join("Core/configs/modules/coa.conf"), disabled).unwrap();
assert!(enable(&root)
.unwrap_err()
.to_string()
.contains("Stop this server"));
assert_eq!(
fs::read_to_string(root.join("Core/configs/modules/coa.conf")).unwrap(),
disabled
);
}
}
+1
View File
@@ -471,6 +471,7 @@ mod tests {
std::env::var("COA_REAL_CONTROL_ROOT").expect("disposable root"),
);
assert!(root.starts_with("C:/games/source/candidate-evidence-20261021"));
crate::config::portable::enable(&root).expect("owner portable-character opt-in");
let databases = realms().expect("disposable databases");
reset_b(&databases.b);
let server = Server::start(spec().expect("disposable worldserver"));
+5 -1
View File
@@ -620,6 +620,10 @@ mod tests {
tx,
reset_on_drop: true,
});
assert_eq!(peer.read(&mut [0u8; 1]).unwrap(), 0);
match peer.read(&mut [0u8; 1]) {
Ok(0) => {},
Err(error) if matches!(error.kind(), std::io::ErrorKind::ConnectionReset | std::io::ErrorKind::ConnectionAborted) => {},
other => panic!("The abandoned relay stream must close, got {other:?}"),
}
}
}
+2
View File
@@ -223,6 +223,8 @@ fn err(code: AppError, message: &str) -> Response {
fn unavailable(what: &str, e: &Error) -> Response {
tracing::warn!(error = %e, "{what}");
#[cfg(test)]
eprintln!("{what}: {e}");
err(
AppError::Unavailable,
"The server could not do that right now.",
@@ -1681,6 +1681,8 @@ impl PortableService {
let ops = [Operation::OnlineImport, Operation::RuntimeSession];
let report = self.report(&model, &caps, &opts, &ops, true);
if verdict_of(report.verdict()) == Verdict::Incompatible {
#[cfg(test)]
eprintln!("Remote import compatibility: {report:?}");
return Err(fail(
"incompatible",
"Character is incompatible with this realm; nothing was changed.",
+2
View File
@@ -60,3 +60,5 @@ Use **Saved versions** to see when progress was saved. If the Manager reports a
In the realm's Public list card, enable “Allow portable characters on this realm” and save. It is off until the owner opts in. Turning it off blocks new exports and imports; it does not delete saved characters. Keep the host Manager running. The control connection and game relay have separate status indicators: a connected control channel does not establish a game tunnel. Characters stay within their original ruleset (CoA, Wildcard or Warcraft Reborn); changing servers does not convert their ruleset.
Keep both Managers running. Saving resumes after reconnecting or restarting, and later logins stay monitored. Wait for saving before switching realms. Your installed servers use local preparation and recovery. Experimental limitation: an older existing copy on another host cannot yet be refreshed automatically while its worldserver runs. Returning may require host maintenance. The stale copy is blocked and your canonical character stays saved. Do not delete the character or reinstall the server to bypass this message.
Stop the server before enabling this for the first time. Saving prepares portable sessions for its next start; disabling access leaves ongoing sessions intact.
+2
View File
@@ -51,3 +51,5 @@ Unter **Gespeicherte Versionen (Saved versions)** siehst du, wann dein Fortschri
Aktiviere in der Karte zur öffentlichen Realmliste „Portable Charaktere auf diesem Realm erlauben“ und speichere. Ohne Zustimmung des Betreibers bleibt der Zugang gesperrt. Ausschalten verhindert neue Exporte und Importe, löscht aber keine gespeicherten Charaktere. Der Manager des Betreibers muss laufen. Steuerverbindung und Spiel-Relay haben getrennte Statusanzeigen; eine Steuerverbindung allein ist noch kein Spieltunnel. Charaktere bleiben in ihrem ursprünglichen Spielmodus: CoA, Wildcard oder Warcraft Reborn.
Lass beide Manager laufen. Nach Verbindungsabbrüchen oder Neustarts wird ausstehender Fortschritt weiter gespeichert; auch spätere Anmeldungen werden überwacht. Warte vor dem Realmwechsel auf den Abschluss. Eigene installierte Server nutzen die lokale Vorbereitung und Wiederherstellung. Experimentelle Einschränkung: Eine ältere Kopie bei einem anderen Host lässt sich auf dessen laufendem Worldserver noch nicht automatisch aktualisieren. Die Rückkehr kann Wartungsarbeiten des Hosts erfordern. Die alte Kopie wird blockiert, dein kanonischer Charakter bleibt gespeichert. Lösche den Charakter nicht und installiere den Server nicht neu, um die Meldung zu umgehen.
Stoppe den Server vor dem ersten Aktivieren. Beim Speichern werden portable Sitzungen für den nächsten Start eingerichtet. Das Sperren neuer Zugriffe unterbricht laufende Sitzungen nicht.
+2
View File
@@ -51,3 +51,5 @@ En **Versiones guardadas (Saved versions)** puedes ver cuándo se guardó el pro
En la tarjeta de publicación del reino, activa «Permitir personajes portátiles en este reino» y guarda. El acceso está desactivado por defecto. Desactivarlo impide nuevas exportaciones e importaciones sin borrar personajes guardados. El Manager del anfitrión debe permanecer abierto. La conexión de control y el relay del juego muestran estados separados: un canal de control conectado no garantiza un túnel de juego. Los personajes conservan su modo original: CoA, Wildcard o Warcraft Reborn.
Mantén abiertos ambos Managers. Tras una desconexión o reinicio, el progreso pendiente vuelve a guardarse; también se supervisan los siguientes inicios de sesión. Espera a que termine antes de cambiar de reino. Tus servidores instalados usan la preparación y recuperación locales. Limitación experimental: una copia antigua en otro anfitrión todavía no se actualiza automáticamente mientras su worldserver está en ejecución. Volver puede requerir mantenimiento del anfitrión. Esa copia se bloquea y tu personaje canónico queda guardado. No borres el personaje ni reinstales el servidor para evitar este mensaje.
Detén el servidor antes de activar esta opción por primera vez. Al guardar se preparan las sesiones portátiles para el próximo inicio. Bloquear nuevos accesos no interrumpe las sesiones actuales.
+2
View File
@@ -51,3 +51,5 @@ Sur un royaume dont le niveau maximal est inférieur, votre personnage peut temp
Dans la carte de publication du royaume, activez « Autoriser les personnages portables sur ce royaume », puis enregistrez. Cet accès est désactivé par défaut. Le désactiver bloque les nouveaux exports et imports sans supprimer les personnages sauvegardés. Le Manager de l’hôte doit rester ouvert. La connexion de contrôle et le relais de jeu ont des états distincts : un canal de contrôle connecté ne suffit pas à établir un tunnel de jeu. Chaque personnage conserve son mode d’origine : CoA, Wildcard ou Warcraft Reborn.
Gardez les deux Managers ouverts. Après une coupure ou un redémarrage, la sauvegarde reprend ; les connexions suivantes restent suivies. Attendez la fin avant de changer de royaume. Vos serveurs installés utilisent la préparation et la récupération locales. Limite expérimentale : une ancienne copie chez un autre hôte ne peut pas encore être actualisée automatiquement sur son worldserver en cours d’exécution. Le retour peut nécessiter une maintenance par l’hôte. Cette copie est bloquée et votre personnage canonique reste enregistré. Ne supprimez pas le personnage et ne réinstallez pas le serveur pour contourner ce message.
Arrêtez le serveur avant la première activation. L’enregistrement prépare les sessions portables pour le prochain démarrage. Bloquer les nouveaux accès ne coupe pas les sessions en cours.
+2
View File
@@ -51,3 +51,5 @@
В блоке «Публичный список» включите «Разрешить переносимых персонажей на этом реалме» и сохраните. По умолчанию доступ выключен. Отключение запрещает новые экспорты и импорты, но не удаляет сохранённых персонажей. Менеджер владельца должен оставаться запущенным. Подключение к службе управления и игровой relay имеют отдельные статусы: управляющий канал ещё не означает наличие игрового туннеля. Персонажи остаются в своём режиме (CoA, Wildcard или Warcraft Reborn); смена сервера не преобразует режим персонажа.
Во время игры должны работать оба менеджера. После обрыва связи или перезапуска сохранение продолжается автоматически; повторные входы тоже отслеживаются. Перед сменой реалма дождитесь сохранения. Ваши установленные серверы используют локальную подготовку и восстановление. Ограничение экспериментальной функции: устаревшая копия у другого владельца пока не обновляется автоматически при работающем worldserver. Для возвращения может потребоваться обслуживание владельцем. Устаревшая копия блокируется, основной персонаж остаётся сохранённым. Не удаляйте персонажа и не переустанавливайте сервер для обхода сообщения.
Перед первым включением остановите сервер. При сохранении Менеджер настроит портативные сессии для следующего запуска. Запрет доступа не прерывает текущие сессии.
+2
View File
@@ -51,3 +51,5 @@
在服务器的公开列表设置中,勾选“允许便携角色进入此服务器”并保存。默认不允许访问。关闭后会阻止新的导出和导入,但不会删除已保存的角色。主机端 Manager 必须保持运行。控制连接与游戏中继分别显示状态;控制连接成功不代表游戏隧道已经建立。角色始终保留原来的游戏模式(CoA、Wildcard 或 Warcraft Reborn),更换服务器不会转换角色模式。
请保持两个管理器运行。断线或重启后,待保存的进度会继续同步,再次登录也会继续跟踪。请等待保存完成后再切换服务器。自己安装的服务器使用本地准备和恢复流程。实验功能限制:其他主机上的旧角色副本目前无法在其 worldserver 运行时自动更新。返回该服务器可能需要主人进行维护。旧副本会被阻止,你的主角色仍然保存在管理器中。请勿通过删除角色或重装服务器绕过提示。
首次启用前请先停止服务器。保存时会为下次启动配置便携角色会话;关闭准入不会中断正在进行的会话。
+25
View File
@@ -183,6 +183,31 @@ pub(crate) async fn registry_set_access(
.clone()
.ok_or_else(|| fail("stopped", "the publishing service did not start"))?;
tauri::async_runtime::spawn_blocking(move || {
if allow_portable {
if let Some(route) = route.as_deref().filter(|value| !value.trim().is_empty()) {
coa_core::realm_registry::settings::validate_route(route.trim())
.map_err(|e| fail("invalid", e.to_string()))?;
}
let installs = Registry::at(data_dir().join("installs.json"))
.list().map_err(|e| fail("invalid", e.to_string()))?;
let access = coa_core::realm_registry::advert::find_access(
&data_dir().join("portable/realms"), &installs, &local_id,
).ok_or_else(|| fail("invalid", "This realm is no longer installed."))?;
if let Some(root) = &access.root {
coa_core::config::portable::enable(root)
.map_err(|e| fail("invalid", e.to_string()))?;
} else {
let db = access.db().map_err(|e| fail("invalid", e.to_string()))?;
let mut ra = access.ra().map_err(|e| fail("invalid", e.to_string()))?;
let caps = coa_core::portable::realm::profile::probe_capabilities(
&db, Some(&access.data_dir), Some(&mut ra),
&coa_core::portable::extension::ExtensionRegistry::new(),
).map_err(|e| fail("invalid", e.to_string()))?;
if !caps.content.supports(coa_core::portable::capabilities::Feature::RuntimeSessions) {
return Err(fail("invalid", "Enable portable sessions in this external server's core configuration and restart it before allowing portable characters."));
}
}
}
rt.set_access(&local_id, existing_only, allow_portable, route.as_deref())
.map_err(|e| fail("invalid", e.to_string()))
})
+1
View File
@@ -993,6 +993,7 @@ const de: Partial<Record<keyof typeof en, string>> = {
"fr.tab.servers": "Öffentliche Server",
"fr.tab.lan": "LAN und Direktverbindung",
"access.allowPortable": "Portable Charaktere auf diesem Realm erlauben",
"access.allowPortableHint": "Stoppe den Server vor dem ersten Aktivieren. Beim Speichern werden portable Sitzungen für den nächsten Start eingerichtet. Das Sperren neuer Zugriffe unterbricht laufende Sitzungen nicht.",
"access.relay": "Relay",
"access.relayUp": "Spiel-Relay verbunden",
"access.relayDown": "Spiel-Relay nicht verbunden",
+1
View File
@@ -1204,6 +1204,7 @@ const en = {
"crash.copied": "Copied!",
"access.allowPortable": "Allow portable characters on this realm",
"access.allowPortableHint": "Stop the server before enabling this for the first time. Saving prepares portable sessions for its next start; disabling access leaves ongoing sessions intact.",
"access.relay": "Relay",
"access.relayUp": "Game relay connected",
"access.relayDown": "Game relay disconnected",
+1
View File
@@ -993,6 +993,7 @@ const es: Partial<Record<keyof typeof en, string>> = {
"fr.tab.servers": "Servidores públicos",
"fr.tab.lan": "LAN y conexión directa",
"access.allowPortable": "Permitir personajes portátiles en este reino",
"access.allowPortableHint": "Detén el servidor antes de activar esta opción por primera vez. Al guardar se preparan las sesiones portátiles para el próximo inicio. Bloquear nuevos accesos no interrumpe las sesiones actuales.",
"access.relay": "Relay",
"access.relayUp": "Relay del juego conectado",
"access.relayDown": "Relay del juego desconectado",
+1
View File
@@ -993,6 +993,7 @@ const fr: Partial<Record<keyof typeof en, string>> = {
"fr.tab.servers": "Serveurs publics",
"fr.tab.lan": "Réseau local et connexion directe",
"access.allowPortable": "Autoriser les personnages portables sur ce royaume",
"access.allowPortableHint": "Arrêtez le serveur avant la première activation. L’enregistrement prépare les sessions portables pour le prochain démarrage. Bloquer les nouveaux accès ne coupe pas les sessions en cours.",
"access.relay": "Relay",
"access.relayUp": "Relais de jeu connecté",
"access.relayDown": "Relais de jeu déconnecté",
+1
View File
@@ -1186,6 +1186,7 @@ const ru: Partial<Record<keyof typeof en, string>> = {
"crash.copied": "Скопировано!",
"access.allowPortable": "Разрешить переносимых персонажей на этом реалме",
"access.allowPortableHint": "Перед первым включением остановите сервер. При сохранении Менеджер настроит портативные сессии для следующего запуска. Запрет доступа не прерывает текущие сессии.",
"access.relay": "Relay",
"access.relayUp": "Игровой relay подключён",
"access.relayDown": "Игровой relay не подключён",
+1
View File
@@ -995,6 +995,7 @@ const zh = {
"fr.tab.servers": "公开服务器",
"fr.tab.lan": "局域网与直连",
"access.allowPortable": "允许便携角色进入此服务器",
"access.allowPortableHint": "首次启用前请先停止服务器。保存时会为下次启动配置便携角色会话;关闭准入不会中断正在进行的会话。",
"access.relay": "Relay",
"access.relayUp": "游戏中继已连接",
"access.relayDown": "游戏中继未连接",
+1 -1
View File
@@ -96,7 +96,7 @@ export function PublishCard({ serverId, serverName }: { serverId: string; server
<p className="font-medium">{t("access.title")}</p>
<p className="mt-1 text-xs text-muted">{t("access.text")}</p>
<label className="mt-3 flex items-start gap-2"><input type="checkbox" checked={existingOnly} onChange={(e) => setExistingOnly(e.target.checked)} className="mt-1" data-testid="existing-only" /><span>{t("access.existingOnly")}<span className="block text-xs text-muted">{t("access.existingOnlyHint")}</span></span></label>
<label className="mt-3 flex items-start gap-2"><input type="checkbox" checked={allowPortable} onChange={(e) => setAllowPortable(e.target.checked)} className="mt-1" data-testid="allow-portable" /><span>{t("access.allowPortable")}</span></label>
<label className="mt-3 flex items-start gap-2"><input type="checkbox" checked={allowPortable} onChange={(e) => setAllowPortable(e.target.checked)} className="mt-1" data-testid="allow-portable" /><span>{t("access.allowPortable")}<span className="block text-xs text-muted">{t("access.allowPortableHint")}</span></span></label>
<label htmlFor="access-route" className="mt-3 block font-medium">{t("access.route")}</label>
<input id="access-route" value={route} placeholder="play.example.org:3724" onChange={(e) => setRoute(e.target.value)} className="mt-1 w-full rounded-md border border-line bg-card px-3 py-2" data-testid="access-route" />
<p className="mt-1 text-xs text-muted">{t("access.routeHint")}</p>