dataretriever.h

/*
 * Copyright (c) 2001, 2002, 2003 Frerich Raabe <raabe@kde.org>
 *
 * This program 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. For licensing and distribution details, check the
 * accompanying file 'COPYING'.
 */

#ifndef SYNDICATION_DATARETRIEVER_H
#define SYNDICATION_DATARETRIEVER_H

#include "ksyndication_export.h"

#include <QtCore/QObject>
#include <QtCore/QString>
#include <QtCore/QProcess>

namespace KIO
{
    class Job;
}
class KJob;
class KUrl;

class QByteArray;

namespace Syndication
{

class SYNDICATION_EXPORT DataRetriever : public QObject
{
    Q_OBJECT
    public:
        DataRetriever();

        virtual ~DataRetriever();

        virtual void retrieveData(const KUrl& url) = 0;

        virtual int errorCode() const = 0;

        virtual void abort() = 0;

    Q_SIGNALS:
        void dataRetrieved(const QByteArray& data, bool success);

    private:
        DataRetriever(const DataRetriever& other);
        DataRetriever& operator=(const DataRetriever& other);
};


class SYNDICATION_EXPORT OutputRetriever : public DataRetriever
{
    Q_OBJECT

    public:

        OutputRetriever();

        virtual ~OutputRetriever();

        virtual void retrieveData(const KUrl& url);

        virtual int errorCode() const;

        virtual void abort() {}

    private Q_SLOTS:
        void slotFinished ( int exitCode, QProcess::ExitStatus exitStatus ) ;

    private:
        OutputRetriever(const OutputRetriever& other);
        OutputRetriever& operator=(const OutputRetriever& other);

        struct OutputRetrieverPrivate;
        OutputRetrieverPrivate* const d;
};

class SYNDICATION_EXPORT FileRetriever : public DataRetriever
{
    Q_OBJECT

    public:

        FileRetriever();

        virtual ~FileRetriever();

        virtual void retrieveData(const KUrl& url);

        virtual int errorCode() const;

        virtual void abort();

        static void setUseCache(bool enabled);
        
        static void setUserAgent(const QString& userAgent);

    Q_SIGNALS:

        void permanentRedirection(const KUrl& url);

    protected Q_SLOTS:

        void slotTimeout();

    private Q_SLOTS:

        void slotData(KIO::Job*job, const QByteArray& data);
        void slotResult(KJob* job);
        void slotPermanentRedirection(KIO::Job* job, const KUrl& fromUrl,
                                      const KUrl& toUrl);

    private:

        static bool m_useCache;
        static QString m_userAgent;

        FileRetriever(const FileRetriever& other);
        FileRetriever& operator=(const FileRetriever& other);

        struct FileRetrieverPrivate;
        FileRetrieverPrivate* const d;
};

} // namespace Syndication

#endif // SYNDICATION_DATARETRIEVER_H