Differential D21970 Diff 60291 src/util/externalcommand_polkitbackend.h

Changeset View

Standalone View

src/util/externalcommand_polkitbackend.h

This file was added.

1		/*************************************************************************
2		* Copyright (C) 2019 by Shubham <shubham.jangra@kdemail.net> *
3		* *
4		* This program is free software; you can redistribute it and/or *
5		* modify it under the terms of the GNU General Public License as *
6		* published by the Free Software Foundation; either version 3 of *
7		* the License, or (at your option) any later version. *
8		* *
9		* This program is distributed in the hope that it will be useful, *
10		* but WITHOUT ANY WARRANTY; without even the implied warranty of *
11		* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the *
12		* GNU General Public License for more details. *
13		* *
14		* You should have received a copy of the GNU General Public License *
15		* along with this program. If not, see <http://www.gnu.org/licenses/>.*
16		*************************************************************************/
17
18		#ifndef EXTERNALCOMMAND_POLKITBACKEND_H
19		#define EXTERNALCOMMAND_POLKITBACKEND_H
20
21		#include <QByteArray>
22		#include <QEventLoop>
23		#include <QHash>
24		#include <QString>
25		#include <QStringList>
26		#include <QVariant>
27		#include <QWidget>
28
29		#include <PolkitQt1/Authority>
30		#include <PolkitQt1/ActionDescription>
31		#include <PolkitQt1/Subject>
32
33		using namespace PolkitQt1;
34
35		namespace Auth
36		{
37
38		/** A Polkit Qt backend class for authorizing actions.
39
40		This class is used to authorize various functions if
41		they ask for privileged execution. It starts by verifying
42		the action under consideration if it is the one it is
43		saying and authorizes it based on the credentials
44		provided.
45
46		@author Shubham <shubham.jangra@kdemail.net>
47		*/
48		class PolkitQt1Backend : public QObject
49		{
50		Q_OBJECT
51		Q_DISABLE_COPY(PolkitQt1Backend)
	stikonasUnsubmitted Done We don't need `Q_PLUGIN_METADATA` in kpmcore. I think we'll only support PolkitQt1, so we won't be loading authentication backendslike KAuth. stikonas: We don't need `Q_PLUGIN_METADATA` in kpmcore. I think we'll only support PolkitQt1, so we…
52		Q_PLUGIN_METADATA(IID "org.kde.Polkit1Backend")
53
54		public:
55		/**
56		* \brief Constructor of PolkitQt1Backend class
57		*/
58		PolkitQt1Backend();
59
60		/**
61		* \brief Destructor of PolkitQt1Backend class
62		*/
63		~PolkitQt1Backend();
64
65		/**
66		* \brief Initializes the KDE Polkit Authentication Agent.
67		*
68		* \param action Action in question
69		* \param parent Parent widget
70		*
71		*/
72		void initPolkitAgent(const QString &action, QWidget *parent = nullptr);
73
74		/**
75		* \brief A function to check for the action's current status.
76		*
77		* \param action Action in question
78		* \param calledID The Application process ID of the action
79		*
80		* \return the result of action status ie. If action is Authorized or not.
81		*/
82		Authority::Result actionStatus(const QString &action, QByteArray &callerID);
83
84		/**
85		* \brief Function to get the current Application process ID
86		*
87		* \return Application process ID of the action
88		*/
89		QByteArray callerID() const;
90
91		/**
92		* \brief Tries to grant authorization to the \p action in question.
93		*
94		* \param action Action in question.
95		* \param callerID The Application process ID of the action
96		*
97		* \return \c true if authority authorizes the action, \c false Action is not authorized.
98		*
99		*/
100		bool isCallerAuthorized(const QString &action, QByteArray &callerID);
101
102		/**
103		* \brief Chexcks if the action already exists ie. the action has already been granted authorization
104		*
105		* \param action Action in question.
106		*
107		* \return \c true if action is already authorized, \c false if action is not previously authorized.
108		*
109		*/
110		bool actionAlreadyExists(const QString &action);
111
112		/**
113		* \return the code of last error which has occured.
114		*/
115		Authority::ErrorCode pollError() const;
116
117
118		// Dummy function for calling QTimer
119		void quit() const;
120
121		public Q_SLOTS:
122		void sendProgressStep(const int percent);
123		void sendProgressStep(const QVariantMap &step);
124
125		void checkForResultChanged();
126		void updateCachedActions(const PolkitQt1::ActionDescription::List &actions);
127
128		Q_SIGNALS:
129		void actionStarted(const QString &action);
130		void actionAuthorized(bool isAuthorized = false);
131		void actionCompleted(const QString &action);
132
133		private:
134		QHash<QString, Authority::Result> m_cachedResults;
135		QStringList m_existingActions;
136		bool m_flyingActions; // Already running actions
137		};
138
139		class PolkitEventLoop : public QEventLoop
140		{
141		Q_OBJECT
142
143		public:
144		PolkitEventLoop(QObject *parent = nullptr);
145		~PolkitEventLoop();
146
147		Authority::Result result() const;
148
149		public Q_SLOTS:
150		// Quits from the current Polkit Event loop
151		void requestQuit(const Authority::Result &result);
152
153		private:
154		Authority::Result m_result;
155		};
156
157		} // namespace Auth
158
159		#endif // EXTERNALCOMMAND_POLKITBACKEND_H