PluginInfo PluginManager::readPluginMetaData(const QString fileName)
{
QDomDocument pluginDoc("EnvisionPlugin");
QFile file(fileName);
if ( !file.open(QIODevice::ReadOnly) ) throw EnvisionException("Can not open file for reading: " + fileName);
if ( !pluginDoc.setContent(&file) ) throw EnvisionException("File is not a valid Envision Plugin descriptor: " + fileName);
QDomElement root = pluginDoc.documentElement();
if ( root.tagName() != "plugin" ) throw EnvisionException("File is not a valid Envision Plugin descriptor - Root element is invalid: " + fileName);
PluginInfo pinfo;
pinfo.id = root.attribute("id");
if ( pinfo.id == QString::null ) throw EnvisionException("File is not a valid Envision Plugin descriptor - ID is invalid: " + fileName);
pinfo.fullName = root.attribute("name");
if ( pinfo.fullName == QString::null ) throw EnvisionException("File is not a valid Envision Plugin descriptor - Name is invalid: " + fileName);
pinfo.version = root.attribute("version");
if ( pinfo.version == QString::null ) throw EnvisionException("File is not a valid Envision Plugin descriptor - Version is invalid: " + fileName);
QDomNode node = root.firstChild();
while ( !node.isNull() )
{
QDomElement elem = node.toElement();
if ( !elem.isNull() && elem.tagName() == "dependencies" )
{
QDomNode dep = elem.firstChild();
while ( !dep.isNull() )
{
QDomElement depElem = dep.toElement();
if ( depElem.tagName() == "dependency" )
{
PluginDependency pd;
pd.id = depElem.attribute("pluginid");
if ( pd.id == QString::null ) throw EnvisionException("Invalid plugin dependency id in file: " + fileName);
pd.majorVersion = depElem.attribute("version");
if ( pd.majorVersion == QString::null ) throw EnvisionException("Invalid plugin dependency version in file: " + fileName);
pinfo.dependencies.append(pd);
}
dep = dep.nextSibling();
}
}
node = node.nextSibling();
}
return pinfo;
}
void PluginManager::scanAllPluginsMetaData()
{
QStringList meta = pluginsDir.entryList(QStringList() << "*.plugin", QDir::Files);
for (QStringList::iterator plugin = meta.begin(); plugin != meta.end(); plugin++)
{
PluginInfo info = readPluginMetaData(pluginsDir.absoluteFilePath(*plugin));
if ( idToMetaDataMap.contains(info.id) ) throw EnvisionException("Plugin id is not unique: " + info.id);
pluginMetaData.append(info);
idToMetaDataMap.insert(info.id, &pluginMetaData.last());
}
}
void PluginManager::unloadAllPlugins()
{
QTextStream out(stdout);
while( !loadedPlugins.isEmpty() )
{
auto plugin = loadedPlugins.takeLast();
auto id = idToPluginLoaderMap.key(plugin);
idToPluginLoaderMap.remove(id);
out << "Unloading plug-in " << id << "... ";
EnvisionPlugin* p = qobject_cast<EnvisionPlugin*> (plugin->instance());
p->unload();
if (!plugin->unload()) throw EnvisionException("Could not unload plugin: " + plugin->errorString());
delete plugin;
out << "OK" << endl;
}
}
void PluginManager::loadAllPlugins(EnvisionManager& envisionManager)
{
int lastCountLoaded = -1;
// Holds the ids of plugins which are not yet loaded.
QStringList plugins;
for (auto p_meta : pluginMetaData)
plugins.append(p_meta.id);
QTextStream out(stdout);
while ( lastCountLoaded != loadedPlugins.length() && loadedPlugins.length() < pluginMetaData.length() )
{
lastCountLoaded = loadedPlugins.length();
for (int i = plugins.length() - 1; i >= 0; i--)
{
QList<PluginDependency> depList = idToMetaDataMap.value(plugins.at(i))->dependencies;
bool allDependenciesLoaded = true;
for (QList<PluginDependency>::iterator dep = depList.begin(); dep != depList.end(); dep++)
{
// Check if this dependency is already loaded
if ( idToPluginLoaderMap.contains(dep->id) == false )
{
allDependenciesLoaded = false;
break;
}
// Check if the version of the non-dependent plugin matches the version the current plugin depends on
if ( !idToMetaDataMap.value(dep->id)->version.startsWith(dep->majorVersion + ".", Qt::CaseSensitive) )
throw EnvisionException("Plugin " + plugins.at(i) + " depends on version " + dep->majorVersion
+ " of " + dep->id + " but a different version is installed.");
}
if ( allDependenciesLoaded )
{
out << "Loading plug-in " << plugins.at(i) << "... " << endl;
QPluginLoader* plugin = new QPluginLoader(pluginsDir.absoluteFilePath(getLibraryFileName(plugins.at(i))));
plugin->setLoadHints(QLibrary::ExportExternalSymbolsHint);
plugin->load();
if ( plugin->isLoaded() == false )
throw EnvisionException("Could not load plugin: " + plugin->errorString());
EnvisionPlugin* p = qobject_cast<EnvisionPlugin*> (plugin->instance());
p->initialize(envisionManager);
out << plugins.at(i) << " loaded OK" << endl;
loadedPlugins.append(plugin);
idToPluginLoaderMap.insert(plugins.at(i), plugin);
plugins.removeAt(i);
}
}
}
// Check if there are any plug-ins with unmet dependencies
if (plugins.size() > 0)
{
out<< "Warning: The following plug-ins have not been loaded because their dependencies are not satisfied" << endl;
for (int i = 0; i< plugins.size(); ++i) out << " " << plugins.at(i) << endl;
}
else out << "All plug-ins loaded." << endl;
}
QList<PluginInfo> EnvisionManager::getAllLoadedPluginsInfo()
{
if (exitSet) return QList<PluginInfo>();
if (pm) return pm->getAllLoadedPluginsInfo();
throw EnvisionException("The Envision Manager has no Plugin Manager set");
}
