Zip Class Reference

Zip file compression. More...

#include <zip.h>

Collaboration diagram for Zip:

Public Types
enum	ErrorCode {   Ok , ZlibInit , ZlibError , FileExists ,   OpenFailed , NoOpenArchive , FileNotFound , ReadFailed ,   WriteFailed , SeekFailed }
enum	CompressionLevel {   Store , Deflate1 = 1 , Deflate2 , Deflate3 ,   Deflate4 , Deflate5 , Deflate6 , Deflate7 ,   Deflate8 , Deflate9 , AutoCPU , AutoMIME ,   AutoFull }
enum	CompressionOption { RelativePaths = 0x0001 , AbsolutePaths = 0x0002 , IgnorePaths = 0x0004 }

Public Member Functions
	Zip ()
virtual	~Zip ()
bool	isOpen () const
void	setPassword (const QString &pwd)
void	clearPassword ()
	Convenience method, clears the current password.
QString	password () const
	Returns the currently used password.
ErrorCode	createArchive (const QString &file, bool overwrite=true)
ErrorCode	createArchive (QIODevice *device)
QString	archiveComment () const
void	setArchiveComment (const QString &comment)
ErrorCode	addDirectoryContents (const QString &path, CompressionLevel level=AutoFull)
ErrorCode	addDirectoryContents (const QString &path, const QString &root, CompressionLevel level=AutoFull)
ErrorCode	addDirectory (const QString &path, CompressionOptions options=RelativePaths, CompressionLevel level=AutoFull)
ErrorCode	addDirectory (const QString &path, const QString &root, CompressionLevel level=AutoFull)
ErrorCode	addDirectory (const QString &path, const QString &root, CompressionOptions options=RelativePaths, CompressionLevel level=AutoFull)
ErrorCode	closeArchive ()
QString	formatError (ErrorCode c) const

Private Attributes
ZipPrivate *	d

Detailed Description

Zip file compression.

Some quick usage examples.

Suppose you have this directory structure:

/root/dir1/
/root/dir1/file1.1
/root/dir1/file1.2
/root/dir1/dir1.1/
/root/dir1/dir1.2/file1.2.1

EXAMPLE 1:
myZipInstance.addDirectory("/root/dir1");

RESULT:
Beheaves like any common zip software and creates a zip file with this structure:

dir1/
dir1/file1.1
dir1/file1.2
dir1/dir1.1/
dir1/dir1.2/file1.2.1

EXAMPLE 2:
myZipInstance.addDirectory("/root/dir1", "myRoot/myFolder");

RESULT:
Adds a custom root to the paths and creates a zip file with this structure:

myRoot/myFolder/dir1/
myRoot/myFolder/dir1/file1.1
myRoot/myFolder/dir1/file1.2
myRoot/myFolder/dir1/dir1.1/
myRoot/myFolder/dir1/dir1.2/file1.2.1

EXAMPLE 3:
myZipInstance.addDirectory("/root/dir1", Zip::AbsolutePaths);

NOTE:
Same as calling addDirectory(SOME_PATH, PARENT_PATH_of_SOME_PATH).

RESULT:
Preserves absolute paths and creates a zip file with this structure:

/root/dir1/
/root/dir1/file1.1
/root/dir1/file1.2
/root/dir1/dir1.1/
/root/dir1/dir1.2/file1.2.1

EXAMPLE 4:
myZipInstance.setPassword("hellopass");
myZipInstance.addDirectory("/root/dir1", "/");

RESULT:
Adds and encrypts the files in /root/dir1, creating the following zip structure:

/dir1/
/dir1/file1.1
/dir1/file1.2
/dir1/dir1.1/
/dir1/dir1.2/file1.2.1

Definition at line 45 of file zip.h.

Member Enumeration Documentation

CompressionLevel

enum CompressionLevel

Returns the result of a decompression operation. \value Zip::Store No compression. \value Zip::Deflate1 Deflate compression level 1(lowest compression). \value Zip::Deflate1 Deflate compression level 2. \value Zip::Deflate1 Deflate compression level 3. \value Zip::Deflate1 Deflate compression level 4. \value Zip::Deflate1 Deflate compression level 5. \value Zip::Deflate1 Deflate compression level 6. \value Zip::Deflate1 Deflate compression level 7. \value Zip::Deflate1 Deflate compression level 8. \value Zip::Deflate1 Deflate compression level 9 (maximum compression). \value Zip::AutoCPU Adapt compression level to CPU speed (faster CPU => better compression). \value Zip::AutoMIME Adapt compression level to MIME type of the file being compressed. \value Zip::AutoFull Use both CPU and MIME type detection.

Enumerator
Store
Deflate1
Deflate2
Deflate3
Deflate4
Deflate5
Deflate6
Deflate7
Deflate8
Deflate9
AutoCPU
AutoMIME
AutoFull

Definition at line 62 of file zip.h.

  {
    Store,
    Deflate1 = 1, Deflate2, Deflate3, Deflate4,
    Deflate5, Deflate6, Deflate7, Deflate8, Deflate9,
    AutoCPU, AutoMIME, AutoFull
  };

CompressionOption

enum CompressionOption

Enumerator
RelativePaths	Does not preserve absolute paths in the zip file when adding a file/directory (default)
AbsolutePaths	Preserve absolute paths.
IgnorePaths	Do not store paths. All the files are put in the (evtl. user defined) root of the zip file.

Definition at line 70 of file zip.h.

  {
    //! Does not preserve absolute paths in the zip file when adding a file/directory (default)
    RelativePaths = 0x0001,
    //! Preserve absolute paths
    AbsolutePaths = 0x0002,
    //! Do not store paths. All the files are put in the (evtl. user defined) root of the zip file
    IgnorePaths = 0x0004
  };

ErrorCode

enum ErrorCode

The result of a compression operation. \value Zip::Ok No error occurred. \value Zip::ZlibInit Failed to init or load the zlib library. \value Zip::ZlibError The zlib library returned some error. \value Zip::FileExists The file already exists and will not be overwritten. \value Zip::OpenFailed Unable to create or open a device. \value Zip::NoOpenArchive CreateArchive() has not been called yet. \value Zip::FileNotFound File or directory does not exist. \value Zip::ReadFailed Reading of a file failed. \value Zip::WriteFailed Writing of a file failed. \value Zip::SeekFailed Seek failed.

Enumerator
Ok
ZlibInit
ZlibError
FileExists
OpenFailed
NoOpenArchive
FileNotFound
ReadFailed
WriteFailed
SeekFailed

Definition at line 48 of file zip.h.

  {
    Ok,
    ZlibInit,
    ZlibError,
    FileExists,
    OpenFailed,
    NoOpenArchive,
    FileNotFound,
    ReadFailed,
    WriteFailed,
    SeekFailed
  };

Constructor & Destructor Documentation

Zip()

Zip

(

)

Creates a new Zip file compressor.

Definition at line 218 of file zip.cpp.

{
  d = new ZipPrivate;
}

~Zip()

~Zip ( )

virtual

Closes any open archive and releases used resources.

Definition at line 226 of file zip.cpp.

{
  closeArchive();
  delete d;
}

Here is the call graph for this function:

Member Function Documentation

addDirectory() [1/3]

Zip::ErrorCode addDirectory	(	const QString &	path,
		CompressionOptions	options = RelativePaths,
		CompressionLevel	level = AutoFull
	)

Convenience method, same as calling Zip::addDirectory(const QString&,const QString&,CompressionLevel) with an empty root parameter (or with the parent directory of path if the AbsolutePaths options is set).

The ExtractionOptions are checked in the order they are defined in the zip.h heaser file. This means that the last one overwrites the previous one (if some conflict occurs), i.e. Zip::IgnorePaths | Zip::AbsolutePaths would be interpreted as Zip::IgnorePaths.

Definition at line 333 of file zip.cpp.

{
  return addDirectory(path, QString(), options, level);
}

Referenced by addDirectory(), addDirectory(), addDirectory(), addDirectoryContents(), addDirectoryContents(), and compress().

Here is the call graph for this function:

Here is the caller graph for this function:

addDirectory() [2/3]

Zip::ErrorCode addDirectory	(	const QString &	path,
		const QString &	root,
		CompressionLevel	level = AutoFull
	)

Convenience method, same as calling Zip::addDirectory(const QString&,const QString&,CompressionOptions,CompressionLevel) with the Zip::RelativePaths flag as compression option.

Definition at line 342 of file zip.cpp.

{
  return addDirectory(path, root, Zip::RelativePaths, level);
}

Here is the call graph for this function:

addDirectory() [3/3]

Zip::ErrorCode addDirectory	(	const QString &	path,
		const QString &	root,
		CompressionOptions	options = RelativePaths,
		CompressionLevel	level = AutoFull
	)

Recursively adds files contained in dir to the archive, using root as name for the root folder. Stops adding files if some error occurs.

The ExtractionOptions are checked in the order they are defined in the zip.h heaser file. This means that the last one overwrites the previous one (if some conflict occurs), i.e. Zip::IgnorePaths | Zip::AbsolutePaths would be interpreted as Zip::IgnorePaths.

The root parameter is ignored with the Zip::IgnorePaths parameter and used as path prefix (a trailing / is always added as directory separator!) otherwise (even with Zip::AbsolutePaths set!).

Definition at line 376 of file zip.cpp.

{
  // qDebug() << QString("addDir(path=%1, root=%2)").arg(path, root);
 
  // Bad boy didn't call createArchive() yet :)
  if (d->device == 0)
    return Zip::NoOpenArchive;
 
  QDir dir(path);
  if (!dir.exists())
    return Zip::FileNotFound;
 
  // Remove any trailing separator
  QString actualRoot = root.trimmed();
 
  // Preserve Unix root
  if (actualRoot != "/")
  {
    while (actualRoot.endsWith("/") || actualRoot.endsWith("\\"))
      actualRoot.truncate(actualRoot.length() - 1);
  }
 
  // QDir::cleanPath() fixes some issues with QDir::dirName()
  QFileInfo current(QDir::cleanPath(path));
 
  if (!actualRoot.isEmpty() && actualRoot != "/")
    actualRoot.append("/");
 
  /* This part is quite confusing and needs some test or check */
  /* An attempt to compress the / root directory evtl. using a root prefix should be a good test */
  if (options.testFlag(AbsolutePaths) && !options.testFlag(IgnorePaths))
  {
    QString absolutePath = d->extractRoot(path);
    if (!absolutePath.isEmpty() && absolutePath != "/")
      absolutePath.append("/");
    actualRoot.append(absolutePath);
  }
 
  if (!options.testFlag(IgnorePaths))
  {
    actualRoot = actualRoot.append(QDir(current.absoluteFilePath()).dirName());
    actualRoot.append("/");
  }
 
  // actualRoot now contains the path of the file relative to the zip archive
  // with a trailing /
 
  QFileInfoList list = dir.entryInfoList(
    QDir::Files |
    QDir::Dirs |
    QDir::NoDotAndDotDot |
    QDir::NoSymLinks);
 
  ErrorCode ec = Zip::Ok;
  bool filesAdded = false;
 
  CompressionOptions recursionOptions;
  if (options.testFlag(IgnorePaths))
    recursionOptions |= IgnorePaths;
  else recursionOptions |= RelativePaths;
 
  for (int i = 0; i < list.size() && ec == Zip::Ok; ++i)
  {
    QFileInfo info = list.at(i);
 
    if (info.isDir())
    {
      // Recursion :)
      ec = addDirectory(info.absoluteFilePath(), actualRoot, recursionOptions, level);
    }
    else
    {
      ec = d->createEntry(info, actualRoot, level);
      filesAdded = true;
    }
  }
 
 
  // We need an explicit record for this dir
  // Non-empty directories don't need it because they have a path component in the filename
  if (!filesAdded && !options.testFlag(IgnorePaths))
    ec = d->createEntry(current, actualRoot, level);
 
  return ec;
}

Here is the call graph for this function:

addDirectoryContents() [1/2]

Zip::ErrorCode addDirectoryContents	(	const QString &	path,
		CompressionLevel	level = AutoFull
	)

Convenience method, same as calling Zip::addDirectory(const QString&,const QString&,CompressionOptions,CompressionLevel) with the Zip::IgnorePaths flag as compression option and an empty root parameter.

Definition at line 351 of file zip.cpp.

{
  return addDirectory(path, QString(), IgnorePaths, level);
}

Here is the call graph for this function:

addDirectoryContents() [2/2]

Zip::ErrorCode addDirectoryContents	(	const QString &	path,
		const QString &	root,
		CompressionLevel	level = AutoFull
	)

Convenience method, same as calling Zip::addDirectory(const QString&,const QString&,CompressionOptions,CompressionLevel) with the Zip::IgnorePaths flag as compression option.

Definition at line 360 of file zip.cpp.

{
  return addDirectory(path, root, IgnorePaths, level);
}

Here is the call graph for this function:

archiveComment()

QString archiveComment

(

)

const

Returns the current archive comment.

Definition at line 308 of file zip.cpp.

{
  return d->comment;
}

clearPassword()

void clearPassword

(

)

Convenience method, clears the current password.

Definition at line 252 of file zip.cpp.

{
  d->password.clear();
}

closeArchive()

Zip::ErrorCode closeArchive

(

)

Closes the archive and writes any pending data.

Definition at line 465 of file zip.cpp.

{
  Zip::ErrorCode ec = d->closeArchive();
  d->reset();
  return ec;
}

Referenced by compress(), and ~Zip().

Here is the call graph for this function:

Here is the caller graph for this function:

createArchive() [1/2]

Zip::ErrorCode createArchive	(	const QString &	filename,
		bool	overwrite = true
	)

Attempts to create a new Zip archive. If overwrite is true and the file already exist it will be overwritten. Any open archive will be closed.

Definition at line 268 of file zip.cpp.

{
  QFile* file = new QFile(filename);
 
  if (file->exists() && !overwrite) {
    delete file;
    return Zip::FileExists;
  }
 
  if (!file->open(QIODevice::WriteOnly)) {
    delete file;
    return Zip::OpenFailed;
  }
 
  Zip::ErrorCode ec = createArchive(file);
  if (ec != Zip::Ok) {
    file->remove();
  }
 
  return ec;
}

Referenced by compress(), and createArchive().

Here is the call graph for this function:

Here is the caller graph for this function:

createArchive() [2/2]

Zip::ErrorCode createArchive

(

QIODevice *

device

)

Attempts to create a new Zip archive. If there is another open archive this will be closed.

Warning

The class takes ownership of the device!

Definition at line 294 of file zip.cpp.

{
  if (device == 0)
  {
    qDebug() << "Invalid device.";
    return Zip::OpenFailed;
  }
 
  return d->createArchive(device);
}

Here is the call graph for this function:

formatError()

QString formatError

(

Zip::ErrorCode

c

)

const

Returns a locale translated error string for a given error code.

Definition at line 475 of file zip.cpp.

{
  switch (c)
  {
  case Ok: return QCoreApplication::translate("Zip", "ZIP operation completed successfully."); break;
  case ZlibInit: return QCoreApplication::translate("Zip", "Failed to initialize or load zlib library."); break;
  case ZlibError: return QCoreApplication::translate("Zip", "zlib library error."); break;
  case OpenFailed: return QCoreApplication::translate("Zip", "Unable to create or open file."); break;
  case NoOpenArchive: return QCoreApplication::translate("Zip", "No archive has been created yet."); break;
  case FileNotFound: return QCoreApplication::translate("Zip", "File or directory does not exist."); break;
  case ReadFailed: return QCoreApplication::translate("Zip", "File read error."); break;
  case WriteFailed: return QCoreApplication::translate("Zip", "File write error."); break;
  case SeekFailed: return QCoreApplication::translate("Zip", "File seek error."); break;
  default: ;
  }
 
  return QCoreApplication::translate("Zip", "Unknown error.");
}

Referenced by compress().

Here is the caller graph for this function:

isOpen()

bool isOpen

(

)

const

Returns true if there is an open archive.

Definition at line 235 of file zip.cpp.

{
  return d->device != 0;
}

password()

QString password

(

)

const

Returns the currently used password.

Definition at line 258 of file zip.cpp.

{
  return d->password;
}

setArchiveComment()

void setArchiveComment

(

const QString &

comment

)

Sets the comment for this archive. Note: createArchive() should have been called before.

Definition at line 317 of file zip.cpp.

{
  if (d->device != 0)
    d->comment = comment;
}

Referenced by compress().

Here is the caller graph for this function:

setPassword()

void setPassword

(

const QString &

pwd

)

Sets the password to be used for the next files being added! Files added before calling this method will use the previously set password (if any). Closing the archive won't clear the password!

Definition at line 246 of file zip.cpp.

{
  d->password = pwd;
}

Referenced by compress().

Here is the caller graph for this function:

Member Data Documentation

d

ZipPrivate* d

private

Definition at line 108 of file zip.h.

Referenced by addDirectory(), archiveComment(), clearPassword(), closeArchive(), createArchive(), isOpen(), password(), setArchiveComment(), setPassword(), Zip(), and ~Zip().

---

The documentation for this class was generated from the following files:

• /exports/ffsm/src_latest/src/zip.h
• /exports/ffsm/src_latest/src/zip.cpp