Differential D20265 Diff 56056 libnotificationmanager/jobsmodel.cpp

Changeset View

Standalone View

View Options

libnotificationmanager/jobsmodel.cpp

  • This file was added.
1​/*
2​ * Copyright 2019 Kai Uwe Broulik <kde@privat.broulik.de>
3​ *
4​ * This library is free software; you can redistribute it and/or
5​ * modify it under the terms of the GNU Lesser General Public
6​ * License as published by the Free Software Foundation; either
7​ * version 2.1 of the License, or (at your option) version 3, or any
8​ * later version accepted by the membership of KDE e.V. (or its
9​ * successor approved by the membership of KDE e.V.), which shall
10​ * act as a proxy defined in Section 6 of version 3 of the license.
11​ *
12​ * This library is distributed in the hope that it will be useful,
13​ * but WITHOUT ANY WARRANTY; without even the implied warranty of
14​ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
15​ * Lesser General Public License for more details.
16​ *
17​ * You should have received a copy of the GNU Lesser General Public
18​ * License along with this library. If not, see <http://www.gnu.org/licenses/>.
19​ */
20​
21​#include "jobsmodel.h"
22​#include "jobsmodel_p.h"
23​
24​#include "notifications.h"
25​
26​#include <QDebug>
27​#include <QScopedPointer>
28​
29​#include <KJob>
30​
31​#include <Plasma/DataEngineConsumer>
32​#include <Plasma/DataEngine>
33​#include <Plasma/ServiceJob>
34​
35​#include "job.h"
36​#include "job_p.h"
37​
38​using namespace NotificationManager;
39​
40​JobsModel::JobsModel()
41​ : QAbstractListModel(nullptr)
42​ , d(new JobsModelPrivate(this))
43​{
44​ connect(d, &JobsModelPrivate::jobViewAboutToBeAdded, this, [this](int row, Job *job) {
45​ Q_UNUSED(job);
46​ beginInsertRows(QModelIndex(), row, row);
47​ });
48​ connect(d, &JobsModelPrivate::jobViewAdded, this, [this](int row) {
49​ Q_UNUSED(row);
50​ endInsertRows();
51​ });
52​
53​ connect(d, &JobsModelPrivate::jobViewAboutToBeRemoved, this, [this](int row) {
54​ beginRemoveRows(QModelIndex(), row, row);
55​ });
56​ connect(d, &JobsModelPrivate::jobViewRemoved, this, [this](int row) {
57​ Q_UNUSED(row);
58​ endRemoveRows();
59​ });
60​
61​ connect(d, &JobsModelPrivate::jobViewChanged, this, [this](int row, Job *job, const QVector<int> &roles) {
62​ Q_UNUSED(job);
63​ const QModelIndex idx = index(row, 0);
64​ emit dataChanged(idx, idx, roles);
65​ });
66​}
67​
68​JobsModel::~JobsModel() = default;
69​
70​JobsModel::Ptr JobsModel::createJobsModel()
71​{
72​ static QWeakPointer<JobsModel> s_instance;
martUnsubmitted
Not Done

any reason to go this way instead of Q_GLOBAL_STATIC ?
I guess you want to have cases in which none of it is ever created? tough the case would be when there are no notification plasmoids, but in that case the plugin containing the library wouldn't be loaded?

mart: any reason to go this way instead of Q_GLOBAL_STATIC ? I guess you want to have cases in which…
broulikAuthorUnsubmitted
Not Done

This library is not just for plasmoids, it is also used in the jobs dataengine for instance.
But yeah I want some refcounting so the model stuff is only done when there's actually someone using it.

broulik: This library is not just for plasmoids, it is also used in the jobs dataengine for instance.
73​ if (!s_instance) {
74​ QSharedPointer<JobsModel> ptr(new JobsModel());
75​ s_instance = ptr.toWeakRef();
76​ return ptr;
77​ }
78​ return s_instance.toStrongRef();
79​}
80​
81​bool JobsModel::init()
82​{
83​ return d->init();
84​}
85​
86​bool JobsModel::isValid() const
87​{
88​ return d->m_valid;
89​}
90​
91​QVariant JobsModel::data(const QModelIndex &index, int role) const
92​{
93​ if (!index.isValid() || index.row() >= d->m_jobViews.count()) {
94​ return QVariant();
95​ }
96​
97​ Job *job = d->m_jobViews.at(index.row());
98​
99​ switch (role) {
100​ case Notifications::IdRole: return job->id();
101​ case Notifications::TypeRole: return Notifications::JobType;
102​ // basically when it started
103​ case Notifications::CreatedRole:
104​ if (job->created().isValid()) {
105​ return job->created();
106​ }
107​ break;
108​ // basically when it finished
109​ case Notifications::UpdatedRole:
110​ if (job->updated().isValid()) {
111​ return job->updated();
112​ }
113​ break;
114​ case Notifications::SummaryRole: return job->summary();
115​ case Notifications::BodyRole: return job->text();
116​ case Notifications::DesktopEntryRole: return job->desktopEntry();
117​ case Notifications::ApplicationNameRole: return job->applicationName();
118​ case Notifications::ApplicationIconNameRole: return job->applicationIconName();
119​
120​ case Notifications::JobStateRole: return job->state();
121​ case Notifications::PercentageRole: return job->percentage();
122​ case Notifications::JobErrorRole: return job->error();
123​ case Notifications::SuspendableRole: return job->suspendable();
124​ case Notifications::KillableRole: return job->killable();
125​ case Notifications::JobDetailsRole: return QVariant::fromValue(job);
126​
127​ // successfully finished jobs timeout like a regular notifiation
128​ // whereas running or error'd jobs are persistent
129​ case Notifications::TimeoutRole:
130​ return job->state() == Notifications::JobStateStopped && !job->error() ? -1 : 0;
131​ case Notifications::ClosableRole:
132​ return job->state() == Notifications::JobStateStopped;
133​
134​ case Notifications::ConfigurableRole: return false;
135​ case Notifications::ExpiredRole: return job->expired();
136​ case Notifications::DismissedRole: return job->dismissed();
137​ }
138​
139​ return QVariant();
140​}
141​
142​bool JobsModel::setData(const QModelIndex &index, const QVariant &value, int role)
143​{
144​ if (!index.isValid() || index.row() >= d->m_jobViews.count()) {
145​ return false;
146​ }
147​
148​ Job *job = d->m_jobViews.at(index.row());
149​
150​ bool dirty = false;
151​
152​ switch (role) {
153​ case Notifications::DismissedRole:
154​ if (value.toBool() != job->dismissed()) {
155​ job->setDismissed(value.toBool());
156​ dirty = true;
157​ }
158​ break;
159​ }
160​
161​ if (dirty) {
162​ emit dataChanged(index, index, {role});
163​ }
davidedmundsonUnsubmitted
Done

Why?

job::setDismissed has a signal that should propagate through

davidedmundson: Why? job::setDismissed has a signal that should propagate through
164​
165​ return dirty;
166​}
167​
168​int JobsModel::rowCount(const QModelIndex &parent) const
169​{
170​ if (parent.isValid()) {
171​ return 0;
172​ }
173​
174​ return d->m_jobViews.count();
175​}
176​
177​void JobsModel::close(const QModelIndex &idx)
178​{
179​ if (!idx.isValid() || idx.row() >= d->m_jobViews.count()) {
180​ return;
181​ }
182​
183​ d->removeAt(idx.row());
184​}
185​
186​void JobsModel::expire(const QModelIndex &idx)
187​{
188​ if (!idx.isValid() || idx.row() >= d->m_jobViews.count()) {
189​ return;
190​ }
191​
192​ d->m_jobViews.at(idx.row())->setExpired(true);
193​}
194​
195​void JobsModel::suspend(const QModelIndex &idx)
196​{
197​ if (!idx.isValid() || idx.row() >= d->m_jobViews.count()) {
198​ return;
199​ }
200​
201​ emit d->m_jobViews.at(idx.row())->suspend();
202​}
davidedmundsonUnsubmitted
Done

emit is wrong

davidedmundson: emit is wrong
203​
204​void JobsModel::resume(const QModelIndex &idx)
205​{
206​ if (!idx.isValid() || idx.row() >= d->m_jobViews.count()) {
207​ return;
208​ }
209​
210​ emit d->m_jobViews.at(idx.row())->resume();
211​}
212​
213​void JobsModel::kill(const QModelIndex &idx)
214​{
215​ if (!idx.isValid() || idx.row() >= d->m_jobViews.count()) {
davidedmundsonUnsubmitted
Done

https://doc.qt.io/qt-5/qabstractitemmodel.html#checkIndex

davidedmundson: https://doc.qt.io/qt-5/qabstractitemmodel.html#checkIndex
216​ return;
217​ }
218​
219​ emit d->m_jobViews.at(idx.row())->kill();
220​}
221​
222​void JobsModel::clear(Notifications::ClearFlags flags)
223​{
224​ if (d->m_jobViews.isEmpty()) {
225​ return;
226​ }
227​
228​ for (int i = d->m_jobViews.count() - 1; i >= 0; --i) {
229​ Job *job = d->m_jobViews.at(i);
230​
231​ bool clear = (flags.testFlag(Notifications::ClearExpired) && job->expired());
232​
233​ // Compared to notifications, the number of jobs is typically small
234​ // so for simplicity we can just delete one item at a time
235​ if (clear) {
236​ d->removeAt(i);
237​ }
238​ }
239​}