zipios_FileEntry - Man Page

typedef std::vector< unsigned char > buffer_t
typedef int CompressionLevel
The compression level to be used to save an entry.
typedef uint32_t crc32_t
typedef std::shared_ptr< FileEntry > pointer_t
typedef std::vector< pointer_t > vector_t

FileEntry (FilePath const &filename, std::string const &comment=std::string())
Initialize a FileEntry object.
virtual ~FileEntry ()
Clean up a FileEntry object.
virtual pointer_t clone () const =0
Create a clone of a file entry.
virtual std::string getComment () const
Retrieve the comment of the file entry.
virtual size_t getCompressedSize () const
Retrieve the size of the file when compressed.
virtual crc32_t getCrc () const
Return the CRC of the entry.
std::streampos getEntryOffset () const
Get the offset of this entry in a Zip archive.
virtual buffer_t getExtra () const
Some extra data to be stored along the entry.
virtual std::string getFileName () const
Return the basename of this entry.
virtual size_t getHeaderSize () const
Retrieve the size of the header.
virtual CompressionLevel getLevel () const
Retrieve the compression level.
virtual StorageMethod getMethod () const
Return the method used to create this entry.
virtual std::string getName () const
Return the filename of the entry.
virtual size_t getSize () const
Retrieve the size of the file when uncompressed.
virtual DOSDateTime::dosdatetime_t getTime () const
Get the MS-DOS date/time of this entry.
virtual std::time_t getUnixTime () const
Get the Unix date/time of this entry.
bool hasCrc () const
Check whether the CRC32 was defined.
virtual bool isDirectory () const
Check whether the filename represents a directory.
virtual bool isEqual (FileEntry const &file_entry) const
Compare two file entries for equality.
virtual bool isValid () const
Check whether this entry is valid.
virtual void read (std::istream &is)
Read this FileEntry from the input stream.
virtual void setComment (std::string const &comment)
Set the comment field for the FileEntry.
virtual void setCompressedSize (size_t size)
Set the size when the file is compressed.
virtual void setCrc (crc32_t crc)
Save the CRC of the entry.
void setEntryOffset (std::streampos offset)
Defines the position of the entry in a Zip archive.
virtual void setExtra (buffer_t const &extra)
Set the extra field buffer.
virtual void setLevel (CompressionLevel level)
Define the level of compression to use by this FileEntry.
virtual void setMethod (StorageMethod method)
Sets the storage method field for the entry.
virtual void setSize (size_t size)
Sets the size field for the entry.
virtual void setTime (DOSDateTime::dosdatetime_t time)
Set the FileEntry time using a DOS time.
virtual void setUnixTime (std::time_t time)
Sets the time field in Unix time format for the entry.
virtual std::string toString () const
Returns a human-readable string representation of the entry.
virtual void write (std::ostream &os)
Write this FileEntry to the output stream.

static CompressionLevel const COMPRESSION_LEVEL_DEFAULT = -3
static CompressionLevel const COMPRESSION_LEVEL_FASTEST = -1
static CompressionLevel const COMPRESSION_LEVEL_MAXIMUM = 100
static CompressionLevel const COMPRESSION_LEVEL_MINIMUM = 1
static CompressionLevel const COMPRESSION_LEVEL_NONE = 0
static CompressionLevel const COMPRESSION_LEVEL_SMALLEST = -2

std::string m_comment
StorageMethod m_compress_method = StorageMethod::STORED
CompressionLevel m_compression_level = COMPRESSION_LEVEL_DEFAULT
uint32_t m_crc_32 = 0
std::streampos m_entry_offset = 0
buffer_t m_extra_field
FilePath m_filename
bool m_has_crc_32 = false
size_t m_uncompressed_size = 0
time_t m_unix_time = 0
bool m_valid = false

Definition at line 80 of file fileentry.hpp.

Values defined using this time represent the compression level to be used when compressing an entry.

If unchanged, use the DEFAULT_COMPRESSION value.

It is possible to change the compression level to NO_COMPRESSION or use the setMethod() with STORED to avoid any compression (i.e. create a zip file which awfully looks like a tarball).

Todo

These values are one to one mapped to zlib compression values. This is likely to change once we start offering other compression scheme for a number defined between 0 and 100 instead.

Definition at line 85 of file fileentry.hpp.

Definition at line 81 of file fileentry.hpp.

Definition at line 78 of file fileentry.hpp.

Definition at line 79 of file fileentry.hpp.

This function initializes a FileEntry object. By default you may define the filename of the FileEntry object.

In case of an on disk directory, the filename should be the path to the file that can be read from disk, otherwise the FileEntry object will be viewed as invalid. There is, otherwise, no restriction to the filename.

Parameters

filename The file entry filename.
comment The comment attached to the file.

Definition at line 99 of file fileentry.cpp.

The destructor is defined as it has to be virtual.

It will eventually clean up resources used by the FileEntry class.

Definition at line 133 of file fileentry.cpp.

This function creates a heap allocated clone of the object this method is called for.

Note that the object is expected to overload this function in order to create a clone of the correct type.

Returns

A smart pointer to the clone.

Implemented in zipios::DirectoryEntry, zipios::ZipCentralDirectoryEntry, and zipios::ZipLocalEntry.

Referenced by zipios::FileCollection::addEntry().

This function returns the comment of this entry.

If the entry was not assigned a comment, this function returns an empty string. All entries can be given a comment, although for most it will be ignored unless you save the file to a Zip archive.

Returns

The comment associated with this entry, if there is one.

Definition at line 149 of file fileentry.cpp.

References m_comment.

This function returns the compressed size of the entry. If the entry is not stored in a compressed format, the uncompressed size is returned.

Returns

The compressed size of the entry.

Reimplemented in zipios::ZipLocalEntry.

Definition at line 163 of file fileentry.cpp.

References getSize().

Referenced by toString().

This function returns the CRC 32 of this entry, if it has one.

The CRC is set only after the file is compressed so it may not always be available. The hasCrc() function can be used to know whether it was set before.

Returns

The CRC32 for the entry, if it has one.

Todo

Should we throw if m_has_crc_32 is false?

Definition at line 181 of file fileentry.cpp.

References m_crc_32.

This function retrieves the offset at which this FileEntry resides in the Zip archive it is attached to.

Note that in case of a Zip archive embedded in another file, the offset is virtual (relative to the start of the Zip archive in the larger file.)

Returns

The position in the Zip archive.

Definition at line 201 of file fileentry.cpp.

References m_entry_offset.

This function returns a copy of the vector of bytes of extra data that are stored with the entry.

This buffer should be generated using the still non-existent ZipExtra class. This includes definitions of additional meta data necessary on various operating systems. For example, Linux makes use of the 'UT' (Universal Time) to save the atime, ctime, and mtime parameters, and 'ux' (Unix) to save the Unix permissions and user identifier (uid) and group identifier (gid).

Returns

A buffer_t of extra bytes that are associated with this entry.

Definition at line 221 of file fileentry.cpp.

References m_extra_field.

This function returns the filename only of the entry.

Warning

The function returns the last segment of the filename whether it is a regular file or a directory so one can search for a directory with the MATCH or IGNORE search options.

Returns

The filename of the entry.

Definition at line 319 of file fileentry.cpp.

References zipios::FilePath::filename(), and m_filename.

This function determines the size of the Zip archive header necessary for that file.

By default the function returns zero meaning that no header is defined.

Returns

The size of the header in bytes.

Reimplemented in zipios::ZipCentralDirectoryEntry, and zipios::ZipLocalEntry.

Definition at line 236 of file fileentry.cpp.

Use this function to read the compression level to use to compress a file.

Note that the compression level is rarely saved in the destination file, so after reading a file from a Zip archive this parameter is set to the default compression level which does not represent the level used to create the file.

The compression level is a number between 1 and 100 if compression is wanted. 0 for no compression. A few negative numbers represent various default compression levels.

Returns

The compression level to use to write this entry to a Zip archive.

See also

CompressionLevel

setLevel()

Definition at line 261 of file fileentry.cpp.

References COMPRESSION_LEVEL_NONE, isDirectory(), and m_compression_level.

This function returns the method used to store the entry data in the FileCollection it is attached to.

Returns

the storage method used to store the entry in a collection.

See also

StorageMethod

setMethod()

Definition at line 281 of file fileentry.cpp.

References isDirectory(), m_compress_method, and zipios::STORED.

Referenced by zipios::ZipInputStreambuf::ZipInputStreambuf(), and zipios::ZipInputStreambuf::underflow().

The function returns the full filename of the entry, including a path if the entry is stored in a sub-folder.

Returns

The filename of the entry including its path.

Definition at line 302 of file fileentry.cpp.

References m_filename.

This function returns the uncompressed size of the entry data.

Returns

Returns the uncompressed size of the entry.

Definition at line 331 of file fileentry.cpp.

References m_uncompressed_size.

Referenced by zipios::ZipInputStreambuf::ZipInputStreambuf(), and getCompressedSize().

This function returns the date and time of the entry in MS-DOS date/time format.

Note

An MS-DOS date is limited to 127 years starting on 1980. So it will be over after Dec 31, 2107.

Returns

The date and time of the entry in MS-DOS format.

Definition at line 348 of file fileentry.cpp.

References zipios::DOSDateTime::getDOSDateTime(), m_unix_time, and zipios::DOSDateTime::setUnixTimestamp().

This function returns the date and time of the entry in Unix date/time format (see time()).

Note

The FileEntry object saves the time as a Unix time_t value, however, the Zip file format uses the DOS time format. So for a Zip file, the precision of the date is to the next even second. Yet, this function may return a value which is odd when the time comes from a file on disk.

Unless you have an old 32 bit system that defines time_t as a 32 bit value, a Unix date can be considered infinite. Otherwise it is limited to some time in 2068.

Returns

The date and time of the entry as a time_t value.

Definition at line 380 of file fileentry.cpp.

References m_unix_time.

This function returns true if the setCrc() function was called earlier with a valid CRC32 and the FileEntry implementation supports a CRC (i.e. a DirectoryEntry does not have a CRC).

Returns

true if a CRC32 is defined in this class.

Definition at line 394 of file fileentry.cpp.

References m_has_crc_32.

This function checks the last character of the filename, if it is a separator ('/') then the function returns true meaning that the file represents a directory.

Returns

true if the entry represents a directory.

Reimplemented in zipios::ZipLocalEntry.

Definition at line 408 of file fileentry.cpp.

References zipios::FilePath::isDirectory(), and m_filename.

Referenced by getLevel(), getMethod(), setLevel(), setMethod(), and toString().

This function compares most of the fields between two file entries to see whether they are equal or not.

Warning

The Extra buffer is ignored in the comparison. There are two reasons for this: (1) it is unlikely that such a parameter should could in the comparison (just like the compressed size of the file) and (2) the comparison is not trivial as each chunk in the buffer needs to be separately compared (we may offer that capability once we have a ZipExtra class.)

Parameters

file_entry The file entry to compare this against.

Returns

true if both FileEntry objects are considered equal.

Reimplemented in zipios::DirectoryEntry, and zipios::ZipLocalEntry.

Definition at line 431 of file fileentry.cpp.

References m_comment, m_compress_method, m_crc_32, m_filename, m_has_crc_32, m_uncompressed_size, m_unix_time, and m_valid.

Referenced by zipios::DirectoryEntry::isEqual(), and zipios::ZipLocalEntry::isEqual().

Any method or operator that initializes a FileEntry may set a flag that specifies whether the file entry is valid or not. If it is not this method returns false.

Returns

true if the FileEntry has been parsed successfully.

Definition at line 453 of file fileentry.cpp.

References m_valid.

Referenced by zipios::ZipInputStreambuf::ZipInputStreambuf().

This function is called when the FileEntry should be initialized from the specified input stream.

Exceptions

IOException The default implementation raise an IOException error because there is no reading the FileEntry from anywhere.

Parameters

is The input stream.

Reimplemented in zipios::ZipCentralDirectoryEntry, and zipios::ZipLocalEntry.

Definition at line 732 of file fileentry.cpp.

This function sets the comment of this FileEntry. Note that all implementations of the FileEntry may not include support for a comment. In that case this function does nothing.

Parameters

comment A string with the new comment.

Definition at line 467 of file fileentry.cpp.

References m_comment.

This function saves the compressed size of the entry in this object.

By default the compressed size is viewed as the same as the uncompressed size (i.e. as if STORED was used for the compression method.)

Parameters

size Value to set the compressed size field of the entry to.

Reimplemented in zipios::ZipLocalEntry.

Definition at line 486 of file fileentry.cpp.

This function saves the CRC field in this FileEntry field.

Parameters

crc value to set the crc field to.

Reimplemented in zipios::ZipLocalEntry.

Definition at line 498 of file fileentry.cpp.

This function defines the position of the FileEntry in a Zip archive. By default the position is set to zero.

The offset is generally read from a Zip directory entry.

When used to seek in a file, the FileCollection will add the start offset defined in the VirtualSeeker. In other words this is the position in the Zip archive itself, not the final position in the file you are reading the archive from.

Parameters

offset The new archive entry offset.

Definition at line 518 of file fileentry.cpp.

References m_entry_offset.

This function is used to set the extra field.

Only one type of file entry supports an extra field buffer. The others do nothing when this function is called.

Parameters

extra The extra field is set to this value.

Definition at line 533 of file fileentry.cpp.

References m_extra_field.

This function saves the level of compression the library should use to compress the file before saving it in the output file.

Note

If the StorageMethod is set to STORED, then the compression level is ignored, but it is left unchanged.

Exceptions

InvalidStateException This function raises this exception if the specified level is out of the allowed range.

Parameters

level The compression level to use to compress the file data.

Definition at line 554 of file fileentry.cpp.

References COMPRESSION_LEVEL_MAXIMUM, COMPRESSION_LEVEL_MINIMUM, COMPRESSION_LEVEL_NONE, isDirectory(), and m_compression_level.

This function sets the method with which the file data is to be compressed.

The method is ignored in a file entry which cannot be compressed. (or more precisely, the method is forced as STORED.)

Exceptions

InvalidStateException This exception is raised if the method parameter does not represent a supported method. At this time the library only supports STORED and DEFLATED. The getMethod() may return more types as read from a Zip archive, but it is not possible to set such types using this function.

Parameters

method The method field is set to the specified value.

Definition at line 591 of file fileentry.cpp.

References zipios::DEFLATED, isDirectory(), m_compress_method, and zipios::STORED.

This function is used to save the size of this file on disk when uncompressed.

Parameters

size The size field is set to this value.

Definition at line 643 of file fileentry.cpp.

References m_uncompressed_size.

This function saves the specified dosdatetime value as the last modification date and time of this entry. This is generally used when reading that information * from a Zip archive. Otherwise you probably want to use the setUnixTime() instead since it is one to one compatible with the value handle by time(), stat(), and other OS functions.

Parameters

dosdatetime Set time field as is using this MS-DOS date/time value.

Definition at line 659 of file fileentry.cpp.

References zipios::DOSDateTime::getUnixTimestamp(), zipios::DOSDateTime::setDOSDateTime(), and setUnixTime().

This function is used to set the last modification time of this entry. In most cases this comes from the stat structure field named st_mtime. If you are creating a file directly in memory, you may use the return value of time(nullptr);.

Parameters

time The time field is set to the specified value.

Definition at line 676 of file fileentry.cpp.

References m_unix_time.

Referenced by setTime().

This function transforms the basic information of the entry in a string. Note that most of the information is lost as the function is likely to only display the filename and the size of the file, nothing more.

Returns

A human-readable string representation of the entry.

Definition at line 691 of file fileentry.cpp.

References getCompressedSize(), isDirectory(), m_filename, and m_uncompressed_size.

Referenced by zipios::operator<<().

This function is called when the FileEntry should be saved in the specified output stream.

Exceptions

IOException The default implementation raise an IOException error because there is no writing the FileEntry anywhere.

Parameters

os The output stream.

Reimplemented in zipios::ZipCentralDirectoryEntry, and zipios::ZipLocalEntry.

Definition at line 750 of file fileentry.cpp.

Definition at line 87 of file fileentry.hpp.

Referenced by zipios::DeflateOutputStreambuf::init().

Definition at line 89 of file fileentry.hpp.

Referenced by zipios::DeflateOutputStreambuf::init().

Definition at line 92 of file fileentry.hpp.

Referenced by zipios::DeflateOutputStreambuf::init(), and setLevel().

Definition at line 91 of file fileentry.hpp.

Referenced by zipios::DeflateOutputStreambuf::init(), and setLevel().

Definition at line 90 of file fileentry.hpp.

Referenced by zipios::ZipOutputStreambuf::closeEntry(), getLevel(), zipios::DeflateOutputStreambuf::init(), zipios::ZipOutputStreambuf::overflow(), zipios::ZipOutputStreambuf::putNextEntry(), setLevel(), zipios::ZipCentralDirectoryEntry::write(), and zipios::ZipLocalEntry::write().

Definition at line 88 of file fileentry.hpp.

Referenced by zipios::DeflateOutputStreambuf::init().

Definition at line 133 of file fileentry.hpp.

Referenced by getComment(), zipios::ZipCentralDirectoryEntry::getHeaderSize(), isEqual(), zipios::ZipCentralDirectoryEntry::read(), setComment(), and zipios::ZipCentralDirectoryEntry::write().

Definition at line 137 of file fileentry.hpp.

Referenced by getMethod(), isEqual(), zipios::ZipCentralDirectoryEntry::read(), zipios::ZipLocalEntry::read(), setMethod(), zipios::ZipCentralDirectoryEntry::write(), and zipios::ZipLocalEntry::write().

Definition at line 138 of file fileentry.hpp.

Referenced by getLevel(), setLevel(), zipios::ZipCentralDirectoryEntry::write(), and zipios::ZipLocalEntry::write().

Definition at line 139 of file fileentry.hpp.

Referenced by getCrc(), isEqual(), zipios::ZipCentralDirectoryEntry::read(), zipios::ZipLocalEntry::read(), zipios::ZipLocalEntry::setCrc(), zipios::ZipCentralDirectoryEntry::write(), and zipios::ZipLocalEntry::write().

Definition at line 136 of file fileentry.hpp.

Referenced by getEntryOffset(), zipios::ZipCentralDirectoryEntry::read(), setEntryOffset(), and zipios::ZipCentralDirectoryEntry::write().

Definition at line 140 of file fileentry.hpp.

Referenced by getExtra(), zipios::ZipCentralDirectoryEntry::getHeaderSize(), zipios::ZipLocalEntry::getHeaderSize(), zipios::ZipCentralDirectoryEntry::read(), zipios::ZipLocalEntry::read(), setExtra(), zipios::ZipCentralDirectoryEntry::write(), and zipios::ZipLocalEntry::write().

Definition at line 132 of file fileentry.hpp.

Referenced by zipios::DirectoryEntry::DirectoryEntry(), getFileName(), zipios::ZipCentralDirectoryEntry::getHeaderSize(), zipios::ZipLocalEntry::getHeaderSize(), getName(), isDirectory(), isEqual(), zipios::ZipCentralDirectoryEntry::read(), zipios::ZipLocalEntry::read(), toString(), zipios::ZipCentralDirectoryEntry::write(), and zipios::ZipLocalEntry::write().

Definition at line 141 of file fileentry.hpp.

Referenced by hasCrc(), isEqual(), and zipios::ZipLocalEntry::setCrc().

Definition at line 134 of file fileentry.hpp.

Referenced by zipios::DirectoryEntry::DirectoryEntry(), getSize(), isEqual(), zipios::ZipCentralDirectoryEntry::read(), zipios::ZipLocalEntry::read(), setSize(), toString(), zipios::ZipCentralDirectoryEntry::write(), and zipios::ZipLocalEntry::write().

Definition at line 135 of file fileentry.hpp.

Referenced by zipios::DirectoryEntry::DirectoryEntry(), getTime(), getUnixTime(), isEqual(), zipios::ZipCentralDirectoryEntry::read(), zipios::ZipLocalEntry::read(), setUnixTime(), zipios::ZipCentralDirectoryEntry::write(), and zipios::ZipLocalEntry::write().

Definition at line 142 of file fileentry.hpp.

Referenced by zipios::DirectoryEntry::DirectoryEntry(), isEqual(), isValid(), zipios::ZipCentralDirectoryEntry::read(), and zipios::ZipLocalEntry::read().