Coverage Report

Created: 2026-07-25 07:46

next uncovered line (L), next uncovered region (R), next uncovered branch (B)
/src/serenity/Userland/Libraries/LibCompress/Gzip.h
Line
Count
Source
1
/*
2
 * Copyright (c) 2020-2022, the SerenityOS developers.
3
 * Copyright (c) 2021, Idan Horowitz <idan.horowitz@serenityos.org>
4
 *
5
 * SPDX-License-Identifier: BSD-2-Clause
6
 */
7
8
#pragma once
9
10
#include <AK/NonnullOwnPtr.h>
11
#include <AK/OwnPtr.h>
12
#include <AK/Stream.h>
13
#include <LibCompress/Deflate.h>
14
#include <LibCrypto/Checksum/CRC32.h>
15
16
namespace Compress {
17
18
constexpr u8 gzip_magic_1 = 0x1f;
19
constexpr u8 gzip_magic_2 = 0x8b;
20
struct [[gnu::packed]] BlockHeader {
21
    u8 identification_1;
22
    u8 identification_2;
23
    u8 compression_method;
24
    u8 flags;
25
    LittleEndian<u32> modification_time;
26
    u8 extra_flags;
27
    u8 operating_system;
28
29
    bool valid_magic_number() const;
30
    bool supported_by_implementation() const;
31
};
32
33
struct Flags {
34
    static constexpr u8 FTEXT = 1 << 0;
35
    static constexpr u8 FHCRC = 1 << 1;
36
    static constexpr u8 FEXTRA = 1 << 2;
37
    static constexpr u8 FNAME = 1 << 3;
38
    static constexpr u8 FCOMMENT = 1 << 4;
39
40
    static constexpr u8 MAX = FTEXT | FHCRC | FEXTRA | FNAME | FCOMMENT;
41
};
42
43
class GzipDecompressor final : public Stream {
44
public:
45
    GzipDecompressor(MaybeOwned<Stream>);
46
    ~GzipDecompressor();
47
48
    virtual ErrorOr<Bytes> read_some(Bytes) override;
49
    virtual ErrorOr<size_t> write_some(ReadonlyBytes) override;
50
    virtual bool is_eof() const override;
51
0
    virtual bool is_open() const override { return true; }
52
0
    virtual void close() override { }
53
54
    static ErrorOr<ByteBuffer> decompress_all(ReadonlyBytes);
55
56
    static ErrorOr<Optional<String>> describe_header(ReadonlyBytes);
57
    static bool is_likely_compressed(ReadonlyBytes bytes);
58
59
private:
60
    class Member {
61
    public:
62
        static ErrorOr<NonnullOwnPtr<Member>> construct(BlockHeader header, LittleEndianInputBitStream&);
63
64
        BlockHeader m_header;
65
        NonnullOwnPtr<DeflateDecompressor> m_stream;
66
        Crypto::Checksum::CRC32 m_checksum;
67
        size_t m_nread { 0 };
68
69
    private:
70
        Member(BlockHeader, NonnullOwnPtr<DeflateDecompressor>);
71
    };
72
73
0
    Member const& current_member() const { return *m_current_member; }
74
221k
    Member& current_member() { return *m_current_member; }
75
76
    NonnullOwnPtr<LittleEndianInputBitStream> m_input_stream;
77
    u8 m_partial_header[sizeof(BlockHeader)];
78
    size_t m_partial_header_offset { 0 };
79
    OwnPtr<Member> m_current_member {};
80
81
    bool m_eof { false };
82
};
83
84
class GzipCompressor final : public Stream {
85
public:
86
    GzipCompressor(MaybeOwned<Stream>);
87
88
    virtual ErrorOr<Bytes> read_some(Bytes) override;
89
    virtual ErrorOr<size_t> write_some(ReadonlyBytes) override;
90
    virtual bool is_eof() const override;
91
    virtual bool is_open() const override;
92
    virtual void close() override;
93
94
    static ErrorOr<ByteBuffer> compress_all(ReadonlyBytes bytes);
95
96
private:
97
    MaybeOwned<Stream> m_output_stream;
98
};
99
100
}