2014-02-10 02:10:30 +01:00
|
|
|
/*************************************************************************/
|
|
|
|
/* file_access_zip.h */
|
|
|
|
/*************************************************************************/
|
|
|
|
/* This file is part of: */
|
|
|
|
/* GODOT ENGINE */
|
2017-08-27 14:16:55 +02:00
|
|
|
/* https://godotengine.org */
|
2014-02-10 02:10:30 +01:00
|
|
|
/*************************************************************************/
|
2022-01-03 21:27:34 +01:00
|
|
|
/* Copyright (c) 2007-2022 Juan Linietsky, Ariel Manzur. */
|
|
|
|
/* Copyright (c) 2014-2022 Godot Engine contributors (cf. AUTHORS.md). */
|
2014-02-10 02:10:30 +01: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: */
|
|
|
|
/* */
|
|
|
|
/* 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. */
|
|
|
|
/*************************************************************************/
|
2018-01-05 00:50:27 +01:00
|
|
|
|
|
|
|
#ifndef FILE_ACCESS_ZIP_H
|
|
|
|
#define FILE_ACCESS_ZIP_H
|
2014-02-10 02:10:30 +01:00
|
|
|
|
2020-09-03 12:28:55 +02:00
|
|
|
#ifdef MINIZIP_ENABLED
|
|
|
|
|
2014-02-10 02:10:30 +01:00
|
|
|
#include "core/io/file_access_pack.h"
|
2022-05-13 15:04:37 +02:00
|
|
|
#include "core/templates/rb_map.h"
|
2017-04-28 18:29:15 +02:00
|
|
|
|
|
|
|
#include "thirdparty/minizip/unzip.h"
|
|
|
|
|
2014-02-10 02:10:30 +01:00
|
|
|
#include <stdlib.h>
|
|
|
|
|
|
|
|
class ZipArchive : public PackSource {
|
|
|
|
public:
|
|
|
|
struct File {
|
2020-05-12 17:01:17 +02:00
|
|
|
int package = -1;
|
2014-02-10 02:10:30 +01:00
|
|
|
unz_file_pos file_pos;
|
2020-05-12 17:01:17 +02:00
|
|
|
File() {}
|
2014-02-10 02:10:30 +01:00
|
|
|
};
|
|
|
|
|
|
|
|
private:
|
|
|
|
struct Package {
|
|
|
|
String filename;
|
2020-05-12 17:01:17 +02:00
|
|
|
unzFile zfile = nullptr;
|
2014-02-10 02:10:30 +01:00
|
|
|
};
|
|
|
|
Vector<Package> packages;
|
|
|
|
|
2022-05-13 15:04:37 +02:00
|
|
|
HashMap<String, File> files;
|
2014-02-10 02:10:30 +01:00
|
|
|
|
|
|
|
static ZipArchive *instance;
|
|
|
|
|
|
|
|
public:
|
|
|
|
void close_handle(unzFile p_file) const;
|
|
|
|
unzFile get_file_handle(String p_file) const;
|
|
|
|
|
|
|
|
Error add_package(String p_name);
|
|
|
|
|
|
|
|
bool file_exists(String p_name) const;
|
|
|
|
|
2022-04-05 12:40:26 +02:00
|
|
|
virtual bool try_open_pack(const String &p_path, bool p_replace_files, uint64_t p_offset) override;
|
2022-03-23 10:08:58 +01:00
|
|
|
Ref<FileAccess> get_file(const String &p_path, PackedData::PackedFile *p_file) override;
|
2014-02-10 02:10:30 +01:00
|
|
|
|
|
|
|
static ZipArchive *get_singleton();
|
|
|
|
|
|
|
|
ZipArchive();
|
|
|
|
~ZipArchive();
|
|
|
|
};
|
|
|
|
|
|
|
|
class FileAccessZip : public FileAccess {
|
2020-09-19 15:45:00 +02:00
|
|
|
unzFile zfile = nullptr;
|
2014-02-10 02:10:30 +01:00
|
|
|
unz_file_info64 file_info;
|
|
|
|
|
2022-05-02 16:28:25 +02:00
|
|
|
mutable bool at_eof = false;
|
2014-02-10 02:10:30 +01:00
|
|
|
|
2022-04-12 10:15:02 +02:00
|
|
|
void _close();
|
|
|
|
|
2014-02-10 02:10:30 +01:00
|
|
|
public:
|
2021-05-25 09:22:10 +02:00
|
|
|
virtual Error _open(const String &p_path, int p_mode_flags) override; ///< open a file
|
|
|
|
virtual bool is_open() const override; ///< true when file is open
|
2014-02-10 02:10:30 +01:00
|
|
|
|
2021-05-25 09:22:10 +02:00
|
|
|
virtual void seek(uint64_t p_position) override; ///< seek to a given position
|
|
|
|
virtual void seek_end(int64_t p_position = 0) override; ///< seek from the end of file
|
|
|
|
virtual uint64_t get_position() const override; ///< get position in the file
|
|
|
|
virtual uint64_t get_length() const override; ///< get size of the file
|
2014-02-10 02:10:30 +01:00
|
|
|
|
2021-05-25 09:22:10 +02:00
|
|
|
virtual bool eof_reached() const override; ///< reading passed EOF
|
2014-02-10 02:10:30 +01:00
|
|
|
|
2021-05-25 09:22:10 +02:00
|
|
|
virtual uint8_t get_8() const override; ///< get a byte
|
|
|
|
virtual uint64_t get_buffer(uint8_t *p_dst, uint64_t p_length) const override;
|
2014-02-10 02:10:30 +01:00
|
|
|
|
2021-05-25 09:22:10 +02:00
|
|
|
virtual Error get_error() const override; ///< get last error
|
2014-02-10 02:10:30 +01:00
|
|
|
|
2021-05-25 09:22:10 +02:00
|
|
|
virtual void flush() override;
|
|
|
|
virtual void store_8(uint8_t p_dest) override; ///< store a byte
|
2019-03-26 18:51:13 +01:00
|
|
|
|
2021-05-25 09:22:10 +02:00
|
|
|
virtual bool file_exists(const String &p_name) override; ///< return true if a file exists
|
2014-02-10 02:10:30 +01:00
|
|
|
|
2021-05-25 09:22:10 +02:00
|
|
|
virtual uint64_t _get_modified_time(const String &p_file) override { return 0; } // todo
|
|
|
|
virtual uint32_t _get_unix_permissions(const String &p_file) override { return 0; }
|
|
|
|
virtual Error _set_unix_permissions(const String &p_file, uint32_t p_permissions) override { return FAILED; }
|
2014-02-10 02:10:30 +01:00
|
|
|
|
|
|
|
FileAccessZip(const String &p_path, const PackedData::PackedFile &p_file);
|
|
|
|
~FileAccessZip();
|
|
|
|
};
|
|
|
|
|
2018-01-05 00:50:27 +01:00
|
|
|
#endif // MINIZIP_ENABLED
|
2020-09-03 12:28:55 +02:00
|
|
|
|
|
|
|
#endif // FILE_ACCESS_ZIP_H
|