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 * SPDX-License-Identifier: LGPL-2.1-or-later
9 * This library is free software; you can redistribute it and/or
10 * modify it under the terms of the GNU Lesser General Public
11 * License as published by the Free Software Foundation; either
12 * version 2.1 of the License, or (at your option) any later version.
14 * This library is distributed in the hope that it will be useful,
15 * but WITHOUT ANY WARRANTY; without even the implied warranty of
16 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
17 * Lesser General Public License for more details.
19 * You should have received a copy of the GNU Lesser General
20 * Public License along with this library; if not, see <http://www.gnu.org/licenses/>.
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"
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 an 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);
94 static gchar *g_network_service_connectable_to_string (GSocketConnectable *connectable);
96 G_DEFINE_TYPE_WITH_CODE (GNetworkService, g_network_service, G_TYPE_OBJECT,
97 G_ADD_PRIVATE (GNetworkService)
98 G_IMPLEMENT_INTERFACE (G_TYPE_SOCKET_CONNECTABLE,
99 g_network_service_connectable_iface_init))
102 g_network_service_finalize (GObject *object)
104 GNetworkService *srv = G_NETWORK_SERVICE (object);
106 g_free (srv->priv->service);
107 g_free (srv->priv->protocol);
108 g_free (srv->priv->domain);
109 g_free (srv->priv->scheme);
111 if (srv->priv->targets)
112 g_resolver_free_targets (srv->priv->targets);
114 G_OBJECT_CLASS (g_network_service_parent_class)->finalize (object);
118 g_network_service_class_init (GNetworkServiceClass *klass)
120 GObjectClass *gobject_class = G_OBJECT_CLASS (klass);
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;
165 connectable_iface->to_string = g_network_service_connectable_to_string;
169 g_network_service_init (GNetworkService *srv)
171 srv->priv = g_network_service_get_instance_private (srv);
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 * Returns: (transfer full) (type GNetworkService): 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 * Returns: @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 * Returns: @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 * Returns: @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 * Gets the URI scheme used to resolve proxies. By default, the service name
326 * Returns: @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 g_free (srv->priv->scheme);
358 srv->priv->scheme = g_strdup (scheme);
360 g_object_notify (G_OBJECT (srv), "scheme");
364 g_network_service_fallback_targets (GNetworkService *srv)
370 has_port = g_getservbyname_ntohs (srv->priv->service, "tcp", &port);
372 #ifdef HAVE_ENDSERVENT
379 target = g_srv_target_new (srv->priv->domain, port, 0, 0);
380 return g_list_append (NULL, target);
383 #define G_TYPE_NETWORK_SERVICE_ADDRESS_ENUMERATOR (_g_network_service_address_enumerator_get_type ())
384 #define G_NETWORK_SERVICE_ADDRESS_ENUMERATOR(obj) (G_TYPE_CHECK_INSTANCE_CAST ((obj), G_TYPE_NETWORK_SERVICE_ADDRESS_ENUMERATOR, GNetworkServiceAddressEnumerator))
387 GSocketAddressEnumerator parent_instance;
390 GNetworkService *srv;
391 GSocketAddressEnumerator *addr_enum;
397 } GNetworkServiceAddressEnumerator;
400 GSocketAddressEnumeratorClass parent_class;
402 } GNetworkServiceAddressEnumeratorClass;
404 static GType _g_network_service_address_enumerator_get_type (void);
405 G_DEFINE_TYPE (GNetworkServiceAddressEnumerator, _g_network_service_address_enumerator, G_TYPE_SOCKET_ADDRESS_ENUMERATOR)
407 static GSocketAddress *
408 g_network_service_address_enumerator_next (GSocketAddressEnumerator *enumerator,
409 GCancellable *cancellable,
412 GNetworkServiceAddressEnumerator *srv_enum =
413 G_NETWORK_SERVICE_ADDRESS_ENUMERATOR (enumerator);
414 GSocketAddress *ret = NULL;
416 /* If we haven't yet resolved srv, do that */
417 if (!srv_enum->srv->priv->targets)
420 GError *my_error = NULL;
422 targets = g_resolver_lookup_service (srv_enum->resolver,
423 srv_enum->srv->priv->service,
424 srv_enum->srv->priv->protocol,
425 srv_enum->srv->priv->domain,
426 cancellable, &my_error);
427 if (!targets && g_error_matches (my_error, G_RESOLVER_ERROR,
428 G_RESOLVER_ERROR_NOT_FOUND))
430 targets = g_network_service_fallback_targets (srv_enum->srv);
432 g_clear_error (&my_error);
437 g_propagate_error (error, my_error);
441 srv_enum->srv->priv->targets = targets;
442 srv_enum->t = srv_enum->srv->priv->targets;
445 /* Delegate to GNetworkAddress */
448 if (srv_enum->addr_enum == NULL && srv_enum->t)
450 GError *my_error = NULL;
453 GSocketConnectable *addr;
454 GSrvTarget *target = srv_enum->t->data;
456 srv_enum->t = g_list_next (srv_enum->t);
458 hostname = g_hostname_to_ascii (g_srv_target_get_hostname (target));
460 if (hostname == NULL)
462 if (srv_enum->error == NULL)
464 g_error_new (G_IO_ERROR, G_IO_ERROR_INVALID_ARGUMENT,
465 "Received invalid hostname '%s' from GSrvTarget",
466 g_srv_target_get_hostname (target));
470 uri = g_uri_join (G_URI_FLAGS_NONE,
471 g_network_service_get_scheme (srv_enum->srv),
474 g_srv_target_get_port (target),
480 addr = g_network_address_parse_uri (uri,
481 g_srv_target_get_port (target),
487 if (srv_enum->error == NULL)
488 srv_enum->error = my_error;
490 g_error_free (my_error);
494 if (srv_enum->use_proxy)
495 srv_enum->addr_enum = g_socket_connectable_proxy_enumerate (addr);
497 srv_enum->addr_enum = g_socket_connectable_enumerate (addr);
498 g_object_unref (addr);
501 if (srv_enum->addr_enum)
503 GError *my_error = NULL;
505 ret = g_socket_address_enumerator_next (srv_enum->addr_enum,
511 if (srv_enum->error == NULL)
512 srv_enum->error = my_error;
514 g_error_free (my_error);
519 g_object_unref (srv_enum->addr_enum);
520 srv_enum->addr_enum = NULL;
524 while (srv_enum->addr_enum == NULL && srv_enum->t);
526 if (ret == NULL && srv_enum->error)
528 g_propagate_error (error, srv_enum->error);
529 srv_enum->error = NULL;
535 static void next_async_resolved_targets (GObject *source_object,
536 GAsyncResult *result,
538 static void next_async_have_targets (GTask *srv_enum);
539 static void next_async_have_address (GObject *source_object,
540 GAsyncResult *result,
544 g_network_service_address_enumerator_next_async (GSocketAddressEnumerator *enumerator,
545 GCancellable *cancellable,
546 GAsyncReadyCallback callback,
549 GNetworkServiceAddressEnumerator *srv_enum =
550 G_NETWORK_SERVICE_ADDRESS_ENUMERATOR (enumerator);
553 task = g_task_new (enumerator, cancellable, callback, user_data);
554 g_task_set_source_tag (task, g_network_service_address_enumerator_next_async);
556 /* If we haven't yet resolved srv, do that */
557 if (!srv_enum->srv->priv->targets)
559 g_resolver_lookup_service_async (srv_enum->resolver,
560 srv_enum->srv->priv->service,
561 srv_enum->srv->priv->protocol,
562 srv_enum->srv->priv->domain,
564 next_async_resolved_targets,
568 next_async_have_targets (task);
572 next_async_resolved_targets (GObject *source_object,
573 GAsyncResult *result,
576 GTask *task = user_data;
577 GNetworkServiceAddressEnumerator *srv_enum = g_task_get_source_object (task);
578 GError *error = NULL;
581 targets = g_resolver_lookup_service_finish (srv_enum->resolver,
584 if (!targets && g_error_matches (error, G_RESOLVER_ERROR,
585 G_RESOLVER_ERROR_NOT_FOUND))
587 targets = g_network_service_fallback_targets (srv_enum->srv);
589 g_clear_error (&error);
594 g_task_return_error (task, error);
595 g_object_unref (task);
599 srv_enum->t = srv_enum->srv->priv->targets = targets;
600 next_async_have_targets (task);
605 next_async_have_targets (GTask *task)
607 GNetworkServiceAddressEnumerator *srv_enum = g_task_get_source_object (task);
609 /* Delegate to GNetworkAddress */
610 if (srv_enum->addr_enum == NULL && srv_enum->t)
612 GSocketConnectable *addr;
613 GSrvTarget *target = srv_enum->t->data;
615 srv_enum->t = g_list_next (srv_enum->t);
616 addr = g_network_address_new (g_srv_target_get_hostname (target),
617 (guint16) g_srv_target_get_port (target));
619 if (srv_enum->use_proxy)
620 srv_enum->addr_enum = g_socket_connectable_proxy_enumerate (addr);
622 srv_enum->addr_enum = g_socket_connectable_enumerate (addr);
624 g_object_unref (addr);
627 if (srv_enum->addr_enum)
629 g_socket_address_enumerator_next_async (srv_enum->addr_enum,
630 g_task_get_cancellable (task),
631 next_async_have_address,
638 g_task_return_error (task, srv_enum->error);
639 srv_enum->error = NULL;
642 g_task_return_pointer (task, NULL, NULL);
644 g_object_unref (task);
649 next_async_have_address (GObject *source_object,
650 GAsyncResult *result,
653 GTask *task = user_data;
654 GNetworkServiceAddressEnumerator *srv_enum = g_task_get_source_object (task);
655 GSocketAddress *address;
656 GError *error = NULL;
658 address = g_socket_address_enumerator_next_finish (srv_enum->addr_enum,
664 if (srv_enum->error == NULL)
665 srv_enum->error = error;
667 g_error_free (error);
672 g_object_unref (srv_enum->addr_enum);
673 srv_enum->addr_enum = NULL;
675 next_async_have_targets (task);
679 g_task_return_pointer (task, address, g_object_unref);
680 g_object_unref (task);
684 static GSocketAddress *
685 g_network_service_address_enumerator_next_finish (GSocketAddressEnumerator *enumerator,
686 GAsyncResult *result,
689 return g_task_propagate_pointer (G_TASK (result), error);
693 _g_network_service_address_enumerator_init (GNetworkServiceAddressEnumerator *enumerator)
698 g_network_service_address_enumerator_finalize (GObject *object)
700 GNetworkServiceAddressEnumerator *srv_enum =
701 G_NETWORK_SERVICE_ADDRESS_ENUMERATOR (object);
704 g_object_unref (srv_enum->srv);
706 if (srv_enum->addr_enum)
707 g_object_unref (srv_enum->addr_enum);
709 if (srv_enum->resolver)
710 g_object_unref (srv_enum->resolver);
713 g_error_free (srv_enum->error);
715 G_OBJECT_CLASS (_g_network_service_address_enumerator_parent_class)->finalize (object);
719 _g_network_service_address_enumerator_class_init (GNetworkServiceAddressEnumeratorClass *srvenum_class)
721 GObjectClass *object_class = G_OBJECT_CLASS (srvenum_class);
722 GSocketAddressEnumeratorClass *enumerator_class =
723 G_SOCKET_ADDRESS_ENUMERATOR_CLASS (srvenum_class);
725 enumerator_class->next = g_network_service_address_enumerator_next;
726 enumerator_class->next_async = g_network_service_address_enumerator_next_async;
727 enumerator_class->next_finish = g_network_service_address_enumerator_next_finish;
729 object_class->finalize = g_network_service_address_enumerator_finalize;
732 static GSocketAddressEnumerator *
733 g_network_service_connectable_enumerate (GSocketConnectable *connectable)
735 GNetworkServiceAddressEnumerator *srv_enum;
737 srv_enum = g_object_new (G_TYPE_NETWORK_SERVICE_ADDRESS_ENUMERATOR, NULL);
738 srv_enum->srv = g_object_ref (G_NETWORK_SERVICE (connectable));
739 srv_enum->resolver = g_resolver_get_default ();
740 srv_enum->use_proxy = FALSE;
742 return G_SOCKET_ADDRESS_ENUMERATOR (srv_enum);
745 static GSocketAddressEnumerator *
746 g_network_service_connectable_proxy_enumerate (GSocketConnectable *connectable)
748 GSocketAddressEnumerator *addr_enum;
749 GNetworkServiceAddressEnumerator *srv_enum;
751 addr_enum = g_network_service_connectable_enumerate (connectable);
752 srv_enum = G_NETWORK_SERVICE_ADDRESS_ENUMERATOR (addr_enum);
753 srv_enum->use_proxy = TRUE;
759 g_network_service_connectable_to_string (GSocketConnectable *connectable)
761 GNetworkService *service;
763 service = G_NETWORK_SERVICE (connectable);
765 return g_strdup_printf ("(%s, %s, %s, %s)", service->priv->service,
766 service->priv->protocol, service->priv->domain,
767 service->priv->scheme);