Client: clear the game cache on Play, remember the friend's server login

- clear_game_cache removes Cache/WDB/<locale>/*.wdb before every Play (own server and
  friend's), on by default, switch in the client card; nothing else in Cache or Data.
- The connection profile keeps the listed realm it was joined through; Play fills that
  realm's saved account into GlueConfig.json every time. A host typed by hand drops it.

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
This commit is contained in:
ДмитрийandClaude Opus 5.5 committed 2026-11-15 20:51:40 +05:00
1 parent 260d10b729
commit d64fdb51be
16 files changed
+149

No files matched your search

+7
View File
@@ -0,0 +1,7 @@
---
area: manager
type: added
audience: players
title: The game cache is cleared before every Play
---
After a server update the game showed old names and stats from its own cache (Cache/WDB). Play now clears that cache first; it fills again within seconds. A switch next to the client graphics settings turns it off.
@@ -0,0 +1,7 @@
---
area: manager
type: fixed
audience: players
title: The account for a friend's server is in the login box at every Play
---
The account the Manager made on a listed server was filled in only when joining. Play now fills it in every time, also after another server's account was used.
+49
View File
@@ -415,6 +415,38 @@ pub fn install_addon(client: &Path, meta: &Path, source: &Path) -> Result<()> {
Ok(())
}
/// Remove the game's cache of server data (`Cache/WDB/<locale>/*.wdb`: creatures, items, quests, pages). The client
/// keeps answers it got from a server; after the server's data changes they show old names and stats until the
/// cache is gone. Only `.wdb` files under `Cache/WDB` are removed. Returns how many.
pub fn clear_game_cache(client: &Path) -> Result<usize> {
if is_running(client) {
return Ok(0);
}
let root = client.join("Cache").join("WDB");
let mut removed = 0;
let Ok(locales) = fs::read_dir(&root) else {
return Ok(0);
};
for locale in locales.flatten() {
if !locale.file_type().is_ok_and(|t| t.is_dir()) {
continue;
}
let Ok(files) = fs::read_dir(locale.path()) else {
continue;
};
for file in files.flatten() {
let path = file.path();
let is_wdb = path
.extension()
.is_some_and(|e| e.eq_ignore_ascii_case("wdb"));
if is_wdb && file.file_type().is_ok_and(|t| t.is_file()) && fs::remove_file(&path).is_ok() {
removed += 1;
}
}
}
Ok(removed)
}
/// Start the game client. The caller is responsible for making sure the server is ready first.
pub fn launch(client: &Path) -> Result<u32> {
let exe =
@@ -613,6 +645,23 @@ pub fn recover_all_realmlist_overrides(meta_roots: &[PathBuf]) -> usize {
#[cfg(test)]
mod tests {
use super::*;
#[test]
fn only_the_server_data_cache_is_cleared() {
let d = tempfile::tempdir().unwrap();
let wdb = d.path().join("Cache/WDB/enUS");
fs::create_dir_all(&wdb).unwrap();
fs::write(wdb.join("creaturecache.wdb"), b"x").unwrap();
fs::write(wdb.join("itemcache.WDB"), b"x").unwrap();
fs::write(wdb.join("notes.txt"), b"keep").unwrap();
fs::create_dir_all(d.path().join("Data/Retail/Cache")).unwrap();
fs::write(d.path().join("Data/Retail/Cache/id-1.bin"), b"keep").unwrap();
assert_eq!(clear_game_cache(d.path()).unwrap(), 2);
assert!(wdb.join("notes.txt").is_file());
assert!(d.path().join("Data/Retail/Cache/id-1.bin").is_file());
assert_eq!(clear_game_cache(d.path()).unwrap(), 0);
assert_eq!(clear_game_cache(&d.path().join("missing")).unwrap(), 0);
}
#[cfg(windows)]
#[test]
+14
View File
@@ -7,6 +7,10 @@ use std::path::{Path, PathBuf};
pub struct Profile {
pub host: String,
pub client_path: Option<String>,
/// The listed server `host` belongs to, when the player joined it through the server list: its account is
/// filled into the game's login box at every Play.
#[serde(default, skip_serializing_if = "Option::is_none")]
pub realm: Option<String>,
}
pub fn load(dir: &Path) -> Result<Profile> {
@@ -43,12 +47,21 @@ pub fn save(dir: &Path, profile: &Profile) -> Result<()> {
#[cfg(test)]
mod tests {
use super::*;
#[test]
fn a_profile_from_before_the_realm_field_still_loads() {
let d = tempfile::tempdir().unwrap();
std::fs::write(d.path().join("connection.json"), br#"{"host":"1.2.3.4","client_path":null}"#).unwrap();
let p = load(d.path()).unwrap();
assert_eq!((p.host.as_str(), p.realm), ("1.2.3.4", None));
}
#[test]
fn connection_needs_no_server_and_survives_restart() {
let dir = tempfile::tempdir().unwrap();
let profile = Profile {
host: "192.168.1.10".into(),
client_path: None,
realm: None,
};
save(dir.path(), &profile).unwrap();
assert_eq!(load(dir.path()).unwrap().host, profile.host);
@@ -70,6 +83,7 @@ mod tests {
let profile = Profile {
host: "192.168.1.10".into(),
client_path: Some(game.to_string_lossy().into()),
realm: None,
};
save(dir.path(), &profile).unwrap();
assert!(
+1
View File
@@ -439,6 +439,7 @@ pub(crate) async fn join_realm(
let mut profile = coa_core::remote_client::load(&dir)
.map_err(|e| fail("other", e.to_string()))?;
profile.host = host;
profile.realm = Some(realm.clone());
coa_core::remote_client::save(&dir, &profile)
.map_err(|e| fail("launch", e.to_string()))?;
super::play(state, REMOTE_CLIENT_ID.to_string())
+35
View File
@@ -240,6 +240,7 @@ async fn portable_launch(
let mut profile =
coa_core::remote_client::load(&dir).map_err(|e| other(e.into()))?;
profile.host = address;
profile.realm = Some(realm.clone());
coa_core::remote_client::save(&dir, &profile).map_err(|e| other(e.into()))?;
if let Some(ref cp) = profile.client_path {
if let Ok(pc) = control_cmds::player(&state) {
@@ -2076,6 +2077,10 @@ fn remote_connect(
if host.is_empty() {
return Err(Error::Invalid("Enter the host's IP address or hostname.".into()).into());
}
if profile.host != host {
// A host typed by hand is not the listed server whose account was remembered.
profile.realm = None;
}
profile.host = host.into();
coa_core::remote_client::save(&dir, &profile)?;
Ok(profile)
@@ -2476,6 +2481,15 @@ async fn play(
if id == REMOTE_CLIENT_ID {
let ctx = client_context(&state, &id)?;
let client = ctx.require()?;
// The account the Manager made (or linked) on that listed server goes into the login box at every Play,
// also when another server's account was used in between.
let login = coa_core::remote_client::load(&remote_dir())
.ok()
.and_then(|profile| profile.realm)
.and_then(|realm| {
let pc = control_cmds::player(&state).ok()?;
pc.credentials(&control_cmds::realm_id(&realm).ok()?).ok()?
});
return blocking(move || {
if ctx.host.is_empty() {
return Err(Error::Invalid(
@@ -2486,6 +2500,12 @@ async fn play(
return Err(Error::Invalid("The game is already running.".into()));
}
coa_core::client::begin_realmlist_override(&client, &ctx.dir, &ctx.host)?;
if let Some(creds) = &login {
let _ = coa_core::glue_config::prefill_login(&client, &creds.username, &creds.password);
}
if window_preferences::clear_cache_on_play(&data_dir()) {
let _ = coa_core::client::clear_game_cache(&client);
}
coa_core::client::launch(&client)?;
let client_c = client.clone();
let meta_c = ctx.dir.clone();
@@ -2532,6 +2552,9 @@ async fn play(
if existing.is_empty() {
let _ = coa_core::glue_config::prefill_login(&client, "local", "local");
}
if window_preferences::clear_cache_on_play(&data_dir()) {
let _ = coa_core::client::clear_game_cache(&client);
}
coa_core::client::launch(&client)?;
Ok(DriverOutcome {
ok: true,
@@ -2998,6 +3021,16 @@ fn set_close_to_tray(enabled: bool) -> std::result::Result<(), UiError> {
Ok(window_preferences::save(&data_dir(), enabled)?)
}
#[tauri::command]
fn clear_game_cache_on_play() -> bool {
window_preferences::clear_cache_on_play(&data_dir())
}
#[tauri::command]
fn set_clear_game_cache_on_play(enabled: bool) -> std::result::Result<(), UiError> {
Ok(window_preferences::save_clear_cache_on_play(&data_dir(), enabled)?)
}
fn show_main_window(app: &AppHandle) {
let handle = app.clone();
if let Err(error) = app.run_on_main_thread(move || {
@@ -3082,6 +3115,8 @@ pub fn run() {
mysql_custom_save,
restart_schedule,
restart_schedule_save,
clear_game_cache_on_play,
set_clear_game_cache_on_play,
check_database,
repair_server,
module_set_enabled,
+12
View File
@@ -11,3 +11,15 @@ pub fn close_to_tray(dir: &Path) -> coa_core::Result<bool> {
pub fn save(dir: &Path, enabled: bool) -> coa_core::Result<()> {
coa_core::fsx::atomic_write_json(&dir.join("close-to-tray.json"), &enabled)
}
/// Clear the game's cache of server data before every Play (on unless the player turned it off).
pub fn clear_cache_on_play(dir: &Path) -> bool {
std::fs::read(dir.join("clear-game-cache.json"))
.ok()
.and_then(|bytes| serde_json::from_slice(&bytes).ok())
.unwrap_or(true)
}
pub fn save_clear_cache_on_play(dir: &Path, enabled: bool) -> coa_core::Result<()> {
coa_core::fsx::atomic_write_json(&dir.join("clear-game-cache.json"), &enabled)
}
+2
View File
@@ -29,6 +29,8 @@ export {};
(window as any).__TAURI_INTERNALS__ = {
transformCallback: (cb: unknown)=>cb, unregisterCallback(){}, convertFileSrc:(x: unknown)=>x,
invoke: async (cmd: string, args?: any)=>{
if(cmd==="clear_game_cache_on_play") return localStorage.getItem("demo-clear-cache")!=="0";
if(cmd==="set_clear_game_cache_on_play"){localStorage.setItem("demo-clear-cache",args.enabled?"1":"0");return;}
if(cmd==="close_to_tray") return localStorage.getItem("demo-close-tray")==="1";
if(cmd==="set_close_to_tray"){localStorage.setItem("demo-close-tray",args.enabled?"1":"0");return;}
if(cmd==="client_graphics") return JSON.parse(localStorage.getItem("demo-graphics")??'{"dxvk_disabled":false,"enhancements_disabled":false}');
+2
View File
@@ -786,6 +786,8 @@ const de: Partial<Record<keyof typeof en, string>> = {
"sched.save": "Speichern",
"sched.saved": "Gespeichert.",
"sched.unsupported": "Dieser Server kann das noch nicht: Aktualisiere ihn auf einen Build mit dem neuen Launcher.",
"client.clearCache": "Spiel-Cache vor jedem Start leeren",
"client.clearCacheHint": "Das Spiel merkt sich Kreaturen, Gegenstände und Quests vom Server (Cache/WDB). Nach einem Server-Update zeigen sie sonst alte Namen und Werte; der Cache füllt sich in Sekunden wieder.",
"realm.namesTitle": "Realmnamen",
"realm.namesHint": "So heißt der Realm in der Realmliste der Spieler. Ein laufender Server zeigt den Namen sofort, und er bleibt nach Updates erhalten.",
"realm.nameSave": "Speichern",
+2
View File
@@ -70,6 +70,8 @@ const en = {
"sched.save": "Save",
"sched.saved": "Saved.",
"sched.unsupported": "This server cannot do it yet: update the server to a build with the new launcher.",
"client.clearCache": "Clear the game cache before every Play",
"client.clearCacheHint": "The game remembers creatures, items and quests it got from a server (Cache/WDB). After a server update they can show old names and stats; the cache fills again within seconds.",
"realm.namesTitle": "Realm names",
"realm.namesHint": "The name players see in the realm list. A running server shows it at once, and it stays after updates.",
"realm.nameSave": "Save",
+2
View File
@@ -786,6 +786,8 @@ const es: Partial<Record<keyof typeof en, string>> = {
"sched.save": "Guardar",
"sched.saved": "Guardado.",
"sched.unsupported": "Este servidor aún no puede hacerlo: actualízalo a una versión con el nuevo lanzador.",
"client.clearCache": "Vaciar la caché del juego antes de cada inicio",
"client.clearCacheHint": "El juego recuerda criaturas, objetos y misiones recibidos del servidor (Cache/WDB). Tras actualizar el servidor pueden mostrar nombres y estadísticas antiguos; la caché se llena de nuevo en segundos.",
"realm.namesTitle": "Nombres de los reinos",
"realm.namesHint": "El nombre que ven los jugadores en la lista de reinos. Un servidor en marcha lo muestra al instante y se mantiene tras las actualizaciones.",
"realm.nameSave": "Guardar",
+2
View File
@@ -786,6 +786,8 @@ const fr: Partial<Record<keyof typeof en, string>> = {
"sched.save": "Enregistrer",
"sched.saved": "Enregistré.",
"sched.unsupported": "Ce serveur ne le permet pas encore : mettez-le à jour vers une version avec le nouveau lanceur.",
"client.clearCache": "Vider le cache du jeu avant chaque lancement",
"client.clearCacheHint": "Le jeu garde les créatures, objets et quêtes reçus du serveur (Cache/WDB). Après une mise à jour du serveur, ils peuvent montrer d'anciens noms et statistiques ; le cache se remplit en quelques secondes.",
"realm.namesTitle": "Noms des royaumes",
"realm.namesHint": "Le nom que les joueurs voient dans la liste des royaumes. Un serveur en marche l'affiche aussitôt, et il reste après les mises à jour.",
"realm.nameSave": "Enregistrer",
+2
View File
@@ -73,6 +73,8 @@ const ru: Partial<Record<keyof typeof en, string>> = {
"sched.save": "Сохранить",
"sched.saved": "Сохранено.",
"sched.unsupported": "Этот сервер пока так не умеет: обновите его до сборки с новым лаунчером.",
"client.clearCache": "Очищать кэш игры перед каждым запуском",
"client.clearCacheHint": "Игра запоминает существ, предметы и задания, полученные от сервера (Cache/WDB). После обновления сервера там остаются старые названия и характеристики; кэш снова заполняется за секунды.",
"realm.namesTitle": "Названия реалмов",
"realm.namesHint": "Так реалм называется в списке реалмов у игроков. Работающий сервер показывает новое название сразу, и оно сохраняется после обновлений.",
"realm.nameSave": "Сохранить",
+2
View File
@@ -71,6 +71,8 @@ const zh = {
"sched.save": "保存",
"sched.saved": "已保存。",
"sched.unsupported": "此服务器暂不支持:请将服务器更新到带有新启动器的版本。",
"client.clearCache": "每次启动前清空游戏缓存",
"client.clearCacheHint": "游戏会保存从服务器获得的生物、物品和任务(Cache/WDB)。服务器更新后,这些缓存可能显示旧的名称和属性;缓存会在几秒内重新生成。",
"realm.namesTitle": "服务器名称",
"realm.namesHint": "玩家在服务器列表中看到的名称。运行中的服务器会立即显示新名称,更新后也会保留。",
"realm.nameSave": "保存",
+2
View File
@@ -491,6 +491,8 @@ export const api = {
realmProfiles: (id: string) => invoke<RealmProfiles>("realm_profiles", { id }),
realmSelect: (id: string, mode: RealmMode, restart: boolean) => invoke<RealmProfiles>("realm_select", { id, mode, restart }),
realmSimultaneous: (id: string, enabled: boolean) => invoke<RealmProfiles>("realm_simultaneous", { id, enabled }),
clearGameCacheOnPlay: () => invoke<boolean>("clear_game_cache_on_play"),
setClearGameCacheOnPlay: (enabled: boolean) => invoke<void>("set_clear_game_cache_on_play", { enabled }),
restartSchedule: (id: string) => invoke<RestartScheduleView>("restart_schedule", { id }),
restartScheduleSave: (id: string, schedule: RestartSchedule) => invoke<RestartScheduleView>("restart_schedule_save", { id, schedule }),
mysqlCustom: (id: string) => invoke<CustomMysql>("mysql_custom", { id }),
+8
View File
@@ -9,6 +9,12 @@ export function ClientGraphics({ serverId }: { serverId: string }) {
const [busy, setBusy] = useState(false);
const [error, setError] = useState<string | null>(null);
useEffect(() => { void api.clientGraphics(serverId).then(setState).catch(e => setError(asUiError(e).technical)); }, [serverId]);
const [clearCache, setClearCache] = useState<boolean | null>(null);
useEffect(() => { void api.clearGameCacheOnPlay().then(setClearCache).catch(() => setClearCache(true)); }, []);
async function changeClearCache(on: boolean) {
setClearCache(on);
try { await api.setClearGameCacheOnPlay(on); } catch (e) { setClearCache(!on); setError(asUiError(e).technical); }
}
async function change(name: string, disabled: boolean) {
setBusy(true); setError(null);
try { setState(await api.clientSetGraphics(serverId, name, disabled)); await checkClient(serverId); }
@@ -19,6 +25,8 @@ export function ClientGraphics({ serverId }: { serverId: string }) {
<label className="flex items-center gap-2 text-sm"><input type="checkbox" checked={state?.dxvk_disabled ?? false} disabled={!state || busy} onChange={e => void change("d3d9.dll", e.target.checked)} />{t("client.graphics.dxvk")}</label>
<label className="flex items-center gap-2 text-sm"><input type="checkbox" checked={state?.enhancements_disabled ?? false} disabled={!state || busy} onChange={e => void change("dxgi.dll", e.target.checked)} />{t("client.graphics.enhancements")}</label>
<p className="text-xs text-muted">{t("client.graphics.hint")}</p>
<label className="flex items-center gap-2 text-sm"><input type="checkbox" checked={clearCache ?? true} disabled={clearCache === null} onChange={e => void changeClearCache(e.target.checked)} />{t("client.clearCache")}</label>
<p className="text-xs text-muted">{t("client.clearCacheHint")}</p>
{error && <p className="text-sm text-bad" role="alert">{error}</p>}
</div>;
}