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 package org.apache.hc.client5.http.impl.classic;
29
30 import java.io.IOException;
31 import java.util.ArrayList;
32 import java.util.List;
33 import java.util.Locale;
34 import java.util.zip.GZIPInputStream;
35
36 import org.apache.hc.client5.http.classic.ExecChain;
37 import org.apache.hc.client5.http.classic.ExecChainHandler;
38 import org.apache.hc.client5.http.config.RequestConfig;
39 import org.apache.hc.client5.http.entity.BrotliDecompressingEntity;
40 import org.apache.hc.client5.http.entity.BrotliInputStreamFactory;
41 import org.apache.hc.client5.http.entity.DecompressingEntity;
42 import org.apache.hc.client5.http.entity.DeflateInputStream;
43 import org.apache.hc.client5.http.entity.DeflateInputStreamFactory;
44 import org.apache.hc.client5.http.entity.GZIPInputStreamFactory;
45 import org.apache.hc.client5.http.entity.InputStreamFactory;
46 import org.apache.hc.client5.http.protocol.HttpClientContext;
47 import org.apache.hc.core5.annotation.Contract;
48 import org.apache.hc.core5.annotation.Internal;
49 import org.apache.hc.core5.annotation.ThreadingBehavior;
50 import org.apache.hc.core5.http.ClassicHttpRequest;
51 import org.apache.hc.core5.http.ClassicHttpResponse;
52 import org.apache.hc.core5.http.Header;
53 import org.apache.hc.core5.http.HeaderElement;
54 import org.apache.hc.core5.http.HttpEntity;
55 import org.apache.hc.core5.http.HttpException;
56 import org.apache.hc.core5.http.HttpHeaders;
57 import org.apache.hc.core5.http.ProtocolException;
58 import org.apache.hc.core5.http.config.Lookup;
59 import org.apache.hc.core5.http.config.RegistryBuilder;
60 import org.apache.hc.core5.http.message.BasicHeaderValueParser;
61 import org.apache.hc.core5.http.message.MessageSupport;
62 import org.apache.hc.core5.http.message.ParserCursor;
63 import org.apache.hc.core5.util.Args;
64 import org.brotli.dec.BrotliInputStream;
65
66
67
68
69
70
71
72
73
74
75
76
77 @Contract(threading = ThreadingBehavior.STATELESS)
78 @Internal
79 public final class ContentCompressionExec implements ExecChainHandler {
80
81 public static final int MAX_CODEC_LIST_LEN = 5;
82
83 private final Header acceptEncoding;
84 private final Lookup<InputStreamFactory> decoderRegistry;
85 private final boolean ignoreUnknown;
86 private final int maxCodecListLen;
87
88 public ContentCompressionExec(
89 final List<String> acceptEncoding,
90 final Lookup<InputStreamFactory> decoderRegistry,
91 final boolean ignoreUnknown,
92 final int maxCodecListLen) {
93
94 final boolean brotliSupported = decoderRegistry == null && BrotliDecompressingEntity.isAvailable();
95 if (acceptEncoding != null) {
96 this.acceptEncoding = MessageSupport.headerOfTokens(HttpHeaders.ACCEPT_ENCODING, acceptEncoding);
97 } else {
98 final List<String> encodings = new ArrayList<>(4);
99 encodings.add("gzip");
100 encodings.add("x-gzip");
101 encodings.add("deflate");
102 if (brotliSupported) {
103 encodings.add("br");
104 }
105 this.acceptEncoding = MessageSupport.headerOfTokens(HttpHeaders.ACCEPT_ENCODING, encodings);
106 }
107 if (decoderRegistry != null) {
108 this.decoderRegistry = decoderRegistry;
109 } else {
110 final RegistryBuilder<InputStreamFactory> builder = RegistryBuilder.<InputStreamFactory>create()
111 .register("gzip", GZIPInputStreamFactory.getInstance())
112 .register("x-gzip", GZIPInputStreamFactory.getInstance())
113 .register("deflate", DeflateInputStreamFactory.getInstance());
114 if (brotliSupported) {
115 builder.register("br", BrotliInputStreamFactory.getInstance());
116 }
117 this.decoderRegistry = builder.build();
118 }
119 this.ignoreUnknown = ignoreUnknown;
120 this.maxCodecListLen = maxCodecListLen;
121 }
122
123 public ContentCompressionExec(
124 final List<String> acceptEncoding,
125 final Lookup<InputStreamFactory> decoderRegistry,
126 final boolean ignoreUnknown) {
127 this(acceptEncoding, decoderRegistry, ignoreUnknown, MAX_CODEC_LIST_LEN);
128 }
129
130 public ContentCompressionExec(final boolean ignoreUnknown) {
131 this(null, null, ignoreUnknown, MAX_CODEC_LIST_LEN);
132 }
133
134 public ContentCompressionExec(final int maxCodecListLen) {
135 this(null, null, true, maxCodecListLen);
136 }
137
138
139
140
141
142
143
144
145
146
147 public ContentCompressionExec() {
148 this(null, null, true, MAX_CODEC_LIST_LEN);
149 }
150
151
152 @Override
153 public ClassicHttpResponse execute(
154 final ClassicHttpRequest request,
155 final ExecChain.Scope scope,
156 final ExecChain chain) throws IOException, HttpException {
157 Args.notNull(request, "HTTP request");
158 Args.notNull(scope, "Scope");
159
160 final HttpClientContext clientContext = scope.clientContext;
161 final RequestConfig requestConfig = clientContext.getRequestConfigOrDefault();
162
163
164 if (!request.containsHeader(HttpHeaders.ACCEPT_ENCODING) && requestConfig.isContentCompressionEnabled()) {
165 request.addHeader(acceptEncoding);
166 }
167
168 final ClassicHttpResponse response = chain.proceed(request, scope);
169
170 final HttpEntity entity = response.getEntity();
171
172
173 if (requestConfig.isContentCompressionEnabled() && entity != null && entity.getContentLength() != 0) {
174 final String contentEncoding = entity.getContentEncoding();
175 if (contentEncoding != null) {
176 final ParserCursor cursor = new ParserCursor(0, contentEncoding.length());
177 final HeaderElement[] codecs = BasicHeaderValueParser.INSTANCE.parseElements(contentEncoding, cursor);
178 if (maxCodecListLen > 0 && codecs.length > maxCodecListLen) {
179 throw new ProtocolException("Codec list exceeds maximum of " + maxCodecListLen + " elements");
180 }
181 for (final HeaderElement codec : codecs) {
182 final String codecname = codec.getName().toLowerCase(Locale.ROOT);
183 final InputStreamFactory decoderFactory = decoderRegistry.lookup(codecname);
184 if (decoderFactory != null) {
185 response.setEntity(new DecompressingEntity(response.getEntity(), decoderFactory));
186 response.removeHeaders(HttpHeaders.CONTENT_LENGTH);
187 response.removeHeaders(HttpHeaders.CONTENT_ENCODING);
188 response.removeHeaders(HttpHeaders.CONTENT_MD5);
189 } else {
190 if (!"identity".equals(codecname) && !ignoreUnknown) {
191 throw new HttpException("Unsupported Content-Encoding: " + codec.getName());
192 }
193 }
194 }
195 }
196 }
197 return response;
198 }
199
200 }