Differential D22889 Diff 63501 src/util/externalcommand.h

Changeset View

Standalone View

View Options

src/util/externalcommand.h

1/************************************************************************* 1​/*************************************************************************
2 * Copyright (C) 2008 by Volker Lanz <vl@fidra.de> * 2​ * Copyright (C) 2008 by Volker Lanz <vl@fidra.de> *
3 * Copyright (C) 2016-2018 by Andrius Štikonas <andrius@stikonas.eu> * 3​ * Copyright (C) 2016-2018 by Andrius Štikonas <andrius@stikonas.eu> *
4​ * Copyright (C) 2019 by Shubham <aryan100jangid@gmail.com> *
4 * * 5​ * *
5 * This program is free software; you can redistribute it and/or * 6​ * This program is free software; you can redistribute it and/or *
6 * modify it under the terms of the GNU General Public License as * 7​ * modify it under the terms of the GNU General Public License as *
7 * published by the Free Software Foundation; either version 3 of * 8​ * published by the Free Software Foundation; either version 3 of *
8 * the License, or (at your option) any later version. * 9​ * the License, or (at your option) any later version. *
9 * * 10​ * *
10 * This program is distributed in the hope that it will be useful, * 11​ * This program is distributed in the hope that it will be useful, *
11 * but WITHOUT ANY WARRANTY; without even the implied warranty of * 12​ * but WITHOUT ANY WARRANTY; without even the implied warranty of *
12 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the * 13​ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the *
13 * GNU General Public License for more details. * 14​ * GNU General Public License for more details. *
14 * * 15​ * *
15 * You should have received a copy of the GNU General Public License * 16​ * You should have received a copy of the GNU General Public License *
16 * along with this program. If not, see <http://www.gnu.org/licenses/>.* 17​ * along with this program. If not, see <http://www.gnu.org/licenses/>.*
17 *************************************************************************/ 18​ *************************************************************************/
18 19​
19#ifndef KPMCORE_EXTERNALCOMMAND_H 20​#ifndef KPMCORE_EXTERNALCOMMAND_H
20#define KPMCORE_EXTERNALCOMMAND_H 21​#define KPMCORE_EXTERNALCOMMAND_H
21 22​
22#include "util/libpartitionmanagerexport.h" 23​#include "util/libpartitionmanagerexport.h"
23 24​
24#include <QDebug> 25​#include <QDebug>
25#include <QProcess> 26​#include <QProcess>
26#include <QString> 27​#include <QString>
27#include <QStringList> 28​#include <QStringList>
28#include <QtGlobal> ​
29#include <QThread> 29​#include <QThread>
30#include <QVariant> 30​#include <QVariant>
31 31​
32#include <memory> 32​#include <memory>
33 33​
34namespace KAuth { class ExecuteJob; } 34​namespace Auth { class PolkitQt1Backend; }
35 35​
36class KJob; ​
37class Report; ​
38class CopySource; 36​class CopySource;
39class CopyTarget; 37​class CopyTarget;
38​class Report;
39​
40​class KJob;
40class QDBusInterface; 41​class QDBusInterface;
41 42​
42struct ExternalCommandPrivate; 43​struct ExternalCommandPrivate;
43 44​
44class DBusThread : public QThread 45​class DBusThread : public QThread
45{ 46​{
46 Q_OBJECT 47​ Q_OBJECT
47 // We register on DBus so the helper can monitor us and terminate if we 48​
48 // terminate. 49​private:
49 Q_CLASSINFO("D-Bus Interface", "org.kde.kpmcore.applicationinterface") ​
50 void run() override; 50​ void run() override;
51}; 51​};
52 52​
53/** An external command. 53​/** An external command.
54 54​
55 Runs an external command as a child process. 55​ Runs an external command as a child process.
56 56​
57 @author Volker Lanz <vl@fidra.de> 57​ @author Volker Lanz <vl@fidra.de>
58 @author Andrius Štikonas <andrius@stikonas.eu> 58​ @author Andrius Štikonas <andrius@stikonas.eu>
59*/ 59​*/
60class LIBKPMCORE_EXPORT ExternalCommand : public QObject 60​class LIBKPMCORE_EXPORT ExternalCommand : public QObject
61{ 61​{
62 Q_OBJECT 62​ Q_OBJECT
63​ // We register on DBus so the helper can monitor us and terminate if we terminate.
64​ Q_CLASSINFO("D-Bus Interface", "org.kde.kpmcore.applicationinterface")
63 Q_DISABLE_COPY(ExternalCommand) 65​ Q_DISABLE_COPY(ExternalCommand)
64 66​
65public: 67​public:
66 explicit ExternalCommand(const QString& cmd = QString(), const QStringList& args = QStringList(), const QProcess::ProcessChannelMode processChannelMode = QProcess::MergedChannels); 68​ explicit ExternalCommand(const QString& cmd = QString(), const QStringList& args = QStringList(), const QProcess::ProcessChannelMode processChannelMode = QProcess::MergedChannels);
67 explicit ExternalCommand(Report& report, const QString& cmd = QString(), const QStringList& args = QStringList(), const QProcess::ProcessChannelMode processChannelMode = QProcess::MergedChannels); 69​ explicit ExternalCommand(Report& report, const QString& cmd = QString(), const QStringList& args = QStringList(), const QProcess::ProcessChannelMode processChannelMode = QProcess::MergedChannels);
68 70​
69 ~ExternalCommand(); 71​ ~ExternalCommand();
70 72​
Show All 26 Lines73public:
97 /**< @return the command output */ 99​ /**< @return the command output */
98 const QString output() const; 100​ const QString output() const;
99 /**< @return the command output */ 101​ /**< @return the command output */
100 const QByteArray& rawOutput() const; 102​ const QByteArray& rawOutput() const;
101 103​
102 /**< @return pointer to the Report or nullptr */ 104​ /**< @return pointer to the Report or nullptr */
103 Report* report(); 105​ Report* report();
104 106​
105 void emitReport(const QVariantMap& report) { emit reportSignal(report); } 107​ /**< Dummy function for QTimer */
106 ​
107 /**< Dummy function for QTimer when needed. */ ​
108 void quit(); 108​ void quit();
109 109​
110 // KAuth ​
111 /**< start ExternalCommand Helper */ 110​ /**< start ExternalCommand Helper */
112 bool startHelper(); 111​ bool startHelper();
113 112​
114 /**< stop ExternalCommand Helper */ 113​ /**< stop ExternalCommand Helper */
115 static void stopHelper(); 114​ static void stopHelper();
116 115​
117 /**< Sets a parent widget for the authentication dialog. 116​ /**< Sets a parent widget for the authentication dialog.
118 * @param p parent widget 117​ * @param p parent widget
119 */ 118​ */
120 static void setParentWidget(QWidget *p) { 119​ static void setParentWidget(QWidget *p) {
121 parent = p; 120​ parent = p;
122 } 121​ }
123 122​
124Q_SIGNALS: 123​Q_SIGNALS:
125 void progress(int); 124​ void progress(int);
126 void reportSignal(const QVariantMap&); 125​ void reportSignal(const QVariantMap&);
127 126​
127​ // remove above signals
128​ void newData();
129​
128public Q_SLOTS: 130​public Q_SLOTS:
129 void emitProgress(KJob*, unsigned long percent) { emit progress(percent); } 131​ void emitProgress(KJob*, unsigned long percent) { emit progress(percent); }
132​ void emitReport(const QVariantMap& report) { emit reportSignal(report); }
133​
134​ Q_SCRIPTABLE void emitNewData(int percent);
135​ Q_SCRIPTABLE void emitNewData(QString message);
130 136​
131private: 137​private:
132 void setExitCode(int i); 138​ void setExitCode(int i);
133 void onReadOutput(); 139​// void onReadOutput();
134 140​
135private: 141​private:
136 std::unique_ptr<ExternalCommandPrivate> d; 142​ std::unique_ptr<ExternalCommandPrivate> d;
137 143​
138 // KAuth 144​ // Use Polkit Authorization backend for authorizing actions
139 static KAuth::ExecuteJob *m_job; 145​ static Auth::PolkitQt1Backend *m_authJob;
140 static bool helperStarted; 146​ static bool helperStarted;
141 static QWidget *parent; 147​ static QWidget *parent;
142}; 148​};
143 149​
144#endif 150​#endif // KPMCORE_EXTERNALCOMMAND_H