[glib] Implement GProxyAddress
- From: Nicolas Dufresne <nicolasd src gnome org>
- To: commits-list gnome org
- Cc:
- Subject: [glib] Implement GProxyAddress
- Date: Thu, 19 Aug 2010 21:04:39 +0000 (UTC)
commit 466111c9605ace99389d56ace213621db01e18d9
Author: Nicolas Dufresne <nicolas dufresne collabora co uk>
Date: Mon Apr 26 17:27:33 2010 -0400
Implement GProxyAddress
A GSocketInetAddress representing the proxy server address with additional
properties proxy type, destination address and port, username and password.
Reviewed-by: Dan Winship <danw gnome org>
docs/reference/gio/gio-docs.xml | 1 +
docs/reference/gio/gio-sections.txt | 23 +++
docs/reference/gio/gio.types | 1 +
gio/Makefile.am | 2 +
gio/gio.h | 1 +
gio/gio.symbols | 12 ++
gio/giotypes.h | 1 +
gio/gproxyaddress.c | 345 +++++++++++++++++++++++++++++++++++
gio/gproxyaddress.h | 76 ++++++++
9 files changed, 462 insertions(+), 0 deletions(-)
---
diff --git a/docs/reference/gio/gio-docs.xml b/docs/reference/gio/gio-docs.xml
index 61f9168..a809877 100644
--- a/docs/reference/gio/gio-docs.xml
+++ b/docs/reference/gio/gio-docs.xml
@@ -109,6 +109,7 @@
<xi:include href="xml/gunixfdmessage.xml"/>
<xi:include href="xml/gcredentials.xml"/>
<xi:include href="xml/gunixcredentialsmessage.xml"/>
+ <xi:include href="xml/gproxyaddress.xml"/>
</chapter>
<chapter id="highlevel-socket">
<title>Highlevel network functionallity</title>
diff --git a/docs/reference/gio/gio-sections.txt b/docs/reference/gio/gio-sections.txt
index f762c02..202b689 100644
--- a/docs/reference/gio/gio-sections.txt
+++ b/docs/reference/gio/gio-sections.txt
@@ -2786,3 +2786,26 @@ G_PROXY_RESOLVER_GET_IFACE
<SUBSECTION Private>
g_proxy_resolver_get_type
</SECTION>
+
+<SECTION>
+<FILE>gproxyaddress</FILE>
+<TITLE>GProxyAddress</TITLE>
+GProxyAddress
+GProxyAddressClass
+g_proxy_address_get_destination_hostname
+g_proxy_address_get_destination_port
+g_proxy_address_get_password
+g_proxy_address_get_protocol
+g_proxy_address_get_username
+g_proxy_address_new
+<SUBSECTION Standard>
+G_PROXY_ADDRESS
+G_PROXY_ADDRESS_CLASS
+G_PROXY_ADDRESS_GET_CLASS
+G_IS_PROXY_ADDRESS
+G_IS_PROXY_ADDRESS_CLASS
+G_TYPE_PROXY_ADDRESS
+<SUBSECTION Private>
+GProxyAddressPrivate
+g_proxy_address_get_type
+</SECTION>
diff --git a/docs/reference/gio/gio.types b/docs/reference/gio/gio.types
index 5a9f7d7..6452ff6 100644
--- a/docs/reference/gio/gio.types
+++ b/docs/reference/gio/gio.types
@@ -75,6 +75,7 @@ g_output_stream_get_type
g_output_stream_splice_flags_get_type
g_password_save_get_type
g_permission_get_type
+g_proxy_address_get_type
g_proxy_resolver_get_type
g_resolver_error_get_type
g_resolver_get_type
diff --git a/gio/Makefile.am b/gio/Makefile.am
index 10df75a..a08915b 100644
--- a/gio/Makefile.am
+++ b/gio/Makefile.am
@@ -350,6 +350,7 @@ libgio_2_0_la_SOURCES = \
gsocketlistener.c \
gsocketoutputstream.c \
gsocketoutputstream.h \
+ gproxyaddress.c \
gsocketservice.c \
gsrvtarget.c \
gtcpconnection.c \
@@ -481,6 +482,7 @@ gio_headers = \
gnetworkservice.h \
goutputstream.h \
gpermission.h \
+ gproxyaddress.h \
gproxyresolver.h \
gresolver.h \
gseekable.h \
diff --git a/gio/gio.h b/gio/gio.h
index 733ec2f..003b134 100644
--- a/gio/gio.h
+++ b/gio/gio.h
@@ -92,6 +92,7 @@
#include <gio/gnetworkservice.h>
#include <gio/goutputstream.h>
#include <gio/gpermission.h>
+#include <gio/gproxyaddress.h>
#include <gio/gproxyresolver.h>
#include <gio/gresolver.h>
#include <gio/gseekable.h>
diff --git a/gio/gio.symbols b/gio/gio.symbols
index 700f949..2a579b6 100644
--- a/gio/gio.symbols
+++ b/gio/gio.symbols
@@ -1139,6 +1139,18 @@ g_proxy_resolver_lookup_finish
#endif
#endif
+#if IN_HEADER(__G_PROXY_ADDRESS_H__)
+#if IN_FILE(__G_PROXY_ADDRESS_C__)
+g_proxy_address_get_type
+g_proxy_address_new
+g_proxy_address_get_protocol
+g_proxy_address_get_destination_hostname
+g_proxy_address_get_destination_port
+g_proxy_address_get_username
+g_proxy_address_get_password
+#endif
+#endif
+
#if IN_HEADER(__G_RESOLVER_H__)
#if IN_FILE(__G_RESOLVER_C__)
g_resolver_error_quark
diff --git a/gio/giotypes.h b/gio/giotypes.h
index 2227846..dacb986 100644
--- a/gio/giotypes.h
+++ b/gio/giotypes.h
@@ -206,6 +206,7 @@ typedef struct _GVfs GVfs; /* Dummy typedef */
* Since: 2.26
**/
typedef struct _GProxyResolver GProxyResolver;
+typedef struct _GProxyAddress GProxyAddress;
/**
* GVolume:
diff --git a/gio/gproxyaddress.c b/gio/gproxyaddress.c
new file mode 100644
index 0000000..61dfc7d
--- /dev/null
+++ b/gio/gproxyaddress.c
@@ -0,0 +1,345 @@
+/* GIO - GLib Input, Output and Streaming Library
+ *
+ * Copyright (C) 2010 Collabora, Ltd.
+ *
+ * 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; 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
+ * 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, write to the
+ * Free Software Foundation, Inc., 59 Temple Place, Suite 330,
+ * Boston, MA 02111-1307, USA.
+ *
+ * Authors: Nicolas Dufresne <nicolas dufresne collabora co uk>
+ */
+
+#include <config.h>
+#include <glib.h>
+#include <string.h>
+
+#include <gio/gsocketaddress.h>
+
+#include "gproxyaddress.h"
+#include "glibintl.h"
+
+/**
+ * SECTION:gproxyaddress
+ * @short_description: An internet address with proxy information
+ *
+ * Support for proxied #GInetSocketAddress.
+ */
+
+/**
+ * GProxyAddress:
+ *
+ * A #GInetSocketAddress representing a connection via a proxy server
+ *
+ * Since: 2.26
+ **/
+G_DEFINE_TYPE (GProxyAddress, g_proxy_address, G_TYPE_INET_SOCKET_ADDRESS);
+
+enum
+{
+ PROP_0,
+ PROP_PROTOCOL,
+ PROP_DESTINATION_HOSTNAME,
+ PROP_DESTINATION_PORT,
+ PROP_USERNAME,
+ PROP_PASSWORD
+};
+
+struct _GProxyAddressPrivate
+{
+ gchar *protocol;
+ gchar *username;
+ gchar *password;
+ gchar *dest_hostname;
+ guint16 dest_port;
+};
+
+static void
+g_proxy_address_finalize (GObject *object)
+{
+ GProxyAddress *proxy = G_PROXY_ADDRESS (object);
+
+ g_free (proxy->priv->protocol);
+ g_free (proxy->priv->username);
+ g_free (proxy->priv->password);
+ g_free (proxy->priv->dest_hostname);
+
+ G_OBJECT_CLASS (g_proxy_address_parent_class)->finalize (object);
+}
+
+static void
+g_proxy_address_set_property (GObject *object,
+ guint prop_id,
+ const GValue *value,
+ GParamSpec *pspec)
+{
+ GProxyAddress *proxy = G_PROXY_ADDRESS (object);
+
+ switch (prop_id)
+ {
+ case PROP_PROTOCOL:
+ g_free (proxy->priv->protocol);
+ proxy->priv->protocol = g_value_dup_string (value);
+ break;
+
+ case PROP_DESTINATION_HOSTNAME:
+ g_free (proxy->priv->dest_hostname);
+ proxy->priv->dest_hostname = g_value_dup_string (value);
+ break;
+
+ case PROP_DESTINATION_PORT:
+ proxy->priv->dest_port = g_value_get_uint (value);
+ break;
+
+ case PROP_USERNAME:
+ g_free (proxy->priv->username);
+ proxy->priv->username = g_value_dup_string (value);
+ break;
+
+ case PROP_PASSWORD:
+ g_free (proxy->priv->password);
+ proxy->priv->password = g_value_dup_string (value);
+ break;
+
+ default:
+ G_OBJECT_WARN_INVALID_PROPERTY_ID (object, prop_id, pspec);
+ }
+}
+
+static void
+g_proxy_address_get_property (GObject *object,
+ guint prop_id,
+ GValue *value,
+ GParamSpec *pspec)
+{
+ GProxyAddress *proxy = G_PROXY_ADDRESS (object);
+
+ switch (prop_id)
+ {
+ case PROP_PROTOCOL:
+ g_value_set_string (value, proxy->priv->protocol);
+ break;
+
+ case PROP_DESTINATION_HOSTNAME:
+ g_value_set_string (value, proxy->priv->dest_hostname);
+ break;
+
+ case PROP_DESTINATION_PORT:
+ g_value_set_uint (value, proxy->priv->dest_port);
+ break;
+
+ case PROP_USERNAME:
+ g_value_set_string (value, proxy->priv->username);
+ break;
+
+ case PROP_PASSWORD:
+ g_value_set_string (value, proxy->priv->password);
+ break;
+
+ default:
+ G_OBJECT_WARN_INVALID_PROPERTY_ID (object, prop_id, pspec);
+ }
+}
+
+static void
+g_proxy_address_class_init (GProxyAddressClass *klass)
+{
+ GObjectClass *gobject_class = G_OBJECT_CLASS (klass);
+
+ g_type_class_add_private (klass, sizeof (GProxyAddressPrivate));
+
+ gobject_class->finalize = g_proxy_address_finalize;
+ gobject_class->set_property = g_proxy_address_set_property;
+ gobject_class->get_property = g_proxy_address_get_property;
+
+ g_object_class_install_property (gobject_class,
+ PROP_PROTOCOL,
+ g_param_spec_string ("protocol",
+ P_("Protocol"),
+ P_("The proxy protocol"),
+ NULL,
+ G_PARAM_READWRITE |
+ G_PARAM_CONSTRUCT_ONLY |
+ G_PARAM_STATIC_STRINGS));
+
+ g_object_class_install_property (gobject_class,
+ PROP_USERNAME,
+ g_param_spec_string ("username",
+ P_("Username"),
+ P_("The proxy username"),
+ NULL,
+ G_PARAM_READWRITE |
+ G_PARAM_CONSTRUCT_ONLY |
+ G_PARAM_STATIC_STRINGS));
+
+ g_object_class_install_property (gobject_class,
+ PROP_PASSWORD,
+ g_param_spec_string ("password",
+ P_("Password"),
+ P_("The proxy password"),
+ NULL,
+ G_PARAM_READWRITE |
+ G_PARAM_CONSTRUCT_ONLY |
+ G_PARAM_STATIC_STRINGS));
+
+ g_object_class_install_property (gobject_class,
+ PROP_DESTINATION_HOSTNAME,
+ g_param_spec_string ("destination-hostname",
+ P_("Destination Hostname"),
+ P_("The proxy destination hostname"),
+ NULL,
+ G_PARAM_READWRITE |
+ G_PARAM_CONSTRUCT_ONLY |
+ G_PARAM_STATIC_STRINGS));
+
+ g_object_class_install_property (gobject_class,
+ PROP_DESTINATION_PORT,
+ g_param_spec_uint ("destination-port",
+ P_("Destination Port"),
+ P_("The proxy destination port"),
+ 0, 65535, 0,
+ G_PARAM_READWRITE |
+ G_PARAM_CONSTRUCT_ONLY |
+ G_PARAM_STATIC_STRINGS));
+}
+
+static void
+g_proxy_address_init (GProxyAddress *proxy)
+{
+ proxy->priv = G_TYPE_INSTANCE_GET_PRIVATE (proxy,
+ G_TYPE_PROXY_ADDRESS,
+ GProxyAddressPrivate);
+ proxy->priv->protocol = NULL;
+ proxy->priv->username = NULL;
+ proxy->priv->password = NULL;
+ proxy->priv->dest_hostname = NULL;
+ proxy->priv->dest_port = 0;
+}
+
+/**
+ * g_proxy_address_new:
+ * @inetaddr: The proxy server #GInetAddress.
+ * @port: The proxy server port.
+ * @protocol: The proxy protocol to support, in lower case (e.g. socks, http).
+ * @dest_hostname: The destination hostname the the proxy should tunnel to.
+ * @dest_port: The destination port to tunnel to.
+ * @username: The username to authenticate to the proxy server (or %NULL).
+ * @password: The password to authenticate to the proxy server (or %NULL).
+ *
+ * Creates a new #GProxyAddress for @inetaddr with @protocol that should
+ * tunnel through @dest_hostname and @dest_port.
+ *
+ * Returns: a new #GProxyAddress
+ *
+ * Since: 2.26
+ */
+GSocketAddress *
+g_proxy_address_new (GInetAddress *inetaddr,
+ guint16 port,
+ const gchar *protocol,
+ const gchar *dest_hostname,
+ guint16 dest_port,
+ const gchar *username,
+ const gchar *password)
+{
+ return g_object_new (G_TYPE_PROXY_ADDRESS,
+ "address", inetaddr,
+ "port", port,
+ "protocol", protocol,
+ "destination-hostname", dest_hostname,
+ "destination-port", dest_port,
+ "username", username,
+ "password", password,
+ NULL);
+}
+
+
+/**
+ * g_proxy_address_get_protocol:
+ * @proxy: a #GProxyAddress
+ *
+ * Gets @proxy's protocol.
+ *
+ * Returns: the @proxy's protocol
+ *
+ * Since: 2.26
+ */
+const gchar *
+g_proxy_address_get_protocol (GProxyAddress *proxy)
+{
+ return proxy->priv->protocol;
+}
+
+/**
+ * g_proxy_address_get_destination_hostname
+ * @proxy: a #GProxyAddress
+ *
+ * Gets @proxy's destination hostname.
+ *
+ * Returns: the @proxy's destination hostname
+ *
+ * Since: 2.26
+ */
+const gchar *
+g_proxy_address_get_destination_hostname (GProxyAddress *proxy)
+{
+ return proxy->priv->dest_hostname;
+}
+
+/**
+ * g_proxy_address_get_destination_port
+ * @proxy: a #GProxyAddress
+ *
+ * Gets @proxy's destination port.
+ *
+ * Returns: the @proxy's destination port
+ *
+ * Since: 2.26
+ */
+guint16
+g_proxy_address_get_destination_port (GProxyAddress *proxy)
+{
+ return proxy->priv->dest_port;
+}
+
+/**
+ * g_proxy_address_get_username
+ * @proxy: a #GProxyAddress
+ *
+ * Gets @proxy's username.
+ *
+ * Returns: the @proxy's username
+ *
+ * Since: 2.26
+ */
+const gchar *
+g_proxy_address_get_username (GProxyAddress *proxy)
+{
+ return proxy->priv->username;
+}
+
+/**
+ * g_proxy_address_get_password
+ * @proxy: a #GProxyAddress
+ *
+ * Gets @proxy's password.
+ *
+ * Returns: the @proxy's password
+ *
+ * Since: 2.26
+ */
+const gchar *
+g_proxy_address_get_password (GProxyAddress *proxy)
+{
+ return proxy->priv->password;
+}
diff --git a/gio/gproxyaddress.h b/gio/gproxyaddress.h
new file mode 100644
index 0000000..cc4594d
--- /dev/null
+++ b/gio/gproxyaddress.h
@@ -0,0 +1,76 @@
+/* GIO - GLib Input, Output and Streaming Library
+ *
+ * Copyright (C) 2010 Collabora, Ltd.
+ *
+ * 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; 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
+ * 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, write to the
+ * Free Software Foundation, Inc., 59 Temple Place, Suite 330,
+ * Boston, MA 02111-1307, USA.
+ *
+ * Authors: Nicolas Dufresne <nicolas dufresne collabora co uk>
+ */
+
+#if !defined (__GIO_GIO_H_INSIDE__) && !defined (GIO_COMPILATION)
+#error "Only <gio/gio.h> can be included directly."
+#endif
+
+#ifndef __G_PROXY_ADDRESS_H__
+#define __G_PROXY_ADDRESS_H__
+
+#include <gio/ginetsocketaddress.h>
+
+G_BEGIN_DECLS
+
+#define G_TYPE_PROXY_ADDRESS (g_proxy_address_get_type ())
+#define G_PROXY_ADDRESS(o) (G_TYPE_CHECK_INSTANCE_CAST ((o), G_TYPE_PROXY_ADDRESS, GProxyAddress))
+#define G_PROXY_ADDRESS_CLASS(k) (G_TYPE_CHECK_CLASS_CAST((k), G_TYPE_PROXY_ADDRESS, GProxyAddressClass))
+#define G_IS_PROXY_ADDRESS(o) (G_TYPE_CHECK_INSTANCE_TYPE ((o), G_TYPE_PROXY_ADDRESS))
+#define G_IS_PROXY_ADDRESS_CLASS(k) (G_TYPE_CHECK_CLASS_TYPE ((k), G_TYPE_PROXY_ADDRESS))
+#define G_PROXY_ADDRESS_GET_CLASS(o) (G_TYPE_INSTANCE_GET_CLASS ((o), G_TYPE_PROXY_ADDRESS, GProxyAddressClass))
+
+typedef struct _GProxyAddressClass GProxyAddressClass;
+typedef struct _GProxyAddressPrivate GProxyAddressPrivate;
+
+struct _GProxyAddress
+{
+ GInetSocketAddress parent_instance;
+
+ /*< private >*/
+ GProxyAddressPrivate *priv;
+};
+
+struct _GProxyAddressClass
+{
+ GInetSocketAddressClass parent_class;
+};
+
+
+GType g_proxy_address_get_type (void) G_GNUC_CONST;
+
+GSocketAddress *g_proxy_address_new (GInetAddress *inetaddr,
+ guint16 port,
+ const gchar *protocol,
+ const gchar *dest_hostname,
+ guint16 dest_port,
+ const gchar *username,
+ const gchar *password);
+
+const gchar *g_proxy_address_get_protocol (GProxyAddress *proxy);
+const gchar *g_proxy_address_get_destination_hostname (GProxyAddress *proxy);
+guint16 g_proxy_address_get_destination_port (GProxyAddress *proxy);
+const gchar *g_proxy_address_get_username (GProxyAddress *proxy);
+const gchar *g_proxy_address_get_password (GProxyAddress *proxy);
+
+G_END_DECLS
+
+#endif /* __G_PROXY_ADDRESS_H__ */
[
Date Prev][
Date Next] [
Thread Prev][
Thread Next]
[
Thread Index]
[
Date Index]
[
Author Index]
