libsoup/soup-cookie-jar.c

   1 /* -*- Mode: C; tab-width: 8; indent-tabs-mode: t; c-basic-offset: 8 -*- */
   2 /*
   3  * soup-cookie-jar.c
   4  *
   5  * Copyright (C) 2008 Red Hat, Inc.
   6  */
   7
   8 #ifdef HAVE_CONFIG_H
   9 #include <config.h>
  10 #endif
  11
  12 #include <string.h>
  13
  14 #include "soup-cookie-jar.h"
  15 #include "soup.h"
  16 #include "soup-marshal.h"
  17
  18 /**
  19  * SECTION:soup-cookie-jar
  20  * @short_description: Automatic cookie handling for #SoupSession
  21  *
  22  * A #SoupCookieJar stores #SoupCookie<!-- -->s and arrange for them
  23  * to be sent with the appropriate #SoupMessage<!-- -->s.
  24  * #SoupCookieJar implements #SoupSessionFeature, so you can add a
  25  * cookie jar to a session with soup_session_add_feature() or
  26  * soup_session_add_feature_by_type().
  27  *
  28  * Note that the base #SoupCookieJar class does not support any form
  29  * of long-term cookie persistence.
  30  **/
  31
  32 static void soup_cookie_jar_session_feature_init (SoupSessionFeatureInterface *feature_interface, gpointer interface_data);
  33
  34 G_DEFINE_TYPE_WITH_CODE (SoupCookieJar, soup_cookie_jar, G_TYPE_OBJECT,
  35                          G_IMPLEMENT_INTERFACE (SOUP_TYPE_SESSION_FEATURE,
  36                                                 soup_cookie_jar_session_feature_init))
  37
  38 enum {
  39         CHANGED,
  40         LAST_SIGNAL
  41 };
  42
  43 static guint signals[LAST_SIGNAL] = { 0 };
  44
  45 enum {
  46         PROP_0,
  47
  48         PROP_READ_ONLY,
  49         PROP_ACCEPT_POLICY,
  50
  51         LAST_PROP
  52 };
  53
  54 typedef struct {
  55         gboolean constructed, read_only;
  56         GHashTable *domains, *serials;
  57         guint serial;
  58         SoupCookieJarAcceptPolicy accept_policy;
  59 } SoupCookieJarPrivate;
  60 #define SOUP_COOKIE_JAR_GET_PRIVATE(o) (G_TYPE_INSTANCE_GET_PRIVATE ((o), SOUP_TYPE_COOKIE_JAR, SoupCookieJarPrivate))
  61
  62 static void
  63 soup_cookie_jar_init (SoupCookieJar *jar)
  64 {
  65         SoupCookieJarPrivate *priv = SOUP_COOKIE_JAR_GET_PRIVATE (jar);
  66
  67         priv->domains = g_hash_table_new_full (soup_str_case_hash,
  68                                                soup_str_case_equal,
  69                                                g_free, NULL);
  70         priv->serials = g_hash_table_new (NULL, NULL);
  71         priv->accept_policy = SOUP_COOKIE_JAR_ACCEPT_ALWAYS;
  72 }
  73
  74 static void
  75 soup_cookie_jar_constructed (GObject *object)
  76 {
  77         SoupCookieJarPrivate *priv = SOUP_COOKIE_JAR_GET_PRIVATE (object);
  78
  79         priv->constructed = TRUE;
  80 }
  81
  82 static void
  83 soup_cookie_jar_finalize (GObject *object)
  84 {
  85         SoupCookieJarPrivate *priv = SOUP_COOKIE_JAR_GET_PRIVATE (object);
  86         GHashTableIter iter;
  87         gpointer key, value;
  88
  89         g_hash_table_iter_init (&iter, priv->domains);
  90         while (g_hash_table_iter_next (&iter, &key, &value))
  91                 soup_cookies_free (value);
  92         g_hash_table_destroy (priv->domains);
  93         g_hash_table_destroy (priv->serials);
  94
  95         G_OBJECT_CLASS (soup_cookie_jar_parent_class)->finalize (object);
  96 }
  97
  98 static void
  99 soup_cookie_jar_set_property (GObject *object, guint prop_id,
 100                               const GValue *value, GParamSpec *pspec)
 101 {
 102         SoupCookieJarPrivate *priv =
 103                 SOUP_COOKIE_JAR_GET_PRIVATE (object);
 104
 105         switch (prop_id) {
 106         case PROP_READ_ONLY:
 107                 priv->read_only = g_value_get_boolean (value);
 108                 break;
 109         case PROP_ACCEPT_POLICY:
 110                 priv->accept_policy = g_value_get_enum (value);
 111                 break;
 112         default:
 113                 G_OBJECT_WARN_INVALID_PROPERTY_ID (object, prop_id, pspec);
 114                 break;
 115         }
 116 }
 117
 118 static void
 119 soup_cookie_jar_get_property (GObject *object, guint prop_id,
 120                               GValue *value, GParamSpec *pspec)
 121 {
 122         SoupCookieJarPrivate *priv =
 123                 SOUP_COOKIE_JAR_GET_PRIVATE (object);
 124
 125         switch (prop_id) {
 126         case PROP_READ_ONLY:
 127                 g_value_set_boolean (value, priv->read_only);
 128                 break;
 129         case PROP_ACCEPT_POLICY:
 130                 g_value_set_enum (value, priv->accept_policy);
 131                 break;
 132         default:
 133                 G_OBJECT_WARN_INVALID_PROPERTY_ID (object, prop_id, pspec);
 134                 break;
 135         }
 136 }
 137
 138 static gboolean
 139 soup_cookie_jar_real_is_persistent (SoupCookieJar *jar)
 140 {
 141         return FALSE;
 142 }
 143
 144 static void
 145 soup_cookie_jar_class_init (SoupCookieJarClass *jar_class)
 146 {
 147         GObjectClass *object_class = G_OBJECT_CLASS (jar_class);
 148
 149         g_type_class_add_private (jar_class, sizeof (SoupCookieJarPrivate));
 150
 151         object_class->constructed = soup_cookie_jar_constructed;
 152         object_class->finalize = soup_cookie_jar_finalize;
 153         object_class->set_property = soup_cookie_jar_set_property;
 154         object_class->get_property = soup_cookie_jar_get_property;
 155
 156         jar_class->is_persistent = soup_cookie_jar_real_is_persistent;
 157
 158         /**
 159          * SoupCookieJar::changed:
 160          * @jar: the #SoupCookieJar
 161          * @old_cookie: the old #SoupCookie value
 162          * @new_cookie: the new #SoupCookie value
 163          *
 164          * Emitted when @jar changes. If a cookie has been added,
 165          * @new_cookie will contain the newly-added cookie and
 166          * @old_cookie will be %NULL. If a cookie has been deleted,
 167          * @old_cookie will contain the to-be-deleted cookie and
 168          * @new_cookie will be %NULL. If a cookie has been changed,
 169          * @old_cookie will contain its old value, and @new_cookie its
 170          * new value.
 171          **/
 172         signals[CHANGED] =
 173                 g_signal_new ("changed",
 174                               G_OBJECT_CLASS_TYPE (object_class),
 175                               G_SIGNAL_RUN_FIRST,
 176                               G_STRUCT_OFFSET (SoupCookieJarClass, changed),
 177                               NULL, NULL,
 178                               _soup_marshal_NONE__BOXED_BOXED,
 179                               G_TYPE_NONE, 2,
 180                               SOUP_TYPE_COOKIE | G_SIGNAL_TYPE_STATIC_SCOPE,
 181                               SOUP_TYPE_COOKIE | G_SIGNAL_TYPE_STATIC_SCOPE);
 182
 183         /**
 184          * SOUP_COOKIE_JAR_READ_ONLY:
 185          *
 186          * Alias for the #SoupCookieJar:read-only property. (Whether
 187          * or not the cookie jar is read-only.)
 188          **/
 189         g_object_class_install_property (
 190                 object_class, PROP_READ_ONLY,
 191                 g_param_spec_boolean (SOUP_COOKIE_JAR_READ_ONLY,
 192                                       "Read-only",
 193                                       "Whether or not the cookie jar is read-only",
 194                                       FALSE,
 195                                       G_PARAM_READWRITE | G_PARAM_CONSTRUCT_ONLY));
 196
 197         /**
 198          * SOUP_COOKIE_JAR_ACCEPT_POLICY:
 199          *
 200          * Alias for the #SoupCookieJar:accept-policy property.
 201          *
 202          * Since: 2.30
 203          */
 204         /**
 205          * SoupCookieJar:accept-policy:
 206          *
 207          * The policy the jar should follow to accept or reject cookies
 208          *
 209          * Since: 2.30
 210          */
 211         g_object_class_install_property (
 212                 object_class, PROP_ACCEPT_POLICY,
 213                 g_param_spec_enum (SOUP_COOKIE_JAR_ACCEPT_POLICY,
 214                                    "Accept-policy",
 215                                    "The policy the jar should follow to accept or reject cookies",
 216                                    SOUP_TYPE_COOKIE_JAR_ACCEPT_POLICY,
 217                                    SOUP_COOKIE_JAR_ACCEPT_ALWAYS,
 218                                    G_PARAM_READWRITE));
 219 }
 220
 221 /**
 222  * soup_cookie_jar_new:
 223  *
 224  * Creates a new #SoupCookieJar. The base #SoupCookieJar class does
 225  * not support persistent storage of cookies; use a subclass for that.
 226  *
 227  * Returns: a new #SoupCookieJar
 228  *
 229  * Since: 2.24
 230  **/
 231 SoupCookieJar *
 232 soup_cookie_jar_new (void)
 233 {
 234         return g_object_new (SOUP_TYPE_COOKIE_JAR, NULL);
 235 }
 236
 237 /**
 238  * soup_cookie_jar_save:
 239  * @jar: a #SoupCookieJar
 240  *
 241  * This function exists for backward compatibility, but does not do
 242  * anything any more; cookie jars are saved automatically when they
 243  * are changed.
 244  *
 245  * Since: 2.24
 246  *
 247  * Deprecated: This is a no-op.
 248  */
 249 void
 250 soup_cookie_jar_save (SoupCookieJar *jar)
 251 {
 252         /* Does nothing, obsolete */
 253 }
 254
 255 static void
 256 soup_cookie_jar_changed (SoupCookieJar *jar,
 257                          SoupCookie *old, SoupCookie *new)
 258 {
 259         SoupCookieJarPrivate *priv = SOUP_COOKIE_JAR_GET_PRIVATE (jar);
 260
 261         if (old && old != new)
 262                 g_hash_table_remove (priv->serials, old);
 263         if (new) {
 264                 priv->serial++;
 265                 g_hash_table_insert (priv->serials, new, GUINT_TO_POINTER (priv->serial));
 266         }
 267
 268         if (priv->read_only || !priv->constructed)
 269                 return;
 270
 271         g_signal_emit (jar, signals[CHANGED], 0, old, new);
 272 }
 273
 274 static int
 275 compare_cookies (gconstpointer a, gconstpointer b, gpointer jar)
 276 {
 277         SoupCookie *ca = (SoupCookie *)a;
 278         SoupCookie *cb = (SoupCookie *)b;
 279         SoupCookieJarPrivate *priv = SOUP_COOKIE_JAR_GET_PRIVATE (jar);
 280         int alen, blen;
 281         guint aserial, bserial;
 282
 283         /* "Cookies with longer path fields are listed before cookies
 284          * with shorter path field."
 285          */
 286         alen = ca->path ? strlen (ca->path) : 0;
 287         blen = cb->path ? strlen (cb->path) : 0;
 288         if (alen != blen)
 289                 return blen - alen;
 290
 291         /* "Among cookies that have equal length path fields, cookies
 292          * with earlier creation dates are listed before cookies with
 293          * later creation dates."
 294          */
 295         aserial = GPOINTER_TO_UINT (g_hash_table_lookup (priv->serials, ca));
 296         bserial = GPOINTER_TO_UINT (g_hash_table_lookup (priv->serials, cb));
 297         return aserial - bserial;
 298 }
 299
 300 static GSList *
 301 get_cookies (SoupCookieJar *jar, SoupURI *uri, gboolean for_http, gboolean copy_cookies)
 302 {
 303         SoupCookieJarPrivate *priv;
 304         GSList *cookies, *domain_cookies;
 305         char *domain, *cur, *next_domain;
 306         GSList *new_head, *cookies_to_remove = NULL, *p;
 307
 308         priv = SOUP_COOKIE_JAR_GET_PRIVATE (jar);
 309
 310         if (!uri->host)
 311                 return NULL;
 312
 313         /* The logic here is a little weird, but the plan is that if
 314          * uri->host is "www.foo.com", we will end up looking up
 315          * cookies for ".www.foo.com", "www.foo.com", ".foo.com", and
 316          * ".com", in that order. (Logic stolen from Mozilla.)
 317          */
 318         cookies = NULL;
 319         domain = cur = g_strdup_printf (".%s", uri->host);
 320         next_domain = domain + 1;
 321         do {
 322                 new_head = domain_cookies = g_hash_table_lookup (priv->domains, cur);
 323                 while (domain_cookies) {
 324                         GSList *next = domain_cookies->next;
 325                         SoupCookie *cookie = domain_cookies->data;
 326
 327                         if (cookie->expires && soup_date_is_past (cookie->expires)) {
 328                                 cookies_to_remove = g_slist_append (cookies_to_remove,
 329                                                                     cookie);
 330                                 new_head = g_slist_delete_link (new_head, domain_cookies);
 331                                 g_hash_table_insert (priv->domains,
 332                                                      g_strdup (cur),
 333                                                      new_head);
 334                         } else if (soup_cookie_applies_to_uri (cookie, uri) &&
 335                                    (for_http || !cookie->http_only))
 336                                 cookies = g_slist_append (cookies, copy_cookies ? soup_cookie_copy (cookie) : cookie);
 337
 338                         domain_cookies = next;
 339                 }
 340                 cur = next_domain;
 341                 if (cur)
 342                         next_domain = strchr (cur + 1, '.');
 343         } while (cur);
 344         g_free (domain);
 345
 346         for (p = cookies_to_remove; p; p = p->next) {
 347                 SoupCookie *cookie = p->data;
 348
 349                 soup_cookie_jar_changed (jar, cookie, NULL);
 350                 soup_cookie_free (cookie);
 351         }
 352         g_slist_free (cookies_to_remove);
 353
 354         return g_slist_sort_with_data (cookies, compare_cookies, jar);
 355 }
 356
 357 /**
 358  * soup_cookie_jar_get_cookies:
 359  * @jar: a #SoupCookieJar
 360  * @uri: a #SoupURI
 361  * @for_http: whether or not the return value is being passed directly
 362  * to an HTTP operation
 363  *
 364  * Retrieves (in Cookie-header form) the list of cookies that would
 365  * be sent with a request to @uri.
 366  *
 367  * If @for_http is %TRUE, the return value will include cookies marked
 368  * "HttpOnly" (that is, cookies that the server wishes to keep hidden
 369  * from client-side scripting operations such as the JavaScript
 370  * document.cookies property). Since #SoupCookieJar sets the Cookie
 371  * header itself when making the actual HTTP request, you should
 372  * almost certainly be setting @for_http to %FALSE if you are calling
 373  * this.
 374  *
 375  * Return value: the cookies, in string form, or %NULL if there are no
 376  * cookies for @uri.
 377  *
 378  * Since: 2.24
 379  **/
 380 char *
 381 soup_cookie_jar_get_cookies (SoupCookieJar *jar, SoupURI *uri,
 382                              gboolean for_http)
 383 {
 384         GSList *cookies;
 385
 386         g_return_val_if_fail (SOUP_IS_COOKIE_JAR (jar), NULL);
 387         g_return_val_if_fail (uri != NULL, NULL);
 388
 389         cookies = get_cookies (jar, uri, for_http, FALSE);
 390
 391         if (cookies) {
 392                 char *result = soup_cookies_to_cookie_header (cookies);
 393                 g_slist_free (cookies);
 394
 395                 if (!*result) {
 396                         g_free (result);
 397                         result = NULL;
 398                 }
 399                 return result;
 400         } else
 401                 return NULL;
 402 }
 403
 404 /**
 405  * soup_cookie_jar_get_cookie_list:
 406  * @jar: a #SoupCookieJar
 407  * @uri: a #SoupURI
 408  * @for_http: whether or not the return value is being passed directly
 409  * to an HTTP operation
 410  *
 411  * Retrieves the list of cookies that would be sent with a request to @uri
 412  * as a #GSList of #SoupCookie objects.
 413  *
 414  * If @for_http is %TRUE, the return value will include cookies marked
 415  * "HttpOnly" (that is, cookies that the server wishes to keep hidden
 416  * from client-side scripting operations such as the JavaScript
 417  * document.cookies property). Since #SoupCookieJar sets the Cookie
 418  * header itself when making the actual HTTP request, you should
 419  * almost certainly be setting @for_http to %FALSE if you are calling
 420  * this.
 421  *
 422  * Return value: (transfer full) (element-type Soup.Cookie): a #GSList
 423  * with the cookies in the @jar that would be sent with a request to @uri.
 424  *
 425  * Since: 2.40
 426  **/
 427 GSList *
 428 soup_cookie_jar_get_cookie_list (SoupCookieJar *jar, SoupURI *uri, gboolean for_http)
 429 {
 430         g_return_val_if_fail (SOUP_IS_COOKIE_JAR (jar), NULL);
 431         g_return_val_if_fail (uri != NULL, NULL);
 432
 433         return get_cookies (jar, uri, for_http, TRUE);
 434 }
 435
 436 /**
 437  * soup_cookie_jar_add_cookie:
 438  * @jar: a #SoupCookieJar
 439  * @cookie: (transfer full): a #SoupCookie
 440  *
 441  * Adds @cookie to @jar, emitting the 'changed' signal if we are modifying
 442  * an existing cookie or adding a valid new cookie ('valid' means
 443  * that the cookie's expire date is not in the past).
 444  *
 445  * @cookie will be 'stolen' by the jar, so don't free it afterwards.
 446  *
 447  * Since: 2.26
 448  **/
 449 void
 450 soup_cookie_jar_add_cookie (SoupCookieJar *jar, SoupCookie *cookie)
 451 {
 452         SoupCookieJarPrivate *priv;
 453         GSList *old_cookies, *oc, *last = NULL;
 454         SoupCookie *old_cookie;
 455
 456         g_return_if_fail (SOUP_IS_COOKIE_JAR (jar));
 457         g_return_if_fail (cookie != NULL);
 458
 459         /* Never accept cookies for public domains. */
 460         if (!g_hostname_is_ip_address (cookie->domain) &&
 461             soup_tld_domain_is_public_suffix (cookie->domain)) {
 462                 soup_cookie_free (cookie);
 463                 return;
 464         }
 465
 466         priv = SOUP_COOKIE_JAR_GET_PRIVATE (jar);
 467         old_cookies = g_hash_table_lookup (priv->domains, cookie->domain);
 468         for (oc = old_cookies; oc; oc = oc->next) {
 469                 old_cookie = oc->data;
 470                 if (!strcmp (cookie->name, old_cookie->name) &&
 471                     !g_strcmp0 (cookie->path, old_cookie->path)) {
 472                         if (cookie->expires && soup_date_is_past (cookie->expires)) {
 473                                 /* The new cookie has an expired date,
 474                                  * this is the way the the server has
 475                                  * of telling us that we have to
 476                                  * remove the cookie.
 477                                  */
 478                                 old_cookies = g_slist_delete_link (old_cookies, oc);
 479                                 g_hash_table_insert (priv->domains,
 480                                                      g_strdup (cookie->domain),
 481                                                      old_cookies);
 482                                 soup_cookie_jar_changed (jar, old_cookie, NULL);
 483                                 soup_cookie_free (old_cookie);
 484                                 soup_cookie_free (cookie);
 485                         } else {
 486                                 oc->data = cookie;
 487                                 soup_cookie_jar_changed (jar, old_cookie, cookie);
 488                                 soup_cookie_free (old_cookie);
 489                         }
 490
 491                         return;
 492                 }
 493                 last = oc;
 494         }
 495
 496         /* The new cookie is... a new cookie */
 497         if (cookie->expires && soup_date_is_past (cookie->expires)) {
 498                 soup_cookie_free (cookie);
 499                 return;
 500         }
 501
 502         if (last)
 503                 last->next = g_slist_append (NULL, cookie);
 504         else {
 505                 old_cookies = g_slist_append (NULL, cookie);
 506                 g_hash_table_insert (priv->domains, g_strdup (cookie->domain),
 507                                      old_cookies);
 508         }
 509
 510         soup_cookie_jar_changed (jar, NULL, cookie);
 511 }
 512
 513 /**
 514  * soup_cookie_jar_add_cookie_with_first_party:
 515  * @jar: a #SoupCookieJar
 516  * @first_party: the URI for the main document
 517  * @cookie: (transfer full): a #SoupCookie
 518  *
 519  * Adds @cookie to @jar, emitting the 'changed' signal if we are modifying
 520  * an existing cookie or adding a valid new cookie ('valid' means
 521  * that the cookie's expire date is not in the past).
 522  *
 523  * @first_party will be used to reject cookies coming from third party
 524  * resources in case such a security policy is set in the @jar.
 525  *
 526  * @cookie will be 'stolen' by the jar, so don't free it afterwards.
 527  *
 528  * Since: 2.40
 529  **/
 530 void
 531 soup_cookie_jar_add_cookie_with_first_party (SoupCookieJar *jar, SoupURI *first_party, SoupCookie *cookie)
 532 {
 533         SoupCookieJarPrivate *priv;
 534
 535         g_return_if_fail (SOUP_IS_COOKIE_JAR (jar));
 536         g_return_if_fail (first_party != NULL);
 537         g_return_if_fail (cookie != NULL);
 538
 539         priv = SOUP_COOKIE_JAR_GET_PRIVATE (jar);
 540         if (priv->accept_policy == SOUP_COOKIE_JAR_ACCEPT_NEVER) {
 541                 soup_cookie_free (cookie);
 542                 return;
 543         }
 544
 545         if (priv->accept_policy == SOUP_COOKIE_JAR_ACCEPT_ALWAYS ||
 546             soup_cookie_domain_matches (cookie, first_party->host)) {
 547                 /* will steal or free soup_cookie */
 548                 soup_cookie_jar_add_cookie (jar, cookie);
 549         } else {
 550                 soup_cookie_free (cookie);
 551         }
 552 }
 553
 554 /**
 555  * soup_cookie_jar_set_cookie:
 556  * @jar: a #SoupCookieJar
 557  * @uri: the URI setting the cookie
 558  * @cookie: the stringified cookie to set
 559  *
 560  * Adds @cookie to @jar, exactly as though it had appeared in a
 561  * Set-Cookie header returned from a request to @uri.
 562  *
 563  * Keep in mind that if the #SoupCookieJarAcceptPolicy
 564  * %SOUP_COOKIE_JAR_ACCEPT_NO_THIRD_PARTY is set you'll need to use
 565  * soup_cookie_jar_set_cookie_with_first_party(), otherwise the jar
 566  * will have no way of knowing if the cookie is being set by a third
 567  * party or not.
 568  *
 569  * Since: 2.24
 570  **/
 571 void
 572 soup_cookie_jar_set_cookie (SoupCookieJar *jar, SoupURI *uri,
 573                             const char *cookie)
 574 {
 575         SoupCookie *soup_cookie;
 576         SoupCookieJarPrivate *priv;
 577
 578         g_return_if_fail (SOUP_IS_COOKIE_JAR (jar));
 579         g_return_if_fail (uri != NULL);
 580         g_return_if_fail (cookie != NULL);
 581
 582         if (!uri->host)
 583                 return;
 584
 585         priv = SOUP_COOKIE_JAR_GET_PRIVATE (jar);
 586         if (priv->accept_policy == SOUP_COOKIE_JAR_ACCEPT_NEVER)
 587                 return;
 588
 589         g_return_if_fail (priv->accept_policy != SOUP_COOKIE_JAR_ACCEPT_NO_THIRD_PARTY);
 590
 591         soup_cookie = soup_cookie_parse (cookie, uri);
 592         if (soup_cookie) {
 593                 /* will steal or free soup_cookie */
 594                 soup_cookie_jar_add_cookie (jar, soup_cookie);
 595         }
 596 }
 597
 598 /**
 599  * soup_cookie_jar_set_cookie_with_first_party:
 600  * @jar: a #SoupCookieJar
 601  * @uri: the URI setting the cookie
 602  * @first_party: the URI for the main document
 603  * @cookie: the stringified cookie to set
 604  *
 605  * Adds @cookie to @jar, exactly as though it had appeared in a
 606  * Set-Cookie header returned from a request to @uri. @first_party
 607  * will be used to reject cookies coming from third party resources in
 608  * case such a security policy is set in the @jar.
 609  *
 610  * Since: 2.30
 611  **/
 612 void
 613 soup_cookie_jar_set_cookie_with_first_party (SoupCookieJar *jar,
 614                                              SoupURI *uri,
 615                                              SoupURI *first_party,
 616                                              const char *cookie)
 617 {
 618         SoupCookie *soup_cookie;
 619
 620         g_return_if_fail (SOUP_IS_COOKIE_JAR (jar));
 621         g_return_if_fail (uri != NULL);
 622         g_return_if_fail (first_party != NULL);
 623         g_return_if_fail (cookie != NULL);
 624
 625         if (!uri->host)
 626                 return;
 627
 628         soup_cookie = soup_cookie_parse (cookie, uri);
 629         if (soup_cookie)
 630                 soup_cookie_jar_add_cookie_with_first_party (jar, first_party, soup_cookie);
 631 }
 632
 633 static void
 634 process_set_cookie_header (SoupMessage *msg, gpointer user_data)
 635 {
 636         SoupCookieJar *jar = user_data;
 637         SoupCookieJarPrivate *priv = SOUP_COOKIE_JAR_GET_PRIVATE (jar);
 638         GSList *new_cookies, *nc;
 639
 640         if (priv->accept_policy == SOUP_COOKIE_JAR_ACCEPT_NEVER)
 641                 return;
 642
 643         new_cookies = soup_cookies_from_response (msg);
 644         for (nc = new_cookies; nc; nc = nc->next) {
 645                 SoupURI *first_party = soup_message_get_first_party (msg);
 646
 647                 if ((priv->accept_policy == SOUP_COOKIE_JAR_ACCEPT_NO_THIRD_PARTY &&
 648                      first_party != NULL && first_party->host &&
 649                      soup_cookie_domain_matches (nc->data, first_party->host)) ||
 650                     priv->accept_policy == SOUP_COOKIE_JAR_ACCEPT_ALWAYS)
 651                         soup_cookie_jar_add_cookie (jar, nc->data);
 652                 else
 653                         soup_cookie_free (nc->data);
 654         }
 655         g_slist_free (new_cookies);
 656 }
 657
 658 static void
 659 soup_cookie_jar_request_queued (SoupSessionFeature *feature,
 660                                 SoupSession *session,
 661                                 SoupMessage *msg)
 662 {
 663         soup_message_add_header_handler (msg, "got-headers",
 664                                          "Set-Cookie",
 665                                          G_CALLBACK (process_set_cookie_header),
 666                                          feature);
 667 }
 668
 669 static void
 670 soup_cookie_jar_request_started (SoupSessionFeature *feature,
 671                                  SoupSession *session,
 672                                  SoupMessage *msg,
 673                                  SoupSocket *socket)
 674 {
 675         SoupCookieJar *jar = SOUP_COOKIE_JAR (feature);
 676         char *cookies;
 677
 678         cookies = soup_cookie_jar_get_cookies (jar, soup_message_get_uri (msg), TRUE);
 679         if (cookies) {
 680                 soup_message_headers_replace (msg->request_headers,
 681                                               "Cookie", cookies);
 682                 g_free (cookies);
 683         } else
 684                 soup_message_headers_remove (msg->request_headers, "Cookie");
 685 }
 686
 687 static void
 688 soup_cookie_jar_request_unqueued (SoupSessionFeature *feature,
 689                                   SoupSession *session,
 690                                   SoupMessage *msg)
 691 {
 692         g_signal_handlers_disconnect_by_func (msg, process_set_cookie_header, feature);
 693 }
 694
 695 static void
 696 soup_cookie_jar_session_feature_init (SoupSessionFeatureInterface *feature_interface,
 697                                       gpointer interface_data)
 698 {
 699         feature_interface->request_queued = soup_cookie_jar_request_queued;
 700         feature_interface->request_started = soup_cookie_jar_request_started;
 701         feature_interface->request_unqueued = soup_cookie_jar_request_unqueued;
 702 }
 703
 704 /**
 705  * soup_cookie_jar_all_cookies:
 706  * @jar: a #SoupCookieJar
 707  *
 708  * Constructs a #GSList with every cookie inside the @jar.
 709  * The cookies in the list are a copy of the original, so
 710  * you have to free them when you are done with them.
 711  *
 712  * Return value: (transfer full) (element-type Soup.Cookie): a #GSList
 713  * with all the cookies in the @jar.
 714  *
 715  * Since: 2.26
 716  **/
 717 GSList *
 718 soup_cookie_jar_all_cookies (SoupCookieJar *jar)
 719 {
 720         SoupCookieJarPrivate *priv;
 721         GHashTableIter iter;
 722         GSList *l = NULL;
 723         gpointer key, value;
 724
 725         g_return_val_if_fail (SOUP_IS_COOKIE_JAR (jar), NULL);
 726
 727         priv = SOUP_COOKIE_JAR_GET_PRIVATE (jar);
 728
 729         g_hash_table_iter_init (&iter, priv->domains);
 730
 731         while (g_hash_table_iter_next (&iter, &key, &value)) {
 732                 GSList *p, *cookies = value;
 733                 for (p = cookies; p; p = p->next)
 734                         l = g_slist_prepend (l, soup_cookie_copy (p->data));
 735         }
 736
 737         return l;
 738 }
 739
 740 /**
 741  * soup_cookie_jar_delete_cookie:
 742  * @jar: a #SoupCookieJar
 743  * @cookie: a #SoupCookie
 744  *
 745  * Deletes @cookie from @jar, emitting the 'changed' signal.
 746  *
 747  * Since: 2.26
 748  **/
 749 void
 750 soup_cookie_jar_delete_cookie (SoupCookieJar *jar,
 751                                SoupCookie    *cookie)
 752 {
 753         SoupCookieJarPrivate *priv;
 754         GSList *cookies, *p;
 755         char *domain;
 756
 757         g_return_if_fail (SOUP_IS_COOKIE_JAR (jar));
 758         g_return_if_fail (cookie != NULL);
 759
 760         priv = SOUP_COOKIE_JAR_GET_PRIVATE (jar);
 761
 762         domain = g_strdup (cookie->domain);
 763
 764         cookies = g_hash_table_lookup (priv->domains, domain);
 765         if (cookies == NULL)
 766                 return;
 767
 768         for (p = cookies; p; p = p->next ) {
 769                 SoupCookie *c = (SoupCookie*)p->data;
 770                 if (soup_cookie_equal (cookie, c)) {
 771                         cookies = g_slist_delete_link (cookies, p);
 772                         g_hash_table_insert (priv->domains,
 773                                              domain,
 774                                              cookies);
 775                         soup_cookie_jar_changed (jar, c, NULL);
 776                         soup_cookie_free (c);
 777                         return;
 778                 }
 779         }
 780 }
 781
 782 /**
 783  * SoupCookieJarAcceptPolicy:
 784  * @SOUP_COOKIE_JAR_ACCEPT_ALWAYS: accept all cookies unconditionally.
 785  * @SOUP_COOKIE_JAR_ACCEPT_NEVER: reject all cookies unconditionally.
 786  * @SOUP_COOKIE_JAR_ACCEPT_NO_THIRD_PARTY: accept all cookies set by
 787  * the main document loaded in the application using libsoup. An
 788  * example of the most common case, web browsers, would be: If
 789  * http://www.example.com is the page loaded, accept all cookies set
 790  * by example.com, but if a resource from http://www.third-party.com
 791  * is loaded from that page reject any cookie that it could try to
 792  * set. For libsoup to be able to tell apart first party cookies from
 793  * the rest, the application must call soup_message_set_first_party()
 794  * on each outgoing #SoupMessage, setting the #SoupURI of the main
 795  * document. If no first party is set in a message when this policy is
 796  * in effect, cookies will be assumed to be third party by default.
 797  *
 798  * The policy for accepting or rejecting cookies returned in
 799  * responses.
 800  *
 801  * Since: 2.30
 802  */
 803
 804 /**
 805  * soup_cookie_jar_get_accept_policy:
 806  * @jar: a #SoupCookieJar
 807  *
 808  * Gets @jar's #SoupCookieJarAcceptPolicy
 809  *
 810  * Returns: the #SoupCookieJarAcceptPolicy set in the @jar
 811  *
 812  * Since: 2.30
 813  **/
 814 SoupCookieJarAcceptPolicy
 815 soup_cookie_jar_get_accept_policy (SoupCookieJar *jar)
 816 {
 817         SoupCookieJarPrivate *priv;
 818
 819         g_return_val_if_fail (SOUP_IS_COOKIE_JAR (jar), SOUP_COOKIE_JAR_ACCEPT_ALWAYS);
 820
 821         priv = SOUP_COOKIE_JAR_GET_PRIVATE (jar);
 822         return priv->accept_policy;
 823 }
 824
 825 /**
 826  * soup_cookie_jar_set_accept_policy:
 827  * @jar: a #SoupCookieJar
 828  * @policy: a #SoupCookieJarAcceptPolicy
 829  *
 830  * Sets @policy as the cookie acceptance policy for @jar.
 831  *
 832  * Since: 2.30
 833  **/
 834 void
 835 soup_cookie_jar_set_accept_policy (SoupCookieJar *jar,
 836                                    SoupCookieJarAcceptPolicy policy)
 837 {
 838         SoupCookieJarPrivate *priv;
 839
 840         g_return_if_fail (SOUP_IS_COOKIE_JAR (jar));
 841
 842         priv = SOUP_COOKIE_JAR_GET_PRIVATE (jar);
 843
 844         if (priv->accept_policy != policy) {
 845                 priv->accept_policy = policy;
 846                 g_object_notify (G_OBJECT (jar), SOUP_COOKIE_JAR_ACCEPT_POLICY);
 847         }
 848 }
 849
 850 /**
 851  * soup_cookie_jar_is_persistent:
 852  * @jar: a #SoupCookieJar
 853  *
 854  * Gets whether @jar stores cookies persistenly.
 855  *
 856  * Returns: %TRUE if @jar storage is persistent or %FALSE otherwise.
 857  *
 858  * Since: 2.40
 859  **/
 860 gboolean
 861 soup_cookie_jar_is_persistent (SoupCookieJar *jar)
 862 {
 863         g_return_val_if_fail (SOUP_IS_COOKIE_JAR (jar), FALSE);
 864
 865         return SOUP_COOKIE_JAR_GET_CLASS (jar)->is_persistent (jar);
 866 }