Issue #8769 - Introduce new Compression Handler with support for gzip, brotli, and zstandard

jetty-core/jetty-compression/jetty-compression-brotli/pom.xml

@@ -0,0 +1,37 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<project xmlns="http://maven.apache.org/POM/4.0.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd">
+
+  <modelVersion>4.0.0</modelVersion>
+  <parent>
+    <groupId>org.eclipse.jetty.compression</groupId>
+    <artifactId>jetty-compression</artifactId>
+    <version>12.1.0-SNAPSHOT</version>
+  </parent>
+  <artifactId>jetty-compression-brotli</artifactId>
+  <packaging>jar</packaging>
+  <name>Core :: Compression :: Brotli Support</name>
+  <description>Jetty Core Compression :: Brotli Support</description>
+
+  <properties>
+    <bundle-symbolic-name>${project.groupId}.brotli</bundle-symbolic-name>
+  </properties>
+
+  <dependencies>
+    <dependency>
+      <groupId>com.aayushatharva.brotli4j</groupId>
+      <artifactId>brotli4j</artifactId>
+      <version>1.16.0</version>
+    </dependency>
+    <dependency>
+      <groupId>org.eclipse.jetty.compression</groupId>
+      <artifactId>jetty-compression-common</artifactId>
+      <version>${project.version}</version>
+    </dependency>
+    <dependency>
+      <groupId>org.eclipse.jetty</groupId>
+      <artifactId>jetty-slf4j-impl</artifactId>
+      <scope>test</scope>
+    </dependency>
+  </dependencies>
+
+</project>

jetty-core/jetty-compression/jetty-compression-brotli/src/main/java/org/eclipse/jetty/compression/brotli/BrotliCompression.java

@@ -0,0 +1,178 @@
+//
+// ========================================================================
+// Copyright (c) 1995 Mort Bay Consulting Pty Ltd and others.
+//
+// This program and the accompanying materials are made available under the
+// terms of the Eclipse Public License v. 2.0 which is available at
+// https://www.eclipse.org/legal/epl-2.0, or the Apache License, Version 2.0
+// which is available at https://www.apache.org/licenses/LICENSE-2.0.
+//
+// SPDX-License-Identifier: EPL-2.0 OR Apache-2.0
+// ========================================================================
+//
+
+package org.eclipse.jetty.compression.brotli;
+
+import java.io.IOException;
+import java.io.InputStream;
+import java.io.OutputStream;
+import java.nio.ByteOrder;
+import java.util.List;
+
+import com.aayushatharva.brotli4j.Brotli4jLoader;
+import com.aayushatharva.brotli4j.decoder.BrotliInputStream;
+import com.aayushatharva.brotli4j.encoder.BrotliOutputStream;
+import org.eclipse.jetty.compression.Compression;
+import org.eclipse.jetty.compression.DecoderSource;
+import org.eclipse.jetty.compression.EncoderSink;
+import org.eclipse.jetty.http.CompressedContentFormat;
+import org.eclipse.jetty.http.HttpField;
+import org.eclipse.jetty.http.HttpFields;
+import org.eclipse.jetty.http.HttpHeader;
+import org.eclipse.jetty.http.PreEncodedHttpField;
+import org.eclipse.jetty.io.Content;
+import org.eclipse.jetty.io.RetainableByteBuffer;
+import org.slf4j.Logger;
+import org.slf4j.LoggerFactory;
+
+/**
+ * Brotli Compression.
+ *
+ * @see <a href="https://datatracker.ietf.org/doc/html/rfc7932">RFC7932: Brotli Compressed Data Format</a>
+ */
+public class BrotliCompression extends Compression
+{
+    private static final Logger LOG = LoggerFactory.getLogger(BrotliCompression.class);
+    public static final List<String> EXTENSIONS = List.of("br");
+
+    static
+    {
+        Brotli4jLoader.ensureAvailability();
+    }
+
+    private static final CompressedContentFormat BR = new CompressedContentFormat("br", ".br");
+    private static final String ENCODING_NAME = "br";
+    private static final HttpField X_CONTENT_ENCODING = new PreEncodedHttpField("X-Content-Encoding", ENCODING_NAME);
+    private static final HttpField CONTENT_ENCODING = new PreEncodedHttpField(HttpHeader.CONTENT_ENCODING, ENCODING_NAME);
+    private static final int DEFAULT_MIN_BROTLI_SIZE = 48;
+
+    private int minCompressSize = DEFAULT_MIN_BROTLI_SIZE;
+
+    public BrotliCompression()
+    {
+        super(ENCODING_NAME);
+    }
+
+    public com.aayushatharva.brotli4j.encoder.Encoder.Parameters getEncoderParams()
+    {
+        com.aayushatharva.brotli4j.encoder.Encoder.Parameters params = new com.aayushatharva.brotli4j.encoder.Encoder.Parameters();
+        params.setQuality(5); // TODO: make configurable
+        params.setMode(com.aayushatharva.brotli4j.encoder.Encoder.Mode.GENERIC);
+        return params;
+    }
+
+    public int getMinCompressSize()
+    {
+        return minCompressSize;
+    }
+
+    public void setMinCompressSize(int minCompressSize)
+    {
+        this.minCompressSize = Math.max(minCompressSize, DEFAULT_MIN_BROTLI_SIZE);
+    }
+
+    @Override
+    public boolean acceptsCompression(HttpFields headers, long contentLength)
+    {
+        if (contentLength >= 0 && contentLength < minCompressSize)
+        {
+            if (LOG.isDebugEnabled())
+                LOG.debug("{} excluded minCompressSize {}", this, headers);
+            return false;
+        }
+
+        // check the accept encoding header
+        if (!headers.contains(HttpHeader.ACCEPT_ENCODING, getEncodingName()))
+        {
+            if (LOG.isDebugEnabled())
+                LOG.debug("{} excluded not {} acceptable {}", this, getEncodingName(), headers);
+            return false;
+        }
+
+        return true;
+    }
+
+    @Override
+    public String getName()
+    {
+        return "brotli";
+    }
+
+    @Override
+    public List<String> getFileExtensionNames()
+    {
+        return EXTENSIONS;
+    }
+
+    @Override
+    public HttpField getXContentEncodingField()
+    {
+        return X_CONTENT_ENCODING;
+    }
+
+    @Override
+    public HttpField getContentEncodingField()
+    {
+        return CONTENT_ENCODING;
+    }
+
+    @Override
+    public RetainableByteBuffer acquireByteBuffer()
+    {
+        return acquireByteBuffer(getBufferSize());
+    }
+
+    @Override
+    public RetainableByteBuffer acquireByteBuffer(int length)
+    {
+        // Zero-capacity buffers aren't released, they MUST NOT come from the pool.
+        if (length == 0)
+            return RetainableByteBuffer.EMPTY;
+
+        // Can Brotli4J use direct byte buffers?
+        RetainableByteBuffer buffer = getByteBufferPool().acquire(length, false);
+        buffer.getByteBuffer().order(getByteOrder());
+        return buffer;
+    }
+
+    private ByteOrder getByteOrder()
+    {
+        // Per https://datatracker.ietf.org/doc/html/rfc7932#section-1.5
+        // Brotli is LITTLE_ENDIAN
+        return ByteOrder.LITTLE_ENDIAN;
+    }
+
+    @Override
+    public OutputStream newDecoderOutputStream(OutputStream out) throws IOException
+    {
+        return new BrotliOutputStream(out);
+    }
+
+    @Override
+    public DecoderSource newDecoderSource(Content.Source source)
+    {
+        return new BrotliDecoderSource(this, source);
+    }
+
+    @Override
+    public InputStream newEncoderInputStream(InputStream in) throws IOException
+    {
+        return new BrotliInputStream(in);
+    }
+
+    @Override
+    public EncoderSink newEncoderSink(Content.Sink sink)
+    {
+        return new BrotliEncoderSink(this, sink);
+    }
+}

jetty-core/jetty-compression/jetty-compression-brotli/src/main/java/org/eclipse/jetty/compression/brotli/BrotliDecoderSource.java

@@ -0,0 +1,97 @@
+//
+// ========================================================================
+// Copyright (c) 1995 Mort Bay Consulting Pty Ltd and others.
+//
+// This program and the accompanying materials are made available under the
+// terms of the Eclipse Public License v. 2.0 which is available at
+// https://www.eclipse.org/legal/epl-2.0, or the Apache License, Version 2.0
+// which is available at https://www.apache.org/licenses/LICENSE-2.0.
+//
+// SPDX-License-Identifier: EPL-2.0 OR Apache-2.0
+// ========================================================================
+//
+
+package org.eclipse.jetty.compression.brotli;
+
+import java.io.IOException;
+import java.nio.ByteBuffer;
+
+import com.aayushatharva.brotli4j.decoder.DecoderJNI;
+import org.eclipse.jetty.compression.DecoderSource;
+import org.eclipse.jetty.io.Content;
+import org.eclipse.jetty.util.BufferUtil;
+
+public class BrotliDecoderSource extends DecoderSource
+{
+    private static final ByteBuffer EMPTY_BUFFER = BufferUtil.EMPTY_BUFFER;
+    private final BrotliCompression compression;
+    private final DecoderJNI.Wrapper decoder;
+
+    public BrotliDecoderSource(BrotliCompression compression, Content.Source source)
+    {
+        super(source);
+        this.compression = compression;
+        try
+        {
+            this.decoder = new DecoderJNI.Wrapper(compression.getBufferSize());
+        }
+        catch (IOException e)
+        {
+            throw new RuntimeException("Unable to initialize Brotli Decoder", e);
+        }
+    }
+
+    @Override
+    protected void release()
+    {
+        decoder.destroy();
+    }
+
+    @Override
+    protected Content.Chunk nextChunk(Content.Chunk readChunk) throws IOException
+    {
+        ByteBuffer compressed = readChunk.getByteBuffer();
+        if (readChunk.isLast() && !readChunk.hasRemaining())
+            return Content.Chunk.EOF;
+
+        boolean last = readChunk.isLast();
+
+        while (true)
+        {
+            switch (decoder.getStatus())
+            {
+                case DONE ->
+                {
+                    return last ? Content.Chunk.EOF : Content.Chunk.EMPTY;
+                }
+                case OK ->
+                {
+                    decoder.push(0);
+                }
+                case NEEDS_MORE_INPUT ->
+                {
+                    ByteBuffer input = decoder.getInputBuffer();
+                    BufferUtil.clearToFill(input);
+                    int len = BufferUtil.put(compressed, input);
+                    decoder.push(len);
+
+                    if (len == 0)
+                    {
+                        // rely on status.OK to go to EOF.
+                        return Content.Chunk.EMPTY;
+                    }
+                }
+                case NEEDS_MORE_OUTPUT ->
+                {
+                    ByteBuffer output = decoder.pull();
+                    // rely on status.OK to go to EOF
+                    return Content.Chunk.from(output, false);
+                }
+                default ->
+                {
+                    throw new IOException("Decoder failure: Corrupted input buffer");
+                }
+            }
+        }
+    }
+}