KZip Class Reference
This class implements a kioslave to access zip files from KDE. A class for reading/writing zip archives. More...
#include <kzip.h>
Inheritance diagram for KZip:


Public Types | |
enum | ExtraField { NoExtraField = 0, ModificationTime = 1, DefaultExtraField = 1 } |
enum | Compression { NoCompression = 0, DeflateCompression = 1 } |
Public Member Functions | |
KZip (const QString &filename) | |
KZip (QIODevice *dev) | |
virtual | ~KZip () |
QString | fileName () |
void | setExtraField (ExtraField ef) |
ExtraField | extraField () const |
void | setCompression (Compression c) |
Compression | compression () const |
virtual bool | writeFile (const QString &name, const QString &user, const QString &group, uint size, const char *data) |
virtual bool | prepareWriting (const QString &name, const QString &user, const QString &group, uint size) |
bool | writeSymLink (const QString &name, const QString &target, const QString &user, const QString &group, mode_t perm, time_t atime, time_t mtime, time_t ctime) |
bool | prepareWriting (const QString &name, const QString &user, const QString &group, uint size, mode_t perm, time_t atime, time_t mtime, time_t ctime) |
bool | writeFile (const QString &name, const QString &user, const QString &group, uint size, mode_t perm, time_t atime, time_t mtime, time_t ctime, const char *data) |
bool | writeData (const char *data, uint size) |
virtual bool | doneWriting (uint size) |
Protected Member Functions | |
virtual bool | openArchive (int mode) |
virtual bool | closeArchive () |
virtual bool | writeDir (const QString &, const QString &, const QString &) |
virtual void | virtual_hook (int id, void *data) |
bool | writeData_impl (const char *data, uint size) |
bool | prepareWriting_impl (const QString &name, const QString &user, const QString &group, uint size, mode_t perm, time_t atime, time_t mtime, time_t ctime) |
bool | writeSymLink_impl (const QString &name, const QString &target, const QString &user, const QString &group, mode_t perm, time_t atime, time_t mtime, time_t ctime) |
Detailed Description
This class implements a kioslave to access zip files from KDE. A class for reading/writing zip archives.You can use it in IO_ReadOnly or in IO_WriteOnly mode, and it behaves just as expected. It can also be used in IO_ReadWrite mode, in this case one can append files to an existing zip archive. When you append new files, which are not yet in the zip, it works as expected, i.e. the files are appended at the end. When you append a file, which is already in the file, the reference to the old file is dropped and the new one is added to the zip - but the old data from the file itself is not deleted, it is still in the zipfile. so when you want to have a small and garbage-free zipfile, just read the contents of the appended zip file and write it to a new one in IO_WriteOnly mode. This is especially important when you don't want to leak information of how intermediate versions of files in the zip were looking. For more information on the zip fileformat go to http://www.pkware.com/products/enterprise/white_papers/appnote.html
- Author:
- Holger Schroeder <holger-kde@holgis.net>
- Since:
- 3.1
Definition at line 53 of file kzip.h.
Member Enumeration Documentation
|
Describes the contents of the "extra field" for a given file in the Zip archive.
Definition at line 89 of file kzip.h. Referenced by extraField(). |
|
Describes the compression type for a given file in the Zip archive.
Definition at line 112 of file kzip.h. Referenced by compression(). |
Constructor & Destructor Documentation
|
Creates an instance that operates on the given filename. using the compression filter associated to given mimetype.
|
|
Creates an instance that operates on the given device. The device can be compressed (KFilterDev) or not (QFile, etc.). WARNING: don't assume that giving a QFile here will decompress the file, in case it's compressed!
|
|
If the zip file is still opened, then it will be closed automatically by the destructor.
Definition at line 326 of file kzip.cpp. References KArchive::close(), KArchive::device(), QString::isEmpty(), and KArchive::isOpened(). |
Member Function Documentation
|
The name of the zip file, as passed to the constructor. Null if you used the QIODevice constructor.
|
|
Call this before writeFile or prepareWriting, to define what the next file to be written should have in its extra field.
|
|
The current type of "extra field" that will be used for new files.
Definition at line 1157 of file kzip.cpp. References ExtraField. |
|
Call this before writeFile or prepareWriting, to define whether the next files to be written should be compressed or not.
Definition at line 1142 of file kzip.cpp. References NoCompression. |
|
The current compression mode that will be used for new files.
Definition at line 1147 of file kzip.cpp. References Compression, DeflateCompression, and NoCompression. |
|
If an archive is opened for writing then you can add a new file using this function. This method takes the whole data at once.
Reimplemented from KArchive. Definition at line 818 of file kzip.cpp. References KArchive::mode(), KStdAccel::name(), and KArchive::writeFile(). |
|
Alternative method for writing: call prepareWriting(), then feed the data in small chunks using writeData(), and call doneWriting() when done.
Implements KArchive. Definition at line 836 of file kzip.cpp. References KStdAccel::name(). |
|
Writes a symbolic link to the archive if the archive must be opened for writing.
Reimplemented from KArchive. Definition at line 1054 of file kzip.cpp. References KStdAccel::name(), and KArchive::writeSymLink(). |
|
Here's another way of writing a file into an archive: Call prepareWriting, then call writeData() as many times as wanted then call doneWriting( totalSize ). For tar.gz files, you need to know the size before hand, it is needed in the header! For zip files, size isn't used. This method also allows some file metadata to be set. However, depending on the archive type not all metadata might be regarded.
Reimplemented from KArchive. Definition at line 845 of file kzip.cpp. References KStdAccel::name(), and KArchive::prepareWriting(). |
|
If an archive is opened for writing then you can add a new file using this function. If the file name is for example "mydir/test1" then the directory "mydir" is automatically appended first if that did not happen yet. This method also allows some file metadata to be set. However, depending on the archive type not all metadata might be regarded.
Reimplemented from KArchive. Definition at line 827 of file kzip.cpp. References KStdAccel::name(), and KArchive::writeFile(). |
|
Write data to a file that has been created using prepareWriting().
Reimplemented from KArchive. Definition at line 1121 of file kzip.cpp. References KArchive::writeData(). |
|
Write data to a file that has been created using prepareWriting().
Implements KArchive. Definition at line 1017 of file kzip.cpp. References QIODevice::at(), KArchive::device(), and ModificationTime. |
|
Opens the archive for reading. Parses the directory listing of the archive and creates the KArchiveDirectory/KArchiveFile entries.
Implements KArchive. Definition at line 337 of file kzip.cpp. References KArchiveDirectory::addEntry(), QIODevice::at(), QDir::cleanDirPath(), QFile::decodeName(), KArchive::device(), endl(), QString::endsWith(), KArchiveDirectory::entry(), KArchive::findOrCreate(), QString::findRev(), QAsciiDict::insert(), KArchiveEntry::isDirectory(), QString::isEmpty(), kdWarning(), QString::left(), QString::length(), QString::mid(), KStdAccel::name(), NoCompression, QIODevice::readBlock(), KArchive::rootDir(), QAsciiDict::setAutoDelete(), and KIO::symlink(). |
|
Closes the archive.
Implements KArchive. Definition at line 630 of file kzip.cpp. References QIODevice::at(), QPtrListIterator::current(), KArchive::device(), QFile::encodeName(), QCString::length(), KArchive::mode(), QPtrListIterator::toFirst(), and QIODevice::writeBlock(). |
|
If an archive is opened for writing then you can add new directories using this function. KArchive won't write one directory twice.
Implements KArchive. |
The documentation for this class was generated from the following files: