karchive.h

/* This file is part of the KDE libraries
   Copyright (C) 2000 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 <tqdatetime.h>
#include <tqstring.h>
#include <tqstringlist.h>
#include <tqdict.h>
 
#include <tdelibs_export.h>
 
class KArchiveDirectory;
class KArchiveFile;

class TDEIO_EXPORT KArchive
{
protected:
    KArchive( TQIODevice * dev );
 
public:
    virtual ~KArchive();

    virtual bool open( int mode );

    virtual void close();

    // TODO KDE4 merge with above
    bool closeSucceeded() const;

    bool isOpened() const { return m_open; }

    int mode() const { return m_mode; }

    TQIODevice * device() const { return m_dev; }

    const KArchiveDirectory* directory() const;

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

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

    virtual bool writeDir( const TQString& name, const TQString& user, const TQString& group ) = 0;

    bool writeDir( const TQString& name, const TQString& user, const TQString& group,
                mode_t perm, time_t atime, time_t mtime, time_t ctime );

    bool writeSymLink(const TQString &name, const TQString &target,
                const TQString &user, const TQString &group,
                mode_t perm, time_t atime, time_t mtime, time_t ctime);

    virtual bool writeFile( const TQString& name, const TQString& user, const TQString& group, uint size, const char* data );

    bool writeFile( const TQString& name, const TQString& user, const TQString& group,
                uint size, mode_t perm, time_t atime, time_t mtime,
                time_t ctime, const char* data );

    virtual bool prepareWriting( const TQString& name, const TQString& user, const TQString& group, uint size ) = 0;

    bool prepareWriting( const TQString& name, const TQString& user,
                const TQString& group, uint size, mode_t perm,
                time_t atime, time_t mtime, time_t ctime );

    bool writeData( const char* data, uint size );

    virtual bool doneWriting( uint size ) = 0;
 
protected:
    virtual bool openArchive( int mode ) = 0;

    virtual bool closeArchive() = 0;

    virtual KArchiveDirectory* rootDir();

    KArchiveDirectory * findOrCreate( const TQString & path );

    void setDevice( TQIODevice *dev );

    void setRootDir( KArchiveDirectory *rootDir );
 
private:
    TQIODevice * m_dev;
    bool m_open;
    char m_mode;
protected:
    virtual void virtual_hook( int id, void* data );
    /* @internal for virtual_hook */
    enum { VIRTUAL_WRITE_DATA = 1, VIRTUAL_WRITE_SYMLINK, VIRTUAL_WRITE_DIR,
        VIRTUAL_WRITE_FILE, VIRTUAL_PREPARE_WRITING };
    bool prepareWriting_impl( const TQString& name, const TQString& user,
                const TQString& group, uint size, mode_t perm,
                time_t atime, time_t mtime, time_t ctime );
    struct PrepareWritingParams {
    const TQString *name;
    const TQString *user;
    const TQString *group;
    uint size;
    mode_t perm;
    time_t atime, mtime, ctime;
    bool retval;
    };
    bool writeFile_impl( const TQString& name, const TQString& user,
                const TQString& group, uint size, mode_t perm,
                time_t atime, time_t mtime, time_t ctime,
                const char* data );
    struct WriteFileParams {
    const TQString *name;
    const TQString *user;
    const TQString *group;
    uint size;
    mode_t perm;
    time_t atime, mtime, ctime;
    const char *data;
    bool retval;
    };
    bool writeDir_impl(const TQString& name, const TQString& user,
                const TQString& group, mode_t perm,
                time_t atime, time_t mtime, time_t ctime);
    struct WriteDirParams {
    const TQString *name;
    const TQString *user;
    const TQString *group;
    mode_t perm;
    time_t atime, mtime, ctime;
    bool retval;
    };
    bool writeSymLink_impl(const TQString &name, const TQString &target,
                const TQString &user, const TQString &group,
                mode_t perm, time_t atime, time_t mtime, time_t ctime);
    struct WriteSymlinkParams {
    const TQString *name;
    const TQString *target;
    const TQString *user;
    const TQString *group;
    mode_t perm;
    time_t atime, mtime, ctime;
    bool retval;
    };
    bool writeData_impl( const char* data, uint size );
    struct WriteDataParams {
        const char* data;
        uint size;
        bool retval;
    };
private:
    class KArchivePrivate;
    KArchivePrivate * d;
};

class TDEIO_EXPORT KArchiveEntry
{
public:
    KArchiveEntry( KArchive* archive, const TQString& name, int access, int date,
               const TQString& user, const TQString& group,
               const TQString &symlink );
 
    virtual ~KArchiveEntry() { }

    TQDateTime datetime() const;

    int date() const { return m_date; }

    TQString name() const { return m_name; }
    mode_t permissions() const { return m_access; }
    TQString user() const { return m_user; }
    TQString group() const { return m_group; }

    TQString symlink() const { return m_symlink; }

    virtual bool isFile() const { return false; }

    virtual bool isDirectory() const { return false; }
 
protected:
    KArchive* archive() const { return m_archive; }
 
private:
    TQString m_name;
    int m_date;
    mode_t m_access;
    TQString m_user;
    TQString m_group;
    TQString m_symlink;
    KArchive* m_archive;
protected:
    virtual void virtual_hook( int id, void* data );
private:
    class KArchiveEntryPrivate* d;
};

class TDEIO_EXPORT KArchiveFile : public KArchiveEntry
{
public:
    KArchiveFile( KArchive* archive, const TQString& name, int access, int date,
              const TQString& user, const TQString& group, const TQString &symlink,
              int pos, int size );
 
    virtual ~KArchiveFile() { }

    int position() const; // TODO use TQ_LONG in KDE-4.0
    int size() const; // TODO use TQ_LONG in KDE-4.0
    void setSize( int s ) { m_size = s; }

    virtual TQByteArray data() const;

    TQIODevice *device() const; // TODO make virtual

    virtual bool isFile() const { return true; }

    void copyTo(const TQString& dest) const;
 
private:
    int m_pos; // TODO use TQ_LONG in KDE-4.0
    int m_size; // TODO use TQ_LONG in KDE-4.0
protected:
    virtual void virtual_hook( int id, void* data );
private:
    class KArchiveFilePrivate* d;
};

class TDEIO_EXPORT KArchiveDirectory : public KArchiveEntry
{
public:
    KArchiveDirectory( KArchive* archive, const TQString& name, int access, int date,
                   const TQString& user, const TQString& group,
                   const TQString& symlink);
 
    virtual ~KArchiveDirectory() { }

    TQStringList entries() const;
    KArchiveEntry* entry( TQString name );
    const KArchiveEntry* entry( TQString name ) const;

    void addEntry( KArchiveEntry* );

    virtual bool isDirectory() const { return true; }

     void copyTo(const TQString& dest, bool recursive = true) const;
 
private:
    TQDict<KArchiveEntry> m_entries;
protected:
    virtual void virtual_hook( int id, void* data );
private:
    class KArchiveDirectoryPrivate* d;
};
 
#endif