Messagelib

headerstylepluginmanager.cpp
1 /*
2  SPDX-FileCopyrightText: 2015-2023 Laurent Montel <[email protected]>
3 
4  SPDX-License-Identifier: LGPL-2.0-or-later
5 */
6 
7 #include "headerstylepluginmanager.h"
8 #include "headerstyleplugin.h"
9 #include "messageviewer_debug.h"
10 #include <KPluginFactory>
11 #include <KPluginMetaData>
12 #include <QFileInfo>
13 
14 using namespace MessageViewer;
15 
16 class HeaderStylePluginInfo
17 {
18 public:
19  HeaderStylePluginInfo() = default;
20 
21  PimCommon::PluginUtilData pluginData;
22  QString metaDataFileNameBaseName;
23  QString metaDataFileName;
24  KPluginMetaData data;
25  MessageViewer::HeaderStylePlugin *plugin = nullptr;
26  bool isEnabled = false;
27 };
28 
29 class MessageViewer::HeaderStylePluginManagerPrivate
30 {
31 public:
32  HeaderStylePluginManagerPrivate(HeaderStylePluginManager *qq)
33  : q(qq)
34  {
35  }
36 
37  Q_REQUIRED_RESULT QVector<MessageViewer::HeaderStylePlugin *> pluginsList() const;
38  Q_REQUIRED_RESULT QVector<PimCommon::PluginUtilData> pluginDataList() const;
39  void initializePluginList();
40  void loadPlugin(HeaderStylePluginInfo *item);
41  Q_REQUIRED_RESULT QString configGroupName() const;
42  Q_REQUIRED_RESULT QString configPrefixSettingKey() const;
43  MessageViewer::HeaderStylePlugin *pluginFromIdentifier(const QString &id);
44 
45 private:
46  QVector<PimCommon::PluginUtilData> mPluginDataList;
48  HeaderStylePluginManager *const q;
49 };
50 
51 namespace
52 {
53 QString pluginVersion()
54 {
55  return QStringLiteral("1.0");
56 }
57 }
58 
59 QVector<PimCommon::PluginUtilData> HeaderStylePluginManagerPrivate::pluginDataList() const
60 {
61  return mPluginDataList;
62 }
63 
64 QString HeaderStylePluginManagerPrivate::configGroupName() const
65 {
66  return QStringLiteral("HeaderStylePlugins");
67 }
68 
69 QString HeaderStylePluginManagerPrivate::configPrefixSettingKey() const
70 {
71  return QStringLiteral("PluginHeaderStyle");
72 }
73 
74 void HeaderStylePluginManagerPrivate::initializePluginList()
75 {
76  const QVector<KPluginMetaData> plugins =
77  KPluginMetaData::findPlugins(QStringLiteral("pim" QT_STRINGIFY(QT_VERSION_MAJOR)) + QStringLiteral("/messageviewer/headerstyle"));
78 
79 #if QT_VERSION < QT_VERSION_CHECK(6, 0, 0)
81 #else
83 #endif
84  i.toBack();
85  const QPair<QStringList, QStringList> pair = PimCommon::PluginUtil::loadPluginSetting(configGroupName(), configPrefixSettingKey());
86  QVector<int> listOrder;
87  while (i.hasPrevious()) {
88  HeaderStylePluginInfo info;
89 
90  const KPluginMetaData data = i.previous();
91 
92  // 1) get plugin data => name/description etc.
93  info.pluginData = PimCommon::PluginUtil::createPluginMetaData(data);
94  // 2) look at if plugin is activated
95  const bool isPluginActivated =
96  PimCommon::PluginUtil::isPluginActivated(pair.first, pair.second, info.pluginData.mEnableByDefault, info.pluginData.mIdentifier);
97  info.isEnabled = isPluginActivated;
98  info.metaDataFileNameBaseName = QFileInfo(data.fileName()).baseName();
99  info.metaDataFileName = data.fileName();
100  info.data = data;
101  const QString version = data.version();
102  if (pluginVersion() == version) {
103  const QVariant p = data.rawData().value(QStringLiteral("X-KDE-MessageViewer-Header-Order")).toVariant();
104  int order = -1;
105  if (p.isValid()) {
106  order = p.toInt();
107  }
108  int pos = 0;
109  for (; pos < listOrder.count(); ++pos) {
110  if (listOrder.at(pos) > order) {
111  pos--;
112  break;
113  }
114  }
115  pos = qMax(0, pos);
116  listOrder.insert(pos, order);
117  info.plugin = nullptr;
118  mPluginList.insert(pos, info);
119  } else {
120  qCWarning(MESSAGEVIEWER_LOG) << "Plugin " << data.name() << " doesn't have correction plugin version. It will not be loaded.";
121  }
122  }
124  for (QVector<HeaderStylePluginInfo>::iterator it = mPluginList.begin(); it != end; ++it) {
125  loadPlugin(&(*it));
126  }
127 }
128 
129 QVector<MessageViewer::HeaderStylePlugin *> HeaderStylePluginManagerPrivate::pluginsList() const
130 {
132  QVector<HeaderStylePluginInfo>::ConstIterator end(mPluginList.constEnd());
133  for (QVector<HeaderStylePluginInfo>::ConstIterator it = mPluginList.constBegin(); it != end; ++it) {
134  if (auto plugin = (*it).plugin) {
135  lst << plugin;
136  }
137  }
138  return lst;
139 }
140 
141 void HeaderStylePluginManagerPrivate::loadPlugin(HeaderStylePluginInfo *item)
142 {
143  if (auto plugin = KPluginFactory::instantiatePlugin<MessageViewer::HeaderStylePlugin>(item->data, q, QVariantList() << item->metaDataFileName).plugin) {
144  item->plugin = plugin;
145  item->plugin->setIsEnabled(item->isEnabled);
146  item->pluginData.mHasConfigureDialog = false;
147  mPluginDataList.append(item->pluginData);
148  }
149 }
150 
151 MessageViewer::HeaderStylePlugin *HeaderStylePluginManagerPrivate::pluginFromIdentifier(const QString &id)
152 {
153  QVector<HeaderStylePluginInfo>::ConstIterator end(mPluginList.constEnd());
154  for (QVector<HeaderStylePluginInfo>::ConstIterator it = mPluginList.constBegin(); it != end; ++it) {
155  if ((*it).pluginData.mIdentifier == id) {
156  return (*it).plugin;
157  }
158  }
159  return {};
160 }
161 
162 HeaderStylePluginManager *HeaderStylePluginManager::self()
163 {
164  static HeaderStylePluginManager s_self;
165  return &s_self;
166 }
167 
168 HeaderStylePluginManager::HeaderStylePluginManager(QObject *parent)
169  : QObject(parent)
170  , d(new MessageViewer::HeaderStylePluginManagerPrivate(this))
171 {
172  d->initializePluginList();
173 }
174 
175 HeaderStylePluginManager::~HeaderStylePluginManager() = default;
176 
177 QVector<MessageViewer::HeaderStylePlugin *> HeaderStylePluginManager::pluginsList() const
178 {
179  return d->pluginsList();
180 }
181 
182 QStringList HeaderStylePluginManager::pluginListName() const
183 {
184  QStringList lst;
185  lst.reserve(d->pluginsList().count());
186  const auto pluginsList{d->pluginsList()};
187  for (MessageViewer::HeaderStylePlugin *plugin : pluginsList) {
188  lst << plugin->name();
189  }
190  return lst;
191 }
192 
193 QString HeaderStylePluginManager::configGroupName() const
194 {
195  return d->configGroupName();
196 }
197 
198 QString HeaderStylePluginManager::configPrefixSettingKey() const
199 {
200  return d->configPrefixSettingKey();
201 }
202 
203 QVector<PimCommon::PluginUtilData> HeaderStylePluginManager::pluginsDataList() const
204 {
205  return d->pluginDataList();
206 }
207 
208 MessageViewer::HeaderStylePlugin *HeaderStylePluginManager::pluginFromIdentifier(const QString &id)
209 {
210  return d->pluginFromIdentifier(id);
211 }
QJsonObject rawData() const
bool isValid() const const
QVector::iterator begin()
void insert(int i, T &&value)
QString fileName() const
The HeaderStylePluginManager class.
QString version() const
void reserve(int alloc)
const T & at(int i) const const
QString name() const
QString baseName() const const
int toInt(bool *ok) const const
QJsonValue value(const QString &key) const const
QVariant toVariant() const const
static QVector< KPluginMetaData > findPlugins(const QString &directory, std::function< bool(const KPluginMetaData &)> filter, KPluginMetaDataOption option)
unsigned int version()
The HeaderStylePlugin class.
int count(const T &value) const const
QVector::const_iterator constBegin() const const
const QList< QKeySequence > & end()
This file is part of the KDE documentation.
Documentation copyright © 1996-2023 The KDE developers.
Generated on Sun Mar 26 2023 04:08:11 by doxygen 1.8.17 written by Dimitri van Heesch, © 1997-2006

KDE's Doxygen guidelines are available online.