1/* unzip.h -- IO for uncompress .zip files using zlib 2 Version 1.1, February 14h, 2010 3 part of the MiniZip project - ( http://www.winimage.com/zLibDll/minizip.html ) 4 5 Copyright (C) 1998-2010 Gilles Vollant (minizip) ( http://www.winimage.com/zLibDll/minizip.html ) 6 7 Modifications of Unzip for Zip64 8 Copyright (C) 2007-2008 Even Rouault 9 10 Modifications for Zip64 support on both zip and unzip 11 Copyright (C) 2009-2010 Mathias Svensson ( http://result42.com ) 12 13 For more info read MiniZip_info.txt 14 15 --------------------------------------------------------------------------------- 16 17 Condition of use and distribution are the same than zlib : 18 19 This software is provided 'as-is', without any express or implied 20 warranty. In no event will the authors be held liable for any damages 21 arising from the use of this software. 22 23 Permission is granted to anyone to use this software for any purpose, 24 including commercial applications, and to alter it and redistribute it 25 freely, subject to the following restrictions: 26 27 1. The origin of this software must not be misrepresented; you must not 28 claim that you wrote the original software. If you use this software 29 in a product, an acknowledgment in the product documentation would be 30 appreciated but is not required. 31 2. Altered source versions must be plainly marked as such, and must not be 32 misrepresented as being the original software. 33 3. This notice may not be removed or altered from any source distribution. 34 35 --------------------------------------------------------------------------------- 36 37 Changes 38 39 See header of unzip64.c 40 41*/ 42 43#ifndef _unz64_H 44#define _unz64_H 45 46#ifdef __cplusplus 47extern "C" { 48#endif 49 50#ifndef _ZLIB_H 51#include "zlib.h" 52#endif 53 54#ifndef _ZLIBIOAPI_H 55#include "ioapi.h" 56#endif 57 58#ifdef HAVE_BZIP2 59#include "bzlib.h" 60#endif 61 62#define Z_BZIP2ED 12 63 64#if defined(STRICTUNZIP) || defined(STRICTZIPUNZIP) 65/* like the STRICT of WIN32, we define a pointer that cannot be converted 66 from (void*) without cast */ 67typedef struct TagunzFile__ { int unused; } unzFile__; 68typedef unzFile__ *unzFile; 69#else 70typedef voidp unzFile; 71#endif 72 73 74#define UNZ_OK (0) 75#define UNZ_END_OF_LIST_OF_FILE (-100) 76#define UNZ_ERRNO (Z_ERRNO) 77#define UNZ_EOF (0) 78#define UNZ_PARAMERROR (-102) 79#define UNZ_BADZIPFILE (-103) 80#define UNZ_INTERNALERROR (-104) 81#define UNZ_CRCERROR (-105) 82 83/* tm_unz contain date/time info */ 84typedef struct tm_unz_s 85{ 86 int tm_sec; /* seconds after the minute - [0,59] */ 87 int tm_min; /* minutes after the hour - [0,59] */ 88 int tm_hour; /* hours since midnight - [0,23] */ 89 int tm_mday; /* day of the month - [1,31] */ 90 int tm_mon; /* months since January - [0,11] */ 91 int tm_year; /* years - [1980..2044] */ 92} tm_unz; 93 94/* unz_global_info structure contain global data about the ZIPfile 95 These data comes from the end of central dir */ 96typedef struct unz_global_info64_s 97{ 98 ZPOS64_T number_entry; /* total number of entries in 99 the central dir on this disk */ 100 uLong size_comment; /* size of the global comment of the zipfile */ 101} unz_global_info64; 102 103typedef struct unz_global_info_s 104{ 105 uLong number_entry; /* total number of entries in 106 the central dir on this disk */ 107 uLong size_comment; /* size of the global comment of the zipfile */ 108} unz_global_info; 109 110/* unz_file_info contain information about a file in the zipfile */ 111typedef struct unz_file_info64_s 112{ 113 uLong version; /* version made by 2 bytes */ 114 uLong version_needed; /* version needed to extract 2 bytes */ 115 uLong flag; /* general purpose bit flag 2 bytes */ 116 uLong compression_method; /* compression method 2 bytes */ 117 uLong dosDate; /* last mod file date in Dos fmt 4 bytes */ 118 uLong crc; /* crc-32 4 bytes */ 119 ZPOS64_T compressed_size; /* compressed size 8 bytes */ 120 ZPOS64_T uncompressed_size; /* uncompressed size 8 bytes */ 121 uLong size_filename; /* filename length 2 bytes */ 122 uLong size_file_extra; /* extra field length 2 bytes */ 123 uLong size_file_comment; /* file comment length 2 bytes */ 124 125 uLong disk_num_start; /* disk number start 2 bytes */ 126 uLong internal_fa; /* internal file attributes 2 bytes */ 127 uLong external_fa; /* external file attributes 4 bytes */ 128 129 tm_unz tmu_date; 130} unz_file_info64; 131 132typedef struct unz_file_info_s 133{ 134 uLong version; /* version made by 2 bytes */ 135 uLong version_needed; /* version needed to extract 2 bytes */ 136 uLong flag; /* general purpose bit flag 2 bytes */ 137 uLong compression_method; /* compression method 2 bytes */ 138 uLong dosDate; /* last mod file date in Dos fmt 4 bytes */ 139 uLong crc; /* crc-32 4 bytes */ 140 uLong compressed_size; /* compressed size 4 bytes */ 141 uLong uncompressed_size; /* uncompressed size 4 bytes */ 142 uLong size_filename; /* filename length 2 bytes */ 143 uLong size_file_extra; /* extra field length 2 bytes */ 144 uLong size_file_comment; /* file comment length 2 bytes */ 145 146 uLong disk_num_start; /* disk number start 2 bytes */ 147 uLong internal_fa; /* internal file attributes 2 bytes */ 148 uLong external_fa; /* external file attributes 4 bytes */ 149 150 tm_unz tmu_date; 151} unz_file_info; 152 153extern int ZEXPORT unzStringFileNameCompare(const char* fileName1, 154 const char* fileName2, 155 int iCaseSensitivity); 156/* 157 Compare two filenames (fileName1,fileName2). 158 If iCaseSensitivity = 1, comparison is case sensitive (like strcmp) 159 If iCaseSensitivity = 2, comparison is not case sensitive (like strcmpi 160 or strcasecmp) 161 If iCaseSensitivity = 0, case sensitivity is default of your operating system 162 (like 1 on Unix, 2 on Windows) 163*/ 164 165 166extern unzFile ZEXPORT unzOpen(const char *path); 167extern unzFile ZEXPORT unzOpen64(const void *path); 168/* 169 Open a Zip file. path contain the full pathname (by example, 170 on a Windows XP computer "c:\\zlib\\zlib113.zip" or on an Unix computer 171 "zlib/zlib113.zip". 172 If the zipfile cannot be opened (file don't exist or in not valid), the 173 return value is NULL. 174 Else, the return value is a unzFile Handle, usable with other function 175 of this unzip package. 176 the "64" function take a const void* pointer, because the path is just the 177 value passed to the open64_file_func callback. 178 Under Windows, if UNICODE is defined, using fill_fopen64_filefunc, the path 179 is a pointer to a wide unicode string (LPCTSTR is LPCWSTR), so const char* 180 does not describe the reality 181*/ 182 183 184extern unzFile ZEXPORT unzOpen2(const char *path, 185 zlib_filefunc_def* pzlib_filefunc_def); 186/* 187 Open a Zip file, like unzOpen, but provide a set of file low level API 188 for read/write the zip file (see ioapi.h) 189*/ 190 191extern unzFile ZEXPORT unzOpen2_64(const void *path, 192 zlib_filefunc64_def* pzlib_filefunc_def); 193/* 194 Open a Zip file, like unz64Open, but provide a set of file low level API 195 for read/write the zip file (see ioapi.h) 196*/ 197 198extern int ZEXPORT unzClose(unzFile file); 199/* 200 Close a ZipFile opened with unzOpen. 201 If there is files inside the .Zip opened with unzOpenCurrentFile (see later), 202 these files MUST be closed with unzCloseCurrentFile before call unzClose. 203 return UNZ_OK if there is no problem. */ 204 205extern unzFile ZEXPORT unzOpenFile OF((FILE *inputfile)); 206/* 207 Open an opened zip file. 208*/ 209 210extern int ZEXPORT unzCloseFile OF((unzFile file)); 211/* 212 Close a ZipFile opened with unzOpenFile. 213 If there is files inside the .Zip opened with unzOpenCurrentFile(see before), 214 these files MUST be closed with unzCloseCurrentFile before call unzCloseFile. 215 return UNZ_OK if there is no problem. */ 216 217extern int ZEXPORT unzGetGlobalInfo(unzFile file, 218 unz_global_info *pglobal_info); 219 220extern int ZEXPORT unzGetGlobalInfo64(unzFile file, 221 unz_global_info64 *pglobal_info); 222/* 223 Write info about the ZipFile in the *pglobal_info structure. 224 No preparation of the structure is needed 225 return UNZ_OK if there is no problem. */ 226 227 228extern int ZEXPORT unzGetGlobalComment(unzFile file, 229 char *szComment, 230 uLong uSizeBuf); 231/* 232 Get the global comment string of the ZipFile, in the szComment buffer. 233 uSizeBuf is the size of the szComment buffer. 234 return the number of byte copied or an error code <0 235*/ 236 237 238/***************************************************************************/ 239/* Unzip package allow you browse the directory of the zipfile */ 240 241extern int ZEXPORT unzGoToFirstFile(unzFile file); 242/* 243 Set the current file of the zipfile to the first file. 244 return UNZ_OK if there is no problem 245*/ 246 247extern int ZEXPORT unzGoToNextFile(unzFile file); 248/* 249 Set the current file of the zipfile to the next file. 250 return UNZ_OK if there is no problem 251 return UNZ_END_OF_LIST_OF_FILE if the actual file was the latest. 252*/ 253 254extern int ZEXPORT unzLocateFile(unzFile file, 255 const char *szFileName, 256 int iCaseSensitivity); 257/* 258 Try locate the file szFileName in the zipfile. 259 For the iCaseSensitivity signification, see unzStringFileNameCompare 260 261 return value : 262 UNZ_OK if the file is found. It becomes the current file. 263 UNZ_END_OF_LIST_OF_FILE if the file is not found 264*/ 265 266extern int ZEXPORT unzLocateFile2 OF((unzFile file, 267 const char *szFileName, 268 int iCaseSensitivity)); 269/* 270 Try locate the file szFileName in the zipfile, like unzLocateFile, but provide performance optimization. 271 For the iCaseSensitivity signification, see unzStringFileNameCompare 272 273 return value : 274 UNZ_OK if the file is found. It becomes the current file. 275 UNZ_END_OF_LIST_OF_FILE if the file is not found 276*/ 277 278/* ****************************************** */ 279/* Ryan supplied functions */ 280/* unz_file_info contain information about a file in the zipfile */ 281typedef struct unz_file_pos_s 282{ 283 uLong pos_in_zip_directory; /* offset in zip file directory */ 284 uLong num_of_file; /* # of file */ 285} unz_file_pos; 286 287extern int ZEXPORT unzGetFilePos( 288 unzFile file, 289 unz_file_pos* file_pos); 290 291extern int ZEXPORT unzGoToFilePos( 292 unzFile file, 293 unz_file_pos* file_pos); 294 295typedef struct unz64_file_pos_s 296{ 297 ZPOS64_T pos_in_zip_directory; /* offset in zip file directory */ 298 ZPOS64_T num_of_file; /* # of file */ 299} unz64_file_pos; 300 301extern int ZEXPORT unzGetFilePos64( 302 unzFile file, 303 unz64_file_pos* file_pos); 304 305extern int ZEXPORT unzGoToFilePos64( 306 unzFile file, 307 const unz64_file_pos* file_pos); 308 309/* ****************************************** */ 310 311extern int ZEXPORT unzGetCurrentFileInfo64(unzFile file, 312 unz_file_info64 *pfile_info, 313 char *szFileName, 314 uLong fileNameBufferSize, 315 void *extraField, 316 uLong extraFieldBufferSize, 317 char *szComment, 318 uLong commentBufferSize); 319 320extern int ZEXPORT unzGetCurrentFileInfo(unzFile file, 321 unz_file_info *pfile_info, 322 char *szFileName, 323 uLong fileNameBufferSize, 324 void *extraField, 325 uLong extraFieldBufferSize, 326 char *szComment, 327 uLong commentBufferSize); 328/* 329 Get Info about the current file 330 if pfile_info!=NULL, the *pfile_info structure will contain some info about 331 the current file 332 if szFileName!=NULL, the filename string will be copied in szFileName 333 (fileNameBufferSize is the size of the buffer) 334 if extraField!=NULL, the extra field information will be copied in extraField 335 (extraFieldBufferSize is the size of the buffer). 336 This is the Central-header version of the extra field 337 if szComment!=NULL, the comment string of the file will be copied in szComment 338 (commentBufferSize is the size of the buffer) 339*/ 340 341 342/** Addition for GDAL : START */ 343 344extern ZPOS64_T ZEXPORT unzGetCurrentFileZStreamPos64(unzFile file); 345 346/** Addition for GDAL : END */ 347 348 349/***************************************************************************/ 350/* for reading the content of the current zipfile, you can open it, read data 351 from it, and close it (you can close it before reading all the file) 352 */ 353 354extern int ZEXPORT unzOpenCurrentFile(unzFile file); 355/* 356 Open for reading data the current file in the zipfile. 357 If there is no error, the return value is UNZ_OK. 358*/ 359 360extern int ZEXPORT unzOpenCurrentFilePassword(unzFile file, 361 const char* password); 362/* 363 Open for reading data the current file in the zipfile. 364 password is a crypting password 365 If there is no error, the return value is UNZ_OK. 366*/ 367 368extern int ZEXPORT unzOpenCurrentFile2(unzFile file, 369 int* method, 370 int* level, 371 int raw); 372/* 373 Same than unzOpenCurrentFile, but open for read raw the file (not uncompress) 374 if raw==1 375 *method will receive method of compression, *level will receive level of 376 compression 377 note : you can set level parameter as NULL (if you did not want known level, 378 but you CANNOT set method parameter as NULL 379*/ 380 381extern int ZEXPORT unzOpenCurrentFile3(unzFile file, 382 int* method, 383 int* level, 384 int raw, 385 const char* password); 386/* 387 Same than unzOpenCurrentFile, but open for read raw the file (not uncompress) 388 if raw==1 389 *method will receive method of compression, *level will receive level of 390 compression 391 note : you can set level parameter as NULL (if you did not want known level, 392 but you CANNOT set method parameter as NULL 393*/ 394 395 396extern int ZEXPORT unzCloseCurrentFile(unzFile file); 397/* 398 Close the file in zip opened with unzOpenCurrentFile 399 Return UNZ_CRCERROR if all the file was read but the CRC is not good 400*/ 401 402extern int ZEXPORT unzReadCurrentFile(unzFile file, 403 voidp buf, 404 unsigned len); 405/* 406 Read bytes from the current file (opened by unzOpenCurrentFile) 407 buf contain buffer where data must be copied 408 len the size of buf. 409 410 return the number of byte copied if some bytes are copied 411 return 0 if the end of file was reached 412 return <0 with error code if there is an error 413 (UNZ_ERRNO for IO error, or zLib error for uncompress error) 414*/ 415 416extern z_off_t ZEXPORT unztell(unzFile file); 417 418extern ZPOS64_T ZEXPORT unztell64(unzFile file); 419/* 420 Give the current position in uncompressed data 421*/ 422 423extern int ZEXPORT unzeof(unzFile file); 424/* 425 return 1 if the end of file was reached, 0 elsewhere 426*/ 427 428extern int ZEXPORT unzGetLocalExtrafield(unzFile file, 429 voidp buf, 430 unsigned len); 431/* 432 Read extra field from the current file (opened by unzOpenCurrentFile) 433 This is the local-header version of the extra field (sometimes, there is 434 more info in the local-header version than in the central-header) 435 436 if buf==NULL, it return the size of the local extra field 437 438 if buf!=NULL, len is the size of the buffer, the extra header is copied in 439 buf. 440 the return value is the number of bytes copied in buf, or (if <0) 441 the error code 442*/ 443 444/***************************************************************************/ 445 446/* Get the current file offset */ 447extern ZPOS64_T ZEXPORT unzGetOffset64 (unzFile file); 448extern uLong ZEXPORT unzGetOffset (unzFile file); 449 450/* Set the current file offset */ 451extern int ZEXPORT unzSetOffset64 (unzFile file, ZPOS64_T pos); 452extern int ZEXPORT unzSetOffset (unzFile file, uLong pos); 453 454 455 456#ifdef __cplusplus 457} 458#endif 459 460#endif /* _unz64_H */ 461