-
Notifications
You must be signed in to change notification settings - Fork 0
Expand file tree
/
Copy pathpluginmanager.cpp
More file actions
378 lines (322 loc) · 10.3 KB
/
pluginmanager.cpp
File metadata and controls
378 lines (322 loc) · 10.3 KB
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
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
#include "pluginmanager.h"
#include "pluginmanager_p.h"
#include <QtCore/QDir>
#include <QtCore/QXmlStreamReader>
#include <QtCore/QSettings>
#include <QtGui/QApplication>
#include <utils/iprogressmonitor.h>
#include "iplugin.h"
#include "pluginspec.h"
using namespace PluginLoader;
enum {
debugPluginManager = 0
};
PluginManager::PluginManager()
: d_ptr(new PluginManagerPrivate(this))
{
Q_D(PluginManager);
d->restoreSettings();
}
PluginManager::~PluginManager()
{
Q_D(PluginManager);
d->saveSettings();
delete d;
}
/*!
The PluginManager is a singleton. Use this method to get an instance.
\return PluginManager's instance
*/
PluginManager *PluginManager::instance()
{
static PluginManager instance;
return &instance;
}
/*!
Returs all paths where to search for plugins.
\return plugin paths
*/
QStringList PluginManager::getPluginPaths()
{
QDir rootDir = QApplication::applicationDirPath();
rootDir.cdUp();
const QString rootDirPath = rootDir.canonicalPath();
const QString searchPath =
rootDirPath + '/' + QString(UITOOLS_REL_PLUGINS_DIR);
return QStringList() << searchPath;
}
/*!
Searches all the given \a paths for valid application's plugins. Once the
dependencies among plugins are resolved the plugins are loaded in found
order.
\param paths the list of paths where to search for plugins
*/
void PluginManager::loadPlugins(const QStringList &paths)
{
Q_D(PluginManager);
return d->loadPlugins(paths);
}
/*!
Returns the list of successfully loaded plugins.
\return the list of loaded plugins
*/
QList<IPlugin *> PluginManager::plugins() const
{
Q_D(const PluginManager);
return d->plugins();
}
/*!
Tries to initialize all loaded plugins.
\return true if all loaded plugins were successfully initialized
\sa IPlugin::initialize()
*/
bool PluginManager::initializePlugins(Utils::IProgressMonitor *monitor)
{
Q_D(PluginManager);
return d->initializePlugins(monitor);
}
/*!
In case some plugin initialization failed and the reason is too critical,
plugin may request application shutdown.
Optional argument \a pluginName is filled by plugin name that has requested
shutdown and can be used in a message shown to user.
\param pluginName if not null, filled by plugin name which needs shutdown
\return true if any plugin requested shutdown
*/
bool PluginManager::isShutdownRequested(QString *pluginName)
{
Q_D(PluginManager);
if (pluginName != 0)
*pluginName = d->pluginWhichRequestedShutdown;
return !d->pluginWhichRequestedShutdown.isEmpty();
}
/*!
Unloads all loaded plugins. Before each plugin is unloaded the method
IPlugin::shutdown() is called.
\sa IPlugin::shutdown()
*/
void PluginManager::unloadPlugins()
{
Q_D(PluginManager);
QList<PluginSpec *> queue = d->unloadQueue();
return d->unloadPlugins(queue);
}
/*!
Returns the list of plugin specifications for successfully loaded plugins.
The specification is taken from plugin's description file.
\return the list of plugin specifications
\sa PluginSpec
*/
QList<PluginSpec *> PluginManager::pluginSpecs() const
{
Q_D(const PluginManager);
return d->pluginSpecs();
}
/*!
Returns the plugin specification for given \a plugin.
\param plugin the instance of loaded plugin
\return the plugin specification
*/
PluginSpec *PluginManager::pluginSpec(IPlugin *plugin) const
{
Q_D(const PluginManager);
return d->pluginSpec(plugin);
}
bool PluginManager::isPluginLoaded(const QString &pluginName) const
{
Q_D(const PluginManager);
foreach (IPlugin *plugin, d->plugins()) {
if (pluginSpec(plugin)->name() == pluginName)
return true;
}
return false;
}
PluginManagerPrivate::PluginManagerPrivate(PluginManager *q)
: q_ptr(q)
{
}
PluginManagerPrivate::~PluginManagerPrivate()
{
QList<IPlugin *> plugins = m_pluginToSpec.uniqueKeys();
plugins.removeAll(0);
if (plugins.count() > 0) {
qWarning("%d unloaded plugins left left in memory:", plugins.count());
foreach (IPlugin *plugin, plugins) {
qWarning(" - %s", qPrintable(m_pluginToSpec.value(plugin)->name()));
}
}
qDeleteAll(m_pluginToSpec);
m_pluginToSpec.clear();
}
void PluginManagerPrivate::loadPlugins(const QStringList &paths)
{
Q_ASSERT(!paths.isEmpty());
Q_ASSERT(m_pluginToSpec.isEmpty());
readPluginSpecs(paths);
resolveDependencies();
QList<PluginSpec *> pluginLoadQueue = loadQueue();
foreach (PluginSpec *pluginSpec, pluginLoadQueue) {
IPlugin *plugin = pluginSpec->loadPlugin();
if (plugin != 0) {
m_pluginToSpec.remove(0, pluginSpec);
m_pluginToSpec.insert(plugin, pluginSpec);
}
}
}
QList<IPlugin *> PluginManagerPrivate::plugins() const
{
QList<IPlugin *> plugins = m_pluginToSpec.uniqueKeys();
plugins.removeAll(0);
return plugins;
}
bool PluginManagerPrivate::initializePlugins(Utils::IProgressMonitor *monitor)
{
Q_Q(PluginManager);
QList<PluginSpec *> pluginLoadQueue = loadQueue();
bool allInitialized = true;
pluginWhichRequestedShutdown.clear();
foreach (PluginSpec *pluginSpec, pluginLoadQueue) {
if (pluginSpec->state() == PluginSpec::Loaded) {
monitor->setStatus(pluginSpec->name());
bool initialized = pluginSpec->initializePlugin();
if (!initialized) {
allInitialized = false;
// unload dependent plugins
QList<PluginSpec *> queue;
QList<PluginSpec *> circularity;
//shutdown requested, unload all plugins and terminate app
if (pluginSpec->plugin()->isShutdownRequested()) {
pluginWhichRequestedShutdown = pluginSpec->name();
return false;
}
else {
pluginSpec->unloadQueue(queue, circularity);
unloadPlugins(queue);
// update 'IndirectlyDisabled' state of dependent plugins
pluginSpec->resolveIndirectlyDisabled(true);
}
}
}
}
emit q->pluginsInitialized();
return allInitialized;
}
void PluginManagerPrivate::unloadPlugins(QList<PluginSpec *> unloadQueue)
{
foreach (PluginSpec *pluginSpec, unloadQueue) {
m_pluginToSpec.remove(pluginSpec->plugin(), pluginSpec);
pluginSpec->unloadPlugin();
m_pluginToSpec.insert(0, pluginSpec);
}
}
QList<PluginSpec *> PluginManagerPrivate::pluginSpecs() const
{
return m_pluginToSpec.values();
}
PluginSpec *PluginManagerPrivate::pluginSpec(IPlugin *plugin) const
{
Q_ASSERT(plugin != 0);
return m_pluginToSpec.value(plugin);
}
void PluginManagerPrivate::restoreSettings()
{
QSettings settings;
settings.beginGroup("PluginManager");
m_disabledPlugins = settings.value(
QLatin1String("PluginSpec.DisabledPlugins")).toStringList();
settings.endGroup(); // PluginManager
if (debugPluginManager) {
qDebug("PluginManager: Settings restored");
}
}
void PluginManagerPrivate::saveSettings()
{
QSettings settings;
settings.beginGroup(QLatin1String("PluginManager"));
QStringList tempDisabledPlugins;
QList<PluginSpec *> pluginSpecs = m_pluginToSpec.values();
foreach (PluginSpec *spec, pluginSpecs) {
if (!spec->isEnabled()) {
tempDisabledPlugins.append(spec->name());
}
}
tempDisabledPlugins.removeDuplicates();
settings.setValue(
QLatin1String("PluginSpec.DisabledPlugins"), tempDisabledPlugins);
settings.endGroup(); // PluginManager
if (debugPluginManager) {
qDebug("PluginManager: Settings saved");
}
}
void PluginManagerPrivate::readPluginSpecs(const QStringList &paths)
{
qDeleteAll(m_pluginToSpec);
m_pluginToSpec.clear();
QStringList specFileNames;
QStringList searchPaths = paths;
while (!searchPaths.isEmpty()) {
const QDir dir(searchPaths.takeFirst());
const QStringList nameFilters = QStringList() << "*.spec";
const QFileInfoList files =
dir.entryInfoList(nameFilters, QDir::Readable | QDir::Files);
foreach (const QFileInfo &file, files) {
specFileNames << file.absoluteFilePath();
}
const QFileInfoList subDirs = dir.entryInfoList(
QDir::Readable | QDir::Dirs | QDir::NoDotAndDotDot);
foreach (const QFileInfo &subDir, subDirs) {
searchPaths << subDir.absoluteFilePath();
}
}
foreach (const QString &specFileName, specFileNames) {
PluginSpec *pluginSpec = new PluginSpec();
if (pluginSpec->read(specFileName)) {
m_pluginToSpec.insert(0, pluginSpec);
}
}
}
void PluginManagerPrivate::resolveDependencies()
{
const QList<PluginSpec *> pluginSpecs = m_pluginToSpec.values();
foreach (PluginSpec *pluginSpec, pluginSpecs) {
if (m_disabledPlugins.contains(pluginSpec->name())) {
pluginSpec->setEnabled(false);
}
pluginSpec->resolveDependecies(pluginSpecs);
}
foreach (PluginSpec *pluginSpec, pluginSpecs) {
pluginSpec->resolveIndirectlyDisabled(true);
}
}
QList<PluginSpec *> PluginManagerPrivate::loadQueue()
{
QList<PluginSpec *> queue;
/*
We need to sort pluginSpecs in ascending order of pluginSpec.name
to ensure the same load order everywhere.
*/
QMap<QString, PluginSpec *> pluginSpecs;
foreach (PluginSpec *pluginSpec, m_pluginToSpec) {
pluginSpecs.insert(pluginSpec->name(), pluginSpec);
}
foreach (PluginSpec *pluginSpec, pluginSpecs) {
QList<PluginSpec *> circularityCheckQueue;
if (pluginSpec->state() >= PluginSpec::Resolved)
pluginSpec->loadQueue(queue, circularityCheckQueue);
}
if (debugPluginManager)
qWarning() << "Load queue: " << queue;
return queue;
}
QList<PluginSpec *> PluginManagerPrivate::unloadQueue()
{
QList<PluginSpec *> queue;
foreach (PluginSpec *pluginSpec, m_pluginToSpec) {
QList<PluginSpec *> circularityCheckQueue;
if (pluginSpec->state() >= PluginSpec::Loaded)
pluginSpec->unloadQueue(queue, circularityCheckQueue);
}
if (debugPluginManager)
qWarning() << "Unload queue: " << queue;
return queue;
}