UnZip Class Reference

PKZip 2.0 file decompression. Compatibility with later versions is not ensured as they may use unsupported compression algorithms. Versions after 2.7 may have an incompatible header format and thus be completely incompatible. More...

#include <unzip.h>

Collaboration diagram for UnZip:

Classes
struct	ZipEntry

Public Types
enum	ErrorCode {   Ok , ZlibInit , ZlibError , OpenFailed ,   PartiallyCorrupted , Corrupted , WrongPassword , NoOpenArchive ,   FileNotFound , ReadFailed , WriteFailed , SeekFailed ,   CreateDirFailed , InvalidDevice , InvalidArchive , HeaderConsistencyError ,   Skip , SkipAll }
enum	ExtractionOption { ExtractPaths = 0x0001 , SkipPaths = 0x0002 }
enum	CompressionMethod { NoCompression , Deflated , UnknownCompression }
enum	FileType { File , Directory }

Public Member Functions
	UnZip ()
virtual	~UnZip ()
bool	isOpen () const
ErrorCode	openArchive (const QString &filename)
ErrorCode	openArchive (QIODevice *device)
void	closeArchive ()
QString	archiveComment () const
QString	formatError (UnZip::ErrorCode c) const
bool	contains (const QString &file) const
QStringList	fileList () const
QList< ZipEntry >	entryList () const
ErrorCode	extractAll (const QString &dirname, ExtractionOptions options=ExtractPaths)
ErrorCode	extractAll (const QDir &dir, ExtractionOptions options=ExtractPaths)
ErrorCode	extractFile (const QString &filename, const QString &dirname, ExtractionOptions options=ExtractPaths)
ErrorCode	extractFile (const QString &filename, const QDir &dir, ExtractionOptions options=ExtractPaths)
ErrorCode	extractFile (const QString &filename, QIODevice *device, ExtractionOptions options=ExtractPaths)
ErrorCode	extractFiles (const QStringList &filenames, const QString &dirname, ExtractionOptions options=ExtractPaths)
ErrorCode	extractFiles (const QStringList &filenames, const QDir &dir, ExtractionOptions options=ExtractPaths)
void	setPassword (const QString &pwd)

Private Attributes
UnzipPrivate *	d

Detailed Description

PKZip 2.0 file decompression. Compatibility with later versions is not ensured as they may use unsupported compression algorithms. Versions after 2.7 may have an incompatible header format and thus be completely incompatible.

Definition at line 45 of file unzip.h.

Member Enumeration Documentation

CompressionMethod

enum CompressionMethod

Enumerator
NoCompression
Deflated
UnknownCompression

Definition at line 79 of file unzip.h.

  {
    NoCompression, Deflated, UnknownCompression
  };

ErrorCode

enum ErrorCode

The result of a decompression operation. \value UnZip::Ok No error occurred. \value UnZip::ZlibInit Failed to init or load the zlib library. \value UnZip::ZlibError The zlib library returned some error. \value UnZip::OpenFailed Unable to create or open a device. \value UnZip::PartiallyCorrupted Corrupted zip archive - some files could be extracted. \value UnZip::Corrupted Corrupted or invalid zip archive. \value UnZip::WrongPassword Unable to decrypt a password protected file. \value UnZip::NoOpenArchive No archive has been opened yet. \value UnZip::FileNotFound Unable to find the requested file in the archive. \value UnZip::ReadFailed Reading of a file failed. \value UnZip::WriteFailed Writing of a file failed. \value UnZip::SeekFailed Seek failed. \value UnZip::CreateDirFailed Could not create a directory. \value UnZip::InvalidDevice A null device has been passed as parameter. \value UnZip::InvalidArchive This is not a valid (or supported) ZIP archive. \value UnZip::HeaderConsistencyError Local header record info does not match with the central directory record info. The archive may be corrupted.

\value UnZip::Skip Internal use only. \value UnZip::SkipAll Internal use only.

Enumerator
Ok
ZlibInit
ZlibError
OpenFailed
PartiallyCorrupted
Corrupted
WrongPassword
NoOpenArchive
FileNotFound
ReadFailed
WriteFailed
SeekFailed
CreateDirFailed
InvalidDevice
InvalidArchive
HeaderConsistencyError
Skip
SkipAll

Definition at line 48 of file unzip.h.

  {
    Ok,
    ZlibInit,
    ZlibError,
    OpenFailed,
    PartiallyCorrupted,
    Corrupted,
    WrongPassword,
    NoOpenArchive,
    FileNotFound,
    ReadFailed,
    WriteFailed,
    SeekFailed,
    CreateDirFailed,
    InvalidDevice,
    InvalidArchive,
    HeaderConsistencyError,
 
    Skip, SkipAll // internal use only
  };

ExtractionOption

enum ExtractionOption

Enumerator
ExtractPaths	Extracts paths (default)
SkipPaths	Ignores paths and extracts all the files to the same directory.

Definition at line 70 of file unzip.h.

  {
    //! Extracts paths (default)
    ExtractPaths = 0x0001,
    //! Ignores paths and extracts all the files to the same directory
    SkipPaths = 0x0002
  };

FileType

enum FileType

Enumerator
File
Directory

Definition at line 84 of file unzip.h.

  {
    File, Directory
  };

Constructor & Destructor Documentation

UnZip()

UnZip

(

)

Creates a new Zip file decompressor.

Definition at line 165 of file unzip.cpp.

{
  d = new UnzipPrivate;
}

~UnZip()

~UnZip ( )

virtual

Closes any open archive and releases used resources.

Definition at line 173 of file unzip.cpp.

{
  closeArchive();
  delete d;
}

Here is the call graph for this function:

Member Function Documentation

archiveComment()

QString archiveComment

(

)

const

Definition at line 231 of file unzip.cpp.

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

Referenced by listFiles().

Here is the caller graph for this function:

closeArchive()

void closeArchive

(

)

Closes the archive and releases all the used resources (like cached passwords).

Definition at line 226 of file unzip.cpp.

{
  d->closeArchive();
}

Referenced by decompress(), listFiles(), ModelData::loadInput(), UnzipPrivate::openArchive(), and ~UnZip().

Here is the call graph for this function:

Here is the caller graph for this function:

contains()

bool contains

(

const QString &

file

)

const

Returns true if the archive contains a file with the given path and name.

Definition at line 270 of file unzip.cpp.

{
  if (d->headers == 0)
    return false;
 
  return d->headers->contains(file);
}

entryList()

QList< UnZip::ZipEntry > entryList

(

)

const

Returns information for each (correctly parsed) entry of this archive.

Definition at line 289 of file unzip.cpp.

{
  QList<UnZip::ZipEntry> list;
 
  if (d->headers != 0)
  {
    for (QMap<QString,ZipEntryP*>::ConstIterator it = d->headers->constBegin(); it != d->headers->constEnd(); ++it)
    {
      const ZipEntryP* entry = it.value();
      Q_ASSERT(entry != 0);
 
      ZipEntry z;
 
      z.filename = it.key();
      if (!entry->comment.isEmpty())
        z.comment = entry->comment;
      z.compressedSize = entry->szComp;
      z.uncompressedSize = entry->szUncomp;
      z.crc32 = entry->crc;
      z.lastModified = d->convertDateTime(entry->modDate, entry->modTime);
 
      z.compression = entry->compMethod == 0 ? NoCompression : entry->compMethod == 8 ? Deflated : UnknownCompression;
      z.type = z.filename.endsWith("/") ? Directory : File;
 
      z.encrypted = entry->isEncrypted();
 
      list.append(z);
    }
  }
 
  return list;
}

Referenced by listFiles().

Here is the call graph for this function:

Here is the caller graph for this function:

extractAll() [1/2]

UnZip::ErrorCode extractAll	(	const QDir &	dir,
		ExtractionOptions	options = ExtractPaths
	)

Extracts the whole archive to a directory.

Definition at line 333 of file unzip.cpp.

{
  // this should only happen if we didn't call openArchive() yet
  if (d->device == 0)
    return NoOpenArchive;
 
  if (d->headers == 0)
    return Ok;
 
  bool end = false;
  for (QMap<QString,ZipEntryP*>::Iterator itr = d->headers->begin(); itr != d->headers->end(); ++itr)
  {
    ZipEntryP* entry = itr.value();
    Q_ASSERT(entry != 0);
 
    if ((entry->isEncrypted()) && d->skipAllEncrypted)
      continue;
 
    switch (d->extractFile(itr.key(), *entry, dir, options))
    {
    case Corrupted:
      qDebug() << "Removing corrupted entry" << itr.key();
      d->headers->erase(itr++);
      if (itr == d->headers->end())
        end = true;
      break;
    case CreateDirFailed:
      break;
    case Skip:
      break;
    case SkipAll:
      d->skipAllEncrypted = true;
      break;
    default:
      ;
    }
 
    if (end)
      break;
  }
 
  return Ok;
}

Here is the call graph for this function:

extractAll() [2/2]

UnZip::ErrorCode extractAll	(	const QString &	dirname,
		ExtractionOptions	options = ExtractPaths
	)

Extracts the whole archive to a directory.

Definition at line 325 of file unzip.cpp.

{
  return extractAll(QDir(dirname), options);
}

Referenced by decompress(), extractAll(), and ModelData::loadInput().

Here is the call graph for this function:

Here is the caller graph for this function:

extractFile() [1/3]

UnZip::ErrorCode extractFile	(	const QString &	filename,
		const QDir &	dir,
		ExtractionOptions	options = ExtractPaths
	)

Extracts a single file to a directory.

Definition at line 388 of file unzip.cpp.

{
  QMap<QString,ZipEntryP*>::Iterator itr = d->headers->find(filename);
  if (itr != d->headers->end())
  {
    ZipEntryP* entry = itr.value();
    Q_ASSERT(entry != 0);
    return d->extractFile(itr.key(), *entry, dir, options);
  }
 
  return FileNotFound;
}

Here is the call graph for this function:

extractFile() [2/3]

UnZip::ErrorCode extractFile	(	const QString &	filename,
		const QString &	dirname,
		ExtractionOptions	options = ExtractPaths
	)

Extracts a single file to a directory.

Definition at line 380 of file unzip.cpp.

{
  return extractFile(filename, QDir(dirname), options);
}

Referenced by extractFile(), UnzipPrivate::extractFile(), extractFiles(), and extractFiles().

Here is the call graph for this function:

Here is the caller graph for this function:

extractFile() [3/3]

UnZip::ErrorCode extractFile	(	const QString &	filename,
		QIODevice *	dev,
		ExtractionOptions	options = ExtractPaths
	)

Extracts a single file to a directory.

Definition at line 404 of file unzip.cpp.

{
  if (dev == 0)
    return InvalidDevice;
 
  QMap<QString,ZipEntryP*>::Iterator itr = d->headers->find(filename);
  if (itr != d->headers->end()) {
    ZipEntryP* entry = itr.value();
    Q_ASSERT(entry != 0);
    return d->extractFile(itr.key(), *entry, dev, options);
  }
 
  return FileNotFound;
}

Here is the call graph for this function:

extractFiles() [1/2]

UnZip::ErrorCode extractFiles	(	const QStringList &	filenames,
		const QDir &	dir,
		ExtractionOptions	options = ExtractPaths
	)

Extracts a list of files. Stops extraction at the first error (but continues if a file does not exist in the archive).

Definition at line 444 of file unzip.cpp.

{
  ErrorCode ec;
 
  for (QStringList::ConstIterator itr = filenames.constBegin(); itr != filenames.constEnd(); ++itr)
  {
    ec = extractFile(*itr, dir, options);
    if (ec == FileNotFound)
      continue;
    if (ec != Ok)
      return ec;
  }
 
  return Ok;
}

Here is the call graph for this function:

extractFiles() [2/2]

UnZip::ErrorCode extractFiles	(	const QStringList &	filenames,
		const QString &	dirname,
		ExtractionOptions	options = ExtractPaths
	)

Extracts a list of files. Stops extraction at the first error (but continues if a file does not exist in the archive).

Definition at line 423 of file unzip.cpp.

{
  QDir dir(dirname);
  ErrorCode ec;
 
  for (QStringList::ConstIterator itr = filenames.constBegin(); itr != filenames.constEnd(); ++itr)
  {
    ec = extractFile(*itr, dir, options);
    if (ec == FileNotFound)
      continue;
    if (ec != Ok)
      return ec;
  }
 
  return Ok;
}

Here is the call graph for this function:

fileList()

QStringList fileList

(

)

const

Returns complete paths of files and directories in this archive.

Definition at line 281 of file unzip.cpp.

{
  return d->headers == 0 ? QStringList() : d->headers->keys();
}

formatError()

QString formatError

(

UnZip::ErrorCode

c

)

const

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

Definition at line 241 of file unzip.cpp.

{
  switch (c)
  {
  case Ok: return QCoreApplication::translate("UnZip", "ZIP operation completed successfully."); break;
  case ZlibInit: return QCoreApplication::translate("UnZip", "Failed to initialize or load zlib library."); break;
  case ZlibError: return QCoreApplication::translate("UnZip", "zlib library error."); break;
  case OpenFailed: return QCoreApplication::translate("UnZip", "Unable to create or open file."); break;
  case PartiallyCorrupted: return QCoreApplication::translate("UnZip", "Partially corrupted archive. Some files might be extracted."); break;
  case Corrupted: return QCoreApplication::translate("UnZip", "Corrupted archive."); break;
  case WrongPassword: return QCoreApplication::translate("UnZip", "Wrong password."); break;
  case NoOpenArchive: return QCoreApplication::translate("UnZip", "No archive has been created yet."); break;
  case FileNotFound: return QCoreApplication::translate("UnZip", "File or directory does not exist."); break;
  case ReadFailed: return QCoreApplication::translate("UnZip", "File read error."); break;
  case WriteFailed: return QCoreApplication::translate("UnZip", "File write error."); break;
  case SeekFailed: return QCoreApplication::translate("UnZip", "File seek error."); break;
  case CreateDirFailed: return QCoreApplication::translate("UnZip", "Unable to create a directory."); break;
  case InvalidDevice: return QCoreApplication::translate("UnZip", "Invalid device."); break;
  case InvalidArchive: return QCoreApplication::translate("UnZip", "Invalid or incompatible zip archive."); break;
  case HeaderConsistencyError: return QCoreApplication::translate("UnZip", "Inconsistent headers. Archive might be corrupted."); break;
  default: ;
  }
 
  return QCoreApplication::translate("UnZip", "Unknown error.");
}

Referenced by decompress(), listFiles(), and ModelData::loadInput().

Here is the caller graph for this function:

isOpen()

bool isOpen

(

)

const

Returns true if there is an open archive.

Definition at line 182 of file unzip.cpp.

{
  return d->device != 0;
}

openArchive() [1/2]

UnZip::ErrorCode openArchive

(

const QString &

filename

)

Opens a zip archive and reads the files list. Closes any previously opened archive.

Definition at line 190 of file unzip.cpp.

{
  QFile* file = new QFile(filename);
 
  if (!file->exists()) {
    delete file;
    return UnZip::FileNotFound;
  }
 
  if (!file->open(QIODevice::ReadOnly)) {
    delete file;
    return UnZip::OpenFailed;
  }
 
  return openArchive(file);
}

Referenced by decompress(), listFiles(), ModelData::loadInput(), and openArchive().

Here is the call graph for this function:

Here is the caller graph for this function:

openArchive() [2/2]

UnZip::ErrorCode openArchive

(

QIODevice *

device

)

Opens a zip archive and reads the entries list. Closes any previously opened archive.

Warning

The class takes ownership of the device so don't delete it!

Definition at line 212 of file unzip.cpp.

{
  if (device == 0)
  {
    qDebug() << "Invalid device.";
    return UnZip::InvalidDevice;
  }
 
  return d->openArchive(device);
}

Here is the call graph for this function:

setPassword()

void setPassword

(

const QString &

pwd

)

Remove/replace this method to add your own password retrieval routine.

Definition at line 463 of file unzip.cpp.

{
  d->password = pwd;
}

Referenced by decompress(), and listFiles().

Here is the caller graph for this function:

Member Data Documentation

d

UnzipPrivate* d

private

Definition at line 139 of file unzip.h.

Referenced by archiveComment(), closeArchive(), contains(), UnzipPrivate::createDirectory(), entryList(), extractAll(), extractFile(), extractFile(), fileList(), isOpen(), openArchive(), setPassword(), UnZip(), and ~UnZip().

---

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

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