ZipDataSource.h
Go to the documentation of this file.
00001 /***************************************************************************** 00002 * Copyright (C) 2011 by Benjamin Hadorn (b_hadorn@bluewin.ch) 00003 ***************************************************************************** 00004 * Project : Zeus Base Library 00005 * Module : ZipDataSource 00006 * Package : Zeus.ZeusBase.System 00007 * Author : Benjamin Hadorn 00008 * Date : 27.12.2011 00009 * System : Zeus-Framework 00010 ***************************************************************************** 00011 * Licence: * 00012 * This library is free software; you can redistribute it and/or modify * 00013 * it under the terms of the GNU Lesser General Public License as * 00014 * published by the Free Software Foundation; either version * 00015 * 2.1 of the License, or (at your option) any later version. * 00016 * * 00017 * This library is distributed in the hope that it will be useful, * 00018 * but WITHOUT ANY WARRANTY; without even the implied warranty of * 00019 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the * 00020 * GNU Lesser General Public License for more details. * 00021 * * 00022 * You should have received a copy of the GNU Lesser General Public * 00023 * License along with this library; if not, write to the Free Software * 00024 * Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110, USA * 00025 *****************************************************************************/ 00026 00027 /***************************************************************************** 00028 * Changes: 00029 * 27.12.2011 bha: created zeus 2.0 00030 *****************************************************************************/ 00031 00032 #ifndef ZipDataSourceH 00033 #define ZipDataSourceH 00034 00035 #include <zeusbase/System/Interfaces/IInputStream.hpp> 00036 #include <zeusbase/System/ArrayPtr.hpp> 00037 #include <zeusbase/System/StringMap.hpp> 00038 #include <zeusbase/System/SingleLinkedList.hpp> 00039 #include <zeusbase/System/Interfaces/IStringList.hpp> 00040 #include <zeusbase/System/ZObject.h> 00041 00042 BEGIN_NAMESPACE_Zeus 00043 00044 class IOutputStream; 00045 00046 #pragma pack(1) 00047 00048 /*************************************************************************/ 00051 /*************************************************************************/ 00052 struct TypeZipLocalFileHeader 00053 { 00054 //The signature is read seperatly to check if the end of the file list is reached 00055 //Int32 ulSignature; //local file header signature 4 bytes (0x04034b50) 00056 Uint16 usVersion; //version needed to extract 2 bytes 00057 Uint16 usFlags; //general purpose bit flag 2 bytes 00058 Uint16 usCompressionMethod; //compression method 2 bytes 00059 Uint16 usLastModTime; //last mod file time 2 bytes 00060 Uint16 usLastModDate; //last mod file date 2 bytes 00061 Uint32 ulCRC32; //crc-32 4 bytes 00062 Uint32 ulCompressedSize; //compressed size 4 bytes 00063 Uint32 ulUncompressedSize; //uncompressed size 4 bytes 00064 Uint16 usFileNameLength; //file name length 2 bytes 00065 Uint16 usExtraFieldLength; //extra field length 2 bytes 00066 }; 00067 00068 /*************************************************************************/ 00071 /*************************************************************************/ 00072 struct TypeZipCentralDirectoryFileHeader 00073 { 00074 //The signature is read seperatly to check if the end of the file list is reached 00075 //Int32 ulSignature; //central file header signature 4 bytes (0x02014b50) 00076 Uint16 usVersionMadeOf; //version made by 2 bytes 00077 Uint16 usVersion; //version needed to extract 2 bytes 00078 Uint16 usFlags; //general purpose bit flag 2 bytes 00079 Uint16 usCompressionMethod; //compression method 2 bytes 00080 Uint16 usLastModTime; //last mod file time 2 bytes 00081 Uint16 usLastModDate; //last mod file date 2 bytes 00082 Uint32 ulCRC32; //crc-32 4 bytes 00083 Uint32 ulCompressedSize; //compressed size 4 bytes 00084 Uint32 ulUncompressedSize; //uncompressed size 4 bytes 00085 Uint16 usFileNameLength; //file name length 2 bytes 00086 Uint16 usExtraFieldLength; //extra field length 2 bytes 00087 Uint16 usFileCommentLength; //file comment length 2 bytes 00088 Uint16 usDiskNumberStart; //disk number start 2 bytes 00089 Uint16 usInternalFileAttr; //internal file attributes 2 bytes 00090 Uint32 ulExternalFileAttr; //external file attributes 4 bytes 00091 Uint32 ulOffsetToEntry; //relative offset of local header 4 bytes 00092 }; 00093 00094 00095 /*************************************************************************/ 00098 /*************************************************************************/ 00099 struct TypeFileDescriptor 00100 { 00101 Uint32 ulCRC32; //crc-32 4 bytes 00102 Uint32 ulCompressedSize; //compressed size 4 bytes 00103 Uint32 ulUncompressedSize; //uncompressed size 4 bytes 00104 }; 00105 00106 #pragma pack() 00107 00108 /*************************************************************************/ 00111 /*************************************************************************/ 00112 struct TypeFile 00113 { 00114 TypeZipLocalFileHeader Header; 00115 TArrayPtr<char> ptrLocalExtraData; 00116 TArrayPtr<char> ptrData; 00117 TypeFileDescriptor Descriptor; 00118 bool bHasDescriptor; 00119 TypeZipCentralDirectoryFileHeader CentralDirHeader; 00120 TArrayPtr<char> ptrCentralExtraData; 00121 00123 inline TypeFile() 00124 { 00125 bHasDescriptor = false; 00126 } 00127 00129 inline ~TypeFile() 00130 {} 00131 }; 00132 00133 /*****************************************************************************/ 00136 /*****************************************************************************/ 00137 enum ECompressionMethod 00138 { 00139 etNotDefined = -1, 00140 etNoCompression = 0, // 0 - The file is stored (no compression) 00141 etShrunk = 1, // 1 - The file is Shrunk 00142 etReducedToCFactor_1 = 2, // 2 - The file is Reduced with compression factor 1 00143 etReducedToCFactor_2 = 3, // 3 - The file is Reduced with compression factor 2 00144 etReducedToCFactor_3 = 4, // 4 - The file is Reduced with compression factor 3 00145 etReducedToCFactor_4 = 5, // 5 - The file is Reduced with compression factor 4 00146 etImploded = 6, // 6 - The file is Imploded 00147 etRevTokenComp = 7, // 7 - Reserved for Tokenizing compression algorithm 00148 etDeflated = 8, // 8 - The file is Deflated 00149 etEnhancedDelated = 9, // 9 - Enhanced Deflating using Deflate64(tm) 00150 etPkWareCompr = 10, //10 - PKWARE Data Compression Library Imploding (old IBM TERSE) 00151 //11 - Reserved by PKWARE 00152 etBZIP_2 = 12, //12 - File is compressed using BZIP2 algorithm 00153 //13 - Reserved by PKWARE 00154 etLZMA = 14, //14 - LZMA (EFS) 00155 //15 - Reserved by PKWARE 00156 //16 - Reserved by PKWARE 00157 //17 - Reserved by PKWARE 00158 etIBM_TERSE = 18, //18 - File is compressed using IBM TERSE (new) 00159 etIBM_LZ77 = 19, //19 - IBM LZ77 z Architecture (PFS) 00160 etWavPack = 97, //97 - WavPack compressed data 00161 etPPMd_Version1 = 98, //98 - PPMd version I, Rev 1 00162 }; 00163 00164 /*****************************************************************************/ 00167 /*****************************************************************************/ 00168 zeusbase_class TZippedFileEntry : public TZObject 00169 { 00170 public: 00171 TZippedFileEntry(const IString& rFileEntryName, TypeFile& rEntry); 00172 TZippedFileEntry(const IString& rFileEntryName, const IString& rFileNameToCompress); 00173 00174 Retval compressFile(const IString& rPassword, Int iZipLevel = 4); 00175 00177 inline Uint32 getChecksum() const { return m_rEntry.Header.ulCRC32; } 00179 inline Uint getCompressedSize() const { return m_rEntry.Header.ulCompressedSize; } 00181 inline ECompressionMethod getCompressionMethod() const { return (ECompressionMethod)m_rEntry.Header.usCompressionMethod;} 00182 Float getCompressionRate() const; 00184 inline TString getComment() const { return m_strComment; } 00186 inline TString getFileEntryName() const { return m_strEntryName; } 00187 Timeval getModificationTime() const; 00188 Uint64 getSize() const; 00189 Retval getUnzippedData(IByteArray& rData) const; 00190 Retval getUnzippedData(IByteArray& rData, const IString& rPassword) const; 00191 00193 inline bool isCompressed() const { return m_bCompressed; } 00194 inline bool isDirectory() const { return (m_strEntryName.endsWith(L"\\") || m_strEntryName.endsWith(L"/")); } 00195 inline bool isEncrypted() const { return (m_rEntry.Header.usFlags & 0x0001); } 00196 00198 inline void setComment(const IString& rValue) { m_strComment = rValue; } 00199 00200 protected: 00201 virtual ~TZippedFileEntry(); 00202 Uint generateOutput(IOutputStream& rOutStream); 00203 Uint generateOutputForCentralDirectory(IOutputStream& rOutStream, Uint uiOffsetToLocalHeader); 00204 00205 inline TypeFile& getFileEntryStructure() { return m_rEntry; } 00206 inline void setSourceFile(const IString& rFileName) { m_strFileName = rFileName; } 00207 00208 private: 00210 TypeFile& m_rEntry; 00212 TString m_strFileName; 00214 TString m_strEntryName; 00216 TString m_strComment; 00218 bool m_bCompressed; 00219 00220 //friend class used to hide protected methods to library user 00221 friend class TZipDataSource; 00222 }; 00223 00224 //INLINE METHODS 00225 00226 /*****************************************************************************/ 00229 /*****************************************************************************/ 00230 inline Retval TZippedFileEntry::getUnzippedData(IByteArray& rData) const 00231 { 00232 return getUnzippedData(rData, TString(L"")); 00233 } 00234 00235 00236 //############################################################################ 00237 //############################################################################ 00238 00239 00240 /*****************************************************************************/ 00244 /*****************************************************************************/ 00245 zeusbase_class TZipDataSource : public TZObject 00246 { 00247 public: 00248 TZipDataSource(); 00249 TZipDataSource(IInputStream& rInStream); 00250 00251 Retval addFileEntry(const IString& rEntryName, const IString& rFileName, const IString& rPassword, bool bOverwriteIfExists, Int iZipLevel); 00252 Retval deleteFileEntry(Int iIndex); 00253 Retval getFileEntry(Int iIndex, TZippedFileEntry*& rpEntry) const; 00254 Retval getFileEntryByName(const IString& rEntryName, TZippedFileEntry*& rpEntry) const; 00255 void getFileEntryNames(IStringList& rNames) const; 00256 Int getFileEntryCount() const; 00257 bool isValid() const; 00258 Retval removeFileEntry(const IString& rEntryName); 00259 00260 Retval generateOutput(IOutputStream& rOutStream); 00261 00262 protected: 00263 virtual ~TZipDataSource(); 00264 00265 private: 00267 bool m_bValid; 00269 TSingleLinkedList<TZippedFileEntry*> m_lstFiles; 00271 TStringMap<Int> m_mapLookup; 00272 00273 bool readBuffer(IInputStream& rInStream, TArrayPtr<char>& rpBuffer, Int iSize); 00274 }; 00275 00276 //INLINE METHODS 00277 00278 /*****************************************************************************/ 00281 /*****************************************************************************/ 00282 inline bool TZipDataSource::isValid() const 00283 { 00284 return m_bValid; 00285 } 00286 00287 /*****************************************************************************/ 00290 /*****************************************************************************/ 00291 inline Int TZipDataSource::getFileEntryCount() const 00292 { 00293 return m_lstFiles.getCount(); 00294 } 00295 00296 /*****************************************************************************/ 00303 /*****************************************************************************/ 00304 inline Retval TZipDataSource::getFileEntryByName(const IString& rEntryName, TZippedFileEntry*& rpEntry) const 00305 { 00306 Int iIndex = m_mapLookup.getItemConst(rEntryName); 00307 return getFileEntry(iIndex, rpEntry); 00308 } 00309 00310 /*****************************************************************************/ 00314 /*****************************************************************************/ 00315 inline Retval TZipDataSource::removeFileEntry(const IString& rEntryName) 00316 { 00317 Int iIndex = m_mapLookup.getItemConst(rEntryName); 00318 return deleteFileEntry(iIndex); 00319 } 00320 00321 00322 END_NAMESPACE_Zeus 00323 00324 #endif