#include <ziparchive.h>

Detailed Description

Private helper class for ZipFileSystem to hold per-Zip-archive data.

Uses the zlib and the minizip lib for zip file access.

Multithreading: access to zlib archives needs to be serialized. A ZipArchive objects contains a critical section which it will hand down to ZipFileEntry objects.

Copyright: (C) 2006 Radon Labs GmbH (C) 2013-2020 Individual contributors, see AUTHORS file

Inherits IO::ArchiveBase.

Public Member Functions
	ZipArchive ()
	constructor

virtual	~ZipArchive ()
	destructor

bool	Setup (const URI &uri, const Util::String &rootPath="")
	setup the archive from an URI

void	Discard ()
	discard the archive

Util::Array< Util::String >	ListFiles (const Util::String &dirPathInArchive, const Util::String &pattern) const
	list all files in a directory in the archive

Util::Array< Util::String >	ListDirectories (const Util::String &dirPathInArchive, const Util::String &pattern) const
	list all subdirectories in a directory in the archive

URI	ConvertToArchiveURI (const URI &fileURI) const
	convert a "file:" URI into a "zip:" URI pointing into this archive

Util::String	ConvertToPathInArchive (const Util::String &absPath) const
	convert an absolute path to local path inside archive, returns empty string if absPath doesn't point into this archive

Public Member Functions inherited from IO::ArchiveBase
	ArchiveBase ()
	constructor

virtual	~ArchiveBase ()
	destructor

bool	Setup (const URI &archiveURI, const Util::String &rootPath)
	setup the archive from an URI (without file extension)

void	Discard ()
	discard the archive

bool	IsValid () const
	return true if archive is valid

const URI &	GetURI () const
	get the URI of the archive

Util::Array< Util::String >	ListFiles (const Util::String &dirPathInArchive, const Util::String &pattern) const
	list all files in a directory in the archive

Util::Array< Util::String >	ListDirectories (const Util::String &dirPathInArchive, const Util::String &pattern) const
	list all subdirectories in a directory in the archive

URI	ConvertToArchiveURI (const URI &fileURI) const
	convert a "file:" URI into a archive-specific URI pointing into this archive

Util::String	ConvertToPathInArchive (const Util::String &absPath) const
	convert an absolute path to local path inside archive, returns empty string if absPath doesn't point into this archive

Public Member Functions inherited from Core::RefCounted
	RefCounted ()
	constructor

int	GetRefCount () const
	get the current refcount

void	AddRef ()
	increment refcount by one

void	Release ()
	decrement refcount and destroy object if refcount is zero

bool	IsInstanceOf (const Rtti &rtti) const
	return true if this object is instance of given class

bool	IsInstanceOf (const Util::String &className) const
	return true if this object is instance of given class by string

bool	IsInstanceOf (const Util::FourCC &classFourCC) const
	return true if this object is instance of given class by fourcc

bool	IsA (const Rtti &rtti) const
	return true if this object is instance of given class, or a derived class

bool	IsA (const Util::String &rttiName) const
	return true if this object is instance of given class, or a derived class, by string

bool	IsA (const Util::FourCC &rttiFourCC) const
	return true if this object is instance of given class, or a derived class, by fourcc

const Util::String &	GetClassName () const
	get the class name

Util::FourCC	GetClassFourCC () const
	get the class FourCC code

Private Member Functions
	__DeclareClass (ZipArchive)

void	ParseTableOfContents ()
	parse the table of contents into memory

void	AddEntry (const Util::String &path)
	add a new file entry, create missing dir entries on the way

const ZipFileEntry *	FindFileEntry (const Util::String &pathInZipArchive) const
	find a file entry in the zip archive, return 0 if not exists

ZipFileEntry *	FindFileEntry (const Util::String &pathInZipArchive)
	find a file entry in the zip archive, return 0 if not exists

const ZipDirEntry *	FindDirEntry (const Util::String &pathInZipArchive) const
	find a directory entry in the zip archive, return 0 if not exists

Private Attributes
Util::String	rootPath

unzFile	zipFileHandle

ZipDirEntry	rootEntry

Threading::CriticalSection	archiveCritSect

zlib_filefunc64_def	zlibIoFuncs

Friends
class	ZipFileSystem

class	ZipFileStream

Additional Inherited Members
Static Public Member Functions inherited from Core::RefCounted
static void	DumpRefCountingLeaks ()
	dump refcounting leaks, call at end of application (NEBULA_DEBUG builds only!)

Protected Member Functions inherited from Core::RefCounted
virtual	~RefCounted ()
	destructor (called when refcount reaches zero)

Protected Attributes inherited from IO::ArchiveBase
bool	isValid

URI	uri

Constructor & Destructor Documentation

◆ ZipArchive()

IO::ZipArchive::ZipArchive ( )

constructor

◆ ~ZipArchive()

IO::ZipArchive::~ZipArchive ( )

virtual

destructor

Member Function Documentation

◆ __DeclareClass()

IO::ZipArchive::__DeclareClass ( ZipArchive )

private

◆ AddEntry()

void IO::ZipArchive::AddEntry ( const Util::String & path )

private

add a new file entry, create missing dir entries on the way

This will create a new ZipFileEntry or ZipDirEntry object and sort it into the entry tree.

Missing ZipDirEntry objects in the path will be created as needed.

◆ ConvertToArchiveURI()

URI IO::ZipArchive::ConvertToArchiveURI ( const URI & fileURI ) const

convert a "file:" URI into a "zip:" URI pointing into this archive

This method takes a normal "file:" scheme URI and convertes it into a "zip:" scheme URI which points to the file in this zip archive.

This is used by the IoServer for transparent file access into zip archives.

◆ ConvertToPathInArchive()

String IO::ZipArchive::ConvertToPathInArchive ( const Util::String & absPath ) const

convert an absolute path to local path inside archive, returns empty string if absPath doesn't point into this archive

Test if an absolute path points into the zip archive and return a locale path into the zip archive.

This will not test, whether the file or directory inside the zip archive actually exists, only if the path points INTO the zip archive by checking against the location directory of the zip archive.

◆ Discard()

void IO::ZipArchive::Discard ( )

discard the archive

This closes the zip archive, releasing the table of contents and closing the zip file.

◆ FindDirEntry()

const ZipDirEntry * IO::ZipArchive::FindDirEntry ( const Util::String & pathInZipArchive ) const

private

find a directory entry in the zip archive, return 0 if not exists

◆ FindFileEntry() [1/2]

ZipFileEntry * IO::ZipArchive::FindFileEntry ( const Util::String & pathInZipArchive )

private

find a file entry in the zip archive, return 0 if not exists

◆ FindFileEntry() [2/2]

const ZipFileEntry * IO::ZipArchive::FindFileEntry ( const Util::String & pathInZipArchive ) const

private

find a file entry in the zip archive, return 0 if not exists

◆ ListDirectories()

Array< String > IO::ZipArchive::ListDirectories	(	const Util::String &	dirPathInArchive,
		const Util::String &	pattern ) const

list all subdirectories in a directory in the archive

◆ ListFiles()

Array< String > IO::ZipArchive::ListFiles	(	const Util::String &	dirPathInArchive,
		const Util::String &	pattern ) const

list all files in a directory in the archive

◆ ParseTableOfContents()

void IO::ZipArchive::ParseTableOfContents ( )

private

parse the table of contents into memory

Internal method which parses the table of contents of the into a tree of ZipDirEntry and ZipFileEntry objects.

◆ Setup()

bool IO::ZipArchive::Setup	(	const URI &	uri,
		const Util::String &	rootPath = "" )

setup the archive from an URI

This opens the zip archive and reads the table of content as a tree of ZipDirEntry and ZipFileEntry objects.

Friends And Related Symbol Documentation

◆ ZipFileStream

friend class ZipFileStream

friend

◆ ZipFileSystem

friend class ZipFileSystem

friend

Member Data Documentation

◆ archiveCritSect

Threading::CriticalSection IO::ZipArchive::archiveCritSect

private

◆ rootEntry

ZipDirEntry IO::ZipArchive::rootEntry

private

◆ rootPath

Util::String IO::ZipArchive::rootPath

private

◆ zipFileHandle

unzFile IO::ZipArchive::zipFileHandle

private

◆ zlibIoFuncs

zlib_filefunc64_def IO::ZipArchive::zlibIoFuncs

private

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

/github/workspace/code/foundation/io/zipfs/ziparchive.h
/github/workspace/code/foundation/io/zipfs/ziparchive.cc

Detailed Description

Public Member Functions

Private Member Functions

Private Attributes

Friends

Additional Inherited Members

Constructor & Destructor Documentation

◆ ZipArchive()

◆ ~ZipArchive()

Member Function Documentation

◆ __DeclareClass()

◆ AddEntry()

◆ ConvertToArchiveURI()

◆ ConvertToPathInArchive()

◆ Discard()

◆ FindDirEntry()

◆ FindFileEntry() [1/2]

◆ FindFileEntry() [2/2]

◆ ListDirectories()

◆ ListFiles()

◆ ParseTableOfContents()

◆ Setup()

Friends And Related Symbol Documentation

◆ ZipFileStream

◆ ZipFileSystem

Member Data Documentation

◆ archiveCritSect

◆ rootEntry

◆ rootPath

◆ zipFileHandle

◆ zlibIoFuncs