diff options
author | Günther Wagner <info@gunibert.de> | 2022-01-12 19:15:20 +0000 |
---|---|---|
committer | Günther Wagner <info@gunibert.de> | 2022-01-12 19:15:20 +0000 |
commit | 85bd00adfa6e06d3426ce7c9007e68e62f51be14 (patch) | |
tree | e21e069019d003978fba09e127c979fbd0b7ebb2 /rest | |
parent | 6db3436246b94063b09f3957ee8cdccc8fb71dc3 (diff) | |
parent | 025e53c313850501500048cbc3c44d80a4f8cbec (diff) | |
download | librest-85bd00adfa6e06d3426ce7c9007e68e62f51be14.tar.gz |
Modernized the codebase
See merge request GNOME/librest!11
Diffstat (limited to 'rest')
-rw-r--r-- | rest/meson.build | 7 | ||||
-rw-r--r-- | rest/oauth-proxy-call.c | 49 | ||||
-rw-r--r-- | rest/oauth-proxy-private.h | 45 | ||||
-rw-r--r-- | rest/oauth-proxy.c | 119 | ||||
-rw-r--r-- | rest/oauth-proxy.h | 151 | ||||
-rw-r--r-- | rest/rest-oauth2-proxy-call.c | 3 | ||||
-rw-r--r-- | rest/rest-param.c | 2 | ||||
-rw-r--r-- | rest/rest-params.c | 196 | ||||
-rw-r--r-- | rest/rest-params.h | 52 | ||||
-rw-r--r-- | rest/rest-proxy-call.c | 2 | ||||
-rw-r--r-- | rest/rest-proxy.c | 69 | ||||
-rw-r--r-- | rest/rest-proxy.h | 61 | ||||
-rw-r--r-- | rest/rest-xml-node.h | 34 | ||||
-rw-r--r-- | rest/rest-xml-parser.h | 19 |
14 files changed, 439 insertions, 370 deletions
diff --git a/rest/meson.build b/rest/meson.build index a22742e..58dfbd8 100644 --- a/rest/meson.build +++ b/rest/meson.build @@ -87,12 +87,11 @@ if get_option('introspection') endforeach librest_gir = gnome.generate_gir(librest_lib, - sources: [ librest_headers, librest_sources, librest_enums[1] ], - dependencies: librest_deps, + sources: librest_sources + librest_headers + librest_enums, + nsversion: librest_api_version, namespace: 'Rest', - identifier_prefix: 'Rest', symbol_prefix: 'rest', - nsversion: librest_api_version, + identifier_prefix: 'Rest', includes: [ 'GObject-2.0', 'Gio-2.0', 'Soup-@0@'.format(libsoup_api_version) ], extra_args: librest_gir_extra_args, install: true, diff --git a/rest/oauth-proxy-call.c b/rest/oauth-proxy-call.c index b292cad..560e928 100644 --- a/rest/oauth-proxy-call.c +++ b/rest/oauth-proxy-call.c @@ -24,7 +24,7 @@ #include <libsoup/soup.h> #include <rest/rest-proxy-call.h> #include "oauth-proxy-call.h" -#include "oauth-proxy-private.h" +#include "oauth-proxy.h" #include "rest-proxy-call-private.h" #include "sha1.h" @@ -33,14 +33,14 @@ G_DEFINE_TYPE (OAuthProxyCall, oauth_proxy_call, REST_TYPE_PROXY_CALL) #define OAUTH_ENCODE_STRING(x_) (x_ ? g_uri_escape_string( (x_), NULL, TRUE) : g_strdup ("")) static char * -sign_plaintext (OAuthProxyPrivate *priv) +sign_plaintext (OAuthProxy *proxy) { char *cs; char *ts; char *rv; - cs = OAUTH_ENCODE_STRING (priv->consumer_secret); - ts = OAUTH_ENCODE_STRING (priv->token_secret); + cs = OAUTH_ENCODE_STRING (oauth_proxy_get_consumer_secret (proxy)); + ts = OAUTH_ENCODE_STRING (oauth_proxy_get_token_secret (proxy)); rv = g_strconcat (cs, "&", ts, NULL); g_free (cs); @@ -117,7 +117,6 @@ merge_params (GHashTable *hash, RestParams *params) static char * sign_hmac (OAuthProxy *proxy, RestProxyCall *call, GHashTable *oauth_params) { - OAuthProxyPrivate *priv; const char *url_str; char *key, *signature, *ep, *eep; const char *content_type; @@ -127,15 +126,14 @@ sign_hmac (OAuthProxy *proxy, RestProxyCall *call, GHashTable *oauth_params) RestParam *param; gboolean encode_query_params = TRUE; - priv = PROXY_GET_PRIVATE (proxy); url_str = rest_proxy_call_get_url (call); text = g_string_new (NULL); g_string_append (text, rest_proxy_call_get_method (call)); g_string_append_c (text, '&'); - if (priv->oauth_echo) { - g_string_append_uri_escaped (text, priv->service_url, NULL, FALSE); - } else if (priv->signature_host != NULL) { + if (oauth_proxy_is_echo (proxy)) + g_string_append_uri_escaped (text, oauth_proxy_get_service_url (proxy), NULL, FALSE); + else if (oauth_proxy_get_signature_host (proxy) != NULL) { GUri *url = g_uri_parse (url_str, G_URI_FLAGS_ENCODED, NULL); GUri *new_url; gchar *signing_url; @@ -143,7 +141,7 @@ sign_hmac (OAuthProxy *proxy, RestProxyCall *call, GHashTable *oauth_params) new_url = g_uri_build (g_uri_get_flags (url), g_uri_get_scheme (url), g_uri_get_userinfo (url), - priv->signature_host, + oauth_proxy_get_signature_host (proxy), g_uri_get_port (url), g_uri_get_path (url), g_uri_get_query (url), @@ -178,7 +176,7 @@ sign_hmac (OAuthProxy *proxy, RestProxyCall *call, GHashTable *oauth_params) /* Merge the OAuth parameters with the query parameters */ all_params = g_hash_table_new (g_str_hash, g_str_equal); merge_hashes (all_params, oauth_params); - if (encode_query_params && !priv->oauth_echo) { + if (encode_query_params && !oauth_proxy_is_echo (proxy)) { merge_params (all_params, rest_proxy_call_get_params (call)); } @@ -191,7 +189,7 @@ sign_hmac (OAuthProxy *proxy, RestProxyCall *call, GHashTable *oauth_params) g_hash_table_destroy (all_params); /* PLAINTEXT signature value is the HMAC-SHA1 key value */ - key = sign_plaintext (priv); + key = sign_plaintext (proxy); signature = hmac_sha1 (key, text->str); @@ -263,12 +261,10 @@ static gboolean _prepare (RestProxyCall *call, GError **error) { OAuthProxy *proxy = NULL; - OAuthProxyPrivate *priv; char *s; GHashTable *oauth_params; g_object_get (call, "proxy", &proxy, NULL); - priv = PROXY_GET_PRIVATE (proxy); /* We have to make this hash free the strings and thus duplicate when we put * them in since when we call call steal_oauth_params that has to duplicate @@ -288,15 +284,15 @@ _prepare (RestProxyCall *call, GError **error) g_hash_table_insert (oauth_params, g_strdup ("oauth_nonce"), s); g_hash_table_insert (oauth_params, g_strdup ("oauth_consumer_key"), - g_strdup (priv->consumer_key)); + g_strdup (oauth_proxy_get_consumer_key (proxy))); - if (priv->token) - g_hash_table_insert (oauth_params, g_strdup ("oauth_token"), g_strdup (priv->token)); + if (oauth_proxy_get_token (proxy)) + g_hash_table_insert (oauth_params, g_strdup ("oauth_token"), g_strdup (oauth_proxy_get_token (proxy))); - switch (priv->method) { + switch (oauth_proxy_get_sign_method (proxy)) { case PLAINTEXT: g_hash_table_insert (oauth_params, g_strdup ("oauth_signature_method"), g_strdup ("PLAINTEXT")); - s = sign_plaintext (priv); + s = sign_plaintext (proxy); break; case HMAC_SHA1: g_hash_table_insert (oauth_params, g_strdup ("oauth_signature_method"), g_strdup ("HMAC-SHA1")); @@ -306,9 +302,9 @@ _prepare (RestProxyCall *call, GError **error) g_hash_table_insert (oauth_params, g_strdup ("oauth_signature"), s); s = make_authorized_header (oauth_params); - if (priv->oauth_echo) { + if (oauth_proxy_is_echo (proxy)) { rest_proxy_call_add_header (call, "X-Verify-Credentials-Authorization", s); - rest_proxy_call_add_param (call, "X-Auth-Service-Provider", priv->service_url); + rest_proxy_call_add_param (call, "X-Auth-Service-Provider", oauth_proxy_get_service_url (proxy)); } else { rest_proxy_call_add_header (call, "Authorization", s); } @@ -336,7 +332,6 @@ oauth_proxy_call_init (OAuthProxyCall *self) void oauth_proxy_call_parse_token_response (OAuthProxyCall *call) { - OAuthProxyPrivate *priv; GHashTable *form; OAuthProxy *proxy; g_autofree gchar *formstr = NULL; @@ -346,19 +341,15 @@ oauth_proxy_call_parse_token_response (OAuthProxyCall *call) g_return_if_fail (OAUTH_IS_PROXY_CALL (call)); g_object_get (call, "proxy", &proxy, NULL); - priv = PROXY_GET_PRIVATE (proxy); g_object_unref (proxy); - g_assert (priv); formstr = g_strndup (rest_proxy_call_get_payload (REST_PROXY_CALL (call)), rest_proxy_call_get_payload_length (REST_PROXY_CALL (call))); form = soup_form_decode (formstr); - g_free (priv->token); - g_free (priv->token_secret); - priv->token = g_strdup (g_hash_table_lookup (form, "oauth_token")); - priv->token_secret = g_strdup (g_hash_table_lookup (form, "oauth_token_secret")); + oauth_proxy_set_token (proxy, g_hash_table_lookup (form, "oauth_token")); + oauth_proxy_set_token_secret (proxy, g_hash_table_lookup (form, "oauth_token_secret")); /* This header should only exist for request_token replies, but its easier just to always check it */ - priv->oauth_10a = g_hash_table_lookup (form, "oauth_callback_confirmed") != NULL; + oauth_proxy_set_oauth10a (proxy, g_hash_table_lookup (form, "oauth_callback_confirmed") != NULL); g_hash_table_destroy (form); } diff --git a/rest/oauth-proxy-private.h b/rest/oauth-proxy-private.h deleted file mode 100644 index 2d178a5..0000000 --- a/rest/oauth-proxy-private.h +++ /dev/null @@ -1,45 +0,0 @@ -/* - * librest - RESTful web services access - * Copyright (c) 2008, 2009, Intel Corporation. - * - * Authors: Rob Bradford <rob@linux.intel.com> - * Ross Burton <ross@linux.intel.com> - * - * This program is free software; you can redistribute it and/or modify it - * under the terms and conditions of the GNU Lesser General Public License, - * version 2.1, as published by the Free Software Foundation. - * - * This program is distributed in the hope 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 program; if not, write to the Free Software Foundation, - * Inc., 51 Franklin St - Fifth Floor, Boston, MA 02110-1301 USA. - * - */ - -#include "oauth-proxy.h" - -#define PROXY_GET_PRIVATE(o) \ - (G_TYPE_INSTANCE_GET_PRIVATE ((o), OAUTH_TYPE_PROXY, OAuthProxyPrivate)) - -typedef struct { - /* Application "consumer" keys */ - char *consumer_key; - char *consumer_secret; - /* Authorisation "user" tokens */ - char *token; - char *token_secret; - /* How we're signing */ - OAuthSignatureMethod method; - /* OAuth 1.0a */ - gboolean oauth_10a; - char *verifier; - /* OAuth Echo */ - gboolean oauth_echo; - char *service_url; - /* URL to use for signatures */ - char *signature_host; -} OAuthProxyPrivate; diff --git a/rest/oauth-proxy.c b/rest/oauth-proxy.c index f8c0053..d81c0d7 100644 --- a/rest/oauth-proxy.c +++ b/rest/oauth-proxy.c @@ -23,10 +23,32 @@ #include <rest/rest-proxy.h> #include <libsoup/soup.h> #include "oauth-proxy.h" -#include "oauth-proxy-private.h" #include "oauth-proxy-call.h" -G_DEFINE_TYPE (OAuthProxy, oauth_proxy, REST_TYPE_PROXY) +typedef struct { + /* Application "consumer" keys */ + char *consumer_key; + char *consumer_secret; + /* Authorisation "user" tokens */ + char *token; + char *token_secret; + /* How we're signing */ + OAuthSignatureMethod method; + /* OAuth 1.0a */ + gboolean oauth_10a; + char *verifier; + /* OAuth Echo */ + gboolean oauth_echo; + char *service_url; + /* URL to use for signatures */ + char *signature_host; +} OAuthProxyPrivate; + +struct _OAuthProxy { + RestProxy parent_instance; +}; + +G_DEFINE_TYPE_WITH_PRIVATE (OAuthProxy, oauth_proxy, REST_TYPE_PROXY) enum { PROP_0, @@ -54,7 +76,8 @@ static void oauth_proxy_get_property (GObject *object, guint property_id, GValue *value, GParamSpec *pspec) { - OAuthProxyPrivate *priv = PROXY_GET_PRIVATE (object); + OAuthProxy *self = OAUTH_PROXY (object); + OAuthProxyPrivate *priv = oauth_proxy_get_instance_private (self); switch (property_id) { case PROP_CONSUMER_KEY: @@ -84,7 +107,8 @@ static void oauth_proxy_set_property (GObject *object, guint property_id, const GValue *value, GParamSpec *pspec) { - OAuthProxyPrivate *priv = PROXY_GET_PRIVATE (object); + OAuthProxy *self = OAUTH_PROXY (object); + OAuthProxyPrivate *priv = oauth_proxy_get_instance_private (self); switch (property_id) { case PROP_CONSUMER_KEY: @@ -123,7 +147,8 @@ oauth_proxy_set_property (GObject *object, guint property_id, static void oauth_proxy_finalize (GObject *object) { - OAuthProxyPrivate *priv = PROXY_GET_PRIVATE (object); + OAuthProxy *self = OAUTH_PROXY (object); + OAuthProxyPrivate *priv = oauth_proxy_get_instance_private (self); g_free (priv->consumer_key); g_free (priv->consumer_secret); @@ -146,8 +171,6 @@ oauth_proxy_class_init (OAuthProxyClass *klass) RestProxyClass *proxy_class = REST_PROXY_CLASS (klass); GParamSpec *pspec; - g_type_class_add_private (klass, sizeof (OAuthProxyPrivate)); - object_class->get_property = oauth_proxy_get_property; object_class->set_property = oauth_proxy_set_property; object_class->finalize = oauth_proxy_finalize; @@ -201,7 +224,8 @@ oauth_proxy_class_init (OAuthProxyClass *klass) static void oauth_proxy_init (OAuthProxy *self) { - PROXY_GET_PRIVATE (self)->method = HMAC_SHA1; + OAuthProxyPrivate *priv = oauth_proxy_get_instance_private (self); + priv->method = HMAC_SHA1; } /** @@ -534,6 +558,22 @@ oauth_proxy_access_token_finish (OAuthProxy *proxy, return g_task_propagate_boolean (G_TASK (result), error); } +const char * +oauth_proxy_get_consumer_key (OAuthProxy *self) +{ + OAuthProxyPrivate *priv = oauth_proxy_get_instance_private (self); + + return priv->consumer_key; +} + +const char * +oauth_proxy_get_consumer_secret (OAuthProxy *self) +{ + OAuthProxyPrivate *priv = oauth_proxy_get_instance_private (self); + + return priv->consumer_secret; +} + /** * oauth_proxy_get_token: * @proxy: an #OAuthProxy @@ -546,7 +586,8 @@ oauth_proxy_access_token_finish (OAuthProxy *proxy, const char * oauth_proxy_get_token (OAuthProxy *proxy) { - OAuthProxyPrivate *priv = PROXY_GET_PRIVATE (proxy); + OAuthProxyPrivate *priv = oauth_proxy_get_instance_private (proxy); + return priv->token; } @@ -560,10 +601,9 @@ oauth_proxy_get_token (OAuthProxy *proxy) void oauth_proxy_set_token (OAuthProxy *proxy, const char *token) { - OAuthProxyPrivate *priv; + OAuthProxyPrivate *priv = oauth_proxy_get_instance_private (proxy); g_return_if_fail (OAUTH_IS_PROXY (proxy)); - priv = PROXY_GET_PRIVATE (proxy); g_free (priv->token); priv->token = g_strdup (token); @@ -581,7 +621,8 @@ oauth_proxy_set_token (OAuthProxy *proxy, const char *token) const char * oauth_proxy_get_token_secret (OAuthProxy *proxy) { - OAuthProxyPrivate *priv = PROXY_GET_PRIVATE (proxy); + OAuthProxyPrivate *priv = oauth_proxy_get_instance_private (proxy); + return priv->token_secret; } @@ -595,10 +636,9 @@ oauth_proxy_get_token_secret (OAuthProxy *proxy) void oauth_proxy_set_token_secret (OAuthProxy *proxy, const char *token_secret) { - OAuthProxyPrivate *priv; + OAuthProxyPrivate *priv = oauth_proxy_get_instance_private (proxy); g_return_if_fail (OAUTH_IS_PROXY (proxy)); - priv = PROXY_GET_PRIVATE (proxy); if (priv->token_secret) g_free (priv->token_secret); @@ -619,9 +659,22 @@ oauth_proxy_set_token_secret (OAuthProxy *proxy, const char *token_secret) gboolean oauth_proxy_is_oauth10a (OAuthProxy *proxy) { + OAuthProxyPrivate *priv = oauth_proxy_get_instance_private (proxy); + g_return_val_if_fail (OAUTH_IS_PROXY (proxy), FALSE); - return PROXY_GET_PRIVATE (proxy)->oauth_10a; + return priv->oauth_10a; +} + +void +oauth_proxy_set_oauth10a (OAuthProxy *self, + gboolean oauth10a) +{ + OAuthProxyPrivate *priv = oauth_proxy_get_instance_private (self); + + g_return_if_fail (OAUTH_IS_PROXY (self)); + + priv->oauth_10a = oauth10a; } /** @@ -636,10 +689,9 @@ oauth_proxy_is_oauth10a (OAuthProxy *proxy) const char * oauth_proxy_get_signature_host (OAuthProxy *proxy) { - OAuthProxyPrivate *priv; + OAuthProxyPrivate *priv = oauth_proxy_get_instance_private (proxy); g_return_val_if_fail (OAUTH_IS_PROXY (proxy), NULL); - priv = PROXY_GET_PRIVATE (proxy); return priv->signature_host; } @@ -655,10 +707,9 @@ void oauth_proxy_set_signature_host (OAuthProxy *proxy, const char *signature_host) { - OAuthProxyPrivate *priv; + OAuthProxyPrivate *priv = oauth_proxy_get_instance_private (proxy); g_return_if_fail (OAUTH_IS_PROXY (proxy)); - priv = PROXY_GET_PRIVATE (proxy); g_free (priv->signature_host); @@ -686,14 +737,13 @@ oauth_proxy_new_echo_proxy (OAuthProxy *proxy, gboolean binding_required) { OAuthProxy *echo_proxy; - OAuthProxyPrivate *priv, *echo_priv; + OAuthProxyPrivate *echo_priv; + OAuthProxyPrivate *priv = oauth_proxy_get_instance_private (proxy); g_return_val_if_fail (OAUTH_IS_PROXY (proxy), NULL); g_return_val_if_fail (service_url, NULL); g_return_val_if_fail (url_format, NULL); - priv = PROXY_GET_PRIVATE (proxy); - echo_proxy = g_object_new (OAUTH_TYPE_PROXY, "url-format", url_format, "binding-required", binding_required, @@ -703,7 +753,7 @@ oauth_proxy_new_echo_proxy (OAuthProxy *proxy, "token", priv->token, "token-secret", priv->token_secret, NULL); - echo_priv = PROXY_GET_PRIVATE (echo_proxy); + echo_priv = oauth_proxy_get_instance_private (echo_proxy); echo_priv->oauth_echo = TRUE; echo_priv->service_url = g_strdup (service_url); @@ -728,3 +778,26 @@ oauth_signature_method_get_type (void) return enum_type_id; } +gboolean +oauth_proxy_is_echo (OAuthProxy *self) +{ + OAuthProxyPrivate *priv = oauth_proxy_get_instance_private (self); + + return priv->oauth_echo; +} + +const char * +oauth_proxy_get_service_url (OAuthProxy *self) +{ + OAuthProxyPrivate *priv = oauth_proxy_get_instance_private (self); + + return priv->service_url; +} + +OAuthSignatureMethod +oauth_proxy_get_sign_method (OAuthProxy *self) +{ + OAuthProxyPrivate *priv = oauth_proxy_get_instance_private (self); + + return priv->method; +} diff --git a/rest/oauth-proxy.h b/rest/oauth-proxy.h index fa1a89e..2616a34 100644 --- a/rest/oauth-proxy.h +++ b/rest/oauth-proxy.h @@ -28,37 +28,7 @@ G_BEGIN_DECLS #define OAUTH_TYPE_PROXY oauth_proxy_get_type() - -#define OAUTH_PROXY(obj) \ - (G_TYPE_CHECK_INSTANCE_CAST ((obj), OAUTH_TYPE_PROXY, OAuthProxy)) - -#define OAUTH_PROXY_CLASS(klass) \ - (G_TYPE_CHECK_CLASS_CAST ((klass), OAUTH_TYPE_PROXY, OAuthProxyClass)) - -#define OAUTH_IS_PROXY(obj) \ - (G_TYPE_CHECK_INSTANCE_TYPE ((obj), OAUTH_TYPE_PROXY)) - -#define OAUTH_IS_PROXY_CLASS(klass) \ - (G_TYPE_CHECK_CLASS_TYPE ((klass), OAUTH_TYPE_PROXY)) - -#define OAUTH_PROXY_GET_CLASS(obj) \ - (G_TYPE_INSTANCE_GET_CLASS ((obj), OAUTH_TYPE_PROXY, OAuthProxyClass)) - -/** - * OAuthProxy: - * - * #OAuthProxy has no publicly available members. - */ -typedef struct { - RestProxy parent; -} OAuthProxy; - -typedef struct { - RestProxyClass parent_class; - /*< private >*/ - /* padding for future expansion */ - gpointer _padding_dummy[8]; -} OAuthProxyClass; +G_DECLARE_FINAL_TYPE (OAuthProxy, oauth_proxy, OAUTH, PROXY, RestProxy) GType oauth_signature_method_get_type (void) G_GNUC_CONST; #define OAUTH_TYPE_SIGNATURE_METHOD (oauth_signature_method_get_type()) @@ -77,68 +47,63 @@ typedef enum { HMAC_SHA1 } OAuthSignatureMethod; -GType oauth_proxy_get_type (void); - -RestProxy* oauth_proxy_new (const char *consumer_key, - const char *consumer_secret, - const gchar *url_format, - gboolean binding_required); - -RestProxy* oauth_proxy_new_with_token (const char *consumer_key, - const char *consumer_secret, - const char *token, - const char *token_secret, - const gchar *url_format, - gboolean binding_required); - -gboolean oauth_proxy_request_token (OAuthProxy *proxy, - const char *function, - const char *callback_uri, - GError **error); - -void oauth_proxy_request_token_async (OAuthProxy *proxy, - const char *function, - const char *callback_uri, - GCancellable *cancellable, - GAsyncReadyCallback callback, - gpointer user_data); -gboolean oauth_proxy_request_token_finish (OAuthProxy *proxy, - GAsyncResult *result, - GError **error); - -gboolean oauth_proxy_is_oauth10a (OAuthProxy *proxy); - -gboolean oauth_proxy_access_token (OAuthProxy *proxy, - const char *function, - const char *verifier, - GError **error); - -void oauth_proxy_access_token_async (OAuthProxy *proxy, - const char *function, - const char *verifier, - GCancellable *cancellable, - GAsyncReadyCallback callback, - gpointer user_data); -gboolean oauth_proxy_access_token_finish (OAuthProxy *proxy, - GAsyncResult *result, - GError **error); - -const char * oauth_proxy_get_token (OAuthProxy *proxy); - -void oauth_proxy_set_token (OAuthProxy *proxy, const char *token); - -const char * oauth_proxy_get_token_secret (OAuthProxy *proxy); - -void oauth_proxy_set_token_secret (OAuthProxy *proxy, const char *token_secret); -const char * oauth_proxy_get_signature_host (OAuthProxy *proxy); - -void oauth_proxy_set_signature_host (OAuthProxy *proxy, - const char *signature_host); - -RestProxy *oauth_proxy_new_echo_proxy (OAuthProxy *proxy, - const char *service_url, - const gchar *url_format, - gboolean binding_required); +RestProxy *oauth_proxy_new (const char *consumer_key, + const char *consumer_secret, + const gchar *url_format, + gboolean binding_required); +RestProxy *oauth_proxy_new_with_token (const char *consumer_key, + const char *consumer_secret, + const char *token, + const char *token_secret, + const gchar *url_format, + gboolean binding_required); +gboolean oauth_proxy_request_token (OAuthProxy *proxy, + const char *function, + const char *callback_uri, + GError **error); +void oauth_proxy_request_token_async (OAuthProxy *proxy, + const char *function, + const char *callback_uri, + GCancellable *cancellable, + GAsyncReadyCallback callback, + gpointer user_data); +gboolean oauth_proxy_request_token_finish (OAuthProxy *proxy, + GAsyncResult *result, + GError **error); +gboolean oauth_proxy_is_oauth10a (OAuthProxy *proxy); +void oauth_proxy_set_oauth10a (OAuthProxy *proxy, + gboolean oauth10a); +gboolean oauth_proxy_access_token (OAuthProxy *proxy, + const char *function, + const char *verifier, + GError **error); +void oauth_proxy_access_token_async (OAuthProxy *proxy, + const char *function, + const char *verifier, + GCancellable *cancellable, + GAsyncReadyCallback callback, + gpointer user_data); +gboolean oauth_proxy_access_token_finish (OAuthProxy *proxy, + GAsyncResult *result, + GError **error); +const char *oauth_proxy_get_consumer_key (OAuthProxy *proxy); +const char *oauth_proxy_get_consumer_secret (OAuthProxy *proxy); +const char *oauth_proxy_get_token (OAuthProxy *proxy); +void oauth_proxy_set_token (OAuthProxy *proxy, + const char *token); +const char *oauth_proxy_get_token_secret (OAuthProxy *proxy); +void oauth_proxy_set_token_secret (OAuthProxy *proxy, + const char *token_secret); +const char *oauth_proxy_get_signature_host (OAuthProxy *proxy); +void oauth_proxy_set_signature_host (OAuthProxy *proxy, + const char *signature_host); +RestProxy *oauth_proxy_new_echo_proxy (OAuthProxy *proxy, + const char *service_url, + const gchar *url_format, + gboolean binding_required); +gboolean oauth_proxy_is_echo (OAuthProxy *proxy); +const char *oauth_proxy_get_service_url (OAuthProxy *proxy); +OAuthSignatureMethod oauth_proxy_get_sign_method (OAuthProxy *proxy); G_END_DECLS diff --git a/rest/rest-oauth2-proxy-call.c b/rest/rest-oauth2-proxy-call.c index cbea6f5..88840b3 100644 --- a/rest/rest-oauth2-proxy-call.c +++ b/rest/rest-oauth2-proxy-call.c @@ -1,6 +1,6 @@ /* rest-oauth2-proxy-call.c * - * Copyright 2021 Günther Wagner <info@gunibert.de> + * Copyright 2021-2022 Günther Wagner <info@gunibert.de> * * This program is free software; you can redistribute it and/or modify it * under the terms and conditions of the GNU Lesser General Public License, @@ -24,7 +24,6 @@ static gboolean rest_oauth2_proxy_call_prepare (RestProxyCall *call, GError **error) { - RestOAuth2ProxyCall *self = (RestOAuth2ProxyCall *)call; RestOAuth2Proxy *proxy = NULL; g_autoptr(GDateTime) now = NULL; GDateTime *expiration_date = NULL; diff --git a/rest/rest-param.c b/rest/rest-param.c index 8ad105f..1f6f73c 100644 --- a/rest/rest-param.c +++ b/rest/rest-param.c @@ -89,7 +89,7 @@ rest_param_new_full (const char *name, param = g_slice_new0 (RestParam); if (use == REST_MEMORY_COPY) { - data = g_memdup (data, length); + data = g_memdup2 (data, length); use = REST_MEMORY_TAKE; } diff --git a/rest/rest-params.c b/rest/rest-params.c index f246cc2..f2ac286 100644 --- a/rest/rest-params.c +++ b/rest/rest-params.c @@ -30,18 +30,7 @@ * @see_also: #RestParam, #RestProxyCall. */ -/* - * RestParams is an alias for GHashTable achieved by opaque types in the public - * headers and casting internally. This has several limitations, mainly - * supporting multiple parameters with the same name and preserving the ordering - * of parameters. - * - * These are not requirements for the bulk of the web services, but this - * limitation does mean librest can't be used for a few web services. - * - * TODO: this should be a list to support multiple parameters with the same - * name. - */ +G_DEFINE_BOXED_TYPE (RestParams, rest_params, rest_params_ref, rest_params_unref) /** * rest_params_new: @@ -53,11 +42,13 @@ RestParams * rest_params_new (void) { - /* The key is a string that is owned by the RestParam, so we don't need to - explicitly free it on removal. */ - return (RestParams *) - g_hash_table_new_full (g_str_hash, g_str_equal, - NULL, (GDestroyNotify)rest_param_unref); + RestParams *self; + + self = g_slice_new0 (RestParams); + self->ref_count = 1; + self->params = NULL; + + return self; } /** @@ -67,13 +58,73 @@ rest_params_new (void) * Destroy the #RestParams and the #RestParam objects that it contains. **/ void -rest_params_free (RestParams *params) +rest_params_free (RestParams *self) { - GHashTable *hash = (GHashTable *)params; + g_assert (self); + g_assert_cmpint (self->ref_count, ==, 0); - g_return_if_fail (params); + g_list_free_full (g_steal_pointer (&self->params), (GDestroyNotify) rest_param_unref); + + g_slice_free (RestParams, self); +} + +/** + * rest_params_copy: + * @self: a #RestParams + * + * Makes a deep copy of a #RestParams. + * + * Returns: (transfer full): A newly created #RestParams with the same + * contents as @self + */ +RestParams * +rest_params_copy (RestParams *self) +{ + RestParams *copy; + + g_return_val_if_fail (self, NULL); + g_return_val_if_fail (self->ref_count, NULL); + + copy = rest_params_new (); + copy->params = g_list_copy_deep (self->params, (GCopyFunc) rest_param_ref, NULL); + + return copy; +} + +/** + * rest_params_ref: + * @self: A #RestParams + * + * Increments the reference count of @self by one. + * + * Returns: (transfer full): @self + */ +RestParams * +rest_params_ref (RestParams *self) +{ + g_return_val_if_fail (self, NULL); + g_return_val_if_fail (self->ref_count, NULL); + + g_atomic_int_inc (&self->ref_count); - g_hash_table_destroy (hash); + return self; +} + +/** + * rest_params_unref: + * @self: A #RestParams + * + * Decrements the reference count of @self by one, freeing the structure when + * the reference count reaches zero. + */ +void +rest_params_unref (RestParams *self) +{ + g_return_if_fail (self); + g_return_if_fail (self->ref_count); + + if (g_atomic_int_dec_and_test (&self->ref_count)) + rest_params_free (self); } /** @@ -84,14 +135,25 @@ rest_params_free (RestParams *params) * Add @param to @params. **/ void -rest_params_add (RestParams *params, RestParam *param) +rest_params_add (RestParams *self, + RestParam *param) { - GHashTable *hash = (GHashTable *)params; - - g_return_if_fail (params); + g_return_if_fail (self); g_return_if_fail (param); - g_hash_table_replace (hash, (gpointer)rest_param_get_name (param), param); + self->params = g_list_append (self->params, param); +} + +static gint +rest_params_find (gconstpointer self, + gconstpointer name) +{ + const RestParam *e = self; + const char *n = name; + const char *n2 = rest_param_get_name ((RestParam *)e); + + if (g_strcmp0 (n2, n) == 0) return 0; + return -1; } /** @@ -105,14 +167,13 @@ rest_params_add (RestParams *params, RestParam *param) * doesn't exist **/ RestParam * -rest_params_get (RestParams *params, const char *name) +rest_params_get (RestParams *self, + const char *name) { - GHashTable *hash = (GHashTable *)params; - - g_return_val_if_fail (params, NULL); + g_return_val_if_fail (self, NULL); g_return_val_if_fail (name, NULL); - return g_hash_table_lookup (hash, name); + return g_list_find_custom (self->params, name, rest_params_find)->data; } /** @@ -123,14 +184,16 @@ rest_params_get (RestParams *params, const char *name) * Remove the #RestParam called @name. **/ void -rest_params_remove (RestParams *params, const char *name) +rest_params_remove (RestParams *self, + const char *name) { - GHashTable *hash = (GHashTable *)params; + GList *elem = NULL; - g_return_if_fail (params); + g_return_if_fail (self); g_return_if_fail (name); - g_hash_table_remove (hash, name); + elem = g_list_find_custom (self->params, name, rest_params_find); + self->params = g_list_remove (self->params, elem->data); } /** @@ -143,27 +206,22 @@ rest_params_remove (RestParams *params, const char *name) * Returns: %TRUE if all of the parameters are simple strings, %FALSE otherwise. **/ gboolean -rest_params_are_strings (RestParams *params) +rest_params_are_strings (RestParams *self) { - GHashTable *hash = (GHashTable *)params; - GHashTableIter iter; - RestParam *param; - - g_return_val_if_fail (params, FALSE); + g_return_val_if_fail (self, FALSE); - g_hash_table_iter_init (&iter, hash); - while (g_hash_table_iter_next (&iter, NULL, (gpointer)¶m)) { - if (!rest_param_is_string (param)) - return FALSE; - } + for (GList *cur = self->params; cur; cur = g_list_next (cur)) + { + if (!rest_param_is_string (cur->data)) + return FALSE; + } return TRUE; - } /** * rest_params_as_string_hash_table: - * @params: a valid #RestParams + * @self: a valid #RestParams * * Create a new #GHashTable which contains the name and value of all string * (content type of text/plain) parameters. @@ -174,23 +232,19 @@ rest_params_are_strings (RestParams *params) * Returns: (element-type utf8 Rest.Param) (transfer container): a new #GHashTable. **/ GHashTable * -rest_params_as_string_hash_table (RestParams *params) +rest_params_as_string_hash_table (RestParams *self) { - GHashTable *hash, *strings; - GHashTableIter iter; - const char *name = NULL; - RestParam *param = NULL; + GHashTable *strings; - g_return_val_if_fail (params, NULL); + g_return_val_if_fail (self, NULL); - hash = (GHashTable *)params; strings = g_hash_table_new (g_str_hash, g_str_equal); - g_hash_table_iter_init (&iter, hash); - while (g_hash_table_iter_next (&iter, (gpointer)&name, (gpointer)¶m)) { - if (rest_param_is_string (param)) - g_hash_table_insert (strings, (gpointer)name, (gpointer)rest_param_get_content (param)); - } + for (GList *cur = self->params; cur; cur = g_list_next (cur)) + { + if (rest_param_is_string (cur->data)) + g_hash_table_insert (strings, (gpointer)rest_param_get_name (cur->data), (gpointer)rest_param_get_content (cur->data)); + } return strings; } @@ -214,12 +268,14 @@ rest_params_as_string_hash_table (RestParams *params) * ]| **/ void -rest_params_iter_init (RestParamsIter *iter, RestParams *params) +rest_params_iter_init (RestParamsIter *iter, + RestParams *params) { g_return_if_fail (iter); g_return_if_fail (params); - g_hash_table_iter_init ((GHashTableIter *)iter, (GHashTable *)params); + iter->params = params; + iter->position = -1; } /** @@ -235,9 +291,21 @@ rest_params_iter_init (RestParamsIter *iter, RestParams *params) * Returns: %FALSE if the end of the #RestParams has been reached, %TRUE otherwise. **/ gboolean -rest_params_iter_next (RestParamsIter *iter, const char **name, RestParam **param) +rest_params_iter_next (RestParamsIter *iter, + const char **name, + RestParam **param) { + GList *cur = NULL; + g_return_val_if_fail (iter, FALSE); - return g_hash_table_iter_next ((GHashTableIter *)iter, (gpointer)name, (gpointer)param); + iter->position++; + cur = g_list_nth (iter->params->params, iter->position); + + if (cur == NULL) return FALSE; + + *param = cur->data; + *name = rest_param_get_name (*param); + return TRUE; } + diff --git a/rest/rest-params.h b/rest/rest-params.h index caace9d..9f53f77 100644 --- a/rest/rest-params.h +++ b/rest/rest-params.h @@ -20,34 +20,52 @@ * */ -#ifndef _REST_PARAMS -#define _REST_PARAMS +#pragma once #include <glib-object.h> #include "rest-param.h" G_BEGIN_DECLS -typedef struct _RestParams RestParams; -typedef struct _GHashTableIter RestParamsIter; - -RestParams * rest_params_new (void); - -void rest_params_free (RestParams *params); +#define REST_TYPE_PARAMS (rest_params_get_type ()) -void rest_params_add (RestParams *params, RestParam *param); +typedef struct _RestParams RestParams; +typedef struct _RestParamsIter RestParamsIter; -RestParam *rest_params_get (RestParams *params, const char *name); +struct _RestParams +{ + /*< private >*/ + guint ref_count; -void rest_params_remove (RestParams *params, const char *name); + GList *params; +}; -gboolean rest_params_are_strings (RestParams *params); +struct _RestParamsIter +{ + /*< private >*/ + RestParams *params; + gint position; +}; -GHashTable * rest_params_as_string_hash_table (RestParams *params); +GType rest_params_get_type (void) G_GNUC_CONST; +RestParams *rest_params_new (void); +RestParams *rest_params_copy (RestParams *self); +RestParams *rest_params_ref (RestParams *self); +void rest_params_unref (RestParams *self); +void rest_params_add (RestParams *params, + RestParam *param); +RestParam *rest_params_get (RestParams *params, + const char *name); +void rest_params_remove (RestParams *params, + const char *name); +gboolean rest_params_are_strings (RestParams *params); +GHashTable *rest_params_as_string_hash_table (RestParams *params); +void rest_params_iter_init (RestParamsIter *iter, + RestParams *params); +gboolean rest_params_iter_next (RestParamsIter *iter, + const char **name, + RestParam **param); -void rest_params_iter_init (RestParamsIter *iter, RestParams *params); -gboolean rest_params_iter_next (RestParamsIter *iter, const char **name, RestParam **param); +G_DEFINE_AUTOPTR_CLEANUP_FUNC (RestParams, rest_params_unref) G_END_DECLS - -#endif /* _REST_PARAMS */ diff --git a/rest/rest-proxy-call.c b/rest/rest-proxy-call.c index 24d952d..791a7dd 100644 --- a/rest/rest-proxy-call.c +++ b/rest/rest-proxy-call.c @@ -148,7 +148,7 @@ rest_proxy_call_dispose (GObject *object) g_clear_object (&priv->cancellable); } - g_clear_pointer (&priv->params, rest_params_free); + g_clear_pointer (&priv->params, rest_params_unref); g_clear_pointer (&priv->headers, g_hash_table_unref); g_clear_pointer (&priv->response_headers, g_hash_table_unref); g_clear_object (&priv->proxy); diff --git a/rest/rest-proxy.c b/rest/rest-proxy.c index 8231b6f..d8dbfc6 100644 --- a/rest/rest-proxy.c +++ b/rest/rest-proxy.c @@ -31,8 +31,6 @@ #include "rest-private.h" -#define GET_PRIVATE(o) rest_proxy_get_instance_private(REST_PROXY(o)) - typedef struct _RestProxyPrivate RestProxyPrivate; struct _RestProxyPrivate { @@ -74,16 +72,14 @@ enum { static guint signals[LAST_SIGNAL] = { 0 }; -static gboolean _rest_proxy_simple_run_valist (RestProxy *proxy, - char **payload, - goffset *len, - GError **error, - va_list params); - -static RestProxyCall *_rest_proxy_new_call (RestProxy *proxy); - -static gboolean _rest_proxy_bind_valist (RestProxy *proxy, - va_list params); +static gboolean _rest_proxy_simple_run_valist (RestProxy *proxy, + char **payload, + goffset *len, + GError **error, + va_list params); +static RestProxyCall *_rest_proxy_new_call (RestProxy *proxy); +static gboolean _rest_proxy_bind_valist (RestProxy *proxy, + va_list params); GQuark rest_proxy_error_quark (void) @@ -97,7 +93,8 @@ rest_proxy_get_property (GObject *object, GValue *value, GParamSpec *pspec) { - RestProxyPrivate *priv = GET_PRIVATE (object); + RestProxy *self = REST_PROXY (object); + RestProxyPrivate *priv = rest_proxy_get_instance_private (self); switch (property_id) { case PROP_URL_FORMAT: @@ -145,7 +142,8 @@ rest_proxy_set_property (GObject *object, const GValue *value, GParamSpec *pspec) { - RestProxyPrivate *priv = GET_PRIVATE (object); + RestProxy *self = REST_PROXY (object); + RestProxyPrivate *priv = rest_proxy_get_instance_private (self); switch (property_id) { case PROP_URL_FORMAT: @@ -199,7 +197,8 @@ rest_proxy_set_property (GObject *object, static void rest_proxy_dispose (GObject *object) { - RestProxyPrivate *priv = GET_PRIVATE (object); + RestProxy *self = REST_PROXY (object); + RestProxyPrivate *priv = rest_proxy_get_instance_private (self); g_clear_object (&priv->session); @@ -226,7 +225,7 @@ authenticate (RestProxy *self, gboolean retrying, SoupSession *session) { - RestProxyPrivate *priv = GET_PRIVATE (self); + RestProxyPrivate *priv = rest_proxy_get_instance_private (self); RestProxyAuth *rest_auth; gboolean try_auth; @@ -241,7 +240,8 @@ authenticate (RestProxy *self, static void rest_proxy_constructed (GObject *object) { - RestProxyPrivate *priv = GET_PRIVATE (object); + RestProxy *self = REST_PROXY (object); + RestProxyPrivate *priv = rest_proxy_get_instance_private (self); if (!priv->disable_cookies) { SoupSessionFeature *cookie_jar = @@ -270,7 +270,8 @@ rest_proxy_constructed (GObject *object) static void rest_proxy_finalize (GObject *object) { - RestProxyPrivate *priv = GET_PRIVATE (object); + RestProxy *self = REST_PROXY (object); + RestProxyPrivate *priv = rest_proxy_get_instance_private (self); g_free (priv->url); g_free (priv->url_format); @@ -440,14 +441,17 @@ transform_tls_database_to_ssl_ca_file (GBinding *binding, static void rest_proxy_init (RestProxy *self) { - RestProxyPrivate *priv = GET_PRIVATE (self); + RestProxyPrivate *priv = rest_proxy_get_instance_private (self); +#ifdef REST_SYSTEM_CA_FILE GTlsDatabase *tls_database; +#endif #ifndef WITH_SOUP_2 priv->ssl_strict = TRUE; #endif priv->session = soup_session_new (); + soup_session_remove_feature_by_type (priv->session, SOUP_TYPE_AUTH_MANAGER); #ifdef REST_SYSTEM_CA_FILE /* with ssl-strict (defaults TRUE) setting ssl-ca-file forces all @@ -532,7 +536,7 @@ static gboolean _rest_proxy_bind_valist (RestProxy *proxy, va_list params) { - RestProxyPrivate *priv = GET_PRIVATE (proxy); + RestProxyPrivate *priv = rest_proxy_get_instance_private (proxy); g_return_val_if_fail (proxy != NULL, FALSE); g_return_val_if_fail (priv->url_format != NULL, FALSE); @@ -583,7 +587,7 @@ rest_proxy_set_user_agent (RestProxy *proxy, const gchar * rest_proxy_get_user_agent (RestProxy *proxy) { - RestProxyPrivate *priv = GET_PRIVATE (proxy); + RestProxyPrivate *priv = rest_proxy_get_instance_private (proxy); g_return_val_if_fail (REST_IS_PROXY (proxy), NULL); @@ -613,9 +617,10 @@ rest_proxy_get_user_agent (RestProxy *proxy) * Since: 0.7.92 */ void -rest_proxy_add_soup_feature (RestProxy *proxy, SoupSessionFeature *feature) +rest_proxy_add_soup_feature (RestProxy *proxy, + SoupSessionFeature *feature) { - RestProxyPrivate *priv = GET_PRIVATE (proxy); + RestProxyPrivate *priv = rest_proxy_get_instance_private (proxy); g_return_if_fail (REST_IS_PROXY(proxy)); g_return_if_fail (feature != NULL); @@ -659,7 +664,7 @@ rest_proxy_new_call (RestProxy *proxy) gboolean _rest_proxy_get_binding_required (RestProxy *proxy) { - RestProxyPrivate *priv = GET_PRIVATE (proxy); + RestProxyPrivate *priv = rest_proxy_get_instance_private (proxy); g_return_val_if_fail (REST_IS_PROXY (proxy), FALSE); @@ -669,14 +674,14 @@ _rest_proxy_get_binding_required (RestProxy *proxy) const gchar * _rest_proxy_get_bound_url (RestProxy *proxy) { - RestProxyPrivate *priv = GET_PRIVATE (proxy); + RestProxyPrivate *priv = rest_proxy_get_instance_private (proxy); g_return_val_if_fail (REST_IS_PROXY (proxy), NULL); if (!priv->url && !priv->binding_required) - { - priv->url = g_strdup (priv->url_format); - } + { + priv->url = g_strdup (priv->url_format); + } return priv->url; } @@ -791,7 +796,7 @@ _rest_proxy_queue_message (RestProxy *proxy, RestMessageFinishedCallback callback, gpointer user_data) { - RestProxyPrivate *priv = GET_PRIVATE (proxy); + RestProxyPrivate *priv = rest_proxy_get_instance_private (proxy); RestMessageQueueData *data; g_return_if_fail (REST_IS_PROXY (proxy)); @@ -841,7 +846,7 @@ _rest_proxy_send_message_async (RestProxy *proxy, GAsyncReadyCallback callback, gpointer user_data) { - RestProxyPrivate *priv = GET_PRIVATE (proxy); + RestProxyPrivate *priv = rest_proxy_get_instance_private (proxy); GTask *task; task = g_task_new (proxy, cancellable, callback, user_data); @@ -868,7 +873,7 @@ _rest_proxy_cancel_message (RestProxy *proxy, SoupMessage *message) { #ifdef WITH_SOUP_2 - RestProxyPrivate *priv = GET_PRIVATE (proxy); + RestProxyPrivate *priv = rest_proxy_get_instance_private (proxy); g_return_if_fail (REST_IS_PROXY (proxy)); g_return_if_fail (SOUP_IS_MESSAGE (message)); @@ -885,7 +890,7 @@ _rest_proxy_send_message (RestProxy *proxy, GCancellable *cancellable, GError **error) { - RestProxyPrivate *priv = GET_PRIVATE (proxy); + RestProxyPrivate *priv = rest_proxy_get_instance_private (proxy); GBytes *body; g_return_val_if_fail (REST_IS_PROXY (proxy), NULL); diff --git a/rest/rest-proxy.h b/rest/rest-proxy.h index bb6d7b0..4b2a813 100644 --- a/rest/rest-proxy.h +++ b/rest/rest-proxy.h @@ -160,41 +160,32 @@ typedef enum { GQuark rest_proxy_error_quark (void); -RestProxy *rest_proxy_new (const gchar *url_format, - gboolean binding_required); - -RestProxy * -rest_proxy_new_with_authentication (const gchar *url_format, - gboolean binding_required, - const gchar *username, - const gchar *password); - -gboolean rest_proxy_bind (RestProxy *proxy, - ...); - -gboolean rest_proxy_bind_valist (RestProxy *proxy, - va_list params); - -void rest_proxy_set_user_agent (RestProxy *proxy, const char *user_agent); - -const gchar *rest_proxy_get_user_agent (RestProxy *proxy); - -void rest_proxy_add_soup_feature (RestProxy *proxy, - SoupSessionFeature *feature); - -RestProxyCall *rest_proxy_new_call (RestProxy *proxy); - -G_GNUC_NULL_TERMINATED -gboolean rest_proxy_simple_run (RestProxy *proxy, - gchar **payload, - goffset *len, - GError **error, - ...); -gboolean rest_proxy_simple_run_valist (RestProxy *proxy, - gchar **payload, - goffset *len, - GError **error, - va_list params); +RestProxy *rest_proxy_new (const gchar *url_format, + gboolean binding_required); +RestProxy *rest_proxy_new_with_authentication (const gchar *url_format, + gboolean binding_required, + const gchar *username, + const gchar *password); +gboolean rest_proxy_bind (RestProxy *proxy, + ...); +gboolean rest_proxy_bind_valist (RestProxy *proxy, + va_list params); +void rest_proxy_set_user_agent (RestProxy *proxy, + const char *user_agent); +const gchar *rest_proxy_get_user_agent (RestProxy *proxy); +void rest_proxy_add_soup_feature (RestProxy *proxy, + SoupSessionFeature *feature); +RestProxyCall *rest_proxy_new_call (RestProxy *proxy); +gboolean rest_proxy_simple_run (RestProxy *proxy, + gchar **payload, + goffset *len, + GError **error, + ...) G_GNUC_NULL_TERMINATED; +gboolean rest_proxy_simple_run_valist (RestProxy *proxy, + gchar **payload, + goffset *len, + GError **error, + va_list params); G_END_DECLS #endif /* _REST_PROXY */ diff --git a/rest/rest-xml-node.h b/rest/rest-xml-node.h index 335bd64..05a4056 100644 --- a/rest/rest-xml-node.h +++ b/rest/rest-xml-node.h @@ -21,8 +21,7 @@ * */ -#ifndef _REST_XML_NODE -#define _REST_XML_NODE +#pragma once #include <glib-object.h> @@ -39,6 +38,8 @@ G_BEGIN_DECLS * @attrs: a #GHashTable of string name to string values for the attributes of * the element. * @next: the sibling #RestXmlNode with the same name + * + * The #RestXmlNode contains a parsed XmlNode for easy consumption */ typedef struct _RestXmlNode RestXmlNode; struct _RestXmlNode { @@ -54,20 +55,21 @@ struct _RestXmlNode { GType rest_xml_node_get_type (void); -RestXmlNode *rest_xml_node_ref (RestXmlNode *node); -void rest_xml_node_unref (RestXmlNode *node); -const gchar *rest_xml_node_get_attr (RestXmlNode *node, - const gchar *attr_name); -RestXmlNode *rest_xml_node_find (RestXmlNode *start, - const gchar *tag); +RestXmlNode *rest_xml_node_ref (RestXmlNode *node); +void rest_xml_node_unref (RestXmlNode *node); +const gchar *rest_xml_node_get_attr (RestXmlNode *node, + const gchar *attr_name); +RestXmlNode *rest_xml_node_find (RestXmlNode *start, + const gchar *tag); +RestXmlNode *rest_xml_node_add_child (RestXmlNode *parent, + const char *tag); +char *rest_xml_node_print (RestXmlNode *node); +void rest_xml_node_add_attr (RestXmlNode *node, + const char *attribute, + const char *value); +void rest_xml_node_set_content (RestXmlNode *node, + const char *value); -RestXmlNode *rest_xml_node_add_child (RestXmlNode *parent, const char *tag); -char *rest_xml_node_print (RestXmlNode *node); -void rest_xml_node_add_attr (RestXmlNode *node, - const char *attribute, - const char *value); -void rest_xml_node_set_content (RestXmlNode *node, const char *value); +G_DEFINE_AUTOPTR_CLEANUP_FUNC (RestXmlNode, rest_xml_node_unref) G_END_DECLS - -#endif /* _REST_XML_NODE */ diff --git a/rest/rest-xml-parser.h b/rest/rest-xml-parser.h index cceda02..cee2570 100644 --- a/rest/rest-xml-parser.h +++ b/rest/rest-xml-parser.h @@ -20,8 +20,7 @@ * */ -#ifndef _REST_XML_PARSER -#define _REST_XML_PARSER +#pragma once #include <glib-object.h> #include <rest/rest-xml-node.h> @@ -31,15 +30,19 @@ G_BEGIN_DECLS #define REST_TYPE_XML_PARSER rest_xml_parser_get_type() G_DECLARE_DERIVABLE_TYPE (RestXmlParser, rest_xml_parser, REST, XML_PARSER, GObject) +/** + * RestXmlParser: + * + * A Xml Parser for Rest Responses + */ + struct _RestXmlParserClass { GObjectClass parent_class; }; -RestXmlParser *rest_xml_parser_new (void); -RestXmlNode *rest_xml_parser_parse_from_data (RestXmlParser *parser, - const gchar *data, - goffset len); +RestXmlParser *rest_xml_parser_new (void); +RestXmlNode *rest_xml_parser_parse_from_data (RestXmlParser *parser, + const gchar *data, + goffset len); G_END_DECLS - -#endif /* _REST_XML_PARSER */ |