com.aspectran.undertow.server.encoding.EncodingHandlerWrapper Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of aspectran-all Show documentation
Aspectran (All-in-One)
There is a newer version: 8.1.5
/*
 * Copyright (c) 2008-2023 The Aspectran Project
 *
 * Licensed 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
 *
 *     http://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 com.aspectran.undertow.server.encoding;

import com.aspectran.web.support.http.HttpHeaders;
import com.aspectran.web.support.http.MediaType;
import io.undertow.attribute.RequestHeaderAttribute;
import io.undertow.predicate.Predicate;
import io.undertow.predicate.Predicates;
import io.undertow.server.HandlerWrapper;
import io.undertow.server.HttpHandler;
import io.undertow.server.HttpServerExchange;
import io.undertow.server.handlers.encoding.ContentEncodingRepository;
import io.undertow.server.handlers.encoding.DeflateEncodingProvider;
import io.undertow.server.handlers.encoding.EncodingHandler;
import io.undertow.server.handlers.encoding.GzipEncodingProvider;
import io.undertow.util.HttpString;

import java.util.ArrayList;
import java.util.Arrays;
import java.util.Collections;
import java.util.LinkedHashSet;
import java.util.List;
import java.util.Set;

/**
 * Configure HTTP compression in Undertow {@link HttpHandler} and
 * create an {@link EncodingHandler}.
 *
 * Created: 2019-08-18
 */
public class EncodingHandlerWrapper implements HandlerWrapper {

    private static final String GZIP = "gzip";

    private static final String DEFLATE = "deflate";

    private String[] contentEncodingProviderNames;

    private long maxContentSize = 2048L;

    private String[] mediaTypes;

    private String[] excludedUserAgents;

    public void setContentEncodingProviders(String... contentEncodingProviderNames) {
        this.contentEncodingProviderNames = contentEncodingProviderNames;
    }

    public void setMaxContentSize(long maxContentSize) {
        this.maxContentSize = maxContentSize;
    }

    public void setMediaTypes(String[] mediaTypes) {
        this.mediaTypes = mediaTypes;
    }

    public void setExcludedUserAgents(String[] excludedUserAgents) {
        this.excludedUserAgents = excludedUserAgents;
    }

    @Override
    public HttpHandler wrap(HttpHandler handler) {
        ContentEncodingRepository contentEncodingRepository = new ContentEncodingRepository();
        if (contentEncodingProviderNames != null && contentEncodingProviderNames.length != 0) {
            Set names = new LinkedHashSet<>(Arrays.asList(contentEncodingProviderNames));
            Predicate predicate = Predicates.and(getCompressionPredicates());
            int priority = 100;
            for (String name : names) {
                if (GZIP.equalsIgnoreCase(name)) {
                    contentEncodingRepository.addEncodingHandler(GZIP,
                            new GzipEncodingProvider(), priority, predicate);
                } else if (DEFLATE.equalsIgnoreCase(name)) {
                    contentEncodingRepository.addEncodingHandler(DEFLATE,
                            new DeflateEncodingProvider(), priority, predicate);
                } else {
                    throw new IllegalArgumentException("Unknown content encoding provider '" + name + "'");
                }
                priority /= 10;
            }
        }
        return new EncodingHandler(handler, contentEncodingRepository);
    }

    private Predicate[] getCompressionPredicates() {
        List predicates = new ArrayList<>();
        if (maxContentSize > 0L) {
            predicates.add(Predicates.requestLargerThan(maxContentSize));
        }
        if (mediaTypes != null && mediaTypes.length > 0) {
            predicates.add(new CompressibleMimeTypePredicate(mediaTypes));
        }
        if (excludedUserAgents != null) {
            for (String agent : excludedUserAgents) {
                RequestHeaderAttribute agentHeader = new RequestHeaderAttribute(new HttpString(HttpHeaders.USER_AGENT));
                predicates.add(Predicates.not(Predicates.regex(agentHeader, agent)));
            }
        }
        return predicates.toArray(new Predicate[0]);
    }

    private static class CompressibleMimeTypePredicate implements Predicate {

        private final List mediaTypes;

        private CompressibleMimeTypePredicate(String[] mediaTypes) {
            if (mediaTypes.length == 1) {
                this.mediaTypes = Collections.singletonList(MediaType.parseMediaType(mediaTypes[0]));
            } else {
                this.mediaTypes = new ArrayList<>(mediaTypes.length);
                for (String mediaType : mediaTypes) {
                    this.mediaTypes.add(MediaType.parseMediaType(mediaType));
                }
            }
        }

        @Override
        public boolean resolve(HttpServerExchange exchange) {
            String contentType = exchange.getResponseHeaders().getFirst(HttpHeaders.CONTENT_TYPE);
            if (contentType != null) {
                for (MediaType mediaType : this.mediaTypes) {
                    if (mediaType.isCompatibleWith(MediaType.parseMediaType(contentType))) {
                        return true;
                    }
                }
            }
            return false;
        }

    }

}