File indexing completed on 2024-04-28 11:33:46

 /* This file is part of the KDE libraries
    SPDX-FileCopyrightText: 2000 David Faure <faure@kde.org>
    SPDX-FileCopyrightText: 2011 Mario Bensi <mbensi@ipsquad.net>
 
    SPDX-License-Identifier: LGPL-2.0-or-later
 */
 
 #include "kcompressiondevice.h"
 #include "kcompressiondevice_p.h"
 #include "kfilterbase.h"
 #include "loggingcategory.h"
 #include "kgzipfilter.h"
 #include "knonefilter.h"
 
 #include "config-compression.h"
 
 #if HAVE_BZIP2_SUPPORT
 #include "kbzip2filter.h"
 #endif
 #if HAVE_XZ_SUPPORT
 #include "kxzfilter.h"
 #endif
 #if HAVE_ZSTD_SUPPORT
 #include "kzstdfilter.h"
 #endif
 
 #include <QDebug>
 #include <QFile>
 #include <QMimeDatabase>
 
 #include <assert.h>
 #include <stdio.h> // for EOF
 #include <stdlib.h>
 
 class KCompressionDevicePrivate
 {
 public:
     KCompressionDevicePrivate(KCompressionDevice *qq)
         : bNeedHeader(true)
         , bSkipHeaders(false)
         , bOpenedUnderlyingDevice(false)
         , type(KCompressionDevice::None)
         , errorCode(QFileDevice::NoError)
         , deviceReadPos(0)
         , q(qq)
     {
     }
 
     void propagateErrorCode();
 
     bool bNeedHeader;
     bool bSkipHeaders;
     bool bOpenedUnderlyingDevice;
     QByteArray buffer; // Used as 'input buffer' when reading, as 'output buffer' when writing
     QByteArray origFileName;
     KFilterBase::Result result;
     KFilterBase *filter;
     KCompressionDevice::CompressionType type;
     QFileDevice::FileError errorCode;
     qint64 deviceReadPos;
     KCompressionDevice *q;
 };
 
 void KCompressionDevicePrivate::propagateErrorCode()
 {
     QIODevice *dev = filter->device();
     if (QFileDevice *fileDev = qobject_cast<QFileDevice *>(dev)) {
         if (fileDev->error() != QFileDevice::NoError) {
             errorCode = fileDev->error();
             q->setErrorString(dev->errorString());
         }
     }
     // ... we have no generic way to propagate errors from other kinds of iodevices. Sucks, heh? :(
 }
 
 static KCompressionDevice::CompressionType findCompressionByFileName(const QString &fileName)
 {
     if (fileName.endsWith(QLatin1String(".gz"), Qt::CaseInsensitive)) {
         return KCompressionDevice::GZip;
     }
 #if HAVE_BZIP2_SUPPORT
     if (fileName.endsWith(QLatin1String(".bz2"), Qt::CaseInsensitive)) {
         return KCompressionDevice::BZip2;
     }
 #endif
 #if HAVE_XZ_SUPPORT
     if (fileName.endsWith(QLatin1String(".lzma"), Qt::CaseInsensitive) || fileName.endsWith(QLatin1String(".xz"), Qt::CaseInsensitive)) {
         return KCompressionDevice::Xz;
     }
 #endif
 #if HAVE_ZSTD_SUPPORT
     if (fileName.endsWith(QLatin1String(".zst"), Qt::CaseInsensitive)) {
         return KCompressionDevice::Zstd;
     }
 #endif
     else {
         // not a warning, since this is called often with other MIME types (see #88574)...
         // maybe we can avoid that though?
         // qCDebug(KArchiveLog) << "findCompressionByFileName : no compression found for " << fileName;
     }
 
     return KCompressionDevice::None;
 }
 
 KCompressionDevice::CompressionType KCompressionDevice::compressionTypeForMimeType(const QString &mimeType)
 {
     if (mimeType == QLatin1String("application/gzip") //
         || mimeType == QLatin1String("application/x-gzip") // legacy name, kept for compatibility
     ) {
         return KCompressionDevice::GZip;
     }
 #if HAVE_BZIP2_SUPPORT
     if (mimeType == QLatin1String("application/x-bzip") //
         || mimeType == QLatin1String("application/x-bzip2") // old name, kept for compatibility
     ) {
         return KCompressionDevice::BZip2;
     }
 #endif
 #if HAVE_XZ_SUPPORT
     if (mimeType == QLatin1String("application/x-lzma") // legacy name, still used
         || mimeType == QLatin1String("application/x-xz") // current naming
     ) {
         return KCompressionDevice::Xz;
     }
 #endif
 #if HAVE_ZSTD_SUPPORT
     if (mimeType == QLatin1String("application/zstd")) {
         return KCompressionDevice::Zstd;
     }
 #endif
     QMimeDatabase db;
     const QMimeType mime = db.mimeTypeForName(mimeType);
     if (mime.isValid()) {
         // use legacy MIME type for now, see comment in impl. of KTar(const QString &, const QString &_mimetype)
         if (mime.inherits(QStringLiteral("application/x-gzip"))) {
             return KCompressionDevice::GZip;
         }
 #if HAVE_BZIP2_SUPPORT
         if (mime.inherits(QStringLiteral("application/x-bzip"))) {
             return KCompressionDevice::BZip2;
         }
 #endif
 #if HAVE_XZ_SUPPORT
         if (mime.inherits(QStringLiteral("application/x-lzma"))) {
             return KCompressionDevice::Xz;
         }
 
         if (mime.inherits(QStringLiteral("application/x-xz"))) {
             return KCompressionDevice::Xz;
         }
 #endif
     }
 
     // not a warning, since this is called often with other MIME types (see #88574)...
     // maybe we can avoid that though?
     // qCDebug(KArchiveLog) << "no compression found for" << mimeType;
     return KCompressionDevice::None;
 }
 
 KFilterBase *KCompressionDevice::filterForCompressionType(KCompressionDevice::CompressionType type)
 {
     switch (type) {
     case KCompressionDevice::GZip:
         return new KGzipFilter;
     case KCompressionDevice::BZip2:
 #if HAVE_BZIP2_SUPPORT
         return new KBzip2Filter;
 #else
         return nullptr;
 #endif
     case KCompressionDevice::Xz:
 #if HAVE_XZ_SUPPORT
         return new KXzFilter;
 #else
         return nullptr;
 #endif
     case KCompressionDevice::None:
         return new KNoneFilter;
 #if HAVE_ZSTD_SUPPORT
     case KCompressionDevice::Zstd:
         return new KZstdFilter;
 #endif
     }
     return nullptr;
 }
 
 KCompressionDevice::KCompressionDevice(QIODevice *inputDevice, bool autoDeleteInputDevice, CompressionType type)
     : d(new KCompressionDevicePrivate(this))
 {
     assert(inputDevice);
     d->filter = filterForCompressionType(type);
     if (d->filter) {
         d->type = type;
         d->filter->setDevice(inputDevice, autoDeleteInputDevice);
     }
 }
 
 KCompressionDevice::KCompressionDevice(const QString &fileName, CompressionType type)
     : d(new KCompressionDevicePrivate(this))
 {
     QFile *f = new QFile(fileName);
     d->filter = filterForCompressionType(type);
     if (d->filter) {
         d->type = type;
         d->filter->setDevice(f, true);
     } else {
         delete f;
     }
 }
 
 KCompressionDevice::KCompressionDevice(const QString &fileName)
     : KCompressionDevice(fileName, findCompressionByFileName(fileName))
 {
 }
 
 KCompressionDevice::~KCompressionDevice()
 {
     if (isOpen()) {
         close();
     }
     delete d->filter;
     delete d;
 }
 
 KCompressionDevice::CompressionType KCompressionDevice::compressionType() const
 {
     return d->type;
 }
 
 bool KCompressionDevice::open(QIODevice::OpenMode mode)
 {
     if (isOpen()) {
         // qCWarning(KArchiveLog) << "KCompressionDevice::open: device is already open";
         return true; // QFile returns false, but well, the device -is- open...
     }
     if (!d->filter) {
         return false;
     }
     d->bOpenedUnderlyingDevice = false;
     // qCDebug(KArchiveLog) << mode;
     if (mode == QIODevice::ReadOnly) {
         d->buffer.resize(0);
     } else {
         d->buffer.resize(BUFFER_SIZE);
         d->filter->setOutBuffer(d->buffer.data(), d->buffer.size());
     }
     if (!d->filter->device()->isOpen()) {
         if (!d->filter->device()->open(mode)) {
             // qCWarning(KArchiveLog) << "KCompressionDevice::open: Couldn't open underlying device";
             d->propagateErrorCode();
             return false;
         }
         d->bOpenedUnderlyingDevice = true;
     }
     d->bNeedHeader = !d->bSkipHeaders;
     d->filter->setFilterFlags(d->bSkipHeaders ? KFilterBase::NoHeaders : KFilterBase::WithHeaders);
     if (!d->filter->init(mode)) {
         return false;
     }
     d->result = KFilterBase::Ok;
     setOpenMode(mode);
     return true;
 }
 
 void KCompressionDevice::close()
 {
     if (!isOpen()) {
         return;
     }
     if (d->filter->mode() == QIODevice::WriteOnly && d->errorCode == QFileDevice::NoError) {
         write(nullptr, 0); // finish writing
     }
     // qCDebug(KArchiveLog) << "Calling terminate().";
 
     if (!d->filter->terminate()) {
         // qCWarning(KArchiveLog) << "KCompressionDevice::close: terminate returned an error";
         d->errorCode = QFileDevice::UnspecifiedError;
     }
     if (d->bOpenedUnderlyingDevice) {
         QIODevice *dev = d->filter->device();
         dev->close();
         d->propagateErrorCode();
     }
     setOpenMode(QIODevice::NotOpen);
 }
 
 QFileDevice::FileError KCompressionDevice::error() const
 {
     return d->errorCode;
 }
 
 bool KCompressionDevice::seek(qint64 pos)
 {
     if (d->deviceReadPos == pos) {
         return QIODevice::seek(pos);
     }
 
     // qCDebug(KArchiveLog) << "seek(" << pos << ") called, current pos=" << QIODevice::pos();
 
     Q_ASSERT(d->filter->mode() == QIODevice::ReadOnly);
 
     if (pos == 0) {
         if (!QIODevice::seek(pos)) {
             return false;
         }
 
         // We can forget about the cached data
         d->bNeedHeader = !d->bSkipHeaders;
         d->result = KFilterBase::Ok;
         d->filter->setInBuffer(nullptr, 0);
         d->filter->reset();
         d->deviceReadPos = 0;
         return d->filter->device()->reset();
     }
 
     qint64 bytesToRead;
     if (d->deviceReadPos < pos) { // we can start from here
         bytesToRead = pos - d->deviceReadPos;
         // Since we're going to do a read() below
         // we need to reset the internal QIODevice pos to the real position we are
         // so that after read() we are indeed pointing to the pos seek
         // asked us to be in
         if (!QIODevice::seek(d->deviceReadPos)) {
             return false;
         }
     } else {
         // we have to start from 0 ! Ugly and slow, but better than the previous
         // solution (KTarGz was allocating everything into memory)
         if (!seek(0)) { // recursive
             return false;
         }
         bytesToRead = pos;
     }
 
     // qCDebug(KArchiveLog) << "reading " << bytesToRead << " dummy bytes";
     QByteArray dummy(qMin(bytesToRead, qint64(SEEK_BUFFER_SIZE)), 0);
     while (bytesToRead > 0) {
         const qint64 bytesToReadThisTime = qMin(bytesToRead, qint64(dummy.size()));
         const bool result = (read(dummy.data(), bytesToReadThisTime) == bytesToReadThisTime);
         if (!result) {
             return false;
         }
         bytesToRead -= bytesToReadThisTime;
     }
     return true;
 }
 
 bool KCompressionDevice::atEnd() const
 {
     return (d->type == KCompressionDevice::None || d->result == KFilterBase::End) //
         && QIODevice::atEnd() // take QIODevice's internal buffer into account
         && d->filter->device()->atEnd();
 }
 
 qint64 KCompressionDevice::readData(char *data, qint64 maxlen)
 {
     Q_ASSERT(d->filter->mode() == QIODevice::ReadOnly);
     // qCDebug(KArchiveLog) << "maxlen=" << maxlen;
     KFilterBase *filter = d->filter;
 
     uint dataReceived = 0;
 
     // We came to the end of the stream
     if (d->result == KFilterBase::End) {
         return dataReceived;
     }
 
     // If we had an error, return -1.
     if (d->result != KFilterBase::Ok) {
         return -1;
     }
 
     qint64 availOut = maxlen;
     filter->setOutBuffer(data, maxlen);
 
     while (dataReceived < maxlen) {
         if (filter->inBufferEmpty()) {
             // Not sure about the best size to set there.
             // For sure, it should be bigger than the header size (see comment in readHeader)
             d->buffer.resize(BUFFER_SIZE);
             // Request data from underlying device
             int size = filter->device()->read(d->buffer.data(), d->buffer.size());
             // qCDebug(KArchiveLog) << "got" << size << "bytes from device";
             if (size) {
                 filter->setInBuffer(d->buffer.data(), size);
             } else {
                 // Not enough data available in underlying device for now
                 break;
             }
         }
         if (d->bNeedHeader) {
             (void)filter->readHeader();
             d->bNeedHeader = false;
         }
 
         d->result = filter->uncompress();
 
         if (d->result == KFilterBase::Error) {
             // qCWarning(KArchiveLog) << "KCompressionDevice: Error when uncompressing data";
             break;
         }
 
         // We got that much data since the last time we went here
         uint outReceived = availOut - filter->outBufferAvailable();
         // qCDebug(KArchiveLog) << "avail_out = " << filter->outBufferAvailable() << " result=" << d->result << " outReceived=" << outReceived;
         if (availOut < uint(filter->outBufferAvailable())) {
             // qCWarning(KArchiveLog) << " last availOut " << availOut << " smaller than new avail_out=" << filter->outBufferAvailable() << " !";
         }
 
         dataReceived += outReceived;
         data += outReceived;
         availOut = maxlen - dataReceived;
         if (d->result == KFilterBase::End) {
             // We're actually at the end, no more data to check
             if (filter->device()->atEnd()) {
                 break;
             }
 
             // Still not done, re-init and try again
             filter->init(filter->mode());
         }
         filter->setOutBuffer(data, availOut);
     }
 
     d->deviceReadPos += dataReceived;
     return dataReceived;
 }
 
 qint64 KCompressionDevice::writeData(const char *data /*0 to finish*/, qint64 len)
 {
     KFilterBase *filter = d->filter;
     Q_ASSERT(filter->mode() == QIODevice::WriteOnly);
     // If we had an error, return 0.
     if (d->result != KFilterBase::Ok) {
         return 0;
     }
 
     bool finish = (data == nullptr);
     if (!finish) {
         filter->setInBuffer(data, len);
         if (d->bNeedHeader) {
             (void)filter->writeHeader(d->origFileName);
             d->bNeedHeader = false;
         }
     }
 
     uint dataWritten = 0;
     uint availIn = len;
     while (dataWritten < len || finish) {
         d->result = filter->compress(finish);
 
         if (d->result == KFilterBase::Error) {
             // qCWarning(KArchiveLog) << "KCompressionDevice: Error when compressing data";
             // What to do ?
             break;
         }
 
         // Wrote everything ?
         if (filter->inBufferEmpty() || (d->result == KFilterBase::End)) {
             // We got that much data since the last time we went here
             uint wrote = availIn - filter->inBufferAvailable();
 
             // qCDebug(KArchiveLog) << " Wrote everything for now. avail_in=" << filter->inBufferAvailable() << "result=" << d->result << "wrote=" << wrote;
 
             // Move on in the input buffer
             data += wrote;
             dataWritten += wrote;
 
             availIn = len - dataWritten;
             // qCDebug(KArchiveLog) << " availIn=" << availIn << "dataWritten=" << dataWritten << "pos=" << pos();
             if (availIn > 0) {
                 filter->setInBuffer(data, availIn);
             }
         }
 
         if (filter->outBufferFull() || (d->result == KFilterBase::End) || finish) {
             // qCDebug(KArchiveLog) << " writing to underlying. avail_out=" << filter->outBufferAvailable();
             int towrite = d->buffer.size() - filter->outBufferAvailable();
             if (towrite > 0) {
                 // Write compressed data to underlying device
                 int size = filter->device()->write(d->buffer.data(), towrite);
                 if (size != towrite) {
                     // qCWarning(KArchiveLog) << "KCompressionDevice::write. Could only write " << size << " out of " << towrite << " bytes";
                     d->errorCode = QFileDevice::WriteError;
                     setErrorString(tr("Could not write. Partition full?"));
                     return 0; // indicate an error
                 }
                 // qCDebug(KArchiveLog) << " wrote " << size << " bytes";
             }
             if (d->result == KFilterBase::End) {
                 Q_ASSERT(finish); // hopefully we don't get end before finishing
                 break;
             }
             d->buffer.resize(BUFFER_SIZE);
             filter->setOutBuffer(d->buffer.data(), d->buffer.size());
         }
     }
 
     return dataWritten;
 }
 
 void KCompressionDevice::setOrigFileName(const QByteArray &fileName)
 {
     d->origFileName = fileName;
 }
 
 void KCompressionDevice::setSkipHeaders()
 {
     d->bSkipHeaders = true;
 }
 
 KFilterBase *KCompressionDevice::filterBase()
 {
     return d->filter;
 }
 
 #include "moc_kcompressiondevice.cpp"