1 /*
2  * ====================================================================
3  * Licensed to the Apache Software Foundation (ASF) under one
4  * or more contributor license agreements.  See the NOTICE file
5  * distributed with this work for additional information
6  * regarding copyright ownership.  The ASF licenses this file
7  * to you under the Apache License, Version 2.0 (the
8  * "License"); you may not use this file except in compliance
9  * with the License.  You may obtain a copy of the License at
10  *
11  *   http://www.apache.org/licenses/LICENSE-2.0
12  *
13  * Unless required by applicable law or agreed to in writing,
14  * software distributed under the License is distributed on an
15  * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
16  * KIND, either express or implied.  See the License for the
17  * specific language governing permissions and limitations
18  * under the License.
19  * ====================================================================
20  *
21  * This software consists of voluntary contributions made by many
22  * individuals on behalf of the Apache Software Foundation.  For more
23  * information on the Apache Software Foundation, please see
24  * <http://www.apache.org/>.
25  *
26  */
27 package org.apache.http.client.protocol;
28
29 import java.io.IOException;
30 import java.util.Locale;
31
32 import org.apache.http.Header;
33 import org.apache.http.HeaderElement;
34 import org.apache.http.HttpEntity;
35 import org.apache.http.HttpException;
36 import org.apache.http.HttpResponse;
37 import org.apache.http.HttpResponseInterceptor;
38 import org.apache.http.annotation.Contract;
39 import org.apache.http.annotation.ThreadingBehavior;
40 import org.apache.http.client.config.RequestConfig;
41 import org.apache.http.client.entity.DecompressingEntity;
42 import org.apache.http.client.entity.DeflateInputStreamFactory;
43 import org.apache.http.client.entity.GZIPInputStreamFactory;
44 import org.apache.http.client.entity.InputStreamFactory;
45 import org.apache.http.config.Lookup;
46 import org.apache.http.config.RegistryBuilder;
47 import org.apache.http.protocol.HttpContext;
48
49 /**
50  * {@link HttpResponseInterceptor} responsible for processing Content-Encoding
51  * responses.
52  * <p>
53  * Instances of this class are stateless and immutable, therefore threadsafe.
54  *
55  * @since 4.1
56  *
57  */
58 @Contract(threading = ThreadingBehavior.IMMUTABLE_CONDITIONAL)
59 public class ResponseContentEncoding implements HttpResponseInterceptor {
60
61     public static final String UNCOMPRESSED = "http.client.response.uncompressed";
62
63     private final Lookup<InputStreamFactory> decoderRegistry;
64     private final boolean ignoreUnknown;
65
66     /**
67      * @since 4.5
68      */
69     public ResponseContentEncoding(final Lookup<InputStreamFactory> decoderRegistry, final boolean ignoreUnknown) {
70         this.decoderRegistry = decoderRegistry != null ? decoderRegistry :
71             RegistryBuilder.<InputStreamFactory>create()
72                     .register("gzip", GZIPInputStreamFactory.getInstance())
73                     .register("x-gzip", GZIPInputStreamFactory.getInstance())
74                     .register("deflate", DeflateInputStreamFactory.getInstance())
75                     .build();
76         this.ignoreUnknown = ignoreUnknown;
77     }
78
79     /**
80      * @since 4.5
81      */
82     public ResponseContentEncoding(final boolean ignoreUnknown) {
83         this(null, ignoreUnknown);
84     }
85
86     /**
87      * @since 4.4
88      */
89     public ResponseContentEncoding(final Lookup<InputStreamFactory> decoderRegistry) {
90         this(decoderRegistry, true);
91     }
92
93     /**
94      * Handles {@code gzip} and {@code deflate} compressed entities by using the following
95      * decoders:
96      * <ul>
97      * <li>gzip - see {@link java.util.zip.GZIPInputStream}</li>
98      * <li>deflate - see {@link org.apache.http.client.entity.DeflateInputStream}</li>
99      * </ul>
100      */
101     public ResponseContentEncoding() {
102         this(null);
103     }
104
105     @Override
106     public void process(
107             final HttpResponse response,
108             final HttpContext context) throws HttpException, IOException {
109         final HttpEntity entity = response.getEntity();
110
111         final HttpClientContext clientContext = HttpClientContext.adapt(context);
112         final RequestConfig requestConfig = clientContext.getRequestConfig();
113         // entity can be null in case of 304 Not Modified, 204 No Content or similar
114         // check for zero length entity.
115         if (requestConfig.isContentCompressionEnabled() && entity != null && entity.getContentLength() != 0) {
116             final Header ceheader = entity.getContentEncoding();
117             if (ceheader != null) {
118                 final HeaderElement[] codecs = ceheader.getElements();
119                 for (final HeaderElement codec : codecs) {
120                     final String codecname = codec.getName().toLowerCase(Locale.ROOT);
121                     final InputStreamFactory decoderFactory = decoderRegistry.lookup(codecname);
122                     if (decoderFactory != null) {
123                         response.setEntity(new DecompressingEntity(response.getEntity(), decoderFactory));
124                         response.removeHeaders("Content-Length");
125                         response.removeHeaders("Content-Encoding");
126                         response.removeHeaders("Content-MD5");
127                     } else {
128                         if (!"identity".equals(codecname) && !ignoreUnknown) {
129                             throw new HttpException("Unsupported Content-Encoding: " + codec.getName());
130                         }
131                     }
132                 }
133             }
134         }
135     }
136
137 }
138