XrdZip::LFH Struct Reference

A data structure representing ZIP Local File Header. More...

#include <XrdZipLFH.hh>

Collaboration diagram for XrdZip::LFH:

Public Member Functions
	LFH (const char *buffer, const uint64_t bufferSize=0)
	Constructor from buffer.
	LFH (const std::string &filename, uint32_t crc, off_t fileSize, time_t time)
	Constructor.
void	ParseExtra (const char *buffer, uint16_t length)
void	Serialize (buffer_t &buffer)
	Serialize the object into a buffer.

Static Public Member Functions
static uint32_t	initSize (const off_t &fileSize)
	Convenience function for initializing compressed/uncompressed size.

Public Attributes
uint32_t	compressedSize
uint16_t	compressionMethod
std::unique_ptr< Extra >	extra
uint16_t	extraLength
std::string	filename
uint16_t	filenameLength
uint16_t	generalBitFlag
uint16_t	lfhSize
uint16_t	minZipVersion
dos_timestmp	timestmp
uint32_t	uncompressedSize
uint32_t	ZCRC32

Static Public Attributes
static const uint16_t	lfhBaseSize = 30
static const uint32_t	lfhSign = 0x04034b50
	Local File Header signature.

Detailed Description

A data structure representing ZIP Local File Header.

Definition at line 41 of file XrdZipLFH.hh.

Constructor & Destructor Documentation

LFH() [1/2]

XrdZip::LFH::LFH ( const std::string & filename, uint32_t crc, off_t fileSize, time_t time )

inline

Constructor.

Definition at line 55 of file XrdZipLFH.hh.

                                                                                :
      generalBitFlag( 0 ), compressionMethod( 0 ), timestmp( time ), ZCRC32( crc ),
      compressedSize( initSize( fileSize ) ), uncompressedSize( initSize( fileSize ) ),
      filenameLength( filename.size() ), filename( filename ), extra( new Extra( fileSize ) )
    {
      extraLength = extra->totalSize;
      if ( extraLength == 0 )
        minZipVersion = 10;
      else
        minZipVersion = 45;
      lfhSize = lfhBaseSize + filenameLength + extraLength;
    }

References compressedSize, compressionMethod, extra, extraLength, filename, filenameLength, generalBitFlag, initSize(), lfhBaseSize, lfhSize, minZipVersion, timestmp, uncompressedSize, and ZCRC32.

Here is the call graph for this function:

LFH() [2/2]

XrdZip::LFH::LFH ( const char * buffer, const uint64_t bufferSize = 0 )

inline

Constructor from buffer.

Definition at line 71 of file XrdZipLFH.hh.

    {
        if(bufferSize > 0 && bufferSize < (uint64_t)lfhBaseSize)
                throw bad_data();
      // check if the buffer contains a LFH record
      uint32_t signature = 0;
      from_buffer( signature, buffer );
      if( signature != lfhSign ) throw bad_data();
      // parse LFH filds
      from_buffer( minZipVersion, buffer );
      from_buffer( generalBitFlag, buffer );
      from_buffer( compressionMethod, buffer );
      from_buffer( timestmp.time, buffer );
      from_buffer( timestmp.date, buffer );
      from_buffer( ZCRC32, buffer );
      from_buffer( compressedSize, buffer );
      from_buffer( uncompressedSize, buffer );
      from_buffer( filenameLength, buffer );
      from_buffer( extraLength, buffer );
 
      if(bufferSize > 0 && (uint64_t)(lfhBaseSize + filenameLength + extraLength) > bufferSize)
          throw bad_data();
      // parse the filename
      filename.assign( buffer, filenameLength );
      buffer += filenameLength;
      // parse the extra record
      if( extraLength > 0 )
        ParseExtra( buffer, extraLength );
 
      lfhSize = lfhBaseSize + filenameLength + extraLength;
    }

References compressedSize, compressionMethod, extraLength, filename, filenameLength, XrdZip::from_buffer(), generalBitFlag, lfhBaseSize, lfhSign, lfhSize, minZipVersion, ParseExtra(), timestmp, uncompressedSize, and ZCRC32.

Here is the call graph for this function:

Member Function Documentation

initSize()

static uint32_t XrdZip::LFH::initSize ( const off_t & fileSize )

inlinestatic

Convenience function for initializing compressed/uncompressed size.

Definition at line 46 of file XrdZipLFH.hh.

    {
      return fileSize >= ovrflw<uint32_t>::value ?
             ovrflw<uint32_t>::value : fileSize;
    }

References XrdZip::ovrflw< UINT >::value.

Referenced by LFH().

Here is the caller graph for this function:

ParseExtra()

void XrdZip::LFH::ParseExtra ( const char * buffer, uint16_t length )

inline

Definition at line 126 of file XrdZipLFH.hh.

    {
      uint8_t ovrflws = Extra::NONE;
      uint16_t exsize = 0;
 
      // check if compressed size is overflown
      if( compressedSize == ovrflw<uint32_t>::value)
      {
        ovrflws |= Extra::CPMSIZE;
        exsize  += sizeof( uint64_t );
      }
 
      // check if original size is overflown
      if( uncompressedSize == ovrflw<uint32_t>::value )
      {
        ovrflws |= Extra::UCMPSIZE;
        exsize  += sizeof( uint64_t );
      }
 
      // if the expected size of ZIP64 extension is 0 we
      // can skip parsing of 'extra'
      if( exsize == 0 ) return;
 
      extra.reset( new Extra() );
 
      // Parse the extra part
      buffer = Extra::Find( buffer, length );
      if( buffer )
        extra->FromBuffer( buffer, exsize, ovrflws );
    }

References compressedSize, XrdZip::Extra::CPMSIZE, extra, XrdZip::Extra::Find(), XrdZip::Extra::NONE, XrdZip::Extra::UCMPSIZE, uncompressedSize, and XrdZip::ovrflw< UINT >::value.

Referenced by LFH().

Here is the call graph for this function:

Here is the caller graph for this function:

Serialize()

void XrdZip::LFH::Serialize ( buffer_t & buffer )

inline

Serialize the object into a buffer.

Definition at line 106 of file XrdZipLFH.hh.

    {
      copy_bytes( lfhSign, buffer );
      copy_bytes( minZipVersion, buffer );
      copy_bytes( generalBitFlag, buffer );
      copy_bytes( compressionMethod, buffer );
      copy_bytes( timestmp.time, buffer );
      copy_bytes( timestmp.date, buffer );
      copy_bytes( ZCRC32, buffer );
      copy_bytes( compressedSize, buffer );
      copy_bytes( uncompressedSize, buffer );
      copy_bytes( filenameLength, buffer );
      copy_bytes( extraLength , buffer );
      std::copy( filename.begin(), filename.end(), std::back_inserter( buffer ) );
      extra->Serialize( buffer );
    }

References compressedSize, compressionMethod, XrdZip::copy_bytes(), extra, extraLength, filename, filenameLength, generalBitFlag, lfhSign, minZipVersion, timestmp, uncompressedSize, and ZCRC32.

Here is the call graph for this function:

Member Data Documentation

compressedSize

uint32_t XrdZip::LFH::compressedSize

Definition at line 162 of file XrdZipLFH.hh.

Referenced by LFH(), LFH(), ParseExtra(), and Serialize().

compressionMethod

uint16_t XrdZip::LFH::compressionMethod

Definition at line 159 of file XrdZipLFH.hh.

Referenced by LFH(), LFH(), and Serialize().

extra

std::unique_ptr<Extra> XrdZip::LFH::extra

Definition at line 167 of file XrdZipLFH.hh.

Referenced by LFH(), ParseExtra(), and Serialize().

extraLength

uint16_t XrdZip::LFH::extraLength

Definition at line 165 of file XrdZipLFH.hh.

Referenced by LFH(), LFH(), and Serialize().

filename

std::string XrdZip::LFH::filename

Definition at line 166 of file XrdZipLFH.hh.

Referenced by LFH(), LFH(), and Serialize().

filenameLength

uint16_t XrdZip::LFH::filenameLength

Definition at line 164 of file XrdZipLFH.hh.

Referenced by LFH(), LFH(), and Serialize().

generalBitFlag

uint16_t XrdZip::LFH::generalBitFlag

Definition at line 158 of file XrdZipLFH.hh.

Referenced by LFH(), LFH(), and Serialize().

lfhBaseSize

const uint16_t XrdZip::LFH::lfhBaseSize = 30

static

Definition at line 174 of file XrdZipLFH.hh.

Referenced by LFH(), and LFH().

lfhSign

const uint32_t XrdZip::LFH::lfhSign = 0x04034b50

static

Local File Header signature.

Definition at line 173 of file XrdZipLFH.hh.

Referenced by LFH(), and Serialize().

lfhSize

uint16_t XrdZip::LFH::lfhSize

Definition at line 168 of file XrdZipLFH.hh.

Referenced by LFH(), and LFH().

minZipVersion

uint16_t XrdZip::LFH::minZipVersion

Definition at line 157 of file XrdZipLFH.hh.

Referenced by LFH(), LFH(), and Serialize().

timestmp

dos_timestmp XrdZip::LFH::timestmp

Definition at line 160 of file XrdZipLFH.hh.

Referenced by LFH(), LFH(), and Serialize().

uncompressedSize

uint32_t XrdZip::LFH::uncompressedSize

Definition at line 163 of file XrdZipLFH.hh.

Referenced by LFH(), LFH(), ParseExtra(), and Serialize().

ZCRC32

uint32_t XrdZip::LFH::ZCRC32

Definition at line 161 of file XrdZipLFH.hh.

Referenced by LFH(), LFH(), and Serialize().

---

The documentation for this struct was generated from the following file:

• XrdZipLFH.hh