| Version: 3.3.1

Archive Formats

The archive classes handle archive formats such as zip.

Currently zip and tar support is bundled with wxWidgets and when external liblzma library is available (see Using LZMA compression with liblzma), XZ format using LZMA2 algorithm is supported as well.

For each archive type, there are the following classes (using zip here as an example):

- wxZipInputStream: Input stream
- wxZipOutputStream: Output stream
- wxZipEntry: Holds meta-data for an entry (e.g. filename, timestamp, etc.)

There are also abstract wxArchive classes that can be used to write code that can handle any of the archive types, see Generic Archive Programming.

Also see wxFileSystem for a higher level interface that can handle archive files in a generic way.

The classes are designed to handle archives on both seekable streams such as disk files, or non-seekable streams such as pipes and sockets (see Archives on Non-Seekable Streams).

# Creating an Archive

Call wxArchiveOutputStream::PutNextEntry() to create each new entry in the archive, then write the entry's data. Another call to PutNextEntry() closes the current entry and begins the next. For example:

wxFFileOutputStream out("test.zip");
wxZipOutputStream zip(out);
wxTextOutputStream txt(zip);
wxString sep(wxFileName::GetPathSeparator());
zip.PutNextEntry("entry1.txt");
txt << "Some text for entry1.txt\n";
zip.PutNextEntry("subdir" + sep + "entry2.txt");
txt << "Some text for subdir/entry2.txt\n";
wxFFileOutputStream
This class represents data written to a file.
Definition: wfstream.h:118
wxFileName::GetPathSeparator
static wxUniChar GetPathSeparator(wxPathFormat format=wxPATH_NATIVE)
Returns the usually used path separator for this format.
wxString
String class for passing textual data to or receiving it from wxWidgets.
Definition: string.h:372
wxTextOutputStream
This class provides functions that write text data using an output stream, allowing you to write text...
Definition: txtstrm.h:304
wxZipOutputStream
Output stream for writing zip files.
Definition: zipstrm.h:478

The name of each entry can be a full path, which makes it possible to store entries in subdirectories.

# Extracting an Archive

wxArchiveInputStream::GetNextEntry() returns a pointer to entry object containing the meta-data for the next entry in the archive (and gives away ownership).

Reading from the input stream then returns the entry's data. Eof() becomes true after an attempt has been made to read past the end of the entry's data.

When there are no more entries, GetNextEntry() returns nullptr and sets Eof().

std::unique_ptr<wxZipEntry> entry;
wxFFileInputStream in("test.zip");
wxZipInputStream zip(in);
while (entry.reset(zip.GetNextEntry()), entry.get() != nullptr)
{
// access meta-data
wxString name = entry->GetName();
// read 'zip' to access the entry's data
}
wxFFileInputStream
This class represents data read in from a file.
Definition: wfstream.h:284
wxZipInputStream
Input stream for reading zip files.
Definition: zipstrm.h:381

# Modifying an Archive

To modify an existing archive, write a new copy of the archive to a new file, making any necessary changes along the way and transferring any unchanged entries using wxArchiveOutputStream::CopyEntry().

For archive types which compress entry data, CopyEntry() is likely to be much more efficient than transferring the data using Read() and Write() since it will copy them without decompressing and recompressing them.

In general modifications are not possible without rewriting the archive, though it may be possible in some limited cases. Even then, rewriting the archive is usually a better choice since a failure can be handled without losing the whole archive. wxTempFileOutputStream can be helpful to do this.

For example to delete all entries matching the pattern "*.txt":

std::unique_ptr<wxFFileInputStream> in(new wxFFileInputStream("test.zip"));
wxTempFileOutputStream out("test.zip");
wxZipInputStream inzip(*in);
wxZipOutputStream outzip(out);
std::unique_ptr<wxZipEntry> entry;
// transfer any meta-data for the archive as a whole (the zip comment
// in the case of zip)
outzip.CopyArchiveMetaData(inzip);
// call CopyEntry for each entry except those matching the pattern
while (entry.reset(inzip.GetNextEntry()), entry.get() != nullptr)
if (!entry->GetName().Matches("*.txt"))
if (!outzip.CopyEntry(entry.release(), inzip))
break;
// close the input stream by releasing the pointer to it, do this
// before closing the output stream so that the file can be replaced
in.reset();
// you can check for success as follows
bool success = inzip.Eof() && outzip.Close() && out.Commit();
wxTempFileOutputStream
wxTempFileOutputStream is an output stream based on wxTempFile.
Definition: wfstream.h:21

# Looking Up an Archive Entry by Name

Also see wxFileSystem for a higher level interface that is more convenient for accessing archive entries by name.

To open just one entry in an archive, the most efficient way is to simply search for it linearly by calling wxArchiveInputStream::GetNextEntry() until the required entry is found. This works both for archives on seekable and non-seekable streams.

The format of filenames in the archive is likely to be different from the local filename format. For example zips and tars use unix style names, with forward slashes as the path separator, and absolute paths are not allowed. So if on Windows the file "C:\MYDIR\MYFILE.TXT" is stored, then when reading the entry back wxArchiveEntry::GetName() will return "MYDIR\MYFILE.TXT". The conversion into the internal format and back has lost some information.

So to avoid ambiguity when searching for an entry matching a local name, it is better to convert the local name to the archive's internal format and search for that:

std::unique_ptr<wxZipEntry> entry;
// convert the local name we are looking for into the internal format
wxString name = wxZipEntry::GetInternalName(localName);
// open the zip
wxFFileInputStream in("test.zip");
wxZipInputStream zip(in);
// call GetNextEntry() until the required internal name is found
do
{
entry.reset(zip.GetNextEntry());
}
while (entry.get() != nullptr && entry->GetInternalName() != name);
if (entry.get() != nullptr)
{
// read the entry's data...
}
wxZipEntry::GetInternalName
wxString GetInternalName() const
Returns the entry's filename in the internal format used within the archive.

To access several entries randomly, it is most efficient to transfer the entire catalogue of entries to a container such as a std::map or a wxHashMap then entries looked up by name can be opened using the wxArchiveInputStream::OpenEntry() method.

using ZipEntryPtr = std::unique_ptr<wxZipEntry>;
using ZipCatalog = std::map<wxString, ZipEntryPtr>;
ZipEntryPtr entry;
ZipCatalog cat;
// open the zip
wxFFileInputStream in("test.zip");
wxZipInputStream zip(in);
// load the zip catalog
while (entry.reset(zip.GetNextEntry()), entry.get() != nullptr)
cat[entry->GetInternalName()] = std::move(entry);
// open an entry by name
auto it = cat.find(wxZipEntry::GetInternalName(localName));
if (it != cat.end())
{
zip.OpenEntry(*it->second);
// ... now read entry's data
}

To open more than one entry simultaneously you need more than one underlying stream on the same archive:

// opening another entry without closing the first requires another
// input stream for the same file
wxFFileInputStream in2("test.zip");
wxZipInputStream zip2(in2);
if ((it = cat.find(wxZipEntry::GetInternalName(local2))) != cat.end())
zip2.OpenEntry(*it->second);

# Generic Archive Programming

Also see wxFileSystem for a higher level interface that can handle archive files in a generic way.

The specific archive classes, such as the wxZip classes, inherit from the following abstract classes which can be used to write code that can handle any of the archive types:

- wxArchiveInputStream: Input stream
- wxArchiveOutputStream: Output stream
- wxArchiveEntry: Holds the meta-data for an entry (e.g. filename)

In order to able to write generic code it's necessary to be able to create instances of the classes without knowing which archive type is being used.

To allow this there is a class factory for each archive type, derived from wxArchiveClassFactory, that can create the other classes.

For example, given wxArchiveClassFactory* factory, streams and entries can be created like this:

// create streams without knowing their type
std::unique_ptr<wxArchiveInputStream> inarc(factory->NewStream(in));
std::unique_ptr<wxArchiveOutputStream> outarc(factory->NewStream(out));
// create an empty entry object
std::unique_ptr<wxArchiveEntry> entry(factory->NewEntry());

For the factory itself, the static member wxArchiveClassFactory::Find() can be used to find a class factory that can handle a given file extension or mime type. For example, given filename:

const wxArchiveClassFactory *factory;
factory = wxArchiveClassFactory::Find(filename, wxSTREAM_FILEEXT);
if (factory)
stream = factory->NewStream(new wxFFileInputStream(filename));
wxArchiveClassFactory
Allows the creation of streams to handle archive formats such as zip and tar.
Definition: archive.h:330
wxArchiveClassFactory::Find
static const wxArchiveClassFactory * Find(const wxString &protocol, wxStreamProtocolType type=wxSTREAM_PROTOCOL)
A static member that finds a factory that can handle a given protocol, MIME type or file extension.
wxArchiveClassFactory::NewStream
wxArchiveInputStream * NewStream(wxInputStream &stream) const
Create a new input or output stream to read or write an archive.
wxSTREAM_FILEEXT
@ wxSTREAM_FILEEXT
File extensions the stream handles.
Definition: stream.h:832

Find() does not give away ownership of the returned pointer, so it does not need to be deleted.

There are similar class factories for the filter streams that handle the compression and decompression of a single stream, such as wxGzipInputStream. These can be found using wxFilterClassFactory::Find().

For example, to list the contents of archive filename:

std::unique_ptr<wxInputStream> in(new wxFFileInputStream(filename));
if (in->IsOk())
{
// look for a filter handler, e.g. for '.gz'
const wxFilterClassFactory *fcf;
fcf = wxFilterClassFactory::Find(filename, wxSTREAM_FILEEXT);
if (fcf)
{
in.reset(fcf->NewStream(in.release()));
// pop the extension, so if it was '.tar.gz' it is now just '.tar'
filename = fcf->PopExtension(filename);
}
// look for a archive handler, e.g. for '.zip' or '.tar'
const wxArchiveClassFactory *acf;
acf = wxArchiveClassFactory::Find(filename, wxSTREAM_FILEEXT);
if (acf)
{
std::unique_ptr<wxArchiveInputStream> arc(acf->NewStream(in.release()));
std::unique_ptr<wxArchiveEntry> entry;
// list the contents of the archive
while ((entry.reset(arc->GetNextEntry())), entry.get() != nullptr)
std::wcout << entry->GetName() << "\n";
}
else
{
wxLogError("can't handle '%s'", filename);
}
}
wxFilterClassFactory
Allows the creation of filter streams to handle compression formats such as gzip and bzip2.
Definition: stream.h:862
wxFilterClassFactory::PopExtension
wxString PopExtension(const wxString &location) const
Remove the file extension of location if it is one of the file extensions handled by this factory.
wxFilterClassFactory::Find
static const wxFilterClassFactory * Find(const wxString &protocol, wxStreamProtocolType type=wxSTREAM_PROTOCOL)
A static member that finds a factory that can handle a given protocol, MIME type, HTTP encoding or fi...
wxFilterClassFactory::NewStream
virtual wxFilterInputStream * NewStream(wxInputStream &stream) const =0
Create a new input or output stream to decompress or compress a given stream.
wxLogError
void wxLogError(const char *formatString,...)
The functions to use for error messages, i.e.

# Archives on Non-Seekable Streams

In general, handling archives on non-seekable streams is done in the same way as for seekable streams, with a few caveats.

The main limitation is that accessing entries randomly using wxArchiveInputStream::OpenEntry() is not possible, the entries can only be accessed sequentially in the order they are stored within the archive.

For each archive type, there will also be other limitations which will depend on the order the entries' meta-data is stored within the archive. These are not too difficult to deal with, and are outlined below.

## PutNextEntry and the Entry Size

When writing archives, some archive formats store the entry size before the entry's data (tar has this limitation, zip doesn't). In this case the entry's size must be passed to wxArchiveOutputStream::PutNextEntry() or an error occurs.

This is only an issue on non-seekable streams, since otherwise the archive output stream can seek back and fix up the header once the size of the entry is known.

For generic programming, one way to handle this is to supply the size whenever it is known, and rely on the error message from the output stream when the operation is not supported.

## GetNextEntry and the Weak Reference Mechanism

Some archive formats do not store all an entry's meta-data before the entry's data (zip is an example). In this case, when reading from a non-seekable stream, wxArchiveInputStream::GetNextEntry() can only return a partially populated wxArchiveEntry object - not all the fields are set.

The input stream then keeps a weak reference to the entry object and updates it when more meta-data becomes available. A weak reference being one that does not prevent you from deleting the wxArchiveEntry object - the input stream only attempts to update it if it is still around.

The documentation for each archive entry type gives the details of what meta-data becomes available and when. For generic programming, when the worst case must be assumed, you can rely on all the fields of wxArchiveEntry being fully populated when GetNextEntry() returns, with the following exceptions:

- wxArchiveEntry::GetSize(): Guaranteed to be available after the entry has been read to wxInputStream::Eof(), or wxArchiveInputStream::CloseEntry() has been called.
- wxArchiveEntry::IsReadOnly(): Guaranteed to be available after the end of the archive has been reached, i.e. after GetNextEntry() returns nullptr and Eof() is true.

This mechanism allows wxArchiveOutputStream::CopyEntry() to always fully preserve entries' meta-data. No matter what order order the meta-data occurs within the archive, the input stream will always have read it before the output stream must write it.

## wxArchiveNotifier

Notifier objects can be used to get a notification whenever an input stream updates a wxArchiveEntry object's data via the weak reference mechanism.

Consider the following code which renames an entry in an archive. This is the usual way to modify an entry's meta-data, simply set the required field before writing it with wxArchiveOutputStream::CopyEntry():

std::unique_ptr<wxArchiveInputStream> arc(factory->NewStream(in));
std::unique_ptr<wxArchiveOutputStream> outarc(factory->NewStream(out));
std::unique_ptr<wxArchiveEntry> entry;
outarc->CopyArchiveMetaData(*arc);
while (entry.reset(arc->GetNextEntry()), entry.get() != nullptr)
{
if (entry->GetName() == from)
entry->SetName(to);
if (!outarc->CopyEntry(entry.release(), *arc))
break;
}
bool success = arc->Eof() && outarc->Close();

However, for non-seekable streams, this technique cannot be used for fields such as wxArchiveEntry::IsReadOnly(), which are not necessarily set when wxArchiveInputStream::GetNextEntry() returns.

In this case a wxArchiveNotifier can be used:

class MyNotifier : public wxArchiveNotifier
{
public:
void OnEntryUpdated(wxArchiveEntry& entry) { entry.SetIsReadOnly(false); }
};
wxArchiveEntry
This is an abstract base class which serves as a common interface to archive entry classes such as wx...
Definition: archive.h:186
wxArchiveEntry::SetIsReadOnly
virtual void SetIsReadOnly(bool isReadOnly=true)=0
Sets this entry as a read-only file.
wxArchiveNotifier
If you need to know when a wxArchiveInputStream updates a wxArchiveEntry object, you can create a not...
Definition: archive.h:486
wxArchiveNotifier::OnEntryUpdated
virtual void OnEntryUpdated(wxArchiveEntry &entry)=0
This method must be overridden in your derived class.

The meta-data changes are done in your notifier's wxArchiveNotifier::OnEntryUpdated() method, then wxArchiveEntry::SetNotifier() is called before CopyEntry():

std::unique_ptr<wxArchiveInputStream> arc(factory->NewStream(in));
std::unique_ptr<wxArchiveOutputStream> outarc(factory->NewStream(out));
std::unique_ptr<wxArchiveEntry> entry;
MyNotifier notifier;
outarc->CopyArchiveMetaData(*arc);
while (entry.reset(arc->GetNextEntry()), entry.get() != nullptr)
{
entry->SetNotifier(notifier);
if (!outarc->CopyEntry(entry.release(), *arc))
break;
}
bool success = arc->Eof() && outarc->Close();

SetNotifier() calls OnEntryUpdated() immediately, then the input stream calls it again whenever it sets more fields in the entry. Since OnEntryUpdated() will be called at least once, this technique always works even when it is not strictly necessary to use it. For example, changing the entry name can be done this way too and it works on seekable streams as well as non-seekable.