qtziphlp.h

Go to the documentation of this file.

//
// Description: Zip helper, base class
//

/* Copyright (c) 2013 Konrad Rosenbaum <konrad@silmor.de>

Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in
all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
THE SOFTWARE. */

#ifndef ZIPHELPER_QTZIPHLP_H
#define ZIPHELPER_QTZIPHLP_H

#include "qtzipbase.h"
#include <QDateTime>

class QIODevice;

namespace QtZipHelper {

class Zip;
class Unzip;

class ZIPHLP_EXPORT ZipFileInfo
{
        public:
                ZipFileInfo();
                ZipFileInfo(const ZipFileInfo&);
                ZipFileInfo& operator=(const ZipFileInfo&);
                
                bool isValid()const{return !mName.isEmpty();}
                
                operator bool()const{return !mName.isEmpty();}
                
                QString fileName()const{return mName;}
                QDateTime createTime()const{return mTime;}
                int rawCompressionMethod()const{return mMethod;}
                ulong fileCRC()const{return mCRC;}
                ulong uncompressedSize()const{return mUSize;}
                
        private:
                friend class Zip;
                friend class Unzip;
                ZipFileInfo(const QString&,const QDateTime&,int,ulong,ulong);
                
                QDateTime mTime;
                QString mName;
                int mMethod;
                ulong mCRC,mUSize;
};

class ZIPHLP_EXPORT Zip:public ZipHlpBase
{
        Q_OBJECT
        friend class Unzip;
        public:
                explicit Zip(QObject* parent = 0);
                virtual ~Zip();
                
                enum OpenMode {
                        OpenTruncate=0,
                        OpenAppend=1
                };
                bool isOpen() const;
        public slots:
                virtual bool open(QIODevice *d, OpenMode mode=OpenTruncate);
                virtual void close();
                virtual bool storeFile(const QString &name, QIODevice &file,
                        const QDateTime &time = QDateTime::currentDateTime());
                virtual bool storeFile(const QString&name, QByteArray content,
                        const QDateTime &time = QDateTime::currentDateTime());
                virtual bool storeRawFile(const ZipFileInfo&info, QIODevice &file);
                virtual bool storeRawFile(const ZipFileInfo&info, QByteArray content);
};

class ZIPHLP_EXPORT Unzip:public ZipHlpBase
{
        Q_OBJECT
        public:
                explicit Unzip(QObject*parent=0);
                virtual ~Unzip();
                virtual bool isOpen() const;
        public slots:
                virtual bool open(QIODevice *d);
                virtual void close();
                virtual int fileCount()const;
                virtual ZipFileInfo firstFile();
                virtual ZipFileInfo nextFile();
                virtual ZipFileInfo locateFile(const QString &name, Qt::CaseSensitivity cs = Qt::CaseSensitive);
                virtual ZipFileInfo currentFile()const;
                virtual ZipFileInfo currentFile(QIODevice &d)const;
                virtual ZipFileInfo currentFile(QByteArray&)const;
                virtual QByteArray currentFileContent()const;
                virtual ZipFileInfo currentFileRaw(QIODevice &d)const;
                virtual ZipFileInfo currentFileRaw(QByteArray&)const;
                virtual QByteArray currentFileRawContent()const;
                virtual QString currentFileName()const;
                virtual bool copyCurrentFile(Zip&)const;
};

//end of namespace
};

using namespace QtZipHelper;

#endif