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 "gnetworkingprivate.h"
35 #include "gresolver.h"
36 #include "gsimpleasyncresult.h"
37 #include "gsocketaddressenumerator.h"
38 #include "gsocketconnectable.h"
39 #include "gsrvtarget.h"
46 * SECTION:gnetworkservice
47 * @short_description: A GSocketConnectable for resolving SRV records
50 * Like #GNetworkAddress does with hostnames, #GNetworkService
51 * provides an easy way to resolve a SRV record, and then attempt to
52 * connect to one of the hosts that implements that service, handling
53 * service priority/weighting, multiple IP addresses, and multiple
56 * See #GSrvTarget for more information about SRV records, and see
57 * #GSocketConnectable for and example of using the connectable
64 * A #GSocketConnectable for resolving a SRV record and connecting to
68 struct _GNetworkServicePrivate
70 gchar *service, *protocol, *domain, *scheme;
82 static void g_network_service_set_property (GObject *object,
86 static void g_network_service_get_property (GObject *object,
91 static void g_network_service_connectable_iface_init (GSocketConnectableIface *iface);
92 static GSocketAddressEnumerator *g_network_service_connectable_enumerate (GSocketConnectable *connectable);
93 static GSocketAddressEnumerator *g_network_service_connectable_proxy_enumerate (GSocketConnectable *connectable);
95 G_DEFINE_TYPE_WITH_CODE (GNetworkService, g_network_service, G_TYPE_OBJECT,
96 G_IMPLEMENT_INTERFACE (G_TYPE_SOCKET_CONNECTABLE,
97 g_network_service_connectable_iface_init))
100 g_network_service_finalize (GObject *object)
102 GNetworkService *srv = G_NETWORK_SERVICE (object);
104 g_free (srv->priv->service);
105 g_free (srv->priv->protocol);
106 g_free (srv->priv->domain);
107 g_free (srv->priv->scheme);
109 if (srv->priv->targets)
110 g_resolver_free_targets (srv->priv->targets);
112 G_OBJECT_CLASS (g_network_service_parent_class)->finalize (object);
116 g_network_service_class_init (GNetworkServiceClass *klass)
118 GObjectClass *gobject_class = G_OBJECT_CLASS (klass);
120 g_type_class_add_private (klass, sizeof (GNetworkServicePrivate));
122 gobject_class->set_property = g_network_service_set_property;
123 gobject_class->get_property = g_network_service_get_property;
124 gobject_class->finalize = g_network_service_finalize;
126 g_object_class_install_property (gobject_class, PROP_SERVICE,
127 g_param_spec_string ("service",
129 P_("Service name, eg \"ldap\""),
132 G_PARAM_CONSTRUCT_ONLY |
133 G_PARAM_STATIC_STRINGS));
134 g_object_class_install_property (gobject_class, PROP_PROTOCOL,
135 g_param_spec_string ("protocol",
137 P_("Network protocol, eg \"tcp\""),
140 G_PARAM_CONSTRUCT_ONLY |
141 G_PARAM_STATIC_STRINGS));
142 g_object_class_install_property (gobject_class, PROP_DOMAIN,
143 g_param_spec_string ("domain",
145 P_("Network domain, eg, \"example.com\""),
148 G_PARAM_CONSTRUCT_ONLY |
149 G_PARAM_STATIC_STRINGS));
150 g_object_class_install_property (gobject_class, PROP_DOMAIN,
151 g_param_spec_string ("scheme",
153 P_("Network scheme (default is to use service)"),
156 G_PARAM_STATIC_STRINGS));
161 g_network_service_connectable_iface_init (GSocketConnectableIface *connectable_iface)
163 connectable_iface->enumerate = g_network_service_connectable_enumerate;
164 connectable_iface->proxy_enumerate = g_network_service_connectable_proxy_enumerate;
168 g_network_service_init (GNetworkService *srv)
170 srv->priv = G_TYPE_INSTANCE_GET_PRIVATE (srv, G_TYPE_NETWORK_SERVICE,
171 GNetworkServicePrivate);
175 g_network_service_set_property (GObject *object,
180 GNetworkService *srv = G_NETWORK_SERVICE (object);
185 srv->priv->service = g_value_dup_string (value);
189 srv->priv->protocol = g_value_dup_string (value);
193 srv->priv->domain = g_value_dup_string (value);
197 g_network_service_set_scheme (srv, g_value_get_string (value));
201 G_OBJECT_WARN_INVALID_PROPERTY_ID (object, prop_id, pspec);
207 g_network_service_get_property (GObject *object,
212 GNetworkService *srv = G_NETWORK_SERVICE (object);
217 g_value_set_string (value, g_network_service_get_service (srv));
221 g_value_set_string (value, g_network_service_get_protocol (srv));
225 g_value_set_string (value, g_network_service_get_domain (srv));
229 g_value_set_string (value, g_network_service_get_scheme (srv));
233 G_OBJECT_WARN_INVALID_PROPERTY_ID (object, prop_id, pspec);
239 * g_network_service_new:
240 * @service: the service type to look up (eg, "ldap")
241 * @protocol: the networking protocol to use for @service (eg, "tcp")
242 * @domain: the DNS domain to look up the service in
244 * Creates a new #GNetworkService representing the given @service,
245 * @protocol, and @domain. This will initially be unresolved; use the
246 * #GSocketConnectable interface to resolve it.
248 * Return value: (transfer full): a new #GNetworkService
253 g_network_service_new (const gchar *service,
254 const gchar *protocol,
257 return g_object_new (G_TYPE_NETWORK_SERVICE,
259 "protocol", protocol,
265 * g_network_service_get_service:
266 * @srv: a #GNetworkService
268 * Gets @srv's service name (eg, "ldap").
270 * Return value: @srv's service name
275 g_network_service_get_service (GNetworkService *srv)
277 g_return_val_if_fail (G_IS_NETWORK_SERVICE (srv), NULL);
279 return srv->priv->service;
283 * g_network_service_get_protocol:
284 * @srv: a #GNetworkService
286 * Gets @srv's protocol name (eg, "tcp").
288 * Return value: @srv's protocol name
293 g_network_service_get_protocol (GNetworkService *srv)
295 g_return_val_if_fail (G_IS_NETWORK_SERVICE (srv), NULL);
297 return srv->priv->protocol;
301 * g_network_service_get_domain:
302 * @srv: a #GNetworkService
304 * Gets the domain that @srv serves. This might be either UTF-8 or
305 * ASCII-encoded, depending on what @srv was created with.
307 * Return value: @srv's domain name
312 g_network_service_get_domain (GNetworkService *srv)
314 g_return_val_if_fail (G_IS_NETWORK_SERVICE (srv), NULL);
316 return srv->priv->domain;
320 * g_network_service_get_scheme:
321 * @srv: a #GNetworkService
323 * Get's the URI scheme used to resolve proxies. By default, the service name
326 * Return value: @srv's scheme name
331 g_network_service_get_scheme (GNetworkService *srv)
333 g_return_val_if_fail (G_IS_NETWORK_SERVICE (srv), NULL);
335 if (srv->priv->scheme)
336 return srv->priv->scheme;
338 return srv->priv->service;
342 * g_network_service_set_scheme:
343 * @srv: a #GNetworkService
344 * @scheme: a URI scheme
346 * Set's the URI scheme used to resolve proxies. By default, the service name
352 g_network_service_set_scheme (GNetworkService *srv,
355 g_return_if_fail (G_IS_NETWORK_SERVICE (srv));
357 if (srv->priv->scheme)
358 g_free (srv->priv->scheme);
359 srv->priv->scheme = g_strdup (scheme);
361 g_object_notify (G_OBJECT (srv), "scheme");
365 #define G_TYPE_NETWORK_SERVICE_ADDRESS_ENUMERATOR (_g_network_service_address_enumerator_get_type ())
366 #define G_NETWORK_SERVICE_ADDRESS_ENUMERATOR(obj) (G_TYPE_CHECK_INSTANCE_CAST ((obj), G_TYPE_NETWORK_SERVICE_ADDRESS_ENUMERATOR, GNetworkServiceAddressEnumerator))
369 GSocketAddressEnumerator parent_instance;
372 GNetworkService *srv;
373 GSocketAddressEnumerator *addr_enum;
379 /* For async operation */
380 GCancellable *cancellable;
381 GSimpleAsyncResult *result;
382 } GNetworkServiceAddressEnumerator;
385 GSocketAddressEnumeratorClass parent_class;
387 } GNetworkServiceAddressEnumeratorClass;
389 G_DEFINE_TYPE (GNetworkServiceAddressEnumerator, _g_network_service_address_enumerator, G_TYPE_SOCKET_ADDRESS_ENUMERATOR)
391 static GSocketAddress *
392 g_network_service_address_enumerator_next (GSocketAddressEnumerator *enumerator,
393 GCancellable *cancellable,
396 GNetworkServiceAddressEnumerator *srv_enum =
397 G_NETWORK_SERVICE_ADDRESS_ENUMERATOR (enumerator);
398 GSocketAddress *ret = NULL;
400 /* If we haven't yet resolved srv, do that */
401 if (!srv_enum->srv->priv->targets)
405 targets = g_resolver_lookup_service (srv_enum->resolver,
406 srv_enum->srv->priv->service,
407 srv_enum->srv->priv->protocol,
408 srv_enum->srv->priv->domain,
413 srv_enum->srv->priv->targets = targets;
414 srv_enum->t = srv_enum->srv->priv->targets;
417 /* Delegate to GNetworkAddress */
420 if (srv_enum->addr_enum == NULL && srv_enum->t)
422 GError *error = NULL;
425 GSocketConnectable *addr;
426 GSrvTarget *target = srv_enum->t->data;
428 srv_enum->t = g_list_next (srv_enum->t);
430 hostname = g_hostname_to_ascii (g_srv_target_get_hostname (target));
432 if (hostname == NULL)
434 if (srv_enum->error == NULL)
436 g_error_new (G_IO_ERROR, G_IO_ERROR_INVALID_ARGUMENT,
437 "Received invalid hostname '%s' from GSrvTarget",
438 g_srv_target_get_hostname (target));
442 uri = _g_uri_from_authority (g_network_service_get_scheme (srv_enum->srv),
444 g_srv_target_get_port (target),
448 addr = g_network_address_parse_uri (uri,
449 g_srv_target_get_port (target),
455 if (srv_enum->error == NULL)
456 srv_enum->error = error;
460 if (srv_enum->use_proxy)
461 srv_enum->addr_enum = g_socket_connectable_proxy_enumerate (addr);
463 srv_enum->addr_enum = g_socket_connectable_enumerate (addr);
464 g_object_unref (addr);
467 if (srv_enum->addr_enum)
469 GError *error = NULL;
471 ret = g_socket_address_enumerator_next (srv_enum->addr_enum,
477 if (srv_enum->error == NULL)
478 srv_enum->error = error;
480 g_error_free (error);
482 g_object_unref (srv_enum->addr_enum);
483 srv_enum->addr_enum = NULL;
487 while (srv_enum->addr_enum == NULL && srv_enum->t);
489 if (ret == NULL && srv_enum->error)
491 g_propagate_error (error, srv_enum->error);
492 srv_enum->error = NULL;
498 static void next_async_resolved_targets (GObject *source_object,
499 GAsyncResult *result,
501 static void next_async_have_targets (GNetworkServiceAddressEnumerator *srv_enum);
502 static void next_async_have_address (GObject *source_object,
503 GAsyncResult *result,
507 g_network_service_address_enumerator_next_async (GSocketAddressEnumerator *enumerator,
508 GCancellable *cancellable,
509 GAsyncReadyCallback callback,
512 GNetworkServiceAddressEnumerator *srv_enum =
513 G_NETWORK_SERVICE_ADDRESS_ENUMERATOR (enumerator);
515 g_return_if_fail (srv_enum->result == NULL);
517 srv_enum->result = g_simple_async_result_new (G_OBJECT (enumerator),
519 g_network_service_address_enumerator_next_async);
522 srv_enum->cancellable = g_object_ref (cancellable);
524 /* If we haven't yet resolved srv, do that */
525 if (!srv_enum->srv->priv->targets)
527 g_resolver_lookup_service_async (srv_enum->resolver,
528 srv_enum->srv->priv->service,
529 srv_enum->srv->priv->protocol,
530 srv_enum->srv->priv->domain,
532 next_async_resolved_targets,
536 next_async_have_targets (srv_enum);
540 next_async_resolved_targets (GObject *source_object,
541 GAsyncResult *result,
544 GNetworkServiceAddressEnumerator *srv_enum = user_data;
545 GError *error = NULL;
547 srv_enum->srv->priv->targets =
548 g_resolver_lookup_service_finish (srv_enum->resolver, result, &error);
552 GSimpleAsyncResult *simple = srv_enum->result;
554 srv_enum->result = NULL;
555 g_simple_async_result_set_from_error (simple, error);
556 g_error_free (error);
557 g_simple_async_result_complete (simple);
558 g_object_unref (simple);
562 srv_enum->t = srv_enum->srv->priv->targets;
563 next_async_have_targets (srv_enum);
568 next_async_have_targets (GNetworkServiceAddressEnumerator *srv_enum)
570 /* Delegate to GNetworkAddress */
571 if (srv_enum->addr_enum == NULL && srv_enum->t)
573 GSocketConnectable *addr;
574 GSrvTarget *target = srv_enum->t->data;
576 srv_enum->t = g_list_next (srv_enum->t);
577 addr = g_network_address_new (g_srv_target_get_hostname (target),
578 (guint16) g_srv_target_get_port (target));
580 if (srv_enum->use_proxy)
581 srv_enum->addr_enum = g_socket_connectable_proxy_enumerate (addr);
583 srv_enum->addr_enum = g_socket_connectable_enumerate (addr);
585 g_object_unref (addr);
588 if (srv_enum->addr_enum)
590 g_socket_address_enumerator_next_async (srv_enum->addr_enum,
591 srv_enum->cancellable,
592 next_async_have_address,
597 GSimpleAsyncResult *simple = srv_enum->result;
598 srv_enum->result = NULL;
602 g_simple_async_result_set_from_error (simple, srv_enum->error);
603 g_error_free (srv_enum->error);
604 srv_enum->error = NULL;
607 g_simple_async_result_complete (simple);
608 g_object_unref (simple);
613 next_async_have_address (GObject *source_object,
614 GAsyncResult *result,
617 GNetworkServiceAddressEnumerator *srv_enum = user_data;
618 GSocketAddress *address;
619 GError *error = NULL;
621 address = g_socket_address_enumerator_next_finish (srv_enum->addr_enum,
627 if (srv_enum->error == NULL)
628 srv_enum->error = error;
630 g_error_free (error);
632 g_object_unref (srv_enum->addr_enum);
633 srv_enum->addr_enum = NULL;
635 next_async_have_targets (srv_enum);
639 GSimpleAsyncResult *simple = srv_enum->result;
641 srv_enum->result = NULL;
644 g_simple_async_result_set_op_res_gpointer (simple,
645 address, g_object_unref);
647 g_simple_async_result_complete (simple);
648 g_object_unref (simple);
652 static GSocketAddress *
653 g_network_service_address_enumerator_next_finish (GSocketAddressEnumerator *enumerator,
654 GAsyncResult *result,
657 GSimpleAsyncResult *simple = G_SIMPLE_ASYNC_RESULT (result);
658 GSocketAddress *sockaddr;
660 if (g_simple_async_result_propagate_error (simple, error))
663 sockaddr = g_simple_async_result_get_op_res_gpointer (simple);
664 return sockaddr ? g_object_ref (sockaddr) : NULL;
668 _g_network_service_address_enumerator_init (GNetworkServiceAddressEnumerator *enumerator)
673 g_network_service_address_enumerator_finalize (GObject *object)
675 GNetworkServiceAddressEnumerator *srv_enum =
676 G_NETWORK_SERVICE_ADDRESS_ENUMERATOR (object);
679 g_object_unref (srv_enum->srv);
681 if (srv_enum->addr_enum)
682 g_object_unref (srv_enum->addr_enum);
684 if (srv_enum->resolver)
685 g_object_unref (srv_enum->resolver);
687 if (srv_enum->result)
688 g_object_unref (srv_enum->result);
690 if (srv_enum->cancellable)
691 g_object_unref (srv_enum->cancellable);
694 g_error_free (srv_enum->error);
696 G_OBJECT_CLASS (_g_network_service_address_enumerator_parent_class)->finalize (object);
700 _g_network_service_address_enumerator_class_init (GNetworkServiceAddressEnumeratorClass *srvenum_class)
702 GObjectClass *object_class = G_OBJECT_CLASS (srvenum_class);
703 GSocketAddressEnumeratorClass *enumerator_class =
704 G_SOCKET_ADDRESS_ENUMERATOR_CLASS (srvenum_class);
706 enumerator_class->next = g_network_service_address_enumerator_next;
707 enumerator_class->next_async = g_network_service_address_enumerator_next_async;
708 enumerator_class->next_finish = g_network_service_address_enumerator_next_finish;
710 object_class->finalize = g_network_service_address_enumerator_finalize;
713 static GSocketAddressEnumerator *
714 g_network_service_connectable_enumerate (GSocketConnectable *connectable)
716 GNetworkServiceAddressEnumerator *srv_enum;
718 srv_enum = g_object_new (G_TYPE_NETWORK_SERVICE_ADDRESS_ENUMERATOR, NULL);
719 srv_enum->srv = g_object_ref (connectable);
720 srv_enum->resolver = g_resolver_get_default ();
721 srv_enum->use_proxy = FALSE;
723 return G_SOCKET_ADDRESS_ENUMERATOR (srv_enum);
726 static GSocketAddressEnumerator *
727 g_network_service_connectable_proxy_enumerate (GSocketConnectable *connectable)
729 GSocketAddressEnumerator *addr_enum;
730 GNetworkServiceAddressEnumerator *srv_enum;
732 addr_enum = g_network_service_connectable_enumerate (connectable);
733 srv_enum = G_NETWORK_SERVICE_ADDRESS_ENUMERATOR (addr_enum);
734 srv_enum->use_proxy = TRUE;