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 "gresolver.h"
34 #include "gsimpleasyncresult.h"
35 #include "gsocketaddressenumerator.h"
37 #include "gsocketconnectable.h"
43 * SECTION:gnetworkaddress
44 * @short_description: A GSocketConnectable for resolving hostnames
47 * #GNetworkAddress provides an easy way to resolve a hostname and
48 * then attempt to connect to that host, handling the possibility of
49 * multiple IP addresses and multiple address families.
51 * See #GSocketConnectable for and example of using the connectable
58 * A #GSocketConnectable for resolving a hostname and connecting to
62 struct _GNetworkAddressPrivate {
76 static void g_network_address_set_property (GObject *object,
80 static void g_network_address_get_property (GObject *object,
85 static void g_network_address_connectable_iface_init (GSocketConnectableIface *iface);
86 static GSocketAddressEnumerator *g_network_address_connectable_enumerate (GSocketConnectable *connectable);
88 G_DEFINE_TYPE_WITH_CODE (GNetworkAddress, g_network_address, G_TYPE_OBJECT,
89 G_IMPLEMENT_INTERFACE (G_TYPE_SOCKET_CONNECTABLE,
90 g_network_address_connectable_iface_init))
93 g_network_address_finalize (GObject *object)
95 GNetworkAddress *addr = G_NETWORK_ADDRESS (object);
97 g_free (addr->priv->hostname);
98 g_free (addr->priv->scheme);
100 if (addr->priv->sockaddrs)
104 for (a = addr->priv->sockaddrs; a; a = a->next)
105 g_object_unref (a->data);
106 g_list_free (addr->priv->sockaddrs);
109 G_OBJECT_CLASS (g_network_address_parent_class)->finalize (object);
113 g_network_address_class_init (GNetworkAddressClass *klass)
115 GObjectClass *gobject_class = G_OBJECT_CLASS (klass);
117 g_type_class_add_private (klass, sizeof (GNetworkAddressPrivate));
119 gobject_class->set_property = g_network_address_set_property;
120 gobject_class->get_property = g_network_address_get_property;
121 gobject_class->finalize = g_network_address_finalize;
123 g_object_class_install_property (gobject_class, PROP_HOSTNAME,
124 g_param_spec_string ("hostname",
126 P_("Hostname to resolve"),
129 G_PARAM_CONSTRUCT_ONLY |
130 G_PARAM_STATIC_STRINGS));
131 g_object_class_install_property (gobject_class, PROP_PORT,
132 g_param_spec_uint ("port",
137 G_PARAM_CONSTRUCT_ONLY |
138 G_PARAM_STATIC_STRINGS));
140 g_object_class_install_property (gobject_class, PROP_SCHEME,
141 g_param_spec_string ("scheme",
146 G_PARAM_CONSTRUCT_ONLY |
147 G_PARAM_STATIC_STRINGS));
151 g_network_address_connectable_iface_init (GSocketConnectableIface *connectable_iface)
153 connectable_iface->enumerate = g_network_address_connectable_enumerate;
157 g_network_address_init (GNetworkAddress *addr)
159 addr->priv = G_TYPE_INSTANCE_GET_PRIVATE (addr, G_TYPE_NETWORK_ADDRESS,
160 GNetworkAddressPrivate);
164 g_network_address_set_property (GObject *object,
169 GNetworkAddress *addr = G_NETWORK_ADDRESS (object);
174 g_free (addr->priv->hostname);
175 addr->priv->hostname = g_value_dup_string (value);
179 addr->priv->port = g_value_get_uint (value);
183 if (addr->priv->scheme)
184 g_free (addr->priv->scheme);
185 addr->priv->scheme = g_value_dup_string (value);
189 G_OBJECT_WARN_INVALID_PROPERTY_ID (object, prop_id, pspec);
196 g_network_address_get_property (GObject *object,
201 GNetworkAddress *addr = G_NETWORK_ADDRESS (object);
206 g_value_set_string (value, addr->priv->hostname);
210 g_value_set_uint (value, addr->priv->port);
214 g_value_set_string (value, addr->priv->scheme);
218 G_OBJECT_WARN_INVALID_PROPERTY_ID (object, prop_id, pspec);
225 g_network_address_set_addresses (GNetworkAddress *addr,
229 GSocketAddress *sockaddr;
231 g_return_if_fail (addresses != NULL && addr->priv->sockaddrs == NULL);
233 for (a = addresses; a; a = a->next)
235 sockaddr = g_inet_socket_address_new (a->data, addr->priv->port);
236 addr->priv->sockaddrs = g_list_prepend (addr->priv->sockaddrs, sockaddr);
237 g_object_unref (a->data);
239 g_list_free (addresses);
240 addr->priv->sockaddrs = g_list_reverse (addr->priv->sockaddrs);
244 * g_network_address_new:
245 * @hostname: the hostname
248 * Creates a new #GSocketConnectable for connecting to the given
249 * @hostname and @port.
251 * Return value: the new #GNetworkAddress
256 g_network_address_new (const gchar *hostname,
259 return g_object_new (G_TYPE_NETWORK_ADDRESS,
260 "hostname", hostname,
266 * g_network_address_parse:
267 * @host_and_port: the hostname and optionally a port
268 * @default_port: the default port if not in @host_and_port
269 * @error: a pointer to a #GError, or %NULL
271 * Creates a new #GSocketConnectable for connecting to the given
272 * @hostname and @port. May fail and return %NULL in case
273 * parsing @host_and_port fails.
275 * @host_and_port may be in any of a number of recognised formats: an IPv6
276 * address, an IPv4 address, or a domain name (in which case a DNS
277 * lookup is performed). Quoting with [] is supported for all address
278 * types. A port override may be specified in the usual way with a
279 * colon. Ports may be given as decimal numbers or symbolic names (in
280 * which case an /etc/services lookup is performed).
282 * If no port is specified in @host_and_port then @default_port will be
283 * used as the port number to connect to.
285 * In general, @host_and_port is expected to be provided by the user
286 * (allowing them to give the hostname, and a port overide if necessary)
287 * and @default_port is expected to be provided by the application.
289 * Return value: the new #GNetworkAddress, or %NULL on error
294 g_network_address_parse (const gchar *host_and_port,
295 guint16 default_port,
298 GSocketConnectable *connectable;
303 g_return_val_if_fail (host_and_port != NULL, NULL);
306 if (host_and_port[0] == '[')
307 /* escaped host part (to allow, eg. "[2001:db8::1]:888") */
311 end = strchr (host_and_port, ']');
314 g_set_error (error, G_IO_ERROR, G_IO_ERROR_INVALID_ARGUMENT,
315 _("Hostname '%s' contains '[' but not ']'"), host_and_port);
321 else if (end[1] == ':')
325 g_set_error (error, G_IO_ERROR, G_IO_ERROR_INVALID_ARGUMENT,
326 "The ']' character (in hostname '%s') must come at the"
327 " end or be immediately followed by ':' and a port",
332 name = g_strndup (host_and_port + 1, end - host_and_port - 1);
335 else if ((port = strchr (host_and_port, ':')))
336 /* string has a ':' in it */
341 if (strchr (port, ':'))
342 /* more than one ':' in string */
344 /* this is actually an unescaped IPv6 address */
345 name = g_strdup (host_and_port);
349 name = g_strndup (host_and_port, port - host_and_port - 1);
353 /* plain hostname, no port */
354 name = g_strdup (host_and_port);
360 g_set_error (error, G_IO_ERROR, G_IO_ERROR_INVALID_ARGUMENT,
361 "If a ':' character is given, it must be followed by a "
362 "port (in hostname '%s').", host_and_port);
367 else if ('0' <= port[0] && port[0] <= '9')
372 value = strtol (port, &end, 10);
373 if (*end != '\0' || value < 0 || value > G_MAXUINT16)
375 g_set_error (error, G_IO_ERROR, G_IO_ERROR_INVALID_ARGUMENT,
376 "Invalid numeric port '%s' specified in hostname '%s'",
377 port, host_and_port);
387 struct servent *entry;
389 entry = getservbyname (port, "tcp");
392 g_set_error (error, G_IO_ERROR, G_IO_ERROR_INVALID_ARGUMENT,
393 "Unknown service '%s' specified in hostname '%s'",
394 port, host_and_port);
395 #ifdef HAVE_ENDSERVENT
402 portnum = g_ntohs (entry->s_port);
404 #ifdef HAVE_ENDSERVENT
411 /* No port in host_and_port */
412 portnum = default_port;
415 connectable = g_network_address_new (name, portnum);
421 /* Allowed characters outside alphanumeric for unreserved. */
422 #define G_URI_OTHER_UNRESERVED "-._~"
424 /* This or something equivalent will eventually go into glib/guri.h */
426 _g_uri_parse_authority (const char *uri,
432 const char *start, *p;
435 g_return_val_if_fail (uri != NULL, FALSE);
446 /* From RFC 3986 Decodes:
447 * URI = scheme ":" hier-part [ "?" query ] [ "#" fragment ]
448 * hier-part = "//" authority path-abempty
449 * path-abempty = *( "/" segment )
450 * authority = [ userinfo "@" ] host [ ":" port ]
453 /* Check we have a valid scheme */
454 tmp_str = g_uri_parse_scheme (uri);
462 * hier-part = "//" authority path-abempty
465 start = strstr (p, "//");
471 p = strchr (start, '@');
476 * userinfo = *( unreserved / pct-encoded / sub-delims / ":" )
477 * unreserved = ALPHA / DIGIT / "-" / "." / "_" / "~"
478 * pct-encoded = "%" HEXDIG HEXDIG
490 if (!(g_ascii_isxdigit (p[0]) ||
491 g_ascii_isxdigit (p[1])))
499 /* unreserved / sub-delims / : */
500 if (!(g_ascii_isalnum(c) ||
501 strchr (G_URI_OTHER_UNRESERVED, c) ||
502 strchr (G_URI_RESERVED_CHARS_SUBCOMPONENT_DELIMITERS, c) ||
508 *userinfo = g_strndup (start, p - start - 1);
519 * host = IP-literal / IPv4address / reg-name
520 * reg-name = *( unreserved / pct-encoded / sub-delims )
523 /* If IPv6 or IPvFuture */
533 /* unreserved / sub-delims */
534 if (!(g_ascii_isalnum(c) ||
535 strchr (G_URI_OTHER_UNRESERVED, c) ||
536 strchr (G_URI_RESERVED_CHARS_SUBCOMPONENT_DELIMITERS, c) ||
558 if (!(g_ascii_isxdigit (p[0]) ||
559 g_ascii_isxdigit (p[1])))
567 /* unreserved / sub-delims */
568 if (!(g_ascii_isalnum(c) ||
569 strchr (G_URI_OTHER_UNRESERVED, c) ||
570 strchr (G_URI_RESERVED_CHARS_SUBCOMPONENT_DELIMITERS, c)))
576 *host = g_uri_unescape_segment (start, p - 1, NULL);
595 if (!g_ascii_isdigit (c))
598 tmp = (tmp * 10) + (c - '0');
604 *port = (guint16) tmp;
616 if (userinfo && *userinfo)
626 * g_network_address_parse_uri:
627 * @uri: the hostname and optionally a port
628 * @default_port: The default port if none is found in the URI
629 * @error: a pointer to a #GError, or %NULL
631 * Creates a new #GSocketConnectable for connecting to the given
632 * @uri. May fail and return %NULL in case parsing @uri fails.
634 * Using this rather than g_network_address_new() or
635 * g_network_address_parse_host() allows #GSocketClient to determine
636 * when to use application-specific proxy protocols.
638 * Return value: the new #GNetworkAddress, or %NULL on error
643 g_network_address_parse_uri (const gchar *uri,
644 guint16 default_port,
647 GSocketConnectable *conn;
652 if (!_g_uri_parse_authority (uri, &hostname, &port, NULL))
654 g_set_error (error, G_IO_ERROR, G_IO_ERROR_INVALID_ARGUMENT,
663 scheme = g_uri_parse_scheme (uri);
665 conn = g_object_new (G_TYPE_NETWORK_ADDRESS,
666 "hostname", hostname,
678 * g_network_address_get_hostname:
679 * @addr: a #GNetworkAddress
681 * Gets @addr's hostname. This might be either UTF-8 or ASCII-encoded,
682 * depending on what @addr was created with.
684 * Return value: @addr's hostname
689 g_network_address_get_hostname (GNetworkAddress *addr)
691 g_return_val_if_fail (G_IS_NETWORK_ADDRESS (addr), NULL);
693 return addr->priv->hostname;
697 * g_network_address_get_port:
698 * @addr: a #GNetworkAddress
700 * Gets @addr's port number
702 * Return value: @addr's port (which may be 0)
707 g_network_address_get_port (GNetworkAddress *addr)
709 g_return_val_if_fail (G_IS_NETWORK_ADDRESS (addr), 0);
711 return addr->priv->port;
715 * g_network_address_get_scheme:
716 * @addr: a #GNetworkAddress
718 * Gets @addr's scheme
720 * Return value: @addr's scheme (%NULL if not built from URI)
725 g_network_address_get_scheme (GNetworkAddress *addr)
727 g_return_val_if_fail (G_IS_NETWORK_ADDRESS (addr), NULL);
729 return addr->priv->scheme;
732 #define G_TYPE_NETWORK_ADDRESS_ADDRESS_ENUMERATOR (_g_network_address_address_enumerator_get_type ())
733 #define G_NETWORK_ADDRESS_ADDRESS_ENUMERATOR(obj) (G_TYPE_CHECK_INSTANCE_CAST ((obj), G_TYPE_NETWORK_ADDRESS_ADDRESS_ENUMERATOR, GNetworkAddressAddressEnumerator))
736 GSocketAddressEnumerator parent_instance;
738 GNetworkAddress *addr;
740 } GNetworkAddressAddressEnumerator;
743 GSocketAddressEnumeratorClass parent_class;
745 } GNetworkAddressAddressEnumeratorClass;
747 G_DEFINE_TYPE (GNetworkAddressAddressEnumerator, _g_network_address_address_enumerator, G_TYPE_SOCKET_ADDRESS_ENUMERATOR)
750 g_network_address_address_enumerator_finalize (GObject *object)
752 GNetworkAddressAddressEnumerator *addr_enum =
753 G_NETWORK_ADDRESS_ADDRESS_ENUMERATOR (object);
755 g_object_unref (addr_enum->addr);
757 G_OBJECT_CLASS (_g_network_address_address_enumerator_parent_class)->finalize (object);
760 static GSocketAddress *
761 g_network_address_address_enumerator_next (GSocketAddressEnumerator *enumerator,
762 GCancellable *cancellable,
765 GNetworkAddressAddressEnumerator *addr_enum =
766 G_NETWORK_ADDRESS_ADDRESS_ENUMERATOR (enumerator);
767 GSocketAddress *sockaddr;
769 if (!addr_enum->addr->priv->sockaddrs)
771 GResolver *resolver = g_resolver_get_default ();
774 addresses = g_resolver_lookup_by_name (resolver,
775 addr_enum->addr->priv->hostname,
777 g_object_unref (resolver);
782 g_network_address_set_addresses (addr_enum->addr, addresses);
783 addr_enum->a = addr_enum->addr->priv->sockaddrs;
790 sockaddr = addr_enum->a->data;
791 addr_enum->a = addr_enum->a->next;
792 return g_object_ref (sockaddr);
797 got_addresses (GObject *source_object,
798 GAsyncResult *result,
801 GSimpleAsyncResult *simple = user_data;
802 GNetworkAddressAddressEnumerator *addr_enum =
803 g_simple_async_result_get_op_res_gpointer (simple);
804 GResolver *resolver = G_RESOLVER (source_object);
806 GError *error = NULL;
808 addresses = g_resolver_lookup_by_name_finish (resolver, result, &error);
809 if (!addr_enum->addr->priv->sockaddrs)
813 g_simple_async_result_set_from_error (simple, error);
814 g_error_free (error);
818 g_network_address_set_addresses (addr_enum->addr, addresses);
819 addr_enum->a = addr_enum->addr->priv->sockaddrs;
823 g_error_free (error);
825 g_object_unref (resolver);
827 g_simple_async_result_complete (simple);
828 g_object_unref (simple);
832 g_network_address_address_enumerator_next_async (GSocketAddressEnumerator *enumerator,
833 GCancellable *cancellable,
834 GAsyncReadyCallback callback,
837 GNetworkAddressAddressEnumerator *addr_enum =
838 G_NETWORK_ADDRESS_ADDRESS_ENUMERATOR (enumerator);
839 GSimpleAsyncResult *simple;
841 simple = g_simple_async_result_new (G_OBJECT (enumerator),
843 g_network_address_address_enumerator_next_async);
845 if (!addr_enum->addr->priv->sockaddrs)
847 GResolver *resolver = g_resolver_get_default ();
849 g_simple_async_result_set_op_res_gpointer (simple, g_object_ref (addr_enum), g_object_unref);
850 g_resolver_lookup_by_name_async (resolver,
851 addr_enum->addr->priv->hostname,
853 got_addresses, simple);
857 g_simple_async_result_complete_in_idle (simple);
858 g_object_unref (simple);
862 static GSocketAddress *
863 g_network_address_address_enumerator_next_finish (GSocketAddressEnumerator *enumerator,
864 GAsyncResult *result,
867 GNetworkAddressAddressEnumerator *addr_enum =
868 G_NETWORK_ADDRESS_ADDRESS_ENUMERATOR (enumerator);
869 GSimpleAsyncResult *simple = G_SIMPLE_ASYNC_RESULT (result);
870 GSocketAddress *sockaddr;
872 if (g_simple_async_result_propagate_error (simple, error))
874 else if (!addr_enum->a)
878 sockaddr = addr_enum->a->data;
879 addr_enum->a = addr_enum->a->next;
880 return g_object_ref (sockaddr);
885 _g_network_address_address_enumerator_init (GNetworkAddressAddressEnumerator *enumerator)
890 _g_network_address_address_enumerator_class_init (GNetworkAddressAddressEnumeratorClass *addrenum_class)
892 GObjectClass *object_class = G_OBJECT_CLASS (addrenum_class);
893 GSocketAddressEnumeratorClass *enumerator_class =
894 G_SOCKET_ADDRESS_ENUMERATOR_CLASS (addrenum_class);
896 enumerator_class->next = g_network_address_address_enumerator_next;
897 enumerator_class->next_async = g_network_address_address_enumerator_next_async;
898 enumerator_class->next_finish = g_network_address_address_enumerator_next_finish;
899 object_class->finalize = g_network_address_address_enumerator_finalize;
902 static GSocketAddressEnumerator *
903 g_network_address_connectable_enumerate (GSocketConnectable *connectable)
905 GNetworkAddressAddressEnumerator *addr_enum;
907 addr_enum = g_object_new (G_TYPE_NETWORK_ADDRESS_ADDRESS_ENUMERATOR, NULL);
908 addr_enum->addr = g_object_ref (connectable);
910 return (GSocketAddressEnumerator *)addr_enum;