genericpluginmanager.cpp

/*
  SPDX-FileCopyrightText: 2015-2024 Laurent Montel <montel@kde.org>
 
  SPDX-License-Identifier: GPL-2.0-or-later
*/
 
#include "genericpluginmanager.h"
#include "genericplugin.h"
#include "pimcommon_debug.h"
 
#include <KPluginFactory>
 
#include <QFileInfo>
 
using namespace PimCommon;
 
class GenericPluginInfo
{
public:
    GenericPluginInfo() = default;
 
    KPluginMetaData data;
    QString metaDataFileNameBaseName;
    QString metaDataFileName;
    PimCommon::PluginUtilData pluginData;
    PimCommon::GenericPlugin *plugin = nullptr;
    bool isEnabled = true;
};
 
namespace
{
QString pluginVersion()
{
    return QStringLiteral("1.0");
}
}
 
class PimCommon::GenericPluginManagerPrivate
{
public:
    explicit GenericPluginManagerPrivate(GenericPluginManager *qq)
        : q(qq)
    {
    }
 
    void loadPlugin(GenericPluginInfo *item);
    [[nodiscard]] QList<GenericPlugin *> pluginsList() const;
    bool initializePlugins();
    QString pluginDirectory;
    QString pluginName;
    QList<GenericPluginInfo> mPluginList;
 
    [[nodiscard]] QList<PluginUtilData> pluginsDataList() const;
    [[nodiscard]] QString configGroupName() const;
    [[nodiscard]] QString configPrefixSettingKey() const;
    GenericPlugin *pluginFromIdentifier(const QString &id);
 
private:
    QList<PluginUtilData> mPluginDataList;
    GenericPluginManager *const q;
};
 
QString GenericPluginManagerPrivate::configGroupName() const
{
    return QStringLiteral("GenericPlugin-%1").arg(pluginName);
}
 
QString GenericPluginManagerPrivate::configPrefixSettingKey() const
{
    return QStringLiteral("%1Plugin").arg(pluginName);
}
 
bool GenericPluginManagerPrivate::initializePlugins()
{
    if (!mPluginList.isEmpty()) {
        return true;
    }
 
    if (pluginDirectory.isEmpty() || pluginName.isEmpty()) {
        return false;
    }
    const QList<KPluginMetaData> plugins = KPluginMetaData::findPlugins(pluginDirectory);
 
    const QPair<QStringList, QStringList> pair = PimCommon::PluginUtil::loadPluginSetting(configGroupName(), configPrefixSettingKey());
    QListIterator<KPluginMetaData> i(plugins);
    i.toBack();
    while (i.hasPrevious()) {
        GenericPluginInfo info;
        const KPluginMetaData data = i.previous();
 
        // 1) get plugin data => name/description etc.
        info.pluginData = PimCommon::PluginUtil::createPluginMetaData(data);
        // 2) look at if plugin is activated
        const bool isPluginActivated =
            PimCommon::PluginUtil::isPluginActivated(pair.first, pair.second, info.pluginData.mEnableByDefault, info.pluginData.mIdentifier);
        info.isEnabled = isPluginActivated;
        info.metaDataFileNameBaseName = QFileInfo(data.fileName()).baseName();
        info.metaDataFileName = data.fileName();
        info.data = data;
 
        if (pluginVersion() == data.version()) {
            info.plugin = nullptr;
            mPluginList.push_back(info);
        } else {
            qCWarning(PIMCOMMON_LOG) << "Plugin " << data.name() << " doesn't have correction plugin version. It will not be loaded.";
        }
    }
    QList<GenericPluginInfo>::iterator end(mPluginList.end());
    for (QList<GenericPluginInfo>::iterator it = mPluginList.begin(); it != end; ++it) {
        loadPlugin(&(*it));
    }
    return true;
}
 
QList<PluginUtilData> GenericPluginManagerPrivate::pluginsDataList() const
{
    return mPluginDataList;
}
 
QList<GenericPlugin *> GenericPluginManagerPrivate::pluginsList() const
{
    QList<PimCommon::GenericPlugin *> lst;
    QList<GenericPluginInfo>::ConstIterator end(mPluginList.constEnd());
    for (QList<GenericPluginInfo>::ConstIterator it = mPluginList.constBegin(); it != end; ++it) {
        if (auto plugin = (*it).plugin) {
            lst << plugin;
        }
    }
    return lst;
}
 
void GenericPluginManagerPrivate::loadPlugin(GenericPluginInfo *item)
{
    if (auto plugin = KPluginFactory::instantiatePlugin<PimCommon::GenericPlugin>(item->data, q, QVariantList() << item->metaDataFileNameBaseName).plugin) {
        item->plugin = plugin;
        item->plugin->setIsEnabled(item->isEnabled);
        item->pluginData.mHasConfigureDialog = item->plugin->hasConfigureDialog();
        mPluginDataList.append(item->pluginData);
    }
}
 
GenericPlugin *GenericPluginManagerPrivate::pluginFromIdentifier(const QString &id)
{
    QList<GenericPluginInfo>::ConstIterator end(mPluginList.constEnd());
    for (QList<GenericPluginInfo>::ConstIterator it = mPluginList.constBegin(); it != end; ++it) {
        if ((*it).pluginData.mIdentifier == id) {
            return (*it).plugin;
        }
    }
    return {};
}
 
GenericPluginManager::GenericPluginManager(QObject *parent)
    : QObject(parent)
    , d(new GenericPluginManagerPrivate(this))
{
}
 
GenericPluginManager::~GenericPluginManager() = default;
 
bool GenericPluginManager::initializePlugins()
{
    return d->initializePlugins();
}
 
void GenericPluginManager::setPluginDirectory(const QString &directory)
{
    d->pluginDirectory = directory;
}
 
QString GenericPluginManager::pluginDirectory() const
{
    return d->pluginDirectory;
}
 
void GenericPluginManager::setPluginName(const QString &pluginName)
{
    d->pluginName = pluginName;
}
 
QString GenericPluginManager::pluginName() const
{
    return d->pluginName;
}
 
QList<GenericPlugin *> GenericPluginManager::pluginsList() const
{
    return d->pluginsList();
}
 
QList<PluginUtilData> GenericPluginManager::pluginsDataList() const
{
    return d->pluginsDataList();
}
 
QString GenericPluginManager::configGroupName() const
{
    return d->configGroupName();
}
 
QString GenericPluginManager::configPrefixSettingKey() const
{
    return d->configPrefixSettingKey();
}
 
GenericPlugin *GenericPluginManager::pluginFromIdentifier(const QString &id)
{
    return d->pluginFromIdentifier(id);
}
 
#include "moc_genericpluginmanager.cpp"