libpurple/proxy.h

   1 /* purple
   2  *
   3  * Purple is the legal property of its developers, whose names are too numerous
   4  * to list here.  Please refer to the COPYRIGHT file distributed with this
   5  * source distribution.
   6  *
   7  * This program is free software; you can redistribute it and/or modify
   8  * it under the terms of the GNU General Public License as published by
   9  * the Free Software Foundation; either version 2 of the License, or
  10  * (at your option) any later version.
  11  *
  12  * This program 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
  15  * GNU General Public License for more details.
  16  *
  17  * You should have received a copy of the GNU General Public License
  18  * along with this program; if not, write to the Free Software
  19  * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02111-1301  USA
  20  */
  21
  22 #ifndef PURPLE_PROXY_H
  23 #define PURPLE_PROXY_H
  24 /**
  25  * SECTION:proxy
  26  * @section_id: libpurple-proxy
  27  * @short_description: <filename>proxy.h</filename>
  28  * @title: Proxy API
  29  */
  30
  31 #include <glib.h>
  32 #include <gio/gio.h>
  33 #include "eventloop.h"
  34
  35 /**
  36  * PurpleProxyType:
  37  * @PURPLE_PROXY_USE_GLOBAL: Use the global proxy information.
  38  * @PURPLE_PROXY_NONE:       No proxy.
  39  * @PURPLE_PROXY_HTTP:       HTTP proxy.
  40  * @PURPLE_PROXY_SOCKS4:     SOCKS 4 proxy.
  41  * @PURPLE_PROXY_SOCKS5:     SOCKS 5 proxy.
  42  * @PURPLE_PROXY_USE_ENVVAR: Use environmental settings.
  43  * @PURPLE_PROXY_TOR:        Use a Tor proxy (SOCKS 5 really).
  44  *
  45  * A type of proxy connection.
  46  */
  47 typedef enum
  48 {
  49         PURPLE_PROXY_USE_GLOBAL = -1,
  50         PURPLE_PROXY_NONE = 0,
  51         PURPLE_PROXY_HTTP,
  52         PURPLE_PROXY_SOCKS4,
  53         PURPLE_PROXY_SOCKS5,
  54         PURPLE_PROXY_USE_ENVVAR,
  55         PURPLE_PROXY_TOR
  56
  57 } PurpleProxyType;
  58
  59 /**
  60  * PurpleProxyInfo:
  61  *
  62  * Information on proxy settings.
  63  */
  64 typedef struct _PurpleProxyInfo PurpleProxyInfo;
  65
  66 typedef struct _PurpleProxyConnectData PurpleProxyConnectData;
  67
  68 typedef void (*PurpleProxyConnectFunction)(gpointer data, gint source, const gchar *error_message);
  69
  70
  71 #include "account.h"
  72
  73 G_BEGIN_DECLS
  74
  75 /**************************************************************************/
  76 /* Proxy structure API                                                    */
  77 /**************************************************************************/
  78
  79 /**
  80  * purple_proxy_info_get_type:
  81  *
  82  * Returns: The #GType for proxy information.
  83  */
  84 GType purple_proxy_info_get_type(void);
  85
  86 /**
  87  * purple_proxy_info_new:
  88  *
  89  * Creates a proxy information structure.
  90  *
  91  * Returns: The proxy information structure.
  92  */
  93 PurpleProxyInfo *purple_proxy_info_new(void);
  94
  95 /**
  96  * purple_proxy_info_destroy:
  97  * @info: The proxy information structure to destroy.
  98  *
  99  * Destroys a proxy information structure.
 100  */
 101 void purple_proxy_info_destroy(PurpleProxyInfo *info);
 102
 103 /**
 104  * purple_proxy_info_set_proxy_type:
 105  * @info: The proxy information.
 106  * @type: The proxy type.
 107  *
 108  * Sets the type of proxy.
 109  */
 110 void purple_proxy_info_set_proxy_type(PurpleProxyInfo *info, PurpleProxyType type);
 111
 112 /**
 113  * purple_proxy_info_set_host:
 114  * @info: The proxy information.
 115  * @host: The host.
 116  *
 117  * Sets the proxy host.
 118  */
 119 void purple_proxy_info_set_host(PurpleProxyInfo *info, const char *host);
 120
 121 /**
 122  * purple_proxy_info_set_port:
 123  * @info: The proxy information.
 124  * @port: The port.
 125  *
 126  * Sets the proxy port.
 127  */
 128 void purple_proxy_info_set_port(PurpleProxyInfo *info, int port);
 129
 130 /**
 131  * purple_proxy_info_set_username:
 132  * @info:     The proxy information.
 133  * @username: The username.
 134  *
 135  * Sets the proxy username.
 136  */
 137 void purple_proxy_info_set_username(PurpleProxyInfo *info, const char *username);
 138
 139 /**
 140  * purple_proxy_info_set_password:
 141  * @info:     The proxy information.
 142  * @password: The password.
 143  *
 144  * Sets the proxy password.
 145  */
 146 void purple_proxy_info_set_password(PurpleProxyInfo *info, const char *password);
 147
 148 /**
 149  * purple_proxy_info_get_proxy_type:
 150  * @info: The proxy information.
 151  *
 152  * Returns the proxy's type.
 153  *
 154  * Returns: The type.
 155  */
 156 PurpleProxyType purple_proxy_info_get_proxy_type(const PurpleProxyInfo *info);
 157
 158 /**
 159  * purple_proxy_info_get_host:
 160  * @info: The proxy information.
 161  *
 162  * Returns the proxy's host.
 163  *
 164  * Returns: The host.
 165  */
 166 const char *purple_proxy_info_get_host(const PurpleProxyInfo *info);
 167
 168 /**
 169  * purple_proxy_info_get_port:
 170  * @info: The proxy information.
 171  *
 172  * Returns the proxy's port.
 173  *
 174  * Returns: The port.
 175  */
 176 int purple_proxy_info_get_port(const PurpleProxyInfo *info);
 177
 178 /**
 179  * purple_proxy_info_get_username:
 180  * @info: The proxy information.
 181  *
 182  * Returns the proxy's username.
 183  *
 184  * Returns: The username.
 185  */
 186 const char *purple_proxy_info_get_username(const PurpleProxyInfo *info);
 187
 188 /**
 189  * purple_proxy_info_get_password:
 190  * @info: The proxy information.
 191  *
 192  * Returns the proxy's password.
 193  *
 194  * Returns: The password.
 195  */
 196 const char *purple_proxy_info_get_password(const PurpleProxyInfo *info);
 197
 198 /**************************************************************************/
 199 /* Global Proxy API                                                       */
 200 /**************************************************************************/
 201
 202 /**
 203  * purple_global_proxy_get_info:
 204  *
 205  * Returns purple's global proxy information.
 206  *
 207  * Returns: The global proxy information.
 208  */
 209 PurpleProxyInfo *purple_global_proxy_get_info(void);
 210
 211 /**
 212  * purple_global_proxy_set_info:
 213  * @info:     The proxy information.
 214  *
 215  * Set purple's global proxy information.
 216  */
 217 void purple_global_proxy_set_info(PurpleProxyInfo *info);
 218
 219 /**************************************************************************/
 220 /* Proxy API                                                              */
 221 /**************************************************************************/
 222
 223 /**
 224  * purple_proxy_get_handle:
 225  *
 226  * Returns the proxy subsystem handle.
 227  *
 228  * Returns: The proxy subsystem handle.
 229  */
 230 void *purple_proxy_get_handle(void);
 231
 232 /**
 233  * purple_proxy_init:
 234  *
 235  * Initializes the proxy subsystem.
 236  */
 237 void purple_proxy_init(void);
 238
 239 /**
 240  * purple_proxy_uninit:
 241  *
 242  * Uninitializes the proxy subsystem.
 243  */
 244 void purple_proxy_uninit(void);
 245
 246 /**
 247  * purple_proxy_get_setup:
 248  * @account: The account for which the configuration is needed.
 249  *
 250  * Returns configuration of a proxy.
 251  *
 252  * Returns: The configuration of a proxy.
 253  */
 254 PurpleProxyInfo *purple_proxy_get_setup(PurpleAccount *account);
 255
 256 /**
 257  * purple_proxy_connect: (skip)
 258  * @handle:     A handle that should be associated with this
 259  *              connection attempt.  The handle can be used
 260  *              to cancel the connection attempt using the
 261  *              purple_proxy_connect_cancel_with_handle()
 262  *              function.
 263  * @account:    The account making the connection.
 264  * @host:       The destination host.
 265  * @port:       The destination port.
 266  * @connect_cb: (scope call): The function to call when the connection is
 267  *              established.  If the connection failed then
 268  *              fd will be -1 and error message will be set
 269  *              to something descriptive (hopefully).
 270  * @data:       User-defined data.
 271  *
 272  * Makes a connection to the specified host and port.  Note that this
 273  * function name can be misleading--although it is called "proxy
 274  * connect," it is used for establishing any outgoing TCP connection,
 275  * whether through a proxy or not.
 276  *
 277  * Returns: NULL if there was an error, or a reference to an
 278  *         opaque data structure that can be used to cancel
 279  *         the pending connection, if needed.
 280  */
 281 PurpleProxyConnectData *purple_proxy_connect(void *handle,
 282                         PurpleAccount *account,
 283                         const char *host, int port,
 284                         PurpleProxyConnectFunction connect_cb, gpointer data);
 285
 286 /**
 287  * purple_proxy_connect_socks5_account: (skip)
 288  * @handle:     A handle that should be associated with this
 289  *              connection attempt.  The handle can be used
 290  *              to cancel the connection attempt using the
 291  *              purple_proxy_connect_cancel_with_handle()
 292  *              function.
 293  * @account:    The account making the connection.
 294  * @gpi:        The PurpleProxyInfo specifying the proxy settings
 295  * @host:       The destination host.
 296  * @port:       The destination port.
 297  * @connect_cb: (scope call): The function to call when the connection is
 298  *              established.  If the connection failed then
 299  *              fd will be -1 and error message will be set
 300  *              to something descriptive (hopefully).
 301  * @data:       User-defined data.
 302  *
 303  * Makes a connection through a SOCKS5 proxy.
 304  *
 305  * Note that if the account that is making the connection uses a proxy, this
 306  * connection to a SOCKS5 proxy will be made through the account proxy.
 307  *
 308  * Returns: NULL if there was an error, or a reference to an
 309  *         opaque data structure that can be used to cancel
 310  *         the pending connection, if needed.
 311  */
 312 PurpleProxyConnectData *purple_proxy_connect_socks5_account(void *handle,
 313                         PurpleAccount *account, PurpleProxyInfo *gpi,
 314                         const char *host, int port,
 315                         PurpleProxyConnectFunction connect_cb, gpointer data);
 316
 317 /**
 318  * purple_proxy_connect_cancel: (skip)
 319  * @connect_data: The #PurpleProxyConnectData to cancel.
 320  *
 321  * Cancel an in-progress connection attempt.  This should be called
 322  * by the protocol if the user disables an account while it is still
 323  * performing the initial sign on.  Or when establishing a file
 324  * transfer, if we attempt to connect to a remote user but they
 325  * are behind a firewall then the protocol can cancel the connection
 326  * attempt early rather than just letting the OS's TCP/IP stack
 327  * time-out the connection.
 328  */
 329 void purple_proxy_connect_cancel(PurpleProxyConnectData *connect_data);
 330
 331 /**
 332  * purple_proxy_connect_cancel_with_handle: (skip)
 333  * @handle: The handle.
 334  *
 335  * Closes all proxy connections registered with the specified handle.
 336  */
 337 void purple_proxy_connect_cancel_with_handle(void *handle);
 338
 339 /**
 340  * purple_proxy_get_proxy_resolver:
 341  * @account: The account for which to get the proxy resolver.
 342  * @error: Return location for a GError, or NULL.
 343  *
 344  * Returns a #GProxyResolver capable of resolving which proxy
 345  * to use for this account, if any. This object can be given to a
 346  * #GSocketClient for automatic proxy handling or can be used
 347  * directly if desired.
 348  *
 349  * Returns: (transfer full): NULL if there was an error with the
 350  *         account's (or system) proxy settings, or a reference to
 351  *         a #GProxyResolver on success.
 352  */
 353 GProxyResolver *purple_proxy_get_proxy_resolver(PurpleAccount *account,
 354                 GError **error);
 355
 356 G_END_DECLS
 357
 358 #endif /* PURPLE_PROXY_H */