    Title:       Zip and Unzip in the MFC way
    Author:      Tadeusz Dracz
    Email:       tdracz@artpol.com.pl
    Environment: VC++ 6.0, MFC, Windows 95/98/NT/2000/Me
    Keywords:    Zip, Unzip, MFC
    Level:       Intermediate
    Description: The library to create, modify and extract zip archives
    Section      Miscellaneous
    SubSection   General

- Download source - 110 Kb
- Download demo project - 40 Kb

## Overview

This library allows creating, modifying and extracting zip archives in the compatible way with PKZIP (2.5 and higher) and WinZip. Supported are all possible operations on the zip archive: creating, extracting, adding, deleting files from the archive, modifications of the existing archive. There is also the support for creating and extracting multiple disk archives (on non-removable devices as well) and for password encryption and decryption. This module uses compression and decompression functions from zlib library by Jean-loup Gailly and Mark Adler.

## How to integrate with the project

Zip is a static library and statically links to compiled zlib.lib (version 1.13 nowadays). The zlib library can be replaced with a newer version providing you also replace the files: "zlib.h" and "zconf.h" in the Zip project. The Zip library uses MFC in a shared library as a Release and Debug Configuration. Your project must use MFC in the same way in the appropriate project configuration. You may need to adapt this to your needs. To add Zip library functionality to your project you need to link the library to the project. You can do this in at least two ways (in both cases you need to include ZipArchive.h header in your sources like this: #include "ZipArchive.h"):

#### Method 1

Add "..\Zip\debug(release)\Zip.lib" to Project Settings->Link->Input->Object/library modules and add Zip directory to the preprocessor searches (Project Settings -> C++ -> Preprocessor -> Additional include directories).

#### Method 2 (simpler)

Insert Zip project into workspace and set project dependencies (your project dependent on Zip project).

## How to use

The details about using this library are in the sources. The example available for download at the bottom of the page is an almost complete compression\decompression program. There are only main issues mentioned below about using this library. If you have a question about using the library and you can't find the answer here, don't hesitate to ask.

### Compression and decompression

There are some functions defined for fast operations on archive; among others: AddNewFile(), ExtractFile(), DeleteFile(). You only need to call functions Open() - before and Close() - after using them.
Remember to call Close() function when you finish working with CZipArchive class.

### Multi-disk archives

This library supports two kinds of multi-disk archives:
1. Disk spanning performed in the compatible way with all other main zip programs. It means that the archive can only be created on a removable device, the size of the volume is auto-detected and the label is written to the disk. To use this kind of disk spanning you need to define a static callback function for changing disks and set it with SetSpanCallback() function.
2. Disk spanning performed in the internal mode, called in the sources TD span mode. This allows creating multi disk archives also on non-removable devices and with user-defined volume size. There is no need to set callback function in this mode.

This two disk spanning modes create volumes with compatible internal structure. It means that you can easily convert the volumes created in one mode to the other one by renaming the files (in TD mode each volume but last has a number as an extension). To convert the archive from TD to PKZIP compatible archive, copy each file to the removable media, giving them the extension ".zip". You should also label each disk with the appropriate label starting from "pkback# 001".

There is a limited functions set available during work with multi-disk archives. Only adding is allowed when creating an archive and only extracting and testing when opening an existing one. Deleting files from these archives isn't allowed in any of these cases.

Class CZipArchive uses write buffer to make write operations extremely fast. You can change its size with SetAdvanced() function. While creating a multi-disk archive, set the size of the buffer to the maximum size of the volume for the best performance.

The popular archivers such as PKZIP and WinZip cannot operate on archive in TD span mode. You need to convert them to PKZIP span mode (have a look above). Remember about copying the files to the removable media (it does not comply with Winzip, which can extract a multi-disk archive from any media but only from the fixed location on the drive).

### Password encryption and decryption

This library supports creating and extracting of the password protected archives. There are several issues you should be aware of when using this feature. To set the password for the file to be added or extracted call the function SetPassword() with the password as the argument. To clear the password call this function without arguments or with an empty string argument. The function has no effect on a closed archive and on the currently opened file (whether new or existing) inside archive. During opening an archive the password is cleared and it is not changed if the file inside archive is opened. You can set different passwords for different files inside the same archive, but remember to set it BEFORE opening the file. You cannot use ASCII characters with codes above 127 in a password, if you do so, the function SetPassword() returns false and the password is cleared. If the password is cleared, no encryption or decryption take place.
You can find out what files are password encrypted by calling CZipArchive::GetFileInfo() which fills the structrure CZipFileHeader with data, and then the method IsEncrypted() of this structure. If it returns true, the file needs a password to extract.
The successful extraction of the encrypted file doesn't always mean that the password is correct. CZipArchive doesn't check for a crc if m_info.m_uUncomprLeft is not zero in the function CZipArchive::CloseFile(). In some cases bad password causes that this value is not zero, so you have to check also for the return value of this function (it returns -1 in this case). You can also check the size of the extracted file since it is smaller than it should be.

### Self extract support

The library automatically detects self-extracting archives. This is the simplest self-extract code :

    int APIENTRY WinMain(HINSTANCE hInstance,
    HINSTANCE hPrevInstance,
    LPSTR lpCmdLine,
    int nCmdShow)
    {
    	CZipArchive zip;

    	// get path of executable
    	TCHAR szBuff[_MAX_PATH];
    	if (!::GetModuleFileName(hInstance, szBuff, _MAX_PATH))
    		return -1;

    	CString szDest;
    	// ...
    	// add the code here to get the destination directory from the user
    	// for example:
    	/* CBrowseForFolder bf;
    	   bf.strTitle = _T("Select directory to extract files");
    	   if (!bf.GetFolder(szDest))
    	       return -1;
    	*/
    	// class CBrowseForFolder is included in the example project
    	// remember about including the header!

    	zip.Open(szBuff, CZipArchive::openReadOnly);
    	// openReadOnly mode is necessary for self extract archives
    	for (WORD i = 0; i < zip.GetNoEntries(); i++)
    		zip.ExtractFile(i, szDest);

    	zip.Close();
    	return 0;
    	// this code will not work for the encrypted archives since it is needed
    	// to get the password from the user ( a small addition to the
    	// existing code I suppose )
    }

After compiling it and appending a zip archive to it (e.g. with the DOS command: copy /b SelfExtract.exe + ZipFile.zip FinalFile.exe) we have a self extracting archive.

### Testing the integrity of the archive

The new functions has been provided to allow the testing of the integrity of the archive. The first one is CZipArchive::TestFile which is a comprehensive testing function, but if you need a different functionality, you can make your own by taking advantage of the second function provided: CZipArchive::CloseFileAfterTestFailed. The detailed description and the example of use are provided in the sources and in the example project.

### Exceptions

The library throws the following exceptions: CMemoryException, CFileExeption and CZipException. The first two don't need an explanation. The last is thrown when some internal error occurs. Handling them may be done in the following way:

    try
    {
    	// ...
    	// some operations on Zip library
    }
    catch (CException* e)
    {
    	if (e->IsKindOf( RUNTIME_CLASS( CZipException )))
    	{
    		CZipException* p = (CZipException*) e;
    		//... and so on
    	}
    	else if (e->IsKindOf( RUNTIME_CLASS( CFileException )))
    	{
    		CFileException* p = (CFileException*) e;
    		//... and so on
    	}
    	else
    	{
    		// the only possibility is a memory exception I suppose
    		//... and so on
    	}
    	e->Delete();
    }

### Handling the extra field

The extra field of the file can be different in the local and central headers. To set the extra filed in the local header set it in header parameter of CZipArchive::OpenNewFile function. After that the extra field is written to the local header and cleared. You should call CZipArchive::SetExtraField function anytime after opening the new file (but before closing it) to set the file extra field in the central directory.

### Sample application

To run the example, integrate first Zip library into it (Zip library is not included in the example, you must download it separately); you should be asked at the beginning about the location of the Zip project, if not, use one of the integration methods described above. If you don't put Zip library project at the same directory level what the sample application is, you also have to change the path pointing to ZipArchive.h in the file testzipdlgdlg.h.

### Linking errors

When you experience linking errors (mostly LNK2005) you need to make sure that the library and your program are both using single-threaded or both multithreaded library. The option "Project->Settings-> c/c++ ->Code Generation->Use run-time library" should be set to the same value in the ZipArchive library and the program project options.

If it doesn't help, try recompiling the zlib library ( zlib.lib provided with the project is compiled from a release configuration and using Multithreaded DLL run-time library ). You can download the zlib library sources from http://www.artpol-software.com/index_zip.html Use zlibstat project. Set "Use run-time library" option to the same value as you set it in ZipArchve library and your program configurations. Compile the Release configuration of the zlib library and replace with it the file zlib.lib in the ZipArchive folder. You may however experience linking warnings or errors while compiling the Debug configuration. To eliminate them do as follows:

- compile Debug and Release configuraions of the zlib library
- copy zlib_d.lib from Debug and zlib.lib from Release directories to the ZipArchive directory
- add these files to the ZipArchive project (Project -> Add To Project -> Files...)
- go to the project setting dialog (Project -> Settings)
- select debug configurations (Setting For -> Multiple Configurations) such as Debug and Unicode Debug
- select zlib.lib file, then the General tab, and check the box "Exclude file from build"
- select release configurations
- select zlib_.lib and exclude it from these builds

## To Do and updates

I currently work on the non-MFC version of the library and a multi-platform support. Make sure to check out the site http://www.artpol-software.com which is more likely to have an updated version.

## Downloads

Download source - 110 KB

Download example - 40 KB

## History

03.2001

- when the central directory was not located, the library throws CZipException::cdirNotFound,
  which allows distinguish from other exceptions (useful when we want to keep prompting
  the user to insert the last disk in a multi-disk spanning archive).

02.2001

Features added:
  - ability to reuse the archive after an exception thrown during extraction
  - added progress control possibilities to CZipArchive::AddNewFile, CZipArchive::ExtractFile, CZipArchive::TestFile

Changes:
  - CZipArchive::FindFile operation boosted ( thanks to Darin Warling for the idea)
  - library name changed to ZipArchive

Bugs fixed:
  - removed bug during extracting an encrypted file with 0 size
  - fixed bug when extracting a file with an extra field in a local file header (CZipFileHeader::ReadLocal)

01.2001

- Disk numbering in a disk spanning archive begins now from PKBACK# 001 not PKBACK# 000
- Adding and extracting without a full path possible in CZipArchive::AddNewFile and CZipArchive::ExtractFile.
- Several minor changes and enhancements
- Changed names for several classes.

11.2000

- Added support for password encryption and decryption. The encryption used in PKZIP was generously supplied by Roger Schlafly.
- Testing the archive made easier
- Unicode support added

08.2000

- Bugs fixed

06.2000

the code has been completely rewritten since the very beginning; the main improvements are:

- multi-disk archive support
- creation of the disk spanning archives with the user-defined volume size
- ability to modify existing archives (add, delete files)
- modification self-extracting archives
- write buffer used for faster disk write operations
- one class for zip and unzip functions
- fast adding, deleting and extracting files with a single function call

03.2000

- international characters in filenames inside archive are now converted in a compatible way with other archiving programs (they are stored converted to OEM inside archive).

01.2000

first version; it is just modified code from zip.c and unzip.c files written by Gilles Vollant and distributed with zlib library; the modifications are as follows:

- added class' wrappers
- several bugs fixed
- several enhancements added
- MFC support added
- memory leaks eliminated when write error occurred
- automatically free used memory on destruction or exception
- modern error notification using exceptions