kwin/src/pluginmanager.cpp
Alexander Lohnau 0d3b017b23 Avoid QtDBus module include in commonly used headers
Because all of QtCore and QtDBus is no longer pulled in, a few placed had to get explicit includes
2023-10-22 13:45:28 +00:00

135 lines
3.7 KiB
C++

/*
SPDX-FileCopyrightText: 2020 Vlad Zahorodnii <vlad.zahorodnii@kde.org>
SPDX-License-Identifier: GPL-2.0-or-later
*/
#include "pluginmanager.h"
#include "dbusinterface.h"
#include "main.h"
#include "plugin.h"
#include "utils/common.h"
#include <KConfigGroup>
#include <KPluginFactory>
#include <KPluginMetaData>
#include <QPluginLoader>
namespace KWin
{
static const QString s_pluginDirectory = QStringLiteral("kwin/plugins");
static QJsonValue readPluginInfo(const QJsonObject &metadata, const QString &key)
{
return metadata.value(QLatin1String("KPlugin")).toObject().value(key);
}
PluginManager::PluginManager()
{
const KConfigGroup config(kwinApp()->config(), QStringLiteral("Plugins"));
auto checkEnabled = [&config](const QString &pluginId, const QJsonObject &metadata) {
const QString configKey = pluginId + QLatin1String("Enabled");
if (config.hasKey(configKey)) {
return config.readEntry(configKey, false);
}
return readPluginInfo(metadata, QStringLiteral("EnabledByDefault")).toBool(false);
};
const QList<KPluginMetaData> plugins = KPluginMetaData::findPlugins(s_pluginDirectory);
for (const KPluginMetaData &metadata : plugins) {
if (m_plugins.find(metadata.pluginId()) != m_plugins.end()) {
qCWarning(KWIN_CORE) << "Conflicting plugin id" << metadata.pluginId();
continue;
}
if (checkEnabled(metadata.pluginId(), metadata.rawData())) {
loadPlugin(metadata);
}
}
new PluginManagerDBusInterface(this);
}
PluginManager::~PluginManager() = default;
QStringList PluginManager::loadedPlugins() const
{
QStringList ret;
ret.reserve(m_plugins.size());
for (const auto &[key, _] : m_plugins) {
ret.push_back(key);
}
return ret;
}
QStringList PluginManager::availablePlugins() const
{
const QList<KPluginMetaData> plugins = KPluginMetaData::findPlugins(s_pluginDirectory);
QStringList ret;
ret.reserve(plugins.size());
for (const KPluginMetaData &metadata : plugins) {
ret.append(metadata.pluginId());
}
return ret;
}
bool PluginManager::loadPlugin(const QString &pluginId)
{
if (m_plugins.find(pluginId) != m_plugins.end()) {
qCDebug(KWIN_CORE) << "Plugin with id" << pluginId << "is already loaded";
return false;
}
const KPluginMetaData metadata = KPluginMetaData::findPluginById(s_pluginDirectory, pluginId);
if (metadata.isValid()) {
if (loadPlugin(metadata)) {
return true;
}
}
return false;
}
bool PluginManager::loadPlugin(const KPluginMetaData &metadata)
{
if (!metadata.isValid()) {
qCDebug(KWIN_CORE) << "PluginManager::loadPlugin needs a valid plugin metadata";
return false;
}
const QString pluginId = metadata.pluginId();
QPluginLoader pluginLoader(metadata.fileName());
if (pluginLoader.metaData().value("IID").toString() != PluginFactory_iid) {
qCWarning(KWIN_CORE) << pluginId << "has mismatching plugin version";
return false;
}
std::unique_ptr<PluginFactory> factory(qobject_cast<PluginFactory *>(pluginLoader.instance()));
if (!factory) {
qCWarning(KWIN_CORE) << "Failed to get plugin factory for" << pluginId;
return false;
}
if (std::unique_ptr<Plugin> plugin = factory->create()) {
m_plugins[pluginId] = std::move(plugin);
return true;
} else {
return false;
}
}
void PluginManager::unloadPlugin(const QString &pluginId)
{
auto it = m_plugins.find(pluginId);
if (it != m_plugins.end()) {
m_plugins.erase(it);
} else {
qCWarning(KWIN_CORE) << "No plugin with the specified id:" << pluginId;
}
}
} // namespace KWin
#include "moc_pluginmanager.cpp"