|
Packit |
ae235b |
/* GIO - GLib Input, Output and Streaming Library
|
|
Packit |
ae235b |
*
|
|
Packit |
ae235b |
* Copyright (C) 2010 Collabora, Ltd.
|
|
Packit |
ae235b |
*
|
|
Packit |
ae235b |
* This library is free software; you can redistribute it and/or
|
|
Packit |
ae235b |
* modify it under the terms of the GNU Lesser General Public
|
|
Packit |
ae235b |
* License as published by the Free Software Foundation; either
|
|
Packit |
ae235b |
* version 2.1 of the License, or (at your option) any later version.
|
|
Packit |
ae235b |
*
|
|
Packit |
ae235b |
* This library is distributed in the hope that it will be useful,
|
|
Packit |
ae235b |
* but WITHOUT ANY WARRANTY; without even the implied warranty of
|
|
Packit |
ae235b |
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
|
|
Packit |
ae235b |
* Lesser General Public License for more details.
|
|
Packit |
ae235b |
*
|
|
Packit |
ae235b |
* You should have received a copy of the GNU Lesser General
|
|
Packit |
ae235b |
* Public License along with this library; if not, see <http://www.gnu.org/licenses/>.
|
|
Packit |
ae235b |
*
|
|
Packit |
ae235b |
* Author: Nicolas Dufresne <nicolas.dufresne@collabora.co.uk>
|
|
Packit |
ae235b |
*/
|
|
Packit |
ae235b |
|
|
Packit |
ae235b |
#include "config.h"
|
|
Packit |
ae235b |
|
|
Packit |
ae235b |
#include "gproxyresolver.h"
|
|
Packit |
ae235b |
|
|
Packit |
ae235b |
#include <glib.h>
|
|
Packit |
ae235b |
#include "glibintl.h"
|
|
Packit |
ae235b |
|
|
Packit |
ae235b |
#include "gasyncresult.h"
|
|
Packit |
ae235b |
#include "gcancellable.h"
|
|
Packit |
ae235b |
#include "gtask.h"
|
|
Packit |
ae235b |
#include "giomodule.h"
|
|
Packit |
ae235b |
#include "giomodule-priv.h"
|
|
Packit |
ae235b |
#include "gnetworkingprivate.h"
|
|
Packit |
ae235b |
|
|
Packit |
ae235b |
/**
|
|
Packit |
ae235b |
* SECTION:gproxyresolver
|
|
Packit |
ae235b |
* @short_description: Asynchronous and cancellable network proxy resolver
|
|
Packit |
ae235b |
* @include: gio/gio.h
|
|
Packit |
ae235b |
*
|
|
Packit |
ae235b |
* #GProxyResolver provides synchronous and asynchronous network proxy
|
|
Packit |
ae235b |
* resolution. #GProxyResolver is used within #GSocketClient through
|
|
Packit |
ae235b |
* the method g_socket_connectable_proxy_enumerate().
|
|
Packit |
ae235b |
*
|
|
Packit |
ae235b |
* Implementations of #GProxyResolver based on libproxy and GNOME settings can
|
|
Packit |
ae235b |
* be found in glib-networking. GIO comes with an implementation for use inside
|
|
Packit |
ae235b |
* Flatpak portals.
|
|
Packit |
ae235b |
*/
|
|
Packit |
ae235b |
|
|
Packit |
ae235b |
/**
|
|
Packit |
ae235b |
* GProxyResolverInterface:
|
|
Packit |
ae235b |
* @g_iface: The parent interface.
|
|
Packit |
ae235b |
* @is_supported: the virtual function pointer for g_proxy_resolver_is_supported()
|
|
Packit |
ae235b |
* @lookup: the virtual function pointer for g_proxy_resolver_lookup()
|
|
Packit |
ae235b |
* @lookup_async: the virtual function pointer for
|
|
Packit |
ae235b |
* g_proxy_resolver_lookup_async()
|
|
Packit |
ae235b |
* @lookup_finish: the virtual function pointer for
|
|
Packit |
ae235b |
* g_proxy_resolver_lookup_finish()
|
|
Packit |
ae235b |
*
|
|
Packit |
ae235b |
* The virtual function table for #GProxyResolver.
|
|
Packit |
ae235b |
*/
|
|
Packit |
ae235b |
|
|
Packit |
ae235b |
G_DEFINE_INTERFACE (GProxyResolver, g_proxy_resolver, G_TYPE_OBJECT)
|
|
Packit |
ae235b |
|
|
Packit |
ae235b |
static void
|
|
Packit |
ae235b |
g_proxy_resolver_default_init (GProxyResolverInterface *iface)
|
|
Packit |
ae235b |
{
|
|
Packit |
ae235b |
}
|
|
Packit |
ae235b |
|
|
Packit |
ae235b |
/**
|
|
Packit |
ae235b |
* g_proxy_resolver_get_default:
|
|
Packit |
ae235b |
*
|
|
Packit |
ae235b |
* Gets the default #GProxyResolver for the system.
|
|
Packit |
ae235b |
*
|
|
Packit |
ae235b |
* Returns: (transfer none): the default #GProxyResolver.
|
|
Packit |
ae235b |
*
|
|
Packit |
ae235b |
* Since: 2.26
|
|
Packit |
ae235b |
*/
|
|
Packit |
ae235b |
GProxyResolver *
|
|
Packit |
ae235b |
g_proxy_resolver_get_default (void)
|
|
Packit |
ae235b |
{
|
|
Packit |
ae235b |
return _g_io_module_get_default (G_PROXY_RESOLVER_EXTENSION_POINT_NAME,
|
|
Packit |
ae235b |
"GIO_USE_PROXY_RESOLVER",
|
|
Packit |
ae235b |
(GIOModuleVerifyFunc)g_proxy_resolver_is_supported);
|
|
Packit |
ae235b |
}
|
|
Packit |
ae235b |
|
|
Packit |
ae235b |
/**
|
|
Packit |
ae235b |
* g_proxy_resolver_is_supported:
|
|
Packit |
ae235b |
* @resolver: a #GProxyResolver
|
|
Packit |
ae235b |
*
|
|
Packit |
ae235b |
* Checks if @resolver can be used on this system. (This is used
|
|
Packit |
ae235b |
* internally; g_proxy_resolver_get_default() will only return a proxy
|
|
Packit |
ae235b |
* resolver that returns %TRUE for this method.)
|
|
Packit |
ae235b |
*
|
|
Packit |
ae235b |
* Returns: %TRUE if @resolver is supported.
|
|
Packit |
ae235b |
*
|
|
Packit |
ae235b |
* Since: 2.26
|
|
Packit |
ae235b |
*/
|
|
Packit |
ae235b |
gboolean
|
|
Packit |
ae235b |
g_proxy_resolver_is_supported (GProxyResolver *resolver)
|
|
Packit |
ae235b |
{
|
|
Packit |
ae235b |
GProxyResolverInterface *iface;
|
|
Packit |
ae235b |
|
|
Packit |
ae235b |
g_return_val_if_fail (G_IS_PROXY_RESOLVER (resolver), FALSE);
|
|
Packit |
ae235b |
|
|
Packit |
ae235b |
iface = G_PROXY_RESOLVER_GET_IFACE (resolver);
|
|
Packit |
ae235b |
|
|
Packit |
ae235b |
return (* iface->is_supported) (resolver);
|
|
Packit |
ae235b |
}
|
|
Packit |
ae235b |
|
|
Packit |
ae235b |
/**
|
|
Packit |
ae235b |
* g_proxy_resolver_lookup:
|
|
Packit |
ae235b |
* @resolver: a #GProxyResolver
|
|
Packit |
ae235b |
* @uri: a URI representing the destination to connect to
|
|
Packit |
ae235b |
* @cancellable: (nullable): a #GCancellable, or %NULL
|
|
Packit |
ae235b |
* @error: return location for a #GError, or %NULL
|
|
Packit |
ae235b |
*
|
|
Packit |
ae235b |
* Looks into the system proxy configuration to determine what proxy,
|
|
Packit |
ae235b |
* if any, to use to connect to @uri. The returned proxy URIs are of
|
|
Packit |
ae235b |
* the form `<protocol>://[user[:password]@]host:port` or
|
|
Packit |
ae235b |
* `direct://`, where <protocol> could be http, rtsp, socks
|
|
Packit |
ae235b |
* or other proxying protocol.
|
|
Packit |
ae235b |
*
|
|
Packit |
ae235b |
* If you don't know what network protocol is being used on the
|
|
Packit |
ae235b |
* socket, you should use `none` as the URI protocol.
|
|
Packit |
ae235b |
* In this case, the resolver might still return a generic proxy type
|
|
Packit |
ae235b |
* (such as SOCKS), but would not return protocol-specific proxy types
|
|
Packit |
ae235b |
* (such as http).
|
|
Packit |
ae235b |
*
|
|
Packit |
ae235b |
* `direct://` is used when no proxy is needed.
|
|
Packit |
ae235b |
* Direct connection should not be attempted unless it is part of the
|
|
Packit |
ae235b |
* returned array of proxies.
|
|
Packit |
ae235b |
*
|
|
Packit |
ae235b |
* Returns: (transfer full) (array zero-terminated=1): A
|
|
Packit |
ae235b |
* NULL-terminated array of proxy URIs. Must be freed
|
|
Packit |
ae235b |
* with g_strfreev().
|
|
Packit |
ae235b |
*
|
|
Packit |
ae235b |
* Since: 2.26
|
|
Packit |
ae235b |
*/
|
|
Packit |
ae235b |
gchar **
|
|
Packit |
ae235b |
g_proxy_resolver_lookup (GProxyResolver *resolver,
|
|
Packit |
ae235b |
const gchar *uri,
|
|
Packit |
ae235b |
GCancellable *cancellable,
|
|
Packit |
ae235b |
GError **error)
|
|
Packit |
ae235b |
{
|
|
Packit |
ae235b |
GProxyResolverInterface *iface;
|
|
Packit |
ae235b |
|
|
Packit |
ae235b |
g_return_val_if_fail (G_IS_PROXY_RESOLVER (resolver), NULL);
|
|
Packit |
ae235b |
g_return_val_if_fail (uri != NULL, NULL);
|
|
Packit |
ae235b |
|
|
Packit |
ae235b |
if (!_g_uri_parse_authority (uri, NULL, NULL, NULL, error))
|
|
Packit |
ae235b |
return NULL;
|
|
Packit |
ae235b |
|
|
Packit |
ae235b |
iface = G_PROXY_RESOLVER_GET_IFACE (resolver);
|
|
Packit |
ae235b |
|
|
Packit |
ae235b |
return (* iface->lookup) (resolver, uri, cancellable, error);
|
|
Packit |
ae235b |
}
|
|
Packit |
ae235b |
|
|
Packit |
ae235b |
/**
|
|
Packit |
ae235b |
* g_proxy_resolver_lookup_async:
|
|
Packit |
ae235b |
* @resolver: a #GProxyResolver
|
|
Packit |
ae235b |
* @uri: a URI representing the destination to connect to
|
|
Packit |
ae235b |
* @cancellable: (nullable): a #GCancellable, or %NULL
|
|
Packit |
ae235b |
* @callback: (scope async): callback to call after resolution completes
|
|
Packit |
ae235b |
* @user_data: (closure): data for @callback
|
|
Packit |
ae235b |
*
|
|
Packit |
ae235b |
* Asynchronous lookup of proxy. See g_proxy_resolver_lookup() for more
|
|
Packit |
ae235b |
* details.
|
|
Packit |
ae235b |
*
|
|
Packit |
ae235b |
* Since: 2.26
|
|
Packit |
ae235b |
*/
|
|
Packit |
ae235b |
void
|
|
Packit |
ae235b |
g_proxy_resolver_lookup_async (GProxyResolver *resolver,
|
|
Packit |
ae235b |
const gchar *uri,
|
|
Packit |
ae235b |
GCancellable *cancellable,
|
|
Packit |
ae235b |
GAsyncReadyCallback callback,
|
|
Packit |
ae235b |
gpointer user_data)
|
|
Packit |
ae235b |
{
|
|
Packit |
ae235b |
GProxyResolverInterface *iface;
|
|
Packit |
ae235b |
GError *error = NULL;
|
|
Packit |
ae235b |
|
|
Packit |
ae235b |
g_return_if_fail (G_IS_PROXY_RESOLVER (resolver));
|
|
Packit |
ae235b |
g_return_if_fail (uri != NULL);
|
|
Packit |
ae235b |
|
|
Packit |
ae235b |
if (!_g_uri_parse_authority (uri, NULL, NULL, NULL, &error))
|
|
Packit |
ae235b |
{
|
|
Packit |
ae235b |
g_task_report_error (resolver, callback, user_data,
|
|
Packit |
ae235b |
g_proxy_resolver_lookup_async,
|
|
Packit |
ae235b |
g_steal_pointer (&error));
|
|
Packit |
ae235b |
return;
|
|
Packit |
ae235b |
}
|
|
Packit |
ae235b |
|
|
Packit |
ae235b |
iface = G_PROXY_RESOLVER_GET_IFACE (resolver);
|
|
Packit |
ae235b |
|
|
Packit |
ae235b |
(* iface->lookup_async) (resolver, uri, cancellable, callback, user_data);
|
|
Packit |
ae235b |
}
|
|
Packit |
ae235b |
|
|
Packit |
ae235b |
/**
|
|
Packit |
ae235b |
* g_proxy_resolver_lookup_finish:
|
|
Packit |
ae235b |
* @resolver: a #GProxyResolver
|
|
Packit |
ae235b |
* @result: the result passed to your #GAsyncReadyCallback
|
|
Packit |
ae235b |
* @error: return location for a #GError, or %NULL
|
|
Packit |
ae235b |
*
|
|
Packit |
ae235b |
* Call this function to obtain the array of proxy URIs when
|
|
Packit |
ae235b |
* g_proxy_resolver_lookup_async() is complete. See
|
|
Packit |
ae235b |
* g_proxy_resolver_lookup() for more details.
|
|
Packit |
ae235b |
*
|
|
Packit |
ae235b |
* Returns: (transfer full) (array zero-terminated=1): A
|
|
Packit |
ae235b |
* NULL-terminated array of proxy URIs. Must be freed
|
|
Packit |
ae235b |
* with g_strfreev().
|
|
Packit |
ae235b |
*
|
|
Packit |
ae235b |
* Since: 2.26
|
|
Packit |
ae235b |
*/
|
|
Packit |
ae235b |
gchar **
|
|
Packit |
ae235b |
g_proxy_resolver_lookup_finish (GProxyResolver *resolver,
|
|
Packit |
ae235b |
GAsyncResult *result,
|
|
Packit |
ae235b |
GError **error)
|
|
Packit |
ae235b |
{
|
|
Packit |
ae235b |
GProxyResolverInterface *iface;
|
|
Packit |
ae235b |
|
|
Packit |
ae235b |
g_return_val_if_fail (G_IS_PROXY_RESOLVER (resolver), NULL);
|
|
Packit |
ae235b |
|
|
Packit |
ae235b |
iface = G_PROXY_RESOLVER_GET_IFACE (resolver);
|
|
Packit |
ae235b |
|
|
Packit |
ae235b |
return (* iface->lookup_finish) (resolver, result, error);
|
|
Packit |
ae235b |
}
|