godot/core/io/file_access_zip.cpp

Ignoring revisions in .git-blame-ignore-revs. Click here to bypass and see the normal blame view.

352 lines
9.5 KiB
C++
Raw Normal View History

2014-02-10 01:10:30 +00:00
/**************************************************************************/
/* file_access_zip.cpp */
/**************************************************************************/
/* This file is part of: */
/* GODOT ENGINE */
/* https://godotengine.org */
/**************************************************************************/
/* Copyright (c) 2014-present Godot Engine contributors (see AUTHORS.md). */
/* Copyright (c) 2007-2014 Juan Linietsky, Ariel Manzur. */
/* */
/* 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: */
/* */
/* The above copyright notice and this permission notice shall be */
/* included in all copies or substantial portions of the Software. */
/* */
/* 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. */
/**************************************************************************/
2014-02-10 01:10:30 +00:00
#ifdef MINIZIP_ENABLED
#include "file_access_zip.h"
#include "core/io/file_access.h"
2014-02-10 01:10:30 +00:00
2020-04-01 23:20:12 +00:00
ZipArchive *ZipArchive::instance = nullptr;
2014-02-10 01:10:30 +00:00
extern "C" {
struct ZipData {
Ref<FileAccess> f;
};
static void *godot_open(voidpf opaque, const char *p_fname, int mode) {
2014-02-10 01:10:30 +00:00
if (mode & ZLIB_FILEFUNC_MODE_WRITE) {
2020-04-01 23:20:12 +00:00
return nullptr;
}
2014-02-10 01:10:30 +00:00
Ref<FileAccess> f = FileAccess::open(String::utf8(p_fname), FileAccess::READ);
ERR_FAIL_COND_V(f.is_null(), nullptr);
2014-02-10 01:10:30 +00:00
ZipData *zd = memnew(ZipData);
zd->f = f;
return zd;
}
2014-02-10 01:10:30 +00:00
static uLong godot_read(voidpf opaque, voidpf stream, void *buf, uLong size) {
ZipData *zd = (ZipData *)stream;
zd->f->get_buffer((uint8_t *)buf, size);
2014-02-10 01:10:30 +00:00
return size;
}
2014-02-10 01:10:30 +00:00
static uLong godot_write(voidpf opaque, voidpf stream, const void *buf, uLong size) {
return 0;
}
2014-02-10 01:10:30 +00:00
static long godot_tell(voidpf opaque, voidpf stream) {
ZipData *zd = (ZipData *)stream;
return zd->f->get_position();
}
2014-02-10 01:10:30 +00:00
static long godot_seek(voidpf opaque, voidpf stream, uLong offset, int origin) {
ZipData *zd = (ZipData *)stream;
2014-02-10 01:10:30 +00:00
uint64_t pos = offset;
2014-02-10 01:10:30 +00:00
switch (origin) {
case ZLIB_FILEFUNC_SEEK_CUR:
pos = zd->f->get_position() + offset;
2014-02-10 01:10:30 +00:00
break;
case ZLIB_FILEFUNC_SEEK_END:
pos = zd->f->get_length() + offset;
2014-02-10 01:10:30 +00:00
break;
default:
break;
}
2014-02-10 01:10:30 +00:00
zd->f->seek(pos);
2014-02-10 01:10:30 +00:00
return 0;
}
2014-02-10 01:10:30 +00:00
static int godot_close(voidpf opaque, voidpf stream) {
ZipData *zd = (ZipData *)stream;
memdelete(zd);
2014-02-10 01:10:30 +00:00
return 0;
}
2014-02-10 01:10:30 +00:00
static int godot_testerror(voidpf opaque, voidpf stream) {
ZipData *zd = (ZipData *)stream;
return zd->f->get_error() != OK ? 1 : 0;
}
2014-02-10 01:10:30 +00:00
2015-05-26 01:35:00 +00:00
static voidpf godot_alloc(voidpf opaque, uInt items, uInt size) {
return memalloc((size_t)items * size);
}
2014-02-10 01:10:30 +00:00
2015-05-26 01:35:00 +00:00
static void godot_free(voidpf opaque, voidpf address) {
memfree(address);
}
} // extern "C"
2014-02-10 01:10:30 +00:00
void ZipArchive::close_handle(unzFile p_file) const {
ERR_FAIL_NULL_MSG(p_file, "Cannot close a file if none is open.");
2014-02-10 01:10:30 +00:00
unzCloseCurrentFile(p_file);
unzClose(p_file);
}
2014-02-10 01:10:30 +00:00
unzFile ZipArchive::get_file_handle(const String &p_file) const {
2020-04-01 23:20:12 +00:00
ERR_FAIL_COND_V_MSG(!file_exists(p_file), nullptr, "File '" + p_file + " doesn't exist.");
2014-02-10 01:10:30 +00:00
File file = files[p_file];
zlib_filefunc_def io;
memset(&io, 0, sizeof(io));
2014-02-10 01:10:30 +00:00
2021-05-14 05:53:43 +00:00
io.opaque = nullptr;
2014-02-10 01:10:30 +00:00
io.zopen_file = godot_open;
io.zread_file = godot_read;
io.zwrite_file = godot_write;
io.ztell_file = godot_tell;
io.zseek_file = godot_seek;
io.zclose_file = godot_close;
io.zerror_file = godot_testerror;
2015-05-26 01:35:00 +00:00
io.alloc_mem = godot_alloc;
io.free_mem = godot_free;
2014-02-10 01:10:30 +00:00
unzFile pkg = unzOpen2(packages[file.package].filename.utf8().get_data(), &io);
ERR_FAIL_NULL_V_MSG(pkg, nullptr, "Cannot open file '" + packages[file.package].filename + "'.");
2015-05-26 01:35:00 +00:00
int unz_err = unzGoToFilePos(pkg, &file.file_pos);
2017-04-06 11:18:41 +00:00
if (unz_err != UNZ_OK || unzOpenCurrentFile(pkg) != UNZ_OK) {
2014-02-10 01:10:30 +00:00
unzClose(pkg);
2020-04-01 23:20:12 +00:00
ERR_FAIL_V(nullptr);
}
2014-02-10 01:10:30 +00:00
return pkg;
}
2014-02-10 01:10:30 +00:00
bool ZipArchive::try_open_pack(const String &p_path, bool p_replace_files, uint64_t p_offset = 0) {
// load with offset feature only supported for PCK files
ERR_FAIL_COND_V_MSG(p_offset != 0, false, "Invalid PCK data. Note that loading files with a non-zero offset isn't supported with ZIP archives.");
if (p_path.get_extension().nocasecmp_to("zip") != 0 && p_path.get_extension().nocasecmp_to("pcz") != 0) {
2014-02-10 01:10:30 +00:00
return false;
}
2014-02-10 01:10:30 +00:00
zlib_filefunc_def io;
2021-05-14 05:53:43 +00:00
memset(&io, 0, sizeof(io));
2014-02-10 01:10:30 +00:00
2021-05-14 05:53:43 +00:00
io.opaque = nullptr;
2014-02-10 01:10:30 +00:00
io.zopen_file = godot_open;
io.zread_file = godot_read;
io.zwrite_file = godot_write;
io.ztell_file = godot_tell;
io.zseek_file = godot_seek;
io.zclose_file = godot_close;
io.zerror_file = godot_testerror;
unzFile zfile = unzOpen2(p_path.utf8().get_data(), &io);
ERR_FAIL_NULL_V(zfile, false);
2014-02-10 01:10:30 +00:00
unz_global_info64 gi;
int err = unzGetGlobalInfo64(zfile, &gi);
ERR_FAIL_COND_V(err != UNZ_OK, false);
Package pkg;
pkg.filename = p_path;
2014-02-10 01:10:30 +00:00
pkg.zfile = zfile;
packages.push_back(pkg);
int pkg_num = packages.size() - 1;
for (uint64_t i = 0; i < gi.number_entry; i++) {
2014-02-10 01:10:30 +00:00
char filename_inzip[256];
unz_file_info64 file_info;
2020-04-01 23:20:12 +00:00
err = unzGetCurrentFileInfo64(zfile, &file_info, filename_inzip, sizeof(filename_inzip), nullptr, 0, nullptr, 0);
2014-02-10 01:10:30 +00:00
ERR_CONTINUE(err != UNZ_OK);
File f;
f.package = pkg_num;
unzGetFilePos(zfile, &f.file_pos);
2022-01-06 09:34:10 +00:00
String fname = String("res://") + String::utf8(filename_inzip);
2014-02-10 01:10:30 +00:00
files[fname] = f;
uint8_t md5[16] = { 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0 };
PackedData::get_singleton()->add_path(p_path, fname, 1, 0, md5, this, p_replace_files, false);
//printf("packed data add path %s, %s\n", p_name.utf8().get_data(), fname.utf8().get_data());
2014-02-10 01:10:30 +00:00
if ((i + 1) < gi.number_entry) {
unzGoToNextFile(zfile);
}
}
2014-02-10 01:10:30 +00:00
return true;
}
2014-02-10 01:10:30 +00:00
bool ZipArchive::file_exists(const String &p_name) const {
2014-02-10 01:10:30 +00:00
return files.has(p_name);
}
2014-02-10 01:10:30 +00:00
Ref<FileAccess> ZipArchive::get_file(const String &p_path, PackedData::PackedFile *p_file) {
2014-02-10 01:10:30 +00:00
return memnew(FileAccessZip(p_path, *p_file));
}
2014-02-10 01:10:30 +00:00
ZipArchive *ZipArchive::get_singleton() {
2020-04-01 23:20:12 +00:00
if (instance == nullptr) {
2014-02-10 01:10:30 +00:00
instance = memnew(ZipArchive);
}
2014-02-10 01:10:30 +00:00
return instance;
}
2014-02-10 01:10:30 +00:00
ZipArchive::ZipArchive() {
instance = this;
}
2014-02-10 01:10:30 +00:00
ZipArchive::~ZipArchive() {
for (int i = 0; i < packages.size(); i++) {
unzClose(packages[i].zfile);
}
2014-02-10 01:10:30 +00:00
packages.clear();
}
2014-02-10 01:10:30 +00:00
Error FileAccessZip::open_internal(const String &p_path, int p_mode_flags) {
_close();
2014-02-10 01:10:30 +00:00
ERR_FAIL_COND_V(p_mode_flags & FileAccess::WRITE, FAILED);
ZipArchive *arch = ZipArchive::get_singleton();
ERR_FAIL_NULL_V(arch, FAILED);
2014-02-10 01:10:30 +00:00
zfile = arch->get_file_handle(p_path);
ERR_FAIL_NULL_V(zfile, FAILED);
2014-02-10 01:10:30 +00:00
2020-04-01 23:20:12 +00:00
int err = unzGetCurrentFileInfo64(zfile, &file_info, nullptr, 0, nullptr, 0, nullptr, 0);
2014-02-10 01:10:30 +00:00
ERR_FAIL_COND_V(err != UNZ_OK, FAILED);
return OK;
}
2014-02-10 01:10:30 +00:00
void FileAccessZip::_close() {
if (!zfile) {
2014-02-10 01:10:30 +00:00
return;
}
2014-02-10 01:10:30 +00:00
ZipArchive *arch = ZipArchive::get_singleton();
ERR_FAIL_NULL(arch);
2014-02-10 01:10:30 +00:00
arch->close_handle(zfile);
2020-04-01 23:20:12 +00:00
zfile = nullptr;
}
2014-02-10 01:10:30 +00:00
bool FileAccessZip::is_open() const {
2020-04-01 23:20:12 +00:00
return zfile != nullptr;
}
2014-02-10 01:10:30 +00:00
void FileAccessZip::seek(uint64_t p_position) {
ERR_FAIL_NULL(zfile);
2014-02-10 01:10:30 +00:00
unzSeekCurrentFile(zfile, p_position);
}
2014-02-10 01:10:30 +00:00
void FileAccessZip::seek_end(int64_t p_position) {
ERR_FAIL_NULL(zfile);
2021-05-25 06:58:49 +00:00
unzSeekCurrentFile(zfile, get_length() + p_position);
}
2014-02-10 01:10:30 +00:00
uint64_t FileAccessZip::get_position() const {
ERR_FAIL_NULL_V(zfile, 0);
return unztell64(zfile);
}
2014-02-10 01:10:30 +00:00
2021-05-25 06:58:49 +00:00
uint64_t FileAccessZip::get_length() const {
ERR_FAIL_NULL_V(zfile, 0);
2014-02-10 01:10:30 +00:00
return file_info.uncompressed_size;
}
2014-02-10 01:10:30 +00:00
bool FileAccessZip::eof_reached() const {
ERR_FAIL_NULL_V(zfile, true);
2014-02-10 01:10:30 +00:00
return at_eof;
}
2014-02-10 01:10:30 +00:00
uint8_t FileAccessZip::get_8() const {
uint8_t ret = 0;
get_buffer(&ret, 1);
return ret;
}
2014-02-10 01:10:30 +00:00
uint64_t FileAccessZip::get_buffer(uint8_t *p_dst, uint64_t p_length) const {
ERR_FAIL_COND_V(!p_dst && p_length > 0, -1);
ERR_FAIL_NULL_V(zfile, -1);
2014-02-10 01:10:30 +00:00
at_eof = unzeof(zfile);
if (at_eof) {
2014-02-10 01:10:30 +00:00
return 0;
}
int64_t read = unzReadCurrentFile(zfile, p_dst, p_length);
2014-02-10 01:10:30 +00:00
ERR_FAIL_COND_V(read < 0, read);
if ((uint64_t)read < p_length) {
2014-02-10 01:10:30 +00:00
at_eof = true;
}
2014-02-10 01:10:30 +00:00
return read;
}
2014-02-10 01:10:30 +00:00
Error FileAccessZip::get_error() const {
if (!zfile) {
return ERR_UNCONFIGURED;
}
2014-02-10 01:10:30 +00:00
if (eof_reached()) {
return ERR_FILE_EOF;
}
2014-02-10 01:10:30 +00:00
return OK;
}
2014-02-10 01:10:30 +00:00
void FileAccessZip::flush() {
ERR_FAIL();
}
2014-02-10 01:10:30 +00:00
void FileAccessZip::store_8(uint8_t p_dest) {
ERR_FAIL();
}
2014-02-10 01:10:30 +00:00
bool FileAccessZip::file_exists(const String &p_name) {
return false;
}
2014-02-10 01:10:30 +00:00
2023-02-16 13:25:32 +00:00
void FileAccessZip::close() {
_close();
}
FileAccessZip::FileAccessZip(const String &p_path, const PackedData::PackedFile &p_file) {
open_internal(p_path, FileAccess::READ);
}
2014-02-10 01:10:30 +00:00
FileAccessZip::~FileAccessZip() {
_close();
}
2014-02-10 01:10:30 +00:00
#endif // MINIZIP_ENABLED