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.
27 #include "gnetworkservice.h"
29 #include "gcancellable.h"
30 #include "ginetaddress.h"
31 #include "ginetsocketaddress.h"
33 #include "gnetworkaddress.h"
34 #include "gresolver.h"
35 #include "gsimpleasyncresult.h"
36 #include "gsocketaddressenumerator.h"
37 #include "gsocketconnectable.h"
38 #include "gsrvtarget.h"
45 * SECTION:gnetworkservice
46 * @short_description: A GSocketConnectable for resolving SRV records
49 * Like #GNetworkAddress does with hostnames, #GNetworkService
50 * provides an easy way to resolve a SRV record, and then attempt to
51 * connect to one of the hosts that implements that service, handling
52 * service priority/weighting, multiple IP addresses, and multiple
55 * See #GSrvTarget for more information about SRV records, and see
56 * #GSocketConnectable for and example of using the connectable
63 * A #GSocketConnectable for resolving a SRV record and connecting to
67 struct _GNetworkServicePrivate
69 gchar *service, *protocol, *domain, *scheme;
81 static void g_network_service_set_property (GObject *object,
85 static void g_network_service_get_property (GObject *object,
90 static void g_network_service_connectable_iface_init (GSocketConnectableIface *iface);
91 static GSocketAddressEnumerator *g_network_service_connectable_enumerate (GSocketConnectable *connectable);
92 static GSocketAddressEnumerator *g_network_service_connectable_proxy_enumerate (GSocketConnectable *connectable);
94 G_DEFINE_TYPE_WITH_CODE (GNetworkService, g_network_service, G_TYPE_OBJECT,
95 G_IMPLEMENT_INTERFACE (G_TYPE_SOCKET_CONNECTABLE,
96 g_network_service_connectable_iface_init))
99 g_network_service_finalize (GObject *object)
101 GNetworkService *srv = G_NETWORK_SERVICE (object);
103 g_free (srv->priv->service);
104 g_free (srv->priv->protocol);
105 g_free (srv->priv->domain);
106 g_free (srv->priv->scheme);
108 if (srv->priv->targets)
109 g_resolver_free_targets (srv->priv->targets);
111 G_OBJECT_CLASS (g_network_service_parent_class)->finalize (object);
115 g_network_service_class_init (GNetworkServiceClass *klass)
117 GObjectClass *gobject_class = G_OBJECT_CLASS (klass);
119 g_type_class_add_private (klass, sizeof (GNetworkServicePrivate));
121 gobject_class->set_property = g_network_service_set_property;
122 gobject_class->get_property = g_network_service_get_property;
123 gobject_class->finalize = g_network_service_finalize;
125 g_object_class_install_property (gobject_class, PROP_SERVICE,
126 g_param_spec_string ("service",
128 P_("Service name, eg \"ldap\""),
131 G_PARAM_CONSTRUCT_ONLY |
132 G_PARAM_STATIC_STRINGS));
133 g_object_class_install_property (gobject_class, PROP_PROTOCOL,
134 g_param_spec_string ("protocol",
136 P_("Network protocol, eg \"tcp\""),
139 G_PARAM_CONSTRUCT_ONLY |
140 G_PARAM_STATIC_STRINGS));
141 g_object_class_install_property (gobject_class, PROP_DOMAIN,
142 g_param_spec_string ("domain",
144 P_("Network domain, eg, \"example.com\""),
147 G_PARAM_CONSTRUCT_ONLY |
148 G_PARAM_STATIC_STRINGS));
149 g_object_class_install_property (gobject_class, PROP_DOMAIN,
150 g_param_spec_string ("scheme",
152 P_("Network scheme (default is to use service)"),
155 G_PARAM_STATIC_STRINGS));
160 g_network_service_connectable_iface_init (GSocketConnectableIface *connectable_iface)
162 connectable_iface->enumerate = g_network_service_connectable_enumerate;
163 connectable_iface->proxy_enumerate = g_network_service_connectable_proxy_enumerate;
167 g_network_service_init (GNetworkService *srv)
169 srv->priv = G_TYPE_INSTANCE_GET_PRIVATE (srv, G_TYPE_NETWORK_SERVICE,
170 GNetworkServicePrivate);
174 g_network_service_set_property (GObject *object,
179 GNetworkService *srv = G_NETWORK_SERVICE (object);
184 srv->priv->service = g_value_dup_string (value);
188 srv->priv->protocol = g_value_dup_string (value);
192 srv->priv->domain = g_value_dup_string (value);
196 g_network_service_set_scheme (srv, g_value_get_string (value));
200 G_OBJECT_WARN_INVALID_PROPERTY_ID (object, prop_id, pspec);
206 g_network_service_get_property (GObject *object,
211 GNetworkService *srv = G_NETWORK_SERVICE (object);
216 g_value_set_string (value, g_network_service_get_service (srv));
220 g_value_set_string (value, g_network_service_get_protocol (srv));
224 g_value_set_string (value, g_network_service_get_domain (srv));
228 g_value_set_string (value, g_network_service_get_scheme (srv));
232 G_OBJECT_WARN_INVALID_PROPERTY_ID (object, prop_id, pspec);
238 * g_network_service_new:
239 * @service: the service type to look up (eg, "ldap")
240 * @protocol: the networking protocol to use for @service (eg, "tcp")
241 * @domain: the DNS domain to look up the service in
243 * Creates a new #GNetworkService representing the given @service,
244 * @protocol, and @domain. This will initially be unresolved; use the
245 * #GSocketConnectable interface to resolve it.
247 * Return value: a new #GNetworkService
252 g_network_service_new (const gchar *service,
253 const gchar *protocol,
256 return g_object_new (G_TYPE_NETWORK_SERVICE,
258 "protocol", protocol,
264 * g_network_service_get_service:
265 * @srv: a #GNetworkService
267 * Gets @srv's service name (eg, "ldap").
269 * Return value: @srv's service name
274 g_network_service_get_service (GNetworkService *srv)
276 g_return_val_if_fail (G_IS_NETWORK_SERVICE (srv), NULL);
278 return srv->priv->service;
282 * g_network_service_get_protocol:
283 * @srv: a #GNetworkService
285 * Gets @srv's protocol name (eg, "tcp").
287 * Return value: @srv's protocol name
292 g_network_service_get_protocol (GNetworkService *srv)
294 g_return_val_if_fail (G_IS_NETWORK_SERVICE (srv), NULL);
296 return srv->priv->protocol;
300 * g_network_service_get_domain:
301 * @srv: a #GNetworkService
303 * Gets the domain that @srv serves. This might be either UTF-8 or
304 * ASCII-encoded, depending on what @srv was created with.
306 * Return value: @srv's domain name
311 g_network_service_get_domain (GNetworkService *srv)
313 g_return_val_if_fail (G_IS_NETWORK_SERVICE (srv), NULL);
315 return srv->priv->domain;
319 * g_network_service_get_scheme:
320 * @srv: a #GNetworkService
322 * Get's the URI scheme used to resolve proxies. By default, the service name
325 * Return value: @srv's scheme name
330 g_network_service_get_scheme (GNetworkService *srv)
332 g_return_val_if_fail (G_IS_NETWORK_SERVICE (srv), NULL);
334 if (srv->priv->scheme)
335 return srv->priv->scheme;
337 return srv->priv->service;
341 * g_network_service_set_scheme:
342 * @srv: a #GNetworkService
343 * @scheme: a URI scheme
345 * Set's the URI scheme used to resolve proxies. By default, the service name
351 g_network_service_set_scheme (GNetworkService *srv,
354 g_return_if_fail (G_IS_NETWORK_SERVICE (srv));
356 if (srv->priv->scheme)
357 g_free (srv->priv->scheme);
358 srv->priv->scheme = g_strdup (scheme);
360 g_object_notify (G_OBJECT (srv), "scheme");
364 #define G_TYPE_NETWORK_SERVICE_ADDRESS_ENUMERATOR (_g_network_service_address_enumerator_get_type ())
365 #define G_NETWORK_SERVICE_ADDRESS_ENUMERATOR(obj) (G_TYPE_CHECK_INSTANCE_CAST ((obj), G_TYPE_NETWORK_SERVICE_ADDRESS_ENUMERATOR, GNetworkServiceAddressEnumerator))
368 GSocketAddressEnumerator parent_instance;
371 GNetworkService *srv;
372 GSocketAddressEnumerator *addr_enum;
378 /* For async operation */
379 GCancellable *cancellable;
380 GSimpleAsyncResult *result;
381 } GNetworkServiceAddressEnumerator;
384 GSocketAddressEnumeratorClass parent_class;
386 } GNetworkServiceAddressEnumeratorClass;
388 G_DEFINE_TYPE (GNetworkServiceAddressEnumerator, _g_network_service_address_enumerator, G_TYPE_SOCKET_ADDRESS_ENUMERATOR)
390 static GSocketAddress *
391 g_network_service_address_enumerator_next (GSocketAddressEnumerator *enumerator,
392 GCancellable *cancellable,
395 GNetworkServiceAddressEnumerator *srv_enum =
396 G_NETWORK_SERVICE_ADDRESS_ENUMERATOR (enumerator);
397 GSocketAddress *ret = NULL;
399 /* If we haven't yet resolved srv, do that */
400 if (!srv_enum->srv->priv->targets)
404 targets = g_resolver_lookup_service (srv_enum->resolver,
405 srv_enum->srv->priv->service,
406 srv_enum->srv->priv->protocol,
407 srv_enum->srv->priv->domain,
412 srv_enum->srv->priv->targets = targets;
413 srv_enum->t = srv_enum->srv->priv->targets;
416 /* Delegate to GNetworkAddress */
419 if (srv_enum->addr_enum == NULL && srv_enum->t)
421 GError *error = NULL;
424 GSocketConnectable *addr;
425 GSrvTarget *target = srv_enum->t->data;
427 srv_enum->t = g_list_next (srv_enum->t);
429 hostname = g_hostname_to_ascii (g_srv_target_get_hostname (target));
431 if (hostname == NULL)
433 if (srv_enum->error == NULL)
435 g_error_new (G_IO_ERROR, G_IO_ERROR_INVALID_ARGUMENT,
436 "Received invalid hostname '%s' from GSrvTarget",
437 g_srv_target_get_hostname (target));
441 uri = g_strdup_printf ("%s://%s:%u",
442 g_network_service_get_scheme (srv_enum->srv),
444 g_srv_target_get_port (target));
447 addr = g_network_address_parse_uri (uri,
448 g_srv_target_get_port (target),
454 if (srv_enum->error == NULL)
455 srv_enum->error = error;
459 if (srv_enum->use_proxy)
460 srv_enum->addr_enum = g_socket_connectable_proxy_enumerate (addr);
462 srv_enum->addr_enum = g_socket_connectable_enumerate (addr);
463 g_object_unref (addr);
466 if (srv_enum->addr_enum)
468 GError *error = NULL;
470 ret = g_socket_address_enumerator_next (srv_enum->addr_enum,
476 if (srv_enum->error == NULL)
477 srv_enum->error = error;
479 g_error_free (error);
481 g_object_unref (srv_enum->addr_enum);
482 srv_enum->addr_enum = NULL;
486 while (srv_enum->addr_enum == NULL && srv_enum->t);
488 if (ret == NULL && srv_enum->error)
490 g_propagate_error (error, srv_enum->error);
491 srv_enum->error = NULL;
497 static void next_async_resolved_targets (GObject *source_object,
498 GAsyncResult *result,
500 static void next_async_have_targets (GNetworkServiceAddressEnumerator *srv_enum);
501 static void next_async_have_address (GObject *source_object,
502 GAsyncResult *result,
506 g_network_service_address_enumerator_next_async (GSocketAddressEnumerator *enumerator,
507 GCancellable *cancellable,
508 GAsyncReadyCallback callback,
511 GNetworkServiceAddressEnumerator *srv_enum =
512 G_NETWORK_SERVICE_ADDRESS_ENUMERATOR (enumerator);
514 g_return_if_fail (srv_enum->result == NULL);
516 srv_enum->result = g_simple_async_result_new (G_OBJECT (enumerator),
518 g_network_service_address_enumerator_next_async);
521 srv_enum->cancellable = g_object_ref (cancellable);
523 /* If we haven't yet resolved srv, do that */
524 if (!srv_enum->srv->priv->targets)
526 g_resolver_lookup_service_async (srv_enum->resolver,
527 srv_enum->srv->priv->service,
528 srv_enum->srv->priv->protocol,
529 srv_enum->srv->priv->domain,
531 next_async_resolved_targets,
535 next_async_have_targets (srv_enum);
539 next_async_resolved_targets (GObject *source_object,
540 GAsyncResult *result,
543 GNetworkServiceAddressEnumerator *srv_enum = user_data;
544 GError *error = NULL;
546 srv_enum->srv->priv->targets =
547 g_resolver_lookup_service_finish (srv_enum->resolver, result, &error);
551 GSimpleAsyncResult *simple = srv_enum->result;
553 srv_enum->result = NULL;
554 g_simple_async_result_set_from_error (simple, error);
555 g_error_free (error);
556 g_simple_async_result_complete (simple);
557 g_object_unref (simple);
561 srv_enum->t = srv_enum->srv->priv->targets;
562 next_async_have_targets (srv_enum);
567 next_async_have_targets (GNetworkServiceAddressEnumerator *srv_enum)
569 /* Delegate to GNetworkAddress */
570 if (srv_enum->addr_enum == NULL && srv_enum->t)
572 GSocketConnectable *addr;
573 GSrvTarget *target = srv_enum->t->data;
575 srv_enum->t = g_list_next (srv_enum->t);
576 addr = g_network_address_new (g_srv_target_get_hostname (target),
577 (guint16) g_srv_target_get_port (target));
579 if (srv_enum->use_proxy)
580 srv_enum->addr_enum = g_socket_connectable_proxy_enumerate (addr);
582 srv_enum->addr_enum = g_socket_connectable_enumerate (addr);
584 g_object_unref (addr);
587 if (srv_enum->addr_enum)
589 g_socket_address_enumerator_next_async (srv_enum->addr_enum,
590 srv_enum->cancellable,
591 next_async_have_address,
596 GSimpleAsyncResult *simple = srv_enum->result;
597 srv_enum->result = NULL;
601 g_simple_async_result_set_from_error (simple, srv_enum->error);
602 g_error_free (srv_enum->error);
603 srv_enum->error = NULL;
606 g_simple_async_result_complete (simple);
607 g_object_unref (simple);
612 next_async_have_address (GObject *source_object,
613 GAsyncResult *result,
616 GNetworkServiceAddressEnumerator *srv_enum = user_data;
617 GSocketAddress *address;
618 GError *error = NULL;
620 address = g_socket_address_enumerator_next_finish (srv_enum->addr_enum,
626 if (srv_enum->error == NULL)
627 srv_enum->error = error;
629 g_error_free (error);
631 g_object_unref (srv_enum->addr_enum);
632 srv_enum->addr_enum = NULL;
634 next_async_have_targets (srv_enum);
638 GSimpleAsyncResult *simple = srv_enum->result;
640 srv_enum->result = NULL;
643 g_simple_async_result_set_op_res_gpointer (simple,
644 address, g_object_unref);
646 g_simple_async_result_complete (simple);
647 g_object_unref (simple);
651 static GSocketAddress *
652 g_network_service_address_enumerator_next_finish (GSocketAddressEnumerator *enumerator,
653 GAsyncResult *result,
656 GSimpleAsyncResult *simple = G_SIMPLE_ASYNC_RESULT (result);
657 GSocketAddress *sockaddr;
659 if (g_simple_async_result_propagate_error (simple, error))
662 sockaddr = g_simple_async_result_get_op_res_gpointer (simple);
663 return sockaddr ? g_object_ref (sockaddr) : NULL;
667 _g_network_service_address_enumerator_init (GNetworkServiceAddressEnumerator *enumerator)
672 g_network_service_address_enumerator_finalize (GObject *object)
674 GNetworkServiceAddressEnumerator *srv_enum =
675 G_NETWORK_SERVICE_ADDRESS_ENUMERATOR (object);
678 g_object_unref (srv_enum->srv);
680 if (srv_enum->addr_enum)
681 g_object_unref (srv_enum->addr_enum);
683 if (srv_enum->resolver)
684 g_object_unref (srv_enum->resolver);
686 if (srv_enum->result)
687 g_object_unref (srv_enum->result);
689 if (srv_enum->cancellable)
690 g_object_unref (srv_enum->cancellable);
693 g_error_free (srv_enum->error);
695 G_OBJECT_CLASS (_g_network_service_address_enumerator_parent_class)->finalize (object);
699 _g_network_service_address_enumerator_class_init (GNetworkServiceAddressEnumeratorClass *srvenum_class)
701 GObjectClass *object_class = G_OBJECT_CLASS (srvenum_class);
702 GSocketAddressEnumeratorClass *enumerator_class =
703 G_SOCKET_ADDRESS_ENUMERATOR_CLASS (srvenum_class);
705 enumerator_class->next = g_network_service_address_enumerator_next;
706 enumerator_class->next_async = g_network_service_address_enumerator_next_async;
707 enumerator_class->next_finish = g_network_service_address_enumerator_next_finish;
709 object_class->finalize = g_network_service_address_enumerator_finalize;
712 static GSocketAddressEnumerator *
713 g_network_service_connectable_enumerate (GSocketConnectable *connectable)
715 GNetworkServiceAddressEnumerator *srv_enum;
717 srv_enum = g_object_new (G_TYPE_NETWORK_SERVICE_ADDRESS_ENUMERATOR, NULL);
718 srv_enum->srv = g_object_ref (connectable);
719 srv_enum->resolver = g_resolver_get_default ();
720 srv_enum->use_proxy = FALSE;
722 return G_SOCKET_ADDRESS_ENUMERATOR (srv_enum);
725 static GSocketAddressEnumerator *
726 g_network_service_connectable_proxy_enumerate (GSocketConnectable *connectable)
728 GSocketAddressEnumerator *addr_enum;
729 GNetworkServiceAddressEnumerator *srv_enum;
731 addr_enum = g_network_service_connectable_enumerate (connectable);
732 srv_enum = G_NETWORK_SERVICE_ADDRESS_ENUMERATOR (addr_enum);
733 srv_enum->use_proxy = TRUE;