Differential D20576 Diff 57758 kcms/notifications/sourcesmodel.cpp

Changeset View

Standalone View

kcms/notifications/sourcesmodel.cpp

This file was added.

1		/*
2		* Copyright (C) 2007 Matthew Woehlke <mw_triad@users.sourceforge.net>
3		* Copyright (C) 2007 Jeremy Whiting <jpwhiting@kde.org>
4		* Copyright (C) 2016 Olivier Churlaud <olivier@churlaud.com>
5		* Copyright (C) 2019 Kai Uwe Broulik <kde@privat.broulik.de>
6		*
7		* This program is free software; you can redistribute it and/or
8		* modify it under the terms of the GNU General Public License as
9		* published by the Free Software Foundation; either version 2 of
10		* the License or (at your option) version 3 or any later version
11		* accepted by the membership of KDE e.V. (or its successor approved
12		* by the membership of KDE e.V.), which shall act as a proxy
13		* defined in Section 14 of version 3 of the license.
14		*
15		* This program is distributed in the hope that it will be useful,
16		* but WITHOUT ANY WARRANTY; without even the implied warranty of
17		* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
18		* GNU General Public License for more details.
19		*
20		* You should have received a copy of the GNU General Public License
21		* along with this program. If not, see <http://www.gnu.org/licenses/>.
22		*/
23
24		#include "sourcesmodel.h"
25
26		#include <QCollator>
27		#include <QDir>
28		#include <QStandardPaths>
29		#include <QStringList>
30		#include <QRegularExpression>
31
32		#include <KConfig>
33		#include <KConfigGroup>
34		#include <KSharedConfig>
35		#include <KService>
36		#include <KServiceTypeTrader>
37
38		#include <algorithm>
39
40		SourcesModel::SourcesModel(QObject *parent) : QAbstractItemModel(parent)
41		{
42
43		}
44
45		SourcesModel::~SourcesModel() = default;
46
47		QPersistentModelIndex SourcesModel::makePersistentModelIndex(const QModelIndex &idx) const
48		{
49		return QPersistentModelIndex(idx);
50		}
51
52		QPersistentModelIndex SourcesModel::persistentIndexForDesktopEntry(const QString &desktopEntry) const
53		{
54		const auto matches = match(index(0, 0), SourcesModel::DesktopEntryRole, desktopEntry, 1, Qt::MatchFixedString);
55		if (matches.isEmpty()) {
56		return QPersistentModelIndex();
57		}
58		return QPersistentModelIndex(matches.first());
59		}
60
61		QPersistentModelIndex SourcesModel::persistentIndexForNotifyRcName(const QString &notifyRcName) const
62		{
63		const auto matches = match(index(0, 0), SourcesModel::NotifyRcNameRole, notifyRcName, 1, Qt::MatchFixedString);
64		if (matches.isEmpty()) {
65		return QPersistentModelIndex();
66		}
67		return QPersistentModelIndex(matches.first());
68		}
69
70		int SourcesModel::columnCount(const QModelIndex &parent) const
71		{
72		Q_UNUSED(parent);
73		return 1;
74		}
75
76		int SourcesModel::rowCount(const QModelIndex &parent) const
77		{
78		if (parent.column() > 0) {
79		return 0;
80		}
81
82		if (!parent.isValid()) {
83		return m_data.count();
84		}
85
86		if (parent.internalId()) {
87		return 0;
88		}
89
90		return m_data.at(parent.row()).events.count();
91		}
92
93		QVariant SourcesModel::data(const QModelIndex &index, int role) const
94		{
95		if (!index.isValid()) {
96		return QVariant();
97		}
98
99		if (index.internalId()) { // event
100		const auto &event = m_data.at(index.internalId() - 1).events.at(index.row());
101
102		switch (role) {
103		case Qt::DisplayRole: return event.name;
104		case Qt::DecorationRole: return event.iconName;
105		case EventIdRole: return event.eventId;
106		case ActionsRole: return event.actions;
107		}
108
109		return QVariant();
110		}
111
112		const auto &source = m_data.at(index.row());
113
114		switch (role) {
115		case Qt::DisplayRole: return source.display();
116		case Qt::DecorationRole: return source.iconName;
117		case SourceTypeRole: return source.desktopEntry.isEmpty() ? ServiceType : ApplicationType;
118		case NotifyRcNameRole: return source.notifyRcName;
119		case DesktopEntryRole: return source.desktopEntry;
120		}
121
122		return QVariant();
123		}
124
125		bool SourcesModel::setData(const QModelIndex &index, const QVariant &value, int role)
126		{
127		if (!index.isValid()) {
128		return false;
129		}
130
131		bool dirty = false;
132
133		if (index.internalId()) { // event
134		auto &event = m_data[index.internalId() - 1].events[index.row()];
135		switch (role) {
136		case ActionsRole: {
137		const QStringList newActions = value.toStringList();
138		if (event.actions != newActions) {
139		event.actions = newActions;
140		dirty = true;
141		}
142		break;
143		}
144		}
145		}
146
147		if (dirty) {
148		emit dataChanged(index, index, {role});
149		}
150
151		return dirty;
152		}
153
154		QModelIndex SourcesModel::index(int row, int column, const QModelIndex &parent) const
155		{
156		if (row < 0 \|\| column != 0) {
157		return QModelIndex();
158		}
159
160		if (parent.isValid()) {
161		const auto events = m_data.at(parent.row()).events;
162		if (row < events.count()) {
163		return createIndex(row, column, parent.row() + 1);
164		}
165
166		return QModelIndex();
167		}
168
169		if (row < m_data.count()) {
170		return createIndex(row, column, nullptr);
171		}
172
173		return QModelIndex();
174		}
175
176		QModelIndex SourcesModel::parent(const QModelIndex &child) const
177		{
178		if (child.internalId()) {
179		return createIndex(child.internalId() - 1, 0, nullptr);
180		}
181
182		return QModelIndex();
183		}
184
185		QHash<int, QByteArray> SourcesModel::roleNames() const
186		{
187		return {
188		{Qt::DisplayRole, QByteArrayLiteral("display")},
189		{Qt::DecorationRole, QByteArrayLiteral("decoration")},
190		{SourceTypeRole, QByteArrayLiteral("sourceType")},
191		{NotifyRcNameRole, QByteArrayLiteral("notifyRcName")},
192		{DesktopEntryRole, QByteArrayLiteral("desktopEntry")},
193		{EventIdRole, QByteArrayLiteral("eventId")},
194		{ActionsRole, QByteArrayLiteral("actions")}
195		};
196		}
197
198		void SourcesModel::load()
199		{
200		beginResetModel();
201
202		m_data.clear();
203
204		QCollator collator;
205
206		QVector<SourceData> appsData;
207		QVector<SourceData> servicesData;
208
209		QStringList notifyRcFiles;
210		QStringList desktopEntries;
211
212		// old code did KGlobal::dirs()->findAllResources("data", QStringLiteral("/.notifyrc")) but in KF5
213		// only notifyrc files in knotifications5/ folder are supported
214		const QStringList dirs = QStandardPaths::locateAll(QStandardPaths::GenericDataLocation,
215		QStringLiteral("knotifications5"), QStandardPaths::LocateDirectory);
216		for (const QString &dir : dirs) {
217		const QStringList fileNames = QDir(dir).entryList(QStringList() << QStringLiteral("*.notifyrc"));
218		for (const QString &file : fileNames) {
219		if (notifyRcFiles.contains(file)) {
220		continue;
221		}
222
223		notifyRcFiles.append(file);
224
225		KConfig config(file, KConfig::NoGlobals);
226		config.addConfigSources(QStandardPaths::locateAll(QStandardPaths::GenericDataLocation,
227		QStringLiteral("knotifications5/") + file));
228
229		KConfigGroup globalGroup(&config, QLatin1String("Global"));
230
231		const QRegularExpression regExp(QStringLiteral("^Event/([^/]*)$"));
232		const QStringList groups = config.groupList().filter(regExp);
233
234		const QString notifyRcName = file.section(QLatin1Char('.'), 0, -2);
235		const QString desktopEntry = globalGroup.readEntry(QStringLiteral("DesktopEntry"));
236		if (!desktopEntry.isEmpty()) {
237		if (desktopEntries.contains(desktopEntry)) {
238		continue;
239		}
240
241		desktopEntries.append(desktopEntry);
242		}
243
244		SourceData source{
	zzagUnsubmitted Not Done A bit stupid question: how it gets deleted? zzag: A bit stupid question: how it gets deleted?
	broulikAuthorUnsubmitted Not Done Not a stupid question, most likely a leftover broulik: Not a stupid question, most likely a leftover
	martUnsubmitted Not Done delete? mart: delete?
245		// The old KCM read the Name and Comment from global settings disregarding
246		// any user settings and just used user-specific files for actions config
247		// I'm pretty sure there's a readEntry equivalent that does that without
248		// reading the config stuff twice, assuming we care about this to begin with
249		globalGroup.readEntry(QStringLiteral("Name")),
250		globalGroup.readEntry(QStringLiteral("Comment")),
251		globalGroup.readEntry(QStringLiteral("IconName")),
252		notifyRcName,
253		desktopEntry,
254		{} // events
255		};
256
257		QVector<EventData> events;
258		for (const QString &group : groups) {
259		KConfigGroup cg(&config, group);
260
261		const QString eventId = regExp.match(group).captured(1);
262		// TODO context stuff
263		// TODO load defaults thing
264
265		EventData event{
266		cg.readEntry("Name"),
267		cg.readEntry("Comment"),
268		cg.readEntry("IconName"),
269		eventId,
270		// TODO Flags?
271		cg.readEntry("Action").split(QLatin1Char('\|'))
272		};
273		events.append(event);
274		}
275
276		std::sort(events.begin(), events.end(), [&collator](const EventData &a, const EventData &b) {
277		return collator.compare(a.name, b.name) < 0;
278		});
279
280		source.events = events;
281
282		if (!source.desktopEntry.isEmpty()) {
283		appsData.append(source);
284		} else {
285		servicesData.append(source);
286		}
287		}
288		}
289
290		const auto services = KServiceTypeTrader::self()->query(QStringLiteral("Application"),
291		QStringLiteral("exist Exec and TRUE == [X-GNOME-UsesNotifications]"));
292		for (const auto &service : services) {
293		if (service->noDisplay()) {
294		continue;
295		}
296
297		if (desktopEntries.contains(service->desktopEntryName())) {
298		continue;
299		}
300
301		SourceData source{
302		service->name(),
303		service->comment(),
304		service->icon(),
305		QString(), //notifyRcFile
306		service->desktopEntryName(),
307		{} // events
308		};
309		appsData.append(source);
310		desktopEntries.append(service->desktopEntryName());
311		}
312
313		KSharedConfig::Ptr plasmanotifyrc = KSharedConfig::openConfig(QStringLiteral("plasmanotifyrc"));
314		KConfigGroup applicationsGroup = plasmanotifyrc->group("Applications");
315		const QStringList seenApps = applicationsGroup.groupList();
316		for (const QString &app : seenApps) {
317		if (desktopEntries.contains(app)) {
318		continue;
319		}
320
321		KService::Ptr service = KService::serviceByDesktopName(app);
322		if (!service \|\| service->noDisplay()) {
323		continue;
324		}
325
326		SourceData source{
327		service->name(),
328		service->comment(),
329		service->icon(),
330		QString(), //notifyRcFile
331		service->desktopEntryName(),
332		{}
333		};
334		appsData.append(source);
335		desktopEntries.append(service->desktopEntryName());
336		}
337
338		auto sortData = [&collator](const SourceData &a, const SourceData &b) {
339		return collator.compare(a.display(), b.display()) < 0;
340		};
341
342		std::sort(appsData.begin(), appsData.end(), sortData);
343		std::sort(servicesData.begin(), servicesData.end(), sortData);
344
345		m_data << appsData << servicesData;
346
347		endResetModel();
348		}