400858cd5e
Motivation: Netty lacks client side support for decompressing Brotli compressed response bodies. Modification: * Introduce optional dependency to brotli4j by @hyperxpro. It will be up to the user to provide the brotli4j libraries for the target platform in the classpath. brotli4j is currently available for Linux, OSX and Windows, all for x86 only. * Introduce BrotliDecoder in codec module * Plug it onto `HttpContentDecompressor` for HTTP/1 and `DelegatingDecompressorFrameListener` for HTTP/2 * Add test in `HttpContentDecoderTest` * Add `BrotliDecoderTest` that doesn't extend `AbstractDecoderTest` that looks flaky Result: Netty now support decompressing Brotli compressed response bodies.
79 lines
3.3 KiB
Java
79 lines
3.3 KiB
Java
/*
|
|
* Copyright 2012 The Netty Project
|
|
*
|
|
* The Netty Project licenses this file to you under the Apache License,
|
|
* version 2.0 (the "License"); you may not use this file except in compliance
|
|
* with the License. You may obtain a copy of the License at:
|
|
*
|
|
* https://www.apache.org/licenses/LICENSE-2.0
|
|
*
|
|
* Unless required by applicable law or agreed to in writing, software
|
|
* distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
|
|
* WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
|
|
* License for the specific language governing permissions and limitations
|
|
* under the License.
|
|
*/
|
|
package io.netty.handler.codec.http;
|
|
|
|
import static io.netty.handler.codec.http.HttpHeaderValues.BR;
|
|
import static io.netty.handler.codec.http.HttpHeaderValues.DEFLATE;
|
|
import static io.netty.handler.codec.http.HttpHeaderValues.GZIP;
|
|
import static io.netty.handler.codec.http.HttpHeaderValues.X_DEFLATE;
|
|
import static io.netty.handler.codec.http.HttpHeaderValues.X_GZIP;
|
|
|
|
import io.netty.channel.embedded.EmbeddedChannel;
|
|
import io.netty.handler.codec.compression.Brotli;
|
|
import io.netty.handler.codec.compression.BrotliDecoder;
|
|
import io.netty.handler.codec.compression.ZlibCodecFactory;
|
|
import io.netty.handler.codec.compression.ZlibWrapper;
|
|
|
|
/**
|
|
* Decompresses an {@link HttpMessage} and an {@link HttpContent} compressed in
|
|
* {@code gzip} or {@code deflate} encoding. For more information on how this
|
|
* handler modifies the message, please refer to {@link HttpContentDecoder}.
|
|
*/
|
|
public class HttpContentDecompressor extends HttpContentDecoder {
|
|
|
|
private final boolean strict;
|
|
|
|
/**
|
|
* Create a new {@link HttpContentDecompressor} in non-strict mode.
|
|
*/
|
|
public HttpContentDecompressor() {
|
|
this(false);
|
|
}
|
|
|
|
/**
|
|
* Create a new {@link HttpContentDecompressor}.
|
|
*
|
|
* @param strict if {@code true} use strict handling of deflate if used, otherwise handle it in a
|
|
* more lenient fashion.
|
|
*/
|
|
public HttpContentDecompressor(boolean strict) {
|
|
this.strict = strict;
|
|
}
|
|
|
|
@Override
|
|
protected EmbeddedChannel newContentDecoder(String contentEncoding) throws Exception {
|
|
if (GZIP.contentEqualsIgnoreCase(contentEncoding) ||
|
|
X_GZIP.contentEqualsIgnoreCase(contentEncoding)) {
|
|
return new EmbeddedChannel(ctx.channel().id(), ctx.channel().metadata().hasDisconnect(),
|
|
ctx.channel().config(), ZlibCodecFactory.newZlibDecoder(ZlibWrapper.GZIP));
|
|
}
|
|
if (DEFLATE.contentEqualsIgnoreCase(contentEncoding) ||
|
|
X_DEFLATE.contentEqualsIgnoreCase(contentEncoding)) {
|
|
final ZlibWrapper wrapper = strict ? ZlibWrapper.ZLIB : ZlibWrapper.ZLIB_OR_NONE;
|
|
// To be strict, 'deflate' means ZLIB, but some servers were not implemented correctly.
|
|
return new EmbeddedChannel(ctx.channel().id(), ctx.channel().metadata().hasDisconnect(),
|
|
ctx.channel().config(), ZlibCodecFactory.newZlibDecoder(wrapper));
|
|
}
|
|
if (Brotli.isAvailable() && BR.contentEqualsIgnoreCase(contentEncoding)) {
|
|
return new EmbeddedChannel(ctx.channel().id(), ctx.channel().metadata().hasDisconnect(),
|
|
ctx.channel().config(), new BrotliDecoder());
|
|
}
|
|
|
|
// 'identity' or unsupported
|
|
return null;
|
|
}
|
|
}
|