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"
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 {
69 gint64 resolver_serial;
79 static void g_network_address_set_property (GObject *object,
83 static void g_network_address_get_property (GObject *object,
88 static void g_network_address_connectable_iface_init (GSocketConnectableIface *iface);
89 static GSocketAddressEnumerator *g_network_address_connectable_enumerate (GSocketConnectable *connectable);
90 static GSocketAddressEnumerator *g_network_address_connectable_proxy_enumerate (GSocketConnectable *connectable);
92 G_DEFINE_TYPE_WITH_CODE (GNetworkAddress, g_network_address, G_TYPE_OBJECT,
93 G_IMPLEMENT_INTERFACE (G_TYPE_SOCKET_CONNECTABLE,
94 g_network_address_connectable_iface_init))
97 g_network_address_finalize (GObject *object)
99 GNetworkAddress *addr = G_NETWORK_ADDRESS (object);
101 g_free (addr->priv->hostname);
102 g_free (addr->priv->scheme);
104 if (addr->priv->sockaddrs)
108 for (a = addr->priv->sockaddrs; a; a = a->next)
109 g_object_unref (a->data);
110 g_list_free (addr->priv->sockaddrs);
113 G_OBJECT_CLASS (g_network_address_parent_class)->finalize (object);
117 g_network_address_class_init (GNetworkAddressClass *klass)
119 GObjectClass *gobject_class = G_OBJECT_CLASS (klass);
121 g_type_class_add_private (klass, sizeof (GNetworkAddressPrivate));
123 gobject_class->set_property = g_network_address_set_property;
124 gobject_class->get_property = g_network_address_get_property;
125 gobject_class->finalize = g_network_address_finalize;
127 g_object_class_install_property (gobject_class, PROP_HOSTNAME,
128 g_param_spec_string ("hostname",
130 P_("Hostname to resolve"),
133 G_PARAM_CONSTRUCT_ONLY |
134 G_PARAM_STATIC_STRINGS));
135 g_object_class_install_property (gobject_class, PROP_PORT,
136 g_param_spec_uint ("port",
141 G_PARAM_CONSTRUCT_ONLY |
142 G_PARAM_STATIC_STRINGS));
144 g_object_class_install_property (gobject_class, PROP_SCHEME,
145 g_param_spec_string ("scheme",
150 G_PARAM_CONSTRUCT_ONLY |
151 G_PARAM_STATIC_STRINGS));
155 g_network_address_connectable_iface_init (GSocketConnectableIface *connectable_iface)
157 connectable_iface->enumerate = g_network_address_connectable_enumerate;
158 connectable_iface->proxy_enumerate = g_network_address_connectable_proxy_enumerate;
162 g_network_address_init (GNetworkAddress *addr)
164 addr->priv = G_TYPE_INSTANCE_GET_PRIVATE (addr, G_TYPE_NETWORK_ADDRESS,
165 GNetworkAddressPrivate);
169 g_network_address_set_property (GObject *object,
174 GNetworkAddress *addr = G_NETWORK_ADDRESS (object);
179 g_free (addr->priv->hostname);
180 addr->priv->hostname = g_value_dup_string (value);
184 addr->priv->port = g_value_get_uint (value);
188 if (addr->priv->scheme)
189 g_free (addr->priv->scheme);
190 addr->priv->scheme = g_value_dup_string (value);
194 G_OBJECT_WARN_INVALID_PROPERTY_ID (object, prop_id, pspec);
201 g_network_address_get_property (GObject *object,
206 GNetworkAddress *addr = G_NETWORK_ADDRESS (object);
211 g_value_set_string (value, addr->priv->hostname);
215 g_value_set_uint (value, addr->priv->port);
219 g_value_set_string (value, addr->priv->scheme);
223 G_OBJECT_WARN_INVALID_PROPERTY_ID (object, prop_id, pspec);
230 g_network_address_set_addresses (GNetworkAddress *addr,
232 guint64 resolver_serial)
235 GSocketAddress *sockaddr;
237 g_return_if_fail (addresses != NULL && addr->priv->sockaddrs == NULL);
239 for (a = addresses; a; a = a->next)
241 sockaddr = g_inet_socket_address_new (a->data, addr->priv->port);
242 addr->priv->sockaddrs = g_list_prepend (addr->priv->sockaddrs, sockaddr);
243 g_object_unref (a->data);
245 g_list_free (addresses);
246 addr->priv->sockaddrs = g_list_reverse (addr->priv->sockaddrs);
248 addr->priv->resolver_serial = resolver_serial;
252 g_network_address_parse_sockaddr (GNetworkAddress *addr)
254 struct addrinfo hints, *res = NULL;
255 GSocketAddress *sockaddr;
258 memset (&hints, 0, sizeof (hints));
259 hints.ai_flags = AI_NUMERICHOST
260 #ifdef AI_NUMERICSERV
264 g_snprintf (port, sizeof (port), "%u", addr->priv->port);
266 if (getaddrinfo (addr->priv->hostname, port, &hints, &res) != 0)
269 sockaddr = g_socket_address_new_from_native (res->ai_addr, res->ai_addrlen);
271 if (!sockaddr || !G_IS_INET_SOCKET_ADDRESS (sockaddr))
274 addr->priv->sockaddrs = g_list_prepend (addr->priv->sockaddrs, sockaddr);
279 * g_network_address_new:
280 * @hostname: the hostname
283 * Creates a new #GSocketConnectable for connecting to the given
284 * @hostname and @port.
286 * Return value: (transfer full) (type GNetworkAddress): the new #GNetworkAddress
291 g_network_address_new (const gchar *hostname,
294 return g_object_new (G_TYPE_NETWORK_ADDRESS,
295 "hostname", hostname,
301 * g_network_address_parse:
302 * @host_and_port: the hostname and optionally a port
303 * @default_port: the default port if not in @host_and_port
304 * @error: a pointer to a #GError, or %NULL
306 * Creates a new #GSocketConnectable for connecting to the given
307 * @hostname and @port. May fail and return %NULL in case
308 * parsing @host_and_port fails.
310 * @host_and_port may be in any of a number of recognised formats; an IPv6
311 * address, an IPv4 address, or a domain name (in which case a DNS
312 * lookup is performed). Quoting with [] is supported for all address
313 * types. A port override may be specified in the usual way with a
316 * If no port is specified in @host_and_port then @default_port will be
317 * used as the port number to connect to.
319 * In general, @host_and_port is expected to be provided by the user
320 * (allowing them to give the hostname, and a port overide if necessary)
321 * and @default_port is expected to be provided by the application.
323 * (The port component of @host_and_port can also be specified as a
324 * service name rather than as a numeric port, but this functionality
325 * is deprecated, because it depends on the contents of /etc/services,
326 * which is generally quite sparse on platforms other than Linux.)
328 * Return value: (transfer full): the new #GNetworkAddress, or %NULL on error
333 g_network_address_parse (const gchar *host_and_port,
334 guint16 default_port,
337 GSocketConnectable *connectable;
342 g_return_val_if_fail (host_and_port != NULL, NULL);
345 if (host_and_port[0] == '[')
346 /* escaped host part (to allow, eg. "[2001:db8::1]:888") */
350 end = strchr (host_and_port, ']');
353 g_set_error (error, G_IO_ERROR, G_IO_ERROR_INVALID_ARGUMENT,
354 _("Hostname '%s' contains '[' but not ']'"), host_and_port);
360 else if (end[1] == ':')
364 g_set_error (error, G_IO_ERROR, G_IO_ERROR_INVALID_ARGUMENT,
365 "The ']' character (in hostname '%s') must come at the"
366 " end or be immediately followed by ':' and a port",
371 name = g_strndup (host_and_port + 1, end - host_and_port - 1);
374 else if ((port = strchr (host_and_port, ':')))
375 /* string has a ':' in it */
380 if (strchr (port, ':'))
381 /* more than one ':' in string */
383 /* this is actually an unescaped IPv6 address */
384 name = g_strdup (host_and_port);
388 name = g_strndup (host_and_port, port - host_and_port - 1);
392 /* plain hostname, no port */
393 name = g_strdup (host_and_port);
399 g_set_error (error, G_IO_ERROR, G_IO_ERROR_INVALID_ARGUMENT,
400 "If a ':' character is given, it must be followed by a "
401 "port (in hostname '%s').", host_and_port);
406 else if ('0' <= port[0] && port[0] <= '9')
411 value = strtol (port, &end, 10);
412 if (*end != '\0' || value < 0 || value > G_MAXUINT16)
414 g_set_error (error, G_IO_ERROR, G_IO_ERROR_INVALID_ARGUMENT,
415 "Invalid numeric port '%s' specified in hostname '%s'",
416 port, host_and_port);
426 struct servent *entry;
428 entry = getservbyname (port, "tcp");
431 g_set_error (error, G_IO_ERROR, G_IO_ERROR_INVALID_ARGUMENT,
432 "Unknown service '%s' specified in hostname '%s'",
433 port, host_and_port);
434 #ifdef HAVE_ENDSERVENT
441 portnum = g_ntohs (entry->s_port);
443 #ifdef HAVE_ENDSERVENT
450 /* No port in host_and_port */
451 portnum = default_port;
454 connectable = g_network_address_new (name, portnum);
460 /* Allowed characters outside alphanumeric for unreserved. */
461 #define G_URI_OTHER_UNRESERVED "-._~"
463 /* This or something equivalent will eventually go into glib/guri.h */
465 _g_uri_parse_authority (const char *uri,
471 const char *start, *p;
474 g_return_val_if_fail (uri != NULL, FALSE);
485 /* From RFC 3986 Decodes:
486 * URI = scheme ":" hier-part [ "?" query ] [ "#" fragment ]
487 * hier-part = "//" authority path-abempty
488 * path-abempty = *( "/" segment )
489 * authority = [ userinfo "@" ] host [ ":" port ]
492 /* Check we have a valid scheme */
493 tmp_str = g_uri_parse_scheme (uri);
501 * hier-part = "//" authority path-abempty
504 start = strstr (p, "//");
511 if (strchr (start, '@') != NULL)
514 * userinfo = *( unreserved / pct-encoded / sub-delims / ":" )
515 * unreserved = ALPHA / DIGIT / "-" / "." / "_" / "~"
516 * pct-encoded = "%" HEXDIG HEXDIG
529 if (!(g_ascii_isxdigit (p[0]) ||
530 g_ascii_isxdigit (p[1])))
538 /* unreserved / sub-delims / : */
539 if (!(g_ascii_isalnum (c) ||
540 strchr (G_URI_OTHER_UNRESERVED, c) ||
541 strchr (G_URI_RESERVED_CHARS_SUBCOMPONENT_DELIMITERS, c) ||
547 *userinfo = g_strndup (start, p - start - 1);
558 * host = IP-literal / IPv4address / reg-name
559 * reg-name = *( unreserved / pct-encoded / sub-delims )
562 /* If IPv6 or IPvFuture */
574 /* unreserved / sub-delims */
575 if (!(g_ascii_isalnum (c) ||
576 strchr (G_URI_OTHER_UNRESERVED, c) ||
577 strchr (G_URI_RESERVED_CHARS_SUBCOMPONENT_DELIMITERS, c) ||
599 if (!(g_ascii_isxdigit (p[0]) ||
600 g_ascii_isxdigit (p[1])))
608 /* unreserved / sub-delims */
609 if (!(g_ascii_isalnum (c) ||
610 strchr (G_URI_OTHER_UNRESERVED, c) ||
611 strchr (G_URI_RESERVED_CHARS_SUBCOMPONENT_DELIMITERS, c)))
617 *host = g_uri_unescape_segment (start, p - 1, NULL);
636 if (!g_ascii_isdigit (c))
639 tmp = (tmp * 10) + (c - '0');
645 *port = (guint16) tmp;
657 if (userinfo && *userinfo)
667 _g_uri_from_authority (const gchar *protocol,
670 const gchar *userinfo)
674 uri = g_string_new (protocol);
675 g_string_append (uri, "://");
679 g_string_append_uri_escaped (uri, userinfo, G_URI_RESERVED_CHARS_ALLOWED_IN_USERINFO, FALSE);
680 g_string_append_c (uri, '@');
683 if (g_hostname_is_non_ascii (host))
685 gchar *ace_encoded = g_hostname_to_ascii (host);
689 g_string_free (uri, TRUE);
692 g_string_append (uri, ace_encoded);
693 g_free (ace_encoded);
695 else if (strchr (host, ':'))
696 g_string_append_printf (uri, "[%s]", host);
698 g_string_append (uri, host);
701 g_string_append_printf (uri, ":%u", port);
703 return g_string_free (uri, FALSE);
707 * g_network_address_parse_uri:
708 * @uri: the hostname and optionally a port
709 * @default_port: The default port if none is found in the URI
710 * @error: a pointer to a #GError, or %NULL
712 * Creates a new #GSocketConnectable for connecting to the given
713 * @uri. May fail and return %NULL in case parsing @uri fails.
715 * Using this rather than g_network_address_new() or
716 * g_network_address_parse() allows #GSocketClient to determine
717 * when to use application-specific proxy protocols.
719 * Return value: (transfer full): the new #GNetworkAddress, or %NULL on error
724 g_network_address_parse_uri (const gchar *uri,
725 guint16 default_port,
728 GSocketConnectable *conn;
733 if (!_g_uri_parse_authority (uri, &hostname, &port, NULL))
735 g_set_error (error, G_IO_ERROR, G_IO_ERROR_INVALID_ARGUMENT,
744 scheme = g_uri_parse_scheme (uri);
746 conn = g_object_new (G_TYPE_NETWORK_ADDRESS,
747 "hostname", hostname,
759 * g_network_address_get_hostname:
760 * @addr: a #GNetworkAddress
762 * Gets @addr's hostname. This might be either UTF-8 or ASCII-encoded,
763 * depending on what @addr was created with.
765 * Return value: @addr's hostname
770 g_network_address_get_hostname (GNetworkAddress *addr)
772 g_return_val_if_fail (G_IS_NETWORK_ADDRESS (addr), NULL);
774 return addr->priv->hostname;
778 * g_network_address_get_port:
779 * @addr: a #GNetworkAddress
781 * Gets @addr's port number
783 * Return value: @addr's port (which may be 0)
788 g_network_address_get_port (GNetworkAddress *addr)
790 g_return_val_if_fail (G_IS_NETWORK_ADDRESS (addr), 0);
792 return addr->priv->port;
796 * g_network_address_get_scheme:
797 * @addr: a #GNetworkAddress
799 * Gets @addr's scheme
801 * Return value: @addr's scheme (%NULL if not built from URI)
806 g_network_address_get_scheme (GNetworkAddress *addr)
808 g_return_val_if_fail (G_IS_NETWORK_ADDRESS (addr), NULL);
810 return addr->priv->scheme;
813 #define G_TYPE_NETWORK_ADDRESS_ADDRESS_ENUMERATOR (_g_network_address_address_enumerator_get_type ())
814 #define G_NETWORK_ADDRESS_ADDRESS_ENUMERATOR(obj) (G_TYPE_CHECK_INSTANCE_CAST ((obj), G_TYPE_NETWORK_ADDRESS_ADDRESS_ENUMERATOR, GNetworkAddressAddressEnumerator))
817 GSocketAddressEnumerator parent_instance;
819 GNetworkAddress *addr;
822 } GNetworkAddressAddressEnumerator;
825 GSocketAddressEnumeratorClass parent_class;
827 } GNetworkAddressAddressEnumeratorClass;
829 static GType _g_network_address_address_enumerator_get_type (void);
830 G_DEFINE_TYPE (GNetworkAddressAddressEnumerator, _g_network_address_address_enumerator, G_TYPE_SOCKET_ADDRESS_ENUMERATOR)
833 g_network_address_address_enumerator_finalize (GObject *object)
835 GNetworkAddressAddressEnumerator *addr_enum =
836 G_NETWORK_ADDRESS_ADDRESS_ENUMERATOR (object);
838 g_object_unref (addr_enum->addr);
840 G_OBJECT_CLASS (_g_network_address_address_enumerator_parent_class)->finalize (object);
843 static GSocketAddress *
844 g_network_address_address_enumerator_next (GSocketAddressEnumerator *enumerator,
845 GCancellable *cancellable,
848 GNetworkAddressAddressEnumerator *addr_enum =
849 G_NETWORK_ADDRESS_ADDRESS_ENUMERATOR (enumerator);
850 GSocketAddress *sockaddr;
852 if (addr_enum->addresses == NULL)
854 GNetworkAddress *addr = addr_enum->addr;
855 GResolver *resolver = g_resolver_get_default ();
856 gint64 serial = g_resolver_get_serial (resolver);
858 if (addr->priv->resolver_serial != 0 &&
859 addr->priv->resolver_serial != serial)
861 /* Resolver has reloaded, discard cached addresses */
862 g_list_free_full (addr->priv->sockaddrs, g_object_unref);
863 addr->priv->sockaddrs = NULL;
866 if (!addr->priv->sockaddrs)
867 g_network_address_parse_sockaddr (addr);
868 if (!addr->priv->sockaddrs)
872 addresses = g_resolver_lookup_by_name (resolver,
873 addr->priv->hostname,
877 g_object_unref (resolver);
881 g_network_address_set_addresses (addr, addresses, serial);
884 addr_enum->addresses = addr->priv->sockaddrs;
885 addr_enum->next = addr_enum->addresses;
886 g_object_unref (resolver);
889 if (addr_enum->next == NULL)
892 sockaddr = addr_enum->next->data;
893 addr_enum->next = addr_enum->next->next;
894 return g_object_ref (sockaddr);
898 have_addresses (GNetworkAddressAddressEnumerator *addr_enum,
899 GTask *task, GError *error)
901 GSocketAddress *sockaddr;
903 addr_enum->addresses = addr_enum->addr->priv->sockaddrs;
904 addr_enum->next = addr_enum->addresses;
908 sockaddr = g_object_ref (addr_enum->next->data);
909 addr_enum->next = addr_enum->next->next;
915 g_task_return_error (task, error);
917 g_task_return_pointer (task, sockaddr, g_object_unref);
918 g_object_unref (task);
922 got_addresses (GObject *source_object,
923 GAsyncResult *result,
926 GTask *task = user_data;
927 GNetworkAddressAddressEnumerator *addr_enum = g_task_get_source_object (task);
928 GResolver *resolver = G_RESOLVER (source_object);
930 GError *error = NULL;
932 if (!addr_enum->addr->priv->sockaddrs)
934 addresses = g_resolver_lookup_by_name_finish (resolver, result, &error);
938 g_network_address_set_addresses (addr_enum->addr, addresses,
939 g_resolver_get_serial (resolver));
942 have_addresses (addr_enum, task, error);
946 g_network_address_address_enumerator_next_async (GSocketAddressEnumerator *enumerator,
947 GCancellable *cancellable,
948 GAsyncReadyCallback callback,
951 GNetworkAddressAddressEnumerator *addr_enum =
952 G_NETWORK_ADDRESS_ADDRESS_ENUMERATOR (enumerator);
953 GSocketAddress *sockaddr;
956 task = g_task_new (addr_enum, cancellable, callback, user_data);
958 if (addr_enum->addresses == NULL)
960 GNetworkAddress *addr = addr_enum->addr;
961 GResolver *resolver = g_resolver_get_default ();
962 gint64 serial = g_resolver_get_serial (resolver);
964 if (addr->priv->resolver_serial != 0 &&
965 addr->priv->resolver_serial != serial)
967 /* Resolver has reloaded, discard cached addresses */
968 g_list_free_full (addr->priv->sockaddrs, g_object_unref);
969 addr->priv->sockaddrs = NULL;
972 if (!addr->priv->sockaddrs)
974 if (g_network_address_parse_sockaddr (addr))
975 have_addresses (addr_enum, task, NULL);
978 g_resolver_lookup_by_name_async (resolver,
979 addr->priv->hostname,
981 got_addresses, task);
983 g_object_unref (resolver);
987 addr_enum->addresses = addr->priv->sockaddrs;
988 addr_enum->next = addr_enum->addresses;
989 g_object_unref (resolver);
994 sockaddr = g_object_ref (addr_enum->next->data);
995 addr_enum->next = addr_enum->next->next;
1000 g_task_return_pointer (task, sockaddr, g_object_unref);
1001 g_object_unref (task);
1004 static GSocketAddress *
1005 g_network_address_address_enumerator_next_finish (GSocketAddressEnumerator *enumerator,
1006 GAsyncResult *result,
1009 g_return_val_if_fail (g_task_is_valid (result, enumerator), NULL);
1011 return g_task_propagate_pointer (G_TASK (result), error);
1015 _g_network_address_address_enumerator_init (GNetworkAddressAddressEnumerator *enumerator)
1020 _g_network_address_address_enumerator_class_init (GNetworkAddressAddressEnumeratorClass *addrenum_class)
1022 GObjectClass *object_class = G_OBJECT_CLASS (addrenum_class);
1023 GSocketAddressEnumeratorClass *enumerator_class =
1024 G_SOCKET_ADDRESS_ENUMERATOR_CLASS (addrenum_class);
1026 enumerator_class->next = g_network_address_address_enumerator_next;
1027 enumerator_class->next_async = g_network_address_address_enumerator_next_async;
1028 enumerator_class->next_finish = g_network_address_address_enumerator_next_finish;
1029 object_class->finalize = g_network_address_address_enumerator_finalize;
1032 static GSocketAddressEnumerator *
1033 g_network_address_connectable_enumerate (GSocketConnectable *connectable)
1035 GNetworkAddressAddressEnumerator *addr_enum;
1037 addr_enum = g_object_new (G_TYPE_NETWORK_ADDRESS_ADDRESS_ENUMERATOR, NULL);
1038 addr_enum->addr = g_object_ref (connectable);
1040 return (GSocketAddressEnumerator *)addr_enum;
1043 static GSocketAddressEnumerator *
1044 g_network_address_connectable_proxy_enumerate (GSocketConnectable *connectable)
1046 GNetworkAddress *self = G_NETWORK_ADDRESS (connectable);
1047 GSocketAddressEnumerator *proxy_enum;
1050 uri = _g_uri_from_authority (self->priv->scheme ? self->priv->scheme : "none",
1051 self->priv->hostname,
1055 proxy_enum = g_object_new (G_TYPE_PROXY_ADDRESS_ENUMERATOR,
1056 "connectable", connectable,