XZip and XUnzip - Add zip and/or unzip to your app with no extra .lib or .dll

• Download source files - 154.3 KB

Introduction

I have already introduced XZip in a previous article. This article presents XZip and also XUnzip, which together allow you to add zip and unzip to your application without using any .lib or .dll.

First, let me acknowledge the work of Lucian Wischik, who took the many .c and .h files from Info-ZIP and produced the .cpp and .h files that XZip is based on.

XZip and XUnzip Features

Most of the functions are demonstrated in the XZip demo app. Here are the main ones:

• CreateZip() - Create a zip archive file.

//////////////////////////////////////////////////////////////////////////////
//
// CreateZip()
//
// Purpose:     Create a zip archive file
//
// Parameters:  z     - archive file name if flags is ZIP_FILENAME;  for other
//                       uses see below
//              len   - for memory (ZIP_MEMORY) should be the buffer size;
//                       for other uses, should be 0
//              flags - indicates usage, see below;  for files, this will be
//                       ZIP_FILENAME
//
// Returns:     HZIP  - non-zero if zip archive created ok, otherwise 0
//

• ZipAdd() - Add a file to a zip archive.

//////////////////////////////////////////////////////////////////////////////
//
// ZipAdd()
//
// Purpose:     Add a file to a zip archive
//
// Parameters: hz      - handle to an open zip archive
//             dstzn   - name used inside the zip archive to identify the file
//             src     - for a file (ZIP_FILENAME) this specifies the filename
//                        to be added to the archive;  for other uses, see 
//                        below
//             len     - for memory (ZIP_MEMORY) this specifies the buffer
//                        length;  for other uses, this should be 0
//             flags   - indicates usage, see below;  for files, this will be
//                        ZIP_FILENAME
//
// Returns:    ZRESULT - ZR_OK if success, otherwise some other value
//

• OpenZip() - Open an existing zip archive file.

//////////////////////////////////////////////////////////////////////////////
//
// OpenZip()
//
// Purpose:     Open an existing zip archive file
//
// Parameters:  z      - archive file name if flags is ZIP_FILENAME;  for 
//                        other uses see below
//              len    - for memory (ZIP_MEMORY) should be the buffer size;
//                       for other uses, should be 0
//              flags  - indicates usage, see below;  for files, this will be
//                       ZIP_FILENAME
//
// Returns:     HZIP   - non-zero if zip archive opened ok, otherwise 0
//

• GetZipItem() - Get information about an item in an open zip archive.

//////////////////////////////////////////////////////////////////////////////
//
// GetZipItem()
//
// Purpose:     Get information about an item in an open zip archive
//
// Parameters:  hz      - handle of open zip archive
//              index   - index number (0 based) of item in zip
//              ze      - pointer to a ZIPENTRY (if ANSI) or ZIPENTRYW struct
//                        (if Unicode)
//
// Returns:     ZRESULT - ZR_OK if success, otherwise some other value
//

• FindZipItem() - Find item by name and return information about it.

//////////////////////////////////////////////////////////////////////////////
//
// FindZipItem()
//
// Purpose:     Find item by name and return information about it
//
// Parameters:  hz      - handle of open zip archive
//              name    - name of file to look for inside zip archive
//              ic      - TRUE = case insensitive
//              index   - pointer to index number returned, or -1
//              ze      - pointer to a ZIPENTRY (if ANSI) or ZIPENTRYW struct
//                        (if Unicode)
//
// Returns:     ZRESULT - ZR_OK if success, otherwise some other value
//

• UnzipItem() - Find item by index and unzip it.

//////////////////////////////////////////////////////////////////////////////
//
// UnzipItem()
//
// Purpose:     Find item by index and unzip it
//
// Parameters:  hz      - handle of open zip archive
//              index   - index number of file to unzip
//              dst     - target file name of unzipped file
//              len     - for memory (ZIP_MEMORY. length of buffer;
//                        otherwise 0
//              flags   - indicates usage, see below;  for files, this will be
//                        ZIP_FILENAME
//
// Returns:     ZRESULT - ZR_OK if success, otherwise some other value
//

• CloseZip() - Close an open zip archive.

//////////////////////////////////////////////////////////////////////////////
//
// CloseZip()
//
// Purpose:     Close an open zip archive
//
// Parameters:  hz      - handle to an open zip archive
//
// Returns:     ZRESULT - ZR_OK if success, otherwise some other value
//

How To Use

To integrate XZip into your app, you first need to add following the files to your project:

• XZip.cpp
• XZip.h
• XUnzip.cpp
• XUnzip.h

If you include XZip in a project that uses precompiled headers, you must change C/C++ Precompiled Headers settings to Not using precompiled headers for XZip.cpp and XUnzip.cpp.

Next, include the header files XZip.h and XUnzip.h in appropriate project files. Now you are ready to start using XZip. There are many notes concerning usage of various functions in XZip.h and XUnzip.h. Please read all function headers for each function you wish to use.

Known Limitations

XZip and XUnzip have been tested only with files.

Demo App

The XZipTest.exe demo tests the APIs in XZip and XUnzip. Here is some of the output:

Frequently Asked Questions

1. Can I use XZip in non-MFC apps?
   Yes. It has been implemented to compile with any Win32 program.
2. When I try to include XZip.cpp in my MFC project, I get the compiler error XZip.cpp(2918) : fatal error C1010: unexpected end of file while looking for precompiled header directive. How can I fix this?
   When using XZip in project that uses precompiled headers, you must change C/C++ Precompiled Headers settings to Not using precompiled headers for XZip.cpp and XUnzip.cpp. Be sure to do this for All Configurations.

3. When I try to build the demo app, I get the linker error LINK : fatal error LNK1104: cannot open file "mfc42u.lib" Error executing link.exe. How can I fix this?
   The default installation options of Visual C++ v6.0 don't install the Unicode libraries of MFC, so you might get an error that mfc42u.lib or mfc42ud.lib cannot be found. You can fix this either by installing the Unicode libs from the VC++ install CD, or by going to Build | Set Active Configuration and selecting one of the non-Unicode configurations.

   

   You can configure the Visual Studio toolbars to include the Select Active Configuration combobox. This allows you to see at a glance what configuration you are working with.

4. I don't need the Zip/Unzip functions. Can I exclude XZip.cpp/XUnzip.cpp?
   Yes. You only need to include the .h/.cpp pair that you need.
5. Can we use XZip in our (shareware/commercial) app?
   Yes, you can use XZip without charge or license fee, providing you follow the Info-ZIP restrictions as defined in XZip.cpp.
6. Does XZip handle pipes? in-memory zipping?
   XZip has not been tested with anything other than files.
7. Can I use XZip in a VS2005 project?
   Yes. There is a sample VS2005 project included in the download.
8. Does XZip work on Vista?
   Yes.

Acknowledgments

• The code in XZip.cpp and XUnzip.cpp is included with the kind permission of Lucian Wischik. It is based on code from Info-ZIP. Please see XZip.cpp for Info-ZIP's copyright and restrictions.
• The CXListBox class is taken from my own article, XListBox - Owner-draw CListBox with selectable text and background colors.

Revision History

Version 1.3 - 2007 July 18

• Fixed problem with file size that is multiple of 16384, reported by Mathias Svensson.
• Fixed XZip to save file time in local time, suggested by Damir Valiulin.

Version 1.2 - 2007 June 30

• Added project for VS2005.
• Added AddFolderContent() contributed by Renaud Deysine.
• Fixed problem with TUnzip::Open() reported by Pete Howells. Open() now returns correct success code.
• Fixed several bugs reported by Warren Stevens.
• Fixed a problem in unzReadCurrentFile() reported by Kochise.
• Fixed bug in EnsureDirectory() reported by craigmj.
• Changed ideflate() suggested by Michael B. Hansen.
• Fixed problem with time_t reported by Ronney.
• Fixed problems found by Boundschecker as reported by Warren Stevens.
• Made changes to PUTSHORT and PUTBYTE macros and to TZip::write(), suggested by vielheit.

Version 1.1 - 2003 May 7

• Initial public release

Usage

This software is released into the public domain. You are free to use it in any way you like, except that you may not sell this source code. If you modify it or extend it, please to consider posting new code here for everyone to share. This software is provided "as is" with no expressed or implied warranty. I accept no liability for any damage or loss of business that this software may cause.

You must Sign In to use this message board.

FAQ    Noise Tolerance Very HighHighMediumLowVery Low   Layout Expand Posts & RepliesThread ViewNo JavascriptNo JS + Preview   Per page 102550

Msgs 1 to 25 of 163 (Total in Forum: 163) (Refresh) FirstPrevNext

Question about usage with Qt, MinGw + gcc (cross-plattform code) Member 953718 0:29 7 May '09   Hello, first of all...this code is a great thing, but i wonder how to use all the stuff written on Unix too. At the moment i develop a small project with QtCreator on windows, but the source is completely windows independant and can be compiled on Unix without any code changes. And maybe some of the ppl here had same problems and created a source package with all needed changes? Otherwise i bite the bullet and work out a solution by myself (why to reinvent the wheel ^^) so long Sebastian Sign In·View Thread·PermaLink Showing progress of zip operation Aljechin 2:00 5 May '09   Hi, is there a way to show a progress to the user when a lengthy compression operation is happening? May be a callback function? Sign In·View Thread·PermaLink Bug for time convert babiq 23:29 11 Feb '09   It seems current version has bug for filetime setting, if files are zipped by XZip, everything goes well, 'cause XZip save CTime ,ATime and MTime in its extra data field. but some other zip tools do not, they just use last mod file time/date in file header, when XZip unzip files zipped by other tools, filetimes will be wrong,especially for MTime, I think it's a most important time for a file. Following codes may clear this, I have tested only on NTFS,FAT not yet,please confirm it. ZRESULT TUnzip::Get(int index,ZIPENTRY *ze) // WORD dostime = (WORD)(ufi.dosDate&0xFFFF); WORD dosdate = (WORD)((ufi.dosDate>>16)&0xFFFF); FILETIME ft; DosDateTimeToFileTime(dosdate,dostime,&ft); /* new code line start*/ FILETIME utcft; LocalFileTimeToFileTime(&ft,&utcft); ze->atime=utcft; ze->ctime=utcft; ze->mtime=utcft; //ze->atime=ft; ze->ctime=ft; ze->mtime=ft; /* end */ Sign In·View Thread·PermaLink Few winapi calls away from WM compatibility Velja Radenkovic 7:22 6 Feb '09   Hello, Do you know that library almost works on Windows mobile. Parts that need to be altered are: setting file time and reading / writing to files. On WM calls like: CreateFile((const TCHAR*)dst, GENERIC_WRITE, 0, NULL, CREATE_ALWAYS, ze.attr, NULL); can cause trouble especially when unziping to storage cards. They can successfully be replaced with std calls. For example I replaced that one with std::ofstream . For file time I have no suggestions. BTW, thanks for sharing this. Velja Radenkovic www.lusys.net Sign In·View Thread·PermaLink 64-bit build issue (_USE_32BIT_TIME_T) Dale Fugier 9:53 19 Jan '09   Hi Hans, Thanks for posting this sample - looks like it could be useful. You may (or may not) already know of this, but when you compile an x64 build (with VC++ 2005), you get the following error: crtdefs.h(543) : fatal error C1189: #error : You cannot use 32-bit time_t (_USE_32BIT_TIME_T) with _WIN64 I have not tried to diagnose this - just though you might want know. Thanks, - Dale Sign In·View Thread·PermaLink filesize over 4gb Member 2665314 4:08 11 Jan '09   would be nice - but not work with filesize over 4gb ... sascha Sign In·View Thread·PermaLink Bug for UNICODE-build in ZipAdd() causes AddFolderContent() to fail tbrammer 0:54 20 Nov '08   Great work . But there's a bug in the UNICODE build: ZRESULT ZipAdd(HZIP hz, const TCHAR *dstzn, void *src, unsigned int len, DWORD flags) does the WideCharToMultiByte() conversion only for flags == ZIP_FILENAME. So it fails in AddFolderContent() where it is called with flags==ZIP_FOLDER. I think it should be like this: ZRESULT ZipAdd(HZIP hz, const TCHAR *dstzn, void *src, unsigned int len, DWORD flags) { if (hz == 0) { lasterrorZ = ZR_ARGS; return ZR_ARGS; } TZipHandleData *han = (TZipHandleData*)hz; if (han->flag != 2) { lasterrorZ = ZR_ZMODE; return ZR_ZMODE; } TZip *zip = han->zip; char szDest[MAX_PATH*2]; memset(szDest, 0, sizeof(szDest)); #ifdef _UNICODE // need to convert Unicode dest to ANSI int nActualChars = WideCharToMultiByte(CP_ACP, // code page 0, // performance and mapping flags (LPCWSTR) dstzn, // wide-character string -1, // number of chars in string szDest, // buffer for new string MAX_PATH*2-2, // size of buffer NULL, // default for unmappable chars NULL); // set when default char used if (nActualChars == 0) return ZR_ARGS; #else strcpy(szDest, dstzn); #endif if (flags == ZIP_FILENAME) lasterrorZ = zip->Add(szDest, src, len, flags); else lasterrorZ = zip->Add(szDest, src, len, flags); return lasterrorZ; } Sign In·View Thread·PermaLink How to show the progress? Member 1764448 22:28 17 Nov '08   Hello, how can i show progress while creating the zip-file? cause biger files (100mb) take long time to zip... thanks! Sign In·View Thread·PermaLink Can't Open ZIP File (Handle is NULL) HumanJHawkins 14:50 17 Oct '08   Hi, I am trying to use the following code to open a .zip file. The file exists at the path indicated. Can anyone see what is wrong here? #ifdef _UNICODE ZIPENTRYW ze; #else ZIPENTRY ze; #endif memset(&ze, 0, sizeof(ze)); TCHAR * pszZipPath = _T("C:\\Test.zip"); TCHAR * pszZipBook = _T("Test.txt"); int iZipFileIndex = -1; ZRESULT zrZipResult = 0; HZIP hz = OpenZip(&pszZipPath,0, ZIP_FILENAME); if (hz) { // I am never getting to this point... // ZIP always fails to open. } Many thanks in advance. Sign In·View Thread·PermaLink Re: Can't Open ZIP File (Handle is NULL) HumanJHawkins 7:40 20 Oct '08   Oops... Found it. The OpenZip line should have been: HZIP hz = OpenZip(pszZipPath, 0, ZIP_FILENAME); It works great now. Sign In·View Thread·PermaLink AddFolderContent bug... [modified] Mario M. 1:51 17 Oct '08   AddFolderContent does not add any file to ZIP if the zip location is not the current folder ...and here is the fix in XZip.cpp replace this if (ZipAdd(hZip, RelativePathNewFileFound, RelativePathNewFileFound, 0, ZIP_FILENAME) != ZR_OK) { return FALSE; } with this TCHAR tcFullPath[MAX_PATH]={0}; _tcscpy(tcFullPath, AbsolutePath); _tcscat(tcFullPath, _T("\\")); _tcscat(tcFullPath, RelativePathNewFileFound); if (ZipAdd(hZip, RelativePathNewFileFound, tcFullPath, 0, ZIP_FILENAME) != ZR_OK) { return FALSE; } modified on Friday, October 17, 2008 7:07 AM Sign In·View Thread·PermaLink 2.00/5 (1 vote) When Pulling One File from a .Zip, is whole .zip in memory? HumanJHawkins 14:49 16 Oct '08   Specifically when working over a typical Windows network... If there is a .zip with 1000+ little files and I retrieve one file from it, will this use only the bandwith to retrieve the one file (plus a little for overhead if necessary)? Or, does it need to pull the whole file down to work with it? Thanks in advance. Sign In·View Thread·PermaLink 2.00/5 (1 vote) How to retrieve the whole ZIP size in MEMORY mode? Frank Isensee 23:28 8 Oct '08   Hi, Hans, when i use ZIP_FILENAME i can retrieve the size of the result (whatever compressing or decompressing) by retrieving the filesize after CloseZIP. But when using the mode ZIP_MEMORY how can i retrieve the whole size of the compressed (or uncompressed) data which are stored in the buffer?? e.g. when i supply the call of CreateZip with a pointer to a buffer with 100 KB and now i want to compressed data of 80 KB how can i retrieve the size of the ZIP archiv in the buffer (total, with headers, entries ...) ? The same question for decompressing ... Thanx for a hint! Greetings from germany! Frank Sign In·View Thread·PermaLink Solved! Frank Isensee 0:18 9 Oct '08   ... by accident i found the method ZRESULT ZipGetMemory(HZIP hz, void **buf, unsigned long *len); which is the solution for me. @Hans: Because i think this is an important method when using this class in memory mode you should add this method explicit to the documentation in the article ... Greetings from germany! Frank Sign In·View Thread·PermaLink Can it handle passwords? Green Fuze 22:42 3 Aug '08   First of all - great job! Can I use this class to zip/unzip with passwords (thus encrypting the data) ??? Thanks!!! Sign In·View Thread·PermaLink 4.00/5 (3 votes) Incorrect return value from unzReadCurrentFile _Stilgar_ 14:36 12 Jul '08   Hans, First, thank you for a very useful class. I am trying to use it for a large archive (10k+ files, binary and text), and so far the results are fine. However, I'm encountering an error with XUnzip. I'm using the following code: #ifdef _UNICODE ZIPENTRYW ze; #else ZIPENTRY ze; #endif memset(&ze, 0, sizeof(ze)); int index = -1; ZRESULT zr = 0; zr = FindZipItem(hz, itemId, FALSE, &index, &ze); if (!(*buf) || (bufLen > ze.unc_size)) { if (*buf) delete[] *buf; bufLen = ze.unc_size + 1; *buf = new char[bufLen]; } zr = UnzipItem(hz, index, *buf, bufLen, ZIP_MEMORY); if (zr != ZR_OK) { TRACE(_T("UnzipItem failed for %s\r\n"), itemId); } UnzipItem always fails. I dug a bit into your code, and found this line to be the problem (XUnzip.cpp, line 3676): if (err==Z_STREAM_END) return (iRead==0) ? UNZ_EOF : iRead; //+++1.3 For some reason, even though the whole stream was read and deflated, unzReadCurrentFile was returning non-zero value, which is being interpretted as an incomplete operation by Unzip(). My solution (hack?) was to change the iRead==0 condition to be iRead < len (since len may be larger than iRead, for example when the buffer is larger than the stream you are trying to read). I might be overseing something here, so would love to hear your comment on this. Also, as indicated by someone else on this thread, XUnzip can be painfully slow with large ZIP files (10k+ files). Other tools like Total Commander and WinRAR seem to unzip much faster than XUnzip does. I've found the culprit to be in unzLocateFile (called by FindZipItem) - it seem to go through all files in the archive and compare their name with the requested file. I bet there's a better approach available with the ZIP format? also, this could be optimized by loading the files table into a memory-based map, or at least support faster searching for files that are in a zip with alphabettic sorted files. Would like to hear your thoughts on this one as well. Cheers, Stilgar. Sign In·View Thread·PermaLink Re: Incorrect return value from unzReadCurrentFile Hans Dietrich 18:23 12 Jul '08   Hi Stilgar, Your first comment about the line if (err==Z_STREAM_END) return (iRead==0) ? UNZ_EOF : iRead; //+++1.3 is correct. What you say makes sense, but unfortunately doesn't work. I changed it, then had to change it back (notice the 1.3). If you want to experiment, please feel free - but be sure to run the validation tests on any changes you make. The history of XZip is told in the file header. It has been modified, and then modified some more, and I would not try to make any major changes unless I was prepared to do a complete rewrite. I think some of the initial design integrity has been lost in all the changes. If you are willing to make the effort, I think it is possible to make significant improvement. I hope you will consider this, since you seem to be able to analyze the code in depth. Best wishes, Hans [CodeProject Forum Guidelines] [How To Ask A Question] [My Articles] Sign In·View Thread·PermaLink Re: Incorrect return value from unzReadCurrentFile _Stilgar_ 1:35 14 Jul '08   It worked for my use case, that is all I needed... Unfortunately I cannot afford spending any more time on this, this being a very small part in the project I'm working on... I've found another solution at CP that wraps zlib, and has a much faster seeking. It still lacks several things I need, but the basic seem very solid. Also, I think using a zlib wrapper is much safer than having a custom written class that may be inconsistent with the ZIP format - probably exactly what is happening with your code. Stilgar. Sign In·View Thread·PermaLink Edit a zip-file Karl Runmo 11:40 16 Apr '08   I assume that a zip file contain a bounch of individually zipped blobs representing the individually files. Would it not be possible to open an existing zip file and "re-assemble" it excluding some of the files, to have the functionality of removing a file from an archive. I am using this zip-function to add application day logs and replacing each log every 30 day. But to replace a log, I create a temporary new zip file, add 29 of the old days logs and finaly the new days log. There must be a way to do this without having to unzip and rezip each file? Thanks and regards Karl Sign In·View Thread·PermaLink 5.00/5 (1 vote) Adding comment to zip file Member 4444269 11:51 14 Feb '08   Hi! The code's great, and works really well for zipping - thanks, Hans. I'm now trying to add a text comment to associate with the zip file. How can I do this? I tried adding a string value to the comment variable of a TZipFileInfo object in the TZip::Add() method, but it does not seem to work: zfi.comment="abcd\0"; zfi.com=5; I also tried 'abcd', length = 4. Any ideas? Thanks, Kanika Sign In·View Thread·PermaLink 2.00/5 (2 votes) too slow for zips with many files tonim 5:40 12 Feb '08   If files in the zip are above 10000 any unzip is very slow if the file is close to the end of the file list. This is so even if index is supplied and FindZipItem is not used ... tonim Sign In·View Thread·PermaLink 1.00/5 (1 vote) Where are the Other comments ? Member 4279717 22:46 12 Dec '07   this new interface hide older comments ??? Sign In·View Thread·PermaLink Works beautifully... Anyone Know of Similar Code for VB? HumanJHawkins 6:22 7 Nov '07   This worked great, but now I have to use VB for a project that needs zip functionality... I'm spoiled by the simplicity of this. Anyone have any suggestions for something similar for VB? Thanks in advance. Sign In·View Thread·PermaLink Compilation Problem: 'HZIP' : undeclared identifier MausOnMars 0:19 18 Sep '07   Hello, I try to run my own Unzip example. But I get the following error when I compile my source. Error: Compiling... xZipOwnTest.cpp ....\XUnzip.h(91) : error C2065: 'HZIP' : undeclared identifier The source #include windows.h #include "stdafx.h" #include "XUnzip.h" using namespace System; int main(arrayString ^> ^args) { Console::WriteLine(L"bla"); return 0; } I included windows.h. What could be the problem? Thanks for your help. maus Sign In·View Thread·PermaLink 2.00/5 (2 votes) File Time problem MyKbyte 10:29 26 Jul '07   I found a problem using your code zipping and unzipping an archive results in a time shift of 1 hour for the modified date/time, this is UTC + 1 the time zone I'am in. When I unzip a compressed file which is created with MS. option 'Send to compressed file..' I even have a two hour shift, this is day-light saving time. I realy like to use your code but this will be a problem ?? Sign In·View Thread·PermaLink 2.00/5 (1 vote)

Last Visit: 9:55 21 Nov '09     Last Update: 9:55 21 Nov '09 1234567 Next »