gio/gproxyresolver.c

   1 /* GIO - GLib Input, Output and Streaming Library
   2  *
   3  * Copyright (C) 2010 Collabora, Ltd.
   4  *
   5  * This library is free software; you can redistribute it and/or
   6  * modify it under the terms of the GNU Lesser General Public
   7  * License as published by the Free Software Foundation; either
   8  * version 2.1 of the License, or (at your option) any later version.
   9  *
  10  * This library is distributed in the hope that it will be useful,
  11  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  12  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  13  * Lesser General Public License for more details.
  14  *
  15  * You should have received a copy of the GNU Lesser General
  16  * Public License along with this library; if not, see <http://www.gnu.org/licenses/>.
  17  *
  18  * Author: Nicolas Dufresne <nicolas.dufresne@collabora.co.uk>
  19  */
  20
  21 #include "config.h"
  22
  23 #include "gproxyresolver.h"
  24
  25 #include <glib.h>
  26 #include "glibintl.h"
  27
  28 #include "gasyncresult.h"
  29 #include "gcancellable.h"
  30 #include "gtask.h"
  31 #include "giomodule.h"
  32 #include "giomodule-priv.h"
  33 #include "gnetworkingprivate.h"
  34
  35 /**
  36  * SECTION:gproxyresolver
  37  * @short_description: Asynchronous and cancellable network proxy resolver
  38  * @include: gio/gio.h
  39  *
  40  * #GProxyResolver provides synchronous and asynchronous network proxy
  41  * resolution. #GProxyResolver is used within #GSocketClient through
  42  * the method g_socket_connectable_proxy_enumerate().
  43  *
  44  * Implementations of #GProxyResolver based on libproxy and GNOME settings can
  45  * be found in glib-networking. GIO comes with an implementation for use inside
  46  * Flatpak portals.
  47  */
  48
  49 /**
  50  * GProxyResolverInterface:
  51  * @g_iface: The parent interface.
  52  * @is_supported: the virtual function pointer for g_proxy_resolver_is_supported()
  53  * @lookup: the virtual function pointer for g_proxy_resolver_lookup()
  54  * @lookup_async: the virtual function pointer for
  55  *  g_proxy_resolver_lookup_async()
  56  * @lookup_finish: the virtual function pointer for
  57  *  g_proxy_resolver_lookup_finish()
  58  *
  59  * The virtual function table for #GProxyResolver.
  60  */
  61
  62 G_DEFINE_INTERFACE (GProxyResolver, g_proxy_resolver, G_TYPE_OBJECT)
  63
  64 static void
  65 g_proxy_resolver_default_init (GProxyResolverInterface *iface)
  66 {
  67 }
  68
  69 /**
  70  * g_proxy_resolver_get_default:
  71  *
  72  * Gets the default #GProxyResolver for the system.
  73  *
  74  * Returns: (transfer none): the default #GProxyResolver.
  75  *
  76  * Since: 2.26
  77  */
  78 GProxyResolver *
  79 g_proxy_resolver_get_default (void)
  80 {
  81   return _g_io_module_get_default (G_PROXY_RESOLVER_EXTENSION_POINT_NAME,
  82                                    "GIO_USE_PROXY_RESOLVER",
  83                                    (GIOModuleVerifyFunc)g_proxy_resolver_is_supported);
  84 }
  85
  86 /**
  87  * g_proxy_resolver_is_supported:
  88  * @resolver: a #GProxyResolver
  89  *
  90  * Checks if @resolver can be used on this system. (This is used
  91  * internally; g_proxy_resolver_get_default() will only return a proxy
  92  * resolver that returns %TRUE for this method.)
  93  *
  94  * Returns: %TRUE if @resolver is supported.
  95  *
  96  * Since: 2.26
  97  */
  98 gboolean
  99 g_proxy_resolver_is_supported (GProxyResolver *resolver)
 100 {
 101   GProxyResolverInterface *iface;
 102
 103   g_return_val_if_fail (G_IS_PROXY_RESOLVER (resolver), FALSE);
 104
 105   iface = G_PROXY_RESOLVER_GET_IFACE (resolver);
 106
 107   return (* iface->is_supported) (resolver);
 108 }
 109
 110 /**
 111  * g_proxy_resolver_lookup:
 112  * @resolver: a #GProxyResolver
 113  * @uri: a URI representing the destination to connect to
 114  * @cancellable: (nullable): a #GCancellable, or %NULL
 115  * @error: return location for a #GError, or %NULL
 116  *
 117  * Looks into the system proxy configuration to determine what proxy,
 118  * if any, to use to connect to @uri. The returned proxy URIs are of
 119  * the form `<protocol>://[user[:password]@]host:port` or
 120  * `direct://`, where <protocol> could be http, rtsp, socks
 121  * or other proxying protocol.
 122  *
 123  * If you don't know what network protocol is being used on the
 124  * socket, you should use `none` as the URI protocol.
 125  * In this case, the resolver might still return a generic proxy type
 126  * (such as SOCKS), but would not return protocol-specific proxy types
 127  * (such as http).
 128  *
 129  * `direct://` is used when no proxy is needed.
 130  * Direct connection should not be attempted unless it is part of the
 131  * returned array of proxies.
 132  *
 133  * Returns: (transfer full) (array zero-terminated=1): A
 134  *               NULL-terminated array of proxy URIs. Must be freed
 135  *               with g_strfreev().
 136  *
 137  * Since: 2.26
 138  */
 139 gchar **
 140 g_proxy_resolver_lookup (GProxyResolver  *resolver,
 141                          const gchar     *uri,
 142                          GCancellable    *cancellable,
 143                          GError         **error)
 144 {
 145   GProxyResolverInterface *iface;
 146
 147   g_return_val_if_fail (G_IS_PROXY_RESOLVER (resolver), NULL);
 148   g_return_val_if_fail (uri != NULL, NULL);
 149
 150   if (!_g_uri_parse_authority (uri, NULL, NULL, NULL, error))
 151     return NULL;
 152
 153   iface = G_PROXY_RESOLVER_GET_IFACE (resolver);
 154
 155   return (* iface->lookup) (resolver, uri, cancellable, error);
 156 }
 157
 158 /**
 159  * g_proxy_resolver_lookup_async:
 160  * @resolver: a #GProxyResolver
 161  * @uri: a URI representing the destination to connect to
 162  * @cancellable: (nullable): a #GCancellable, or %NULL
 163  * @callback: (scope async): callback to call after resolution completes
 164  * @user_data: (closure): data for @callback
 165  *
 166  * Asynchronous lookup of proxy. See g_proxy_resolver_lookup() for more
 167  * details.
 168  *
 169  * Since: 2.26
 170  */
 171 void
 172 g_proxy_resolver_lookup_async (GProxyResolver      *resolver,
 173                                const gchar         *uri,
 174                                GCancellable        *cancellable,
 175                                GAsyncReadyCallback  callback,
 176                                gpointer             user_data)
 177 {
 178   GProxyResolverInterface *iface;
 179   GError *error = NULL;
 180
 181   g_return_if_fail (G_IS_PROXY_RESOLVER (resolver));
 182   g_return_if_fail (uri != NULL);
 183
 184   if (!_g_uri_parse_authority (uri, NULL, NULL, NULL, &error))
 185     {
 186       g_task_report_error (resolver, callback, user_data,
 187                            g_proxy_resolver_lookup_async,
 188                            g_steal_pointer (&error));
 189       return;
 190     }
 191
 192   iface = G_PROXY_RESOLVER_GET_IFACE (resolver);
 193
 194   (* iface->lookup_async) (resolver, uri, cancellable, callback, user_data);
 195 }
 196
 197 /**
 198  * g_proxy_resolver_lookup_finish:
 199  * @resolver: a #GProxyResolver
 200  * @result: the result passed to your #GAsyncReadyCallback
 201  * @error: return location for a #GError, or %NULL
 202  *
 203  * Call this function to obtain the array of proxy URIs when
 204  * g_proxy_resolver_lookup_async() is complete. See
 205  * g_proxy_resolver_lookup() for more details.
 206  *
 207  * Returns: (transfer full) (array zero-terminated=1): A
 208  *               NULL-terminated array of proxy URIs. Must be freed
 209  *               with g_strfreev().
 210  *
 211  * Since: 2.26
 212  */
 213 gchar **
 214 g_proxy_resolver_lookup_finish (GProxyResolver     *resolver,
 215                                 GAsyncResult       *result,
 216                                 GError            **error)
 217 {
 218   GProxyResolverInterface *iface;
 219
 220   g_return_val_if_fail (G_IS_PROXY_RESOLVER (resolver), NULL);
 221
 222   iface = G_PROXY_RESOLVER_GET_IFACE (resolver);
 223
 224   return (* iface->lookup_finish) (resolver, result, error);
 225 }