JlCompress.h

#ifndef JLCOMPRESSFOLDER_H_
#define JLCOMPRESSFOLDER_H_
 
/*
Copyright (C) 2010 Roberto Pompermaier
Copyright (C) 2005-2016 Sergey A. Tachenov
 
This file is part of QuaZip.
 
QuaZip is free software: you can redistribute it and/or modify
it under the terms of the GNU Lesser General Public License as published by
the Free Software Foundation, either version 2.1 of the License, or
(at your option) any later version.
 
QuaZip is distributed in the hope that it will be useful,
but WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
GNU Lesser General Public License for more details.
 
You should have received a copy of the GNU Lesser General Public License
along with QuaZip.  If not, see <http://www.gnu.org/licenses/>.
 
See COPYING file for the full LGPL text.
 
Original ZIP package is copyrighted by Gilles Vollant and contributors,
see quazip/(un)zip.h files for details. Basically it's the zlib license.
*/
 
#include "quazip.h"
#include "quazipfile.h"
#include "quazipfileinfo.h"
#include "quazip_qt_compat.h"
#include <QtCore/QString>
#include <QtCore/QDir>
#include <QtCore/QFileInfo>
#include <QtCore/QFile>
 
 
class QUAZIP_EXPORT JlCompress {
public:
    class Options {
    public:
        enum CompressionStrategy
        {
            Storage  = 0x00, // Z_NO_COMPRESSION 0
            Fastest  = 0x81, // Z_BEST_SPEED 1
            Faster   = 0x83,
            Standard = 0x86,
            Better   = 0x87,
            Best     = 0x89, // Z_BEST_COMPRESSION 9
            Default  = 0xff
        };
 
    public:
        explicit Options(const CompressionStrategy& strategy)
            : m_compressionStrategy(strategy) {}
 
        explicit Options(const QDateTime& dateTime = QDateTime(),
                         const CompressionStrategy& strategy = Default,
                         bool utf8Enabled = false,
                         const QByteArray& password = QByteArray())
            : m_dateTime(dateTime), m_compressionStrategy(strategy), m_utf8Enabled(utf8Enabled), m_password(password) {}
 
        QDateTime getDateTime() const {
            return m_dateTime;
        }
 
        void setDateTime(const QDateTime &dateTime) {
            m_dateTime = dateTime;
        }
 
        CompressionStrategy getCompressionStrategy() const {
            return m_compressionStrategy;
        }
 
        int getCompressionMethod() const {
            return m_compressionStrategy != Default ? m_compressionStrategy >> 4 : Z_DEFLATED;
        }
 
        int getCompressionLevel() const {
            return m_compressionStrategy != Default ? m_compressionStrategy & 0x0f : Z_DEFAULT_COMPRESSION;
        }
 
        void setCompressionStrategy(const CompressionStrategy &strategy) {
            m_compressionStrategy = strategy;
        }
 
        bool getUtf8Enabled() const {
            return m_utf8Enabled;
        }
 
        void setUtf8Enabled(bool utf8Enabled) {
            m_utf8Enabled = utf8Enabled;
        }
 
        QByteArray getPassword() const {
            return m_password;
        }
 
        void setPassword(const QByteArray& password) {
            m_password = password;
        }
 
    private:
        // If set, used as last modified on file inside the archive.
        // If compressing a directory, used for all files.
        QDateTime m_dateTime;
 
        CompressionStrategy m_compressionStrategy;
 
        /* Enables UTF-8 support for filenames and comments.
         *
         * For methods that create new archives (compressFile, compressFiles, compressDir):
         *   - This flag determines the encoding for all files in the new archive.
         *
         * For methods that add to existing archives (addFile, addFiles, addDir):
         *   - This flag MUST match the encoding already used in the existing archive.
         *   - QuaZip does not auto-detect the existing encoding.
         *   - Mismatched encoding will create an inconsistent archive.
         *
         * For methods that receive QuaZip* zip as an argument:
         *   - This flag is ignored (zip is already opened).
         *   - You must call setUtf8Enabled() on the QuaZip object before open().
         * */
        bool m_utf8Enabled;
 
        /* Password for encryption/decryption.
         *
         * If set during compression, the files will be encrypted with this password.
         * If set during extraction, this password will be used to decrypt the files.
         * Empty password means no encryption/decryption.
         * */
        QByteArray m_password;
    };
 
    static bool copyData(QIODevice &inFile, QIODevice &outFile);
    static QStringList extractDir(QuaZip &zip, const QString &dir);
    static QStringList getFileList(QuaZip *zip);
    static QString extractFile(QuaZip &zip, QString fileName, QString fileDest);
    static QStringList extractFiles(QuaZip &zip, const QStringList &files, const QString &dir);
 
 
    static bool extractFile(QuaZip* zip, QString fileName, QString fileDest);
 
 
    static bool compressFile(QuaZip* zip, QString fileName, QString fileDest);
 
 
    static bool compressFile(QuaZip* zip, QString fileName, QString fileDest, const Options& options);
 
 
    static bool compressSubDir(QuaZip* parentZip, QString dir, QString parentDir, bool recursive,
                               QDir::Filters filters);
 
 
    static bool compressSubDir(QuaZip* parentZip, QString dir, QString parentDir, bool recursive,
                               QDir::Filters filters, const Options& options);
 
 
    static bool removeFile(QStringList listFile);
 
 
    static bool compressFile(QString fileCompressed, QString file);
 
 
    static bool compressFile(QString fileCompressed, QString file, const Options& options);
 
 
    static bool compressFiles(QString fileCompressed, QStringList files);
 
 
    static bool compressFiles(QString fileCompressed, QStringList files, const Options& options);
 
 
    static bool addFile(QString fileCompressed, QString file);
 
 
    static bool addFile(QString fileCompressed, QString file, const Options& options);
 
 
    static bool addFiles(QString fileCompressed, QStringList files);
 
 
    static bool addFiles(QString fileCompressed, QStringList files, const Options& options);
 
 
    static bool addDir(QString fileCompressed, QString dir = QString(), bool recursive = true);
 
 
    static bool addDir(QString fileCompressed, QString dir,
                       bool recursive, QDir::Filters filters);
 
 
    static bool addDir(QString fileCompressed, QString dir,
                       bool recursive, QDir::Filters filters, const Options& options);
 
 
    static bool compressDir(QString fileCompressed, QString dir = QString(), bool recursive = true);
 
    static bool compressDir(QString fileCompressed, QString dir,
                            bool recursive, QDir::Filters filters);
 
    static bool compressDir(QString fileCompressed, QString dir,
                            bool recursive, QDir::Filters filters, const Options& options);
 
 
    static QString extractFile(QString fileCompressed, QString fileName, QString fileDest = QString());
 
 
    static QStringList extractFiles(QString fileCompressed, QStringList files, QString dir = QString());
 
 
    static QStringList extractDir(QString fileCompressed, QString dir = QString());
 
 
    static QStringList extractDir(QString fileCompressed, QuazipTextCodec* fileNameCodec, QString dir = QString());
 
 
    static QString extractFile(QString fileCompressed, QString fileName, QString fileDest, const QByteArray& password);
 
 
    static QStringList extractFiles(QString fileCompressed, QStringList files, QString dir, const QByteArray& password);
 
 
    static QStringList extractDir(QString fileCompressed, QString dir, const QByteArray& password);
 
 
    static QStringList getFileList(QString fileCompressed);
 
 
    static QString extractFile(QIODevice *ioDevice, QString fileName, QString fileDest = QString());
 
 
    static QStringList extractFiles(QIODevice *ioDevice, QStringList files, QString dir = QString());
 
 
    static QStringList extractDir(QIODevice *ioDevice, QString dir = QString());
 
 
    static QStringList extractDir(QIODevice* ioDevice, QuazipTextCodec* fileNameCodec, QString dir = QString());
 
 
    static QStringList getFileList(QIODevice *ioDevice);
};
 
#endif /* JLCOMPRESSFOLDER_H_ */