libsoup/soup-session.c

   1 /* -*- Mode: C; tab-width: 8; indent-tabs-mode: t; c-basic-offset: 8 -*- */
   2 /*
   3  * soup-session.c
   4  *
   5  * Copyright (C) 2000-2003, Ximian, Inc.
   6  */
   7
   8 #ifdef HAVE_CONFIG_H
   9 #include <config.h>
  10 #endif
  11
  12 #include <unistd.h>
  13 #include <string.h>
  14 #include <stdlib.h>
  15
  16 #include "soup-auth.h"
  17 #include "soup-auth-basic.h"
  18 #include "soup-auth-digest.h"
  19 #include "soup-auth-manager-ntlm.h"
  20 #include "soup-connection.h"
  21 #include "soup-marshal.h"
  22 #include "soup-message-private.h"
  23 #include "soup-message-queue.h"
  24 #include "soup-session.h"
  25 #include "soup-session-feature.h"
  26 #include "soup-session-private.h"
  27 #include "soup-socket.h"
  28 #include "soup-ssl.h"
  29 #include "soup-uri.h"
  30
  31 /**
  32  * SECTION:soup-session
  33  * @short_description: Soup session state object
  34  *
  35  * #SoupSession is the object that controls client-side HTTP. A
  36  * #SoupSession encapsulates all of the state that libsoup is keeping
  37  * on behalf of your program; cached HTTP connections, authentication
  38  * information, etc.
  39  *
  40  * Most applications will only need a single #SoupSession; the primary
  41  * reason you might need multiple sessions is if you need to have
  42  * multiple independent authentication contexts. (Eg, you are
  43  * connecting to a server and authenticating as two different users at
  44  * different times; the easiest way to ensure that each #SoupMessage
  45  * is sent with the authentication information you intended is to use
  46  * one session for the first user, and a second session for the other
  47  * user.)
  48  *
  49  * #SoupSession itself is an abstract class, with two subclasses. If
  50  * you are using the glib main loop, you will generally want to use
  51  * #SoupSessionAsync, which uses non-blocking I/O and callbacks. On
  52  * the other hand, if your application is threaded and you want to do
  53  * synchronous I/O in a separate thread from the UI, use
  54  * #SoupSessionSync.
  55  **/
  56
  57 typedef struct {
  58         SoupURI    *root_uri;
  59
  60         GSList     *connections;      /* CONTAINS: SoupConnection */
  61         guint       num_conns;
  62
  63         GHashTable *auth_realms;      /* path -> scheme:realm */
  64         GHashTable *auths;            /* scheme:realm -> SoupAuth */
  65 } SoupSessionHost;
  66
  67 typedef struct {
  68         SoupURI *proxy_uri;
  69         SoupAuth *proxy_auth;
  70
  71         char *ssl_ca_file;
  72         SoupSSLCredentials *ssl_creds;
  73
  74         SoupMessageQueue *queue;
  75
  76         char *user_agent;
  77
  78         GSList *features;
  79         SoupAuthManager *auth_manager;
  80
  81         GHashTable *hosts; /* SoupURI -> SoupSessionHost */
  82         GHashTable *conns; /* SoupConnection -> SoupSessionHost */
  83         guint num_conns;
  84         guint max_conns, max_conns_per_host;
  85         guint io_timeout, idle_timeout;
  86
  87         /* Must hold the host_lock before potentially creating a
  88          * new SoupSessionHost, or adding/removing a connection.
  89          * Must not emit signals or destroy objects while holding it.
  90          */
  91         GMutex *host_lock;
  92
  93         GMainContext *async_context;
  94 } SoupSessionPrivate;
  95 #define SOUP_SESSION_GET_PRIVATE(o) (G_TYPE_INSTANCE_GET_PRIVATE ((o), SOUP_TYPE_SESSION, SoupSessionPrivate))
  96
  97 static void     free_host      (SoupSessionHost *host);
  98
  99 static void queue_message   (SoupSession *session, SoupMessage *msg,
 100                              SoupSessionCallback callback, gpointer user_data);
 101 static void requeue_message (SoupSession *session, SoupMessage *msg);
 102 static void cancel_message  (SoupSession *session, SoupMessage *msg,
 103                              guint status_code);
 104
 105 static void auth_manager_authenticate (SoupAuthManager *manager,
 106                                        SoupMessage *msg, SoupAuth *auth,
 107                                        gboolean retrying, gpointer user_data);
 108
 109 /* temporary until we fix this to index hosts by SoupAddress */
 110 extern guint     soup_uri_host_hash  (gconstpointer  key);
 111 extern gboolean  soup_uri_host_equal (gconstpointer  v1,
 112                                       gconstpointer  v2);
 113 extern SoupURI  *soup_uri_copy_root  (SoupURI *uri);
 114
 115 #define SOUP_SESSION_MAX_CONNS_DEFAULT 10
 116 #define SOUP_SESSION_MAX_CONNS_PER_HOST_DEFAULT 2
 117
 118 #define SOUP_SESSION_USER_AGENT_BASE "libsoup/" PACKAGE_VERSION
 119
 120 G_DEFINE_TYPE (SoupSession, soup_session, G_TYPE_OBJECT)
 121
 122 enum {
 123         REQUEST_QUEUED,
 124         REQUEST_STARTED,
 125         REQUEST_UNQUEUED,
 126         AUTHENTICATE,
 127         LAST_SIGNAL
 128 };
 129
 130 static guint signals[LAST_SIGNAL] = { 0 };
 131
 132 enum {
 133         PROP_0,
 134
 135         PROP_PROXY_URI,
 136         PROP_MAX_CONNS,
 137         PROP_MAX_CONNS_PER_HOST,
 138         PROP_USE_NTLM,
 139         PROP_SSL_CA_FILE,
 140         PROP_ASYNC_CONTEXT,
 141         PROP_TIMEOUT,
 142         PROP_USER_AGENT,
 143         PROP_IDLE_TIMEOUT,
 144         PROP_ADD_FEATURE,
 145         PROP_ADD_FEATURE_BY_TYPE,
 146         PROP_REMOVE_FEATURE_BY_TYPE,
 147
 148         LAST_PROP
 149 };
 150
 151 static void set_property (GObject *object, guint prop_id,
 152                           const GValue *value, GParamSpec *pspec);
 153 static void get_property (GObject *object, guint prop_id,
 154                           GValue *value, GParamSpec *pspec);
 155
 156 static void
 157 soup_session_init (SoupSession *session)
 158 {
 159         SoupSessionPrivate *priv = SOUP_SESSION_GET_PRIVATE (session);
 160
 161         priv->queue = soup_message_queue_new ();
 162
 163         priv->host_lock = g_mutex_new ();
 164         priv->hosts = g_hash_table_new (soup_uri_host_hash,
 165                                         soup_uri_host_equal);
 166         priv->conns = g_hash_table_new (NULL, NULL);
 167
 168         priv->max_conns = SOUP_SESSION_MAX_CONNS_DEFAULT;
 169         priv->max_conns_per_host = SOUP_SESSION_MAX_CONNS_PER_HOST_DEFAULT;
 170
 171         priv->auth_manager = g_object_new (SOUP_TYPE_AUTH_MANAGER_NTLM,
 172                                            SOUP_AUTH_MANAGER_NTLM_USE_NTLM, FALSE,
 173                                            NULL);
 174         g_signal_connect (priv->auth_manager, "authenticate",
 175                           G_CALLBACK (auth_manager_authenticate), session);
 176         soup_auth_manager_add_type (priv->auth_manager, SOUP_TYPE_AUTH_BASIC);
 177         soup_auth_manager_add_type (priv->auth_manager, SOUP_TYPE_AUTH_DIGEST);
 178         soup_session_add_feature (session, SOUP_SESSION_FEATURE (priv->auth_manager));
 179 }
 180
 181 static gboolean
 182 foreach_free_host (gpointer key, gpointer host, gpointer data)
 183 {
 184         free_host (host);
 185         return TRUE;
 186 }
 187
 188 static void
 189 cleanup_hosts (SoupSessionPrivate *priv)
 190 {
 191         GHashTable *old_hosts;
 192
 193         g_mutex_lock (priv->host_lock);
 194         old_hosts = priv->hosts;
 195         priv->hosts = g_hash_table_new (soup_uri_host_hash,
 196                                         soup_uri_host_equal);
 197         g_mutex_unlock (priv->host_lock);
 198
 199         g_hash_table_foreach_remove (old_hosts, foreach_free_host, NULL);
 200         g_hash_table_destroy (old_hosts);
 201 }
 202
 203 static void
 204 dispose (GObject *object)
 205 {
 206         SoupSession *session = SOUP_SESSION (object);
 207         SoupSessionPrivate *priv = SOUP_SESSION_GET_PRIVATE (session);
 208
 209         soup_session_abort (session);
 210         cleanup_hosts (priv);
 211
 212         while (priv->features)
 213                 soup_session_remove_feature (session, priv->features->data);
 214
 215         G_OBJECT_CLASS (soup_session_parent_class)->dispose (object);
 216 }
 217
 218 static void
 219 finalize (GObject *object)
 220 {
 221         SoupSession *session = SOUP_SESSION (object);
 222         SoupSessionPrivate *priv = SOUP_SESSION_GET_PRIVATE (session);
 223
 224         soup_message_queue_destroy (priv->queue);
 225
 226         g_mutex_free (priv->host_lock);
 227         g_hash_table_destroy (priv->hosts);
 228         g_hash_table_destroy (priv->conns);
 229
 230         g_free (priv->user_agent);
 231
 232         if (priv->auth_manager)
 233                 g_object_unref (priv->auth_manager);
 234
 235         if (priv->proxy_uri)
 236                 soup_uri_free (priv->proxy_uri);
 237
 238         if (priv->ssl_creds)
 239                 soup_ssl_free_client_credentials (priv->ssl_creds);
 240
 241         if (priv->async_context)
 242                 g_main_context_unref (priv->async_context);
 243
 244         G_OBJECT_CLASS (soup_session_parent_class)->finalize (object);
 245 }
 246
 247 static void
 248 soup_session_class_init (SoupSessionClass *session_class)
 249 {
 250         GObjectClass *object_class = G_OBJECT_CLASS (session_class);
 251
 252         g_type_class_add_private (session_class, sizeof (SoupSessionPrivate));
 253
 254         /* virtual method definition */
 255         session_class->queue_message = queue_message;
 256         session_class->requeue_message = requeue_message;
 257         session_class->cancel_message = cancel_message;
 258
 259         /* virtual method override */
 260         object_class->dispose = dispose;
 261         object_class->finalize = finalize;
 262         object_class->set_property = set_property;
 263         object_class->get_property = get_property;
 264
 265         /* signals */
 266
 267         /**
 268          * SoupSession::request-queued:
 269          * @session: the session
 270          * @msg: the request that was queued
 271          *
 272          * Emitted when a request is queued on @session. (Note that
 273          * "queued" doesn't just mean soup_session_queue_message();
 274          * soup_session_send_message() implicitly queues the message
 275          * as well.)
 276          *
 277          * When sending a request, first #SoupSession::request_queued
 278          * is emitted, indicating that the session has become aware of
 279          * the request.
 280          *
 281          * Once a connection is available to send the request on, the
 282          * session emits #SoupSession::request_started. Then, various
 283          * #SoupMessage signals are emitted as the message is
 284          * processed. If the message is requeued, it will emit
 285          * #SoupMessage::restarted, which will then be followed by
 286          * another #SoupSession::request_started and another set of
 287          * #SoupMessage signals when the message is re-sent.
 288          *
 289          * Eventually, the message will emit #SoupMessage::finished.
 290          * Normally, this signals the completion of message
 291          * processing. However, it is possible that the application
 292          * will requeue the message from the "finished" handler (or
 293          * equivalently, from the soup_session_queue_message()
 294          * callback). In that case, the process will loop back to
 295          * #SoupSession::request_started.
 296          *
 297          * Eventually, a message will reach "finished" and not be
 298          * requeued. At that point, the session will emit
 299          * #SoupSession::request_unqueued to indicate that it is done
 300          * with the message.
 301          *
 302          * To sum up: #SoupSession::request_queued and
 303          * #SoupSession::request_unqueued are guaranteed to be emitted
 304          * exactly once, but #SoupSession::request_started and
 305          * #SoupMessage::finished (and all of the other #SoupMessage
 306          * signals) may be invoked multiple times for a given message.
 307          **/
 308         signals[REQUEST_QUEUED] =
 309                 g_signal_new ("request-queued",
 310                               G_OBJECT_CLASS_TYPE (object_class),
 311                               G_SIGNAL_RUN_FIRST,
 312                               0, /* FIXME? */
 313                               NULL, NULL,
 314                               soup_marshal_NONE__OBJECT,
 315                               G_TYPE_NONE, 1,
 316                               SOUP_TYPE_MESSAGE);
 317
 318         /**
 319          * SoupSession::request-started:
 320          * @session: the session
 321          * @msg: the request being sent
 322          * @socket: the socket the request is being sent on
 323          *
 324          * Emitted just before a request is sent. See
 325          * #SoupSession::request_queued for a detailed description of
 326          * the message lifecycle within a session.
 327          **/
 328         signals[REQUEST_STARTED] =
 329                 g_signal_new ("request-started",
 330                               G_OBJECT_CLASS_TYPE (object_class),
 331                               G_SIGNAL_RUN_FIRST,
 332                               G_STRUCT_OFFSET (SoupSessionClass, request_started),
 333                               NULL, NULL,
 334                               soup_marshal_NONE__OBJECT_OBJECT,
 335                               G_TYPE_NONE, 2,
 336                               SOUP_TYPE_MESSAGE,
 337                               SOUP_TYPE_SOCKET);
 338
 339         /**
 340          * SoupSession::request-unqueued:
 341          * @session: the session
 342          * @msg: the request that was unqueued
 343          *
 344          * Emitted when a request is removed from @session's queue,
 345          * indicating that @session is done with it. See
 346          * #SoupSession::request_queued for a detailed description of the
 347          * message lifecycle within a session.
 348          **/
 349         signals[REQUEST_UNQUEUED] =
 350                 g_signal_new ("request-unqueued",
 351                               G_OBJECT_CLASS_TYPE (object_class),
 352                               G_SIGNAL_RUN_FIRST,
 353                               0, /* FIXME? */
 354                               NULL, NULL,
 355                               soup_marshal_NONE__OBJECT,
 356                               G_TYPE_NONE, 1,
 357                               SOUP_TYPE_MESSAGE);
 358
 359         /**
 360          * SoupSession::authenticate:
 361          * @session: the session
 362          * @msg: the #SoupMessage being sent
 363          * @auth: the #SoupAuth to authenticate
 364          * @retrying: %TRUE if this is the second (or later) attempt
 365          *
 366          * Emitted when the session requires authentication. If
 367          * credentials are available call soup_auth_authenticate() on
 368          * @auth. If these credentials fail, the signal will be
 369          * emitted again, with @retrying set to %TRUE, which will
 370          * continue until you return without calling
 371          * soup_auth_authenticate() on @auth.
 372          *
 373          * Note that this may be emitted before @msg's body has been
 374          * fully read.
 375          *
 376          * If you call soup_session_pause_message() on @msg before
 377          * returning, then you can authenticate @auth asynchronously
 378          * (as long as you g_object_ref() it to make sure it doesn't
 379          * get destroyed), and then unpause @msg when you are ready
 380          * for it to continue.
 381          **/
 382         signals[AUTHENTICATE] =
 383                 g_signal_new ("authenticate",
 384                               G_OBJECT_CLASS_TYPE (object_class),
 385                               G_SIGNAL_RUN_FIRST,
 386                               G_STRUCT_OFFSET (SoupSessionClass, authenticate),
 387                               NULL, NULL,
 388                               soup_marshal_NONE__OBJECT_OBJECT_BOOLEAN,
 389                               G_TYPE_NONE, 3,
 390                               SOUP_TYPE_MESSAGE,
 391                               SOUP_TYPE_AUTH,
 392                               G_TYPE_BOOLEAN);
 393
 394         /* properties */
 395         g_object_class_install_property (
 396                 object_class, PROP_PROXY_URI,
 397                 g_param_spec_boxed (SOUP_SESSION_PROXY_URI,
 398                                     "Proxy URI",
 399                                     "The HTTP Proxy to use for this session",
 400                                     SOUP_TYPE_URI,
 401                                     G_PARAM_READWRITE));
 402         g_object_class_install_property (
 403                 object_class, PROP_MAX_CONNS,
 404                 g_param_spec_int (SOUP_SESSION_MAX_CONNS,
 405                                   "Max Connection Count",
 406                                   "The maximum number of connections that the session can open at once",
 407                                   1,
 408                                   G_MAXINT,
 409                                   SOUP_SESSION_MAX_CONNS_DEFAULT,
 410                                   G_PARAM_READWRITE));
 411         g_object_class_install_property (
 412                 object_class, PROP_MAX_CONNS_PER_HOST,
 413                 g_param_spec_int (SOUP_SESSION_MAX_CONNS_PER_HOST,
 414                                   "Max Per-Host Connection Count",
 415                                   "The maximum number of connections that the session can open at once to a given host",
 416                                   1,
 417                                   G_MAXINT,
 418                                   SOUP_SESSION_MAX_CONNS_PER_HOST_DEFAULT,
 419                                   G_PARAM_READWRITE));
 420         g_object_class_install_property (
 421                 object_class, PROP_IDLE_TIMEOUT,
 422                 g_param_spec_uint (SOUP_SESSION_IDLE_TIMEOUT,
 423                                    "Idle Timeout",
 424                                    "Connection lifetime when idle",
 425                                    0, G_MAXUINT, 0,
 426                                    G_PARAM_READWRITE));
 427         g_object_class_install_property (
 428                 object_class, PROP_USE_NTLM,
 429                 g_param_spec_boolean (SOUP_SESSION_USE_NTLM,
 430                                       "Use NTLM",
 431                                       "Whether or not to use NTLM authentication",
 432                                       FALSE,
 433                                       G_PARAM_READWRITE));
 434         g_object_class_install_property (
 435                 object_class, PROP_SSL_CA_FILE,
 436                 g_param_spec_string (SOUP_SESSION_SSL_CA_FILE,
 437                                      "SSL CA file",
 438                                      "File containing SSL CA certificates",
 439                                      NULL,
 440                                      G_PARAM_READWRITE));
 441         g_object_class_install_property (
 442                 object_class, PROP_ASYNC_CONTEXT,
 443                 g_param_spec_pointer (SOUP_SESSION_ASYNC_CONTEXT,
 444                                       "Async GMainContext",
 445                                       "The GMainContext to dispatch async I/O in",
 446                                       G_PARAM_READWRITE | G_PARAM_CONSTRUCT_ONLY));
 447         g_object_class_install_property (
 448                 object_class, PROP_TIMEOUT,
 449                 g_param_spec_uint (SOUP_SESSION_TIMEOUT,
 450                                    "Timeout value",
 451                                    "Value in seconds to timeout a blocking I/O",
 452                                    0, G_MAXUINT, 0,
 453                                    G_PARAM_READWRITE));
 454
 455         /**
 456          * SoupSession:user-agent:
 457          *
 458          * If non-%NULL, the value to use for the "User-Agent" header
 459          * on #SoupMessage<!-- -->s sent from this session.
 460          *
 461          * RFC 2616 says: "The User-Agent request-header field
 462          * contains information about the user agent originating the
 463          * request. This is for statistical purposes, the tracing of
 464          * protocol violations, and automated recognition of user
 465          * agents for the sake of tailoring responses to avoid
 466          * particular user agent limitations. User agents SHOULD
 467          * include this field with requests."
 468          *
 469          * The User-Agent header contains a list of one or more
 470          * product tokens, separated by whitespace, with the most
 471          * significant product token coming first. The tokens must be
 472          * brief, ASCII, and mostly alphanumeric (although "-", "_",
 473          * and "." are also allowed), and may optionally include a "/"
 474          * followed by a version string. You may also put comments,
 475          * enclosed in parentheses, between or after the tokens.
 476          *
 477          * If you set a %user_agent property that has trailing
 478          * whitespace, #SoupSession will append its own product token
 479          * (eg, "<literal>libsoup/2.3.2</literal>") to the end of the
 480          * header for you.
 481          **/
 482         g_object_class_install_property (
 483                 object_class, PROP_USER_AGENT,
 484                 g_param_spec_string (SOUP_SESSION_USER_AGENT,
 485                                      "User-Agent string",
 486                                      "User-Agent string",
 487                                      NULL,
 488                                      G_PARAM_READWRITE));
 489
 490         g_object_class_install_property (
 491                 object_class, PROP_ADD_FEATURE,
 492                 g_param_spec_object (SOUP_SESSION_ADD_FEATURE,
 493                                      "Add Feature",
 494                                      "Add a feature object to the session",
 495                                      SOUP_TYPE_SESSION_FEATURE,
 496                                      G_PARAM_READWRITE));
 497         g_object_class_install_property (
 498                 object_class, PROP_ADD_FEATURE_BY_TYPE,
 499                 g_param_spec_gtype (SOUP_SESSION_ADD_FEATURE_BY_TYPE,
 500                                     "Add Feature By Type",
 501                                     "Add a feature object of the given type to the session",
 502                                     SOUP_TYPE_SESSION_FEATURE,
 503                                     G_PARAM_READWRITE));
 504         g_object_class_install_property (
 505                 object_class, PROP_REMOVE_FEATURE_BY_TYPE,
 506                 g_param_spec_gtype (SOUP_SESSION_REMOVE_FEATURE_BY_TYPE,
 507                                     "Remove Feature By Type",
 508                                     "Remove features of the given type from the session",
 509                                     SOUP_TYPE_SESSION_FEATURE,
 510                                     G_PARAM_READWRITE));
 511 }
 512
 513 static gboolean
 514 safe_uri_equal (SoupURI *a, SoupURI *b)
 515 {
 516         if (!a && !b)
 517                 return TRUE;
 518
 519         if ((a && !b) || (b && !a))
 520                 return FALSE;
 521
 522         return soup_uri_equal (a, b);
 523 }
 524
 525 static gboolean
 526 safe_str_equal (const char *a, const char *b)
 527 {
 528         if (!a && !b)
 529                 return TRUE;
 530
 531         if ((a && !b) || (b && !a))
 532                 return FALSE;
 533
 534         return strcmp (a, b) == 0;
 535 }
 536
 537 static void
 538 set_property (GObject *object, guint prop_id,
 539               const GValue *value, GParamSpec *pspec)
 540 {
 541         SoupSession *session = SOUP_SESSION (object);
 542         SoupSessionPrivate *priv = SOUP_SESSION_GET_PRIVATE (session);
 543         SoupURI *uri;
 544         gboolean need_abort = FALSE;
 545         gboolean ca_file_changed = FALSE;
 546         const char *new_ca_file, *user_agent;
 547
 548         switch (prop_id) {
 549         case PROP_PROXY_URI:
 550                 uri = g_value_get_boxed (value);
 551
 552                 if (!safe_uri_equal (priv->proxy_uri, uri))
 553                         need_abort = TRUE;
 554
 555                 if (priv->proxy_uri)
 556                         soup_uri_free (priv->proxy_uri);
 557
 558                 priv->proxy_uri = uri ? soup_uri_copy (uri) : NULL;
 559
 560                 if (need_abort) {
 561                         soup_session_abort (session);
 562                         cleanup_hosts (priv);
 563                 }
 564
 565                 break;
 566         case PROP_MAX_CONNS:
 567                 priv->max_conns = g_value_get_int (value);
 568                 break;
 569         case PROP_MAX_CONNS_PER_HOST:
 570                 priv->max_conns_per_host = g_value_get_int (value);
 571                 break;
 572         case PROP_USE_NTLM:
 573                 g_object_set_property (G_OBJECT (priv->auth_manager),
 574                                        SOUP_AUTH_MANAGER_NTLM_USE_NTLM,
 575                                        value);
 576                 break;
 577         case PROP_SSL_CA_FILE:
 578                 new_ca_file = g_value_get_string (value);
 579
 580                 if (!safe_str_equal (priv->ssl_ca_file, new_ca_file))
 581                         ca_file_changed = TRUE;
 582
 583                 g_free (priv->ssl_ca_file);
 584                 priv->ssl_ca_file = g_strdup (new_ca_file);
 585
 586                 if (ca_file_changed) {
 587                         if (priv->ssl_creds) {
 588                                 soup_ssl_free_client_credentials (priv->ssl_creds);
 589                                 priv->ssl_creds = NULL;
 590                         }
 591
 592                         cleanup_hosts (priv);
 593                 }
 594
 595                 break;
 596         case PROP_ASYNC_CONTEXT:
 597                 priv->async_context = g_value_get_pointer (value);
 598                 if (priv->async_context)
 599                         g_main_context_ref (priv->async_context);
 600                 break;
 601         case PROP_TIMEOUT:
 602                 priv->io_timeout = g_value_get_uint (value);
 603                 break;
 604         case PROP_USER_AGENT:
 605                 g_free (priv->user_agent);
 606                 user_agent = g_value_get_string (value);
 607                 if (!user_agent)
 608                         priv->user_agent = NULL;
 609                 else if (!*user_agent) {
 610                         priv->user_agent =
 611                                 g_strdup (SOUP_SESSION_USER_AGENT_BASE);
 612                 } else if (g_str_has_suffix (user_agent, " ")) {
 613                         priv->user_agent =
 614                                 g_strdup_printf ("%s%s", user_agent,
 615                                                  SOUP_SESSION_USER_AGENT_BASE);
 616                 } else
 617                         priv->user_agent = g_strdup (user_agent);
 618                 break;
 619         case PROP_IDLE_TIMEOUT:
 620                 priv->idle_timeout = g_value_get_uint (value);
 621                 break;
 622         case PROP_ADD_FEATURE:
 623                 soup_session_add_feature (session, g_value_get_object (value));
 624                 break;
 625         case PROP_ADD_FEATURE_BY_TYPE:
 626                 soup_session_add_feature_by_type (session, g_value_get_gtype (value));
 627                 break;
 628         case PROP_REMOVE_FEATURE_BY_TYPE:
 629                 soup_session_remove_feature_by_type (session, g_value_get_gtype (value));
 630                 break;
 631         default:
 632                 G_OBJECT_WARN_INVALID_PROPERTY_ID (object, prop_id, pspec);
 633                 break;
 634         }
 635 }
 636
 637 static void
 638 get_property (GObject *object, guint prop_id,
 639               GValue *value, GParamSpec *pspec)
 640 {
 641         SoupSession *session = SOUP_SESSION (object);
 642         SoupSessionPrivate *priv = SOUP_SESSION_GET_PRIVATE (session);
 643
 644         switch (prop_id) {
 645         case PROP_PROXY_URI:
 646                 g_value_set_boxed (value, priv->proxy_uri);
 647                 break;
 648         case PROP_MAX_CONNS:
 649                 g_value_set_int (value, priv->max_conns);
 650                 break;
 651         case PROP_MAX_CONNS_PER_HOST:
 652                 g_value_set_int (value, priv->max_conns_per_host);
 653                 break;
 654         case PROP_USE_NTLM:
 655                 g_object_get_property (G_OBJECT (priv->auth_manager),
 656                                        SOUP_AUTH_MANAGER_NTLM_USE_NTLM,
 657                                        value);
 658                 break;
 659         case PROP_SSL_CA_FILE:
 660                 g_value_set_string (value, priv->ssl_ca_file);
 661                 break;
 662         case PROP_ASYNC_CONTEXT:
 663                 g_value_set_pointer (value, priv->async_context ? g_main_context_ref (priv->async_context) : NULL);
 664                 break;
 665         case PROP_TIMEOUT:
 666                 g_value_set_uint (value, priv->io_timeout);
 667                 break;
 668         case PROP_USER_AGENT:
 669                 g_value_set_string (value, priv->user_agent);
 670                 break;
 671         case PROP_IDLE_TIMEOUT:
 672                 g_value_set_uint (value, priv->idle_timeout);
 673                 break;
 674         default:
 675                 G_OBJECT_WARN_INVALID_PROPERTY_ID (object, prop_id, pspec);
 676                 break;
 677         }
 678 }
 679
 680
 681 /**
 682  * soup_session_get_async_context:
 683  * @session: a #SoupSession
 684  *
 685  * Gets @session's async_context. This does not add a ref to the
 686  * context, so you will need to ref it yourself if you want it to
 687  * outlive its session.
 688  *
 689  * Return value: @session's #GMainContext, which may be %NULL
 690  **/
 691 GMainContext *
 692 soup_session_get_async_context (SoupSession *session)
 693 {
 694         SoupSessionPrivate *priv;
 695
 696         g_return_val_if_fail (SOUP_IS_SESSION (session), NULL);
 697         priv = SOUP_SESSION_GET_PRIVATE (session);
 698
 699         return priv->async_context;
 700 }
 701
 702 /* Hosts */
 703
 704 static SoupSessionHost *
 705 soup_session_host_new (SoupSession *session, SoupURI *source_uri)
 706 {
 707         SoupSessionPrivate *priv = SOUP_SESSION_GET_PRIVATE (session);
 708         SoupSessionHost *host;
 709
 710         host = g_slice_new0 (SoupSessionHost);
 711         host->root_uri = soup_uri_copy_root (source_uri);
 712
 713         if (host->root_uri->scheme == SOUP_URI_SCHEME_HTTPS &&
 714             !priv->ssl_creds) {
 715                 priv->ssl_creds =
 716                         soup_ssl_get_client_credentials (priv->ssl_ca_file);
 717         }
 718
 719         return host;
 720 }
 721
 722 /* Note: get_host_for_message doesn't lock the host_lock. The caller
 723  * must do it itself if there's a chance the host doesn't already
 724  * exist.
 725  */
 726 static SoupSessionHost *
 727 get_host_for_message (SoupSession *session, SoupMessage *msg)
 728 {
 729         SoupSessionPrivate *priv = SOUP_SESSION_GET_PRIVATE (session);
 730         SoupSessionHost *host;
 731         SoupURI *source = soup_message_get_uri (msg);
 732
 733         host = g_hash_table_lookup (priv->hosts, source);
 734         if (host)
 735                 return host;
 736
 737         host = soup_session_host_new (session, source);
 738         g_hash_table_insert (priv->hosts, host->root_uri, host);
 739
 740         return host;
 741 }
 742
 743 static void
 744 free_host (SoupSessionHost *host)
 745 {
 746         while (host->connections) {
 747                 SoupConnection *conn = host->connections->data;
 748
 749                 host->connections = g_slist_remove (host->connections, conn);
 750                 soup_connection_disconnect (conn);
 751         }
 752
 753         soup_uri_free (host->root_uri);
 754         g_slice_free (SoupSessionHost, host);
 755 }
 756
 757 static void
 758 auth_manager_authenticate (SoupAuthManager *manager, SoupMessage *msg,
 759                            SoupAuth *auth, gboolean retrying,
 760                            gpointer session)
 761 {
 762         g_signal_emit (session, signals[AUTHENTICATE], 0, msg, auth, retrying);
 763 }
 764
 765 static void
 766 redirect_handler (SoupMessage *msg, gpointer user_data)
 767 {
 768         SoupSession *session = user_data;
 769         const char *new_loc;
 770         SoupURI *new_uri;
 771
 772         new_loc = soup_message_headers_get (msg->response_headers, "Location");
 773         g_return_if_fail (new_loc != NULL);
 774
 775         if (msg->status_code == SOUP_STATUS_MOVED_PERMANENTLY ||
 776             msg->status_code == SOUP_STATUS_TEMPORARY_REDIRECT) {
 777                 /* Don't redirect non-safe methods */
 778                 if (msg->method != SOUP_METHOD_GET &&
 779                     msg->method != SOUP_METHOD_HEAD &&
 780                     msg->method != SOUP_METHOD_OPTIONS &&
 781                     msg->method != SOUP_METHOD_PROPFIND)
 782                         return;
 783         } else if (msg->status_code == SOUP_STATUS_SEE_OTHER ||
 784                    msg->status_code == SOUP_STATUS_FOUND) {
 785                 /* Redirect using a GET */
 786                 g_object_set (msg,
 787                               SOUP_MESSAGE_METHOD, SOUP_METHOD_GET,
 788                               NULL);
 789                 soup_message_set_request (msg, NULL,
 790                                           SOUP_MEMORY_STATIC, NULL, 0);
 791                 soup_message_headers_set_encoding (msg->request_headers,
 792                                                    SOUP_ENCODING_NONE);
 793         } else {
 794                 /* Three possibilities:
 795                  *
 796                  *   1) This was a non-3xx response that happened to
 797                  *      have a "Location" header
 798                  *   2) It's a non-redirecty 3xx response (300, 304,
 799                  *      305, 306)
 800                  *   3) It's some newly-defined 3xx response (308+)
 801                  *
 802                  * We ignore all of these cases. In the first two,
 803                  * redirecting would be explicitly wrong, and in the
 804                  * last case, we have no clue if the 3xx response is
 805                  * supposed to be redirecty or non-redirecty. Plus,
 806                  * 2616 says unrecognized status codes should be
 807                  * treated as the equivalent to the x00 code, and we
 808                  * don't redirect on 300, so therefore we shouldn't
 809                  * redirect on 308+ either.
 810                  */
 811                 return;
 812         }
 813
 814         /* Location is supposed to be an absolute URI, but some sites
 815          * are lame, so we use soup_uri_new_with_base().
 816          */
 817         new_uri = soup_uri_new_with_base (soup_message_get_uri (msg), new_loc);
 818         if (!SOUP_URI_VALID_FOR_HTTP (new_uri)) {
 819                 if (new_uri)
 820                         soup_uri_free (new_uri);
 821                 soup_message_set_status_full (msg,
 822                                               SOUP_STATUS_MALFORMED,
 823                                               "Invalid Redirect URL");
 824                 return;
 825         }
 826
 827         soup_message_set_uri (msg, new_uri);
 828         soup_uri_free (new_uri);
 829
 830         soup_session_requeue_message (session, msg);
 831 }
 832
 833 static void
 834 connection_started_request (SoupConnection *conn, SoupMessage *msg,
 835                             gpointer data)
 836 {
 837         SoupSession *session = data;
 838         SoupSessionPrivate *priv = SOUP_SESSION_GET_PRIVATE (session);
 839
 840         if (priv->user_agent) {
 841                 soup_message_headers_replace (msg->request_headers,
 842                                               "User-Agent", priv->user_agent);
 843         }
 844
 845         /* Kludge to deal with the fact that CONNECT msgs come from the
 846          * SoupConnection rather than being queued normally.
 847          */
 848         if (msg->method == SOUP_METHOD_CONNECT)
 849                 g_signal_emit (session, signals[REQUEST_QUEUED], 0, msg);
 850
 851         g_signal_emit (session, signals[REQUEST_STARTED], 0,
 852                        msg, soup_connection_get_socket (conn));
 853 }
 854
 855 gboolean
 856 soup_session_try_prune_connection (SoupSession *session)
 857 {
 858         SoupSessionPrivate *priv = SOUP_SESSION_GET_PRIVATE (session);
 859         GPtrArray *conns;
 860         GHashTableIter iter;
 861         gpointer conn, host;
 862         int i;
 863
 864         conns = g_ptr_array_new ();
 865
 866         g_mutex_lock (priv->host_lock);
 867         g_hash_table_iter_init (&iter, priv->conns);
 868         while (g_hash_table_iter_next (&iter, &conn, &host)) {
 869                 /* Don't prune a connection that is currently in use,
 870                  * or hasn't been used yet.
 871                  */
 872                 if (!soup_connection_is_in_use (conn) &&
 873                     soup_connection_last_used (conn) > 0)
 874                         g_ptr_array_add (conns, g_object_ref (conn));
 875         }
 876         g_mutex_unlock (priv->host_lock);
 877
 878         if (!conns->len) {
 879                 g_ptr_array_free (conns, TRUE);
 880                 return FALSE;
 881         }
 882
 883         for (i = 0; i < conns->len; i++) {
 884                 soup_connection_disconnect (conns->pdata[i]);
 885                 g_object_unref (conns->pdata[i]);
 886         }
 887         g_ptr_array_free (conns, TRUE);
 888
 889         return TRUE;
 890 }
 891
 892 static void
 893 connection_disconnected (SoupConnection *conn, gpointer user_data)
 894 {
 895         SoupSession *session = user_data;
 896         SoupSessionPrivate *priv = SOUP_SESSION_GET_PRIVATE (session);
 897         SoupSessionHost *host;
 898
 899         g_mutex_lock (priv->host_lock);
 900
 901         host = g_hash_table_lookup (priv->conns, conn);
 902         if (host) {
 903                 g_hash_table_remove (priv->conns, conn);
 904                 host->connections = g_slist_remove (host->connections, conn);
 905                 host->num_conns--;
 906         }
 907
 908         g_signal_handlers_disconnect_by_func (conn, connection_disconnected, session);
 909         priv->num_conns--;
 910
 911         g_mutex_unlock (priv->host_lock);
 912         g_object_unref (conn);
 913 }
 914
 915 static void
 916 connect_result (SoupConnection *conn, guint status, gpointer user_data)
 917 {
 918         SoupSession *session = user_data;
 919         SoupSessionPrivate *priv = SOUP_SESSION_GET_PRIVATE (session);
 920         SoupSessionHost *host;
 921         SoupMessageQueueIter iter;
 922         SoupMessage *msg;
 923
 924         g_mutex_lock (priv->host_lock);
 925
 926         host = g_hash_table_lookup (priv->conns, conn);
 927         if (!host) {
 928                 g_mutex_unlock (priv->host_lock);
 929                 return;
 930         }
 931
 932         if (status == SOUP_STATUS_OK) {
 933                 soup_connection_reserve (conn);
 934                 host->connections = g_slist_prepend (host->connections, conn);
 935                 g_mutex_unlock (priv->host_lock);
 936                 return;
 937         }
 938
 939         /* The connection failed. */
 940         g_mutex_unlock (priv->host_lock);
 941         connection_disconnected (conn, session);
 942
 943         if (host->connections) {
 944                 /* Something went wrong this time, but we have at
 945                  * least one open connection to this host. So just
 946                  * leave the message in the queue so it can use that
 947                  * connection once it's free.
 948                  */
 949                 return;
 950         }
 951
 952         /* There are two possibilities: either status is
 953          * SOUP_STATUS_TRY_AGAIN, in which case the session implementation
 954          * will create a new connection (and all we need to do here
 955          * is downgrade the message from CONNECTING to QUEUED); or
 956          * status is something else, probably CANT_CONNECT or
 957          * CANT_RESOLVE or the like, in which case we need to cancel
 958          * any messages waiting for this host, since they're out
 959          * of luck.
 960          */
 961         for (msg = soup_message_queue_first (priv->queue, &iter); msg; msg = soup_message_queue_next (priv->queue, &iter)) {
 962                 if (get_host_for_message (session, msg) == host) {
 963                         if (status == SOUP_STATUS_TRY_AGAIN) {
 964                                 if (soup_message_get_io_status (msg) == SOUP_MESSAGE_IO_STATUS_CONNECTING)
 965                                         soup_message_set_io_status (msg, SOUP_MESSAGE_IO_STATUS_QUEUED);
 966                         } else {
 967                                 soup_session_cancel_message (session, msg,
 968                                                              status);
 969                         }
 970                 }
 971         }
 972 }
 973
 974 /**
 975  * soup_session_get_connection:
 976  * @session: a #SoupSession
 977  * @msg: a #SoupMessage
 978  * @try_pruning: on return, whether or not to try pruning a connection
 979  * @is_new: on return, %TRUE if the returned connection is new and not
 980  * yet connected
 981  *
 982  * Tries to find or create a connection for @msg; this is an internal
 983  * method for #SoupSession subclasses.
 984  *
 985  * If there is an idle connection to the relevant host available, then
 986  * that connection will be returned (with *@is_new set to %FALSE). The
 987  * connection will be marked "reserved", so the caller must call
 988  * soup_connection_release() if it ends up not using the connection
 989  * right away.
 990  *
 991  * If there is no idle connection available, but it is possible to
 992  * create a new connection, then one will be created and returned,
 993  * with *@is_new set to %TRUE. The caller MUST then call
 994  * soup_connection_connect_sync() or soup_connection_connect_async()
 995  * to connect it. If the connection attempt succeeds, the connection
 996  * will be marked "reserved" and added to @session's connection pool
 997  * once it connects. If the connection attempt fails, the connection
 998  * will be unreffed.
 999  *
1000  * If no connection is available and a new connection cannot be made,
1001  * soup_session_get_connection() will return %NULL. If @session has
1002  * the maximum number of open connections open, but does not have the
1003  * maximum number of per-host connections open to the relevant host,
1004  * then *@try_pruning will be set to %TRUE. In this case, the caller
1005  * can call soup_session_try_prune_connection() to close an idle
1006  * connection, and then try soup_session_get_connection() again. (If
1007  * calling soup_session_try_prune_connection() wouldn't help, then
1008  * *@try_pruning is left untouched; it is NOT set to %FALSE.)
1009  *
1010  * Return value: a #SoupConnection, or %NULL
1011  **/
1012 SoupConnection *
1013 soup_session_get_connection (SoupSession *session, SoupMessage *msg,
1014                              gboolean *try_pruning, gboolean *is_new)
1015 {
1016         SoupSessionPrivate *priv = SOUP_SESSION_GET_PRIVATE (session);
1017         SoupConnection *conn;
1018         SoupSessionHost *host;
1019         GSList *conns;
1020
1021         g_mutex_lock (priv->host_lock);
1022
1023         host = get_host_for_message (session, msg);
1024         for (conns = host->connections; conns; conns = conns->next) {
1025                 if (!soup_connection_is_in_use (conns->data)) {
1026                         soup_connection_reserve (conns->data);
1027                         g_mutex_unlock (priv->host_lock);
1028                         *is_new = FALSE;
1029                         return conns->data;
1030                 }
1031         }
1032
1033         if (soup_message_get_io_status (msg) == SOUP_MESSAGE_IO_STATUS_CONNECTING) {
1034                 /* We already started a connection for this
1035                  * message, so don't start another one.
1036                  */
1037                 g_mutex_unlock (priv->host_lock);
1038                 return NULL;
1039         }
1040
1041         if (host->num_conns >= priv->max_conns_per_host) {
1042                 g_mutex_unlock (priv->host_lock);
1043                 return NULL;
1044         }
1045
1046         if (priv->num_conns >= priv->max_conns) {
1047                 *try_pruning = TRUE;
1048                 g_mutex_unlock (priv->host_lock);
1049                 return NULL;
1050         }
1051
1052         conn = soup_connection_new (
1053                 SOUP_CONNECTION_ORIGIN_URI, host->root_uri,
1054                 SOUP_CONNECTION_PROXY_URI, priv->proxy_uri,
1055                 SOUP_CONNECTION_SSL_CREDENTIALS, priv->ssl_creds,
1056                 SOUP_CONNECTION_ASYNC_CONTEXT, priv->async_context,
1057                 SOUP_CONNECTION_TIMEOUT, priv->io_timeout,
1058                 SOUP_CONNECTION_IDLE_TIMEOUT, priv->idle_timeout,
1059                 NULL);
1060         g_signal_connect (conn, "connect_result",
1061                           G_CALLBACK (connect_result),
1062                           session);
1063         g_signal_connect (conn, "disconnected",
1064                           G_CALLBACK (connection_disconnected),
1065                           session);
1066         g_signal_connect (conn, "request_started",
1067                           G_CALLBACK (connection_started_request),
1068                           session);
1069
1070         g_hash_table_insert (priv->conns, conn, host);
1071
1072         /* We increment the connection counts so it counts against the
1073          * totals, but we don't add it to the host's connection list
1074          * yet, since it's not ready for use.
1075          */
1076         priv->num_conns++;
1077         host->num_conns++;
1078
1079         /* Mark the request as connecting, so we don't try to open
1080          * another new connection for it while waiting for this one.
1081          */
1082         soup_message_set_io_status (msg, SOUP_MESSAGE_IO_STATUS_CONNECTING);
1083
1084         g_mutex_unlock (priv->host_lock);
1085         *is_new = TRUE;
1086         return conn;
1087 }
1088
1089 SoupMessageQueue *
1090 soup_session_get_queue (SoupSession *session)
1091 {
1092         SoupSessionPrivate *priv = SOUP_SESSION_GET_PRIVATE (session);
1093
1094         return priv->queue;
1095 }
1096
1097 static void
1098 message_finished (SoupMessage *msg, gpointer user_data)
1099 {
1100         SoupSession *session = user_data;
1101         SoupSessionPrivate *priv = SOUP_SESSION_GET_PRIVATE (session);
1102
1103         if (!SOUP_MESSAGE_IS_STARTING (msg)) {
1104                 soup_message_queue_remove_message (priv->queue, msg);
1105                 g_signal_handlers_disconnect_by_func (msg, message_finished, session);
1106                 g_signal_handlers_disconnect_by_func (msg, redirect_handler, session);
1107                 g_signal_emit (session, signals[REQUEST_UNQUEUED], 0, msg);
1108         }
1109 }
1110
1111 static void
1112 queue_message (SoupSession *session, SoupMessage *msg,
1113                SoupSessionCallback callback, gpointer user_data)
1114 {
1115         SoupSessionPrivate *priv = SOUP_SESSION_GET_PRIVATE (session);
1116
1117         g_signal_connect_after (msg, "finished",
1118                                 G_CALLBACK (message_finished), session);
1119
1120         if (!(soup_message_get_flags (msg) & SOUP_MESSAGE_NO_REDIRECT)) {
1121                 soup_message_add_header_handler (
1122                         msg, "got_body", "Location",
1123                         G_CALLBACK (redirect_handler), session);
1124         }
1125
1126         soup_message_set_io_status (msg, SOUP_MESSAGE_IO_STATUS_QUEUED);
1127         soup_message_queue_append (priv->queue, msg);
1128
1129         g_signal_emit (session, signals[REQUEST_QUEUED], 0, msg);
1130 }
1131
1132 /**
1133  * SoupSessionCallback:
1134  * @session: the session
1135  * @msg: the message that has finished
1136  * @user_data: the data passed to soup_session_queue_message
1137  *
1138  * Prototype for the callback passed to soup_session_queue_message(),
1139  * qv.
1140  **/
1141
1142 /**
1143  * soup_session_queue_message:
1144  * @session: a #SoupSession
1145  * @msg: the message to queue
1146  * @callback: a #SoupSessionCallback which will be called after the
1147  * message completes or when an unrecoverable error occurs.
1148  * @user_data: a pointer passed to @callback.
1149  *
1150  * Queues the message @msg for sending. All messages are processed
1151  * while the glib main loop runs. If @msg has been processed before,
1152  * any resources related to the time it was last sent are freed.
1153  *
1154  * Upon message completion, the callback specified in @callback will
1155  * be invoked (in the thread associated with @session's async
1156  * context). If after returning from this callback the message has not
1157  * been requeued, @msg will be unreffed.
1158  */
1159 void
1160 soup_session_queue_message (SoupSession *session, SoupMessage *msg,
1161                             SoupSessionCallback callback, gpointer user_data)
1162 {
1163         g_return_if_fail (SOUP_IS_SESSION (session));
1164         g_return_if_fail (SOUP_IS_MESSAGE (msg));
1165
1166         SOUP_SESSION_GET_CLASS (session)->queue_message (session, msg,
1167                                                          callback, user_data);
1168 }
1169
1170 static void
1171 requeue_message (SoupSession *session, SoupMessage *msg)
1172 {
1173         soup_message_set_io_status (msg, SOUP_MESSAGE_IO_STATUS_QUEUED);
1174 }
1175
1176 /**
1177  * soup_session_requeue_message:
1178  * @session: a #SoupSession
1179  * @msg: the message to requeue
1180  *
1181  * This causes @msg to be placed back on the queue to be attempted
1182  * again.
1183  **/
1184 void
1185 soup_session_requeue_message (SoupSession *session, SoupMessage *msg)
1186 {
1187         g_return_if_fail (SOUP_IS_SESSION (session));
1188         g_return_if_fail (SOUP_IS_MESSAGE (msg));
1189
1190         SOUP_SESSION_GET_CLASS (session)->requeue_message (session, msg);
1191 }
1192
1193
1194 /**
1195  * soup_session_send_message:
1196  * @session: a #SoupSession
1197  * @msg: the message to send
1198  *
1199  * Synchronously send @msg. This call will not return until the
1200  * transfer is finished successfully or there is an unrecoverable
1201  * error.
1202  *
1203  * @msg is not freed upon return.
1204  *
1205  * Return value: the HTTP status code of the response
1206  */
1207 guint
1208 soup_session_send_message (SoupSession *session, SoupMessage *msg)
1209 {
1210         g_return_val_if_fail (SOUP_IS_SESSION (session), SOUP_STATUS_MALFORMED);
1211         g_return_val_if_fail (SOUP_IS_MESSAGE (msg), SOUP_STATUS_MALFORMED);
1212
1213         return SOUP_SESSION_GET_CLASS (session)->send_message (session, msg);
1214 }
1215
1216
1217 /**
1218  * soup_session_pause_message:
1219  * @session: a #SoupSession
1220  * @msg: a #SoupMessage currently running on @session
1221  *
1222  * Pauses HTTP I/O on @msg. Call soup_session_unpause_message() to
1223  * resume I/O.
1224  **/
1225 void
1226 soup_session_pause_message (SoupSession *session,
1227                             SoupMessage *msg)
1228 {
1229         g_return_if_fail (SOUP_IS_SESSION (session));
1230         g_return_if_fail (SOUP_IS_MESSAGE (msg));
1231
1232         soup_message_io_pause (msg);
1233 }
1234
1235 /**
1236  * soup_session_unpause_message:
1237  * @session: a #SoupSession
1238  * @msg: a #SoupMessage currently running on @session
1239  *
1240  * Resumes HTTP I/O on @msg. Use this to resume after calling
1241  * soup_sessino_pause_message().
1242  *
1243  * If @msg is being sent via blocking I/O, this will resume reading or
1244  * writing immediately. If @msg is using non-blocking I/O, then
1245  * reading or writing won't resume until you return to the main loop.
1246  **/
1247 void
1248 soup_session_unpause_message (SoupSession *session,
1249                               SoupMessage *msg)
1250 {
1251         g_return_if_fail (SOUP_IS_SESSION (session));
1252         g_return_if_fail (SOUP_IS_MESSAGE (msg));
1253
1254         soup_message_io_unpause (msg);
1255 }
1256
1257
1258 static void
1259 cancel_message (SoupSession *session, SoupMessage *msg, guint status_code)
1260 {
1261         SoupSessionPrivate *priv = SOUP_SESSION_GET_PRIVATE (session);
1262
1263         soup_message_queue_remove_message (priv->queue, msg);
1264         soup_message_io_stop (msg);
1265         soup_message_set_status (msg, status_code);
1266         soup_message_finished (msg);
1267 }
1268
1269 /**
1270  * soup_session_cancel_message:
1271  * @session: a #SoupSession
1272  * @msg: the message to cancel
1273  * @status_code: status code to set on @msg (generally
1274  * %SOUP_STATUS_CANCELLED)
1275  *
1276  * Causes @session to immediately finish processing @msg, with a final
1277  * status_code of @status_code. Depending on when you cancel it, the
1278  * response state may be incomplete or inconsistent.
1279  **/
1280 void
1281 soup_session_cancel_message (SoupSession *session, SoupMessage *msg,
1282                              guint status_code)
1283 {
1284         g_return_if_fail (SOUP_IS_SESSION (session));
1285         g_return_if_fail (SOUP_IS_MESSAGE (msg));
1286
1287         SOUP_SESSION_GET_CLASS (session)->cancel_message (session, msg, status_code);
1288 }
1289
1290 static void
1291 gather_conns (gpointer key, gpointer host, gpointer data)
1292 {
1293         SoupConnection *conn = key;
1294         GSList **conns = data;
1295
1296         *conns = g_slist_prepend (*conns, conn);
1297 }
1298
1299 /**
1300  * soup_session_abort:
1301  * @session: the session
1302  *
1303  * Cancels all pending requests in @session.
1304  **/
1305 void
1306 soup_session_abort (SoupSession *session)
1307 {
1308         SoupSessionPrivate *priv;
1309         SoupMessageQueueIter iter;
1310         SoupMessage *msg;
1311         GSList *conns, *c;
1312
1313         g_return_if_fail (SOUP_IS_SESSION (session));
1314         priv = SOUP_SESSION_GET_PRIVATE (session);
1315
1316         for (msg = soup_message_queue_first (priv->queue, &iter);
1317              msg;
1318              msg = soup_message_queue_next (priv->queue, &iter)) {
1319                 soup_session_cancel_message (session, msg,
1320                                              SOUP_STATUS_CANCELLED);
1321         }
1322
1323         /* Close all connections */
1324         g_mutex_lock (priv->host_lock);
1325         conns = NULL;
1326         g_hash_table_foreach (priv->conns, gather_conns, &conns);
1327
1328         for (c = conns; c; c = c->next)
1329                 g_object_ref (c->data);
1330         g_mutex_unlock (priv->host_lock);
1331         for (c = conns; c; c = c->next) {
1332                 soup_connection_disconnect (c->data);
1333                 g_object_unref (c->data);
1334         }
1335
1336         g_slist_free (conns);
1337 }
1338
1339 void
1340 soup_session_add_feature (SoupSession *session, SoupSessionFeature *feature)
1341 {
1342         SoupSessionPrivate *priv;
1343
1344         g_return_if_fail (SOUP_IS_SESSION (session));
1345         g_return_if_fail (SOUP_IS_SESSION_FEATURE (feature));
1346
1347         priv = SOUP_SESSION_GET_PRIVATE (session);
1348         priv->features = g_slist_prepend (priv->features, g_object_ref (feature));
1349         soup_session_feature_attach (feature, session);
1350 }
1351
1352 void
1353 soup_session_add_feature_by_type (SoupSession *session, GType feature_type)
1354 {
1355         SoupSessionFeature *feature;
1356
1357         g_return_if_fail (SOUP_IS_SESSION (session));
1358         g_return_if_fail (g_type_is_a (feature_type, SOUP_TYPE_SESSION_FEATURE));
1359
1360         feature = g_object_new (feature_type, NULL);
1361         soup_session_add_feature (session, feature);
1362         g_object_unref (feature);
1363 }
1364
1365 void
1366 soup_session_remove_feature (SoupSession *session, SoupSessionFeature *feature)
1367 {
1368         SoupSessionPrivate *priv;
1369
1370         g_return_if_fail (SOUP_IS_SESSION (session));
1371
1372         priv = SOUP_SESSION_GET_PRIVATE (session);
1373         if (g_slist_find (priv->features, feature)) {
1374                 priv->features = g_slist_remove (priv->features, feature);
1375                 soup_session_feature_detach (feature, session);
1376                 g_object_unref (feature);
1377         }
1378 }
1379
1380 void
1381 soup_session_remove_feature_by_type (SoupSession *session, GType feature_type)
1382 {
1383         SoupSessionPrivate *priv;
1384         GSList *f;
1385
1386         g_return_if_fail (SOUP_IS_SESSION (session));
1387
1388         priv = SOUP_SESSION_GET_PRIVATE (session);
1389 restart:
1390         for (f = priv->features; f; f = f->next) {
1391                 if (G_TYPE_CHECK_INSTANCE_TYPE (f->data, feature_type)) {
1392                         soup_session_remove_feature (session, f->data);
1393                         goto restart;
1394                 }
1395         }
1396 }