mirror of
https://github.com/id-Software/DOOM-3-BFG.git
synced 2026-03-20 09:00:25 +01:00
Initial commit
This commit is contained in:
Brian Harris
305
neo/framework/Zip.h
Normal file
305
neo/framework/Zip.h
Normal file
@@ -0,0 +1,305 @@
|
||||
/*
|
||||
===========================================================================
|
||||
|
||||
Doom 3 BFG Edition GPL Source Code
|
||||
Copyright (C) 1993-2012 id Software LLC, a ZeniMax Media company.
|
||||
|
||||
This file is part of the Doom 3 BFG Edition GPL Source Code ("Doom 3 BFG Edition Source Code").
|
||||
|
||||
Doom 3 BFG Edition Source Code is free software: you can redistribute it and/or modify
|
||||
it under the terms of the GNU General Public License as published by
|
||||
the Free Software Foundation, either version 3 of the License, or
|
||||
(at your option) any later version.
|
||||
|
||||
Doom 3 BFG Edition Source Code is distributed in the hope that it will be useful,
|
||||
but WITHOUT ANY WARRANTY; without even the implied warranty of
|
||||
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
|
||||
GNU General Public License for more details.
|
||||
|
||||
You should have received a copy of the GNU General Public License
|
||||
along with Doom 3 BFG Edition Source Code. If not, see <http://www.gnu.org/licenses/>.
|
||||
|
||||
In addition, the Doom 3 BFG Edition Source Code is also subject to certain additional terms. You should have received a copy of these additional terms immediately following the terms and conditions of the GNU General Public License which accompanied the Doom 3 BFG Edition Source Code. If not, please request a copy in writing from id Software at the address below.
|
||||
|
||||
If you have questions concerning this license or the applicable additional terms, you may contact in writing id Software LLC, c/o ZeniMax Media Inc., Suite 120, Rockville, Maryland 20850 USA.
|
||||
|
||||
===========================================================================
|
||||
*/
|
||||
#ifndef __ZIP_H__
|
||||
#define __ZIP_H__
|
||||
|
||||
#include "zlib/zlib.h"
|
||||
|
||||
/*
|
||||
================================================================================================
|
||||
|
||||
Contains external code for building ZipFiles.
|
||||
|
||||
The Unzip Package allows extraction of a file from .ZIP file, compatible with
|
||||
PKZip 2.04g, !WinZip, !InfoZip tools and compatibles. Encryption and multi-volume ZipFiles
|
||||
(span) are not supported. Old compressions used by old PKZip 1.x are not supported.
|
||||
|
||||
================================================================================================
|
||||
*/
|
||||
#if defined(STRICTZIP) || defined(STRICTZIPUNZIP)
|
||||
/* like the STRICT of WIN32, we define a pointer that cannot be converted
|
||||
from (void*) without cast */
|
||||
typedef struct TagzipFile__ { int unused; } zipFile__;
|
||||
typedef zipFile__ *zipFile;
|
||||
#else
|
||||
typedef void* zipFile;
|
||||
#endif
|
||||
|
||||
#define ZIP_OK (0)
|
||||
#define ZIP_EOF (0)
|
||||
#define ZIP_ERRNO (Z_ERRNO)
|
||||
#define ZIP_PARAMERROR (-102)
|
||||
#define ZIP_BADZIPFILE (-103)
|
||||
#define ZIP_INTERNALERROR (-104)
|
||||
|
||||
#ifndef Z_BUFSIZE
|
||||
#define Z_BUFSIZE (16384)
|
||||
#endif
|
||||
|
||||
/*
|
||||
========================
|
||||
tm_zip
|
||||
contains date/time info
|
||||
========================
|
||||
*/
|
||||
typedef struct tm_zip_s {
|
||||
unsigned int tm_sec; /* seconds after the minute - [0,59] */
|
||||
unsigned int tm_min; /* minutes after the hour - [0,59] */
|
||||
unsigned int tm_hour; /* hours since midnight - [0,23] */
|
||||
unsigned int tm_mday; /* day of the month - [1,31] */
|
||||
unsigned int tm_mon; /* months since January - [0,11] */
|
||||
unsigned int tm_year; /* years - [1980..2044] */
|
||||
} tm_zip;
|
||||
|
||||
/*
|
||||
========================
|
||||
zip_fileinfo
|
||||
========================
|
||||
*/
|
||||
typedef struct {
|
||||
tm_zip tmz_date; /* date in understandable format */
|
||||
unsigned long dosDate; /* if dos_date == 0, tmu_date is used */
|
||||
// unsigned long flag; /* general purpose bit flag 2 bytes */
|
||||
|
||||
unsigned long internal_fa; /* internal file attributes 2 bytes */
|
||||
unsigned long external_fa; /* external file attributes 4 bytes */
|
||||
} zip_fileinfo;
|
||||
|
||||
#define NOCRYPT // ignore passwords
|
||||
#define SIZEDATA_INDATABLOCK (4096-(4*4))
|
||||
|
||||
/*
|
||||
========================
|
||||
linkedlist_datablock_internal
|
||||
========================
|
||||
*/
|
||||
typedef struct linkedlist_datablock_internal_s {
|
||||
struct linkedlist_datablock_internal_s* next_datablock;
|
||||
unsigned long avail_in_this_block;
|
||||
unsigned long filled_in_this_block;
|
||||
unsigned long unused; /* for future use and alignement */
|
||||
unsigned char data[SIZEDATA_INDATABLOCK];
|
||||
} linkedlist_datablock_internal;
|
||||
|
||||
/*
|
||||
========================
|
||||
linkedlist_data
|
||||
========================
|
||||
*/
|
||||
typedef struct linkedlist_data_s {
|
||||
linkedlist_datablock_internal* first_block;
|
||||
linkedlist_datablock_internal* last_block;
|
||||
} linkedlist_data;
|
||||
|
||||
/*
|
||||
========================
|
||||
curfile_info
|
||||
========================
|
||||
*/
|
||||
typedef struct {
|
||||
z_stream stream; /* zLib stream structure for inflate */
|
||||
int stream_initialised; /* 1 is stream is initialised */
|
||||
unsigned int pos_in_buffered_data; /* last written byte in buffered_data */
|
||||
|
||||
unsigned long pos_local_header; /* offset of the local header of the file currenty writing */
|
||||
char* central_header; /* central header data for the current file */
|
||||
unsigned long size_centralheader; /* size of the central header for cur file */
|
||||
unsigned long flag; /* flag of the file currently writing */
|
||||
|
||||
int method; /* compression method of file currenty wr.*/
|
||||
int raw; /* 1 for directly writing raw data */
|
||||
byte buffered_data[Z_BUFSIZE];/* buffer contain compressed data to be writ*/
|
||||
unsigned long dosDate;
|
||||
unsigned long crc32;
|
||||
int encrypt;
|
||||
#ifndef NOCRYPT
|
||||
unsigned long keys[3]; /* keys defining the pseudo-random sequence */
|
||||
const unsigned long* pcrc_32_tab;
|
||||
int crypt_header_size;
|
||||
#endif
|
||||
} curfile_info;
|
||||
|
||||
//#define NO_ADDFILEINEXISTINGZIP
|
||||
/*
|
||||
========================
|
||||
zip_internal
|
||||
========================
|
||||
*/
|
||||
typedef struct {
|
||||
idFile* filestream; /* io structore of the zipfile */
|
||||
linkedlist_data central_dir; /* datablock with central dir in construction*/
|
||||
int in_opened_file_inzip; /* 1 if a file in the zip is currently writ.*/
|
||||
curfile_info ci; /* info on the file curretly writing */
|
||||
|
||||
unsigned long begin_pos; /* position of the beginning of the zipfile */
|
||||
unsigned long add_position_when_writting_offset;
|
||||
unsigned long number_entry;
|
||||
#ifndef NO_ADDFILEINEXISTINGZIP
|
||||
char* globalcomment;
|
||||
#endif
|
||||
} zip_internal;
|
||||
|
||||
#define APPEND_STATUS_CREATE (0)
|
||||
#define APPEND_STATUS_CREATEAFTER (1)
|
||||
#define APPEND_STATUS_ADDINZIP (2)
|
||||
|
||||
/*
|
||||
Create a zipfile.
|
||||
pathname contain on Windows XP a filename like "c:\\zlib\\zlib113.zip" or on
|
||||
an Unix computer "zlib/zlib113.zip".
|
||||
if the file pathname exist and append==APPEND_STATUS_CREATEAFTER, the zip
|
||||
will be created at the end of the file.
|
||||
(useful if the file contain a self extractor code)
|
||||
if the file pathname exist and append==APPEND_STATUS_ADDINZIP, we will
|
||||
add files in existing zip (be sure you don't add file that doesn't exist)
|
||||
If the zipfile cannot be opened, the return value is NULL.
|
||||
Else, the return value is a zipFile Handle, usable with other function
|
||||
of this zip package.
|
||||
*/
|
||||
|
||||
/* Note : there is no delete function into a zipfile.
|
||||
If you want delete file into a zipfile, you must open a zipfile, and create another
|
||||
Of couse, you can use RAW reading and writing to copy the file you did not want delte
|
||||
*/
|
||||
extern zipFile zipOpen( const char *pathname, int append );
|
||||
|
||||
/*
|
||||
Open a file in the ZIP for writing.
|
||||
filename : the filename in zip (if NULL, '-' without quote will be used
|
||||
*zipfi contain supplemental information
|
||||
if extrafield_local!=NULL and size_extrafield_local>0, extrafield_local
|
||||
contains the extrafield data the the local header
|
||||
if extrafield_global!=NULL and size_extrafield_global>0, extrafield_global
|
||||
contains the extrafield data the the local header
|
||||
if comment != NULL, comment contain the comment string
|
||||
method contain the compression method (0 for store, Z_DEFLATED for deflate)
|
||||
level contain the level of compression (can be Z_DEFAULT_COMPRESSION)
|
||||
*/
|
||||
extern zipFile zipOpen2( const char* pathname, int append, char* globalcomment );
|
||||
|
||||
extern int zipOpenNewFileInZip( zipFile file, const char* filename, const zip_fileinfo* zipfi, const void* extrafield_local,
|
||||
uInt size_extrafield_local, const void* extrafield_global, uInt size_extrafield_global, const char* comment,
|
||||
int method, int level );
|
||||
|
||||
/*
|
||||
Same than zipOpenNewFileInZip, except if raw=1, we write raw file
|
||||
*/
|
||||
extern int zipOpenNewFileInZip2( zipFile file, const char* filename, const zip_fileinfo* zipfi, const void* extrafield_local, uInt size_extrafield_local,
|
||||
const void* extrafield_global, uInt size_extrafield_global, const char* comment, int method, int level, int raw );
|
||||
|
||||
/*
|
||||
Same than zipOpenNewFileInZip2, except
|
||||
windowBits,memLevel,,strategy : see parameter strategy in deflateInit2
|
||||
password : crypting password (NULL for no crypting)
|
||||
crcForCtypting : crc of file to compress (needed for crypting)
|
||||
*/
|
||||
extern int zipOpenNewFileInZip3( zipFile file, const char* filename, const zip_fileinfo* zipfi, const void* extrafield_local, uInt size_extrafield_local,
|
||||
const void* extrafield_global, uInt size_extrafield_global, const char* comment, int method, int level, int raw, int windowBits,
|
||||
int memLevel, int strategy, const char* password, uLong crcForCtypting );
|
||||
|
||||
/*
|
||||
Write data in the zipfile
|
||||
*/
|
||||
extern int zipWriteInFileInZip( zipFile file, const void* buf, unsigned int len );
|
||||
|
||||
|
||||
/*
|
||||
Close the current file in the zipfile
|
||||
*/
|
||||
extern int zipCloseFileInZip( zipFile file );
|
||||
|
||||
|
||||
/*
|
||||
Close the current file in the zipfile, for fiel opened with
|
||||
parameter raw=1 in zipOpenNewFileInZip2
|
||||
uncompressed_size and crc32 are value for the uncompressed size
|
||||
*/
|
||||
extern int zipCloseFileInZipRaw( zipFile file, uLong uncompressed_size, uLong crc32 );
|
||||
|
||||
|
||||
/*
|
||||
Close the zipfile
|
||||
*/
|
||||
extern int zipClose( zipFile file, const char* global_comment );
|
||||
|
||||
|
||||
/*
|
||||
================================================
|
||||
idZipBuilder
|
||||
|
||||
simple interface for zipping up a folder of files
|
||||
by default, the source folder files are added recursively
|
||||
================================================
|
||||
*/
|
||||
class idZipBuilder {
|
||||
public:
|
||||
idZipBuilder() {}
|
||||
~idZipBuilder() {}
|
||||
|
||||
public:
|
||||
// adds a list of file extensions ( e.g. "bcm|bmodel|" ) to be compressed in the zip file
|
||||
void AddFileFilters( const char *filters );
|
||||
// adds a list of file extensions ( e.g. "genmodel|" ) to be added to the zip file, in an uncompressed form
|
||||
void AddUncompressedFileFilters( const char *filters );
|
||||
// builds a zip file of all the files in the specified folder, overwriting if necessary
|
||||
bool Build( const char* zipPath, const char *folder, bool cleanFolder );
|
||||
// updates a zip file with the files in the specified folder
|
||||
bool Update( const char* zipPath, const char *folder, bool cleanFolder );
|
||||
|
||||
// helper function to zip up all the files and put in a new zip file
|
||||
static bool BuildMapFolderZip( const char *mapFileName );
|
||||
// helper function to update a map folder zip for newer files
|
||||
static bool UpdateMapFolderZip( const char *mapFileName );
|
||||
|
||||
// combines multiple in-memory files into a single memory file
|
||||
static idFile_Memory * CombineFiles( const idList< idFile_Memory * > & srcFiles );
|
||||
// extracts multiple in-memory files from a single memory file
|
||||
static bool ExtractFiles( idFile_Memory * & srcFile, idList< idFile_Memory * > & destFiles );
|
||||
|
||||
void CleanSourceFolder();
|
||||
|
||||
bool CreateZipFileFromFileList( const char *name, const idList< idFile_Memory * > & srcFiles );
|
||||
|
||||
zipFile CreateZipFile( const char *name );
|
||||
bool AddFile( zipFile zf, idFile_Memory *fm, bool deleteFile );
|
||||
void CloseZipFile( zipFile zf );
|
||||
private:
|
||||
bool CreateZipFile( bool appendFiles );
|
||||
bool CreateZipFileFromFiles( const idList< idFile_Memory * > & srcFiles );
|
||||
bool GetFileTime( const idStr &filename, unsigned long *dostime ) const;
|
||||
bool IsFiltered( const idStr &filename ) const;
|
||||
bool IsUncompressed( const idStr &filename ) const;
|
||||
|
||||
private:
|
||||
idStr zipFileName; // os path to the zip file
|
||||
idStr sourceFolderName; // source folder of files to zip or add
|
||||
idStrList filterExts; // file extensions we want to compressed
|
||||
idStrList uncompressedFilterExts; // file extensions we don't want to compress
|
||||
};
|
||||
|
||||
#endif /* __ZIP_H__ */
|
||||
Reference in New Issue
Block a user