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 "gresolver.h"
33 #include "gsimpleasyncresult.h"
34 #include "gsocketaddressenumerator.h"
36 #include "gsocketconnectable.h"
41 #ifdef HAVE_WINSOCK2_H
50 * SECTION:gnetworkaddress
51 * @short_description: a #GSocketConnectable for resolving hostnames
54 * #GNetworkAddress provides an easy way to resolve a hostname and
55 * then attempt to connect to that host, handling the possibility of
56 * multiple IP addresses and multiple address families.
58 * See #GSocketConnectable for and example of using the connectable
65 * A #GSocketConnectable for resolving a hostname and connecting to
69 struct _GNetworkAddressPrivate {
81 static void g_network_address_set_property (GObject *object,
85 static void g_network_address_get_property (GObject *object,
90 static void g_network_address_connectable_iface_init (GSocketConnectableIface *iface);
91 static GSocketAddressEnumerator *g_network_address_connectable_enumerate (GSocketConnectable *connectable);
93 G_DEFINE_TYPE_WITH_CODE (GNetworkAddress, g_network_address, G_TYPE_OBJECT,
94 G_IMPLEMENT_INTERFACE (G_TYPE_SOCKET_CONNECTABLE,
95 g_network_address_connectable_iface_init))
98 g_network_address_finalize (GObject *object)
100 GNetworkAddress *addr = G_NETWORK_ADDRESS (object);
102 g_free (addr->priv->hostname);
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"),
132 G_PARAM_READWRITE | G_PARAM_CONSTRUCT_ONLY));
133 g_object_class_install_property (gobject_class, PROP_PORT,
134 g_param_spec_uint ("port",
138 G_PARAM_READWRITE | G_PARAM_CONSTRUCT_ONLY));
142 g_network_address_connectable_iface_init (GSocketConnectableIface *connectable_iface)
144 connectable_iface->enumerate = g_network_address_connectable_enumerate;
148 g_network_address_init (GNetworkAddress *addr)
150 addr->priv = G_TYPE_INSTANCE_GET_PRIVATE (addr, G_TYPE_NETWORK_ADDRESS,
151 GNetworkAddressPrivate);
155 g_network_address_set_property (GObject *object,
160 GNetworkAddress *addr = G_NETWORK_ADDRESS (object);
165 if (addr->priv->hostname)
166 g_free (addr->priv->hostname);
167 addr->priv->hostname = g_value_dup_string (value);
171 addr->priv->port = g_value_get_uint (value);
175 G_OBJECT_WARN_INVALID_PROPERTY_ID (object, prop_id, pspec);
182 g_network_address_get_property (GObject *object,
187 GNetworkAddress *addr = G_NETWORK_ADDRESS (object);
192 g_value_set_string (value, addr->priv->hostname);
196 g_value_set_uint (value, addr->priv->port);
200 G_OBJECT_WARN_INVALID_PROPERTY_ID (object, prop_id, pspec);
207 g_network_address_set_addresses (GNetworkAddress *addr,
211 GSocketAddress *sockaddr;
213 g_return_if_fail (addresses != NULL && addr->priv->sockaddrs == NULL);
215 for (a = addresses; a; a = a->next)
217 sockaddr = g_inet_socket_address_new (a->data, addr->priv->port);
218 addr->priv->sockaddrs = g_list_prepend (addr->priv->sockaddrs, sockaddr);
219 g_object_unref (a->data);
221 g_list_free (addresses);
222 addr->priv->sockaddrs = g_list_reverse (addr->priv->sockaddrs);
226 * g_network_address_new:
227 * @hostname: the hostname
230 * Creates a new #GSocketConnectable for connecting to the given
231 * @hostname and @port.
233 * Return value: the new #GNetworkAddress
238 g_network_address_new (const gchar *hostname,
241 return g_object_new (G_TYPE_NETWORK_ADDRESS,
242 "hostname", hostname,
248 * g_network_address_parse:
249 * @host_and_port: the hostname and optionally a port
250 * @default_port: the default port if not in @host_and_port
251 * @error: a pointer to a #GError, or %NULL
253 * Creates a new #GSocketConnectable for connecting to the given
254 * @hostname and @port. May fail and return %NULL in case
255 * parsing @host_and_port fails.
257 * @host_and_port may be in any of a number of recognised formats: an IPv6
258 * address, an IPv4 address, or a domain name (in which case a DNS
259 * lookup is performed). Quoting with [] is supported for all address
260 * types. A port override may be specified in the usual way with a
261 * colon. Ports may be given as decimal numbers or symbolic names (in
262 * which case an /etc/services lookup is performed).
264 * If no port is specified in @host_and_port then @default_port will be
265 * used as the port number to connect to.
267 * In general, @host_and_port is expected to be provided by the user (allowing
268 * them to give the hostname, and a port overide if necessary) and
269 * @default_port is expected to be provided by the application.
271 * Return value: the new #GNetworkAddress, or %NULL on error
276 g_network_address_parse (const char *host_and_port,
277 guint16 default_port,
280 GSocketConnectable *connectable;
285 g_return_val_if_fail (host_and_port != NULL, NULL);
288 if (host_and_port[0] == '[')
289 /* escaped host part (to allow, eg. "[2001:db8::1]:888") */
293 end = strchr (host_and_port, ']');
296 g_set_error (error, G_IO_ERROR, G_IO_ERROR_INVALID_ARGUMENT,
297 _("Hostname '%s' contains '[' but not ']'"), host_and_port);
303 else if (end[1] == ':')
307 g_set_error (error, G_IO_ERROR, G_IO_ERROR_INVALID_ARGUMENT,
308 "The ']' character (in hostname '%s') must come at the"
309 " end or be immediately followed by ':' and a port",
314 name = g_strndup (host_and_port + 1, end - host_and_port - 1);
317 else if ((port = strchr (host_and_port, ':')))
318 /* string has a ':' in it */
323 if (strchr (port, ':'))
324 /* more than one ':' in string */
326 /* this is actually an unescaped IPv6 address */
327 name = g_strdup (host_and_port);
331 name = g_strndup (host_and_port, port - host_and_port - 1);
335 /* plain hostname, no port */
336 name = g_strdup (host_and_port);
342 g_set_error (error, G_IO_ERROR, G_IO_ERROR_INVALID_ARGUMENT,
343 "If a ':' character is given, it must be followed by a "
344 "port (in hostname '%s').", host_and_port);
349 else if ('0' <= port[0] && port[0] <= '9')
354 value = strtol (port, &end, 10);
355 if (*end != '\0' || value < 0 || value > G_MAXUINT16)
357 g_set_error (error, G_IO_ERROR, G_IO_ERROR_INVALID_ARGUMENT,
358 "Invalid numeric port '%s' specified in hostname '%s'",
359 port, host_and_port);
369 struct servent *entry;
371 entry = getservbyname (port, "tcp");
374 g_set_error (error, G_IO_ERROR, G_IO_ERROR_INVALID_ARGUMENT,
375 "Unknown service '%s' specified in hostname '%s'",
376 port, host_and_port);
377 #ifdef HAVE_ENDSERVENT
384 portnum = g_ntohs (entry->s_port);
386 #ifdef HAVE_ENDSERVENT
393 /* No port in host_and_port */
394 portnum = default_port;
397 connectable = g_network_address_new (name, portnum);
404 * g_network_address_get_hostname:
405 * @addr: a #GNetworkAddress
407 * Gets @addr's hostname. This might be either UTF-8 or ASCII-encoded,
408 * depending on what @addr was created with.
410 * Return value: @addr's hostname
415 g_network_address_get_hostname (GNetworkAddress *addr)
417 g_return_val_if_fail (G_IS_NETWORK_ADDRESS (addr), NULL);
419 return addr->priv->hostname;
423 * g_network_address_get_port:
424 * @addr: a #GNetworkAddress
426 * Gets @addr's port number
428 * Return value: @addr's port (which may be %0)
433 g_network_address_get_port (GNetworkAddress *addr)
435 g_return_val_if_fail (G_IS_NETWORK_ADDRESS (addr), 0);
437 return addr->priv->port;
440 #define G_TYPE_NETWORK_ADDRESS_ADDRESS_ENUMERATOR (_g_network_address_address_enumerator_get_type ())
441 #define G_NETWORK_ADDRESS_ADDRESS_ENUMERATOR(obj) (G_TYPE_CHECK_INSTANCE_CAST ((obj), G_TYPE_NETWORK_ADDRESS_ADDRESS_ENUMERATOR, GNetworkAddressAddressEnumerator))
444 GSocketAddressEnumerator parent_instance;
446 GNetworkAddress *addr;
448 } GNetworkAddressAddressEnumerator;
451 GSocketAddressEnumeratorClass parent_class;
453 } GNetworkAddressAddressEnumeratorClass;
455 G_DEFINE_TYPE (GNetworkAddressAddressEnumerator, _g_network_address_address_enumerator, G_TYPE_SOCKET_ADDRESS_ENUMERATOR)
458 g_network_address_address_enumerator_finalize (GObject *object)
460 GNetworkAddressAddressEnumerator *addr_enum =
461 G_NETWORK_ADDRESS_ADDRESS_ENUMERATOR (object);
463 g_object_unref (addr_enum->addr);
465 G_OBJECT_CLASS (_g_network_address_address_enumerator_parent_class)->finalize (object);
468 static GSocketAddress *
469 g_network_address_address_enumerator_next (GSocketAddressEnumerator *enumerator,
470 GCancellable *cancellable,
473 GNetworkAddressAddressEnumerator *addr_enum =
474 G_NETWORK_ADDRESS_ADDRESS_ENUMERATOR (enumerator);
475 GSocketAddress *sockaddr;
477 if (!addr_enum->addr->priv->sockaddrs)
479 GResolver *resolver = g_resolver_get_default ();
482 addresses = g_resolver_lookup_by_name (resolver,
483 addr_enum->addr->priv->hostname,
485 g_object_unref (resolver);
490 g_network_address_set_addresses (addr_enum->addr, addresses);
491 addr_enum->a = addr_enum->addr->priv->sockaddrs;
498 sockaddr = addr_enum->a->data;
499 addr_enum->a = addr_enum->a->next;
500 return g_object_ref (sockaddr);
505 got_addresses (GObject *source_object,
506 GAsyncResult *result,
509 GSimpleAsyncResult *simple = user_data;
510 GNetworkAddressAddressEnumerator *addr_enum =
511 g_simple_async_result_get_op_res_gpointer (simple);
512 GResolver *resolver = G_RESOLVER (source_object);
514 GError *error = NULL;
516 addresses = g_resolver_lookup_by_name_finish (resolver, result, &error);
517 if (!addr_enum->addr->priv->sockaddrs)
521 g_simple_async_result_set_from_error (simple, error);
522 g_error_free (error);
526 g_network_address_set_addresses (addr_enum->addr, addresses);
527 addr_enum->a = addr_enum->addr->priv->sockaddrs;
531 g_error_free (error);
533 g_object_unref (resolver);
535 g_simple_async_result_complete (simple);
536 g_object_unref (simple);
540 g_network_address_address_enumerator_next_async (GSocketAddressEnumerator *enumerator,
541 GCancellable *cancellable,
542 GAsyncReadyCallback callback,
545 GNetworkAddressAddressEnumerator *addr_enum =
546 G_NETWORK_ADDRESS_ADDRESS_ENUMERATOR (enumerator);
547 GSimpleAsyncResult *simple;
548 GSocketAddress *sockaddr;
550 simple = g_simple_async_result_new (G_OBJECT (enumerator),
552 g_network_address_address_enumerator_next_async);
554 if (!addr_enum->addr->priv->sockaddrs)
556 GResolver *resolver = g_resolver_get_default ();
558 g_simple_async_result_set_op_res_gpointer (simple, g_object_ref (addr_enum), g_object_unref);
559 g_resolver_lookup_by_name_async (resolver,
560 addr_enum->addr->priv->hostname,
562 got_addresses, simple);
566 sockaddr = g_network_address_address_enumerator_next (enumerator, NULL, NULL);
568 g_simple_async_result_set_op_res_gpointer (simple, sockaddr, g_object_unref);
570 g_simple_async_result_complete_in_idle (simple);
571 g_object_unref (simple);
575 static GSocketAddress *
576 g_network_address_address_enumerator_next_finish (GSocketAddressEnumerator *enumerator,
577 GAsyncResult *result,
580 GNetworkAddressAddressEnumerator *addr_enum =
581 G_NETWORK_ADDRESS_ADDRESS_ENUMERATOR (enumerator);
582 GSimpleAsyncResult *simple = G_SIMPLE_ASYNC_RESULT (result);
583 GSocketAddress *sockaddr;
585 if (g_simple_async_result_propagate_error (simple, error))
587 else if (!addr_enum->a)
591 sockaddr = addr_enum->a->data;
592 addr_enum->a = addr_enum->a->next;
593 return g_object_ref (sockaddr);
598 _g_network_address_address_enumerator_init (GNetworkAddressAddressEnumerator *enumerator)
603 _g_network_address_address_enumerator_class_init (GNetworkAddressAddressEnumeratorClass *addrenum_class)
605 GObjectClass *object_class = G_OBJECT_CLASS (addrenum_class);
606 GSocketAddressEnumeratorClass *enumerator_class =
607 G_SOCKET_ADDRESS_ENUMERATOR_CLASS (addrenum_class);
609 enumerator_class->next = g_network_address_address_enumerator_next;
610 enumerator_class->next_async = g_network_address_address_enumerator_next_async;
611 enumerator_class->next_finish = g_network_address_address_enumerator_next_finish;
612 object_class->finalize = g_network_address_address_enumerator_finalize;
615 static GSocketAddressEnumerator *
616 g_network_address_connectable_enumerate (GSocketConnectable *connectable)
618 GNetworkAddressAddressEnumerator *addr_enum;
620 addr_enum = g_object_new (G_TYPE_NETWORK_ADDRESS_ADDRESS_ENUMERATOR, NULL);
621 addr_enum->addr = g_object_ref (connectable);
623 return (GSocketAddressEnumerator *)addr_enum;
626 #define __G_NETWORK_ADDRESS_C__
627 #include "gioaliasdef.c"