serenity/Userland/Libraries/LibArchive/Zip.cpp

/*
 * Copyright (c) 2021, Idan Horowitz <idan.horowitz@serenityos.org>
 * Copyright (c) 2022, the SerenityOS developers.
 *
 * SPDX-License-Identifier: BSD-2-Clause
 */

#include <LibArchive/Zip.h>
#include <LibCompress/Deflate.h>
#include <LibCrypto/Checksum/CRC32.h>

namespace Archive {

bool Zip::find_end_of_central_directory_offset(ReadonlyBytes buffer, size_t& offset)
{
    for (size_t backwards_offset = 0; backwards_offset <= UINT16_MAX; backwards_offset++) // the file may have a trailing comment of an arbitrary 16 bit length
    {
        if (buffer.size() < (sizeof(EndOfCentralDirectory) - sizeof(u8*)) + backwards_offset)
            return false;

        auto const signature_offset = (buffer.size() - (sizeof(EndOfCentralDirectory) - sizeof(u8*)) - backwards_offset);
        if (auto signature = ReadonlyBytes { buffer.data() + signature_offset, EndOfCentralDirectory::signature.size() };
            signature == EndOfCentralDirectory::signature) {
            offset = signature_offset;
            return true;
        }
    }
    return false;
}

Optional<Zip> Zip::try_create(ReadonlyBytes buffer)
{
    size_t end_of_central_directory_offset;
    if (!find_end_of_central_directory_offset(buffer, end_of_central_directory_offset))
        return {};

    EndOfCentralDirectory end_of_central_directory {};
    if (!end_of_central_directory.read(buffer.slice(end_of_central_directory_offset)))
        return {};

    if (end_of_central_directory.disk_number != 0 || end_of_central_directory.central_directory_start_disk != 0 || end_of_central_directory.disk_records_count != end_of_central_directory.total_records_count)
        return {}; // TODO: support multi-volume zip archives

    size_t member_offset = end_of_central_directory.central_directory_offset;
    for (size_t i = 0; i < end_of_central_directory.total_records_count; i++) {
        CentralDirectoryRecord central_directory_record {};
        if (member_offset > buffer.size())
            return {};
        if (!central_directory_record.read(buffer.slice(member_offset)))
            return {};
        if (central_directory_record.general_purpose_flags.encrypted)
            return {}; // TODO: support encrypted zip members
        if (central_directory_record.general_purpose_flags.data_descriptor)
            return {}; // TODO: support zip data descriptors
        if (central_directory_record.compression_method != ZipCompressionMethod::Store && central_directory_record.compression_method != ZipCompressionMethod::Deflate)
            return {}; // TODO: support obsolete zip compression methods
        if (central_directory_record.compression_method == ZipCompressionMethod::Store && central_directory_record.uncompressed_size != central_directory_record.compressed_size)
            return {};
        if (central_directory_record.start_disk != 0)
            return {}; // TODO: support multi-volume zip archives
        if (memchr(central_directory_record.name, 0, central_directory_record.name_length) != nullptr)
            return {};
        LocalFileHeader local_file_header {};
        if (central_directory_record.local_file_header_offset > buffer.size())
            return {};
        if (!local_file_header.read(buffer.slice(central_directory_record.local_file_header_offset)))
            return {};
        if (buffer.size() - (local_file_header.compressed_data - buffer.data()) < central_directory_record.compressed_size)
            return {};
        member_offset += central_directory_record.size();
    }

    return Zip {
        end_of_central_directory.total_records_count,
        end_of_central_directory.central_directory_offset,
        buffer,
    };
}

ErrorOr<bool> Zip::for_each_member(Function<ErrorOr<IterationDecision>(ZipMember const&)> callback) const
{
    size_t member_offset = m_members_start_offset;
    for (size_t i = 0; i < m_member_count; i++) {
        CentralDirectoryRecord central_directory_record {};
        VERIFY(central_directory_record.read(m_input_data.slice(member_offset)));
        LocalFileHeader local_file_header {};
        VERIFY(local_file_header.read(m_input_data.slice(central_directory_record.local_file_header_offset)));

        ZipMember member;
        member.name = TRY(String::from_utf8({ central_directory_record.name, central_directory_record.name_length }));
        member.compressed_data = { local_file_header.compressed_data, central_directory_record.compressed_size };
        member.compression_method = central_directory_record.compression_method;
        member.uncompressed_size = central_directory_record.uncompressed_size;
        member.crc32 = central_directory_record.crc32;
        member.modification_time = central_directory_record.modification_time;
        member.modification_date = central_directory_record.modification_date;
        member.is_directory = central_directory_record.external_attributes & zip_directory_external_attribute || member.name.bytes_as_string_view().ends_with('/'); // FIXME: better directory detection

        if (TRY(callback(member)) == IterationDecision::Break)
            return false;

        member_offset += central_directory_record.size();
    }
    return true;
}

ErrorOr<Statistics> Zip::calculate_statistics() const
{
    size_t file_count = 0;
    size_t directory_count = 0;
    size_t uncompressed_bytes = 0;

    TRY(for_each_member([&](auto zip_member) -> ErrorOr<IterationDecision> {
        if (zip_member.is_directory)
            directory_count++;
        else
            file_count++;
        uncompressed_bytes += zip_member.uncompressed_size;
        return IterationDecision::Continue;
    }));

    return Statistics(file_count, directory_count, uncompressed_bytes);
}

ZipOutputStream::ZipOutputStream(NonnullOwnPtr<Stream> stream)
    : m_stream(move(stream))
{
}

static u16 minimum_version_needed(ZipCompressionMethod method)
{
    // Deflate was added in PKZip 2.0
    return method == ZipCompressionMethod::Deflate ? 20 : 10;
}

ErrorOr<void> ZipOutputStream::add_member(ZipMember const& member)
{
    VERIFY(!m_finished);
    VERIFY(member.name.bytes_as_string_view().length() <= UINT16_MAX);
    VERIFY(member.compressed_data.size() <= UINT32_MAX);
    TRY(m_members.try_append(member));

    LocalFileHeader local_file_header {
        .minimum_version = minimum_version_needed(member.compression_method),
        .general_purpose_flags = { .flags = 0 },
        .compression_method = static_cast<u16>(member.compression_method),
        .modification_time = member.modification_time,
        .modification_date = member.modification_date,
        .crc32 = member.crc32,
        .compressed_size = static_cast<u32>(member.compressed_data.size()),
        .uncompressed_size = member.uncompressed_size,
        .name_length = static_cast<u16>(member.name.bytes_as_string_view().length()),
        .extra_data_length = 0,
        .name = reinterpret_cast<u8 const*>(member.name.bytes_as_string_view().characters_without_null_termination()),
        .extra_data = nullptr,
        .compressed_data = member.compressed_data.data(),
    };
    return local_file_header.write(*m_stream);
}

ErrorOr<ZipOutputStream::MemberInformation> ZipOutputStream::add_member_from_stream(StringView path, Stream& stream, Optional<Core::DateTime> const& modification_time)
{
    auto buffer = TRY(stream.read_until_eof());

    Archive::ZipMember member {};
    member.name = TRY(String::from_utf8(path));

    if (modification_time.has_value()) {
        member.modification_date = to_packed_dos_date(modification_time->year(), modification_time->month(), modification_time->day());
        member.modification_time = to_packed_dos_time(modification_time->hour(), modification_time->minute(), modification_time->second());
    }

    auto deflate_buffer = Compress::DeflateCompressor::compress_all(buffer);
    auto compression_ratio = 1.f;
    auto compressed_size = buffer.size();

    if (!deflate_buffer.is_error() && deflate_buffer.value().size() < buffer.size()) {
        member.compressed_data = deflate_buffer.value().bytes();
        member.compression_method = Archive::ZipCompressionMethod::Deflate;

        compression_ratio = static_cast<float>(deflate_buffer.value().size()) / static_cast<float>(buffer.size());
        compressed_size = member.compressed_data.size();
    } else {
        member.compressed_data = buffer.bytes();
        member.compression_method = Archive::ZipCompressionMethod::Store;
    }

    member.uncompressed_size = buffer.size();

    Crypto::Checksum::CRC32 checksum { buffer.bytes() };
    member.crc32 = checksum.digest();
    member.is_directory = false;

    TRY(add_member(member));

    return MemberInformation { compression_ratio, compressed_size };
}

ErrorOr<void> ZipOutputStream::add_directory(StringView name, Optional<Core::DateTime> const& modification_time)
{
    Archive::ZipMember member {};
    member.name = TRY(String::from_utf8(name));
    member.compressed_data = {};
    member.compression_method = Archive::ZipCompressionMethod::Store;
    member.uncompressed_size = 0;
    member.crc32 = 0;
    member.is_directory = true;

    if (modification_time.has_value()) {
        member.modification_date = to_packed_dos_date(modification_time->year(), modification_time->month(), modification_time->day());
        member.modification_time = to_packed_dos_time(modification_time->hour(), modification_time->minute(), modification_time->second());
    }

    return add_member(member);
}

ErrorOr<void> ZipOutputStream::finish()
{
    VERIFY(!m_finished);
    m_finished = true;

    auto file_header_offset = 0u;
    auto central_directory_size = 0u;
    for (ZipMember const& member : m_members) {
        auto zip_version = minimum_version_needed(member.compression_method);
        CentralDirectoryRecord central_directory_record {
            .made_by_version = zip_version,
            .minimum_version = zip_version,
            .general_purpose_flags = { .flags = 0 },
            .compression_method = member.compression_method,
            .modification_time = member.modification_time,
            .modification_date = member.modification_date,
            .crc32 = member.crc32,
            .compressed_size = static_cast<u32>(member.compressed_data.size()),
            .uncompressed_size = member.uncompressed_size,
            .name_length = static_cast<u16>(member.name.bytes_as_string_view().length()),
            .extra_data_length = 0,
            .comment_length = 0,
            .start_disk = 0,
            .internal_attributes = 0,
            .external_attributes = member.is_directory ? zip_directory_external_attribute : 0,
            .local_file_header_offset = file_header_offset, // FIXME: we assume the wrapped output stream was never written to before us
            .name = reinterpret_cast<u8 const*>(member.name.bytes_as_string_view().characters_without_null_termination()),
            .extra_data = nullptr,
            .comment = nullptr,
        };
        file_header_offset += sizeof(LocalFileHeader::signature) + (sizeof(LocalFileHeader) - (sizeof(u8*) * 3)) + member.name.bytes_as_string_view().length() + member.compressed_data.size();
        TRY(central_directory_record.write(*m_stream));
        central_directory_size += central_directory_record.size();
    }

    EndOfCentralDirectory end_of_central_directory {
        .disk_number = 0,
        .central_directory_start_disk = 0,
        .disk_records_count = static_cast<u16>(m_members.size()),
        .total_records_count = static_cast<u16>(m_members.size()),
        .central_directory_size = central_directory_size,
        .central_directory_offset = file_header_offset,
        .comment_length = 0,
        .comment = nullptr,
    };
    return end_of_central_directory.write(*m_stream);
}

}