1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
|
/*
* This file is part of the PolKit1-qt project
* Copyright (C) 2009 Radek Novacek <rnovacek@redhat.com>
*
* This library is free software; you can redistribute it and/or
* modify it under the terms of the GNU Library General Public
* License as published by the Free Software Foundation; either
* version 2 of the License, or (at your option) any later version.
*
* This library is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
* Library General Public License for more details.
*
* You should have received a copy of the GNU Library General Public License
* along with this library; see the file COPYING.LIB. If not, write to
* the Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor,
* Boston, MA 02110-1301, USA.
*/
#ifndef POLKITQT1_AGENT_SESSION_H
#define POLKITQT1_AGENT_SESSION_H
#include <QtCore/QObject>
#include "polkitqt1-identity.h"
typedef struct _GSimpleAsyncResult GSimpleAsyncResult;
typedef struct _PolkitAgentSession PolkitAgentSession;
namespace PolkitQt1
{
/**
* \namespace Agent Agent
*
* \brief Namespace wrapping Polkit-Qt Agent classes
*
* This namespace wraps all Polkit-Qt Agent classes.
*/
namespace Agent
{
/**
* \internal
* \brief Encapsulation of GSimpleAsyncResult to QObject class
*/
class POLKITQT1_EXPORT AsyncResult
{
public:
explicit AsyncResult(GSimpleAsyncResult *result);
virtual ~AsyncResult();
/**
* \brief Mark the action that is tied to this result as completed.
*/
void setCompleted();
/**
* \brief Sets an error for the asynchronous result.
* Method complete() must be called anyway.
*
* \param text text of the error message
*/
void setError(const QString &text);
private:
class Private;
Private * const d;
};
/**
* \class Session polkitqt1-agent-session.h Session
* \author Radek Novacek <rnovacek@redhat.com>
*
* This class is interface for interacting with native
* authentication system for obtaining authorizations.
*
*/
class POLKITQT1_EXPORT Session : public QObject
{
Q_OBJECT
Q_DISABLE_COPY(Session)
public:
/**
* Create a new authentication session.
*
* \param identity The identity to authenticate
* \param cookie The cookie obtained from the PolicyKit daemon
* \param result Result of the authentication action. Must be finished using complete() method.
* \param parent
*/
Session(const PolkitQt1::Identity& identity, const QString &cookie, AsyncResult *result = 0, QObject *parent = 0);
/**
* Create a new authentication session from PolkitAgentSession object
*
* \warning Use this only if you are completely aware of what are you doing!
*
* \param pkAgentSession PolkitAgentSession object
* \param parent
*/
explicit Session(PolkitAgentSession *pkAgentSession, QObject *parent = 0);
/**
* Destroy authentication session.
*/
~Session();
/**
* Initiate the authentication session.
*
* Use cancel() to cancel the session.
*/
void initiate();
/**
* Method for providing response to requests received via request signal.
*
* \param response Response from the user, typically a password
*/
void setResponse(const QString &response);
/**
* Cancel the authentication session.
* This will emit the completed() signal.
*/
void cancel();
/**
* Get AsyncResult that can be used to finish authentication operation
*
* \return AsyncResult object or NULL if it is not set
*/
AsyncResult *result();
Q_SIGNALS:
/**
* This signal will be emitted when the authentication
* polkitqt1-agent-session.has been completed or cancelled.
*
* \param gainedAuthorization \c True if authorization was successfully obtained.
*/
void completed(bool gainedAuthorization);
/**
* This signal will be emitted when user is requested to answer a question.
*
* \param request The request to show the user, e.g. "name: " or "password: ".
* \param echo \c True if the response to the request SHOULD be echoed on the screen,
* \c False if the response MUST NOT be echoed to the screen.
*/
void request(const QString &request, bool echo);
/**
* This signal will be emitted when there is information
* related to an error condition to be displayed to the user.
*
* \param text An error string to display to the user.
*/
void showError(const QString &text);
/**
* This signal will be emitted when there is information
* to be displayed to the user.
*
* \param text A string to be displayed to the user.
*/
void showInfo(const QString &text);
private:
class Private;
Private * const d;
};
}
}
#endif // SESSION_H
|
