1 /* unzip.h -- IO for uncompress .zip files using zlib 2 Version 1.01e, February 12th, 2005 3 4 Copyright (C) 1998-2005 Gilles Vollant 5 6 This unzip package allow extract file from .ZIP file, compatible with PKZip 2.04g 7 WinZip, InfoZip tools and compatible. 8 9 Multi volume ZipFile (span) are not supported. 10 Encryption compatible with pkzip 2.04g only supported 11 Old compressions used by old PKZip 1.x are not supported 12 13 14 I WAIT FEEDBACK at mail info@winimage.com 15 Visit also http://www.winimage.com/zLibDll/unzip.htm for evolution 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 38 /* for more info about .ZIP format, see 39 http://www.info-zip.org/pub/infozip/doc/appnote-981119-iz.zip 40 http://www.info-zip.org/pub/infozip/doc/ 41 PkWare has also a specification at : 42 ftp://ftp.pkware.com/probdesc.zip 43 */ 44 45 #ifndef _unz_H 46 #define _unz_H 47 48 #ifdef __cplusplus 49 extern "C" { 50 #endif 51 52 #include <zlib.h> 53 54 55 #ifndef _ZLIBIOAPI_H 56 #include "ioapi.h" 57 #endif 58 59 #if defined(STRICTUNZIP) || defined(STRICTZIPUNZIP) 60 /* like the STRICT of WIN32, we define a pointer that cannot be converted 61 from (void*) without cast */ 62 typedef struct TagunzFile__ { int unused; } unzFile__; 63 typedef unzFile__ *unzFile; 64 #else 65 typedef voidp unzFile; 66 #endif 67 68 69 #define UNZ_OK (0) 70 #define UNZ_END_OF_LIST_OF_FILE (-100) 71 #define UNZ_ERRNO (Z_ERRNO) 72 #define UNZ_EOF (0) 73 #define UNZ_PARAMERROR (-102) 74 #define UNZ_BADZIPFILE (-103) 75 #define UNZ_INTERNALERROR (-104) 76 #define UNZ_CRCERROR (-105) 77 78 /* tm_unz contain date/time info */ 79 typedef struct tm_unz_s 80 { 81 uInt tm_sec; /* seconds after the minute - [0,59] */ 82 uInt tm_min; /* minutes after the hour - [0,59] */ 83 uInt tm_hour; /* hours since midnight - [0,23] */ 84 uInt tm_mday; /* day of the month - [1,31] */ 85 uInt tm_mon; /* months since January - [0,11] */ 86 uInt tm_year; /* years - [1980..2044] */ 87 } tm_unz; 88 89 /* unz_global_info structure contain global data about the ZIPfile 90 These data comes from the end of central dir */ 91 typedef struct unz_global_info_s 92 { 93 uLong number_entry; /* total number of entries in 94 the central dir on this disk */ 95 uLong size_comment; /* size of the global comment of the zipfile */ 96 } unz_global_info; 97 98 99 /* unz_file_info contain information about a file in the zipfile */ 100 typedef struct unz_file_info_s 101 { 102 uLong version; /* version made by 2 bytes */ 103 uLong version_needed; /* version needed to extract 2 bytes */ 104 uLong flag; /* general purpose bit flag 2 bytes */ 105 uLong compression_method; /* compression method 2 bytes */ 106 uLong dosDate; /* last mod file date in Dos fmt 4 bytes */ 107 uLong crc; /* crc-32 4 bytes */ 108 uLong compressed_size; /* compressed size 4 bytes */ 109 uLong uncompressed_size; /* uncompressed size 4 bytes */ 110 uLong size_filename; /* filename length 2 bytes */ 111 uLong size_file_extra; /* extra field length 2 bytes */ 112 uLong size_file_comment; /* file comment length 2 bytes */ 113 114 uLong disk_num_start; /* disk number start 2 bytes */ 115 uLong internal_fa; /* internal file attributes 2 bytes */ 116 uLong external_fa; /* external file attributes 4 bytes */ 117 118 tm_unz tmu_date; 119 } unz_file_info; 120 121 extern int ZEXPORT unzStringFileNameCompare OF ((const char* fileName1, 122 const char* fileName2, 123 int iCaseSensitivity)); 124 /* 125 Compare two filename (fileName1,fileName2). 126 If iCaseSenisivity = 1, comparision is case sensitivity (like strcmp) 127 If iCaseSenisivity = 2, comparision is not case sensitivity (like strcmpi 128 or strcasecmp) 129 If iCaseSenisivity = 0, case sensitivity is defaut of your operating system 130 (like 1 on Unix, 2 on Windows) 131 */ 132 133 134 extern unzFile ZEXPORT unzOpen OF((const char *path)); 135 /* 136 Open a Zip file. path contain the full pathname (by example, 137 on a Windows XP computer "c:\\zlib\\zlib113.zip" or on an Unix computer 138 "zlib/zlib113.zip". 139 If the zipfile cannot be opened (file don't exist or in not valid), the 140 return value is NULL. 141 Else, the return value is a unzFile Handle, usable with other function 142 of this unzip package. 143 */ 144 145 extern unzFile ZEXPORT unzOpen2 OF((const char *path, 146 zlib_filefunc_def* pzlib_filefunc_def)); 147 /* 148 Open a Zip file, like unzOpen, but provide a set of file low level API 149 for read/write the zip file (see ioapi.h) 150 */ 151 152 extern int ZEXPORT unzClose OF((unzFile file)); 153 /* 154 Close a ZipFile opened with unzipOpen. 155 If there is files inside the .Zip opened with unzOpenCurrentFile (see later), 156 these files MUST be closed with unzipCloseCurrentFile before call unzipClose. 157 return UNZ_OK if there is no problem. */ 158 159 extern int ZEXPORT unzGetGlobalInfo OF((unzFile file, 160 unz_global_info *pglobal_info)); 161 /* 162 Write info about the ZipFile in the *pglobal_info structure. 163 No preparation of the structure is needed 164 return UNZ_OK if there is no problem. */ 165 166 167 extern int ZEXPORT unzGetGlobalComment OF((unzFile file, 168 char *szComment, 169 uLong uSizeBuf)); 170 /* 171 Get the global comment string of the ZipFile, in the szComment buffer. 172 uSizeBuf is the size of the szComment buffer. 173 return the number of byte copied or an error code <0 174 */ 175 176 177 /***************************************************************************/ 178 /* Unzip package allow you browse the directory of the zipfile */ 179 180 extern int ZEXPORT unzGoToFirstFile OF((unzFile file)); 181 /* 182 Set the current file of the zipfile to the first file. 183 return UNZ_OK if there is no problem 184 */ 185 186 extern int ZEXPORT unzGoToNextFile OF((unzFile file)); 187 /* 188 Set the current file of the zipfile to the next file. 189 return UNZ_OK if there is no problem 190 return UNZ_END_OF_LIST_OF_FILE if the actual file was the latest. 191 */ 192 193 extern int ZEXPORT unzLocateFile OF((unzFile file, 194 const char *szFileName, 195 int iCaseSensitivity)); 196 /* 197 Try locate the file szFileName in the zipfile. 198 For the iCaseSensitivity signification, see unzStringFileNameCompare 199 200 return value : 201 UNZ_OK if the file is found. It becomes the current file. 202 UNZ_END_OF_LIST_OF_FILE if the file is not found 203 */ 204 205 206 /* ****************************************** */ 207 /* Ryan supplied functions */ 208 /* unz_file_info contain information about a file in the zipfile */ 209 typedef struct unz_file_pos_s 210 { 211 uLong pos_in_zip_directory; /* offset in zip file directory */ 212 uLong num_of_file; /* # of file */ 213 } unz_file_pos; 214 215 extern int ZEXPORT unzGetFilePos( 216 unzFile file, 217 unz_file_pos* file_pos); 218 219 extern int ZEXPORT unzGoToFilePos( 220 unzFile file, 221 unz_file_pos* file_pos); 222 223 /* ****************************************** */ 224 225 extern int ZEXPORT unzGetCurrentFileInfo OF((unzFile file, 226 unz_file_info *pfile_info, 227 char *szFileName, 228 uLong fileNameBufferSize, 229 void *extraField, 230 uLong extraFieldBufferSize, 231 char *szComment, 232 uLong commentBufferSize)); 233 /* 234 Get Info about the current file 235 if pfile_info!=NULL, the *pfile_info structure will contain somes info about 236 the current file 237 if szFileName!=NULL, the filemane string will be copied in szFileName 238 (fileNameBufferSize is the size of the buffer) 239 if extraField!=NULL, the extra field information will be copied in extraField 240 (extraFieldBufferSize is the size of the buffer). 241 This is the Central-header version of the extra field 242 if szComment!=NULL, the comment string of the file will be copied in szComment 243 (commentBufferSize is the size of the buffer) 244 */ 245 246 /***************************************************************************/ 247 /* for reading the content of the current zipfile, you can open it, read data 248 from it, and close it (you can close it before reading all the file) 249 */ 250 251 extern int ZEXPORT unzOpenCurrentFile OF((unzFile file)); 252 /* 253 Open for reading data the current file in the zipfile. 254 If there is no error, the return value is UNZ_OK. 255 */ 256 257 extern int ZEXPORT unzOpenCurrentFilePassword OF((unzFile file, 258 const char* password)); 259 /* 260 Open for reading data the current file in the zipfile. 261 password is a crypting password 262 If there is no error, the return value is UNZ_OK. 263 */ 264 265 extern int ZEXPORT unzOpenCurrentFile2 OF((unzFile file, 266 int* method, 267 int* level, 268 int raw)); 269 /* 270 Same than unzOpenCurrentFile, but open for read raw the file (not uncompress) 271 if raw==1 272 *method will receive method of compression, *level will receive level of 273 compression 274 note : you can set level parameter as NULL (if you did not want known level, 275 but you CANNOT set method parameter as NULL 276 */ 277 278 extern int ZEXPORT unzOpenCurrentFile3 OF((unzFile file, 279 int* method, 280 int* level, 281 int raw, 282 const char* password)); 283 /* 284 Same than unzOpenCurrentFile, but open for read raw the file (not uncompress) 285 if raw==1 286 *method will receive method of compression, *level will receive level of 287 compression 288 note : you can set level parameter as NULL (if you did not want known level, 289 but you CANNOT set method parameter as NULL 290 */ 291 292 293 extern int ZEXPORT unzCloseCurrentFile OF((unzFile file)); 294 /* 295 Close the file in zip opened with unzOpenCurrentFile 296 Return UNZ_CRCERROR if all the file was read but the CRC is not good 297 */ 298 299 extern int ZEXPORT unzReadCurrentFile OF((unzFile file, 300 voidp buf, 301 unsigned len)); 302 /* 303 Read bytes from the current file (opened by unzOpenCurrentFile) 304 buf contain buffer where data must be copied 305 len the size of buf. 306 307 return the number of byte copied if somes bytes are copied 308 return 0 if the end of file was reached 309 return <0 with error code if there is an error 310 (UNZ_ERRNO for IO error, or zLib error for uncompress error) 311 */ 312 313 extern z_off_t ZEXPORT unztell OF((unzFile file)); 314 /* 315 Give the current position in uncompressed data 316 */ 317 318 extern int ZEXPORT unzeof OF((unzFile file)); 319 /* 320 return 1 if the end of file was reached, 0 elsewhere 321 */ 322 323 extern int ZEXPORT unzGetLocalExtrafield OF((unzFile file, 324 voidp buf, 325 unsigned len)); 326 /* 327 Read extra field from the current file (opened by unzOpenCurrentFile) 328 This is the local-header version of the extra field (sometimes, there is 329 more info in the local-header version than in the central-header) 330 331 if buf==NULL, it return the size of the local extra field 332 333 if buf!=NULL, len is the size of the buffer, the extra header is copied in 334 buf. 335 the return value is the number of bytes copied in buf, or (if <0) 336 the error code 337 */ 338 339 /***************************************************************************/ 340 341 /* Get the current file offset */ 342 extern uLong ZEXPORT unzGetOffset (unzFile file); 343 344 /* Set the current file offset */ 345 extern int ZEXPORT unzSetOffset (unzFile file, uLong pos); 346 347 348 349 #ifdef __cplusplus 350 } 351 #endif 352 353 #endif /* _unz_H */ 354