File: pluginloader.cpp

package info (click to toggle)
kmymoney 5.0.3-2
  • links: PTS, VCS
  • area: main
  • in suites: buster
  • size: 62,472 kB
  • sloc: cpp: 150,812; sh: 469; python: 425; xml: 249; perl: 169; makefile: 13
file content (172 lines) | stat: -rw-r--r-- 6,606 bytes parent folder | download | duplicates (2)
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
/***************************************************************************
                          pluginloader.cpp
                             -------------------
  Copyright (C) 2017 Łukasz Wojniłowicz <lukasz.wojnilowicz@gmail.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.                                   *
 *                                                                         *
 ***************************************************************************/

#include "pluginloader.h"

// ----------------------------------------------------------------------------
// QT Includes

#include <QMap>
#include <QDebug>

// ----------------------------------------------------------------------------
// KDE Includes

#include <KPluginLoader>
#include <KPluginFactory>
#include <KPluginInfo>
#include <KPluginMetaData>
#include <KXMLGUIFactory>
#include <KSharedConfig>

// ----------------------------------------------------------------------------
// Project Includes

#include "kmymoneyplugin.h"
#include "onlinepluginextended.h"

namespace KMyMoneyPlugin
{
  Category pluginCategory(const KPluginMetaData& pluginInfo)
  {
    if (!pluginInfo.serviceTypes().contains(QStringLiteral("KMyMoney/Plugin"))) {
      auto jsonKMyMoneyData = pluginInfo.rawData()[QLatin1String("KMyMoney")].toObject();
      if (!jsonKMyMoneyData[QLatin1String("OnlineTask")].isNull())
        return OnlineBankOperations;
      else if (!jsonKMyMoneyData[QLatin1String("PayeeIdentifier")].isNull())
        return PayeeIdentifier;
    }
    return StandardPlugin;
  }

  bool isPluginEnabled(const KPluginMetaData& pluginData, const KConfigGroup& pluginSection)
  {
    return pluginSection.readEntry(QString::fromLatin1("%1Enabled").    // we search here for e.g. "csvimporterEnabled = true"
                                   arg(pluginData.pluginId()),
                                   pluginData.isEnabledByDefault());    // if not found, then get default from plugin's json file
  }

  QMap<QString, KPluginMetaData> listPlugins(bool onlyEnabled)
  {
    QMap<QString, KPluginMetaData> plugins;
    const auto pluginDatas = KPluginLoader::findPlugins(QStringLiteral("kmymoney"));          // that means search for plugins in "/lib64/plugins/kmymoney/"
    const auto pluginSection(KSharedConfig::openConfig()->group(QStringLiteral("Plugins")));  // section of config where plugin on/off were saved

    for (const KPluginMetaData& pluginData : pluginDatas) {
      if (pluginData.serviceTypes().contains(QStringLiteral("KMyMoney/Plugin"))) {
        if (!onlyEnabled || isPluginEnabled(pluginData, pluginSection)) {
          // only use the first one found. Otherwise, always the last one
          // wins (usually the installed system version) and the QT_PLUGIN_PATH
          // env variable nor the current directory have an effect for KMyMoney
          if (!plugins.contains(pluginData.pluginId()))
            plugins.insert(pluginData.pluginId(), pluginData);
        }
      }
    }
    return plugins;
  }

  void pluginHandling(Action action, Container& ctnPlugins, QObject* parent, KXMLGUIFactory* guiFactory)
  {

    if (action == Action::Load ||
        action == Action::Reorganize) {
      KPluginLoader::forEachPlugin(QStringLiteral("kmymoney"), [&](const QString &pluginPath) {
          KPluginMetaData metadata(pluginPath);
          qDebug() << "Located plugin" << pluginPath << "Validity" << metadata.isValid();
      });
    }

    QMap<QString, KPluginMetaData> referencePluginDatas;
    if (action == Action::Load ||
        action == Action::Reorganize)
      referencePluginDatas = listPlugins(true);

    if (action == Action::Unload ||
        action == Action::Reorganize) {
      auto& plugins = ctnPlugins.standard;
      auto& refPlugins = referencePluginDatas;
      for (auto it = plugins.begin(); it != plugins.end();) {
        if (!refPlugins.contains(it.key())) {

          ctnPlugins.online.remove(it.key());
          ctnPlugins.extended.remove(it.key());
          ctnPlugins.importer.remove(it.key());
          ctnPlugins.storage.remove(it.key());
          ctnPlugins.data.remove(it.key());

          guiFactory->removeClient(it.value());
          it.value()->unplug();
          delete it.value();
          it = plugins.erase(it);
          continue;

        }
        ++it;
      }
    }

    if (action == Action::Load ||
        action == Action::Reorganize) {

      auto& refPlugins = referencePluginDatas;
      for (auto it = refPlugins.cbegin(); it != refPlugins.cend(); ++it) {
        if (!ctnPlugins.standard.contains(it.key())) {
          qDebug() << "Loading" << (*it).fileName();
          KPluginLoader loader((*it).fileName());
          auto factory = loader.factory();
          if (!factory) {
            qWarning("Could not load plugin '%s', error: %s", qPrintable((*it).fileName()), qPrintable(loader.errorString()));
            loader.unload();
            continue;
          }

          Plugin* plugin = factory->create<Plugin>(parent);
          if (!plugin) {
            qWarning("This is not KMyMoney plugin: '%s'", qPrintable((*it).fileName()));
            loader.unload();
            continue;
          }

          ctnPlugins.standard.insert((*it).pluginId(), plugin);
          plugin->plug();
          guiFactory->addClient(plugin);

          auto IOnline = qobject_cast<OnlinePlugin *>(plugin);
          if (IOnline)
            ctnPlugins.online.insert((*it).pluginId(), IOnline);

          auto IExtended = qobject_cast<OnlinePluginExtended *>(plugin);
          if (IExtended )
            ctnPlugins.extended.insert((*it).pluginId(), IExtended );

          auto IImporter = qobject_cast<ImporterPlugin *>(plugin);
          if (IImporter)
            ctnPlugins.importer.insert((*it).pluginId(), IImporter);

          auto IStorage = qobject_cast<StoragePlugin *>(plugin);
          if (IStorage)
            ctnPlugins.storage.insert((*it).pluginId(), IStorage);

          auto IData = qobject_cast<DataPlugin *>(plugin);
          if (IData)
            ctnPlugins.data.insert((*it).pluginId(), IData);

        }
      }

    }
  }
}