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
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
|
/*
* e-oauth2-support.c
*
* This library is free software: you can redistribute it and/or modify it
* under the terms of the GNU Lesser General Public License as published by
* the Free Software Foundation.
*
* 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 Lesser General Public License
* for more details.
*
* You should have received a copy of the GNU Lesser General Public License
* along with this library. If not, see <http://www.gnu.org/licenses/>.
*
*/
/**
* SECTION: e-oauth2-support
* @include: libebackend/libebackend.h
* @short_description: An interface for OAuth 2.0 support
*
* Support for OAuth 2.0 access tokens is typically provided through
* dynamically loaded modules. The module will provide an extension
* class which implements the #EOAuth2SupportInterface, which can be
* plugged into all appropriate #EServerSideSource instances through
* e_server_side_source_set_oauth2_support(). Incoming requests for
* access tokens are then forwarded to the extension providing OAuth
* 2.0 support through e_oauth2_support_get_access_token().
**/
#include "e-oauth2-support.h"
typedef struct _AsyncContext AsyncContext;
struct _AsyncContext {
ESource *source;
gchar *access_token;
gint expires_in;
};
G_DEFINE_INTERFACE (
EOAuth2Support,
e_oauth2_support,
G_TYPE_OBJECT)
static void
async_context_free (AsyncContext *async_context)
{
if (async_context->source != NULL)
g_object_unref (async_context->source);
g_free (async_context->access_token);
g_slice_free (AsyncContext, async_context);
}
/* Helper for oauth2_support_get_access_token() */
static void
oauth2_support_get_access_token_thread (GSimpleAsyncResult *simple,
GObject *object,
GCancellable *cancellable)
{
AsyncContext *async_context;
GError *error = NULL;
async_context = g_simple_async_result_get_op_res_gpointer (simple);
e_oauth2_support_get_access_token_sync (
E_OAUTH2_SUPPORT (simple),
async_context->source,
cancellable,
&async_context->access_token,
&async_context->expires_in,
&error);
if (error != NULL)
g_simple_async_result_take_error (simple, error);
}
static void
oauth2_support_get_access_token (EOAuth2Support *support,
ESource *source,
GCancellable *cancellable,
GAsyncReadyCallback callback,
gpointer user_data)
{
GSimpleAsyncResult *simple;
AsyncContext *async_context;
async_context = g_slice_new0 (AsyncContext);
async_context->source = g_object_ref (source);
simple = g_simple_async_result_new (
G_OBJECT (support), callback, user_data,
oauth2_support_get_access_token);
g_simple_async_result_set_check_cancellable (simple, cancellable);
g_simple_async_result_set_op_res_gpointer (
simple, async_context, (GDestroyNotify) async_context_free);
g_simple_async_result_run_in_thread (
simple, oauth2_support_get_access_token_thread,
G_PRIORITY_DEFAULT, cancellable);
g_object_unref (simple);
}
static gboolean
oauth2_support_get_access_token_finish (EOAuth2Support *support,
GAsyncResult *result,
gchar **out_access_token,
gint *out_expires_in,
GError **error)
{
GSimpleAsyncResult *simple;
AsyncContext *async_context;
g_return_val_if_fail (
g_simple_async_result_is_valid (
result, G_OBJECT (support),
oauth2_support_get_access_token), FALSE);
simple = G_SIMPLE_ASYNC_RESULT (result);
async_context = g_simple_async_result_get_op_res_gpointer (simple);
if (g_simple_async_result_propagate_error (simple, error))
return FALSE;
g_return_val_if_fail (async_context->access_token != NULL, FALSE);
if (out_access_token != NULL) {
*out_access_token = async_context->access_token;
async_context->access_token = NULL;
}
if (out_expires_in != NULL)
*out_expires_in = async_context->expires_in;
return TRUE;
}
static void
e_oauth2_support_default_init (EOAuth2SupportInterface *iface)
{
iface->get_access_token =
oauth2_support_get_access_token;
iface->get_access_token_finish =
oauth2_support_get_access_token_finish;
}
/**
* e_oauth2_support_get_access_token_sync:
* @support: an #EOAuthSupport
* @source: an #ESource
* @cancellable: optional #GCancellable object, or %NULL
* @out_access_token: return location for the access token, or %NULL
* @out_expires_in: return location for the token expiry, or %NULL
* @error: return location for a #GError, or %NULL
*
* Obtains the OAuth 2.0 access token for @source along with its expiry
* in seconds from the current time (or 0 if unknown).
*
* Free the returned access token with g_free() when finished with it.
* If an error occurs, the function will set @error and return %FALSE.
*
* Returns: %TRUE on success, %FALSE on failure
*
* Since: 3.8
**/
gboolean
e_oauth2_support_get_access_token_sync (EOAuth2Support *support,
ESource *source,
GCancellable *cancellable,
gchar **out_access_token,
gint *out_expires_in,
GError **error)
{
EOAuth2SupportInterface *iface;
g_return_val_if_fail (E_IS_OAUTH2_SUPPORT (support), FALSE);
g_return_val_if_fail (E_IS_SOURCE (source), FALSE);
iface = E_OAUTH2_SUPPORT_GET_INTERFACE (support);
g_return_val_if_fail (iface->get_access_token_sync != NULL, FALSE);
return iface->get_access_token_sync (
support, source, cancellable,
out_access_token, out_expires_in, error);
}
/**
* e_oauth2_support_get_access_token:
* @support: an #EOAuth2Support
* @source: an #ESource
* @cancellable: optional #GCancellable object, or %NULL
* @callback: a #GAsyncReadyCallback to call when the request is satisfied
* @user_data: data to pass to the callback function
*
* Asynchronously obtains the OAuth 2.0 access token for @source along
* with its expiry in seconds from the current time (or 0 if unknown).
*
* When the operation is finished, @callback will be called. You can then
* call e_oauth2_support_get_access_token_finish() to get the result of the
* operation.
*
* Since: 3.8
**/
void
e_oauth2_support_get_access_token (EOAuth2Support *support,
ESource *source,
GCancellable *cancellable,
GAsyncReadyCallback callback,
gpointer user_data)
{
EOAuth2SupportInterface *iface;
g_return_if_fail (E_IS_OAUTH2_SUPPORT (support));
g_return_if_fail (E_IS_SOURCE (source));
iface = E_OAUTH2_SUPPORT_GET_INTERFACE (support);
g_return_if_fail (iface->get_access_token != NULL);
return iface->get_access_token (
support, source, cancellable, callback, user_data);
}
/**
* e_oauth2_support_get_access_token_finish:
* @support: an #EOAuth2Support
* @result: a #GAsyncResult
* @out_access_token: return location for the access token, or %NULL
* @out_expires_in: return location for the token expiry, or %NULL
* @error: return location for a #GError, or %NULL
*
* Finishes the operation started with e_oauth2_support_get_access_token().
*
* Free the returned access token with g_free() when finished with it.
* If an error occurred, the function will set @error and return %FALSE.
*
* Returns: %TRUE on success, %FALSE on failure
*
* Since: 3.8
**/
gboolean
e_oauth2_support_get_access_token_finish (EOAuth2Support *support,
GAsyncResult *result,
gchar **out_access_token,
gint *out_expires_in,
GError **error)
{
EOAuth2SupportInterface *iface;
g_return_val_if_fail (E_IS_OAUTH2_SUPPORT (support), FALSE);
g_return_val_if_fail (G_IS_ASYNC_RESULT (result), FALSE);
iface = E_OAUTH2_SUPPORT_GET_INTERFACE (support);
g_return_val_if_fail (iface->get_access_token_finish != NULL, FALSE);
return iface->get_access_token_finish (
support, result, out_access_token, out_expires_in, error);
}
|
