[wxWidgets.git] / include / wx / zipstrm.h

/////////////////////////////////////////////////////////////////////////////
// Name:        zipstrm.h
// Purpose:     Streams for Zip files
// Author:      Mike Wetherell
// RCS-ID:      $Id$
// Copyright:   (c) Mike Wetherell
// Licence:     wxWindows licence
/////////////////////////////////////////////////////////////////////////////

#ifndef _WX_WXZIPSTREAM_H__
#define _WX_WXZIPSTREAM_H__

#if defined(__GNUG__) && !defined(NO_GCC_PRAGMA)
#pragma interface "zipstrm.h"
#endif

#include "wx/defs.h"

#if wxUSE_ZLIB && wxUSE_STREAMS && wxUSE_ZIPSTREAM

#include "wx/archive.h"
#include "wx/hashmap.h"
#include "wx/filename.h"


/////////////////////////////////////////////////////////////////////////////
// constants

// Compression Method, only 0 (store) and 8 (deflate) are supported here
//
enum wxZipMethod
{
    wxZIP_METHOD_STORE,
    wxZIP_METHOD_SHRINK,
    wxZIP_METHOD_REDUCE1,
    wxZIP_METHOD_REDUCE2,
    wxZIP_METHOD_REDUCE3,
    wxZIP_METHOD_REDUCE4,
    wxZIP_METHOD_IMPLODE,
    wxZIP_METHOD_TOKENIZE,
    wxZIP_METHOD_DEFLATE,
    wxZIP_METHOD_DEFLATE64,
    wxZIP_METHOD_BZIP2 = 12,
    wxZIP_METHOD_DEFAULT = 0xffff
};

// Originating File-System.
// 
// These are Pkware's values. Note that Info-zip disagree on some of them,
// most notably NTFS.
//
enum wxZipSystem
{
    wxZIP_SYSTEM_MSDOS,
    wxZIP_SYSTEM_AMIGA,
    wxZIP_SYSTEM_OPENVMS,
    wxZIP_SYSTEM_UNIX,
    wxZIP_SYSTEM_VM_CMS,
    wxZIP_SYSTEM_ATARI_ST,
    wxZIP_SYSTEM_OS2_HPFS,
    wxZIP_SYSTEM_MACINTOSH,
    wxZIP_SYSTEM_Z_SYSTEM,
    wxZIP_SYSTEM_CPM,
    wxZIP_SYSTEM_WINDOWS_NTFS,
    wxZIP_SYSTEM_MVS,
    wxZIP_SYSTEM_VSE,
    wxZIP_SYSTEM_ACORN_RISC,
    wxZIP_SYSTEM_VFAT,
    wxZIP_SYSTEM_ALTERNATE_MVS,
    wxZIP_SYSTEM_BEOS,
    wxZIP_SYSTEM_TANDEM,
    wxZIP_SYSTEM_OS_400
};

// Dos/Win file attributes
//
enum wxZipAttributes
{
    wxZIP_A_RDONLY = 0x01,
    wxZIP_A_HIDDEN = 0x02,
    wxZIP_A_SYSTEM = 0x04,
    wxZIP_A_SUBDIR = 0x10,
    wxZIP_A_ARCH   = 0x20,

    wxZIP_A_MASK   = 0x37
};

// Values for the flags field in the zip headers
//
enum wxZipFlags
{
    wxZIP_ENCRYPTED         = 0x0001,
    wxZIP_DEFLATE_NORMAL    = 0x0000,   // normal compression
    wxZIP_DEFLATE_EXTRA     = 0x0002,   // extra compression
    wxZIP_DEFLATE_FAST      = 0x0004,   // fast compression
    wxZIP_DEFLATE_SUPERFAST = 0x0006,   // superfast compression
    wxZIP_DEFLATE_MASK      = 0x0006,
    wxZIP_SUMS_FOLLOW       = 0x0008,   // crc and sizes come after the data
    wxZIP_ENHANCED          = 0x0010,
    wxZIP_PATCH             = 0x0020,
    wxZIP_STRONG_ENC        = 0x0040,
    wxZIP_UNUSED            = 0x0F80,
    wxZIP_RESERVED          = 0xF000
};

// Forward decls
//
class WXDLLIMPEXP_BASE wxZipEntry;
class WXDLLIMPEXP_BASE wxZipInputStream;


/////////////////////////////////////////////////////////////////////////////
// wxZipNotifier

class WXDLLIMPEXP_BASE wxZipNotifier
{
public:
    virtual ~wxZipNotifier() { }

    virtual void OnEntryUpdated(wxZipEntry& entry) = 0;
};


/////////////////////////////////////////////////////////////////////////////
// Zip Entry - holds the meta data for a file in the zip

class WXDLLIMPEXP_BASE wxZipEntry : public wxArchiveEntry
{
public:
    wxZipEntry(const wxString& name = wxEmptyString,
               const wxDateTime& dt = wxDateTime::Now(),
               wxFileOffset size = wxInvalidOffset);
    virtual ~wxZipEntry();

    wxZipEntry(const wxZipEntry& entry);
    wxZipEntry& operator=(const wxZipEntry& entry);

    // Get accessors
    wxDateTime   GetDateTime() const            { return m_DateTime; }
    wxFileOffset GetSize() const                { return m_Size; }
    wxFileOffset GetOffset() const              { return m_Offset; }
    wxString     GetInternalName() const        { return m_Name; }
    int          GetMethod() const              { return m_Method; }
    int          GetFlags() const               { return m_Flags; }
    wxUint32     GetCrc() const                 { return m_Crc; }
    wxFileOffset GetCompressedSize() const      { return m_CompressedSize; }
    int          GetSystemMadeBy() const        { return m_SystemMadeBy; }
    wxString     GetComment() const             { return m_Comment; }
    wxUint32     GetExternalAttributes() const  { return m_ExternalAttributes; }
    wxPathFormat GetInternalFormat() const      { return wxPATH_UNIX; }
    int          GetMode() const;
    const char  *GetLocalExtra() const;
    size_t       GetLocalExtraLen() const;
    const char  *GetExtra() const;
    size_t       GetExtraLen() const;
    wxString     GetName(wxPathFormat format = wxPATH_NATIVE) const;

    // is accessors
    inline bool IsDir() const;
    inline bool IsText() const;
    inline bool IsReadOnly() const;
    inline bool IsMadeByUnix() const;

    // set accessors
    void SetDateTime(const wxDateTime& dt)      { m_DateTime = dt; }
    void SetSize(wxFileOffset size)             { m_Size = size; }
    void SetMethod(int method)                  { m_Method = (wxUint16)method; }
    void SetComment(const wxString& comment)    { m_Comment = comment; }
    void SetExternalAttributes(wxUint32 attr )  { m_ExternalAttributes = attr; }
    void SetSystemMadeBy(int system);
    void SetMode(int mode);
    void SetExtra(const char *extra, size_t len);
    void SetLocalExtra(const char *extra, size_t len);

    inline void SetName(const wxString& name,
                        wxPathFormat format = wxPATH_NATIVE);

    static wxString GetInternalName(const wxString& name,
                                    wxPathFormat format = wxPATH_NATIVE,
                                    bool *pIsDir = NULL);

    // set is accessors
    void SetIsDir(bool isDir = true);
    inline void SetIsReadOnly(bool isReadOnly = true);
    inline void SetIsText(bool isText = true);

    wxZipEntry *Clone() const                   { return ZipClone(); }

    void SetNotifier(wxZipNotifier& notifier);
    void UnsetNotifier();

protected:
    // Internal attributes
    enum { TEXT_ATTR = 1 };

    // protected Get accessors
    int GetVersionNeeded() const                { return m_VersionNeeded; }
    wxFileOffset GetKey() const                 { return m_Key; }
    int GetVersionMadeBy() const                { return m_VersionMadeBy; }
    int GetDiskStart() const                    { return m_DiskStart; }
    int GetInternalAttributes() const           { return m_InternalAttributes; }

    void SetVersionNeeded(int version)          { m_VersionNeeded = (wxUint16)version; }
    void SetOffset(wxFileOffset offset)         { m_Offset = offset; }
    void SetFlags(int flags)                    { m_Flags = (wxUint16)flags; }
    void SetVersionMadeBy(int version)          { m_VersionMadeBy = (wxUint8)version; }
    void SetCrc(wxUint32 crc)                   { m_Crc = crc; }
    void SetCompressedSize(wxFileOffset size)   { m_CompressedSize = size; }
    void SetKey(wxFileOffset offset)            { m_Key = offset; }
    void SetDiskStart(int start)                { m_DiskStart = (wxUint16)start; }
    void SetInternalAttributes(int attr)        { m_InternalAttributes = (wxUint16)attr; }

    virtual wxZipEntry *ZipClone() const        { return new wxZipEntry(*this); }

    void Notify();

private:
    wxArchiveEntry* DoClone() const             { return ZipClone(); }

    size_t ReadLocal(wxInputStream& stream, wxMBConv& conv);
    size_t WriteLocal(wxOutputStream& stream, wxMBConv& conv) const;

    size_t ReadCentral(wxInputStream& stream, wxMBConv& conv);
    size_t WriteCentral(wxOutputStream& stream, wxMBConv& conv) const;

    size_t ReadDescriptor(wxInputStream& stream);
    size_t WriteDescriptor(wxOutputStream& stream, wxUint32 crc,
                           wxFileOffset compressedSize, wxFileOffset size);

    wxUint8      m_SystemMadeBy;       // one of enum wxZipSystem
    wxUint8      m_VersionMadeBy;      // major * 10 + minor

    wxUint16     m_VersionNeeded;      // ver needed to extract (20 i.e. v2.0)
    wxUint16     m_Flags;
    wxUint16     m_Method;             // compression method (one of wxZipMethod)
    wxDateTime   m_DateTime;
    wxUint32     m_Crc;
    wxFileOffset m_CompressedSize;
    wxFileOffset m_Size;
    wxString     m_Name;               // in internal format
    wxFileOffset m_Key;                // the original offset for copied entries
    wxFileOffset m_Offset;             // file offset of the entry

    wxString     m_Comment;
    wxUint16     m_DiskStart;          // for multidisk archives, not unsupported
    wxUint16     m_InternalAttributes; // bit 0 set for text files
    wxUint32     m_ExternalAttributes; // system specific depends on SystemMadeBy

    class wxZipMemory *m_Extra;
    class wxZipMemory *m_LocalExtra;

    wxZipNotifier *m_zipnotifier;
    class wxZipWeakLinks *m_backlink;

    friend class wxZipInputStream;
    friend class wxZipOutputStream;

    DECLARE_DYNAMIC_CLASS(wxZipEntry)
};


/////////////////////////////////////////////////////////////////////////////
// wxZipOutputStream 

WX_DECLARE_LIST_WITH_DECL(wxZipEntry, _wxZipEntryList, class WXDLLIMPEXP_BASE);

class WXDLLIMPEXP_BASE wxZipOutputStream : public wxArchiveOutputStream
{
public:
    wxZipOutputStream(wxOutputStream& stream,
                      int level = -1,
                      wxMBConv& conv = wxConvLocal);
    virtual ~wxZipOutputStream();

    bool PutNextEntry(wxZipEntry *entry)        { return DoCreate(entry); }

    bool PutNextEntry(const wxString& name,
                      const wxDateTime& dt = wxDateTime::Now(),
                      wxFileOffset size = wxInvalidOffset);

    bool PutNextDirEntry(const wxString& name,
                         const wxDateTime& dt = wxDateTime::Now());

    bool CopyEntry(wxZipEntry *entry, wxZipInputStream& inputStream);
    bool CopyArchiveMetaData(wxZipInputStream& inputStream);

    void Sync();
    bool CloseEntry();
    bool Close();

    void SetComment(const wxString& comment)    { m_Comment = comment; }

    int  GetLevel() const                       { return m_level; }
    void SetLevel(int level);
    
protected:
    virtual size_t OnSysWrite(const void *buffer, size_t size);
    virtual wxFileOffset OnSysTell() const      { return m_entrySize; }

    struct Buffer { const char *m_data; size_t m_size; };
    virtual wxOutputStream *OpenCompressor(wxOutputStream& stream,
                                           wxZipEntry& entry,
                                           const Buffer bufs[]);
    virtual bool CloseCompressor(wxOutputStream *comp);

    bool IsParentSeekable() const               { return m_offsetAdjustment
                                                        != wxInvalidOffset; }

private:
    bool PutNextEntry(wxArchiveEntry *entry);
    bool CopyEntry(wxArchiveEntry *entry, wxArchiveInputStream& stream);
    bool CopyArchiveMetaData(wxArchiveInputStream& stream);

    bool IsOpened() const                       { return m_comp || m_pending; }

    bool DoCreate(wxZipEntry *entry, bool raw = false);
    void CreatePendingEntry(const void *buffer, size_t size);
    void CreatePendingEntry();

    class wxStoredOutputStream *m_store;
    class wxZlibOutputStream2 *m_deflate;
    class wxZipStreamLink *m_backlink;
    _wxZipEntryList m_entries;
    char *m_initialData;
    size_t m_initialSize;
    wxZipEntry *m_pending;
    bool m_raw;
    wxFileOffset m_headerOffset;
    size_t m_headerSize;
    wxFileOffset m_entrySize;
    wxUint32 m_crcAccumulator;
    wxOutputStream *m_comp;
    int m_level;
    wxFileOffset m_offsetAdjustment;
    wxString m_Comment;

    DECLARE_NO_COPY_CLASS(wxZipOutputStream)
};


/////////////////////////////////////////////////////////////////////////////
// wxZipInputStream 

class WXDLLIMPEXP_BASE wxZipInputStream : public wxArchiveInputStream
{
public:
    typedef wxZipEntry entry_type;

    wxZipInputStream(wxInputStream& stream, wxMBConv& conv = wxConvLocal);
    wxZipInputStream(const wxString& archive, const wxString& file);
    virtual ~wxZipInputStream();

    bool OpenEntry(wxZipEntry& entry)   { return DoOpen(&entry); }
    bool CloseEntry();

    wxZipEntry *GetNextEntry();

    wxString GetComment();
    int GetTotalEntries();

    virtual wxFileOffset GetLength() const { return m_entry.GetSize(); }

protected:
    size_t OnSysRead(void *buffer, size_t size);
    wxFileOffset OnSysTell() const { return m_decomp ? m_decomp->TellI() : 0; }
    wxFileOffset OnSysSeek(wxFileOffset seek, wxSeekMode mode);

    virtual wxInputStream *OpenDecompressor(wxInputStream& stream);
    virtual bool CloseDecompressor(wxInputStream *decomp);

private:
    void Init();
    wxInputStream& OpenFile(const wxString& archive);

    wxArchiveEntry *DoGetNextEntry()    { return GetNextEntry(); }

    bool OpenEntry(wxArchiveEntry& entry);

    wxStreamError ReadLocal(bool readEndRec = false);
    wxStreamError ReadCentral();

    wxUint32 ReadSignature();
    bool FindEndRecord();
    bool LoadEndRecord();
    
    bool AtHeader() const       { return m_headerSize == 0; }
    bool AfterHeader() const    { return m_headerSize > 0 && !m_decomp; }
    bool IsOpened() const       { return m_decomp != NULL; }

    wxZipStreamLink *MakeLink(wxZipOutputStream *out);

    bool DoOpen(wxZipEntry *entry = NULL, bool raw = false);
    bool OpenDecompressor(bool raw = false);

    class wxStoredInputStream *m_store;
    class wxZlibInputStream2 *m_inflate;
    class wxRawInputStream *m_rawin;
    class wxFFileInputStream *m_ffile;
    wxZipEntry m_entry;
    bool m_raw;
    size_t m_headerSize;
    wxUint32 m_crcAccumulator;
    wxInputStream *m_decomp;
    bool m_parentSeekable;
    class wxZipWeakLinks *m_weaklinks;
    class wxZipStreamLink *m_streamlink;
    wxFileOffset m_offsetAdjustment;
    wxFileOffset m_position;
    wxUint32 m_signature;
    size_t m_TotalEntries;
    wxString m_Comment;

    friend bool wxZipOutputStream::CopyEntry(
                    wxZipEntry *entry, wxZipInputStream& inputStream);
    friend bool wxZipOutputStream::CopyArchiveMetaData(
                    wxZipInputStream& inputStream);

    DECLARE_NO_COPY_CLASS(wxZipInputStream)
};


/////////////////////////////////////////////////////////////////////////////
// Iterators

#if wxUSE_STL || defined WX_TEST_ARCHIVE_ITERATOR
typedef wxArchiveIterator<wxZipInputStream> wxZipIter;
typedef wxArchiveIterator<wxZipInputStream,
         std::pair<wxString, wxZipEntry*> > wxZipPairIter;
#endif


/////////////////////////////////////////////////////////////////////////////
// wxZipClassFactory

class WXDLLIMPEXP_BASE wxZipClassFactory : public wxArchiveClassFactory
{
public:
    typedef wxZipEntry        entry_type;
    typedef wxZipInputStream  instream_type;
    typedef wxZipOutputStream outstream_type;
    typedef wxZipNotifier     notifier_type;
#if wxUSE_STL || defined WX_TEST_ARCHIVE_ITERATOR
    typedef wxZipIter         iter_type;
    typedef wxZipPairIter     pairiter_type;
#endif

    wxZipEntry *NewEntry() const
        { return new wxZipEntry; }
    wxZipInputStream *NewStream(wxInputStream& stream) const
        { return new wxZipInputStream(stream, GetConv()); }
    wxZipOutputStream *NewStream(wxOutputStream& stream) const
        { return new wxZipOutputStream(stream, -1, GetConv()); }

    wxString GetInternalName(const wxString& name,
                             wxPathFormat format = wxPATH_NATIVE) const
        { return wxZipEntry::GetInternalName(name, format); }

protected:
    wxArchiveEntry *DoNewEntry() const
        { return NewEntry(); }
    wxArchiveInputStream *DoNewStream(wxInputStream& stream) const
        { return NewStream(stream); }
    wxArchiveOutputStream *DoNewStream(wxOutputStream& stream) const
        { return NewStream(stream); }

private:
    DECLARE_DYNAMIC_CLASS(wxZipClassFactory)
};


/////////////////////////////////////////////////////////////////////////////
// wxZipEntry inlines

inline bool wxZipEntry::IsText() const
{
    return (m_InternalAttributes & TEXT_ATTR) != 0;
}

inline bool wxZipEntry::IsDir() const
{
    return (m_ExternalAttributes & wxZIP_A_SUBDIR) != 0;
}

inline bool wxZipEntry::IsReadOnly() const
{
    return (m_ExternalAttributes & wxZIP_A_RDONLY) != 0;
}

inline bool wxZipEntry::IsMadeByUnix() const
{
    const int pattern =
        (1 << wxZIP_SYSTEM_OPENVMS) |
        (1 << wxZIP_SYSTEM_UNIX) |
        (1 << wxZIP_SYSTEM_ATARI_ST) |
        (1 << wxZIP_SYSTEM_ACORN_RISC) |
        (1 << wxZIP_SYSTEM_BEOS) | (1 << wxZIP_SYSTEM_TANDEM);

    // note: some unix zippers put madeby = dos
    return (m_SystemMadeBy == wxZIP_SYSTEM_MSDOS
            && (m_ExternalAttributes & ~0xFFFF))
        || ((pattern >> m_SystemMadeBy) & 1);
}

inline void wxZipEntry::SetIsText(bool isText)
{
    if (isText)
        m_InternalAttributes |= TEXT_ATTR;
    else
        m_InternalAttributes &= ~TEXT_ATTR;
}

inline void wxZipEntry::SetIsReadOnly(bool isReadOnly)
{
    if (isReadOnly)
        SetMode(GetMode() & ~0222);
    else
        SetMode(GetMode() | 0200);
}

inline void wxZipEntry::SetName(const wxString& name,
                                wxPathFormat format /*=wxPATH_NATIVE*/)
{
    bool isDir;
    m_Name = GetInternalName(name, format, &isDir);
    SetIsDir(isDir);
}


#endif // wxUSE_ZLIB && wxUSE_STREAMS && wxUSE_ZIPSTREAM

#endif // _WX_WXZIPSTREAM_H__
Commit	Line	Data
5526e819	1	/////////////////////////////////////////////////////////////////////////////
00375592 VZ	2	// Name: zipstrm.h
	3	// Purpose: Streams for Zip files
	4	// Author: Mike Wetherell
	5	// RCS-ID: $Id$
	6	// Copyright: (c) Mike Wetherell
65571936	7	// Licence: wxWindows licence
5526e819 VS	8	/////////////////////////////////////////////////////////////////////////////
5526e819 VS	9
00375592 VZ	10	#ifndef _WX_WXZIPSTREAM_H__
00375592 VZ	11	#define _WX_WXZIPSTREAM_H__
5526e819	12
12028905	13	#if defined(__GNUG__) && !defined(NO_GCC_PRAGMA)
5279a24d	14	#pragma interface "zipstrm.h"
5526e819 VS	15	#endif
5526e819 VS	16
d1af991f	17	#include "wx/defs.h"
5526e819	18
00375592	19	#if wxUSE_ZLIB && wxUSE_STREAMS && wxUSE_ZIPSTREAM
d1af991f	20
00375592 VZ	21	#include "wx/archive.h"
	22	#include "wx/hashmap.h"
	23	#include "wx/filename.h"
5526e819	24
5526e819	25
00375592 VZ	26	/////////////////////////////////////////////////////////////////////////////
	27	// constants
	28
	29	// Compression Method, only 0 (store) and 8 (deflate) are supported here
	30	//
	31	enum wxZipMethod
	32	{
	33	wxZIP_METHOD_STORE,
	34	wxZIP_METHOD_SHRINK,
	35	wxZIP_METHOD_REDUCE1,
	36	wxZIP_METHOD_REDUCE2,
	37	wxZIP_METHOD_REDUCE3,
	38	wxZIP_METHOD_REDUCE4,
	39	wxZIP_METHOD_IMPLODE,
	40	wxZIP_METHOD_TOKENIZE,
	41	wxZIP_METHOD_DEFLATE,
	42	wxZIP_METHOD_DEFLATE64,
	43	wxZIP_METHOD_BZIP2 = 12,
	44	wxZIP_METHOD_DEFAULT = 0xffff
	45	};
	46
	47	// Originating File-System.
	48	//
	49	// These are Pkware's values. Note that Info-zip disagree on some of them,
	50	// most notably NTFS.
	51	//
	52	enum wxZipSystem
	53	{
	54	wxZIP_SYSTEM_MSDOS,
	55	wxZIP_SYSTEM_AMIGA,
	56	wxZIP_SYSTEM_OPENVMS,
	57	wxZIP_SYSTEM_UNIX,
	58	wxZIP_SYSTEM_VM_CMS,
	59	wxZIP_SYSTEM_ATARI_ST,
	60	wxZIP_SYSTEM_OS2_HPFS,
	61	wxZIP_SYSTEM_MACINTOSH,
	62	wxZIP_SYSTEM_Z_SYSTEM,
	63	wxZIP_SYSTEM_CPM,
	64	wxZIP_SYSTEM_WINDOWS_NTFS,
	65	wxZIP_SYSTEM_MVS,
	66	wxZIP_SYSTEM_VSE,
	67	wxZIP_SYSTEM_ACORN_RISC,
	68	wxZIP_SYSTEM_VFAT,
	69	wxZIP_SYSTEM_ALTERNATE_MVS,
	70	wxZIP_SYSTEM_BEOS,
	71	wxZIP_SYSTEM_TANDEM,
	72	wxZIP_SYSTEM_OS_400
	73	};
	74
	75	// Dos/Win file attributes
	76	//
	77	enum wxZipAttributes
	78	{
	79	wxZIP_A_RDONLY = 0x01,
	80	wxZIP_A_HIDDEN = 0x02,
	81	wxZIP_A_SYSTEM = 0x04,
	82	wxZIP_A_SUBDIR = 0x10,
	83	wxZIP_A_ARCH = 0x20,
	84
	85	wxZIP_A_MASK = 0x37
	86	};
	87
	88	// Values for the flags field in the zip headers
	89	//
90	enum wxZipFlags
91	{
92	wxZIP_ENCRYPTED = 0x0001,
93	wxZIP_DEFLATE_NORMAL = 0x0000, // normal compression
94	wxZIP_DEFLATE_EXTRA = 0x0002, // extra compression
95	wxZIP_DEFLATE_FAST = 0x0004, // fast compression
96	wxZIP_DEFLATE_SUPERFAST = 0x0006, // superfast compression
97	wxZIP_DEFLATE_MASK = 0x0006,
98	wxZIP_SUMS_FOLLOW = 0x0008, // crc and sizes come after the data
99	wxZIP_ENHANCED = 0x0010,
100	wxZIP_PATCH = 0x0020,
101	wxZIP_STRONG_ENC = 0x0040,
102	wxZIP_UNUSED = 0x0F80,
103	wxZIP_RESERVED = 0xF000
104	};
105
106	// Forward decls
107	//
108	class WXDLLIMPEXP_BASE wxZipEntry;
109	class WXDLLIMPEXP_BASE wxZipInputStream;
110
111
112	/////////////////////////////////////////////////////////////////////////////
113	// wxZipNotifier
5526e819	114
00375592	115	class WXDLLIMPEXP_BASE wxZipNotifier
5526e819	116	{
f6bcfd97	117	public:
00375592 VZ	118	virtual ~wxZipNotifier() { }
	119
	120	virtual void OnEntryUpdated(wxZipEntry& entry) = 0;
	121	};
	122
	123
	124	/////////////////////////////////////////////////////////////////////////////
	125	// Zip Entry - holds the meta data for a file in the zip
	126
	127	class WXDLLIMPEXP_BASE wxZipEntry : public wxArchiveEntry
	128	{
	129	public:
	130	wxZipEntry(const wxString& name = wxEmptyString,
	131	const wxDateTime& dt = wxDateTime::Now(),
	132	wxFileOffset size = wxInvalidOffset);
	133	virtual ~wxZipEntry();
	134
	135	wxZipEntry(const wxZipEntry& entry);
	136	wxZipEntry& operator=(const wxZipEntry& entry);
	137
	138	// Get accessors
	139	wxDateTime GetDateTime() const { return m_DateTime; }
	140	wxFileOffset GetSize() const { return m_Size; }
	141	wxFileOffset GetOffset() const { return m_Offset; }
	142	wxString GetInternalName() const { return m_Name; }
	143	int GetMethod() const { return m_Method; }
	144	int GetFlags() const { return m_Flags; }
	145	wxUint32 GetCrc() const { return m_Crc; }
	146	wxFileOffset GetCompressedSize() const { return m_CompressedSize; }
	147	int GetSystemMadeBy() const { return m_SystemMadeBy; }
	148	wxString GetComment() const { return m_Comment; }
	149	wxUint32 GetExternalAttributes() const { return m_ExternalAttributes; }
	150	wxPathFormat GetInternalFormat() const { return wxPATH_UNIX; }
	151	int GetMode() const;
	152	const char *GetLocalExtra() const;
	153	size_t GetLocalExtraLen() const;
	154	const char *GetExtra() const;
	155	size_t GetExtraLen() const;
	156	wxString GetName(wxPathFormat format = wxPATH_NATIVE) const;
	157
	158	// is accessors
	159	inline bool IsDir() const;
	160	inline bool IsText() const;
	161	inline bool IsReadOnly() const;
	162	inline bool IsMadeByUnix() const;
	163
	164	// set accessors
	165	void SetDateTime(const wxDateTime& dt) { m_DateTime = dt; }
	166	void SetSize(wxFileOffset size) { m_Size = size; }
ceefc965	167	void SetMethod(int method) { m_Method = (wxUint16)method; }
00375592 VZ	168	void SetComment(const wxString& comment) { m_Comment = comment; }
	169	void SetExternalAttributes(wxUint32 attr ) { m_ExternalAttributes = attr; }
	170	void SetSystemMadeBy(int system);
	171	void SetMode(int mode);
	172	void SetExtra(const char *extra, size_t len);
	173	void SetLocalExtra(const char *extra, size_t len);
	174
	175	inline void SetName(const wxString& name,
	176	wxPathFormat format = wxPATH_NATIVE);
	177
	178	static wxString GetInternalName(const wxString& name,
	179	wxPathFormat format = wxPATH_NATIVE,
	180	bool *pIsDir = NULL);
	181
	182	// set is accessors
	183	void SetIsDir(bool isDir = true);
	184	inline void SetIsReadOnly(bool isReadOnly = true);
	185	inline void SetIsText(bool isText = true);
f6bcfd97	186
00375592 VZ	187	wxZipEntry *Clone() const { return ZipClone(); }
	188
	189	void SetNotifier(wxZipNotifier& notifier);
	190	void UnsetNotifier();
f6bcfd97 BP	191
f6bcfd97 BP	192	protected:
00375592 VZ	193	// Internal attributes
	194	enum { TEXT_ATTR = 1 };
	195
	196	// protected Get accessors
	197	int GetVersionNeeded() const { return m_VersionNeeded; }
	198	wxFileOffset GetKey() const { return m_Key; }
	199	int GetVersionMadeBy() const { return m_VersionMadeBy; }
	200	int GetDiskStart() const { return m_DiskStart; }
	201	int GetInternalAttributes() const { return m_InternalAttributes; }
	202
ceefc965	203	void SetVersionNeeded(int version) { m_VersionNeeded = (wxUint16)version; }
00375592	204	void SetOffset(wxFileOffset offset) { m_Offset = offset; }
ceefc965 WS	205	void SetFlags(int flags) { m_Flags = (wxUint16)flags; }
ceefc965 WS	206	void SetVersionMadeBy(int version) { m_VersionMadeBy = (wxUint8)version; }
00375592 VZ	207	void SetCrc(wxUint32 crc) { m_Crc = crc; }
	208	void SetCompressedSize(wxFileOffset size) { m_CompressedSize = size; }
	209	void SetKey(wxFileOffset offset) { m_Key = offset; }
ceefc965 WS	210	void SetDiskStart(int start) { m_DiskStart = (wxUint16)start; }
ceefc965 WS	211	void SetInternalAttributes(int attr) { m_InternalAttributes = (wxUint16)attr; }
00375592 VZ	212
	213	virtual wxZipEntry ZipClone() const { return new wxZipEntry(this); }
	214
	215	void Notify();
f6bcfd97 BP	216
f6bcfd97 BP	217	private:
00375592 VZ	218	wxArchiveEntry* DoClone() const { return ZipClone(); }
	219
	220	size_t ReadLocal(wxInputStream& stream, wxMBConv& conv);
	221	size_t WriteLocal(wxOutputStream& stream, wxMBConv& conv) const;
	222
	223	size_t ReadCentral(wxInputStream& stream, wxMBConv& conv);
	224	size_t WriteCentral(wxOutputStream& stream, wxMBConv& conv) const;
	225
	226	size_t ReadDescriptor(wxInputStream& stream);
	227	size_t WriteDescriptor(wxOutputStream& stream, wxUint32 crc,
	228	wxFileOffset compressedSize, wxFileOffset size);
	229
	230	wxUint8 m_SystemMadeBy; // one of enum wxZipSystem
	231	wxUint8 m_VersionMadeBy; // major * 10 + minor
	232
	233	wxUint16 m_VersionNeeded; // ver needed to extract (20 i.e. v2.0)
	234	wxUint16 m_Flags;
	235	wxUint16 m_Method; // compression method (one of wxZipMethod)
	236	wxDateTime m_DateTime;
	237	wxUint32 m_Crc;
	238	wxFileOffset m_CompressedSize;
588066b7	239	wxFileOffset m_Size;
00375592 VZ	240	wxString m_Name; // in internal format
	241	wxFileOffset m_Key; // the original offset for copied entries
	242	wxFileOffset m_Offset; // file offset of the entry
	243
	244	wxString m_Comment;
	245	wxUint16 m_DiskStart; // for multidisk archives, not unsupported
	246	wxUint16 m_InternalAttributes; // bit 0 set for text files
	247	wxUint32 m_ExternalAttributes; // system specific depends on SystemMadeBy
	248
	249	class wxZipMemory *m_Extra;
	250	class wxZipMemory *m_LocalExtra;
	251
	252	wxZipNotifier *m_zipnotifier;
	253	class wxZipWeakLinks *m_backlink;
f6bcfd97	254
00375592 VZ	255	friend class wxZipInputStream;
	256	friend class wxZipOutputStream;
	257
	258	DECLARE_DYNAMIC_CLASS(wxZipEntry)
	259	};
	260
	261
	262	/////////////////////////////////////////////////////////////////////////////
	263	// wxZipOutputStream
	264
	265	WX_DECLARE_LIST_WITH_DECL(wxZipEntry, _wxZipEntryList, class WXDLLIMPEXP_BASE);
	266
	267	class WXDLLIMPEXP_BASE wxZipOutputStream : public wxArchiveOutputStream
	268	{
	269	public:
	270	wxZipOutputStream(wxOutputStream& stream,
	271	int level = -1,
	272	wxMBConv& conv = wxConvLocal);
	273	virtual ~wxZipOutputStream();
	274
	275	bool PutNextEntry(wxZipEntry *entry) { return DoCreate(entry); }
	276
	277	bool PutNextEntry(const wxString& name,
	278	const wxDateTime& dt = wxDateTime::Now(),
	279	wxFileOffset size = wxInvalidOffset);
	280
	281	bool PutNextDirEntry(const wxString& name,
	282	const wxDateTime& dt = wxDateTime::Now());
	283
	284	bool CopyEntry(wxZipEntry *entry, wxZipInputStream& inputStream);
	285	bool CopyArchiveMetaData(wxZipInputStream& inputStream);
	286
	287	void Sync();
	288	bool CloseEntry();
	289	bool Close();
	290
	291	void SetComment(const wxString& comment) { m_Comment = comment; }
	292
	293	int GetLevel() const { return m_level; }
	294	void SetLevel(int level);
	295
	296	protected:
	297	virtual size_t OnSysWrite(const void *buffer, size_t size);
	298	virtual wxFileOffset OnSysTell() const { return m_entrySize; }
	299
	300	struct Buffer { const char *m_data; size_t m_size; };
	301	virtual wxOutputStream *OpenCompressor(wxOutputStream& stream,
	302	wxZipEntry& entry,
	303	const Buffer bufs[]);
	304	virtual bool CloseCompressor(wxOutputStream *comp);
	305
	306	bool IsParentSeekable() const { return m_offsetAdjustment
	307	!= wxInvalidOffset; }
	308
	309	private:
	310	bool PutNextEntry(wxArchiveEntry *entry);
	311	bool CopyEntry(wxArchiveEntry *entry, wxArchiveInputStream& stream);
	312	bool CopyArchiveMetaData(wxArchiveInputStream& stream);
	313
	314	bool IsOpened() const { return m_comp \|\| m_pending; }
	315
	316	bool DoCreate(wxZipEntry *entry, bool raw = false);
	317	void CreatePendingEntry(const void *buffer, size_t size);
	318	void CreatePendingEntry();
319
320	class wxStoredOutputStream *m_store;
321	class wxZlibOutputStream2 *m_deflate;
322	class wxZipStreamLink *m_backlink;
323	_wxZipEntryList m_entries;
324	char *m_initialData;
325	size_t m_initialSize;
326	wxZipEntry *m_pending;
327	bool m_raw;
328	wxFileOffset m_headerOffset;
329	size_t m_headerSize;
330	wxFileOffset m_entrySize;
331	wxUint32 m_crcAccumulator;
332	wxOutputStream *m_comp;
333	int m_level;
334	wxFileOffset m_offsetAdjustment;
335	wxString m_Comment;
336
337	DECLARE_NO_COPY_CLASS(wxZipOutputStream)
338	};
339
340
341	/////////////////////////////////////////////////////////////////////////////
342	// wxZipInputStream
343
344	class WXDLLIMPEXP_BASE wxZipInputStream : public wxArchiveInputStream
345	{
346	public:
347	typedef wxZipEntry entry_type;
348
349	wxZipInputStream(wxInputStream& stream, wxMBConv& conv = wxConvLocal);
350	wxZipInputStream(const wxString& archive, const wxString& file);
351	virtual ~wxZipInputStream();
352
353	bool OpenEntry(wxZipEntry& entry) { return DoOpen(&entry); }
354	bool CloseEntry();
355
356	wxZipEntry *GetNextEntry();
357
358	wxString GetComment();
359	int GetTotalEntries();
360
361	virtual wxFileOffset GetLength() const { return m_entry.GetSize(); }
362
363	protected:
364	size_t OnSysRead(void *buffer, size_t size);
365	wxFileOffset OnSysTell() const { return m_decomp ? m_decomp->TellI() : 0; }
366	wxFileOffset OnSysSeek(wxFileOffset seek, wxSeekMode mode);
367
368	virtual wxInputStream *OpenDecompressor(wxInputStream& stream);
369	virtual bool CloseDecompressor(wxInputStream *decomp);
370
371	private:
372	void Init();
373	wxInputStream& OpenFile(const wxString& archive);
374
375	wxArchiveEntry *DoGetNextEntry() { return GetNextEntry(); }
376
377	bool OpenEntry(wxArchiveEntry& entry);
378
379	wxStreamError ReadLocal(bool readEndRec = false);
380	wxStreamError ReadCentral();
381
382	wxUint32 ReadSignature();
383	bool FindEndRecord();
384	bool LoadEndRecord();
385
386	bool AtHeader() const { return m_headerSize == 0; }
387	bool AfterHeader() const { return m_headerSize > 0 && !m_decomp; }
388	bool IsOpened() const { return m_decomp != NULL; }
389
390	wxZipStreamLink MakeLink(wxZipOutputStream out);
391
392	bool DoOpen(wxZipEntry *entry = NULL, bool raw = false);
393	bool OpenDecompressor(bool raw = false);
394
395	class wxStoredInputStream *m_store;
396	class wxZlibInputStream2 *m_inflate;
397	class wxRawInputStream *m_rawin;
398	class wxFFileInputStream *m_ffile;
399	wxZipEntry m_entry;
400	bool m_raw;
401	size_t m_headerSize;
402	wxUint32 m_crcAccumulator;
403	wxInputStream *m_decomp;
404	bool m_parentSeekable;
405	class wxZipWeakLinks *m_weaklinks;
406	class wxZipStreamLink *m_streamlink;
407	wxFileOffset m_offsetAdjustment;
408	wxFileOffset m_position;
409	wxUint32 m_signature;
410	size_t m_TotalEntries;
411	wxString m_Comment;
412
413	friend bool wxZipOutputStream::CopyEntry(
414	wxZipEntry *entry, wxZipInputStream& inputStream);
415	friend bool wxZipOutputStream::CopyArchiveMetaData(
416	wxZipInputStream& inputStream);
22f3361e VZ	417
22f3361e VZ	418	DECLARE_NO_COPY_CLASS(wxZipInputStream)
5526e819 VS	419	};
	420
	421
81f90336 MW	422	/////////////////////////////////////////////////////////////////////////////
	423	// Iterators
	424
	425	#if wxUSE_STL \|\| defined WX_TEST_ARCHIVE_ITERATOR
	426	typedef wxArchiveIterator<wxZipInputStream> wxZipIter;
	427	typedef wxArchiveIterator<wxZipInputStream,
	428	std::pair<wxString, wxZipEntry*> > wxZipPairIter;
	429	#endif
	430
	431
00375592 VZ	432	/////////////////////////////////////////////////////////////////////////////
00375592 VZ	433	// wxZipClassFactory
5526e819	434
00375592 VZ	435	class WXDLLIMPEXP_BASE wxZipClassFactory : public wxArchiveClassFactory
	436	{
	437	public:
81f90336 MW	438	typedef wxZipEntry entry_type;
	439	typedef wxZipInputStream instream_type;
	440	typedef wxZipOutputStream outstream_type;
	441	typedef wxZipNotifier notifier_type;
	442	#if wxUSE_STL \|\| defined WX_TEST_ARCHIVE_ITERATOR
	443	typedef wxZipIter iter_type;
	444	typedef wxZipPairIter pairiter_type;
	445	#endif
	446
00375592 VZ	447	wxZipEntry *NewEntry() const
	448	{ return new wxZipEntry; }
	449	wxZipInputStream *NewStream(wxInputStream& stream) const
	450	{ return new wxZipInputStream(stream, GetConv()); }
	451	wxZipOutputStream *NewStream(wxOutputStream& stream) const
	452	{ return new wxZipOutputStream(stream, -1, GetConv()); }
	453
	454	wxString GetInternalName(const wxString& name,
	455	wxPathFormat format = wxPATH_NATIVE) const
	456	{ return wxZipEntry::GetInternalName(name, format); }
	457
	458	protected:
	459	wxArchiveEntry *DoNewEntry() const
	460	{ return NewEntry(); }
	461	wxArchiveInputStream *DoNewStream(wxInputStream& stream) const
	462	{ return NewStream(stream); }
	463	wxArchiveOutputStream *DoNewStream(wxOutputStream& stream) const
	464	{ return NewStream(stream); }
	465
	466	private:
	467	DECLARE_DYNAMIC_CLASS(wxZipClassFactory)
	468	};
	469
	470
00375592 VZ	471	/////////////////////////////////////////////////////////////////////////////
	472	// wxZipEntry inlines
	473
f44eaed6	474	inline bool wxZipEntry::IsText() const
00375592 VZ	475	{
	476	return (m_InternalAttributes & TEXT_ATTR) != 0;
	477	}
	478
f44eaed6	479	inline bool wxZipEntry::IsDir() const
00375592 VZ	480	{
	481	return (m_ExternalAttributes & wxZIP_A_SUBDIR) != 0;
	482	}
	483
f44eaed6	484	inline bool wxZipEntry::IsReadOnly() const
00375592 VZ	485	{
	486	return (m_ExternalAttributes & wxZIP_A_RDONLY) != 0;
	487	}
	488
f44eaed6	489	inline bool wxZipEntry::IsMadeByUnix() const
00375592 VZ	490	{
	491	const int pattern =
	492	(1 << wxZIP_SYSTEM_OPENVMS) \|
	493	(1 << wxZIP_SYSTEM_UNIX) \|
	494	(1 << wxZIP_SYSTEM_ATARI_ST) \|
	495	(1 << wxZIP_SYSTEM_ACORN_RISC) \|
	496	(1 << wxZIP_SYSTEM_BEOS) \| (1 << wxZIP_SYSTEM_TANDEM);
	497
	498	// note: some unix zippers put madeby = dos
	499	return (m_SystemMadeBy == wxZIP_SYSTEM_MSDOS
	500	&& (m_ExternalAttributes & ~0xFFFF))
	501	\|\| ((pattern >> m_SystemMadeBy) & 1);
	502	}
	503
f44eaed6	504	inline void wxZipEntry::SetIsText(bool isText)
00375592 VZ	505	{
	506	if (isText)
	507	m_InternalAttributes \|= TEXT_ATTR;
	508	else
	509	m_InternalAttributes &= ~TEXT_ATTR;
	510	}
	511
f44eaed6	512	inline void wxZipEntry::SetIsReadOnly(bool isReadOnly)
00375592 VZ	513	{
	514	if (isReadOnly)
	515	SetMode(GetMode() & ~0222);
	516	else
	517	SetMode(GetMode() \| 0200);
	518	}
	519
f44eaed6 RN	520	inline void wxZipEntry::SetName(const wxString& name,
f44eaed6 RN	521	wxPathFormat format /=wxPATH_NATIVE/)
00375592 VZ	522	{
	523	bool isDir;
	524	m_Name = GetInternalName(name, format, &isDir);
	525	SetIsDir(isDir);
	526	}
	527
	528
	529	#endif // wxUSE_ZLIB && wxUSE_STREAMS && wxUSE_ZIPSTREAM
	530
	531	#endif // _WX_WXZIPSTREAM_H__