Differential D20265 Diff 56056 libnotificationmanager/job_p.cpp

Changeset View

Standalone View

View Options

libnotificationmanager/job_p.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 "job_p.h"
22​#include "job.h"
23​
24​#include "debug.h"
25​
26​#include <QDebug>
27​#include <QDBusConnection>
28​
29​#include <KFilePlacesModel>
30​#include <KService>
31​#include <KLocalizedString>
32​
33​#include "notifications.h"
34​
35​#include "jobviewv2adaptor.h"
36​#include "jobviewv3adaptor.h"
37​
38​#include <QDebug>
39​
40​using namespace NotificationManager;
41​
42​JobPrivate::JobPrivate(uint id, QObject *parent)
43​ : QObject(parent)
44​ , m_id(id)
45​ , m_placesModel(createPlacesModel())
46​{
47​ m_objectPath.setPath(QStringLiteral("/org/kde/notificationmanager/jobs/JobView_%1").arg(id));
48​
49​ // TODO also v1? it's identical to V2 except it doesn't have setError method so supporting it should be easy
50​ new JobViewV2Adaptor(this);
51​ new JobViewV3Adaptor(this);
52​
53​ QDBusConnection::sessionBus().registerObject(m_objectPath.path(), this);
54​}
55​
56​JobPrivate::~JobPrivate() = default;
57​
58​QDBusObjectPath JobPrivate::objectPath() const
59​{
60​ return m_objectPath;
61​}
62​
63​QSharedPointer<KFilePlacesModel> JobPrivate::createPlacesModel()
64​{
65​ static QWeakPointer<KFilePlacesModel> s_instance;
66​ if (!s_instance) {
67​ QSharedPointer<KFilePlacesModel> ptr(new KFilePlacesModel());
68​ s_instance = ptr.toWeakRef();
69​ return ptr;
70​ }
71​ return s_instance.toStrongRef();
72​}
73​
74​// Tries to return a more user-friendly displayed destination
75​// - if it is a place, show the name, e.g. "Downloads"
76​// - if it is inside home, abbreviate that to tilde ~/foo
77​// - otherwise print URL (without password)
78​QString JobPrivate::prettyDestUrl() const
79​{
80​ QUrl url = m_destUrl;
81​ // In case of a single file and no destUrl, try using the second label (most likely "Destination")...
82​ if (!url.isValid() && m_totalFiles == 1) {
83​ url = QUrl::fromUserInput(m_descriptionValue2, QString(), QUrl::AssumeLocalFile).adjusted(QUrl::RemoveFilename);
84​ }
85​
86​ if (!url.isValid()) {
87​ return QString();
88​ }
89​
90​ if (!m_placesModel) {
91​ m_placesModel = createPlacesModel();
92​ }
93​
94​ // If we copy into a "place", show its pretty name instead of a URL/path
95​ for (int row = 0; row < m_placesModel->rowCount(); ++row) {
96​ const QModelIndex idx = m_placesModel->index(row, 0);
97​ if (m_placesModel->isHidden(idx)) {
98​ continue;
99​ }
100​
101​ if (m_placesModel->url(idx).matches(url, QUrl::StripTrailingSlash)) {
102​ return m_placesModel->text(idx);
103​ }
104​ }
105​
106​ if (url.isLocalFile()) {
107​ QString destUrlString = url.toLocalFile();
108​
109​ const QString homePath = QDir::homePath();
110​ if (destUrlString.startsWith(homePath)) {
111​ destUrlString = QStringLiteral("~") + destUrlString.mid(homePath.length());
112​ }
113​
114​ return destUrlString;
115​ }
116​
117​ return url.toDisplayString(); // strips password
118​}
119​
120​void JobPrivate::updateHasDetails()
121​{
122​ const bool hasDetails = m_totalBytes > 0
123​ || m_totalFiles > 0
124​ || m_totalDirectories > 0
125​ || m_processedBytes > 0
126​ || m_processedFiles > 0
127​ || m_processedDirectories > 0
128​ || !m_descriptionLabel1.isEmpty()
129​ || !m_descriptionLabel2.isEmpty()
130​ || !m_descriptionValue1.isEmpty()
131​ || !m_descriptionValue2.isEmpty()
132​ || m_speed > 0;
133​
134​ if (m_hasDetails != hasDetails) {
135​ m_hasDetails = hasDetails;
136​ emit static_cast<Job *>(parent())->hasDetailsChanged();
137​ }
138​}
139​
140​QString JobPrivate::text() const
141​{
142​ if (!m_errorText.isEmpty()) {
143​ return m_errorText;
144​ }
145​
146​ const QString currentFileName = descriptionUrl().fileName();
147​ const QString destUrlString = prettyDestUrl();
148​
149​ if (m_totalFiles == 0) {
150​ if (!destUrlString.isEmpty()) {
151​ if (m_processedFiles > 0) {
152​ return i18ncp("Copying n files to location", "%1 file to %2", "%1 files to %2",
153​ m_processedFiles, destUrlString);
154​ }
155​ return i18nc("Copying unknown amount of files to location", "to %1", destUrlString);
156​ } else if (m_processedFiles > 0) {
157​ return i18ncp("Copying n files", "%1 file", "%1 files", m_processedFiles);
158​ }
159​ } else if (m_totalFiles == 1 && !currentFileName.isEmpty()) {
160​ if (!destUrlString.isEmpty()) {
161​ return i18nc("Copying file to location", "%1 to %2", currentFileName, destUrlString);
162​ }
163​
164​ return currentFileName;
165​ } else if (m_totalFiles > 1) {
166​ if (!destUrlString.isEmpty()) {
167​ if (m_processedFiles > 0 && m_processedFiles <= m_totalFiles) {
168​ return i18ncp("Copying n of m files to locaton", "%2 of %1 file to %3", "%2 of %1 files to %3",
169​ m_totalFiles, m_processedFiles, destUrlString);
170​ }
171​ return i18ncp("Copying n files to location", "%1 file to %2", "%1 files to %2",
172​ m_processedFiles > 0 ? m_processedFiles : m_totalFiles, destUrlString);
173​ }
174​
175​ if (m_processedFiles > 0 && m_processedFiles <= m_totalFiles) {
176​ return i18ncp("Copying n of m files", "%2 of %1 file", "%2 of %1 files",
177​ m_totalFiles, m_processedFiles);
178​ }
179​
180​ return i18ncp("Copying n files", "%1 file", "%1 files", m_processedFiles > 0 ? m_processedFiles : m_totalFiles);
181​ }
182​
183​ qCInfo(NOTIFICATIONMANAGER) << "Failed to generate job text for job with following properties:";
184​ qCInfo(NOTIFICATIONMANAGER) << " processedFiles =" << m_processedFiles << ", totalFiles =" << m_totalFiles
185​ << ", current file name =" << currentFileName << ", destination url string =" << destUrlString;
186​ qCInfo(NOTIFICATIONMANAGER) << "label1 =" << m_descriptionLabel1 << ", value1 =" << m_descriptionValue1
187​ << ", label2 =" << m_descriptionLabel2 << ", value2 =" << m_descriptionValue2;
188​
189​ return QString();
190​}
191​
192​QUrl JobPrivate::descriptionUrl() const
193​{
194​ QUrl url = QUrl::fromUserInput(m_descriptionValue2, QString(), QUrl::AssumeLocalFile);
195​ if (!url.isValid()) {
196​ url = QUrl::fromUserInput(m_descriptionValue1, QString(), QUrl::AssumeLocalFile);
197​ }
198​ return url;
199​}
200​
201​void JobPrivate::finish()
202​{
203​ // Unregister the dbus service since the client is done with it
204​ QDBusConnection::sessionBus().unregisterObject(m_objectPath.path());
205​
206​ // When user canceled transfer, remove it without notice
207​ if (m_error == 1) { // KIO::ERR_USER_CANCELED
208​ emit closed();
209​ return;
210​ }
211​
212​ Job *job = static_cast<Job *>(parent());
213​ // update timestamp
214​ job->resetUpdated();
215​ // when it was hidden in history, bring it up again
216​ job->setDismissed(false);
217​}
218​
219​// JobViewV2
220​void JobPrivate::terminate(const QString &errorMessage)
221​{
222​ Job *job = static_cast<Job *>(parent());
223​ job->setErrorText(errorMessage);
224​ job->setState(Notifications::JobStateStopped);
225​ finish();
226​}
227​
228​void JobPrivate::setSuspended(bool suspended)
229​{
230​ Job *job = static_cast<Job *>(parent());
231​ if (suspended) {
232​ job->setState(Notifications::JobStateSuspended);
233​ } else {
234​ job->setState(Notifications::JobStateRunning);
235​ }
236​}
237​
238​void JobPrivate::setTotalAmount(quint64 amount, const QString &unit)
239​{
240​ if (unit == QLatin1String("bytes")) {
241​ updateField(amount, m_totalBytes, &Job::totalBytesChanged);
242​ } else if (unit == QLatin1String("files")) {
243​ updateField(amount, m_totalFiles, &Job::totalFilesChanged);
244​ } else if (unit == QLatin1String("dirs")) {
245​ updateField(amount, m_totalDirectories, &Job::totalDirectoriesChanged);
246​ }
247​ updateHasDetails();
248​}
249​
250​void JobPrivate::setProcessedAmount(quint64 amount, const QString &unit)
251​{
252​ if (unit == QLatin1String("bytes")) {
253​ updateField(amount, m_processedBytes, &Job::processedBytesChanged);
254​ } else if (unit == QLatin1String("files")) {
255​ updateField(amount, m_processedFiles, &Job::processedFilesChanged);
256​ } else if (unit == QLatin1String("dirs")) {
257​ updateField(amount, m_processedDirectories, &Job::processedDirectoriesChanged);
258​ }
259​ updateHasDetails();
260​}
261​
262​void JobPrivate::setPercent(uint percent)
263​{
264​ const int percentage = static_cast<int>(percent);
265​ if (m_percentage != percentage) {
266​ m_percentage = percentage;
267​ emit static_cast<Job *>(parent())->percentageChanged(percentage);
268​ }
269​}
270​
271​void JobPrivate::setSpeed(quint64 bytesPerSecond)
272​{
273​ updateField(bytesPerSecond, m_speed, &Job::speedChanged);
274​ updateHasDetails();
275​}
276​
277​void JobPrivate::setInfoMessage(const QString &infoMessage)
278​{
279​ updateField(infoMessage, m_summary, &Job::summaryChanged);
280​}
281​
282​bool JobPrivate::setDescriptionField(uint number, const QString &name, const QString &value)
283​{
284​ if (number == 0) {
285​ updateField(name, m_descriptionLabel1, &Job::descriptionLabel1Changed);
286​ updateField(value, m_descriptionValue1, &Job::descriptionValue1Changed);
287​ } else if (number == 1) {
288​ updateField(name, m_descriptionLabel2, &Job::descriptionLabel2Changed);
289​ updateField(value, m_descriptionValue2, &Job::descriptionValue2Changed);
290​ }
291​ updateHasDetails();
davidedmundsonUnsubmitted
Done

descriptionUrlChanged

davidedmundson: descriptionUrlChanged
292​
293​ return false;
294​}
295​
296​void JobPrivate::clearDescriptionField(uint number)
297​{
298​ setDescriptionField(number, QString(), QString());
299​}
300​
301​void JobPrivate::setDestUrl(const QDBusVariant &urlVariant)
302​{
303​ const QUrl destUrl = QUrl(urlVariant.variant().toUrl().adjusted(QUrl::StripTrailingSlash)); // urgh
304​ updateField(destUrl, m_destUrl, &Job::destUrlChanged);
305​}
306​
307​void JobPrivate::setError(uint errorCode)
308​{
309​ static_cast<Job *>(parent())->setError(errorCode);
310​}
311​
312​// JobViewV3
313​void JobPrivate::terminate(uint errorCode, const QString &errorMessage, const QVariantMap &hints)
314​{
315​ Q_UNUSED(hints) // reserved for future extension
316​
317​ Job *job = static_cast<Job *>(parent());
318​ job->setError(errorCode);
319​ job->setErrorText(errorMessage);
320​ job->setState(Notifications::JobStateStopped);
321​ finish();
322​}
323​
324​void JobPrivate::update(const QVariantMap &properties)
325​{
326​ // TODO
327​ sendErrorReply(QDBusError::NotSupported, QStringLiteral("JobViewV3 update is not yet implemented."));
328​ Q_UNUSED(properties)
329​}