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
|
/* -*- Mode: C; indent-tabs-mode: t; c-basic-offset: 8; tab-width: 8 -*- */
/*
* GData Client
* Copyright (C) Philip Withnall 2008-2009 <philip@tecnocode.co.uk>
*
* GData Client 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; either
* version 2.1 of the License, or (at your option) any later version.
*
* GData Client 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 GData Client. If not, see <http://www.gnu.org/licenses/>.
*/
#ifndef GDATA_SERVICE_H
#define GDATA_SERVICE_H
#include <glib.h>
#include <glib-object.h>
#include <libsoup/soup.h>
#include <libxml/parser.h>
#include <gdata/gdata-feed.h>
G_BEGIN_DECLS
/**
* GDataServiceError:
* @GDATA_SERVICE_ERROR_UNAVAILABLE: The service is unavailable due to maintainence or other reasons
* @GDATA_SERVICE_ERROR_PROTOCOL_ERROR: The client or server unexpectedly strayed from the protocol (fatal error)
* @GDATA_SERVICE_ERROR_WITH_QUERY: Generic error when querying for entries
* @GDATA_SERVICE_ERROR_ENTRY_ALREADY_INSERTED: An entry has already been inserted, and cannot be re-inserted
* @GDATA_SERVICE_ERROR_WITH_INSERTION: Generic error when inserting an entry
* @GDATA_SERVICE_ERROR_AUTHENTICATION_REQUIRED: The user attempted to do something which required authentication, and they weren't authenticated
* @GDATA_SERVICE_ERROR_WITH_UPDATE: Generic error when updating an entry
* @GDATA_SERVICE_ERROR_WITH_DELETION: Generic error when deleting an entry
* @GDATA_SERVICE_ERROR_NOT_FOUND: A requested resource (feed or entry) was not found on the server
* @GDATA_SERVICE_ERROR_CONFLICT: There was a conflict when updating an entry on the server; the server-side copy was modified inbetween downloading
* and uploading the modified entry
* @GDATA_SERVICE_ERROR_FORBIDDEN: Generic error for a forbidden action (not due to having insufficient permissions)
* @GDATA_SERVICE_ERROR_WITH_DOWNLOAD: Generic error when downloading a file (rather than querying for an entry).
* @GDATA_SERVICE_ERROR_WITH_UPLOAD: Generic error when uploading a file (either inserting or updating an entry).
*
* Error codes for #GDataService operations.
**/
typedef enum {
GDATA_SERVICE_ERROR_UNAVAILABLE = 1,
GDATA_SERVICE_ERROR_PROTOCOL_ERROR,
GDATA_SERVICE_ERROR_WITH_QUERY,
GDATA_SERVICE_ERROR_ENTRY_ALREADY_INSERTED,
GDATA_SERVICE_ERROR_WITH_INSERTION,
GDATA_SERVICE_ERROR_AUTHENTICATION_REQUIRED,
GDATA_SERVICE_ERROR_WITH_UPDATE,
GDATA_SERVICE_ERROR_WITH_DELETION,
GDATA_SERVICE_ERROR_NOT_FOUND,
GDATA_SERVICE_ERROR_CONFLICT,
GDATA_SERVICE_ERROR_FORBIDDEN,
GDATA_SERVICE_ERROR_WITH_DOWNLOAD,
GDATA_SERVICE_ERROR_WITH_UPLOAD
} GDataServiceError;
/**
* GDataAuthenticationError:
* @GDATA_AUTHENTICATION_ERROR_BAD_AUTHENTICATION: The login request used a username or password that is not recognized.
* @GDATA_AUTHENTICATION_ERROR_NOT_VERIFIED: The account email address has not been verified. The user will need to access their Google account
* directly to resolve the issue before logging in using a non-Google application.
* @GDATA_AUTHENTICATION_ERROR_TERMS_NOT_AGREED: The user has not agreed to terms. The user will need to access their Google account directly to
* resolve the issue before logging in using a non-Google application.
* @GDATA_AUTHENTICATION_ERROR_CAPTCHA_REQUIRED: A CAPTCHA is required. (A response with this error code will also contain an image URL and a
* CAPTCHA token.)
* @GDATA_AUTHENTICATION_ERROR_ACCOUNT_DELETED: The user account has been deleted.
* @GDATA_AUTHENTICATION_ERROR_ACCOUNT_DISABLED: The user account has been disabled.
* @GDATA_AUTHENTICATION_ERROR_SERVICE_DISABLED: The user's access to the specified service has been disabled. (The user account may still be valid.)
*
* Error codes for #GDataDataService authentication operations. See http://code.google.com/apis/accounts/docs/AuthForInstalledApps.html#Errors for
* the official reference.
**/
typedef enum {
GDATA_AUTHENTICATION_ERROR_BAD_AUTHENTICATION = 1,
GDATA_AUTHENTICATION_ERROR_NOT_VERIFIED,
GDATA_AUTHENTICATION_ERROR_TERMS_NOT_AGREED,
GDATA_AUTHENTICATION_ERROR_CAPTCHA_REQUIRED,
GDATA_AUTHENTICATION_ERROR_ACCOUNT_DELETED,
GDATA_AUTHENTICATION_ERROR_ACCOUNT_DISABLED,
GDATA_AUTHENTICATION_ERROR_SERVICE_DISABLED
} GDataAuthenticationError;
/**
* GDataQueryProgressCallback:
* @entry: a new #GDataEntry
* @entry_key: the key of the entry (zero-based index of its position in the feed)
* @entry_count: the total number of entries in the feed
* @user_data: user data passed to the callback
*
* Callback function called for each #GDataEntry parsed in a #GDataFeed when loading the results of a query.
*
* It is called in the main thread, so there is no guarantee on the order in which the callbacks are executed,
* or whether they will be called in a timely manner. It is, however, guaranteed that they will all be called before
* the #GAsyncReadyCallback which signals the completion of the query is called.
**/
typedef void (*GDataQueryProgressCallback) (GDataEntry *entry, guint entry_key, guint entry_count, gpointer user_data);
#define GDATA_TYPE_SERVICE (gdata_service_get_type ())
#define GDATA_SERVICE(o) (G_TYPE_CHECK_INSTANCE_CAST ((o), GDATA_TYPE_SERVICE, GDataService))
#define GDATA_SERVICE_CLASS(k) (G_TYPE_CHECK_CLASS_CAST((k), GDATA_TYPE_SERVICE, GDataServiceClass))
#define GDATA_IS_SERVICE(o) (G_TYPE_CHECK_INSTANCE_TYPE ((o), GDATA_TYPE_SERVICE))
#define GDATA_IS_SERVICE_CLASS(k) (G_TYPE_CHECK_CLASS_TYPE ((k), GDATA_TYPE_SERVICE))
#define GDATA_SERVICE_GET_CLASS(o) (G_TYPE_INSTANCE_GET_CLASS ((o), GDATA_TYPE_SERVICE, GDataServiceClass))
#define GDATA_SERVICE_ERROR gdata_service_error_quark ()
#define GDATA_AUTHENTICATION_ERROR gdata_authentication_error_quark ()
typedef struct _GDataServicePrivate GDataServicePrivate;
/**
* GDataService:
*
* All the fields in the #GDataService structure are private and should never be accessed directly.
**/
typedef struct {
GObject parent;
GDataServicePrivate *priv;
} GDataService;
/**
* GDataServiceClass:
* @parent: the parent class
* @service_name: the name of the service (for subclasses) as given in the service's GData API documentation
* @authentication_uri: the authentication URI (for subclasses) if different from the Google ClientLogin default
* @api_version: the version of the GData API used by the service (typically %2)
* @feed_type: the #GType of the feed class (subclass of #GDataFeed) to use for query results from this service
* @parse_authentication_response: a function to parse the response from the online service to an authentication request as
* issued by gdata_service_authenticate(). It should return %TRUE if authentication was successful, and %FALSE if there was
* an error.
* @append_query_headers: a function to allow subclasses to append their own headers to queries before they are submitted
* to the online service
* @parse_error_response: a function to parse error responses to queries from the online service. It should set the error
* from the status, reason phrase and response body it is passed.
*
* The class structure for the #GDataService type.
**/
typedef struct {
GObjectClass parent;
const gchar *service_name;
const gchar *authentication_uri;
const gchar *api_version;
GType feed_type;
gboolean (*parse_authentication_response) (GDataService *self, guint status, const gchar *response_body, gint length, GError **error);
void (*append_query_headers) (GDataService *self, SoupMessage *message);
void (*parse_error_response) (GDataService *self, GDataServiceError error_type, guint status, const gchar *reason_phrase,
const gchar *response_body, gint length, GError **error);
} GDataServiceClass;
GType gdata_service_get_type (void) G_GNUC_CONST;
GQuark gdata_service_error_quark (void) G_GNUC_CONST;
GQuark gdata_authentication_error_quark (void) G_GNUC_CONST;
gboolean gdata_service_authenticate (GDataService *self, const gchar *username, const gchar *password, GCancellable *cancellable, GError **error);
void gdata_service_authenticate_async (GDataService *self, const gchar *username, const gchar *password,
GCancellable *cancellable, GAsyncReadyCallback callback, gpointer user_data);
gboolean gdata_service_authenticate_finish (GDataService *self, GAsyncResult *async_result, GError **error);
#include <gdata/gdata-query.h>
GDataFeed *gdata_service_query (GDataService *self, const gchar *feed_uri, GDataQuery *query, GType entry_type,
GCancellable *cancellable,
GDataQueryProgressCallback progress_callback, gpointer progress_user_data, GError **error) G_GNUC_WARN_UNUSED_RESULT;
void gdata_service_query_async (GDataService *self, const gchar *feed_uri, GDataQuery *query, GType entry_type,
GCancellable *cancellable,
GDataQueryProgressCallback progress_callback, gpointer progress_user_data,
GAsyncReadyCallback callback, gpointer user_data);
GDataFeed *gdata_service_query_finish (GDataService *self, GAsyncResult *async_result, GError **error) G_GNUC_WARN_UNUSED_RESULT;
GDataEntry *gdata_service_insert_entry (GDataService *self, const gchar *upload_uri, GDataEntry *entry,
GCancellable *cancellable, GError **error) G_GNUC_WARN_UNUSED_RESULT;
void gdata_service_insert_entry_async (GDataService *self, const gchar *upload_uri, GDataEntry *entry, GCancellable *cancellable,
GAsyncReadyCallback callback, gpointer user_data);
GDataEntry *gdata_service_insert_entry_finish (GDataService *self, GAsyncResult *async_result, GError **error) G_GNUC_WARN_UNUSED_RESULT;
GDataEntry *gdata_service_update_entry (GDataService *self, GDataEntry *entry, GCancellable *cancellable, GError **error) G_GNUC_WARN_UNUSED_RESULT;
void gdata_service_update_entry_async (GDataService *self, GDataEntry *entry, GCancellable *cancellable,
GAsyncReadyCallback callback, gpointer user_data);
GDataEntry *gdata_service_update_entry_finish (GDataService *self, GAsyncResult *async_result, GError **error) G_GNUC_WARN_UNUSED_RESULT;
gboolean gdata_service_delete_entry (GDataService *self, GDataEntry *entry, GCancellable *cancellable, GError **error);
void gdata_service_delete_entry_async (GDataService *self, GDataEntry *entry, GCancellable *cancellable,
GAsyncReadyCallback callback, gpointer user_data);
gboolean gdata_service_delete_entry_finish (GDataService *self, GAsyncResult *async_result, GError **error);
SoupURI *gdata_service_get_proxy_uri (GDataService *self);
void gdata_service_set_proxy_uri (GDataService *self, SoupURI *proxy_uri);
gboolean gdata_service_is_authenticated (GDataService *self);
const gchar *gdata_service_get_client_id (GDataService *self);
const gchar *gdata_service_get_username (GDataService *self);
const gchar *gdata_service_get_password (GDataService *self);
G_END_DECLS
#endif /* !GDATA_SERVICE_H */
|
