Differential D21970 Diff 61305 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 <QVariant>
26		#include <QWidget>
27
28		#include <PolkitQt1/Authority>
29		#include <PolkitQt1/Subject>
30
31		using namespace PolkitQt1;
32
33		namespace Auth
34		{
35
36		/** A Polkit Qt backend class for authorizing actions.
37
38		This class is used to authorize various actions if they
39		ask for privileged execution. It starts by verifying the
40		action under consideration if it is the one it is
41		saying and authorizes it based on the credentials
42		provided.
43
44		@author Shubham <shubham.jangra@kdemail.net>
45		*/
46		class PolkitQt1Backend : public QObject
47		{
48		Q_OBJECT
49		Q_DISABLE_COPY(PolkitQt1Backend)
50
51		public:
	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		/**
53		* \brief Constructor of PolkitQt1Backend class
54		*/
55		PolkitQt1Backend();
56
57		/**
58		* \brief Destructor of PolkitQt1Backend class
59		*/
60		~PolkitQt1Backend();
61
62		/**
63		* \brief Initializes the KDE Polkit Authentication Agent.
64		*
65		* \param action Action in question
66		* \param parent Parent widget
67		*
68		*/
69		void initPolkitAgent(const QString &action, QWidget *parent = nullptr) const;
70
71		/**
72		* \brief A function to check for the action's current status.
73		*
74		* \param action Action in question
75		* \param calledID The Application process ID of the action
76		*
77		* \return the result of action status ie. If action is Authorized or not.
78		*/
79		Authority::Result actionStatus(const QString &action, const QByteArray &callerID) const;
80
81		/**
82		* \brief Function to get the current Application process ID
83		*
84		* \return Application process ID of the action
85		*/
86		QByteArray callerID() const;
87
88		/**
89		* \brief Tries to authorize to the \p action in question.
90		*
91		* \param action Action in question.
92		* \param callerID The Application process ID of the action
93		*
94		* \return \c true if authority authorizes the action successfully, \c false Action is not authorized.
95		*
96		*/
97		bool authorizeAction(const QString &action, const QByteArray &callerID);
98
99
100		/**
101		* \brief Stops the running \p action from executing.
102		*
103		* \param action Action in question.
104		* \param callerID The Application process ID of the action
105		*
106		* \return \c true if action is successfully stopped, \c false Action is not stopped.
107		*
108		*/
109		bool stopAction(const QString &action, const QByteArray &callerID);
110
111		// Dummy function for calling QTimer
112		void quit() const;
113
114		public Q_SLOTS:
115		void authStatusChanged();
116		void updateCachedActions(const PolkitQt1::ActionDescription::List &actions);
117
118		Q_SIGNALS:
119		void actionAuthorized(bool isAuthorized = false);
120
121		private:
122		QHash<QString, Authority::Result> m_cachedResults;
123		bool m_flyingActions; // Already running actions
124		};
125
126		class PolkitEventLoop : public QEventLoop
127		{
128		Q_OBJECT
129
130		public:
131		PolkitEventLoop(QObject *parent = nullptr);
132		~PolkitEventLoop();
133
134		Authority::Result result() const;
135
136		public Q_SLOTS:
137		// Quits from the current Polkit Event loop
138		void requestQuit(const Authority::Result &result);
139
140		private:
141		Authority::Result m_result;
142		};
143
144		} // namespace Auth
145
146		#endif // EXTERNALCOMMAND_POLKITBACKEND_H