File indexing completed on 2025-03-23 11:14:12

 /*
     KWin - the KDE window manager
     This file is part of the KDE project.
 
     SPDX-FileCopyrightText: 2013 Martin Gräßlin <mgraesslin@kde.org>
 
     SPDX-License-Identifier: GPL-2.0-or-later
 */
 #include "genericscriptedconfig.h"
 
 #include "config-kwin.h"
 
 #include <kwineffects_interface.h>
 
 #include <KAboutData>
 #define TRANSLATION_DOMAIN "kwin_scripting"
 #include <KLocalizedString>
 #include <KLocalizedTranslator>
 #include <kconfigloader.h>
 
 #include <QFile>
 #include <QLabel>
 #include <QStandardPaths>
 #include <QUiLoader>
 #include <QVBoxLayout>
 
 namespace KWin
 {
 
 QObject *GenericScriptedConfigFactory::create(const char *iface, QWidget *parentWidget, QObject *parent, const QVariantList &args, const QString &keyword)
 {
     // the plugin id is in the args when created by desktop effects kcm or EffectsModel in general
     QString pluginId = args.isEmpty() ? QString() : args.first().toString();
 
     // If we do not get the id of the effect we want to load from the args, we have to check our metadata.
     // This can be the case if the factory gets loaded from a KPluginSelector
     // the plugin id is in plugin factory metadata when created by scripts kcm
     // (because it uses kpluginselector, which doesn't pass the plugin id as the first arg),
     // can be dropped once the scripts kcm is ported to qtquick (because then we could pass the plugin id via the args)
     if (pluginId.isEmpty()) {
         pluginId = metaData().pluginId();
     }
     if (pluginId.startsWith(QLatin1String("kwin4_effect_"))) {
         return new ScriptedEffectConfig(pluginId, parentWidget, args);
     } else {
         return new ScriptingConfig(pluginId, parentWidget, args);
     }
 }
 
 GenericScriptedConfig::GenericScriptedConfig(const QString &keyword, QWidget *parent, const QVariantList &args)
     : KCModule(parent, args)
     , m_packageName(keyword)
     , m_translator(new KLocalizedTranslator(this))
 {
     QCoreApplication::instance()->installTranslator(m_translator);
 }
 
 GenericScriptedConfig::~GenericScriptedConfig()
 {
 }
 
 void GenericScriptedConfig::createUi()
 {
     QVBoxLayout *layout = new QVBoxLayout(this);
 
     const QString packageRoot = QStandardPaths::locate(QStandardPaths::GenericDataLocation,
                                                        QLatin1String("kwin/") + typeName() + QLatin1Char('/') + m_packageName,
                                                        QStandardPaths::LocateDirectory);
     if (packageRoot.isEmpty()) {
         layout->addWidget(new QLabel(i18nc("Error message", "Could not locate package metadata")));
         return;
     }
 
     KPluginMetaData metaData(packageRoot + QLatin1String("/metadata.json"));
 #if QT_VERSION < QT_VERSION_CHECK(6, 0, 0)
     if (!metaData.isValid()) {
         metaData = KPluginMetaData::fromDesktopFile(packageRoot + QLatin1String("/metadata.desktop"));
         if (metaData.isValid()) {
             qWarning("metadata.desktop format is obsolete. Please convert %s to JSON metadata", qPrintable(metaData.fileName()));
         }
     }
 #endif
     if (!metaData.isValid()) {
         layout->addWidget(new QLabel(i18nc("Required file does not exist", "%1 does not contain a valid metadata.json file", qPrintable(packageRoot))));
         return;
     }
 
     const QString kconfigXTFile = packageRoot + QLatin1String("/contents/config/main.xml");
     if (!QFileInfo::exists(kconfigXTFile)) {
         layout->addWidget(new QLabel(i18nc("Required file does not exist", "%1 does not exist", qPrintable(kconfigXTFile))));
         return;
     }
 
     const QString uiPath = packageRoot + QLatin1String("/contents/ui/config.ui");
     if (!QFileInfo::exists(uiPath)) {
         layout->addWidget(new QLabel(i18nc("Required file does not exist", "%1 does not exist", qPrintable(uiPath))));
         return;
     }
 
     const QString localePath = packageRoot + QLatin1String("/contents/locale");
     if (QFileInfo::exists(localePath)) {
         KLocalizedString::addDomainLocaleDir(metaData.value("X-KWin-Config-TranslationDomain").toUtf8(), localePath);
     }
 
     QFile xmlFile(kconfigXTFile);
     KConfigGroup cg = configGroup();
     KConfigLoader *configLoader = new KConfigLoader(cg, &xmlFile, this);
     // load the ui file
     QUiLoader *loader = new QUiLoader(this);
     loader->setLanguageChangeEnabled(true);
     QFile uiFile(uiPath);
     m_translator->setTranslationDomain(metaData.value("X-KWin-Config-TranslationDomain"));
 
     uiFile.open(QFile::ReadOnly);
     QWidget *customConfigForm = loader->load(&uiFile, this);
     m_translator->addContextToMonitor(customConfigForm->objectName());
     uiFile.close();
 
     // send a custom event to the translator to retranslate using our translator
     QEvent le(QEvent::LanguageChange);
     QCoreApplication::sendEvent(customConfigForm, &le);
 
     layout->addWidget(customConfigForm);
     addConfig(configLoader, customConfigForm);
 }
 
 void GenericScriptedConfig::save()
 {
     KCModule::save();
     reload();
 }
 
 void GenericScriptedConfig::reload()
 {
 }
 
 ScriptedEffectConfig::ScriptedEffectConfig(const QString &keyword, QWidget *parent, const QVariantList &args)
     : GenericScriptedConfig(keyword, parent, args)
 {
     createUi();
 }
 
 ScriptedEffectConfig::~ScriptedEffectConfig()
 {
 }
 
 QString ScriptedEffectConfig::typeName() const
 {
     return QStringLiteral("effects");
 }
 
 KConfigGroup ScriptedEffectConfig::configGroup()
 {
     return KSharedConfig::openConfig(QStringLiteral(KWIN_CONFIG))->group(QLatin1String("Effect-") + packageName());
 }
 
 void ScriptedEffectConfig::reload()
 {
     OrgKdeKwinEffectsInterface interface(QStringLiteral("org.kde.KWin"),
                                          QStringLiteral("/Effects"),
                                          QDBusConnection::sessionBus());
     interface.reconfigureEffect(packageName());
 }
 
 ScriptingConfig::ScriptingConfig(const QString &keyword, QWidget *parent, const QVariantList &args)
     : GenericScriptedConfig(keyword, parent, args)
 {
     createUi();
 }
 
 ScriptingConfig::~ScriptingConfig()
 {
 }
 
 KConfigGroup ScriptingConfig::configGroup()
 {
     return KSharedConfig::openConfig(QStringLiteral(KWIN_CONFIG))->group(QLatin1String("Script-") + packageName());
 }
 
 QString ScriptingConfig::typeName() const
 {
     return QStringLiteral("scripts");
 }
 
 void ScriptingConfig::reload()
 {
     // TODO: what to call
 }
 
 } // namespace