mirror of
https://github.com/brues-code/ClassicAPI.git
synced 2026-11-16 08:00:42 +00:00
* feat(addons): retail-like /reload — new addons and new files load Two engine limitations kept anything created after boot from loading until a client restart: 1. File visibility: every relative-path read resolves through a loose-file hash index built once at boot (FUN_00646EA0, latched); the archive layer's live disk probe is dead code (DAT_00865B44 ships 1, boot clears it) and writes never register. New files - including a new addon's TOC and first-ever SavedVariables - were invisible until restart. 2. Registry membership: the addon registry is built once at login; new folders are never walked. Addons::Rescan runs per /reload from the ModuleAutoRegister callback (before the AddOns.txt re-read, progress count, and load pass) and: - re-indexes Interface\AddOns + WTF\Account with the engine's own dedup-safe boot indexer (FUN_VFS_INDEX_SUBTREE) - new files in existing addons then load natively, since the per-addon loader re-reads the TOC from disk on every load pass; a newly installed addon's first SV save now also survives /reload; - replays login scan walk #2 verbatim (FUN_ADDON_SCAN_DISK_DIRS with the engine's own dir-to-parser callback) so new folders register as complete normal entries via the dedup-guarded TOC parser; - mirrors the two structures the login scan would have filled: reverse-LoadWith links (tail-loop grow+append, restricted to pairs involving a new entry - the engine's lists have no dedup) and the flat GetNumAddOns display array (FUN_0051DA70 phase 2: filter byte +0x29, engine grow + qsort comparator). Append-only by design: no teardown, no eviction, no mutation of existing entries - the prior hot-reload attempt died re-running the login-only FUN_ADDON_INIT teardown mid-reload. Still login-only (no safe mechanism): ## metadata edits of already-registered addons and folder deletions. Also centralizes Embedded.cpp's addon-entry field constants into Offsets.h now that a second module reads them. * refactor(addons): centralize the registry list walk; record dedup-guard probe The intrusive linked-list walk (head at [VAR_ADDON_LIST_HEAD], next at entry + [VAR_ADDON_LIST_CTRL] + 4, low-bit-1/NULL sentinel) was implemented twice -- a template in Rescan.cpp and an inline loop in Embedded.cpp's FinalizeEmbeddedEntry. Move it to addons/Registry.h as Addons::ForEachEntry, with a void- or bool-returning visitor (false stops early). The early stop is load-bearing for Embedded: re-linking the found entry to the head invalidates the current next-pointer, so the walk must not continue past it -- the shared helper makes that contract explicit. Also record the TOC-parser dedup-guard verification in Rescan.cpp's scan-call comment: the guard is the parser's FIRST block (hash lookup + name compare, early return before the TOC path is even built), and both the Storm hash (uppercases a-z, folds '/'->'\') and the SStrCmpI compare are case-insensitive -- so the per-/reload scan replay can never re-read or mutate a registered entry's ## metadata, and a case-renamed folder matches its existing entry instead of registering a duplicate. * feat(addons): /reload re-parses edited ## metadata and drops deleted addons The TOC parser's dedup guard makes a registered entry's ## metadata read-once: an edited ## SavedVariables: / ## Dependencies: / any ## line never re-parsed until re-login, and a deleted folder's entry lingered in the addon list. Both were documented login-only limits of the retail-like /reload feature. Rescan's new step 1.5 closes them with evict + re-register, all engine machinery: - Change detection: FNV-1a over the TOC's ## lines only (BOM skipped like the parser, line terminators excluded), read through the hooked FUN_FILE_READ so flavor selection is hashed exactly as the parser reads it. File-reference edits never trigger the evict path -- the load pass re-reads those natively. Baselines seed at login and for newly registered folders in the same Run(), so an edit is always diffed against what was actually parsed. - Evict: scrub the victim from every other entry's reverse-LoadWith list (the one reference the destructor cannot clean -- the loader's post-ADDON_LOADED loop dereferences those entries), then call the engine's own complete per-entry destructor FUN_ADDON_ENTRY_DESTROY (0x005200A0, __stdcall, RET 4; vtable slot 0 of the registry node factory at [0x00BE1B60], dispatched per entry by the login teardown). Verified by decompile: frees every owned allocation (name, dep/SV arrays + buffers, reverse-LoadWith buffer, the ## metadata table) and self-unlinks from both the intrusive list (FUN_00520A60, no-ops when already unlinked) and the hash bucket chain. - Re-register: feed the name back to FUN_TOC_PARSER -- the dedup guard now misses and the entry rebuilds from the edited TOC exactly like a fresh registration. Refreshed entries join the existing FixupReverseLoadWith/RebuildDisplayArray fix-ups; the refresh runs before the before-snapshot so an address-reusing allocator cannot make the added-diff double-count or miss one. Any eviction forces the display-array rebuild (it holds the dead entry's freed name pointer until then). Victims are collected during the walk and processed after it -- the dtor zeroes the link node under the iterator. - Deletion: an unreadable TOC evicts without re-registering; a folder the scan still finds simply re-registers the same reload. Exempt: !!!ClassicAPI (Addons::Embedded owns its entry) and ## Secure: / SMSG-managed entries (the parser cannot restore packet-delivered state; new OFF_ADDON_ENTRY_SECURE = 0x28, parser write site verified). Verified in-game: ## X-Test metadata edit picked up across /reload (GetAddOnMetadata returns the new value), SavedVariables list edit takes effect, folder deletion drops the entry from GetNumAddOns, folder restore re-registers it, and a no-change /reload is a pure hash-compare no-op. * fix(addons): address review — hash commit timing, evict flag, README row - README: the /reload row said `##` metadata edits still need a re-login — stale from before the metadata-refresh step landed. Now matches docs/API.md: edits take effect, deleted folders drop from the addon list. - Rescan: commit g_metaHash only after the re-registration actually happened, so a failed resolve/parse retries next /reload instead of silently absorbing the edit forever; a victim the parse cannot restore is erased (treated as deleted) so a reappearing folder re-seeds. - Rescan: RefreshChangedMetadata returns whether anything was actually destroyed, not whether victims were collected — no display-array rebuild when every victim failed to resolve. - Rescan: comment the load-order consequence of evict + re-register (the fresh entry appends at the list tail; declared deps still force-load first).