Skip to content

Commit

Permalink
Merge branch 'main' into fix/multiple-mod-versions
Browse files Browse the repository at this point in the history
  • Loading branch information
Alystrasz authored Nov 23, 2024
2 parents e747fc3 + fad89b3 commit 82729f0
Show file tree
Hide file tree
Showing 4 changed files with 54 additions and 4 deletions.
35 changes: 32 additions & 3 deletions primedev/mods/autodownload/moddownloader.cpp
Original file line number Diff line number Diff line change
Expand Up @@ -156,6 +156,14 @@ int ModDownloader::ModFetchingProgressCallback(
{
NOTE_UNUSED(totalToUpload);
NOTE_UNUSED(nowUploaded);

// Abort download
ModDownloader* instance = static_cast<ModDownloader*>(ptr);
if (instance->modState.state == ABORTED)
{
return 1;
}

if (totalDownloadSize != 0 && finishedDownloadSize != 0)
{
ModDownloader* instance = static_cast<ModDownloader*>(ptr);
Expand Down Expand Up @@ -563,6 +571,13 @@ void ModDownloader::ExtractMod(fs::path modPath, VerifiedModPlatform platform)
}
}

// Abort mod extraction if needed
if (modState.state == ABORTED)
{
spdlog::info("User cancelled mod installation, aborting mod extraction.");
return;
}

// Go to next file
if ((i + 1) < gi.number_entry)
{
Expand Down Expand Up @@ -602,8 +617,7 @@ void ModDownloader::DownloadMod(std::string modName, std::string modVersion)
spdlog::error("Error while removing downloaded archive: {}", a.what());
}

modState.state = DONE;
spdlog::info("Done downloading {}.", modName);
spdlog::info("Done cleaning after downloading {}.", modName);
});

// Download mod archive
Expand All @@ -613,7 +627,10 @@ void ModDownloader::DownloadMod(std::string modName, std::string modVersion)
if (!fetchingResult.has_value())
{
spdlog::error("Something went wrong while fetching archive, aborting.");
modState.state = MOD_FETCHING_FAILED;
if (modState.state != ABORTED)
{
modState.state = MOD_FETCHING_FAILED;
}
return;
}
archiveLocation = fetchingResult.value();
Expand All @@ -626,11 +643,17 @@ void ModDownloader::DownloadMod(std::string modName, std::string modVersion)

// Extract downloaded mod archive
ExtractMod(archiveLocation, fullVersion.platform);
modState.state = DONE;
});

requestThread.detach();
}

void ModDownloader::CancelDownload()
{
modState.state = ABORTED;
}

ON_DLL_LOAD_RELIESON("engine.dll", ModDownloader, (ConCommand), (CModule module))
{
g_pModDownloader = new ModDownloader();
Expand Down Expand Up @@ -687,3 +710,9 @@ ADD_SQFUNC("ModInstallState", NSGetModInstallState, "", "", ScriptContext::SERVE

return SQRESULT_NOTNULL;
}

ADD_SQFUNC("void", NSCancelModDownload, "", "", ScriptContext::SERVER | ScriptContext::CLIENT | ScriptContext::UI)
{
g_pModDownloader->CancelDownload();
return SQRESULT_NULL;
}
1 change: 1 addition & 0 deletions primedev/mods/autodownload/moddownloader.h
Original file line number Diff line number Diff line change
Expand Up @@ -129,6 +129,7 @@ class ModDownloader
CHECKSUMING,
EXTRACTING,
DONE, // Everything went great, mod can be used in-game
ABORTED, // User cancelled mod install process

// Errors
FAILED, // Generic error message, should be avoided as much as possible
Expand Down
2 changes: 1 addition & 1 deletion primedev/mods/modmanager.cpp
Original file line number Diff line number Diff line change
Expand Up @@ -1026,7 +1026,7 @@ void ModManager::LoadMods()
int currentModIndex = 0;
for (Mod& mod : m_LoadedMods)
{
if (!mod.m_bEnabled || (!mod.RequiredOnClient && !mod.Pdiff.size()))
if (!mod.m_bEnabled)
continue;

modinfoDoc["Mods"].PushBack(rapidjson::kObjectType, modinfoDoc.GetAllocator());
Expand Down
20 changes: 20 additions & 0 deletions primedev/mods/modsavefiles.cpp
Original file line number Diff line number Diff line change
Expand Up @@ -74,6 +74,26 @@ template <ScriptContext context> void SaveFileManager::SaveFileAsync(fs::path fi
std::thread writeThread(
[mutex, file, contents]()
{
// Check if has extension and return early if not
if (!file.has_extension())
{
spdlog::error("A mod failed to save a file via Safe I/O due to the following error:");
spdlog::error("No file extension specified");
return;
}

// If there's a file extension missing here that you need, feel free to make a PR adding it
static const std::set<std::string> whitelist = {".txt", ".json"};

// Check if file extension is whitelisted
std::string extension = file.extension().string();
if (whitelist.find(extension) == whitelist.end())
{
spdlog::error("A mod failed to save a file via Safe I/O due to the following error:");
spdlog::error("Disallowed file extension: {}", extension);
return;
}

try
{
mutex.get().lock();
Expand Down

0 comments on commit 82729f0

Please sign in to comment.