Index: ps/trunk/source/ps/Mod.h =================================================================== --- ps/trunk/source/ps/Mod.h +++ ps/trunk/source/ps/Mod.h @@ -32,7 +32,6 @@ // Singleton-like interface. static Mod& Instance(); - JS::Value GetAvailableMods(const ScriptInterface& scriptInterface) const; const std::vector& GetEnabledMods() const; const std::vector& GetIncompatibleMods() const; @@ -61,26 +60,51 @@ */ JS::Value GetEngineInfo(const ScriptInterface& scriptInterface) const; -private: /** - * This reads the version numbers from the launched mods. - * It caches the result, since the reading of zip files is slow and - * JS pages can request the version numbers too often easily. - * Make sure this is called after each MountMods call. + * Gets a dictionary of available mods and their complete, parsed mod.json data. */ - void CacheEnabledModVersions(const ScriptInterface& scriptInterface); + JS::Value GetAvailableMods(const ScriptRequest& rq) const; + + /** + * Fetches available mods and stores some metadata about them. + * This may open the zipped mod archives, depending on the situation, + * and/or try to write files to the user mod folder, + * which can be quite slow, so should be run rarely. + * TODO: if this did not need the scriptInterface to parse JSON, + * we could run it in different contexts and possibly cleaner. + */ + void UpdateAvailableMods(const ScriptInterface& scriptInterface); + + /** + * Parsed mod.json data for C++ usage. + */ + struct ModData + { + // 'Folder name' of the mod, e.g. 'public' for the main 0 A.D. mod. + CStr m_Pathname; + // "name" property in the mod.json + CStr m_Name; + + CStr m_Version; + std::vector m_Dependencies; + + // For convenience when exporting to JS, keep a record of the full file. + CStr m_Text; + }; + +private: /** * Checks a list of @a mods and returns the incompatible mods, if any. */ - std::vector CheckForIncompatibleMods(const ScriptInterface& scriptInterface, const std::vector& mods, const JS::RootedValue& availableMods) const; + std::vector CheckForIncompatibleMods(const std::vector& mods) const; bool CompareVersionStrings(const CStr& required, const CStr& op, const CStr& version) const; std::vector m_EnabledMods; // Of the currently loaded mods, these are the incompatible with the engine and cannot be loaded. std::vector m_IncompatibleMods; - std::vector> m_LoadedModVersions; + std::vector m_AvailableMods; }; #endif // INCLUDED_MOD Index: ps/trunk/source/ps/Mod.cpp =================================================================== --- ps/trunk/source/ps/Mod.cpp +++ ps/trunk/source/ps/Mod.cpp @@ -28,9 +28,10 @@ #include "ps/GameSetup/Paths.h" #include "ps/Profiler2.h" #include "ps/Pyrogenesis.h" +#include "scriptinterface/JSON.h" #include "scriptinterface/Object.h" +#include "scriptinterface/ScriptExceptions.h" #include "scriptinterface/ScriptInterface.h" -#include "scriptinterface/JSON.h" #include #include @@ -46,7 +47,7 @@ */ Mod g_ModInstance; -bool ParseModJSON(const ScriptRequest& rq, const PIVFS& vfs, OsPath modsPath, OsPath mod, JS::MutableHandleValue json) +bool LoadModJSON(const PIVFS& vfs, OsPath modsPath, OsPath mod, std::string& text) { // Attempt to open mod.json first. std::ifstream modjson; @@ -66,14 +67,13 @@ if (modinfo.Load(vfs, L"mod.json", false) != PSRETURN_OK) return false; - if (!Script::ParseJSON(rq, modinfo.GetAsString(), json)) - return false; + text = modinfo.GetAsString(); // Attempt to write the mod.json file so we'll take the fast path next time. std::ofstream out_mod_json((modsPath / mod / L"mod.json").string8()); if (out_mod_json.good()) { - out_mod_json << modinfo.GetAsString(); + out_mod_json << text; out_mod_json.close(); } else @@ -90,9 +90,33 @@ { std::stringstream buffer; buffer << modjson.rdbuf(); - return Script::ParseJSON(rq, buffer.str(), json); + text = buffer.str(); + return true; } } + +bool ParseModJSON(const ScriptRequest& rq, const PIVFS& vfs, OsPath modsPath, OsPath mod, Mod::ModData& data) +{ + std::string text; + if (!LoadModJSON(vfs, modsPath, mod, text)) + return false; + + JS::RootedValue json(rq.cx); + if (!Script::ParseJSON(rq, text, &json)) + return false; + + data.m_Pathname = utf8_from_wstring(mod.string()); + data.m_Text = text; + + if (!Script::GetProperty(rq, json, "version", data.m_Version)) + return false; + if (!Script::GetProperty(rq, json, "name", data.m_Name)) + return false; + if (!Script::GetProperty(rq, json, "dependencies", data.m_Dependencies)) + return false; + return true; +} + } // anonymous namespace Mod& Mod::Instance() @@ -100,9 +124,9 @@ return g_ModInstance; } -JS::Value Mod::GetAvailableMods(const ScriptInterface& scriptInterface) const +void Mod::UpdateAvailableMods(const ScriptInterface& scriptInterface) { - PROFILE2("GetAvailableMods"); + PROFILE2("UpdateAvailableMods"); const Paths paths(g_CmdLineArgs); @@ -120,15 +144,13 @@ PIVFS vfs = CreateVfs(); ScriptRequest rq(scriptInterface); - JS::RootedValue value(rq.cx, Script::CreateObject(rq)); - for (DirectoryNames::iterator iter = modDirs.begin(); iter != modDirs.end(); ++iter) { - JS::RootedValue json(rq.cx); - if (!ParseModJSON(rq, vfs, modPath, *iter, &json)) + ModData data; + if (!ParseModJSON(rq, vfs, modPath, *iter, data)) continue; // Valid mod data, add it to our structure - Script::SetProperty(rq, value, utf8_from_wstring(iter->string()).c_str(), json); + m_AvailableMods.emplace_back(std::move(data)); } GetDirectoryEntries(modUserPath, NULL, &modDirsUser); @@ -139,14 +161,12 @@ if (std::binary_search(modDirs.begin(), modDirs.end(), *iter)) continue; - JS::RootedValue json(rq.cx); - if (!ParseModJSON(rq, vfs, modUserPath, *iter, &json)) + ModData data; + if (!ParseModJSON(rq, vfs, modUserPath, *iter, data)) continue; // Valid mod data, add it to our structure - Script::SetProperty(rq, value, utf8_from_wstring(iter->string()).c_str(), json); + m_AvailableMods.emplace_back(std::move(data)); } - - return value.get(); } const std::vector& Mod::GetEnabledMods() const @@ -179,21 +199,18 @@ if (counts["mod"] == 0) m_EnabledMods.insert(m_EnabledMods.begin(), "mod"); - ScriptRequest rq(scriptInterface); - JS::RootedValue availableMods(rq.cx, GetAvailableMods(scriptInterface)); - m_IncompatibleMods = CheckForIncompatibleMods(scriptInterface, m_EnabledMods, availableMods); + UpdateAvailableMods(scriptInterface); + + m_IncompatibleMods = CheckForIncompatibleMods(m_EnabledMods); for (const CStr& mod : m_IncompatibleMods) m_EnabledMods.erase(std::find(m_EnabledMods.begin(), m_EnabledMods.end(), mod)); - CacheEnabledModVersions(scriptInterface); - return m_IncompatibleMods.empty(); } -std::vector Mod::CheckForIncompatibleMods(const ScriptInterface& scriptInterface, const std::vector& mods, const JS::RootedValue& availableMods) const +std::vector Mod::CheckForIncompatibleMods(const std::vector& mods) const { - ScriptRequest rq(scriptInterface); std::vector incompatibleMods; std::unordered_map> modDependencies; std::unordered_map modNameVersions; @@ -202,29 +219,17 @@ if (mod == "mod") continue; - JS::RootedValue modData(rq.cx); + std::vector::const_iterator it = std::find_if(m_AvailableMods.begin(), m_AvailableMods.end(), + [&mod](const ModData& modData) { return modData.m_Pathname == mod; }); - // Requested mod is not available, fail - if (!Script::HasProperty(rq, availableMods, mod.c_str())) + if (it == m_AvailableMods.end()) { incompatibleMods.push_back(mod); continue; } - if (!Script::GetProperty(rq, availableMods, mod.c_str(), &modData)) - { - incompatibleMods.push_back(mod); - continue; - } - - std::vector dependencies; - CStr version; - CStr name; - Script::GetProperty(rq, modData, "dependencies", dependencies); - Script::GetProperty(rq, modData, "version", version); - Script::GetProperty(rq, modData, "name", name); - modNameVersions.emplace(name, version); - modDependencies.emplace(mod, dependencies); + modNameVersions.emplace(it->m_Name, it->m_Version); + modDependencies.emplace(it->m_Name, it->m_Dependencies); } static const std::vector toCheck = { "<=", ">=", "=", "<", ">" }; @@ -308,35 +313,26 @@ return versionSize < requiredSize ? lt : gt; } - -void Mod::CacheEnabledModVersions(const ScriptInterface& scriptInterface) +JS::Value Mod::GetLoadedModsWithVersions(const ScriptInterface& scriptInterface) const { - ScriptRequest rq(scriptInterface); - - JS::RootedValue availableMods(rq.cx, GetAvailableMods(scriptInterface)); - - m_LoadedModVersions.clear(); - + std::vector> loadedMods; for (const CStr& mod : m_EnabledMods) { - // Ignore mod mod as it is irrelevant for compatibility checks - if (mod == "mod") - continue; + std::vector::const_iterator it = std::find_if(m_AvailableMods.begin(), m_AvailableMods.end(), + [&mod](const ModData& modData) { return modData.m_Pathname == mod; }); - CStr version; - JS::RootedValue modData(rq.cx); - if (Script::GetProperty(rq, availableMods, mod.c_str(), &modData)) - Script::GetProperty(rq, modData, "version", version); + // This ought be impossible, but let's handle it anyways since it's not a reason to crash. + if (it == m_AvailableMods.end()) + { + LOGERROR("Unavailable mod '%s' was enabled.", mod); + continue; + } - m_LoadedModVersions.push_back({mod, version}); + loadedMods.emplace_back(std::vector{ it->m_Name, it->m_Version }); } -} - -JS::Value Mod::GetLoadedModsWithVersions(const ScriptInterface& scriptInterface) const -{ ScriptRequest rq(scriptInterface); JS::RootedValue returnValue(rq.cx); - Script::ToJSVal(rq, &returnValue, m_LoadedModVersions); + Script::ToJSVal(rq, &returnValue, loadedMods); return returnValue; } @@ -357,3 +353,19 @@ return metainfo; } + +JS::Value Mod::GetAvailableMods(const ScriptRequest& rq) const +{ + JS::RootedValue ret(rq.cx, Script::CreateObject(rq)); + for (const ModData& data : m_AvailableMods) + { + JS::RootedValue json(rq.cx); + if (!Script::ParseJSON(rq, data.m_Text, &json)) + { + ScriptException::Raise(rq, "Error parsing mod.json of '%s'", data.m_Pathname.c_str()); + continue; + } + Script::SetProperty(rq, ret, data.m_Pathname.c_str(), json); + } + return ret.get(); +} Index: ps/trunk/source/ps/tests/test_Mod.h =================================================================== --- ps/trunk/source/ps/tests/test_Mod.h +++ ps/trunk/source/ps/tests/test_Mod.h @@ -91,90 +91,43 @@ ScriptRequest rq(script); JS::RootedObject obj(rq.cx, JS_NewPlainObject(rq.cx)); - CStr jsonString = "{\ - \"name\": \"0ad\",\ - \"version\" : \"0.0.25\",\ - \"label\" : \"0 A.D. Empires Ascendant\",\ - \"url\" : \"https://play0ad.com\",\ - \"description\" : \"A free, open-source, historical RTS game.\",\ - \"dependencies\" : []\ - }\ - "; - JS::RootedValue json(rq.cx); - TS_ASSERT(Script::ParseJSON(rq, jsonString, &json)); - JS_SetProperty(rq.cx, obj, "public", json); - - JS::RootedValue jsonW(rq.cx); - CStr jsonStringW = "{\ - \"name\": \"wrong\",\ - \"version\" : \"0.0.25\",\ - \"label\" : \"wrong mod\",\ - \"url\" : \"\",\ - \"description\" : \"fail\",\ - \"dependencies\" : [\"0ad=0.0.24\"]\ - }\ - "; - TS_ASSERT(Script::ParseJSON(rq, jsonStringW, &jsonW)); - JS_SetProperty(rq.cx, obj, "wrong", jsonW); - - JS::RootedValue jsonG(rq.cx); - CStr jsonStringG = "{\ - \"name\": \"good\",\ - \"version\" : \"0.0.25\",\ - \"label\" : \"good mod\",\ - \"url\" : \"\",\ - \"description\" : \"ok\",\ - \"dependencies\" : [\"0ad=0.0.25\"]\ - }\ - "; - TS_ASSERT(Script::ParseJSON(rq, jsonStringG, &jsonG)); - JS_SetProperty(rq.cx, obj, "good", jsonG); - - JS::RootedValue jsonG2(rq.cx); - CStr jsonStringG2 = "{\ - \"name\": \"good\",\ - \"version\" : \"0.0.25\",\ - \"label\" : \"good mod\",\ - \"url\" : \"\",\ - \"description\" : \"ok\",\ - \"dependencies\" : [\"0ad>=0.0.24\"]\ - }\ - "; - TS_ASSERT(Script::ParseJSON(rq, jsonStringG2, &jsonG2)); - JS_SetProperty(rq.cx, obj, "good2", jsonG2); - - JS::RootedValue availableMods(rq.cx, JS::ObjectValue(*obj)); + m_Mods.m_AvailableMods = { + Mod::ModData{ "public", "0ad", "0.0.25", {}, "" }, + Mod::ModData{ "wrong", "wrong", "0.0.1", { "0ad=0.0.24" }, "" }, + Mod::ModData{ "good", "good", "0.0.2", { "0ad=0.0.25" }, "" }, + Mod::ModData{ "good2", "good2", "0.0.4", { "0ad>=0.0.24" }, "" }, + }; std::vector mods; mods.clear(); mods.push_back("public"); - TS_ASSERT(m_Mods.CheckForIncompatibleMods(script, mods, availableMods).empty()); + TS_ASSERT(m_Mods.CheckForIncompatibleMods(mods).empty()); mods.clear(); mods.push_back("mod"); mods.push_back("public"); - TS_ASSERT(m_Mods.CheckForIncompatibleMods(script, mods, availableMods).empty()); + TS_ASSERT(m_Mods.CheckForIncompatibleMods(mods).empty()); mods.clear(); mods.push_back("public"); mods.push_back("good"); - TS_ASSERT(m_Mods.CheckForIncompatibleMods(script, mods, availableMods).empty()); + TS_ASSERT(m_Mods.CheckForIncompatibleMods(mods).empty()); mods.clear(); mods.push_back("public"); mods.push_back("good2"); - TS_ASSERT(m_Mods.CheckForIncompatibleMods(script, mods, availableMods).empty()); + TS_ASSERT(m_Mods.CheckForIncompatibleMods(mods).empty()); mods.clear(); mods.push_back("public"); mods.push_back("wrong"); - TS_ASSERT(!m_Mods.CheckForIncompatibleMods(script, mods, availableMods).empty()); + TS_ASSERT(!m_Mods.CheckForIncompatibleMods(mods).empty()); mods.clear(); mods.push_back("public"); mods.push_back("does_not_exist"); - TS_ASSERT(!m_Mods.CheckForIncompatibleMods(script, mods, availableMods).empty()); + TS_ASSERT(!m_Mods.CheckForIncompatibleMods(mods).empty()); } };