1/****************************************************************************
2**
3** Copyright (C) 2020 The Qt Company Ltd.
4** Contact: https://www.qt.io/licensing/
5**
6** This file is part of the QtNetwork module of the Qt Toolkit.
7**
8** $QT_BEGIN_LICENSE:LGPL$
9** Commercial License Usage
10** Licensees holding valid commercial Qt licenses may use this file in
11** accordance with the commercial license agreement provided with the
12** Software or, alternatively, in accordance with the terms contained in
13** a written agreement between you and The Qt Company. For licensing terms
14** and conditions see https://www.qt.io/terms-conditions. For further
15** information use the contact form at https://www.qt.io/contact-us.
16**
17** GNU Lesser General Public License Usage
18** Alternatively, this file may be used under the terms of the GNU Lesser
19** General Public License version 3 as published by the Free Software
20** Foundation and appearing in the file LICENSE.LGPL3 included in the
21** packaging of this file. Please review the following information to
22** ensure the GNU Lesser General Public License version 3 requirements
23** will be met: https://www.gnu.org/licenses/lgpl-3.0.html.
24**
25** GNU General Public License Usage
26** Alternatively, this file may be used under the terms of the GNU
27** General Public License version 2.0 or (at your option) the GNU General
28** Public license version 3 or any later version approved by the KDE Free
29** Qt Foundation. The licenses are as published by the Free Software
30** Foundation and appearing in the file LICENSE.GPL2 and LICENSE.GPL3
31** included in the packaging of this file. Please review the following
32** information to ensure the GNU General Public License requirements will
33** be met: https://www.gnu.org/licenses/gpl-2.0.html and
34** https://www.gnu.org/licenses/gpl-3.0.html.
35**
36** $QT_END_LICENSE$
37**
38****************************************************************************/
39
40#ifndef DECOMPRESS_HELPER_P_H
41#define DECOMPRESS_HELPER_P_H
42
43//
44// W A R N I N G
45// -------------
46//
47// This file is not part of the Qt API. It exists for the convenience
48// of the Network Access API. This header file may change from
49// version to version without notice, or even be removed.
50//
51// We mean it.
52//
53
54#include <QtNetwork/private/qtnetworkglobal_p.h>
55#include <QtCore/private/qbytedata_p.h>
56
57#include <memory>
58
59QT_BEGIN_NAMESPACE
60
61class QIODevice;
62class Q_AUTOTEST_EXPORT QDecompressHelper
63{
64public:
65 enum ContentEncoding {
66 None,
67 Deflate,
68 GZip,
69 Brotli,
70 Zstandard,
71 };
72
73 QDecompressHelper() = default;
74 ~QDecompressHelper();
75
76 bool setEncoding(const QByteArray &contentEncoding);
77
78 bool isCountingBytes() const;
79 void setCountingBytesEnabled(bool shouldCount);
80
81 qint64 uncompressedSize() const;
82
83 bool hasData() const;
84 void feed(const QByteArray &data);
85 void feed(QByteArray &&data);
86 void feed(const QByteDataBuffer &buffer);
87 void feed(QByteDataBuffer &&buffer);
88 qsizetype read(char *data, qsizetype maxSize);
89
90 bool isValid() const;
91
92 void clear();
93
94 void setArchiveBombDetectionEnabled(bool enable);
95
96 static bool isSupportedEncoding(const QByteArray &encoding);
97 static QByteArrayList acceptedEncoding();
98
99private:
100 bool isPotentialArchiveBomb() const;
101
102 bool countInternal();
103 bool countInternal(const QByteArray &data);
104 bool countInternal(const QByteDataBuffer &buffer);
105
106 bool setEncoding(ContentEncoding ce);
107 qint64 encodedBytesAvailable() const;
108
109 qsizetype readZLib(char *data, qsizetype maxSize);
110 qsizetype readBrotli(char *data, qsizetype maxSize);
111 qsizetype readZstandard(char *data, qsizetype maxSize);
112
113 QByteDataBuffer compressedDataBuffer;
114 bool decoderHasData = false;
115
116 bool countDecompressed = false;
117 std::unique_ptr<QDecompressHelper> countHelper;
118 qint64 uncompressedBytes = 0;
119
120 // Used for calculating the ratio
121 bool archiveBombDetectionEnabled = true;
122 qint64 totalUncompressedBytes = 0;
123 qint64 totalCompressedBytes = 0;
124
125 ContentEncoding contentEncoding = None;
126
127 void *decoderPointer = nullptr;
128#if QT_CONFIG(brotli)
129 const uint8_t *brotliUnconsumedDataPtr = nullptr;
130 size_t brotliUnconsumedAmount = 0;
131#endif
132};
133
134QT_END_NAMESPACE
135
136#endif // DECOMPRESS_HELPER_P_H
137