Skip to content

MAD: Allow for versioning MWS mods #889

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
Alystrasz merged 5 commits into from
Jan 4, 2026
Merged

MAD: Allow for versioning MWS mods #889

Changes from all commits
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
d889d87
extract extractFile into a lambda
ASpoonPlaysGames Jan 3, 2026
daeb137
use wider int type to avoid potential overflow
ASpoonPlaysGames Jan 3, 2026
034b4a7
make MWS downloads more robust
ASpoonPlaysGames Jan 3, 2026
2ecff97
more aggressively move back to the first file
ASpoonPlaysGames Jan 3, 2026
663398a
formatting
ASpoonPlaysGames Jan 4, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
265 changes: 158 additions & 107 deletions primedev/mods/autodownload/moddownloader.cpp
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -451,140 +451,190 @@ void ModDownloader::ExtractMod(fs::path modPath, fs::path destinationPath, Verif
modState.total = GetModArchiveSize(file, gi);
modState.progress = 0;

// We don't know how to extract mods from unknown platforms
if (platform == VerifiedModPlatform::Unknown)
// extracts the file in the archive at zipFilename to fileDestination on disk
auto extractFile = [&](fs::path fileDestination, char* zipFilename) -> bool
{
spdlog::error("Failed extracting mod from unknown platform.");
modState.state = UNKNOWN_PLATFORM;
return;
}
std::error_code ec;
spdlog::info("=> {}", fileDestination.generic_string());

for (int i = 0; i < gi.number_entry; i++)
{
char zipFilename[256];
unz_file_info64 fileInfo;
status = unzGetCurrentFileInfo64(file, &fileInfo, zipFilename, sizeof(zipFilename), NULL, 0, NULL, 0);

// Extract file
// Create parent directory if needed
if (!std::filesystem::exists(fileDestination.parent_path()))
{
std::error_code ec;
fs::path fileDestination = destinationPath / zipFilename;
spdlog::info("=> {}", fileDestination.generic_string());

// Create parent directory if needed
if (!std::filesystem::exists(fileDestination.parent_path()))
spdlog::info("Parent directory does not exist, creating it.", fileDestination.generic_string());
if (!std::filesystem::create_directories(fileDestination.parent_path(), ec) && ec.value() != 0)
{
spdlog::info("Parent directory does not exist, creating it.", fileDestination.generic_string());
if (!std::filesystem::create_directories(fileDestination.parent_path(), ec) && ec.value() != 0)
{
spdlog::error("Parent directory ({}) creation failed.", fileDestination.parent_path().generic_string());
modState.state = FAILED_WRITING_TO_DISK;
return;
}
spdlog::error("Parent directory ({}) creation failed.", fileDestination.parent_path().generic_string());
modState.state = FAILED_WRITING_TO_DISK;
return false;
}
}

// If current file is a directory, create directory...
if (fileDestination.generic_string().back() == '/')
// If current file is a directory, create directory...
if (fileDestination.generic_string().back() == '/')
{
// Create directory
if (!std::filesystem::create_directory(fileDestination, ec) && ec.value() != 0)
{
// Create directory
if (!std::filesystem::create_directory(fileDestination, ec) && ec.value() != 0)
{
spdlog::error("Directory creation failed: {}", ec.message());
modState.state = FAILED_WRITING_TO_DISK;
return;
}
spdlog::error("Directory creation failed: {}", ec.message());
modState.state = FAILED_WRITING_TO_DISK;
return false;
}
// ...else create file
else
}
// ...else create file
else
{
// Ensure file is in zip archive
if (unzLocateFile(file, zipFilename, 0) != UNZ_OK)
{
// Ensure file is in zip archive
if (unzLocateFile(file, zipFilename, 0) != UNZ_OK)
{
spdlog::error("File \"{}\" was not found in archive.", zipFilename);
modState.state = FAILED_READING_ARCHIVE;
return;
}
spdlog::error("File \"{}\" was not found in archive.", zipFilename);
modState.state = FAILED_READING_ARCHIVE;
return false;
}

// Create file
const int bufferSize = 8192;
void* buffer;
int err = UNZ_OK;
FILE* fout = NULL;
// Create file
const int bufferSize = 8192;
void* buffer;
int err = UNZ_OK;
FILE* fout = NULL;

// Open zip file to prepare its extraction
status = unzOpenCurrentFile(file);
if (status != UNZ_OK)
{
spdlog::error("Could not open file {} from archive.", zipFilename);
modState.state = FAILED_READING_ARCHIVE;
return;
}
// Open zip file to prepare its extraction
status = unzOpenCurrentFile(file);
if (status != UNZ_OK)
{
spdlog::error("Could not open file {} from archive.", zipFilename);
modState.state = FAILED_READING_ARCHIVE;
return false;
}

// Create destination file
fout = fopen(fileDestination.generic_string().c_str(), "wb");
if (fout == NULL)
{
spdlog::error("Failed creating destination file.");
modState.state = FAILED_WRITING_TO_DISK;
return;
}
// Create destination file
fout = fopen(fileDestination.generic_string().c_str(), "wb");
if (fout == NULL)
{
spdlog::error("Failed creating destination file.");
modState.state = FAILED_WRITING_TO_DISK;
return false;
}

// Allocate memory for buffer
buffer = (void*)malloc(bufferSize);
if (buffer == NULL)
{
spdlog::error("Error while allocating memory.");
modState.state = FAILED_WRITING_TO_DISK;
return false;
}

// Allocate memory for buffer
buffer = (void*)malloc(bufferSize);
if (buffer == NULL)
// Extract file to destination
do
{
err = unzReadCurrentFile(file, buffer, bufferSize);
if (err < 0)
{
spdlog::error("Error while allocating memory.");
modState.state = FAILED_WRITING_TO_DISK;
return;
spdlog::error("error {} with zipfile in unzReadCurrentFile", err);
break;
}

// Extract file to destination
do
if (err > 0)
{
err = unzReadCurrentFile(file, buffer, bufferSize);
if (err < 0)
if (fwrite(buffer, (unsigned)err, 1, fout) != 1)
{
spdlog::error("error {} with zipfile in unzReadCurrentFile", err);
spdlog::error("error in writing extracted file\n");
err = UNZ_ERRNO;
break;
}
if (err > 0)
{
if (fwrite(buffer, (unsigned)err, 1, fout) != 1)
{
spdlog::error("error in writing extracted file\n");
err = UNZ_ERRNO;
break;
}
}
}

// Update extraction stats
modState.progress += bufferSize;
modState.ratio = roundf(static_cast<float>(modState.progress) / modState.total * 100);
} while (err > 0);

if (err != UNZ_OK)
{
spdlog::error("An error occurred during file extraction (code: {})", err);
modState.state = FAILED_WRITING_TO_DISK;
return false;
}
err = unzCloseCurrentFile(file);
if (err != UNZ_OK)
{
spdlog::error("error {} with zipfile in unzCloseCurrentFile", err);
}

// Cleanup
if (fout)
fclose(fout);
}

return true;
};

// the folder that contains the mod.json. all other files are considered relative to this
fs::path rootDir = "";

// We don't know how to extract mods from unknown platforms
if (platform == VerifiedModPlatform::Unknown)
{
spdlog::error("Failed extracting mod from unknown platform.");
modState.state = UNKNOWN_PLATFORM;
return;
}
else if (platform == VerifiedModPlatform::ModWorkshop)
{
// find the mod.json and store the folder that it's in as the root directory
unzGoToFirstFile(file);
for (uint64_t i = 0; i < gi.number_entry; ++i)
{
char zipFilename[256];
unz_file_info64 fileInfo;
status = unzGetCurrentFileInfo64(file, &fileInfo, zipFilename, sizeof(zipFilename), NULL, 0, NULL, 0);
fs::path filePath = zipFilename;

// Update extraction stats
modState.progress += bufferSize;
modState.ratio = roundf(static_cast<float>(modState.progress) / modState.total * 100);
} while (err > 0);
if (filePath.has_filename() && filePath.filename() == "mod.json")
{
fs::path parentPath = modPath.filename();
if (filePath.has_parent_path())
rootDir = filePath.parent_path() / "";

break;
}

if (err != UNZ_OK)
if ((i + 1) < gi.number_entry)
{
status = unzGoToNextFile(file);
if (status != UNZ_OK)
{
spdlog::error("An error occurred during file extraction (code: {})", err);
modState.state = FAILED_WRITING_TO_DISK;
spdlog::error("Error while browsing archive files (error code: {}).", status);
return;
}
err = unzCloseCurrentFile(file);
if (err != UNZ_OK)
{
spdlog::error("error {} with zipfile in unzCloseCurrentFile", err);
}

// Cleanup
if (fout)
fclose(fout);
}
}
}

// Abort mod extraction if needed
if (modState.state == ABORTED)
unzGoToFirstFile(file);
for (uint64_t i = 0; i < gi.number_entry; i++)
{
char zipFilename[256];
unz_file_info64 fileInfo;
status = unzGetCurrentFileInfo64(file, &fileInfo, zipFilename, sizeof(zipFilename), NULL, 0, NULL, 0);

// Get the destination path, correcting for rootDir
fs::path zipFilePath = zipFilename;
fs::path relativePath = zipFilePath.lexically_relative(rootDir);
// don't try to do anything with our root directory
if (zipFilePath.compare(rootDir))
{
spdlog::info("User cancelled mod installation, aborting mod extraction.");
return;
fs::path fileDestination = destinationPath / relativePath;

// Extract file
if (!extractFile(fileDestination, zipFilename))
return;

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

// Go to next file
Expand Down Expand Up @@ -681,7 +731,8 @@ void ModDownloader::DownloadMod(std::string modName, std::string modVersion)
/// Don't use archive name as destination with ModWorkshop
if (fullVersion.platform == VerifiedModPlatform::ModWorkshop)
{
modDirectory = GetRemoteModFolderPath();
name = archiveLocation.stem().string();
modDirectory = GetRemoteModFolderPath() / std::format("{}-{}", name, modVersion);
}
else
/// Removes the ".zip" fom the archive name and use it as parent directory
Expand Down