ZIP archive. More...
#include <quazip/quazip.h>
Public Types | |
enum | Constants { MAX_FILE_NAME_LENGTH = 256 } |
Useful constants. More... | |
enum | Mode { mdNotOpen, mdUnzip, mdCreate, mdAppend, mdAdd } |
Open mode of the ZIP file. More... | |
enum | CaseSensitivity { csDefault = 0, csSensitive = 1, csInsensitive = 2 } |
Case sensitivity for the file names. More... | |
Public Member Functions | |
QuaZip () | |
Constructs QuaZip object. | |
QuaZip (const QString &zipName) | |
Constructs QuaZip object associated with ZIP file zipName. | |
~QuaZip () | |
Destroys QuaZip object. | |
bool | open (Mode mode, zlib_filefunc_def *ioApi=NULL) |
Opens ZIP file. | |
void | close () |
Closes ZIP file. | |
void | setFileNameCodec (QTextCodec *fileNameCodec) |
Sets the codec used to encode/decode file names inside archive. | |
void | setFileNameCodec (const char *fileNameCodecName) |
Sets the codec used to encode/decode file names inside archive. | |
QTextCodec * | getFileNameCodec () const |
Returns the codec used to encode/decode comments inside archive. | |
void | setCommentCodec (QTextCodec *commentCodec) |
Sets the codec used to encode/decode comments inside archive. | |
void | setCommentCodec (const char *commentCodecName) |
Sets the codec used to encode/decode comments inside archive. | |
QTextCodec * | getCommentCodec () const |
Returns the codec used to encode/decode comments inside archive. | |
QString | getZipName () const |
Returns the name of the ZIP file. | |
void | setZipName (const QString &zipName) |
Sets the name of the ZIP file. | |
Mode | getMode () const |
Returns the mode in which ZIP file was opened. | |
bool | isOpen () const |
Returns true if ZIP file is open, false otherwise. | |
int | getZipError () const |
Returns the error code of the last operation. | |
int | getEntriesCount () const |
Returns number of the entries in the ZIP central directory. | |
QString | getComment () const |
Returns global comment in the ZIP file. | |
void | setComment (const QString &comment) |
Sets global comment in the ZIP file. | |
bool | goToFirstFile () |
Sets the current file to the first file in the archive. | |
bool | goToNextFile () |
Sets the current file to the next file in the archive. | |
bool | setCurrentFile (const QString &fileName, CaseSensitivity cs=csDefault) |
Sets current file by its name. | |
bool | hasCurrentFile () const |
Returns true if the current file has been set. | |
bool | getCurrentFileInfo (QuaZipFileInfo *info) const |
Retrieves information about the current file. | |
QString | getCurrentFileName () const |
Returns the current file name. | |
unzFile | getUnzFile () |
Returns unzFile handle. | |
zipFile | getZipFile () |
Returns zipFile handle. |
ZIP archive.
This class implements basic interface to the ZIP archive. It can be used to read table contents of the ZIP archive and retreiving information about the files inside it.
You can also use this class to open files inside archive by passing pointer to the instance of this class to the constructor of the QuaZipFile class. But see QuaZipFile::QuaZipFile(QuaZip*, QObject*) for the possible pitfalls.
This class is indended to provide interface to the ZIP subpackage of the ZIP/UNZIP package as well as to the UNZIP subpackage. But currently it supports only UNZIP.
The use of this class is simple - just create instance using constructor, then set ZIP archive file name using setFile() function (if you did not passed the name to the constructor), then open() and then use different functions to work with it! Well, if you are paranoid, you may also wish to call close before destructing the instance, to check for errors on close.
You may also use getUnzFile() and getZipFile() functions to get the ZIP archive handle and use it with ZIP/UNZIP package API directly.
This class supports localized file names inside ZIP archive, but you have to set up proper codec with setCodec() function. By default, locale codec will be used, which is probably ok for UNIX systems, but will almost certainly fail with ZIP archives created in Windows. This is because Windows ZIP programs have strange habit of using DOS encoding for file names in ZIP archives. For example, ZIP archive with cyrillic names created in Windows will have file names in IBM866
encoding instead of WINDOWS-1251
. I think that calling one function is not much trouble, but for true platform independency it would be nice to have some mechanism for file name encoding auto detection using locale information. Does anyone know a good way to do it?
enum QuaZip::Constants |
enum QuaZip::Mode |
Open mode of the ZIP file.
mdNotOpen |
ZIP file is not open. This is the initial mode. |
mdUnzip |
ZIP file is open for reading files inside it. |
mdCreate |
ZIP file was created with open() call. |
mdAppend |
ZIP file was opened in append mode. This refers to |
mdAdd |
ZIP file was opened for adding files in the archive. |
Case sensitivity for the file names.
This is what you specify when accessing files in the archive. Works perfectly fine with any characters thanks to Qt's great unicode support. This is different from ZIP/UNZIP API, where only US-ASCII characters was supported.
QuaZip::QuaZip | ( | ) |
Constructs QuaZip object.
Call setName() before opening constructed object.
QuaZip::~QuaZip | ( | ) |
bool QuaZip::open | ( | Mode | mode, | |
zlib_filefunc_def * | ioApi = NULL | |||
) |
Opens ZIP file.
Argument ioApi specifies IO function set for ZIP/UNZIP package to use. See unzip.h, zip.h and ioapi.h for details. By passing NULL (the default) you just tell package to use the default API which works just fine on UNIX platforms. I have tried it on win32-g++ platform too and it seems it works fine there too, so I see no reason to use win32 IO API included in original ZIP/UNZIP package.
ZIP archive file name will be converted to 8-bit encoding using Qt's QFile::encodeName() function before passing it to the ZIP/UNZIP package API.
Returns true
if successful, false
otherwise.
Argument mode specifies open mode of the ZIP archive. See Mode for details. Note that there is zipOpen2() function in the ZIP/UNZIP API which accepts globalcomment argument, but it does not use it anywhere, so this open() function does not have this argument. See setComment() if you need to set global comment.
NULL
indicating an error. But to make things easier, quazip.h header defines additional error code UNZ_ERROROPEN
and getZipError() will return it if the open call of the ZIP/UNZIP API returns NULL
. References isOpen(), mdAdd, mdAppend, mdCreate, and mdUnzip.
Referenced by JlCompress::compressDir(), JlCompress::compressFile(), JlCompress::compressFiles(), JlCompress::extractDir(), JlCompress::extractFile(), JlCompress::extractFiles(), JlCompress::getFileList(), and QuaZipFile::open().
void QuaZip::close | ( | ) |
Closes ZIP file.
Call getZipError() to determine if the close was successful.
References mdAdd, mdAppend, mdCreate, mdNotOpen, and mdUnzip.
Referenced by QuaZipFile::close(), JlCompress::compressDir(), JlCompress::compressFile(), JlCompress::compressFiles(), JlCompress::extractDir(), JlCompress::extractFile(), JlCompress::extractFiles(), JlCompress::getFileList(), QuaZipFile::open(), and ~QuaZip().
void QuaZip::setFileNameCodec | ( | QTextCodec * | fileNameCodec | ) | [inline] |
Sets the codec used to encode/decode file names inside archive.
This is necessary to access files in the ZIP archive created under Windows with non-latin characters in file names. For example, file names with cyrillic letters will be in IBM866
encoding.
void QuaZip::setFileNameCodec | ( | const char * | fileNameCodecName | ) | [inline] |
Sets the codec used to encode/decode file names inside archive.
This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts. Equivalent to calling setFileNameCodec(QTextCodec::codecForName(codecName));
void QuaZip::setCommentCodec | ( | QTextCodec * | commentCodec | ) | [inline] |
Sets the codec used to encode/decode comments inside archive.
This codec defaults to locale codec, which is probably ok.
void QuaZip::setCommentCodec | ( | const char * | commentCodecName | ) | [inline] |
Sets the codec used to encode/decode comments inside archive.
This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts. Equivalent to calling setCommentCodec(QTextCodec::codecForName(codecName));
QString QuaZip::getZipName | ( | ) | const [inline] |
Returns the name of the ZIP file.
Returns null string if no ZIP file name has been set.
Referenced by QuaZipFile::getZipName().
void QuaZip::setZipName | ( | const QString & | zipName | ) |
Sets the name of the ZIP file.
Does nothing if the ZIP file is open.
Does not reset error code returned by getZipError().
References isOpen().
int QuaZip::getZipError | ( | ) | const [inline] |
Returns the error code of the last operation.
Returns UNZ_OK
if the last operation was successful.
Error code resets to UNZ_OK
every time you call any function that accesses something inside ZIP archive, even if it is const
(like getEntriesCount()). open() and close() calls reset error code too. See documentation for the specific functions for details on error detection.
Referenced by QuaZipFile::close(), JlCompress::compressDir(), JlCompress::compressFile(), JlCompress::compressFiles(), JlCompress::extractDir(), JlCompress::extractFile(), JlCompress::extractFiles(), QuaZipFile::getActualFileName(), QuaZipFile::getFileInfo(), JlCompress::getFileList(), and QuaZipFile::open().
int QuaZip::getEntriesCount | ( | ) | const |
Returns number of the entries in the ZIP central directory.
Returns negative error code in the case of error. The same error code will be returned by subsequent getZipError() call.
References mdUnzip.
void QuaZip::setComment | ( | const QString & | comment | ) | [inline] |
Sets global comment in the ZIP file.
Comment will be written to the archive on close operation.
bool QuaZip::goToFirstFile | ( | ) |
Sets the current file to the first file in the archive.
Returns true
on success, false
otherwise. Call getZipError() to get the error code.
References mdUnzip.
Referenced by JlCompress::getFileList(), and setCurrentFile().
bool QuaZip::goToNextFile | ( | ) |
Sets the current file to the next file in the archive.
Returns true
on success, false
otherwise. Call getZipError() to determine if there was an error.
Should be used only in QuaZip::mdUnzip mode.
UNZ_OK
instead of UNZ_END_OF_LIST_OF_FILE
. This is to make things like this easier: for(bool more=zip.goToFirstFile(); more; more=zip.goToNextFile()) { // do something } if(zip.getZipError()==UNZ_OK) { // ok, there was no error }
References mdUnzip.
Referenced by JlCompress::getFileList(), and setCurrentFile().
bool QuaZip::setCurrentFile | ( | const QString & | fileName, | |
CaseSensitivity | cs = csDefault | |||
) |
Sets current file by its name.
Returns true
if successful, false
otherwise. Argument cs specifies case sensitivity of the file name. Call getZipError() in the case of a failure to get error code.
This is not a wrapper to unzLocateFile() function. That is because I had to implement locale-specific case-insensitive comparison.
Here are the differences from the original implementation:
UNZ_OK
, not UNZ_END_OF_LIST_OF_FILE
(see also goToNextFile()).If fileName is null string then this function unsets the current file and return true
. Note that you should close the file first if it is open! See QuaZipFile::QuaZipFile(QuaZip*,QObject*) for the details.
Should be used only in QuaZip::mdUnzip mode.
References csDefault, getCurrentFileName(), goToFirstFile(), goToNextFile(), and mdUnzip.
Referenced by QuaZipFile::open().
bool QuaZip::getCurrentFileInfo | ( | QuaZipFileInfo * | info | ) | const |
Retrieves information about the current file.
Fills the structure pointed by info. Returns true
on success, false
otherwise. In the latter case structure pointed by info remains untouched. If there was an error, getZipError() returns error code.
Should be used only in QuaZip::mdUnzip mode.
Does nothing and returns false
in any of the following cases.
NULL
;In all these cases getZipError() returns UNZ_OK
since there is no ZIP/UNZIP API call.
References QuaZipFileInfo::comment, QuaZipFileInfo::compressedSize, QuaZipFileInfo::crc, QuaZipFileInfo::dateTime, QuaZipFileInfo::diskNumberStart, QuaZipFileInfo::externalAttr, QuaZipFileInfo::extra, QuaZipFileInfo::flags, hasCurrentFile(), QuaZipFileInfo::internalAttr, isOpen(), mdUnzip, QuaZipFileInfo::method, QuaZipFileInfo::name, QuaZipFileInfo::uncompressedSize, QuaZipFileInfo::versionCreated, and QuaZipFileInfo::versionNeeded.
Referenced by QuaZipFile::getFileInfo(), and JlCompress::getFileList().
QString QuaZip::getCurrentFileName | ( | ) | const |
Returns the current file name.
Equivalent to calling getCurrentFileInfo() and then getting name
field of the QuaZipFileInfo structure, but faster and more convenient.
Should be used only in QuaZip::mdUnzip mode.
References hasCurrentFile(), isOpen(), MAX_FILE_NAME_LENGTH, and mdUnzip.
Referenced by QuaZipFile::getActualFileName(), and setCurrentFile().
unzFile QuaZip::getUnzFile | ( | ) | [inline] |
Returns unzFile
handle.
You can use this handle to directly call UNZIP part of the ZIP/UNZIP package functions (see unzip.h).
Referenced by QuaZipFile::atEnd(), QuaZipFile::close(), QuaZipFile::csize(), QuaZipFile::open(), QuaZipFile::pos(), QuaZipFile::readData(), and QuaZipFile::usize().
zipFile QuaZip::getZipFile | ( | ) | [inline] |
Returns zipFile
handle.
You can use this handle to directly call ZIP part of the ZIP/UNZIP package functions (see zip.h). Warnings about the getUnzFile() function also apply to this function.
Referenced by QuaZipFile::close(), QuaZipFile::open(), and QuaZipFile::writeData().