-
-
Notifications
You must be signed in to change notification settings - Fork 3k
/
qgspluginregistry.cpp
452 lines (375 loc) · 13.1 KB
/
qgspluginregistry.cpp
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
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
/***************************************************************************
QgsPluginRegistry.cpp - Singleton class for
tracking registering plugins.
-------------------
begin : Fri Feb 7 2004
copyright : (C) 2004 by Gary E.Sherman
email : sherman at mrcc.com
***************************************************************************/
/***************************************************************************
* *
* This program is free software; you can redistribute it and/or modify *
* it under the terms of the GNU General Public License as published by *
* the Free Software Foundation; either version 2 of the License, or *
* (at your option) any later version. *
* *
***************************************************************************/
/* $Id$ */
#include <QDir>
#include <QFileInfo>
#include <QLibrary>
#include <QMessageBox>
#include <QSettings>
#include "qgis.h"
#include "qgisinterface.h"
#include "qgspluginregistry.h"
#include "qgspluginmetadata.h"
#include "qgisplugin.h"
#include "qgspythonutils.h"
#include "qgslogger.h"
/* typedefs for plugins */
typedef QgisPlugin *create_ui( QgisInterface * qI );
typedef QString name_t();
typedef QString description_t();
typedef int type_t();
QgsPluginRegistry *QgsPluginRegistry::_instance = 0;
QgsPluginRegistry *QgsPluginRegistry::instance()
{
if ( _instance == 0 )
{
_instance = new QgsPluginRegistry();
}
return _instance;
}
QgsPluginRegistry::QgsPluginRegistry()
: mPythonUtils( NULL ), mQgisInterface( NULL )
{
// constructor does nothing
}
void QgsPluginRegistry::setQgisInterface( QgisInterface* iface )
{
mQgisInterface = iface;
}
void QgsPluginRegistry::setPythonUtils( QgsPythonUtils* pythonUtils )
{
mPythonUtils = pythonUtils;
}
bool QgsPluginRegistry::isLoaded( QString key )
{
QMap<QString, QgsPluginMetadata>::iterator it = mPlugins.find( key );
return ( it != mPlugins.end() );
}
QString QgsPluginRegistry::library( QString key )
{
QMap<QString, QgsPluginMetadata>::iterator it = mPlugins.find( key );
if ( it == mPlugins.end() )
return QString();
return it->library();
}
QgisPlugin *QgsPluginRegistry::plugin( QString key )
{
QMap<QString, QgsPluginMetadata>::iterator it = mPlugins.find( key );
if ( it == mPlugins.end() )
return NULL;
return it->plugin();
}
bool QgsPluginRegistry::isPythonPlugin( QString key )
{
QMap<QString, QgsPluginMetadata>::iterator it = mPlugins.find( key );
if ( it == mPlugins.end() )
return false;
return it->isPython();
}
void QgsPluginRegistry::addPlugin( QString key, QgsPluginMetadata metadata )
{
mPlugins.insert( key, metadata );
}
void QgsPluginRegistry::dump()
{
QgsDebugMsg( "PLUGINS IN REGISTRY: key -> (name, library, isPython)" );
for ( QMap<QString, QgsPluginMetadata>::iterator it = mPlugins.begin();
it != mPlugins.end();
it++ )
{
QgsDebugMsg( QString( "PLUGIN: %1 -> (%2, %3, %4)" )
.arg( it.key() )
.arg( it->name() )
.arg( it->library() )
.arg( it->isPython() ) );
}
}
void QgsPluginRegistry::removePlugin( QString key )
{
QgsDebugMsg( "removing plugin: " + key );
QMap<QString, QgsPluginMetadata>::iterator it = mPlugins.find( key );
if ( it != mPlugins.end() )
{
mPlugins.erase( it );
}
}
void QgsPluginRegistry::unloadAll()
{
for ( QMap<QString, QgsPluginMetadata>::iterator it = mPlugins.begin();
it != mPlugins.end();
it++ )
{
if ( isPythonPlugin( it.key() ) )
{
if ( mPythonUtils )
mPythonUtils->unloadPlugin( it->library() );
else
QgsDebugMsg( "warning: python utils is NULL" );
}
else
{
if ( it->plugin() )
it->plugin()->unload();
else
QgsDebugMsg( "warning: plugin is NULL:" + it.key() );
}
}
}
bool QgsPluginRegistry::checkQgisVersion( QString minVersion )
{
QStringList minVersionParts = minVersion.split( '.' );
// qgis version must be in form x.y.z or just x.y
if ( minVersionParts.count() != 2 && minVersionParts.count() != 3 )
return false;
int minVerMajor, minVerMinor, minVerBugfix = 0;
bool ok;
minVerMajor = minVersionParts.at( 0 ).toInt( &ok );
if ( !ok ) return false;
minVerMinor = minVersionParts.at( 1 ).toInt( &ok );
if ( !ok ) return false;
if ( minVersionParts.count() == 3 )
{
minVerBugfix = minVersionParts.at( 2 ).toInt( &ok );
if ( !ok ) return false;
}
// our qgis version - cut release name after version number
QString qgisVersion = QString( QGis::QGIS_VERSION ).section( '-', 0, 0 );
QStringList qgisVersionParts = qgisVersion.split( "." );
int qgisMajor = qgisVersionParts.at( 0 ).toInt();
int qgisMinor = qgisVersionParts.at( 1 ).toInt();
int qgisBugfix = qgisVersionParts.at( 2 ).toInt();
// first check major version
if ( minVerMajor > qgisMajor ) return false;
if ( minVerMajor < qgisMajor ) return true;
// if same, check minor version
if ( minVerMinor > qgisMinor ) return false;
if ( minVerMinor < qgisMinor ) return true;
// if still same, check bugfix version
if ( minVerBugfix > qgisBugfix ) return false;
// looks like min version is the same as our version - that's fine
return true;
}
void QgsPluginRegistry::loadPythonPlugin( QString packageName )
{
if ( !mPythonUtils || !mPythonUtils->isEnabled() )
{
QgsDebugMsg( "Python is not enabled in QGIS." );
return;
}
QSettings settings;
// is loaded already?
if ( ! isLoaded( packageName ) )
{
// if plugin is not compatible, disable it
if ( ! isPythonPluginCompatible( packageName ) )
{
settings.setValue( "/PythonPlugins/" + packageName, false );
return;
}
mPythonUtils->loadPlugin( packageName );
mPythonUtils->startPlugin( packageName );
// TODO: test success
QString pluginName = mPythonUtils->getPluginMetadata( packageName, "name" );
// add to plugin registry
addPlugin( packageName, QgsPluginMetadata( packageName, pluginName, NULL, true ) );
// add to settings
settings.setValue( "/PythonPlugins/" + packageName, true );
std::cout << "Loaded : " << pluginName.toLocal8Bit().constData() << " (package: "
<< packageName.toLocal8Bit().constData() << ")" << std::endl; // OK
}
}
void QgsPluginRegistry::loadCppPlugin( QString theFullPathName )
{
QSettings settings;
QString baseName = QFileInfo( theFullPathName ).baseName();
// first check to see if its already loaded
if ( isLoaded( baseName ) )
{
// plugin is loaded
// QMessageBox::warning(this, "Already Loaded", description + " is already loaded");
return;
}
QLibrary myLib( theFullPathName );
QString myError; //we will only show detailed diagnostics if something went wrong
myError += "Library name is " + myLib.fileName() + " " + QString( __LINE__ ) + " in " + QString( __FUNCTION__ ) + "\n";
bool loaded = myLib.load();
if ( ! loaded )
{
QgsDebugMsg( "Failed to load " + theFullPathName );
return;
}
myError += "Attempting to resolve the classFactory function " + QString( __LINE__ ) + " in " + QString( __FUNCTION__ ) + "\n";
type_t *pType = ( type_t * ) cast_to_fptr( myLib.resolve( "type" ) );
name_t *pName = ( name_t * ) cast_to_fptr( myLib.resolve( "name" ) );
switch ( pType() )
{
case QgisPlugin::RENDERER:
case QgisPlugin::UI:
case QgisPlugin::VECTOR_OVERLAY:
{
// UI only -- doesn't use mapcanvas
create_ui *cf = ( create_ui * ) cast_to_fptr( myLib.resolve( "classFactory" ) );
if ( cf )
{
QgisPlugin *pl = cf( mQgisInterface );
if ( pl )
{
pl->initGui();
// add it to the plugin registry
addPlugin( baseName, QgsPluginMetadata( myLib.fileName(), pName(), pl ) );
//add it to the qsettings file [ts]
settings.setValue( "/Plugins/" + baseName, true );
}
else
{
// something went wrong
QMessageBox::warning( mQgisInterface->mainWindow(), QObject::tr( "Error Loading Plugin" ),
QObject::tr( "There was an error loading a plugin."
"The following diagnostic information may help the QGIS developers resolve the issue:\n%1." )
.arg( myError ) );
//disable it to the qsettings file [ts]
settings.setValue( "/Plugins/" + baseName, false );
}
}
else
{
QgsDebugMsg( "Unable to find the class factory for " + theFullPathName );
}
}
break;
default:
// type is unknown
QgsDebugMsg( "Plugin " + theFullPathName + " did not return a valid type and cannot be loaded" );
break;
}
}
void QgsPluginRegistry::restoreSessionPlugins( QString thePluginDirString )
{
QSettings mySettings;
#ifdef WIN32
QString pluginExt = "*.dll";
#else
QString pluginExt = "*.so*";
#endif
// check all libs in the current plugin directory and get name and descriptions
QDir myPluginDir( thePluginDirString, pluginExt, QDir::Name | QDir::IgnoreCase, QDir::Files | QDir::NoSymLinks );
for ( uint i = 0; i < myPluginDir.count(); i++ )
{
QString myFullPath = thePluginDirString + "/" + myPluginDir[i];
if ( checkCppPlugin( myFullPath ) )
{
// check if the plugin was active on last session
QString baseName = QFileInfo( myFullPath ).baseName();
if ( mySettings.value( "/Plugins/" + baseName ).toBool() )
{
loadCppPlugin( myFullPath );
}
}
}
if ( mPythonUtils && mPythonUtils->isEnabled() )
{
// check for python plugins system-wide
QStringList pluginList = mPythonUtils->pluginList();
QgsDebugMsg( "Loading python plugins" );
// make the plugin installer and the fTools enabled by default:
if ( !mySettings.contains( "/PythonPlugins/plugin_installer" ) )
{
mySettings.setValue( "/PythonPlugins/plugin_installer", true );
}
if ( !mySettings.contains( "/PythonPlugins/fTools" ) )
{
mySettings.setValue( "/PythonPlugins/fTools", true );
}
for ( int i = 0; i < pluginList.size(); i++ )
{
QString packageName = pluginList[i];
if ( checkPythonPlugin( packageName ) )
{
// check if the plugin was active on last session
if ( mySettings.value( "/PythonPlugins/" + packageName ).toBool() )
{
loadPythonPlugin( packageName );
}
}
}
}
QgsDebugMsg( "Plugin loading completed" );
}
bool QgsPluginRegistry::checkCppPlugin( QString pluginFullPath )
{
QLibrary myLib( pluginFullPath );
bool loaded = myLib.load();
if ( ! loaded )
{
//QgsDebugMsg("Failed to load " + myLib.fileName());
//QgsDebugMsg("Reason: " + myLib.errorString());
return false;
}
name_t * myName = ( name_t * ) cast_to_fptr( myLib.resolve( "name" ) );
description_t * myDescription = ( description_t * ) cast_to_fptr( myLib.resolve( "description" ) );
version_t * myVersion = ( version_t * ) cast_to_fptr( myLib.resolve( "version" ) );
if ( myName && myDescription && myVersion )
return true;
QgsDebugMsg( "Failed to get name, description, or type for " + myLib.fileName() );
return false;
}
bool QgsPluginRegistry::checkPythonPlugin( QString packageName )
{
// import plugin's package
if ( !mPythonUtils->loadPlugin( packageName ) )
return false;
QString pluginName, description, version;
// get information from the plugin
// if there are some problems, don't continue with metadata retreival
pluginName = mPythonUtils->getPluginMetadata( packageName, "name" );
if ( pluginName != "__error__" )
{
description = mPythonUtils->getPluginMetadata( packageName, "description" );
if ( description != "__error__" )
version = mPythonUtils->getPluginMetadata( packageName, "version" );
}
if ( pluginName == "__error__" || description == "__error__" || version == "__error__" )
{
QMessageBox::warning( mQgisInterface->mainWindow(), QObject::tr( "Python error" ),
QObject::tr( "Error when reading metadata of plugin %1" ).arg( packageName ) );
return false;
}
return true;
}
bool QgsPluginRegistry::isPythonPluginCompatible( QString packageName )
{
QString minVersion = mPythonUtils->getPluginMetadata( packageName, "qgisMinimumVersion" );
if ( minVersion == "__error__" || !checkQgisVersion( minVersion ) )
{
//QMessageBox::information(mQgisInterface->mainWindow(),
// QObject::tr("Incompatible plugin"),
// QObject::tr("Plugin \"%1\" is not compatible with this version of Quantum GIS.\nIt will be disabled.").arg(pluginName));
//settings.setValue( "/PythonPlugins/" + packageName, false );
return false;
}
return true;
}
QList<QgsPluginMetadata*> QgsPluginRegistry::pluginData()
{
QList<QgsPluginMetadata*> resultList;
QMap<QString, QgsPluginMetadata>::iterator it = mPlugins.begin();
for ( ; it != mPlugins.end(); ++it )
{
resultList.push_back( &( it.value() ) );
}
return resultList;
}