SyncPluginBase.h

/*
 * This file is part of buteo-syncfw package
 *
 * Copyright (C) 2010 Nokia Corporation and/or its subsidiary(-ies).
 *
 * Contact: Sateesh Kavuri <sateesh.kavuri@nokia.com>
 *
 * This library is free software; you can redistribute it and/or
 * modify it under the terms of the GNU Lesser General Public License
 * version 2.1 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
 * Lesser General Public License for more details.
 *
 * You should have received a copy of the GNU Lesser General Public
 * License along with this library; if not, write to the Free Software
 * Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA
 * 02110-1301 USA
 *
 */
#ifndef SYNCPLUGINBASE_H
#define SYNCPLUGINBASE_H
 
#include "SyncCommonDefs.h"
#include "SyncResults.h"
#include "ButeoPluginIface.h"
 
#include <QString>
#include <QMetaType>
#include <QObject>
#include <QMap>
 
#define DBUS_SERVICE_NAME_PREFIX "com.buteo.msyncd.plugin."
#define DBUS_SERVICE_OBJ_PATH "/"
 
namespace Buteo {
 
class PluginCbInterface;

class SyncPluginBase : public QObject
{
    Q_OBJECT
 
public:
    SyncPluginBase(const QString &aPluginName,
                   const QString &aProfileName,
                   PluginCbInterface *aCbInterface);

    QString getPluginName() const;

    QString getProfileName() const;

    virtual bool init() = 0;

    virtual bool uninit() = 0;

    virtual void abortSync(Sync::SyncStatus aStatus = Sync::SYNC_ABORTED)
    {
        Q_UNUSED(aStatus);
    }

    virtual bool cleanUp() = 0;

    virtual SyncResults getSyncResults() const;
 
signals:
    void transferProgress(const QString &aProfileName, Sync::TransferDatabase aDatabase,
                          Sync::TransferType aType, const QString &aMimeType, int aCommittedItems);

    void error(const QString &aProfileName, const QString &aMessage, SyncResults::MinorCode aErrorCode);

    void success(const QString &aProfileName, const QString &aMessage);

    void accquiredStorage(const QString &aMimeType);

    void syncProgressDetail(const QString &aProfileName, int aProgressDetail);
 
public slots:
    virtual void connectivityStateChanged(Sync::ConnectivityType aType, bool aState) = 0;
 
protected:
    PluginCbInterface  *iCbInterface;
 
    struct ReceivedItemDetails {
        int added;
        int deleted;
        int modified;
        int error;
        QString mime;
    };
 
    QMap<QString, ReceivedItemDetails> receivedItems;
 
    ButeoPluginIface *iOopPluginIface;
 
private:
    QString iPluginName;
    QString iProfileName;
};
 
}
 
#endif // SYNCPLUGINBASE_H