karchive.h

Go to the documentation of this file.

/* 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>

   Moved from ktar.h by Roberto Teixeira <maragato@kde.org>

   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 KARCHIVE_H
#define KARCHIVE_H

#include <sys/stat.h>
#include <sys/types.h>

#include <QtCore/QDate>
#include <QtCore/QString>
#include <QtCore/QStringList>
#include <QtCore/QHash>

#include <kdecore_export.h>

class KArchiveDirectory;
class KArchiveFile;

class KArchivePrivate;
class KDECORE_EXPORT KArchive
{
protected:
    KArchive( const QString& fileName );

    KArchive( QIODevice * dev );

public:
    virtual ~KArchive();

    virtual bool open( QIODevice::OpenMode mode );

    virtual bool close();

    bool isOpen() const;

    QIODevice::OpenMode mode() const;

    QIODevice * device() const;

    QString fileName() const;

    const KArchiveDirectory* directory() const;

    bool addLocalFile( const QString& fileName, const QString& destName );

    bool addLocalDirectory( const QString& path, const QString& destName );

    enum { UnknownTime = static_cast<time_t>( -1 ) };

    virtual bool writeDir( const QString& name, const QString& user, const QString& group,
                           mode_t perm = 040755, time_t atime = UnknownTime,
                           time_t mtime = UnknownTime, time_t ctime = UnknownTime );

    virtual bool writeSymLink(const QString &name, const QString &target,
                              const QString &user, const QString &group,
                              mode_t perm = 0120755, time_t atime = UnknownTime,
                              time_t mtime = UnknownTime, time_t ctime = UnknownTime );

    virtual bool writeFile( const QString& name, const QString& user, const QString& group,
                            const char* data, qint64 size,
                            mode_t perm = 0100644, time_t atime = UnknownTime,
                            time_t mtime = UnknownTime, time_t ctime = UnknownTime );

    virtual bool prepareWriting( const QString& name, const QString& user,
                                 const QString& group, qint64 size,
                                 mode_t perm = 0100644, time_t atime = UnknownTime,
                                 time_t mtime = UnknownTime, time_t ctime = UnknownTime );

    virtual bool writeData( const char* data, qint64 size );

    virtual bool finishWriting( qint64 size );

protected:
    virtual bool openArchive( QIODevice::OpenMode mode ) = 0;

    virtual bool closeArchive() = 0;

    virtual KArchiveDirectory* rootDir();

    virtual bool doWriteDir( const QString& name, const QString& user, const QString& group,
                             mode_t perm, time_t atime, time_t mtime, time_t ctime ) = 0;

    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) = 0;

    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 ) = 0;

    virtual bool doFinishWriting( qint64 size ) = 0;

    KArchiveDirectory * findOrCreate( const QString & path );

    virtual bool createDevice( QIODevice::OpenMode mode );

    void setDevice( QIODevice *dev );

    void setRootDir( KArchiveDirectory *rootDir );

protected:
    virtual void virtual_hook( int id, void* data );
private:
    KArchivePrivate* const d;
};

class KArchiveEntryPrivate;
class KDECORE_EXPORT KArchiveEntry
{
public:
    KArchiveEntry( KArchive* archive, const QString& name, int access, int date,
                   const QString& user, const QString& group,
                   const QString& symlink );

    virtual ~KArchiveEntry();

    QDateTime datetime() const;

    int date() const;

    QString name() const;
    mode_t permissions() const;
    QString user() const;
    QString group() const;

    QString symLinkTarget() const;

    virtual bool isFile() const;

    virtual bool isDirectory() const;

protected:
    KArchive* archive() const;

protected:
    virtual void virtual_hook( int id, void* data );
private:
    KArchiveEntryPrivate* const d;
};

class KArchiveFilePrivate;
class KDECORE_EXPORT KArchiveFile : public KArchiveEntry
{
public:
    KArchiveFile( KArchive* archive, const QString& name, int access, int date,
                  const QString& user, const QString& group, const QString &symlink,
                  qint64 pos, qint64 size );

    virtual ~KArchiveFile();

    qint64 position() const;
    qint64 size() const;
    void setSize( qint64 s );

    virtual QByteArray data() const;

    virtual QIODevice *createDevice() const;

    virtual bool isFile() const;

    void copyTo(const QString& dest) const;

protected:
    virtual void virtual_hook( int id, void* data );
private:
    KArchiveFilePrivate* const d;
};

class KArchiveDirectoryPrivate;
class KDECORE_EXPORT KArchiveDirectory : public KArchiveEntry
{
public:
    KArchiveDirectory( KArchive* archive, const QString& name, int access, int date,
                   const QString& user, const QString& group,
                   const QString& symlink);

    virtual ~KArchiveDirectory();

    QStringList entries() const;
    const KArchiveEntry* entry( const QString& name ) const;

    void addEntry( KArchiveEntry* );

    virtual bool isDirectory() const;

     void copyTo(const QString& dest, bool recursive = true) const;

protected:
    virtual void virtual_hook( int id, void* data );
private:
    KArchiveDirectoryPrivate* const d;
};

#endif