knjobdata.h

Go to the documentation of this file.

/*
    KNode, the KDE newsreader
    Copyright (c) 1999-2006 the KNode authors.
    See file AUTHORS for details

    This program is free software; you can redistribute it and/or modify
    it under the terms of the GNU General Public License as published by
    the Free Software Foundation; either version 2 of the License, or
    (at your option) any later version.
    You should have received a copy of the GNU General Public License
    along with this program; if not, write to the Free Software Foundation,
    Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, US
*/

#ifndef KNJOBDATA_H
#define KNJOBDATA_H

#include "knserverinfo.h"

#include <QPointer>
#include <kurl.h>
#include <kio/global.h>
#include <QObject>
#include <QList>
#include <libkdepim/progresswidget/progressmanager.h>


class KJob;

namespace KIO {
class Job;
}

class KNJobItem;
class KNJobData;


class KNJobConsumer {

  public:
    KNJobConsumer();
    virtual ~KNJobConsumer();

    void emitJob(KNJobData *j);

    void jobDone(KNJobData *j);

    bool jobsPending() const { return !mJobs.isEmpty(); }

    void cancelJobs( boost::shared_ptr<KNJobItem> item );

  protected:
    virtual void processJob(KNJobData *j);
    QList<KNJobData*> mJobs;

};


class KNJobItem {

  public:
    typedef boost::shared_ptr<KNJobItem> Ptr;

    KNJobItem()           {}
    virtual ~KNJobItem()  {}

    virtual bool isLocked()         { return false; }
    virtual void setLocked(bool)    { }

    virtual QString prepareForExecution() { return QString(); }

};


class KNJobData : public QObject
{
  Q_OBJECT

  public:

    friend class KNJobConsumer;

    enum jobType {  JTLoadGroups=1,
                    JTFetchGroups,
                    JTfetchNewHeaders,
                    JTfetchArticle,
                    JTpostArticle,
                    JTmail,
                    JTfetchSource   };

    KNJobData( jobType t, KNJobConsumer *c, KNServerInfo::Ptr a, KNJobItem::Ptr i );
    ~KNJobData();

    jobType type() const                  { return t_ype; }

    KNServerInfo::Ptr account() const { return a_ccount; }
    KNJobItem::Ptr data() const           { return d_ata; }

    int error() const { return mError; }
    QString errorString() const { return mErrorString; }
    bool success() const { return mErrorString.isEmpty() && mError == 0; }
    bool canceled() const { return mCanceled; }

    void cancel();

    void setError( int err, const QString &errMsg );

    void prepareForExecution()           { mErrorString = d_ata->prepareForExecution(); }
    void notifyConsumer();

    virtual void execute() = 0;

    KPIM::ProgressItem* progressItem() const { return mProgressItem; }
    void createProgressItem();

    void setStatus( const QString &msg ) { if ( mProgressItem ) mProgressItem->setStatus( msg ); }
    void setProgress( unsigned int progress ) { if ( mProgressItem ) mProgressItem->setProgress( progress ); }
    void setComplete() { if ( mProgressItem ) { mProgressItem->setComplete(); mProgressItem = 0; } }

  signals:
    void finished( KNJobData* );

  protected:
    void emitFinished();

    KUrl baseUrl() const;

    void setupKJob( KJob *job );

    void setupKIOJob( KIO::Job *job );

  protected:
    jobType t_ype;
    KNJobItem::Ptr d_ata;
    KNServerInfo::Ptr a_ccount;
    int mError;
    QString mErrorString;
    bool mCanceled;
    KNJobConsumer *c_onsumer;
    QPointer<KJob> mJob;
    KPIM::ProgressItem *mProgressItem;

  private slots:
    void slotJobPercent( KJob *job, unsigned long percent );
    void slotJobInfoMessage( KJob *job, const QString &msg );
    void slotEmitFinished();

};


#endif