kde-playground/kdepim-runtime/resources/imap/resourcetask.h

/*
    Copyright (c) 2010 Klarälvdalens Datakonsult AB,
                       a KDAB Group company <info@kdab.com>
    Author: Kevin Ottens <kevin@kdab.com>

    This library is free software; you can redistribute it and/or modify it
    under the terms of the GNU Library General Public License as published by
    the Free Software Foundation; either version 2 of the License, or (at your
    option) any later version.

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

#include <QtCore/QObject>

#include <Akonadi/Collection>
#include <Akonadi/Item>

#include <kimap/listjob.h>

#include "resourcestateinterface.h"

namespace KIMAP
{
  class Session;
}

class SessionPool;

class ResourceTask : public QObject
{
  Q_OBJECT
  Q_ENUMS( ActionIfNoSession )

public:
  enum ActionIfNoSession {
    CancelIfNoSession,
    DeferIfNoSession
  };

  explicit ResourceTask( ActionIfNoSession action, ResourceStateInterface::Ptr resource, QObject *parent = 0 );
  virtual ~ResourceTask();

  void start( SessionPool *pool );

  void kill();

  static QList<QByteArray> fromAkonadiToSupportedImapFlags( const QList<QByteArray> &flags, const Akonadi::Collection &collection );

  static QList<QByteArray> toAkonadiFlags( const QList<QByteArray> &flags );

Q_SIGNALS:
  void status( int status, const QString &message = QString() );

protected:
  virtual void doStart( KIMAP::Session *session ) = 0;

protected:
  QString userName() const;
  QString resourceName() const;
  QStringList serverCapabilities() const;
  QList<KIMAP::MailBoxDescriptor> serverNamespaces() const;

  bool isAutomaticExpungeEnabled() const;
  bool isSubscriptionEnabled() const;
  bool isDisconnectedModeEnabled() const;
  int intervalCheckTime() const;

  Akonadi::Collection collection() const;
  Akonadi::Item item() const;
  Akonadi::Item::List items() const;

  Akonadi::Collection parentCollection() const;

  Akonadi::Collection sourceCollection() const;
  Akonadi::Collection targetCollection() const;

  QSet<QByteArray> parts() const;
  QSet<QByteArray> addedFlags() const;
  QSet<QByteArray> removedFlags() const;

  QString rootRemoteId() const;
  QString mailBoxForCollection( const Akonadi::Collection &collection ) const;

  void setIdleCollection( const Akonadi::Collection &collection );
  void applyCollectionChanges( const Akonadi::Collection &collection );

  void itemRetrieved( const Akonadi::Item &item );

  void itemsRetrieved( const Akonadi::Item::List &items );
  void itemsRetrievedIncremental( const Akonadi::Item::List &changed,
                                  const Akonadi::Item::List &removed );
  void itemsRetrievalDone();

  void setTotalItems(int);

  void changeCommitted( const Akonadi::Item &item );
  void changesCommitted( const Akonadi::Item::List &items );

  void collectionsRetrieved( const Akonadi::Collection::List &collections );

  void collectionAttributesRetrieved( const Akonadi::Collection &col );

  void changeCommitted( const Akonadi::Collection &collection );

  void changeProcessed();

  void searchFinished( const QVector<qint64> &result, bool isRid = true );

  void cancelTask( const QString &errorString );
  void deferTask();
  void restartItemRetrieval(Akonadi::Collection::Id col);
  void taskDone();
  void emitPercent( int percent );
  void emitError( const QString &message );
  void emitWarning( const QString &message );

  void synchronizeCollectionTree();

  void showInformationDialog( const QString &message, const QString &title, const QString &dontShowAgainName );

  const QChar separatorCharacter() const;
  void setSeparatorCharacter( const QChar &separator );

  virtual bool serverSupportsAnnotations() const;
  virtual bool serverSupportsCondstore() const;

  int batchSize() const;

  ResourceStateInterface::Ptr resourceState();

private:

  static QList<QByteArray> fromAkonadiFlags( const QList<QByteArray> &flags );

private slots:
  void onSessionRequested( qint64 requestId, KIMAP::Session *session,
                           int errorCode, const QString &errorString );
  void onConnectionLost( KIMAP::Session *session );
  void onPoolDisconnect();


private:
  SessionPool *m_pool;
  qint64 m_sessionRequestId;

  KIMAP::Session *m_session;
  ActionIfNoSession m_actionIfNoSession;
  ResourceStateInterface::Ptr m_resource;
  bool mCancelled;
};

#endif