PluginManager.h

/*
 * This file is part of buteo-syncfw package
 *
 * Copyright (C) 2010 Nokia Corporation and/or its subsidiary(-ies).
 * Copyright (C) 2014-2015 Jolla Ltd.
 *
 * 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 PLUGINMANAGER_H
#define PLUGINMANAGER_H
 
#include <QString>
#include <QMap>
#include <QReadWriteLock>
#include <QProcess>
 
namespace Buteo {
 
class StorageChangeNotifierPlugin;
class StoragePlugin;
class ClientPlugin;
class ServerPlugin;
class PluginCbInterface;
class SyncProfile;
class Profile;
 
class ClientPluginTest;
class ServerPluginTest;
class StoragePluginTest;
 
typedef ClientPlugin* (*FUNC_CREATE_CLIENT)( const QString&,
                                             const SyncProfile&,
                                             PluginCbInterface* );
typedef void (*FUNC_DESTROY_CLIENT)( ClientPlugin* );
 
typedef ServerPlugin* (*FUNC_CREATE_SERVER)( const QString&,
                                             const Profile&,
                                             PluginCbInterface* );
typedef void (*FUNC_DESTROY_SERVER)( ServerPlugin* );
 
typedef StoragePlugin* (*FUNC_CREATE_STORAGE)(const QString&);
typedef void (*FUNC_DESTROY_STORAGE)(StoragePlugin*);
 
typedef StorageChangeNotifierPlugin* (*FUNC_CREATE_STORAGECHANGENOTIFIER)(const QString&);
typedef void (*FUNC_DESTROY_STORAGECHANGENOTIFIER)(StorageChangeNotifierPlugin*);
 
class PluginManager : public QObject
{
    Q_OBJECT
 
public:
    PluginManager();
    PluginManager( const QString &aPluginPath );
 
    ~PluginManager();
 
    StorageChangeNotifierPlugin* createStorageChangeNotifier( const QString& aStorageName );
 
    void destroyStorageChangeNotifier( StorageChangeNotifierPlugin *aPlugin );
 
    StoragePlugin* createStorage( const QString& aPluginName );
 
    void destroyStorage( StoragePlugin* aPlugin );
 
    ClientPlugin* createClient( const QString& aPluginName,
                                const SyncProfile& aProfile,
                                PluginCbInterface *aCbInterface );
 
    void destroyClient( ClientPlugin* aPlugin );
 
    ServerPlugin* createServer( const QString& aPluginName,
                                const Profile& aProfile,
                                PluginCbInterface *aCbInterface );
 
    void destroyServer( ServerPlugin *aPlugin );
 
protected slots:
 
    void onProcessFinished( int exitCode, QProcess::ExitStatus exitStatus );
 
private:
 
    struct DllInfo
    {
        QString iPath;
        void*   iHandle;
        int     iRefCount;
 
        DllInfo() : iHandle( NULL ), iRefCount( 0 ) { }
    };
 
 
    void loadPluginMaps( const QString aFilter, QMap<QString, QString>& aTargetMap );
 
    void loadOOPPluginMaps( const QString aFilter, QMap<QString, QString>& aTargetMap );
 
    void* loadDll( const QString& aPath );
 
    void* getDllHandle( const QString& aPath );
 
    void unloadDll( const QString& aPath );
 
    static bool killProcess( const QString& aPath );
 
    QProcess* startOOPPlugin( const QString& aPath,
                              const QString& aPluginName,
                              const QString& aProfileName );
 
    void stopOOPPlugin( const QString& aPath );
 
    QString                 iPluginPath;
 
    QMap<QString, QString>  iStorageChangeNotifierMaps;
    QMap<QString, QString>  iStorageMaps;
    QMap<QString, QString>  iClientMaps;
    QMap<QString, QString>  iServerMaps;
 
    QMap<QString, QString>  iOopClientMaps;
    QMap<QString, QString>  iOoPServerMaps;
 
    QList<DllInfo>          iLoadedDlls;
 
    QReadWriteLock          iDllLock;
 
    QString                 iProcBinaryPath;
 
#ifdef SYNCFW_UNIT_TESTS
    friend class ClientPluginTest;
    friend class ServerPluginTest;
    friend class StoragePluginTest;
#endif
 
};
 
}
 
#endif