QGClibarchive.h

Go to the documentation of this file.

#pragma once
 
 
#include "QGCCompressionTypes.h"
 
#include <QtCore/QByteArray>
#include <QtCore/QFile>
#include <QtCore/QIODevice>
#include <QtCore/QLoggingCategory>
#include <QtCore/QString>
#include <QtCore/QStringList>
 
#include <archive.h>
 
Q_DECLARE_LOGGING_CATEGORY(QGClibarchiveLog)
 
namespace QGClibarchive {
 
// ============================================================================
// Types (re-export from QGCCompression for internal use)
// ============================================================================
 
using ProgressCallback = QGCCompression::ProgressCallback;
using ArchiveEntry = QGCCompression::ArchiveEntry;
using ArchiveStats = QGCCompression::ArchiveStats;
using EntryFilter = QGCCompression::EntryFilter;
 
using QGCCompression::kDefaultFilePermissions;
 
// ============================================================================
// Archive Reader Mode
// ============================================================================
 
enum class ReaderMode {
    AllFormats,  
    RawFormat    
};
 
// ============================================================================
// RAII Archive Reader
// ============================================================================
 
class ArchiveReader {
public:
    ArchiveReader() = default;
    ~ArchiveReader();
 
    ArchiveReader(const ArchiveReader&) = delete;
    ArchiveReader& operator=(const ArchiveReader&) = delete;
 
    bool open(const QString &path, ReaderMode mode = ReaderMode::AllFormats);
 
    bool open(QIODevice *device, ReaderMode mode = ReaderMode::AllFormats);
 
    struct archive* handle() const { return _archive; }
 
    struct archive* release() { auto *a = _archive; _archive = nullptr; return a; }
 
    bool isOpen() const { return _archive != nullptr; }
 
    qint64 dataSize() const;
 
    QString formatName() const;
 
    QString filterName() const;
 
private:
    struct archive *_archive = nullptr;
    QString _filePath;  // Stored path for size queries
    QByteArray _resourceData;  // Holds data for Qt resources
    QIODevice *_device = nullptr;  // Device for streaming reads
};
 
// ============================================================================
// QIODevice Streaming Callbacks
// ============================================================================
 
la_ssize_t deviceReadCallback(struct archive *a, void *clientData, const void **buffer);
 
la_int64_t deviceSkipCallback(struct archive *a, void *clientData, la_int64_t request);
 
int deviceCloseCallback(struct archive *a, void *clientData);
 
la_int64_t deviceSeekCallback(struct archive *a, void *clientData, la_int64_t offset, int whence);
 
// ============================================================================
// Utility Functions
// ============================================================================
 
ArchiveEntry toArchiveEntry(struct archive_entry *entry);
 
// ============================================================================
// Low-level Operations
// ============================================================================
 
bool openArchiveForReading(struct archive *a, const QString &filePath, QByteArray &resourceData);
 
bool extractAnyArchive(const QString &archivePath, const QString &outputDirectoryPath,
                       ProgressCallback progress = nullptr,
                       qint64 maxBytes = 0);
 
bool extractArchiveAtomic(const QString &archivePath, const QString &outputDirectoryPath,
                          ProgressCallback progress = nullptr,
                          qint64 maxBytes = 0);
 
bool extractSingleFile(const QString &archivePath, const QString &fileName,
                       const QString &outputPath);
 
QByteArray extractFileToMemory(const QString &archivePath, const QString &fileName);
 
bool extractMultipleFiles(const QString &archivePath, const QStringList &fileNames,
                          const QString &outputDirectoryPath);
 
bool extractByPattern(const QString &archivePath, const QStringList &patterns,
                      const QString &outputDirectoryPath,
                      QStringList *extractedFiles = nullptr);
 
bool validateArchive(const QString &archivePath);
 
bool fileExistsInArchive(const QString &archivePath, const QString &fileName);
 
QStringList listArchiveEntries(const QString &archivePath);
 
QList<ArchiveEntry> listArchiveEntriesDetailed(const QString &archivePath);
 
ArchiveStats getArchiveStats(const QString &archivePath);
 
bool extractWithFilter(const QString &archivePath, const QString &outputDirectoryPath,
                       EntryFilter filter,
                       ProgressCallback progress = nullptr,
                       qint64 maxBytes = 0);
 
// ============================================================================
// Single-File Decompression
// ============================================================================
 
bool decompressSingleFile(const QString &inputPath, const QString &outputPath,
                          ProgressCallback progress = nullptr,
                          qint64 maxBytes = 0);
 
QByteArray decompressDataFromMemory(const QByteArray &data, qint64 maxBytes = 0);
 
// ============================================================================
// QIODevice-based Operations (streaming)
// ============================================================================
 
bool extractFromDevice(QIODevice *device, const QString &outputDirectoryPath,
                       ProgressCallback progress = nullptr,
                       qint64 maxBytes = 0);
 
QByteArray extractFileDataFromDevice(QIODevice *device, const QString &fileName);
 
bool decompressFromDevice(QIODevice *device, const QString &outputPath,
                          ProgressCallback progress = nullptr,
                          qint64 maxBytes = 0);
 
QByteArray decompressDataFromDevice(QIODevice *device, qint64 maxBytes = 0);
 
// ============================================================================
// Format Detection (Thread-Local State)
// ============================================================================
 
QString lastDetectedFormatName();
 
QString lastDetectedFilterName();
 
} // namespace QGClibarchive