mirror of
https://bitbucket.org/smil3y/kdelibs.git
synced 2025-02-24 10:52:49 +00:00
109 lines
4 KiB
C++
109 lines
4 KiB
C++
/* This file is part of the KDE libraries
|
|
Copyright (C) 2000-2005 David Faure <faure@kde.org>
|
|
Copyright (C) 2003 Leo Savernik <l.savernik@aon.at>
|
|
|
|
This library is free software; you can redistribute it and/or
|
|
modify it under the terms of the GNU Library General Public
|
|
License version 2 as published by the Free Software Foundation.
|
|
|
|
This library 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
|
|
Library General Public License for more details.
|
|
|
|
You should have received a copy of the GNU Library General Public License
|
|
along with this library; see the file COPYING.LIB. If not, write to
|
|
the Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor,
|
|
Boston, MA 02110-1301, USA.
|
|
*/
|
|
#ifndef KTAR_H
|
|
#define KTAR_H
|
|
|
|
#include <karchive.h>
|
|
|
|
/**
|
|
* A class for reading / writing (optionally compressed) tar archives.
|
|
*
|
|
* KTar allows you to read and write tar archives, including those
|
|
* that are compressed using gzip, bzip2 or xz.
|
|
*
|
|
* @author Torben Weis <weis@kde.org>, David Faure <faure@kde.org>
|
|
*/
|
|
class KDECORE_EXPORT KTar : public KArchive
|
|
{
|
|
public:
|
|
/**
|
|
* Creates an instance that operates on the given filename
|
|
* using the compression filter associated to given mimetype.
|
|
*
|
|
* @param filename is a local path (e.g. "/home/weis/myfile.tgz")
|
|
* @param mimetype "application/x-gzip", "application/x-bzip" or
|
|
* "application/x-xz"
|
|
* Do not use application/x-compressed-tar or similar - you only need to
|
|
* specify the compression layer ! If the mimetype is omitted, it
|
|
* will be determined from the filename.
|
|
*/
|
|
explicit KTar( const QString& filename,
|
|
const QString& mimetype = QString() );
|
|
|
|
/**
|
|
* Creates an instance that operates on the given device.
|
|
* The device can be compressed (KFilterDev) or not (QFile, etc.).
|
|
* @warning Do not assume that giving a QFile here will decompress the file,
|
|
* in case it's compressed!
|
|
* @param dev the device to read from. If the source is compressed, the
|
|
* QIODevice must take care of decompression
|
|
*/
|
|
explicit KTar( QIODevice * dev );
|
|
|
|
/**
|
|
* If the tar ball is still opened, then it will be
|
|
* closed automatically by the destructor.
|
|
*/
|
|
virtual ~KTar();
|
|
|
|
/**
|
|
* Special function for setting the "original file name" in the gzip header,
|
|
* when writing a tar.gz file. It appears when using in the "file" command,
|
|
* for instance. Should only be called if the underlying device is a KFilterDev!
|
|
* @param fileName the original file name
|
|
*/
|
|
void setOrigFileName( const QByteArray & fileName );
|
|
|
|
protected:
|
|
|
|
/// Reimplemented from KArchive
|
|
virtual bool doWriteSymLink(const QString &name, const QString &target,
|
|
const QString &user, const QString &group,
|
|
mode_t perm, time_t atime, time_t mtime, time_t ctime);
|
|
/// Reimplemented from KArchive
|
|
virtual bool doWriteDir( const QString& name, const QString& user, const QString& group,
|
|
mode_t perm, time_t atime, time_t mtime, time_t ctime );
|
|
/// Reimplemented from KArchive
|
|
virtual bool doPrepareWriting( const QString& name, const QString& user,
|
|
const QString& group, qint64 size, mode_t perm,
|
|
time_t atime, time_t mtime, time_t ctime );
|
|
/// Reimplemented from KArchive
|
|
virtual bool doFinishWriting( qint64 size );
|
|
|
|
/**
|
|
* Opens the archive for reading.
|
|
* Parses the directory listing of the archive
|
|
* and creates the KArchiveDirectory/KArchiveFile entries.
|
|
* @param mode the mode of the file
|
|
*/
|
|
virtual bool openArchive( QIODevice::OpenMode mode );
|
|
virtual bool closeArchive();
|
|
|
|
virtual bool createDevice( QIODevice::OpenMode mode );
|
|
|
|
private:
|
|
|
|
protected:
|
|
virtual void virtual_hook( int id, void* data );
|
|
private:
|
|
class KTarPrivate;
|
|
KTarPrivate* const d;
|
|
};
|
|
|
|
#endif
|