/* ============================================================
 *
 * This file is a part of digiKam project
 * https://www.digikam.org
 *
 * Date        : 2023-05-15
 * Description : geolocation engine based on Marble.
 *               (c) 2015 The Qt Company Ltd.
 *               This file is based on qzipwriter_p.h from Qt with the original license
 *               below, taken from
 *               https://code.qt.io/cgit/qt/qt.git/plain/src/gui/text/qzipwriter_p.h
 *
 * SPDX-FileCopyrightText: 2023-2024 by Gilles Caulier <caulier dot gilles at gmail dot com>
 *
 * SPDX-License-Identifier: LGPL-2.1-only WITH Qt-LGPL-exception-1.1 OR LGPL-3.0-only WITH Qt-LGPL-exception-1.1 OR GPL-3.0-only OR LicenseRef-Qt-Commercial
 *
 * ============================================================ */

#include <qglobal.h>

#ifndef QT_NO_TEXTODFWRITER

#   include "MarbleZipReader.h"
#   include "MarbleZipWriter.h"

// Qt includes

#   include <QDateTime>
#   include <qplatformdefs.h>
#   include <qendian.h>
#   include <QDir>

// Local includes

#   include "digikam_debug.h"

// Zlib includes

#   include <zlib.h>

#   if defined(Q_OS_WIN)
#       undef S_IFREG
#       define S_IFREG 0100000

#       ifndef S_IFDIR
#           define S_IFDIR 0040000
#       endif

#       ifndef S_ISDIR
#           define S_ISDIR(x) ((x) & S_IFDIR) > 0
#       endif

#       ifndef S_ISREG
#           define S_ISREG(x) ((x) & 0170000) == S_IFREG
#       endif

#       define S_IFLNK 020000
#       define S_ISLNK(x) ((x) & S_IFLNK) > 0

#       ifndef S_IRUSR
#           define S_IRUSR 0400
#       endif

#       ifndef S_IWUSR
#           define S_IWUSR 0200
#       endif

#       ifndef S_IXUSR
#           define S_IXUSR 0100
#       endif

#       define S_IRGRP 0040
#       define S_IWGRP 0020
#       define S_IXGRP 0010
#       define S_IROTH 0004
#       define S_IWOTH 0002
#       define S_IXOTH 0001
#   endif

namespace Marble
{

static inline uint readUInt(const uchar* data)
{
    return (data[0]) + (data[1] << 8) + (data[2] << 16) + (data[3] << 24);
}

static inline ushort readUShort(const uchar* data)
{
    return (data[0]) + (data[1] << 8);
}

static inline void writeUInt(uchar* data, uint i)
{
    data[0] = i & 0xff;
    data[1] = (i >> 8) & 0xff;
    data[2] = (i >> 16) & 0xff;
    data[3] = (i >> 24) & 0xff;
}

static inline void writeUShort(uchar* data, ushort i)
{
    data[0] = i & 0xff;
    data[1] = (i >> 8) & 0xff;
}

static inline void copyUInt(uchar* dest, const uchar* src)
{
    dest[0] = src[0];
    dest[1] = src[1];
    dest[2] = src[2];
    dest[3] = src[3];
}

static inline void copyUShort(uchar* dest, const uchar* src)
{
    dest[0] = src[0];
    dest[1] = src[1];
}

static void writeMSDosDate(uchar* dest, const QDateTime& dt)
{
    if (dt.isValid())
    {
        quint16 time =
            (dt.time().hour() << 11)         // 5 bit hour
            | (dt.time().minute() << 5)      // 6 bit minute
            | (dt.time().second() >> 1);     // 5 bit double seconds

        dest[0] = time & 0xff;
        dest[1] = time >> 8;

        quint16 date =
            ((dt.date().year() - 1980) << 9) // 7 bit year 1980-based
            | (dt.date().month() << 5)       // 4 bit month
            | (dt.date().day());             // 5 bit day

        dest[2] = char(date);
        dest[3] = char(date >> 8);
    }

    else
    {
        dest[0] = 0;
        dest[1] = 0;
        dest[2] = 0;
        dest[3] = 0;
    }
}

static quint32 permissionsToMode(QFile::Permissions perms)
{
    quint32 mode = 0;

    if (perms & QFile::ReadOwner)
    {
        mode |= S_IRUSR;
    }

    if (perms & QFile::WriteOwner)
    {
        mode |= S_IWUSR;
    }

    if (perms & QFile::ExeOwner)
    {
        mode |= S_IXUSR;
    }

    if (perms & QFile::ReadUser)
    {
        mode |= S_IRUSR;
    }

    if (perms & QFile::WriteUser)
    {
        mode |= S_IWUSR;
    }

    if (perms & QFile::ExeUser)
    {
        mode |= S_IXUSR;
    }

    if (perms & QFile::ReadGroup)
    {
        mode |= S_IRGRP;
    }

    if (perms & QFile::WriteGroup)
    {
        mode |= S_IWGRP;
    }

    if (perms & QFile::ExeGroup)
    {
        mode |= S_IXGRP;
    }

    if (perms & QFile::ReadOther)
    {
        mode |= S_IROTH;
    }

    if (perms & QFile::WriteOther)
    {
        mode |= S_IWOTH;
    }

    if (perms & QFile::ExeOther)
    {
        mode |= S_IXOTH;
    }

    return mode;
}

static int inflate(Bytef* dest, ulong* destLen, const Bytef* source, ulong sourceLen)
{
    z_stream stream;
    int err;

    stream.next_in = (Bytef*)source;
    stream.avail_in = (uInt)sourceLen;

    if ((uLong)stream.avail_in != sourceLen)
    {
        return Z_BUF_ERROR;
    }

    stream.next_out = dest;
    stream.avail_out = (uInt) * destLen;

    if ((uLong)stream.avail_out != *destLen)
    {
        return Z_BUF_ERROR;
    }

    stream.zalloc = (alloc_func)nullptr;
    stream.zfree = (free_func)nullptr;

    err = inflateInit2(&stream, -MAX_WBITS);

    if (err != Z_OK)
    {
        return err;
    }

    err = inflate(&stream, Z_FINISH);

    if (err != Z_STREAM_END)
    {
        inflateEnd(&stream);

        if (err == Z_NEED_DICT || (err == Z_BUF_ERROR && stream.avail_in == 0))
        {
            return Z_DATA_ERROR;
        }

        return err;
    }

    *destLen = stream.total_out;

    err = inflateEnd(&stream);
    return err;
}

static int deflate(Bytef* dest, ulong* destLen, const Bytef* source, ulong sourceLen)
{
    z_stream stream;
    int err;

    stream.next_in = (Bytef*)source;
    stream.avail_in = (uInt)sourceLen;
    stream.next_out = dest;
    stream.avail_out = (uInt) * destLen;

    if ((uLong)stream.avail_out != *destLen)
    {
        return Z_BUF_ERROR;
    }

    stream.zalloc = (alloc_func)nullptr;
    stream.zfree = (free_func)nullptr;
    stream.opaque = (voidpf)nullptr;

    err = deflateInit2(&stream, Z_DEFAULT_COMPRESSION, Z_DEFLATED, -MAX_WBITS, 8, Z_DEFAULT_STRATEGY);

    if (err != Z_OK)
    {
        return err;
    }

    err = deflate(&stream, Z_FINISH);

    if (err != Z_STREAM_END)
    {
        deflateEnd(&stream);
        return err == Z_OK ? Z_BUF_ERROR : err;
    }

    *destLen = stream.total_out;

    err = deflateEnd(&stream);
    return err;
}

static QFile::Permissions modeToPermissions(quint32 mode)
{
    QFile::Permissions ret;

    if (mode & S_IRUSR)
    {
        ret |= QFile::ReadOwner;
    }

    if (mode & S_IWUSR)
    {
        ret |= QFile::WriteOwner;
    }

    if (mode & S_IXUSR)
    {
        ret |= QFile::ExeOwner;
    }

    if (mode & S_IRUSR)
    {
        ret |= QFile::ReadUser;
    }

    if (mode & S_IWUSR)
    {
        ret |= QFile::WriteUser;
    }

    if (mode & S_IXUSR)
    {
        ret |= QFile::ExeUser;
    }

    if (mode & S_IRGRP)
    {
        ret |= QFile::ReadGroup;
    }

    if (mode & S_IWGRP)
    {
        ret |= QFile::WriteGroup;
    }

    if (mode & S_IXGRP)
    {
        ret |= QFile::ExeGroup;
    }

    if (mode & S_IROTH)
    {
        ret |= QFile::ReadOther;
    }

    if (mode & S_IWOTH)
    {
        ret |= QFile::WriteOther;
    }

    if (mode & S_IXOTH)
    {
        ret |= QFile::ExeOther;
    }

    return ret;
}

static QDateTime readMSDosDate(const uchar* src)
{
    uint dosDate = readUInt(src);
    quint64 uDate;
    uDate = (quint64)(dosDate >> 16);
    uint tm_mday = (uDate & 0x1f);
    uint tm_mon = ((uDate & 0x1E0) >> 5);
    uint tm_year = (((uDate & 0x0FE00) >> 9) + 1980);
    uint tm_hour = ((dosDate & 0xF800) >> 11);
    uint tm_min = ((dosDate & 0x7E0) >> 5);
    uint tm_sec = ((dosDate & 0x1f) << 1);

    return QDateTime(QDate(tm_year, tm_mon, tm_mday), QTime(tm_hour, tm_min, tm_sec));
}

class Q_DECL_HIDDEN LocalFileHeader
{
public:

    uchar signature[4]; //  0x04034b50
    uchar version_needed[2];
    uchar general_purpose_bits[2];
    uchar compression_method[2];
    uchar last_mod_file[4];
    uchar crc_32[4];
    uchar compressed_size[4];
    uchar uncompressed_size[4];
    uchar file_name_length[2];
    uchar extra_field_length[2];
};

class Q_DECL_HIDDEN DataDescriptor
{
public:

    uchar crc_32[4];
    uchar compressed_size[4];
    uchar uncompressed_size[4];
};

class Q_DECL_HIDDEN CentralFileHeader
{
public:

    uchar signature[4]; // 0x02014b50
    uchar version_made[2];
    uchar version_needed[2];
    uchar general_purpose_bits[2];
    uchar compression_method[2];
    uchar last_mod_file[4];
    uchar crc_32[4];
    uchar compressed_size[4];
    uchar uncompressed_size[4];
    uchar file_name_length[2];
    uchar extra_field_length[2];
    uchar file_comment_length[2];
    uchar disk_start[2];
    uchar internal_file_attributes[2];
    uchar external_file_attributes[4];
    uchar offset_local_header[4];
    LocalFileHeader toLocalHeader() const;
};

class Q_DECL_HIDDEN EndOfDirectory
{
public:

    uchar signature[4]; // 0x06054b50
    uchar this_disk[2];
    uchar start_of_directory_disk[2];
    uchar num_dir_entries_this_disk[2];
    uchar num_dir_entries[2];
    uchar directory_size[4];
    uchar dir_start_offset[4];
    uchar comment_length[2];
};

class Q_DECL_HIDDEN FileHeader
{
public:

    CentralFileHeader h;
    QByteArray file_name;
    QByteArray extra_field;
    QByteArray file_comment;
};

MarbleZipReader::FileInfo::FileInfo()
    : isDir(false), isFile(false), isSymLink(false), crc32(0), size(0)
{
}

MarbleZipReader::FileInfo::~FileInfo()
{
}

MarbleZipReader::FileInfo::FileInfo(const FileInfo& other)
{
    operator=(other);
}

MarbleZipReader::FileInfo& MarbleZipReader::FileInfo::operator=(const FileInfo& other)
{
    filePath = other.filePath;
    isDir = other.isDir;
    isFile = other.isFile;
    isSymLink = other.isSymLink;
    permissions = other.permissions;
    crc32 = other.crc32;
    size = other.size;
    lastModified = other.lastModified;
    return *this;
}

bool MarbleZipReader::FileInfo::isValid() const
{
    return isDir || isFile || isSymLink;
}

class Q_DECL_HIDDEN QZipPrivate
{
public:
    QZipPrivate(QIODevice* device, bool ownDev)
        : device(device), ownDevice(ownDev), dirtyFileTree(true), start_of_directory(0)
    {
    }

    ~QZipPrivate()
    {
        if (ownDevice)
        {
            delete device;
        }
    }

    void fillFileInfo(int index, MarbleZipReader::FileInfo& fileInfo) const;

    QIODevice* device;
    bool ownDevice;
    bool dirtyFileTree;
    QList<FileHeader> fileHeaders;
    QByteArray comment;
    uint start_of_directory;
};

void QZipPrivate::fillFileInfo(int index, MarbleZipReader::FileInfo& fileInfo) const
{
    FileHeader header = fileHeaders.at(index);
    fileInfo.filePath = QString::fromLocal8Bit(header.file_name);
    const quint32 mode = (qFromLittleEndian<quint32>(&header.h.external_file_attributes[0]) >> 16) & 0xFFFF;

    if (mode == 0)
    {
        fileInfo.isDir = false;
        fileInfo.isFile = true;
        fileInfo.isSymLink = false;
        fileInfo.permissions = QFile::ReadOwner;
    }

    else
    {
        fileInfo.isDir = S_ISDIR(mode);
        fileInfo.isFile = S_ISREG(mode);
        fileInfo.isSymLink = S_ISLNK(mode);
        fileInfo.permissions = modeToPermissions(mode);
    }

    fileInfo.crc32 = readUInt(header.h.crc_32);
    fileInfo.size = readUInt(header.h.uncompressed_size);
    fileInfo.lastModified = readMSDosDate(header.h.last_mod_file);
}

class Q_DECL_HIDDEN MarbleZipReaderPrivate : public QZipPrivate
{
public:
    MarbleZipReaderPrivate(QIODevice* device, bool ownDev)
        : QZipPrivate(device, ownDev), status(MarbleZipReader::NoError)
    {
    }

    void scanFiles();

    MarbleZipReader::Status status;
};

class Q_DECL_HIDDEN MarbleZipWriterPrivate : public QZipPrivate
{
public:

    MarbleZipWriterPrivate(QIODevice* device, bool ownDev)
        : QZipPrivate(device, ownDev),
          status(MarbleZipWriter::NoError),
          permissions(QFile::ReadOwner | QFile::WriteOwner),
          compressionPolicy(MarbleZipWriter::AlwaysCompress)
    {
    }

    MarbleZipWriter::Status status;
    QFile::Permissions permissions;
    MarbleZipWriter::CompressionPolicy compressionPolicy;

    enum EntryType
    {
        Directory,
        File,
        Symlink
    };

    void addEntry(EntryType type, const QString& fileName, const QByteArray& contents);
};

LocalFileHeader CentralFileHeader::toLocalHeader() const
{
    LocalFileHeader h;
    writeUInt(h.signature, 0x04034b50);
    copyUShort(h.version_needed, version_needed);
    copyUShort(h.general_purpose_bits, general_purpose_bits);
    copyUShort(h.compression_method, compression_method);
    copyUInt(h.last_mod_file, last_mod_file);
    copyUInt(h.crc_32, crc_32);
    copyUInt(h.compressed_size, compressed_size);
    copyUInt(h.uncompressed_size, uncompressed_size);
    copyUShort(h.file_name_length, file_name_length);
    copyUShort(h.extra_field_length, extra_field_length);

    return h;       // cppcheck-suppress uninitvar
}

void MarbleZipReaderPrivate::scanFiles()
{
    if (!dirtyFileTree)
    {
        return;
    }

    if (!(device->isOpen() || device->open(QIODevice::ReadOnly)))
    {
        status = MarbleZipReader::FileOpenError;
        return;
    }

    if ((device->openMode() & QIODevice::ReadOnly) == 0)   // only read the index from readable files.
    {
        status = MarbleZipReader::FileReadError;
        return;
    }

    dirtyFileTree = false;
    uchar tmp[4];
    device->read((char*)tmp, 4);

    if (readUInt(tmp) != 0x04034b50)
    {
        qCWarning(DIGIKAM_MARBLE_LOG) << "QZip: not a zip file!";
        return;
    }

    // find EndOfDirectory header

    int i = 0;
    int start_of_directory = -1;
    int num_dir_entries = 0;
    EndOfDirectory eod;

    while (start_of_directory == -1)
    {
        int pos = device->size() - sizeof(EndOfDirectory) - i;

        if (pos < 0 || i > 65535)
        {
            qCWarning(DIGIKAM_MARBLE_LOG) << "QZip: EndOfDirectory not found";
            return;
        }

        device->seek(pos);
        device->read((char*)&eod, sizeof(EndOfDirectory));

        if (readUInt(eod.signature) == 0x06054b50)
        {
            break;
        }

        ++i;
    }

    // have the eod

    start_of_directory = readUInt(eod.dir_start_offset);
    num_dir_entries = readUShort(eod.num_dir_entries);
    qCDebug(DIGIKAM_MARBLE_LOG) << QString::asprintf("start_of_directory at %d, num_dir_entries=%d", start_of_directory, num_dir_entries);
    int comment_length = readUShort(eod.comment_length);

    if (comment_length != i)
    {
        qCWarning(DIGIKAM_MARBLE_LOG) << "QZip: failed to parse zip file.";
    }

    comment = device->read(qMin(comment_length, i));


    device->seek(start_of_directory);

    for (i = 0; i < num_dir_entries; ++i)
    {
        FileHeader header;
        int read = device->read((char*) &header.h, sizeof(CentralFileHeader));

        if (read < (int)sizeof(CentralFileHeader))
        {
            qCWarning(DIGIKAM_MARBLE_LOG) << "QZip: Failed to read complete header, index may be incomplete";
            break;
        }

        if (readUInt(header.h.signature) != 0x02014b50)
        {
            qCWarning(DIGIKAM_MARBLE_LOG) << "QZip: invalid header signature, index may be incomplete";
            break;
        }

        int l = readUShort(header.h.file_name_length);
        header.file_name = device->read(l);

        if (header.file_name.length() != l)
        {
            qCWarning(DIGIKAM_MARBLE_LOG) << "QZip: Failed to read filename from zip index, index may be incomplete";
            break;
        }

        l = readUShort(header.h.extra_field_length);
        header.extra_field = device->read(l);

        if (header.extra_field.length() != l)
        {
            qCWarning(DIGIKAM_MARBLE_LOG) << "QZip: Failed to read extra field in zip file, skipping file, index may be incomplete";
            break;
        }

        l = readUShort(header.h.file_comment_length);
        header.file_comment = device->read(l);

        if (header.file_comment.length() != l)
        {
            qCWarning(DIGIKAM_MARBLE_LOG) << "QZip: Failed to read file comment, index may be incomplete";
            break;
        }

        qCDebug(DIGIKAM_MARBLE_LOG) << QString::asprintf("found file '%s'", header.file_name.data());
        fileHeaders.append(header);
    }
}

void MarbleZipWriterPrivate::addEntry(EntryType type, const QString& fileName, const QByteArray& contents/*, QFile::Permissions permissions, QZip::Method m*/)
{

#ifndef NDEBUG

    static const char* entryTypes[] =
    {
        "directory",
        "file     ",
        "symlink  "
    };

    qCDebug(DIGIKAM_MARBLE_LOG) << "adding" << entryTypes[type] << ":" << fileName.toUtf8().data() << (type == 2 ? QByteArray(" -> " + contents).constData() : "");

#endif

    if (!(device->isOpen() || device->open(QIODevice::WriteOnly)))
    {
        status = MarbleZipWriter::FileOpenError;
        return;
    }

    device->seek(start_of_directory);

    // don't compress small files
    MarbleZipWriter::CompressionPolicy compression = compressionPolicy;

    if (compressionPolicy == MarbleZipWriter::AutoCompress)
    {
        if (contents.length() < 64)
        {
            compression = MarbleZipWriter::NeverCompress;
        }

        else
        {
            compression = MarbleZipWriter::AlwaysCompress;
        }
    }

    FileHeader header;
    memset(&header.h, 0, sizeof(CentralFileHeader));
    writeUInt(header.h.signature, 0x02014b50);

    writeUShort(header.h.version_needed, 0x14);
    writeUInt(header.h.uncompressed_size, contents.length());
    writeMSDosDate(header.h.last_mod_file, QDateTime::currentDateTime());
    QByteArray data = contents;

    if (compression == MarbleZipWriter::AlwaysCompress)
    {
        writeUShort(header.h.compression_method, 8);

        ulong len = contents.length();

        // shamelessly copied form zlib

        len += (len >> 12) + (len >> 14) + 11;
        int res;

        do
        {
            data.resize(len);
            res = deflate((uchar*)data.data(), &len, (const uchar*)contents.constData(), contents.length());

            switch (res)
            {
                case Z_OK:
                    data.resize(len);
                    break;

                case Z_MEM_ERROR:
                    qCWarning(DIGIKAM_MARBLE_LOG) << QString::fromUtf8("QZip: Z_MEM_ERROR: Not enough memory to compress file, skipping");
                    data.resize(0);
                    break;

                case Z_BUF_ERROR:
                    len *= 2;
                    break;
            }
        }
        while (res == Z_BUF_ERROR);
    }

    // TODO add a check if data.length() > contents.length().  Then try to store the original and revert the compression method to be uncompressed

    writeUInt(header.h.compressed_size, data.length());
    uint crc_32 = ::crc32(0, nullptr, 0);
    crc_32 = ::crc32(crc_32, (const uchar*)contents.constData(), contents.length());
    writeUInt(header.h.crc_32, crc_32);

    header.file_name = fileName.toLocal8Bit();

    if (header.file_name.size() > 0xffff)
    {
        qCWarning(DIGIKAM_MARBLE_LOG) << QString::fromUtf8("QZip: Filename too long, chopping it to 65535 characters");
        header.file_name = header.file_name.left(0xffff);
    }

    writeUShort(header.h.file_name_length, header.file_name.length());

    //h.extra_field_length[2];

    writeUShort(header.h.version_made, 3 << 8);

    //uchar internal_file_attributes[2];
    //uchar external_file_attributes[4];

    quint32 mode = permissionsToMode(permissions);

    switch (type)
    {
        case File:
            mode |= S_IFREG;
            break;

        case Directory:
            mode |= S_IFDIR;
            break;

        case Symlink:
            mode |= S_IFLNK;
            break;
    }

    writeUInt(header.h.external_file_attributes, mode << 16);
    writeUInt(header.h.offset_local_header, start_of_directory);


    fileHeaders.append(header);

    LocalFileHeader h = header.h.toLocalHeader();
    device->write((const char*)&h, sizeof(LocalFileHeader));
    device->write(header.file_name);
    device->write(data);
    start_of_directory = device->pos();
    dirtyFileTree = true;
}

//////////////////////////////  Reader

/*!
    \class Q_DECL_HIDDEN QZipReader::FileInfo
    \internal
    Represents one entry in the zip table of contents.
*/

/*!
    \variable FileInfo::filePath
    The full filepath inside the archive.
*/

/*!
    \variable FileInfo::isDir
    A boolean type indicating if the entry is a directory.
*/

/*!
    \variable FileInfo::isFile
    A boolean type, if it is one this entry is a file.
*/

/*!
    \variable FileInfo::isSymLink
    A boolean type, if it is one this entry is symbolic link.
*/

/*!
    \variable FileInfo::permissions
    A list of flags for the permissions of this entry.
*/

/*!
    \variable FileInfo::crc32
    The calculated checksum as a crc32 type.
*/

/*!
    \variable FileInfo::size
    The total size of the unpacked content.
*/

/*!
    \variable FileInfo::d
    \internal
    private pointer.
*/

/*!
    \class Q_DECL_HIDDEN QZipReader
    \internal
    \since 4.5

    \brief the QZipReader class Q_DECL_HIDDEN provides a way to inspect the contents of a zip
    archive and extract individual files from it.

    QZipReader can be used to read a zip archive either from a file or from any
    device. An in-memory QBuffer for instance.  The reader can be used to read
    which files are in the archive using fileInfoList() and entryInfoAt() but
    also to extract individual files using fileData() or even to extract all
    files in the archive using extractAll()
*/

/*!
    Create a new zip archive that operates on the \a fileName.  The file will be
    opened with the \a mode.
*/
MarbleZipReader::MarbleZipReader(const QString& archive, QIODevice::OpenMode mode)
{
    QScopedPointer<QFile> f(new QFile(archive));
    f->open(mode);
    MarbleZipReader::Status status;

    if (f->error() == QFile::NoError)
    {
        status = NoError;
    }

    else
    {
        if (f->error() == QFile::ReadError)
        {
            status = FileReadError;
        }

        else if (f->error() == QFile::OpenError)
        {
            status = FileOpenError;
        }

        else if (f->error() == QFile::PermissionsError)
        {
            status = FilePermissionsError;
        }

        else
        {
            status = FileError;
        }
    }

    d = new MarbleZipReaderPrivate(f.data(), /*ownDevice=*/true);
    f.take();
    d->status = status;
}

/*!
    Create a new zip archive that operates on the archive found in \a device.
    You have to open the device previous to calling the constructor and only a
    device that is readable will be scanned for zip filecontent.
 */
MarbleZipReader::MarbleZipReader(QIODevice* device)
    : d(new MarbleZipReaderPrivate(device, /*ownDevice=*/false))
{
    Q_ASSERT(device);
}

/*!
    Desctructor
*/
MarbleZipReader::~MarbleZipReader()
{
    close();
    delete d;
}

/*!
    Returns device used for reading zip archive.
*/
QIODevice* MarbleZipReader::device() const
{
    return d->device;
}

/*!
    Returns true if the user can read the file; otherwise returns false.
*/
bool MarbleZipReader::isReadable() const
{
    return d->device->isReadable();
}

/*!
    Returns true if the file exists; otherwise returns false.
*/
bool MarbleZipReader::exists() const
{
    QFile* f = qobject_cast<QFile*> (d->device);

    if (f == nullptr)
    {
        return true;
    }

    return f->exists();
}

/*!
    Returns the list of files the archive contains.
*/
QList<MarbleZipReader::FileInfo> MarbleZipReader::fileInfoList() const
{
    d->scanFiles();
    QList<MarbleZipReader::FileInfo> files;

    for (int i = 0; i < d->fileHeaders.size(); ++i)
    {
        MarbleZipReader::FileInfo fi;
        d->fillFileInfo(i, fi);
        files.append(fi);
    }

    return files;

}

/*!
    Return the number of items in the zip archive.
*/
int MarbleZipReader::count() const
{
    d->scanFiles();
    return d->fileHeaders.count();
}

/*!
    Returns a FileInfo of an entry in the zipfile.
    The \a index is the index into the directory listing of the zipfile.
    Returns an invalid FileInfo if \a index is out of boundaries.

    \sa fileInfoList()
*/
MarbleZipReader::FileInfo MarbleZipReader::entryInfoAt(int index) const
{
    d->scanFiles();
    MarbleZipReader::FileInfo fi;

    if (index >= 0 && index < d->fileHeaders.count())
    {
        d->fillFileInfo(index, fi);
    }

    return fi;
}

/*!
    Fetch the file contents from the zip archive and return the uncompressed bytes.
*/
QByteArray MarbleZipReader::fileData(const QString& fileName) const
{
    d->scanFiles();
    int i;

    for (i = 0; i < d->fileHeaders.size(); ++i)
    {
        if (QString::fromLocal8Bit(d->fileHeaders.at(i).file_name) == fileName)
        {
            break;
        }
    }

    if (i == d->fileHeaders.size())
    {
        return QByteArray();
    }

    FileHeader header = d->fileHeaders.at(i);

    int compressed_size = readUInt(header.h.compressed_size);
    int uncompressed_size = readUInt(header.h.uncompressed_size);
    int start = readUInt(header.h.offset_local_header);

    //qCDebug(DIGIKAM_MARBLE_LOG) << QString::fromUtf8("uncompressing file %d: local header at %d", i, start);

    d->device->seek(start);
    LocalFileHeader lh;
    d->device->read((char*)&lh, sizeof(LocalFileHeader));
    uint skip = readUShort(lh.file_name_length) + readUShort(lh.extra_field_length);
    d->device->seek(d->device->pos() + skip);

    int compression_method = readUShort(lh.compression_method);

    //qCDebug(DIGIKAM_MARBLE_LOG) << QString::fromUtf8("file=%s: compressed_size=%d, uncompressed_size=%d", fileName.toLocal8Bit().data(), compressed_size, uncompressed_size);

    //qCDebug(DIGIKAM_MARBLE_LOG) << QString::fromUtf8("file at %lld", d->device->pos());

    QByteArray compressed = d->device->read(compressed_size);

    if (compression_method == 0)
    {
        // no compression

        compressed.truncate(uncompressed_size);

        return compressed;
    }

    else if (compression_method == 8)
    {
        // Deflate
        //qCDebug(DIGIKAM_MARBLE_LOG) << QString::fromUtf8("compressed=%d", compressed.size());

        compressed.truncate(compressed_size);
        QByteArray baunzip;
        ulong len = qMax(uncompressed_size,  1);
        int res;

        do
        {
            baunzip.resize(len);
            res = inflate((uchar*)baunzip.data(), &len,
                          (uchar*)compressed.constData(), compressed_size);

            switch (res)
            {
                case Z_OK:
                    if ((int)len != baunzip.size())
                    {
                        baunzip.resize(len);
                    }

                    break;

                case Z_MEM_ERROR:
                    qCWarning(DIGIKAM_MARBLE_LOG) << QString::fromUtf8("QZip: Z_MEM_ERROR: Not enough memory");
                    break;

                case Z_BUF_ERROR:
                    len *= 2;
                    break;

                case Z_DATA_ERROR:
                    qCWarning(DIGIKAM_MARBLE_LOG) << QString::fromUtf8("QZip: Z_DATA_ERROR: Input data is corrupted");
                    break;
            }
        }
        while (res == Z_BUF_ERROR);

        return baunzip;
    }

    qCWarning(DIGIKAM_MARBLE_LOG) << "QZip: Unknown compression method";
    return QByteArray();
}

/*!
    Extracts the full contents of the zip file into \a destinationDir on
    the local filesystem.
    In case writing or linking a file fails, the extraction will be aborted.
*/
bool MarbleZipReader::extractAll(const QString& destinationDir) const
{
    QDir baseDir(destinationDir);

    // create directories first

    QList<FileInfo> allFiles = fileInfoList();

    for (const FileInfo& fi : allFiles)
    {
        const QString absPath = destinationDir + QDir::separator() + fi.filePath;

        if (fi.isDir)
        {
            if (!baseDir.mkpath(fi.filePath))
            {
                return false;
            }

            if (!QFile::setPermissions(absPath, fi.permissions))
            {
                return false;
            }
        }
    }

    // set up symlinks

    for (const FileInfo& fi : allFiles)
    {
        const QString absPath = destinationDir + QDir::separator() + fi.filePath;

        if (fi.isSymLink)
        {
            QString destination = QFile::decodeName(fileData(fi.filePath));

            if (destination.isEmpty())
            {
                return false;
            }

            QFileInfo linkFi(absPath);

            if (!QFile::exists(linkFi.absolutePath()))
            {
                QDir::root().mkpath(linkFi.absolutePath());
            }

            if (!QFile::link(destination, absPath))
            {
                return false;
            }

            /* cannot change permission of links
            if (!QFile::setPermissions(absPath, fi.permissions))
                return false;
            */
        }
    }

    for (const FileInfo& fi : allFiles)
    {
        const QString absPath = destinationDir + QDir::separator() + fi.filePath;

        if (fi.isFile)
        {
            QDir::root().mkpath(QFileInfo(absPath).dir().absolutePath());
            QFile f(absPath);

            if (!f.open(QIODevice::WriteOnly))
            {
                return false;
            }

            f.write(fileData(fi.filePath));
            f.setPermissions(fi.permissions);
            f.close();
        }
    }

    return true;
}

/*!
    \enum QZipReader::Status

    The following status values are possible:

    \value NoError  No error occurred.
    \value FileReadError    An error occurred when reading from the file.
    \value FileOpenError    The file could not be opened.
    \value FilePermissionsError The file could not be accessed.
    \value FileError        Another file error occurred.
*/

/*!
    Returns a status code indicating the first error that was met by QZipReader,
    or QZipReader::NoError if no error occurred.
*/
MarbleZipReader::Status MarbleZipReader::status() const
{
    return d->status;
}

/*!
    Close the zip file.
*/
void MarbleZipReader::close()
{
    d->device->close();
}

////////////////////////////// Writer

/*!
    \class Q_DECL_HIDDEN QZipWriter
    \internal
    \since 4.5

    \brief the QZipWriter class Q_DECL_HIDDEN provides a way to create a new zip archive.

    QZipWriter can be used to create a zip archive containing any number of files
    and directories. The files in the archive will be compressed in a way that is
    compatible with common zip reader applications.
*/


/*!
    Create a new zip archive that operates on the \a archive filename.  The file will
    be opened with the \a mode.
    \sa isValid()
*/
MarbleZipWriter::MarbleZipWriter(const QString& fileName, QIODevice::OpenMode mode)
{
    QScopedPointer<QFile> f(new QFile(fileName));
    f->open(mode);
    MarbleZipWriter::Status status;

    if (f->error() == QFile::NoError)
    {
        status = MarbleZipWriter::NoError;
    }

    else
    {
        if (f->error() == QFile::WriteError)
        {
            status = MarbleZipWriter::FileWriteError;
        }

        else if (f->error() == QFile::OpenError)
        {
            status = MarbleZipWriter::FileOpenError;
        }

        else if (f->error() == QFile::PermissionsError)
        {
            status = MarbleZipWriter::FilePermissionsError;
        }

        else
        {
            status = MarbleZipWriter::FileError;
        }
    }

    d = new MarbleZipWriterPrivate(f.data(), /*ownDevice=*/true);
    f.take();
    d->status = status;
}

/*!
    Create a new zip archive that operates on the archive found in \a device.
    You have to open the device previous to calling the constructor and
    only a device that is readable will be scanned for zip filecontent.
 */
MarbleZipWriter::MarbleZipWriter(QIODevice* device)
    : d(new MarbleZipWriterPrivate(device, /*ownDevice=*/false))
{
    Q_ASSERT(device);
}

MarbleZipWriter::~MarbleZipWriter()
{
    close();
    delete d;
}

/*!
    Returns device used for writing zip archive.
*/
QIODevice* MarbleZipWriter::device() const
{
    return d->device;
}

/*!
    Returns true if the user can write to the archive; otherwise returns false.
*/
bool MarbleZipWriter::isWritable() const
{
    return d->device->isWritable();
}

/*!
    Returns true if the file exists; otherwise returns false.
*/
bool MarbleZipWriter::exists() const
{
    QFile* f = qobject_cast<QFile*> (d->device);

    if (f == nullptr)
    {
        return true;
    }

    return f->exists();
}

/*!
    \enum QZipWriter::Status

    The following status values are possible:

    \var NoError
    No error occurred.
    \var FileWriteError
    An error occurred when writing to the device.
    \var FileOpenError
    The file could not be opened.
    \var FilePermissionsError
    The file could not be accessed.
    \var FileError
    Another file error occurred.
*/

/*!
    Returns a status code indicating the first error that was met by QZipWriter,
    or QZipWriter::NoError if no error occurred.
*/
MarbleZipWriter::Status MarbleZipWriter::status() const
{
    return d->status;
}

/*!
    \enum CompressionPolicy

    \var AlwaysCompress
    A file that is added is compressed.
    \var NeverCompress
    A file that is added will be stored without changes.
    \var AutoCompress
    A file that is added will be compressed only if that will give a smaller file.
*/

/*!
     Sets the policy for compressing newly added files to the new \a policy.

    \note the default policy is AlwaysCompress

    \sa compressionPolicy()
    \sa addFile()
*/
void MarbleZipWriter::setCompressionPolicy(CompressionPolicy policy)
{
    d->compressionPolicy = policy;
}

/*!
     Returns the currently set compression policy.
    \sa setCompressionPolicy()
    \sa addFile()
*/
MarbleZipWriter::CompressionPolicy MarbleZipWriter::compressionPolicy() const
{
    return d->compressionPolicy;
}

/*!
    Sets the permissions that will be used for newly added files.

    \note the default permissions are QFile::ReadOwner | QFile::WriteOwner.

    \sa creationPermissions()
    \sa addFile()
*/
void MarbleZipWriter::setCreationPermissions(QFile::Permissions permissions)
{
    d->permissions = permissions;
}

/*!
     Returns the currently set creation permissions.

    \sa setCreationPermissions()
    \sa addFile()
*/
QFile::Permissions MarbleZipWriter::creationPermissions() const
{
    return d->permissions;
}

/*!
    Add a file to the archive with \a data as the file contents.
    The file will be stored in the archive using the \a fileName which
    includes the full path in the archive.

    The new file will get the file permissions based on the current
    creationPermissions and it will be compressed using the zip compression
    based on the current compression policy.

    \sa setCreationPermissions()
    \sa setCompressionPolicy()
*/
void MarbleZipWriter::addFile(const QString& fileName, const QByteArray& data)
{
    d->addEntry(MarbleZipWriterPrivate::File, QDir::fromNativeSeparators(fileName), data);
}

/*!
    Add a file to the archive with \a device as the source of the contents.
    The contents returned from QIODevice::readAll() will be used as the
    filedata.
    The file will be stored in the archive using the \a fileName which
    includes the full path in the archive.
*/
void MarbleZipWriter::addFile(const QString& fileName, QIODevice* device)
{
    Q_ASSERT(device);
    QIODevice::OpenMode mode = device->openMode();
    bool opened = false;

    if ((mode & QIODevice::ReadOnly) == 0)
    {
        opened = true;

        if (! device->open(QIODevice::ReadOnly))
        {
            d->status = FileOpenError;
            return;
        }
    }

    d->addEntry(MarbleZipWriterPrivate::File, QDir::fromNativeSeparators(fileName), device->readAll());

    if (opened)
    {
        device->close();
    }
}

/*!
    Create a new directory in the archive with the specified \a dirName and
    the \a permissions;
*/
void MarbleZipWriter::addDirectory(const QString& dirName)
{
    QString name(QDir::fromNativeSeparators(dirName));

    // separator is mandatory

    if (!name.endsWith(QLatin1Char('/')))
    {
        name.append(QLatin1Char('/'));
    }

    d->addEntry(MarbleZipWriterPrivate::Directory, name, QByteArray());
}

/*!
    Create a new symbolic link in the archive with the specified \a dirName
    and the \a permissions;
    A symbolic link contains the destination (relative) path and name.
*/
void MarbleZipWriter::addSymLink(const QString& fileName, const QString& destination)
{
    d->addEntry(MarbleZipWriterPrivate::Symlink, QDir::fromNativeSeparators(fileName), QFile::encodeName(destination));
}

/*!
   Closes the zip file.
*/
void MarbleZipWriter::close()
{
    if (!(d->device->openMode() & QIODevice::WriteOnly))
    {
        d->device->close();
        return;
    }

    //qCDebug(DIGIKAM_MARBLE_LOG) << QString::fromUtf8("QZip::close writing directory, %d entries", d->fileHeaders.size());

    d->device->seek(d->start_of_directory);

    // write new directory
    for (int i = 0; i < d->fileHeaders.size(); ++i)
    {
        const FileHeader& header = d->fileHeaders.at(i);
        d->device->write((const char*)&header.h, sizeof(CentralFileHeader));
        d->device->write(header.file_name);
        d->device->write(header.extra_field);
        d->device->write(header.file_comment);
    }

    int dir_size = d->device->pos() - d->start_of_directory;

    // write end of directory

    EndOfDirectory eod;
    memset(&eod, 0, sizeof(EndOfDirectory));
    writeUInt(eod.signature, 0x06054b50);

    //uchar this_disk[2];
    //uchar start_of_directory_disk[2];

    writeUShort(eod.num_dir_entries_this_disk, d->fileHeaders.size());
    writeUShort(eod.num_dir_entries, d->fileHeaders.size());
    writeUInt(eod.directory_size, dir_size);
    writeUInt(eod.dir_start_offset, d->start_of_directory);
    writeUShort(eod.comment_length, d->comment.length());

    d->device->write((const char*)&eod, sizeof(EndOfDirectory));
    d->device->write(d->comment);
    d->device->close();
}

} // namespace Marble

#endif // QT_NO_TEXTODFWRITER
