/usr/include/buteosyncfw5/PluginManager.h is in libbuteosyncfw5-dev 0.7.21+16.04.20151216.1-0ubuntu1.
This file is owned by root:root, with mode 0o644.
The actual contents of the file can be viewed below.
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 | /*
* 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;
// Location filters of plugin maps
const QString STORAGEMAP_LOCATION = "-storage.so";
const QString CLIENTMAP_LOCATION = "-client.so";
const QString SERVERMAP_LOCATION = "-server.so";
const QString STORAGECHANGENOTIFIERMAP_LOCATION = "-changenotifier.so";
// OOP plugins binary name suffix
const QString OOP_CLIENT_SUFFIX = "-client";
const QString OOP_SERVER_SUFFIX = "-server";
// Default directory from which to look for plugins
#if QT_VERSION >= QT_VERSION_CHECK(5, 0, 0)
const QString DEFAULT_PLUGIN_PATH = "/usr/lib/buteo-plugins-qt5/";
const QString DEFAULT_OOP_PLUGIN_PATH = "/usr/lib/buteo-plugins-qt5/oopp";
#else
const QString DEFAULT_PLUGIN_PATH = "/usr/lib/buteo-plugins/";
#endif
// The name of the function which is used to create a plugin
const QString CREATE_FUNCTION = "createPlugin";
// The name of the function which is used to destroy a plugin
const QString DESTROY_FUNCTION = "destroyPlugin";
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*);
/*! \brief Manages plugins
*
* Is responsible for creating and destroying storage,
* server and client plugins.
*/
class PluginManager : public QObject
{
Q_OBJECT
public:
/*! \brief Constructor
*
* @param aPluginPath Path where plugins are stored
*/
PluginManager( const QString &aPluginPath = DEFAULT_PLUGIN_PATH );
/*! \brief Destructor
*
*/
~PluginManager();
/*! \brief Creates a new storage change notifier plugin
* for the storage aStoragName
*
* @param aStorageName well-known name of the storage
*/
StorageChangeNotifierPlugin* createStorageChangeNotifier( const QString& aStorageName );
/*! \brief Destroys a storage change notifier plugin instance
*
* @param aStorageName well-known storage name of the plugin to be destroyed
*/
void destroyStorageChangeNotifier( StorageChangeNotifierPlugin *aPlugin );
/*! \brief Creates a new storage plugin instance
*
* @param aPluginName Name of the plugin
* @return Storage plugin if success, otherwise NULL
*/
StoragePlugin* createStorage( const QString& aPluginName );
/*! \brief Destroys a storage plugin instance
*
* @param aPlugin Plugin to destroy
*/
void destroyStorage( StoragePlugin* aPlugin );
/*! \brief Creates a new client plugin instance
*
* @param aPluginName Name of the plugin
* @param aProfile Sync profile
* @param aCbInterface Callback interface
* @return Client plugin on success, otherwise NULL
*/
ClientPlugin* createClient( const QString& aPluginName,
const SyncProfile& aProfile,
PluginCbInterface *aCbInterface );
/*! \brief Destroys a client plugin instance
*
* @param aPlugin Plugin to destroy
*/
void destroyClient( ClientPlugin* aPlugin );
/*! \brief Creates a new server plugin instance
*
* @param aPluginName Name of the plugin
* @param aProfile Server profile
* @param aCbInterface Callback interface
* @return Server plugin on success, otherwise NULL
*/
ServerPlugin* createServer( const QString& aPluginName,
const Profile& aProfile,
PluginCbInterface *aCbInterface );
/*! \brief Destroys a server plugin
*
* @param aPlugin Plugin to destroy
*/
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
|