1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
|
/* -*- Mode: C; tab-width: 8; indent-tabs-mode: t; c-basic-offset: 8 -*- */
/*
* soup-content-decoder.c
*
* Copyright (C) 2009 Red Hat, Inc.
*/
#ifdef HAVE_CONFIG_H
#include <config.h>
#endif
#include "soup-content-decoder.h"
#include "soup.h"
#include "soup-message-private.h"
/**
* SECTION:soup-content-decoder
* @short_description: Content-Encoding handler
*
* #SoupContentDecoder handles the "Accept-Encoding" header on
* outgoing messages, and the "Content-Encoding" header on incoming
* ones. If you add it to a session with soup_session_add_feature() or
* soup_session_add_feature_by_type(), the session will automatically
* use Content-Encoding as appropriate.
*
* (Note that currently there is no way to (automatically) use
* Content-Encoding when sending a request body, or to pick specific
* encoding types to support.)
*
* If #SoupContentDecoder successfully decodes the Content-Encoding,
* it will set the %SOUP_MESSAGE_CONTENT_DECODED flag on the message,
* and the message body and the chunks in the #SoupMessage::got_chunk
* signals will contain the decoded data; however, the message headers
* will be unchanged (and so "Content-Encoding" will still be present,
* "Content-Length" will describe the original encoded length, etc).
*
* If "Content-Encoding" contains any encoding types that
* #SoupContentDecoder doesn't recognize, then none of the encodings
* will be decoded (and the %SOUP_MESSAGE_CONTENT_DECODED flag will
* not be set).
*
* Since: 2.28.2
**/
struct _SoupContentDecoderPrivate {
GHashTable *decoders;
};
typedef GConverter * (*SoupContentDecoderCreator) (void);
static void soup_content_decoder_session_feature_init (SoupSessionFeatureInterface *feature_interface, gpointer interface_data);
G_DEFINE_TYPE_WITH_CODE (SoupContentDecoder, soup_content_decoder, G_TYPE_OBJECT,
G_IMPLEMENT_INTERFACE (SOUP_TYPE_SESSION_FEATURE,
soup_content_decoder_session_feature_init))
/* This is constant for now */
#define ACCEPT_ENCODING_HEADER "gzip, deflate"
static GConverter *
gzip_decoder_creator (void)
{
return (GConverter *)g_zlib_decompressor_new (G_ZLIB_COMPRESSOR_FORMAT_GZIP);
}
static GConverter *
zlib_decoder_creator (void)
{
return (GConverter *)g_zlib_decompressor_new (G_ZLIB_COMPRESSOR_FORMAT_ZLIB);
}
static void
soup_content_decoder_init (SoupContentDecoder *decoder)
{
decoder->priv = G_TYPE_INSTANCE_GET_PRIVATE (decoder,
SOUP_TYPE_CONTENT_DECODER,
SoupContentDecoderPrivate);
decoder->priv->decoders = g_hash_table_new (g_str_hash, g_str_equal);
/* Hardcoded for now */
g_hash_table_insert (decoder->priv->decoders, "gzip",
gzip_decoder_creator);
g_hash_table_insert (decoder->priv->decoders, "x-gzip",
gzip_decoder_creator);
g_hash_table_insert (decoder->priv->decoders, "deflate",
zlib_decoder_creator);
}
static void
soup_content_decoder_finalize (GObject *object)
{
SoupContentDecoder *decoder = SOUP_CONTENT_DECODER (object);
g_hash_table_destroy (decoder->priv->decoders);
G_OBJECT_CLASS (soup_content_decoder_parent_class)->finalize (object);
}
static void
soup_content_decoder_class_init (SoupContentDecoderClass *decoder_class)
{
GObjectClass *object_class = G_OBJECT_CLASS (decoder_class);
g_type_class_add_private (decoder_class, sizeof (SoupContentDecoderPrivate));
object_class->finalize = soup_content_decoder_finalize;
}
static void
soup_content_decoder_got_headers_cb (SoupMessage *msg, SoupContentDecoder *decoder)
{
SoupMessagePrivate *msgpriv = SOUP_MESSAGE_GET_PRIVATE (msg);
const char *header;
GSList *encodings, *e;
SoupContentDecoderCreator converter_creator;
GConverter *converter;
header = soup_message_headers_get_list (msg->response_headers,
"Content-Encoding");
if (!header)
return;
/* Workaround for an apache bug (bgo 613361) */
if (!g_ascii_strcasecmp (header, "gzip") ||
!g_ascii_strcasecmp (header, "x-gzip")) {
const char *content_type = soup_message_headers_get_content_type (msg->response_headers, NULL);
if (content_type &&
(!g_ascii_strcasecmp (content_type, "application/gzip") ||
!g_ascii_strcasecmp (content_type, "application/x-gzip")))
return;
}
/* OK, really, no one is ever going to use more than one
* encoding, but we'll be robust.
*/
encodings = soup_header_parse_list (header);
if (!encodings)
return;
for (e = encodings; e; e = e->next) {
if (!g_hash_table_lookup (decoder->priv->decoders, e->data)) {
soup_header_free_list (encodings);
return;
}
}
/* msgpriv->decoders should be empty at this point anyway, but
* clean it up if it's not.
*/
g_slist_free_full (msgpriv->decoders, g_object_unref);
msgpriv->decoders = NULL;
for (e = encodings; e; e = e->next) {
converter_creator = g_hash_table_lookup (decoder->priv->decoders, e->data);
converter = converter_creator ();
/* Content-Encoding lists the codings in the order
* they were applied in, so we put decoders in reverse
* order so the last-applied will be the first
* decoded.
*/
msgpriv->decoders = g_slist_prepend (msgpriv->decoders, converter);
}
soup_header_free_list (encodings);
}
static void
soup_content_decoder_request_queued (SoupSessionFeature *feature,
SoupSession *session,
SoupMessage *msg)
{
SoupContentDecoder *decoder = SOUP_CONTENT_DECODER (feature);
if (!soup_message_headers_get_one (msg->request_headers,
"Accept-Encoding")) {
soup_message_headers_append (msg->request_headers,
"Accept-Encoding",
ACCEPT_ENCODING_HEADER);
}
g_signal_connect (msg, "got-headers",
G_CALLBACK (soup_content_decoder_got_headers_cb),
decoder);
}
static void
soup_content_decoder_request_unqueued (SoupSessionFeature *feature,
SoupSession *session,
SoupMessage *msg)
{
g_signal_handlers_disconnect_by_func (msg, soup_content_decoder_got_headers_cb, feature);
}
static void
soup_content_decoder_session_feature_init (SoupSessionFeatureInterface *feature_interface,
gpointer interface_data)
{
feature_interface->request_queued = soup_content_decoder_request_queued;
feature_interface->request_unqueued = soup_content_decoder_request_unqueued;
}
|
