ZIP.cpp

Go to the documentation of this file.

#include <vpkpp/format/ZIP.h>
 
#include <cstring>
#include <ctime>
#include <filesystem>
 
#include <mz.h>
#include <mz_os.h>
#include <mz_strm.h>
#include <mz_strm_os.h>
#include <mz_zip.h>
#include <mz_zip_rw.h>
 
#include <FileStream.h>
#include <sourcepp/crypto/CRC32.h>
#include <sourcepp/String.h>
 
using namespace sourcepp;
using namespace vpkpp;
 
ZIP::ZIP(const std::string& fullFilePath_)
        : PackFile(fullFilePath_)
        , tempZIPPath((std::filesystem::temp_directory_path() / (string::generateUUIDv4() + ".zip")).string()) {}
 
ZIP::~ZIP() {
    this->closeZIP();
}
 
std::unique_ptr<PackFile> ZIP::create(const std::string& path) {
    {
        FileStream stream{path, FileStream::OPT_TRUNCATE | FileStream::OPT_CREATE_IF_NONEXISTENT};
 
        // I just created an empty zip with Windows and pasted the result because minizip-ng wasn't behaving
        stream
            .write('P')
            .write('K')
            .write<uint8_t>(5)
            .write<uint8_t>(6)
            .write(std::array<uint16_t, 4>{})
            .write(std::array<uint32_t, 2>{})
            .write<uint16_t>(0);
    }
    return ZIP::open(path);
}
 
std::unique_ptr<PackFile> ZIP::open(const std::string& path, const EntryCallback& callback) {
    if (!std::filesystem::exists(path)) {
        // File does not exist
        return nullptr;
    }
 
    auto* zip = new ZIP{path};
    auto packFile = std::unique_ptr<PackFile>(zip);
 
    if (!zip->openZIP(zip->fullFilePath)) {
        return nullptr;
    }
 
    for (auto code = mz_zip_goto_first_entry(zip->zipHandle); code == MZ_OK; code = mz_zip_goto_next_entry(zip->zipHandle)) {
        if (mz_zip_entry_is_dir(zip->zipHandle) == MZ_OK) {
            continue;
        }
 
        mz_zip_file* fileInfo = nullptr;
        if (mz_zip_entry_get_info(zip->zipHandle, &fileInfo)) {
            return nullptr;
        }
 
        auto entryPath = zip->cleanEntryPath(fileInfo->filename);
 
        Entry entry = createNewEntry();
        entry.flags = fileInfo->compression_method << 16;
        entry.length = fileInfo->uncompressed_size;
        entry.compressedLength = fileInfo->compressed_size;
        entry.crc32 = fileInfo->crc;
 
        zip->entries.insert(entryPath, entry);
 
        if (callback) {
            callback(entryPath, entry);
        }
    }
 
    return packFile;
}
 
std::vector<std::string> ZIP::verifyEntryChecksums() const {
    return this->verifyEntryChecksumsUsingCRC32();
}
 
std::optional<std::vector<std::byte>> ZIP::readEntry(const std::string& path_) const {
    const auto path = this->cleanEntryPath(path_);
    const auto entry = this->findEntry(path);
    if (!entry) {
        return std::nullopt;
    }
    if (entry->unbaked) {
        return readUnbakedEntry(*entry);
    }
 
    // It's baked into the file on disk
    if (!this->streamOpen || !this->zipOpen) {
        return std::nullopt;
    }
    if (mz_zip_locate_entry(this->zipHandle, path.c_str(), !this->isCaseSensitive()) != MZ_OK) {
        return std::nullopt;
    }
    if (mz_zip_entry_read_open(this->zipHandle, 0, nullptr) != MZ_OK) {
        return std::nullopt;
    }
    std::vector<std::byte> out;
    out.resize(entry->length);
    mz_zip_entry_read(this->zipHandle, out.data(), static_cast<int>(entry->length));
    mz_zip_entry_close(this->zipHandle);
    return out;
}
 
bool ZIP::isReadOnly() const noexcept {
    uint8_t xzpVersion = 0;
    mz_zip_get_valve_xzp_version(this->zipHandle, &xzpVersion);
    return xzpVersion == 2 || xzpVersion == 3;
}
 
void ZIP::addEntryInternal(Entry& entry, const std::string& path, std::vector<std::byte>& buffer, EntryOptions options) {
    entry.flags = (static_cast<uint32_t>(options.zip_compressionType == EntryCompressionType::NO_OVERRIDE ? EntryCompressionType::NO_COMPRESS : options.zip_compressionType) << 16) | options.zip_compressionStrength;
    entry.length = buffer.size();
    entry.compressedLength = 0;
    entry.crc32 = crypto::computeCRC32(buffer);
}
 
bool ZIP::bake(const std::string& outputDir_, BakeOptions options, const EntryCallback& callback) {
    // Get the proper file output folder
    const std::string outputDir = this->getBakeOutputDir(outputDir_);
    const std::string outputPath = outputDir + '/' + this->getFilename();
 
    // Use temp folder so we can read from the current ZIP
    if (!this->bakeTempZip(this->tempZIPPath, options, callback)) {
        return false;
    }
    this->mergeUnbakedEntries();
 
    // Close our ZIP and reopen it
    this->closeZIP();
    std::filesystem::rename(this->tempZIPPath, outputPath);
    if (!this->openZIP(outputPath)) {
        return false;
    }
    PackFile::setFullFilePath(outputDir);
    return true;
}
 
Attribute ZIP::getSupportedEntryAttributes() const {
    using enum Attribute;
    return LENGTH | CRC32;
}
 
EntryCompressionType ZIP::getEntryCompressionType(const std::string& path_) const {
    const auto path = this->cleanEntryPath(path_);
    if (this->entries.count(path)) {
        return static_cast<EntryCompressionType>(this->entries.at(path).flags >> 16);
    }
    return EntryCompressionType::NO_COMPRESS;
}
 
void ZIP::setEntryCompressionType(const std::string& path_, EntryCompressionType type) {
    const auto path = this->cleanEntryPath(path_);
    if (this->entries.count(path)) {
        this->entries.at(path).flags = (static_cast<uint32_t>(type) << 16) | (this->entries.at(path).flags & 0xffff);
    }
}
 
int16_t ZIP::getEntryCompressionStrength(const std::string& path_) const {
    const auto path = this->cleanEntryPath(path_);
    if (this->entries.count(path)) {
        return static_cast<int16_t>(this->entries.at(path).flags & 0xffff);
    }
    return 0;
}
 
void ZIP::setEntryCompressionStrength(const std::string& path_, int16_t strength) {
    const auto path = this->cleanEntryPath(path_);
    if (this->entries.count(path)) {
        this->entries.at(path).flags = (this->entries.at(path).flags & 0xffff0000) | strength;
    }
}
 
bool ZIP::bakeTempZip(const std::string& writeZipPath, BakeOptions options, const EntryCallback& callback) const {
    void* writeStreamHandle = mz_stream_os_create();
    if (mz_stream_open(writeStreamHandle, writeZipPath.c_str(), MZ_OPEN_MODE_CREATE | MZ_OPEN_MODE_WRITE)) {
        return false;
    }
 
    void* writeZipHandle = mz_zip_writer_create();
    if (mz_zip_writer_open(writeZipHandle, writeStreamHandle, 0)) {
        return false;
    }
 
    mz_zip_set_version_madeby(writeZipHandle, MZ_VERSION_MADEBY);
 
    const auto modifiedTime = std::time(nullptr);
    const auto modifiedTimeDOS = mz_zip_time_t_to_dos_date(modifiedTime);
 
    const bool overrideCompression = options.zip_compressionTypeOverride != EntryCompressionType::NO_OVERRIDE;
 
    bool noneFailed = true;
    this->runForAllEntries([this, &options, &callback, writeZipHandle, modifiedTime, modifiedTimeDOS, overrideCompression, &noneFailed](const std::string& path, const Entry& entry) {
        const auto binData = this->readEntry(path);
        if (!binData) {
            return;
        }
 
        if (overrideCompression) {
            mz_zip_writer_set_compress_method(writeZipHandle, static_cast<uint16_t>(options.zip_compressionTypeOverride));
            mz_zip_writer_set_compress_level(writeZipHandle, options.zip_compressionStrength);
        } else {
            mz_zip_writer_set_compress_method(writeZipHandle, entry.flags >> 16);
            mz_zip_writer_set_compress_level(writeZipHandle, (entry.flags & 0xffff) > 0 ? static_cast<int16_t>(entry.flags & 0xffff) : options.zip_compressionStrength);
        }
 
        mz_zip_entry fileInfo{};
        fileInfo.filename = path.c_str();
        fileInfo.filename_size = path.length();
        fileInfo.version_madeby = MZ_VERSION_MADEBY;
        fileInfo.creation_date = modifiedTime;
        fileInfo.modified_date = modifiedTimeDOS;
        fileInfo.compression_method = overrideCompression ? static_cast<uint16_t>(options.zip_compressionTypeOverride) : entry.flags >> 16;
        fileInfo.flag = MZ_ZIP_FLAG_DATA_DESCRIPTOR | MZ_ZIP_FLAG_UTF8;
        fileInfo.uncompressed_size = static_cast<int64_t>(entry.length);
        fileInfo.compressed_size = static_cast<int64_t>(entry.compressedLength);
        fileInfo.crc = entry.crc32;
        if (mz_zip_writer_add_buffer(writeZipHandle, binData->data(), static_cast<int>(binData->size()), &fileInfo)) {
            noneFailed = false;
            return;
        }
 
        if (callback) {
            callback(path, entry);
        }
    });
 
    if (mz_zip_writer_close(writeZipHandle)) {
        return false;
    }
    mz_zip_writer_delete(&writeZipHandle);
 
    if (mz_stream_close(writeStreamHandle)) {
        return false;
    }
    mz_stream_delete(&writeStreamHandle);
 
    return noneFailed;
}
 
bool ZIP::openZIP(std::string_view path) {
    this->streamHandle = mz_stream_os_create();
    if (mz_stream_open(this->streamHandle, path.data(), MZ_OPEN_MODE_READ) != MZ_OK) {
        mz_stream_delete(&this->streamHandle);
        return false;
    }
    this->streamOpen = true;
 
    this->zipHandle = mz_zip_create();
    if (mz_zip_open(this->zipHandle, this->streamHandle, MZ_OPEN_MODE_READ) != MZ_OK) {
        mz_zip_delete(&this->zipHandle);
        return false; // No need to delete the stream, it's done when we destruct
    }
    this->zipOpen = true;
 
    return true;
}
 
void ZIP::closeZIP() {
    if (this->zipOpen) {
        mz_zip_close(this->zipHandle);
        mz_zip_delete(&this->zipHandle);
        this->zipOpen = false;
    }
    if (this->streamOpen) {
        mz_stream_close(this->streamHandle);
        mz_stream_delete(&this->streamHandle);
        this->streamOpen = false;
    }
}