1 /* -*- mode: C; c-file-style: "gnu"; indent-tabs-mode: nil; -*- */
3 /* GIO - GLib Input, Output and Streaming Library
5 * Copyright (C) 2008 Red Hat, Inc.
7 * This library is free software; you can redistribute it and/or
8 * modify it under the terms of the GNU Lesser General Public
9 * License as published by the Free Software Foundation; either
10 * version 2 of the License, or (at your option) any later version.
12 * This library is distributed in the hope that it will be useful,
13 * but WITHOUT ANY WARRANTY; without even the implied warranty of
14 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
15 * Lesser General Public License for more details.
17 * You should have received a copy of the GNU Lesser General
18 * Public License along with this library; if not, write to the
19 * Free Software Foundation, Inc., 59 Temple Place, Suite 330,
20 * Boston, MA 02111-1307, USA.
28 #include "gnetworkaddress.h"
29 #include "gasyncresult.h"
30 #include "ginetaddress.h"
31 #include "ginetsocketaddress.h"
32 #include "gnetworkingprivate.h"
33 #include "gproxyaddressenumerator.h"
34 #include "gresolver.h"
35 #include "gsimpleasyncresult.h"
36 #include "gsocketaddressenumerator.h"
38 #include "gsocketconnectable.h"
44 * SECTION:gnetworkaddress
45 * @short_description: A GSocketConnectable for resolving hostnames
48 * #GNetworkAddress provides an easy way to resolve a hostname and
49 * then attempt to connect to that host, handling the possibility of
50 * multiple IP addresses and multiple address families.
52 * See #GSocketConnectable for and example of using the connectable
59 * A #GSocketConnectable for resolving a hostname and connecting to
63 struct _GNetworkAddressPrivate {
77 static void g_network_address_set_property (GObject *object,
81 static void g_network_address_get_property (GObject *object,
86 static void g_network_address_connectable_iface_init (GSocketConnectableIface *iface);
87 static GSocketAddressEnumerator *g_network_address_connectable_enumerate (GSocketConnectable *connectable);
88 static GSocketAddressEnumerator *g_network_address_connectable_proxy_enumerate (GSocketConnectable *connectable);
90 G_DEFINE_TYPE_WITH_CODE (GNetworkAddress, g_network_address, G_TYPE_OBJECT,
91 G_IMPLEMENT_INTERFACE (G_TYPE_SOCKET_CONNECTABLE,
92 g_network_address_connectable_iface_init))
95 g_network_address_finalize (GObject *object)
97 GNetworkAddress *addr = G_NETWORK_ADDRESS (object);
99 g_free (addr->priv->hostname);
100 g_free (addr->priv->scheme);
102 if (addr->priv->sockaddrs)
106 for (a = addr->priv->sockaddrs; a; a = a->next)
107 g_object_unref (a->data);
108 g_list_free (addr->priv->sockaddrs);
111 G_OBJECT_CLASS (g_network_address_parent_class)->finalize (object);
115 g_network_address_class_init (GNetworkAddressClass *klass)
117 GObjectClass *gobject_class = G_OBJECT_CLASS (klass);
119 g_type_class_add_private (klass, sizeof (GNetworkAddressPrivate));
121 gobject_class->set_property = g_network_address_set_property;
122 gobject_class->get_property = g_network_address_get_property;
123 gobject_class->finalize = g_network_address_finalize;
125 g_object_class_install_property (gobject_class, PROP_HOSTNAME,
126 g_param_spec_string ("hostname",
128 P_("Hostname to resolve"),
131 G_PARAM_CONSTRUCT_ONLY |
132 G_PARAM_STATIC_STRINGS));
133 g_object_class_install_property (gobject_class, PROP_PORT,
134 g_param_spec_uint ("port",
139 G_PARAM_CONSTRUCT_ONLY |
140 G_PARAM_STATIC_STRINGS));
142 g_object_class_install_property (gobject_class, PROP_SCHEME,
143 g_param_spec_string ("scheme",
148 G_PARAM_CONSTRUCT_ONLY |
149 G_PARAM_STATIC_STRINGS));
153 g_network_address_connectable_iface_init (GSocketConnectableIface *connectable_iface)
155 connectable_iface->enumerate = g_network_address_connectable_enumerate;
156 connectable_iface->proxy_enumerate = g_network_address_connectable_proxy_enumerate;
160 g_network_address_init (GNetworkAddress *addr)
162 addr->priv = G_TYPE_INSTANCE_GET_PRIVATE (addr, G_TYPE_NETWORK_ADDRESS,
163 GNetworkAddressPrivate);
167 g_network_address_set_property (GObject *object,
172 GNetworkAddress *addr = G_NETWORK_ADDRESS (object);
177 g_free (addr->priv->hostname);
178 addr->priv->hostname = g_value_dup_string (value);
182 addr->priv->port = g_value_get_uint (value);
186 if (addr->priv->scheme)
187 g_free (addr->priv->scheme);
188 addr->priv->scheme = g_value_dup_string (value);
192 G_OBJECT_WARN_INVALID_PROPERTY_ID (object, prop_id, pspec);
199 g_network_address_get_property (GObject *object,
204 GNetworkAddress *addr = G_NETWORK_ADDRESS (object);
209 g_value_set_string (value, addr->priv->hostname);
213 g_value_set_uint (value, addr->priv->port);
217 g_value_set_string (value, addr->priv->scheme);
221 G_OBJECT_WARN_INVALID_PROPERTY_ID (object, prop_id, pspec);
228 g_network_address_set_addresses (GNetworkAddress *addr,
232 GSocketAddress *sockaddr;
234 g_return_if_fail (addresses != NULL && addr->priv->sockaddrs == NULL);
236 for (a = addresses; a; a = a->next)
238 sockaddr = g_inet_socket_address_new (a->data, addr->priv->port);
239 addr->priv->sockaddrs = g_list_prepend (addr->priv->sockaddrs, sockaddr);
240 g_object_unref (a->data);
242 g_list_free (addresses);
243 addr->priv->sockaddrs = g_list_reverse (addr->priv->sockaddrs);
247 * g_network_address_new:
248 * @hostname: the hostname
251 * Creates a new #GSocketConnectable for connecting to the given
252 * @hostname and @port.
254 * Return value: (transfer full): the new #GNetworkAddress
259 g_network_address_new (const gchar *hostname,
262 return g_object_new (G_TYPE_NETWORK_ADDRESS,
263 "hostname", hostname,
269 * g_network_address_parse:
270 * @host_and_port: the hostname and optionally a port
271 * @default_port: the default port if not in @host_and_port
272 * @error: a pointer to a #GError, or %NULL
274 * Creates a new #GSocketConnectable for connecting to the given
275 * @hostname and @port. May fail and return %NULL in case
276 * parsing @host_and_port fails.
278 * @host_and_port may be in any of a number of recognised formats; an IPv6
279 * address, an IPv4 address, or a domain name (in which case a DNS
280 * lookup is performed). Quoting with [] is supported for all address
281 * types. A port override may be specified in the usual way with a
284 * If no port is specified in @host_and_port then @default_port will be
285 * used as the port number to connect to.
287 * In general, @host_and_port is expected to be provided by the user
288 * (allowing them to give the hostname, and a port overide if necessary)
289 * and @default_port is expected to be provided by the application.
291 * (The port component of @host_and_port can also be specified as a
292 * service name rather than as a numeric port, but this functionality
293 * is deprecated, because it depends on the contents of /etc/services,
294 * which is generally quite sparse on platforms other than Linux.)
296 * Return value: (transfer full): the new #GNetworkAddress, or %NULL on error
301 g_network_address_parse (const gchar *host_and_port,
302 guint16 default_port,
305 GSocketConnectable *connectable;
310 g_return_val_if_fail (host_and_port != NULL, NULL);
313 if (host_and_port[0] == '[')
314 /* escaped host part (to allow, eg. "[2001:db8::1]:888") */
318 end = strchr (host_and_port, ']');
321 g_set_error (error, G_IO_ERROR, G_IO_ERROR_INVALID_ARGUMENT,
322 _("Hostname '%s' contains '[' but not ']'"), host_and_port);
328 else if (end[1] == ':')
332 g_set_error (error, G_IO_ERROR, G_IO_ERROR_INVALID_ARGUMENT,
333 "The ']' character (in hostname '%s') must come at the"
334 " end or be immediately followed by ':' and a port",
339 name = g_strndup (host_and_port + 1, end - host_and_port - 1);
342 else if ((port = strchr (host_and_port, ':')))
343 /* string has a ':' in it */
348 if (strchr (port, ':'))
349 /* more than one ':' in string */
351 /* this is actually an unescaped IPv6 address */
352 name = g_strdup (host_and_port);
356 name = g_strndup (host_and_port, port - host_and_port - 1);
360 /* plain hostname, no port */
361 name = g_strdup (host_and_port);
367 g_set_error (error, G_IO_ERROR, G_IO_ERROR_INVALID_ARGUMENT,
368 "If a ':' character is given, it must be followed by a "
369 "port (in hostname '%s').", host_and_port);
374 else if ('0' <= port[0] && port[0] <= '9')
379 value = strtol (port, &end, 10);
380 if (*end != '\0' || value < 0 || value > G_MAXUINT16)
382 g_set_error (error, G_IO_ERROR, G_IO_ERROR_INVALID_ARGUMENT,
383 "Invalid numeric port '%s' specified in hostname '%s'",
384 port, host_and_port);
394 struct servent *entry;
396 entry = getservbyname (port, "tcp");
399 g_set_error (error, G_IO_ERROR, G_IO_ERROR_INVALID_ARGUMENT,
400 "Unknown service '%s' specified in hostname '%s'",
401 port, host_and_port);
402 #ifdef HAVE_ENDSERVENT
409 portnum = g_ntohs (entry->s_port);
411 #ifdef HAVE_ENDSERVENT
418 /* No port in host_and_port */
419 portnum = default_port;
422 connectable = g_network_address_new (name, portnum);
428 /* Allowed characters outside alphanumeric for unreserved. */
429 #define G_URI_OTHER_UNRESERVED "-._~"
431 /* This or something equivalent will eventually go into glib/guri.h */
433 _g_uri_parse_authority (const char *uri,
439 const char *start, *p;
442 g_return_val_if_fail (uri != NULL, FALSE);
453 /* From RFC 3986 Decodes:
454 * URI = scheme ":" hier-part [ "?" query ] [ "#" fragment ]
455 * hier-part = "//" authority path-abempty
456 * path-abempty = *( "/" segment )
457 * authority = [ userinfo "@" ] host [ ":" port ]
460 /* Check we have a valid scheme */
461 tmp_str = g_uri_parse_scheme (uri);
469 * hier-part = "//" authority path-abempty
472 start = strstr (p, "//");
478 p = strchr (start, '@');
483 * userinfo = *( unreserved / pct-encoded / sub-delims / ":" )
484 * unreserved = ALPHA / DIGIT / "-" / "." / "_" / "~"
485 * pct-encoded = "%" HEXDIG HEXDIG
497 if (!(g_ascii_isxdigit (p[0]) ||
498 g_ascii_isxdigit (p[1])))
506 /* unreserved / sub-delims / : */
507 if (!(g_ascii_isalnum(c) ||
508 strchr (G_URI_OTHER_UNRESERVED, c) ||
509 strchr (G_URI_RESERVED_CHARS_SUBCOMPONENT_DELIMITERS, c) ||
515 *userinfo = g_strndup (start, p - start - 1);
526 * host = IP-literal / IPv4address / reg-name
527 * reg-name = *( unreserved / pct-encoded / sub-delims )
530 /* If IPv6 or IPvFuture */
542 /* unreserved / sub-delims */
543 if (!(g_ascii_isalnum(c) ||
544 strchr (G_URI_OTHER_UNRESERVED, c) ||
545 strchr (G_URI_RESERVED_CHARS_SUBCOMPONENT_DELIMITERS, c) ||
567 if (!(g_ascii_isxdigit (p[0]) ||
568 g_ascii_isxdigit (p[1])))
576 /* unreserved / sub-delims */
577 if (!(g_ascii_isalnum(c) ||
578 strchr (G_URI_OTHER_UNRESERVED, c) ||
579 strchr (G_URI_RESERVED_CHARS_SUBCOMPONENT_DELIMITERS, c)))
585 *host = g_uri_unescape_segment (start, p - 1, NULL);
604 if (!g_ascii_isdigit (c))
607 tmp = (tmp * 10) + (c - '0');
613 *port = (guint16) tmp;
625 if (userinfo && *userinfo)
635 _g_uri_from_authority (const gchar *protocol,
638 const gchar *userinfo)
642 uri = g_string_new (protocol);
643 g_string_append (uri, "://");
647 g_string_append_uri_escaped (uri, userinfo, G_URI_RESERVED_CHARS_ALLOWED_IN_USERINFO, FALSE);
648 g_string_append_c (uri, '@');
651 if (g_hostname_is_non_ascii (host))
653 gchar *ace_encoded = g_hostname_to_ascii (host);
657 g_string_free (uri, TRUE);
660 g_string_append (uri, ace_encoded);
661 g_free (ace_encoded);
663 else if (strchr (host, ':'))
664 g_string_append_printf (uri, "[%s]", host);
666 g_string_append (uri, host);
669 g_string_append_printf (uri, ":%u", port);
671 return g_string_free (uri, FALSE);
675 * g_network_address_parse_uri:
676 * @uri: the hostname and optionally a port
677 * @default_port: The default port if none is found in the URI
678 * @error: a pointer to a #GError, or %NULL
680 * Creates a new #GSocketConnectable for connecting to the given
681 * @uri. May fail and return %NULL in case parsing @uri fails.
683 * Using this rather than g_network_address_new() or
684 * g_network_address_parse_host() allows #GSocketClient to determine
685 * when to use application-specific proxy protocols.
687 * Return value: (transfer full): the new #GNetworkAddress, or %NULL on error
692 g_network_address_parse_uri (const gchar *uri,
693 guint16 default_port,
696 GSocketConnectable *conn;
701 if (!_g_uri_parse_authority (uri, &hostname, &port, NULL))
703 g_set_error (error, G_IO_ERROR, G_IO_ERROR_INVALID_ARGUMENT,
712 scheme = g_uri_parse_scheme (uri);
714 conn = g_object_new (G_TYPE_NETWORK_ADDRESS,
715 "hostname", hostname,
727 * g_network_address_get_hostname:
728 * @addr: a #GNetworkAddress
730 * Gets @addr's hostname. This might be either UTF-8 or ASCII-encoded,
731 * depending on what @addr was created with.
733 * Return value: @addr's hostname
738 g_network_address_get_hostname (GNetworkAddress *addr)
740 g_return_val_if_fail (G_IS_NETWORK_ADDRESS (addr), NULL);
742 return addr->priv->hostname;
746 * g_network_address_get_port:
747 * @addr: a #GNetworkAddress
749 * Gets @addr's port number
751 * Return value: @addr's port (which may be 0)
756 g_network_address_get_port (GNetworkAddress *addr)
758 g_return_val_if_fail (G_IS_NETWORK_ADDRESS (addr), 0);
760 return addr->priv->port;
764 * g_network_address_get_scheme:
765 * @addr: a #GNetworkAddress
767 * Gets @addr's scheme
769 * Return value: @addr's scheme (%NULL if not built from URI)
774 g_network_address_get_scheme (GNetworkAddress *addr)
776 g_return_val_if_fail (G_IS_NETWORK_ADDRESS (addr), NULL);
778 return addr->priv->scheme;
781 #define G_TYPE_NETWORK_ADDRESS_ADDRESS_ENUMERATOR (_g_network_address_address_enumerator_get_type ())
782 #define G_NETWORK_ADDRESS_ADDRESS_ENUMERATOR(obj) (G_TYPE_CHECK_INSTANCE_CAST ((obj), G_TYPE_NETWORK_ADDRESS_ADDRESS_ENUMERATOR, GNetworkAddressAddressEnumerator))
785 GSocketAddressEnumerator parent_instance;
787 GNetworkAddress *addr;
790 } GNetworkAddressAddressEnumerator;
793 GSocketAddressEnumeratorClass parent_class;
795 } GNetworkAddressAddressEnumeratorClass;
797 static GType _g_network_address_address_enumerator_get_type (void);
798 G_DEFINE_TYPE (GNetworkAddressAddressEnumerator, _g_network_address_address_enumerator, G_TYPE_SOCKET_ADDRESS_ENUMERATOR)
801 g_network_address_address_enumerator_finalize (GObject *object)
803 GNetworkAddressAddressEnumerator *addr_enum =
804 G_NETWORK_ADDRESS_ADDRESS_ENUMERATOR (object);
806 g_object_unref (addr_enum->addr);
808 G_OBJECT_CLASS (_g_network_address_address_enumerator_parent_class)->finalize (object);
811 static GSocketAddress *
812 g_network_address_address_enumerator_next (GSocketAddressEnumerator *enumerator,
813 GCancellable *cancellable,
816 GNetworkAddressAddressEnumerator *addr_enum =
817 G_NETWORK_ADDRESS_ADDRESS_ENUMERATOR (enumerator);
818 GSocketAddress *sockaddr;
820 if (addr_enum->addresses == NULL)
822 if (!addr_enum->addr->priv->sockaddrs)
824 GResolver *resolver = g_resolver_get_default ();
827 addresses = g_resolver_lookup_by_name (resolver,
828 addr_enum->addr->priv->hostname,
830 g_object_unref (resolver);
835 g_network_address_set_addresses (addr_enum->addr, addresses);
838 addr_enum->addresses = addr_enum->addr->priv->sockaddrs;
839 addr_enum->next = addr_enum->addresses;
842 if (addr_enum->next == NULL)
845 sockaddr = addr_enum->next->data;
846 addr_enum->next = addr_enum->next->next;
847 return g_object_ref (sockaddr);
851 got_addresses (GObject *source_object,
852 GAsyncResult *result,
855 GSimpleAsyncResult *simple = user_data;
856 GNetworkAddressAddressEnumerator *addr_enum =
857 g_simple_async_result_get_op_res_gpointer (simple);
858 GResolver *resolver = G_RESOLVER (source_object);
860 GError *error = NULL;
862 if (!addr_enum->addr->priv->sockaddrs)
864 addresses = g_resolver_lookup_by_name_finish (resolver, result, &error);
867 g_simple_async_result_take_error (simple, error);
869 g_network_address_set_addresses (addr_enum->addr, addresses);
872 g_object_unref (resolver);
874 addr_enum->addresses = addr_enum->addr->priv->sockaddrs;
875 addr_enum->next = addr_enum->addresses;
877 g_simple_async_result_complete (simple);
878 g_object_unref (simple);
882 g_network_address_address_enumerator_next_async (GSocketAddressEnumerator *enumerator,
883 GCancellable *cancellable,
884 GAsyncReadyCallback callback,
887 GNetworkAddressAddressEnumerator *addr_enum =
888 G_NETWORK_ADDRESS_ADDRESS_ENUMERATOR (enumerator);
889 GSimpleAsyncResult *simple;
891 simple = g_simple_async_result_new (G_OBJECT (enumerator),
893 g_network_address_address_enumerator_next_async);
895 if (addr_enum->addresses == NULL)
897 if (!addr_enum->addr->priv->sockaddrs)
899 GResolver *resolver = g_resolver_get_default ();
901 g_simple_async_result_set_op_res_gpointer (simple, g_object_ref (addr_enum), g_object_unref);
902 g_resolver_lookup_by_name_async (resolver,
903 addr_enum->addr->priv->hostname,
905 got_addresses, simple);
909 addr_enum->addresses = addr_enum->addr->priv->sockaddrs;
910 addr_enum->next = addr_enum->addresses;
913 g_simple_async_result_complete_in_idle (simple);
914 g_object_unref (simple);
917 static GSocketAddress *
918 g_network_address_address_enumerator_next_finish (GSocketAddressEnumerator *enumerator,
919 GAsyncResult *result,
922 GNetworkAddressAddressEnumerator *addr_enum =
923 G_NETWORK_ADDRESS_ADDRESS_ENUMERATOR (enumerator);
924 GSimpleAsyncResult *simple = G_SIMPLE_ASYNC_RESULT (result);
925 GSocketAddress *sockaddr;
927 if (g_simple_async_result_propagate_error (simple, error))
929 else if (!addr_enum->next)
933 sockaddr = addr_enum->next->data;
934 addr_enum->next = addr_enum->next->next;
935 return g_object_ref (sockaddr);
940 _g_network_address_address_enumerator_init (GNetworkAddressAddressEnumerator *enumerator)
945 _g_network_address_address_enumerator_class_init (GNetworkAddressAddressEnumeratorClass *addrenum_class)
947 GObjectClass *object_class = G_OBJECT_CLASS (addrenum_class);
948 GSocketAddressEnumeratorClass *enumerator_class =
949 G_SOCKET_ADDRESS_ENUMERATOR_CLASS (addrenum_class);
951 enumerator_class->next = g_network_address_address_enumerator_next;
952 enumerator_class->next_async = g_network_address_address_enumerator_next_async;
953 enumerator_class->next_finish = g_network_address_address_enumerator_next_finish;
954 object_class->finalize = g_network_address_address_enumerator_finalize;
957 static GSocketAddressEnumerator *
958 g_network_address_connectable_enumerate (GSocketConnectable *connectable)
960 GNetworkAddressAddressEnumerator *addr_enum;
962 addr_enum = g_object_new (G_TYPE_NETWORK_ADDRESS_ADDRESS_ENUMERATOR, NULL);
963 addr_enum->addr = g_object_ref (connectable);
965 return (GSocketAddressEnumerator *)addr_enum;
968 static GSocketAddressEnumerator *
969 g_network_address_connectable_proxy_enumerate (GSocketConnectable *connectable)
971 GNetworkAddress *self = G_NETWORK_ADDRESS (connectable);
972 GSocketAddressEnumerator *proxy_enum;
975 uri = _g_uri_from_authority (self->priv->scheme ? self->priv->scheme : "none",
976 self->priv->hostname,
980 proxy_enum = g_object_new (G_TYPE_PROXY_ADDRESS_ENUMERATOR,
981 "connectable", connectable,