axmol/core/base/ZipUtils.cpp

937 lines
26 KiB
C++
Raw Normal View History

2019-11-23 20:27:39 +08:00
/****************************************************************************
Copyright (c) 2010-2012 cocos2d-x.org
Copyright (c) 2013-2016 Chukong Technologies Inc.
Copyright (c) 2017-2018 Xiamen Yaji Software Co., Ltd.
Copyright (c) 2019-present Axmol Engine contributors (see AUTHORS.md).
2019-11-23 20:27:39 +08:00
2022-10-01 16:24:52 +08:00
https://axmolengine.github.io/
2021-12-25 10:04:45 +08:00
2019-11-23 20:27:39 +08:00
Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:
2021-12-25 10:04:45 +08:00
2019-11-23 20:27:39 +08:00
The above copyright notice and this permission notice shall be included in
all copies or substantial portions of the Software.
2021-12-25 10:04:45 +08:00
2019-11-23 20:27:39 +08:00
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
THE SOFTWARE.
****************************************************************************/
#include "base/ZipUtils.h"
#ifdef MINIZIP_FROM_SYSTEM
2021-12-25 10:04:45 +08:00
# include <minizip/unzip.h>
#else // from our embedded sources
# include "unzip.h"
2019-11-23 20:27:39 +08:00
#endif
#include <ioapi.h>
2019-11-23 20:27:39 +08:00
#include <memory>
#include <zlib.h>
#include <assert.h>
#include <stdlib.h>
#include <set>
#include "base/Data.h"
#include "base/Macros.h"
#include "platform/FileUtils.h"
2019-11-23 20:27:39 +08:00
#include <map>
2019-12-01 01:16:46 +08:00
#include <mutex>
2019-11-23 20:27:39 +08:00
2023-06-24 21:18:27 +08:00
#include "yasio/string_view.hpp"
2021-07-15 23:03:43 +08:00
2019-11-23 20:27:39 +08:00
// minizip 1.2.0 is same with other platforms
2021-12-25 10:04:45 +08:00
#define unzGoToFirstFile64(A, B, C, D) unzGoToFirstFile2(A, B, C, D, NULL, 0, NULL, 0)
#define unzGoToNextFile64(A, B, C, D) unzGoToNextFile2(A, B, C, D, NULL, 0, NULL, 0)
2019-11-23 20:27:39 +08:00
NS_AX_BEGIN
2019-11-23 20:27:39 +08:00
2021-12-25 10:04:45 +08:00
unsigned int ZipUtils::s_uEncryptedPvrKeyParts[4] = {0, 0, 0, 0};
2019-11-23 20:27:39 +08:00
unsigned int ZipUtils::s_uEncryptionKey[1024];
bool ZipUtils::s_bEncryptionKeyIsValid = false;
// --------------------- ZipUtils ---------------------
yasio::byte_buffer ZipUtils::compressGZ(const void* in, size_t inlen, int level)
{
int err;
Bytef buffer[512];
z_stream d_stream; /* compression stream */
d_stream.zalloc = nullptr;
d_stream.zfree = nullptr;
d_stream.opaque = (voidpf)0;
d_stream.next_in = (Bytef*)in;
2024-04-06 18:05:42 +08:00
d_stream.avail_in = static_cast<uInt>(inlen);
d_stream.next_out = buffer;
d_stream.avail_out = sizeof(buffer);
yasio::byte_buffer output;
err = deflateInit2(&d_stream, level, Z_DEFLATED, MAX_WBITS + 16 /*well: normaly, gzip is: 16*/, MAX_MEM_LEVEL - 1,
Z_DEFAULT_STRATEGY);
if (err != Z_OK) //
return output;
for (;;)
{
err = deflate(&d_stream, Z_FINISH);
if (err == Z_STREAM_END)
{
output.insert(output.end(), buffer, buffer + sizeof(buffer) - d_stream.avail_out);
break;
}
switch (err)
{
case Z_NEED_DICT:
err = Z_DATA_ERROR;
case Z_DATA_ERROR:
case Z_MEM_ERROR:
goto _L_end;
}
// not enough buffer ?
if (err != Z_STREAM_END)
{
output.insert(output.end(), buffer, buffer + sizeof(buffer));
d_stream.next_out = buffer;
d_stream.avail_out = sizeof(buffer);
}
}
_L_end:
deflateEnd(&d_stream);
if (err != Z_STREAM_END)
{
output.clear();
}
return output;
}
yasio::byte_buffer ZipUtils::decompressGZ(const void* in, size_t inlen, int expected_size)
{ // inflate
int err;
Bytef buffer[512];
z_stream d_stream; /* decompression stream */
d_stream.zalloc = nullptr;
d_stream.zfree = nullptr;
d_stream.opaque = (voidpf)0;
d_stream.next_in = (Bytef*)in;
2024-04-06 18:05:42 +08:00
d_stream.avail_in = static_cast<uInt>(inlen);
d_stream.next_out = buffer;
d_stream.avail_out = sizeof(buffer);
yasio::byte_buffer output;
err = inflateInit2(&d_stream, MAX_WBITS + 32 /*well: normaly, gzip is: 16*/);
if (err != Z_OK) //
return output;
output.reserve(expected_size != -1 ? expected_size : (inlen << 2));
for (;;)
{
err = inflate(&d_stream, Z_NO_FLUSH);
if (err == Z_STREAM_END)
{
output.insert(output.end(), buffer, buffer + sizeof(buffer) - d_stream.avail_out);
break;
}
switch (err)
{
case Z_NEED_DICT:
err = Z_DATA_ERROR;
case Z_DATA_ERROR:
case Z_MEM_ERROR:
goto _L_end;
}
// not enough memory ?
if (err != Z_STREAM_END)
{
// *out = (unsigned char*)realloc(*out, bufferSize * BUFFER_INC_FACTOR);
output.insert(output.end(), buffer, buffer + sizeof(buffer));
d_stream.next_out = buffer;
d_stream.avail_out = sizeof(buffer);
}
}
_L_end:
inflateEnd(&d_stream);
if (err != Z_STREAM_END)
{
2023-09-29 01:57:41 +08:00
switch (err)
{
case Z_MEM_ERROR:
AXLOG("axmol: ZipUtils: Out of memory while decompressing map data!");
break;
case Z_VERSION_ERROR:
AXLOG("axmol: ZipUtils: Incompatible zlib version!");
break;
case Z_DATA_ERROR:
AXLOG("axmol: ZipUtils: Incorrect zlib compressed data!");
break;
default:
AXLOG("axmol: ZipUtils: Unknown error while decompressing map data!");
}
output.clear();
2023-09-29 01:57:41 +08:00
output.shrink_to_fit();
}
return output;
}
2021-12-25 10:04:45 +08:00
inline void ZipUtils::decodeEncodedPvr(unsigned int* data, ssize_t len)
2019-11-23 20:27:39 +08:00
{
2021-12-25 10:04:45 +08:00
const int enclen = 1024;
2019-11-23 20:27:39 +08:00
const int securelen = 512;
2021-12-25 10:04:45 +08:00
const int distance = 64;
2019-11-23 20:27:39 +08:00
// check if key was set
// make sure to call caw_setkey_part() for all 4 key parts
2022-07-16 10:43:05 +08:00
AXASSERT(s_uEncryptedPvrKeyParts[0] != 0,
"axmol:CCZ file is encrypted but key part 0 is not set. Did you call "
2021-12-25 10:04:45 +08:00
"ZipUtils::setPvrEncryptionKeyPart(...)?");
2022-07-16 10:43:05 +08:00
AXASSERT(s_uEncryptedPvrKeyParts[1] != 0,
"axmol:CCZ file is encrypted but key part 1 is not set. Did you call "
2021-12-25 10:04:45 +08:00
"ZipUtils::setPvrEncryptionKeyPart(...)?");
2022-07-16 10:43:05 +08:00
AXASSERT(s_uEncryptedPvrKeyParts[2] != 0,
"axmol:CCZ file is encrypted but key part 2 is not set. Did you call "
2021-12-25 10:04:45 +08:00
"ZipUtils::setPvrEncryptionKeyPart(...)?");
2022-07-16 10:43:05 +08:00
AXASSERT(s_uEncryptedPvrKeyParts[3] != 0,
"axmol:CCZ file is encrypted but key part 3 is not set. Did you call "
2021-12-25 10:04:45 +08:00
"ZipUtils::setPvrEncryptionKeyPart(...)?");
2019-11-23 20:27:39 +08:00
// create long key
2021-12-25 10:04:45 +08:00
if (!s_bEncryptionKeyIsValid)
2019-11-23 20:27:39 +08:00
{
unsigned int y, p, e;
unsigned int rounds = 6;
2021-12-25 10:04:45 +08:00
unsigned int sum = 0;
unsigned int z = s_uEncryptionKey[enclen - 1];
2019-11-23 20:27:39 +08:00
do
{
#define DELTA 0x9e3779b9
2021-12-25 10:04:45 +08:00
#define MX (((z >> 5 ^ y << 2) + (y >> 3 ^ z << 4)) ^ ((sum ^ y) + (s_uEncryptedPvrKeyParts[(p & 3) ^ e] ^ z)))
2019-11-23 20:27:39 +08:00
sum += DELTA;
e = (sum >> 2) & 3;
2021-12-25 10:04:45 +08:00
2019-11-23 20:27:39 +08:00
for (p = 0; p < enclen - 1; p++)
{
y = s_uEncryptionKey[p + 1];
z = s_uEncryptionKey[p] += MX;
}
2021-12-25 10:04:45 +08:00
2019-11-23 20:27:39 +08:00
y = s_uEncryptionKey[0];
z = s_uEncryptionKey[enclen - 1] += MX;
2021-12-25 10:04:45 +08:00
2019-11-23 20:27:39 +08:00
} while (--rounds);
2021-12-25 10:04:45 +08:00
2019-11-23 20:27:39 +08:00
s_bEncryptionKeyIsValid = true;
}
2021-12-25 10:04:45 +08:00
2019-11-23 20:27:39 +08:00
int b = 0;
int i = 0;
2021-12-25 10:04:45 +08:00
2019-11-23 20:27:39 +08:00
// encrypt first part completely
2021-12-25 10:04:45 +08:00
for (; i < len && i < securelen; i++)
2019-11-23 20:27:39 +08:00
{
data[i] ^= s_uEncryptionKey[b++];
2021-12-25 10:04:45 +08:00
if (b >= enclen)
2019-11-23 20:27:39 +08:00
{
b = 0;
}
}
2021-12-25 10:04:45 +08:00
2019-11-23 20:27:39 +08:00
// encrypt second section partially
2021-12-25 10:04:45 +08:00
for (; i < len; i += distance)
2019-11-23 20:27:39 +08:00
{
data[i] ^= s_uEncryptionKey[b++];
2021-12-25 10:04:45 +08:00
if (b >= enclen)
2019-11-23 20:27:39 +08:00
{
b = 0;
}
}
}
2021-12-25 10:04:45 +08:00
inline unsigned int ZipUtils::checksumPvr(const unsigned int* data, ssize_t len)
2019-11-23 20:27:39 +08:00
{
unsigned int cs = 0;
const int cslen = 128;
2021-12-25 10:04:45 +08:00
2019-11-23 20:27:39 +08:00
len = (len < cslen) ? len : cslen;
2021-12-25 10:04:45 +08:00
for (int i = 0; i < len; i++)
2019-11-23 20:27:39 +08:00
{
cs = cs ^ data[i];
}
2021-12-25 10:04:45 +08:00
2019-11-23 20:27:39 +08:00
return cs;
}
2021-12-25 10:04:45 +08:00
ssize_t ZipUtils::inflateMemoryWithHint(unsigned char* in, ssize_t inLength, unsigned char** out, ssize_t outLengthHint)
2019-11-23 20:27:39 +08:00
{
2023-09-29 01:57:41 +08:00
auto outBuffer = decompressGZ(std::span{in, in + inLength}, static_cast<int>(outLengthHint));
auto outLen = outBuffer.size();
if (out)
*out = outBuffer.release_pointer();
return outLen;
2019-11-23 20:27:39 +08:00
}
2021-12-25 10:04:45 +08:00
ssize_t ZipUtils::inflateMemory(unsigned char* in, ssize_t inLength, unsigned char** out)
2019-11-23 20:27:39 +08:00
{
// 256k for hint
return inflateMemoryWithHint(in, inLength, out, 256 * 1024);
}
2021-12-25 10:04:45 +08:00
int ZipUtils::inflateGZipFile(const char* path, unsigned char** out)
2019-11-23 20:27:39 +08:00
{
int len;
unsigned int offset = 0;
2021-12-25 10:04:45 +08:00
2022-07-16 10:43:05 +08:00
AXASSERT(out, "out can't be nullptr.");
AXASSERT(&*out, "&*out can't be nullptr.");
2021-12-25 10:04:45 +08:00
2019-11-24 23:15:56 +08:00
gzFile inFile = gzopen(path, "rb");
2021-12-25 10:04:45 +08:00
if (inFile == nullptr)
{
2022-10-01 16:24:52 +08:00
AXLOG("axmol: ZipUtils: error open gzip file: %s", path);
2019-11-23 20:27:39 +08:00
return -1;
}
2021-12-25 10:04:45 +08:00
2019-11-23 20:27:39 +08:00
/* 512k initial decompress buffer */
yasio::byte_buffer buffer;
buffer.reserve(512);
2021-12-25 10:04:45 +08:00
2023-09-29 01:57:41 +08:00
uint8_t readBuffer[512];
2021-12-25 10:04:45 +08:00
for (;;)
{
2023-09-29 01:57:41 +08:00
len = gzread(inFile, readBuffer, sizeof(readBuffer));
2019-11-23 20:27:39 +08:00
if (len < 0)
{
2022-10-01 16:24:52 +08:00
AXLOG("axmol: ZipUtils: error in gzread");
2019-11-23 20:27:39 +08:00
return -1;
}
if (len == 0)
{
break;
}
2021-12-25 10:04:45 +08:00
2023-09-29 01:57:41 +08:00
buffer.append(readBuffer, readBuffer + 512);
2019-11-23 20:27:39 +08:00
}
2021-12-25 10:04:45 +08:00
2019-11-23 20:27:39 +08:00
if (gzclose(inFile) != Z_OK)
{
2022-10-01 16:24:52 +08:00
AXLOG("axmol: ZipUtils: gzclose failed");
2019-11-23 20:27:39 +08:00
}
2021-12-25 10:04:45 +08:00
2023-09-29 01:57:41 +08:00
auto totalSize = buffer.size();
if (out)
*out = buffer.release_pointer();
2024-04-06 18:05:42 +08:00
return static_cast<int>(totalSize);
2019-11-23 20:27:39 +08:00
}
2021-12-25 10:04:45 +08:00
bool ZipUtils::isCCZFile(const char* path)
2019-11-23 20:27:39 +08:00
{
// load file into memory
Data compressedData = FileUtils::getInstance()->getDataFromFile(path);
if (compressedData.isNull())
{
2022-10-01 16:24:52 +08:00
AXLOG("axmol: ZipUtils: loading file failed");
2019-11-23 20:27:39 +08:00
return false;
}
return isCCZBuffer(compressedData.getBytes(), compressedData.getSize());
}
2021-12-25 10:04:45 +08:00
bool ZipUtils::isCCZBuffer(const unsigned char* buffer, ssize_t len)
2019-11-23 20:27:39 +08:00
{
if (static_cast<size_t>(len) < sizeof(struct CCZHeader))
{
return false;
}
2021-12-25 10:04:45 +08:00
struct CCZHeader* header = (struct CCZHeader*)buffer;
return header->sig[0] == 'C' && header->sig[1] == 'C' && header->sig[2] == 'Z' &&
(header->sig[3] == '!' || header->sig[3] == 'p');
}
2019-11-23 20:27:39 +08:00
2021-12-25 10:04:45 +08:00
bool ZipUtils::isGZipFile(const char* path)
2019-11-23 20:27:39 +08:00
{
// load file into memory
Data compressedData = FileUtils::getInstance()->getDataFromFile(path);
if (compressedData.isNull())
{
2022-10-01 16:24:52 +08:00
AXLOG("axmol: ZipUtils: loading file failed");
2019-11-23 20:27:39 +08:00
return false;
}
return isGZipBuffer(compressedData.getBytes(), compressedData.getSize());
}
2021-12-25 10:04:45 +08:00
bool ZipUtils::isGZipBuffer(const unsigned char* buffer, ssize_t len)
2019-11-23 20:27:39 +08:00
{
if (len < 2)
{
return false;
}
return buffer[0] == 0x1F && buffer[1] == 0x8B;
}
2021-12-25 10:04:45 +08:00
int ZipUtils::inflateCCZBuffer(const unsigned char* buffer, ssize_t bufferLen, unsigned char** out)
2019-11-23 20:27:39 +08:00
{
2021-12-25 10:04:45 +08:00
struct CCZHeader* header = (struct CCZHeader*)buffer;
2019-11-23 20:27:39 +08:00
// verify header
2021-12-25 10:04:45 +08:00
if (header->sig[0] == 'C' && header->sig[1] == 'C' && header->sig[2] == 'Z' && header->sig[3] == '!')
2019-11-23 20:27:39 +08:00
{
// verify header version
2022-07-16 10:43:05 +08:00
unsigned int version = AX_SWAP_INT16_BIG_TO_HOST(header->version);
2021-12-25 10:04:45 +08:00
if (version > 2)
2019-11-23 20:27:39 +08:00
{
2022-10-01 16:24:52 +08:00
AXLOG("axmol: Unsupported CCZ header format");
2019-11-23 20:27:39 +08:00
return -1;
}
// verify compression format
2022-07-16 10:43:05 +08:00
if (AX_SWAP_INT16_BIG_TO_HOST(header->compression_type) != CCZ_COMPRESSION_ZLIB)
2019-11-23 20:27:39 +08:00
{
2022-10-01 16:24:52 +08:00
AXLOG("axmol: CCZ Unsupported compression method");
2019-11-23 20:27:39 +08:00
return -1;
}
}
2021-12-25 10:04:45 +08:00
else if (header->sig[0] == 'C' && header->sig[1] == 'C' && header->sig[2] == 'Z' && header->sig[3] == 'p')
2019-11-23 20:27:39 +08:00
{
// encrypted ccz file
2021-12-25 10:04:45 +08:00
header = (struct CCZHeader*)buffer;
2019-11-23 20:27:39 +08:00
// verify header version
2022-07-16 10:43:05 +08:00
unsigned int version = AX_SWAP_INT16_BIG_TO_HOST(header->version);
2021-12-25 10:04:45 +08:00
if (version > 0)
2019-11-23 20:27:39 +08:00
{
2022-10-01 16:24:52 +08:00
AXLOG("axmol: Unsupported CCZ header format");
2019-11-23 20:27:39 +08:00
return -1;
}
// verify compression format
2022-07-16 10:43:05 +08:00
if (AX_SWAP_INT16_BIG_TO_HOST(header->compression_type) != CCZ_COMPRESSION_ZLIB)
2019-11-23 20:27:39 +08:00
{
2022-10-01 16:24:52 +08:00
AXLOG("axmol: CCZ Unsupported compression method");
2019-11-23 20:27:39 +08:00
return -1;
}
// decrypt
2021-12-25 10:04:45 +08:00
unsigned int* ints = (unsigned int*)(buffer + 12);
ssize_t enclen = (bufferLen - 12) / 4;
2019-11-23 20:27:39 +08:00
decodeEncodedPvr(ints, enclen);
2022-08-08 18:02:17 +08:00
#if _AX_DEBUG > 0
2019-11-23 20:27:39 +08:00
// verify checksum in debug mode
unsigned int calculated = checksumPvr(ints, enclen);
2022-07-16 10:43:05 +08:00
unsigned int required = AX_SWAP_INT32_BIG_TO_HOST(header->reserved);
2019-11-23 20:27:39 +08:00
2021-12-25 10:04:45 +08:00
if (calculated != required)
2019-11-23 20:27:39 +08:00
{
2022-10-01 16:24:52 +08:00
AXLOG("axmol: Can't decrypt image file. Is the decryption key valid?");
2019-11-23 20:27:39 +08:00
return -1;
}
#endif
}
else
{
2022-10-01 16:24:52 +08:00
AXLOG("axmol: Invalid CCZ file");
2019-11-23 20:27:39 +08:00
return -1;
}
2022-07-16 10:43:05 +08:00
unsigned int len = AX_SWAP_INT32_BIG_TO_HOST(header->len);
2023-09-29 01:57:41 +08:00
if (!len)
2019-11-23 20:27:39 +08:00
{
2022-10-01 16:24:52 +08:00
AXLOG("axmol: CCZ: Failed to allocate memory for texture");
2019-11-23 20:27:39 +08:00
return -1;
}
axstd::byte_buffer outBuffer(len);
2023-09-29 01:57:41 +08:00
unsigned long destlen = len;
2021-12-25 10:04:45 +08:00
size_t source = (size_t)buffer + sizeof(*header);
2023-09-29 01:57:41 +08:00
int ret = uncompress(outBuffer.data(), &destlen, (Bytef*)source, static_cast<uLong>(bufferLen - sizeof(*header)));
2019-11-23 20:27:39 +08:00
2021-12-25 10:04:45 +08:00
if (ret != Z_OK)
2019-11-23 20:27:39 +08:00
{
2022-10-01 16:24:52 +08:00
AXLOG("axmol: CCZ: Failed to uncompress data");
2019-11-23 20:27:39 +08:00
return -1;
}
2023-09-29 01:57:41 +08:00
*out = outBuffer.release_pointer();
2019-11-23 20:27:39 +08:00
return len;
}
2021-12-25 10:04:45 +08:00
int ZipUtils::inflateCCZFile(const char* path, unsigned char** out)
2019-11-23 20:27:39 +08:00
{
2022-07-16 10:43:05 +08:00
AXASSERT(out, "Invalid pointer for buffer!");
2021-12-25 10:04:45 +08:00
2019-11-23 20:27:39 +08:00
// load file into memory
Data compressedData = FileUtils::getInstance()->getDataFromFile(path);
2021-12-25 10:04:45 +08:00
2019-11-23 20:27:39 +08:00
if (compressedData.isNull())
{
2022-10-01 16:24:52 +08:00
AXLOG("axmol: Error loading CCZ compressed file");
2019-11-23 20:27:39 +08:00
return -1;
}
2021-12-25 10:04:45 +08:00
2019-11-23 20:27:39 +08:00
return inflateCCZBuffer(compressedData.getBytes(), compressedData.getSize(), out);
}
void ZipUtils::setPvrEncryptionKeyPart(int index, unsigned int value)
{
AXASSERT(index >= 0, "axmol:key part index cannot be less than 0");
AXASSERT(index <= 3, "axmol:key part index cannot be greater than 3");
2021-12-25 10:04:45 +08:00
if (s_uEncryptedPvrKeyParts[index] != value)
2019-11-23 20:27:39 +08:00
{
s_uEncryptedPvrKeyParts[index] = value;
2021-12-25 10:04:45 +08:00
s_bEncryptionKeyIsValid = false;
2019-11-23 20:27:39 +08:00
}
}
2021-12-25 10:04:45 +08:00
void ZipUtils::setPvrEncryptionKey(unsigned int keyPart1,
unsigned int keyPart2,
unsigned int keyPart3,
unsigned int keyPart4)
2019-11-23 20:27:39 +08:00
{
setPvrEncryptionKeyPart(0, keyPart1);
setPvrEncryptionKeyPart(1, keyPart2);
setPvrEncryptionKeyPart(2, keyPart3);
setPvrEncryptionKeyPart(3, keyPart4);
}
// --------------------- ZipFile ---------------------
// from unzip.cpp
#define UNZ_MAXFILENAMEINZIP 256
static const std::string emptyFilename("");
struct ZipEntryInfo
{
unz_file_pos pos;
uint64_t uncompressed_size;
uint64_t offset;
2019-11-23 20:27:39 +08:00
};
struct ZipFilePrivate
2019-11-23 20:27:39 +08:00
{
2021-12-25 10:04:45 +08:00
ZipFilePrivate()
{
functionOverrides.zopen64_file = ZipFile_open_file_func;
functionOverrides.zopendisk64_file = ZipFile_opendisk_file_func;
functionOverrides.zread_file = ZipFile_read_file_func;
functionOverrides.zwrite_file = ZipFile_write_file_func;
functionOverrides.ztell64_file = ZipFile_tell_file_func;
functionOverrides.zseek64_file = ZipFile_seek_file_func;
functionOverrides.zclose_file = ZipFile_close_file_func;
functionOverrides.zerror_file = ZipFile_error_file_func;
functionOverrides.opaque = this;
}
2019-11-23 20:27:39 +08:00
// unzip overrides to support IFileStream
static uint64_t ZipFile_tell_file_func(voidpf opaque, voidpf stream)
2021-12-25 10:04:45 +08:00
{
if (stream == nullptr)
return -1;
auto* fs = (IFileStream*)stream;
return fs->tell();
}
static long ZipFile_seek_file_func(voidpf opaque, voidpf stream, uint64_t offset, int origin)
2021-12-25 10:04:45 +08:00
{
if (stream == nullptr)
return -1;
auto* fs = (IFileStream*)stream;
return fs->seek(offset, origin) != -1 ? 0 : -1; // must return 0 for success or -1 for error
}
static voidpf ZCALLBACK ZipFile_open_file_func(voidpf opaque, const void* filename, int mode)
2021-12-25 10:04:45 +08:00
{
IFileStream::Mode fsMode;
if ((mode & ZLIB_FILEFUNC_MODE_READWRITEFILTER) == ZLIB_FILEFUNC_MODE_READ)
fsMode = IFileStream::Mode::READ;
else if (mode & ZLIB_FILEFUNC_MODE_EXISTING)
fsMode = IFileStream::Mode::APPEND;
else if (mode & ZLIB_FILEFUNC_MODE_CREATE)
fsMode = IFileStream::Mode::WRITE;
else
return nullptr;
return FileUtils::getInstance()->openFileStream((const char*)filename, fsMode).release();
}
2021-12-25 10:04:45 +08:00
static voidpf ZipFile_opendisk_file_func(voidpf opaque, voidpf stream, uint32_t number_disk, int mode)
{
if (stream == nullptr)
return nullptr;
2021-12-25 10:04:45 +08:00
auto* zipFileInfo = (ZipFilePrivate*)opaque;
std::string diskFilename = zipFileInfo->zipFileName;
const auto pos = diskFilename.rfind('.', std::string::npos);
2021-12-25 10:04:45 +08:00
if (pos != std::string::npos && pos != 0)
{
const size_t bufferSize = 5;
char extensionBuffer[bufferSize];
snprintf(&extensionBuffer[0], bufferSize, ".z%02u", number_disk + 1);
2021-12-25 10:04:45 +08:00
diskFilename.replace(pos, std::min((size_t)4, zipFileInfo->zipFileName.size() - pos), extensionBuffer);
return ZipFile_open_file_func(opaque, diskFilename.c_str(), mode);
}
return nullptr;
}
2021-12-25 10:04:45 +08:00
static uint32_t ZipFile_read_file_func(voidpf opaque, voidpf stream, void* buf, uint32_t size)
{
if (stream == nullptr)
2021-12-25 10:04:45 +08:00
return (uint32_t)-1;
return static_cast<IFileStream*>(stream)->read(buf, size);
}
2021-12-25 10:04:45 +08:00
static uint32_t ZipFile_write_file_func(voidpf opaque, voidpf stream, const void* buf, uint32_t size)
{
if (stream == nullptr)
2021-12-25 10:04:45 +08:00
return (uint32_t)-1;
return static_cast<IFileStream*>(stream)->write(buf, size);
}
2021-12-25 10:04:45 +08:00
static int ZipFile_close_file_func(voidpf opaque, voidpf stream)
{
if (stream == nullptr)
return -1;
auto* fs = (IFileStream*)stream;
2021-12-25 10:04:45 +08:00
const auto result = fs->close(); // 0 for success, -1 for error
delete fs;
return result;
}
// THis isn't supported by IFileStream, so just check if the stream is null and open
2021-12-25 10:04:45 +08:00
static int ZipFile_error_file_func(voidpf opaque, voidpf stream)
{
if (stream == nullptr)
{
return -1;
}
auto* fs = (IFileStream*)stream;
2021-12-25 10:04:45 +08:00
if (fs->isOpen())
{
return 0;
}
return -1;
}
// End of Overrides
std::string zipFileName;
unzFile zipFile;
std::mutex zipFileMtx;
2021-12-25 10:04:45 +08:00
// std::unordered_map is faster if available on the platform
typedef hlookup::string_map<struct ZipEntryInfo> FileListContainer;
FileListContainer fileList;
zlib_filefunc64_def functionOverrides{};
};
ZipFile* ZipFile::createFromFile(std::string_view zipFile, std::string_view filter)
2019-11-23 20:27:39 +08:00
{
auto zip = new ZipFile();
if (zip->initWithFile(zipFile, filter))
2019-11-23 20:27:39 +08:00
return zip;
delete zip;
return nullptr;
2019-11-23 20:27:39 +08:00
}
2021-12-25 10:04:45 +08:00
ZipFile::ZipFile() : _data(new ZipFilePrivate())
2019-11-23 20:27:39 +08:00
{
_data->zipFile = nullptr;
}
ZipFile::~ZipFile()
{
if (_data && _data->zipFile)
{
unzClose(_data->zipFile);
}
2022-07-16 10:43:05 +08:00
AX_SAFE_DELETE(_data);
2019-11-23 20:27:39 +08:00
}
bool ZipFile::initWithFile(std::string_view zipFile, std::string_view filter)
{
_data->zipFileName = zipFile;
_data->zipFile = unzOpen2_64(zipFile.data(), &_data->functionOverrides);
return setFilter(filter);
}
bool ZipFile::setFilter(std::string_view filter)
2019-11-23 20:27:39 +08:00
{
bool ret = false;
do
{
2022-07-16 10:43:05 +08:00
AX_BREAK_IF(!_data);
AX_BREAK_IF(!_data->zipFile);
2021-12-25 10:04:45 +08:00
2019-11-23 20:27:39 +08:00
// clear existing file list
_data->fileList.clear();
2021-12-25 10:04:45 +08:00
2019-11-23 20:27:39 +08:00
// UNZ_MAXFILENAMEINZIP + 1 - it is done so in unzLocateFile
char szCurrentFileName[UNZ_MAXFILENAMEINZIP + 1];
unz_file_info64 fileInfo;
2021-12-25 10:04:45 +08:00
2019-11-23 20:27:39 +08:00
// go through all files and store position information about the required files
2021-12-25 10:04:45 +08:00
int err = unzGoToFirstFile64(_data->zipFile, &fileInfo, szCurrentFileName, sizeof(szCurrentFileName) - 1);
2019-11-23 20:27:39 +08:00
while (err == UNZ_OK)
{
unz_file_pos posInfo;
int posErr = unzGetFilePos(_data->zipFile, &posInfo);
if (posErr == UNZ_OK)
{
std::string currentFileName = szCurrentFileName;
// cache info about filtered files only (like 'assets/')
2021-12-25 10:04:45 +08:00
if (filter.empty() || currentFileName.substr(0, filter.length()) == filter)
2019-11-23 20:27:39 +08:00
{
_data->fileList[currentFileName] = ZipEntryInfo{posInfo, (uint64_t)fileInfo.uncompressed_size, 0};
2019-11-23 20:27:39 +08:00
}
}
// next file - also get the information about it
2021-12-25 10:04:45 +08:00
err = unzGoToNextFile64(_data->zipFile, &fileInfo, szCurrentFileName, sizeof(szCurrentFileName) - 1);
2019-11-23 20:27:39 +08:00
}
ret = true;
2021-12-25 10:04:45 +08:00
} while (false);
2019-11-23 20:27:39 +08:00
return ret;
}
bool ZipFile::fileExists(std::string_view fileName) const
2019-11-23 20:27:39 +08:00
{
bool ret = false;
do
{
2022-07-16 10:43:05 +08:00
AX_BREAK_IF(!_data);
2021-12-25 10:04:45 +08:00
2019-11-23 20:27:39 +08:00
ret = _data->fileList.find(fileName) != _data->fileList.end();
2021-12-25 10:04:45 +08:00
} while (false);
2019-11-23 20:27:39 +08:00
return ret;
}
std::vector<std::string> ZipFile::listFiles(std::string_view pathname) const
2019-11-23 20:27:39 +08:00
{
// filter files which `filename.startsWith(pathname)`
// then make each path unique
std::set<std::string_view> fileSet;
2021-12-25 10:04:45 +08:00
ZipFilePrivate::FileListContainer::const_iterator it = _data->fileList.begin();
2019-11-23 20:27:39 +08:00
ZipFilePrivate::FileListContainer::const_iterator end = _data->fileList.end();
2021-12-25 10:04:45 +08:00
// ensure pathname ends with `/` as a directory
std::string ensureDir;
std::string_view dirname = pathname[pathname.length() - 1] == '/' ? pathname : (ensureDir.append(pathname) += '/');
for (auto&& item : _data->fileList)
2019-11-23 20:27:39 +08:00
{
std::string_view filename = item.first;
if (cxx20::starts_with(filename, cxx17::string_view{dirname}))
2019-11-23 20:27:39 +08:00
{
std::string_view suffix{filename.substr(dirname.length())};
auto pos = suffix.find('/');
2019-11-23 20:27:39 +08:00
if (pos == std::string::npos)
{
fileSet.insert(suffix);
2019-11-23 20:27:39 +08:00
}
2021-12-25 10:04:45 +08:00
else
{
// fileSet.insert(parts[0] + "/");
fileSet.insert(suffix.substr(0, pos + 1));
2019-11-23 20:27:39 +08:00
}
}
}
2021-07-15 23:03:43 +08:00
return std::vector<std::string>{fileSet.begin(), fileSet.end()};
2019-11-23 20:27:39 +08:00
}
bool ZipFile::getFileData(std::string_view fileName, ResizableBuffer* buffer)
2019-11-23 20:27:39 +08:00
{
bool res = false;
do
{
2022-07-16 10:43:05 +08:00
AX_BREAK_IF(!_data->zipFile);
AX_BREAK_IF(fileName.empty());
2021-12-25 10:04:45 +08:00
2019-12-01 01:16:46 +08:00
ZipFilePrivate::FileListContainer::iterator it = _data->fileList.find(fileName);
2022-07-16 10:43:05 +08:00
AX_BREAK_IF(it == _data->fileList.end());
2021-12-25 10:04:45 +08:00
2019-12-01 01:16:46 +08:00
ZipEntryInfo& fileInfo = it->second;
2021-12-25 10:04:45 +08:00
2019-12-01 01:16:46 +08:00
std::unique_lock<std::mutex> lck(_data->zipFileMtx);
2019-11-23 20:27:39 +08:00
int nRet = unzGoToFilePos(_data->zipFile, &fileInfo.pos);
2022-07-16 10:43:05 +08:00
AX_BREAK_IF(UNZ_OK != nRet);
2021-12-25 10:04:45 +08:00
2019-11-23 20:27:39 +08:00
nRet = unzOpenCurrentFile(_data->zipFile);
2022-07-16 10:43:05 +08:00
AX_BREAK_IF(UNZ_OK != nRet);
2021-12-25 10:04:45 +08:00
2019-11-23 20:27:39 +08:00
buffer->resize(fileInfo.uncompressed_size);
2022-07-16 10:43:05 +08:00
int AX_UNUSED nSize =
2021-12-25 10:04:45 +08:00
unzReadCurrentFile(_data->zipFile, buffer->buffer(), static_cast<unsigned int>(fileInfo.uncompressed_size));
2022-07-16 10:43:05 +08:00
AXASSERT(nSize == 0 || nSize == (int)fileInfo.uncompressed_size, "the file size is wrong");
2019-11-23 20:27:39 +08:00
unzCloseCurrentFile(_data->zipFile);
res = true;
} while (0);
2021-12-25 10:04:45 +08:00
2019-11-23 20:27:39 +08:00
return res;
}
std::string ZipFile::getFirstFilename()
{
2021-12-25 10:04:45 +08:00
if (unzGoToFirstFile(_data->zipFile) != UNZ_OK)
return emptyFilename;
2019-11-23 20:27:39 +08:00
std::string path;
unz_file_info_s info;
2019-11-23 20:27:39 +08:00
getCurrentFileInfo(&path, &info);
return path;
}
std::string ZipFile::getNextFilename()
{
2021-12-25 10:04:45 +08:00
if (unzGoToNextFile(_data->zipFile) != UNZ_OK)
return emptyFilename;
2019-11-23 20:27:39 +08:00
std::string path;
unz_file_info_s info;
2019-11-23 20:27:39 +08:00
getCurrentFileInfo(&path, &info);
return path;
}
2021-12-25 10:04:45 +08:00
int ZipFile::getCurrentFileInfo(std::string* filename, unz_file_info_s* info)
{
2019-11-23 20:27:39 +08:00
char path[FILENAME_MAX + 1];
int ret = unzGetCurrentFileInfo(_data->zipFile, info, path, sizeof(path), nullptr, 0, nullptr, 0);
2021-12-25 10:04:45 +08:00
if (ret != UNZ_OK)
{
2019-11-23 20:27:39 +08:00
*filename = emptyFilename;
2021-12-25 10:04:45 +08:00
}
else
{
2019-11-23 20:27:39 +08:00
filename->assign(path);
}
return ret;
}
ZipEntryInfo* ZipFile::vopen(std::string_view fileName)
2019-12-01 01:16:46 +08:00
{
auto it = _data->fileList.find(fileName);
2021-12-25 10:04:45 +08:00
if (it != _data->fileList.end())
return &it->second;
return nullptr;
2019-12-01 01:16:46 +08:00
}
int ZipFile::vread(ZipEntryInfo* entry, void* buf, unsigned int size)
2019-12-01 01:16:46 +08:00
{
int n = 0;
2021-12-25 10:04:45 +08:00
do
{
AX_BREAK_IF(entry == nullptr || entry->offset >= entry->uncompressed_size);
2019-12-01 01:16:46 +08:00
std::unique_lock<std::mutex> lck(_data->zipFileMtx);
int nRet = unzGoToFilePos(_data->zipFile, &entry->pos);
2022-07-16 10:43:05 +08:00
AX_BREAK_IF(UNZ_OK != nRet);
2019-12-01 01:16:46 +08:00
nRet = unzOpenCurrentFile(_data->zipFile);
unzSeek64(_data->zipFile, entry->offset, SEEK_SET);
2019-12-01 01:16:46 +08:00
n = unzReadCurrentFile(_data->zipFile, buf, size);
if (n > 0)
entry->offset += n;
2019-12-01 01:16:46 +08:00
unzCloseCurrentFile(_data->zipFile);
} while (false);
return n;
}
int64_t ZipFile::vseek(ZipEntryInfo* entry, int64_t offset, int origin)
2019-12-01 01:16:46 +08:00
{
int64_t result = -1;
if (entry)
2021-12-25 10:04:45 +08:00
{
switch (origin)
{
2019-12-01 01:16:46 +08:00
case SEEK_SET:
result = offset;
break;
case SEEK_CUR:
result = entry->offset + offset;
2019-12-01 01:16:46 +08:00
break;
case SEEK_END:
result = (int32_t)entry->uncompressed_size + offset;
2019-12-01 01:16:46 +08:00
break;
default:;
}
2021-12-25 10:04:45 +08:00
if (result >= 0)
entry->offset = result;
2019-12-01 01:16:46 +08:00
else
result = -1;
}
return result;
}
void ZipFile::vclose(ZipEntryInfo* entry)
{
if (entry != nullptr)
entry->offset = 0;
}
int64_t ZipFile::vsize(ZipEntryInfo* entry)
{
if (entry != nullptr)
return entry->uncompressed_size;
return 0;
}
2019-12-01 01:16:46 +08:00
NS_AX_END