com.github.netty.protocol.servlet.NettyHttpResponse Maven / Gradle / Ivy

Go to download
package com.github.netty.protocol.servlet;

import com.github.netty.core.util.Recyclable;
import com.github.netty.core.util.RecyclableUtil;
import com.github.netty.protocol.servlet.util.HttpConstants;
import com.github.netty.protocol.servlet.util.*;
import io.netty.buffer.Unpooled;
import io.netty.handler.codec.DecoderResult;
import io.netty.handler.codec.http.*;

import javax.servlet.http.Cookie;
import java.io.Flushable;
import java.util.List;
import java.util.Locale;
import java.util.concurrent.atomic.AtomicBoolean;

import static com.github.netty.protocol.servlet.util.HttpHeaderConstants.CLOSE;

/**
 * NettyHttpResponse
 *
 * @author wangzihao
 * 2018/7/28/028
 */
public class NettyHttpResponse implements HttpResponse, Recyclable, Flushable {
    public static final HttpResponseStatus DEFAULT_STATUS = HttpResponseStatus.OK;
    private static final String APPEND_CONTENT_TYPE = ";" + HttpHeaderConstants.CHARSET + "=";
    protected final AtomicBoolean isSettingResponse = new AtomicBoolean(false);
    private DecoderResult decoderResult;
    private HttpVersion version;
    private final HttpHeaders headers;
    private HttpResponseStatus status;
    private LastHttpContent lastHttpContent;
    private ServletHttpExchange exchange;
    private boolean writeSendFile = false;

    public NettyHttpResponse() {
        this.headers = new DefaultHttpHeaders(false);
        this.version = HttpVersion.HTTP_1_1;
        this.status = DEFAULT_STATUS;
        this.decoderResult = DecoderResult.SUCCESS;
    }

    /**
     * Determine if we must drop the connection because of the HTTP status
     * code.  Use the same list of codes as Apache/httpd.
     *
     * @param status response status
     * @return is need close.  true = need close
     */
    private static boolean statusDropsConnection(int status) {
//        if(status == 200){
//            return false;
//        }
        return
//                status == 400 /* SC_BAD_REQUEST */ ||
//                status == 408 /* SC_REQUEST_TIMEOUT */ ||
//                status == 411 /* SC_LENGTH_REQUIRED */ ||
//                status == 413 /* SC_REQUEST_ENTITY_TOO_LARGE */ ||
//                status == 414 /* SC_REQUEST_URI_TOO_LONG */ ||
//                status == 500 /* SC_INTERNAL_SERVER_ERROR */ ||
//                status == 501 /* SC_NOT_IMPLEMENTED */ ||
                status == 503 /* SC_SERVICE_UNAVAILABLE */;
    }

    /**
     * enableTransferEncodingChunked
     *
     * @return LastHttpContent
     */
    public LastHttpContent enableTransferEncodingChunked() {
        if (!isTransferEncodingChunked()) {
            HttpHeaderUtil.setTransferEncodingChunked(headers, true);
            lastHttpContent = new DefaultLastHttpContent(Unpooled.EMPTY_BUFFER, false);
        }
        return lastHttpContent;
    }

    public boolean isTransferEncodingChunked() {
        return HttpHeaderUtil.isTransferEncodingChunked(headers);
    }

    void setExchange(ServletHttpExchange exchange) {
        this.version = exchange.getRequest().getNettyRequest().protocolVersion();
        this.exchange = exchange;
    }

    @Override
    public HttpResponseStatus getStatus() {
        return status;
    }

    @Override
    public NettyHttpResponse setStatus(HttpResponseStatus status) {
        this.status = status;
        return this;
    }

    @Override
    public HttpVersion getProtocolVersion() {
        return version;
    }

    @Override
    public NettyHttpResponse setProtocolVersion(HttpVersion version) {
        this.version = version;
        return this;
    }

    @Override
    public DecoderResult getDecoderResult() {
        return decoderResult;
    }

    @Override
    public void setDecoderResult(DecoderResult result) {
        this.decoderResult = result;
    }

    public HttpResponseStatus status() {
        return status;
    }

    public HttpVersion protocolVersion() {
        return version;
    }

    public DecoderResult decoderResult() {
        return decoderResult;
    }

    public LastHttpContent getLastHttpContent() {
        return lastHttpContent;
    }

    @Override
    public HttpHeaders headers() {
        return headers;
    }

    @Override
    public void recycle() {
        this.headers.clear();
        this.version = HttpVersion.HTTP_1_1;
        this.status = DEFAULT_STATUS;
        this.writeSendFile = false;
        this.lastHttpContent = null;
        this.decoderResult = DecoderResult.SUCCESS;
        this.isSettingResponse.set(false);
    }

    public boolean isWriteSendFile() {
        return writeSendFile;
    }

    public void setWriteSendFile(boolean writeSendFile) {
        this.writeSendFile = writeSendFile;
    }

    @Override
    public int hashCode() {
        int result = decoderResult != null ? decoderResult.hashCode() : 0;
        result = 31 * result + (version != null ? version.hashCode() : 0);
        result = 31 * result + (headers != null ? headers.hashCode() : 0);
        result = 31 * result + (status != null ? status.hashCode() : 0);
        return result;
    }

    @Override
    public boolean equals(Object o) {
        if (this == o) {
            return true;
        }
        if (o == null || getClass() != o.getClass()) {
            return false;
        }

        NettyHttpResponse that = (NettyHttpResponse) o;
        if (!decoderResult.equals(that.decoderResult)) {
            return false;
        }
        if (!version.equals(that.version)) {
            return false;
        }
        if (!status.equals(that.status)) {
            return false;
        }
        return headers.equals(that.headers);
    }

    @Override
    public String toString() {
        return "NettyHttpResponse{" +
                "decoderResult=" + decoderResult +
                ", version=" + version +
                ", headers=" + headers +
                ", status=" + status +
                '}';
    }

    @Override
    public void flush() {
        if (isSettingResponse.compareAndSet(false, true)) {
            //Configure the response header
            ServletHttpServletRequest servletRequest = exchange.getRequest();
            ServletHttpServletResponse servletResponse = exchange.getResponse();
            ServletSessionCookieConfig sessionCookieConfig = exchange.getServletContext().getSessionCookieConfig();

            settingResponseHeader(isKeepAlive(), exchange.getProtocol(), exchange.isSsl(), servletRequest,
                    servletResponse.getContentType(), servletResponse.getCharacterEncoding(),
                    servletResponse.getContentLength(), servletResponse.getLocaleUse(),
                    servletResponse.getCookies(), sessionCookieConfig);
        }
    }

    public boolean isKeepAlive() {
        return exchange.isHttpKeepAlive()
                && !statusDropsConnection(exchange.getResponse().getStatus());
    }

    /**
     * Set the response header
     *
     * @param isKeepAlive         isKeepAlive
     * @param protocol            Protocol
     * @param ssl                 ssl
     * @param servletRequest      servletRequest
     * @param contentType         contentType
     * @param characterEncoding   characterEncoding
     * @param contentLength       contentLength
     * @param locale              locale
     * @param cookies             cookies
     * @param sessionCookieConfig sessionCookieConfig
     */
    private void settingResponseHeader(boolean isKeepAlive, Protocol protocol, boolean ssl,
                                       ServletHttpServletRequest servletRequest,
                                       String contentType, String characterEncoding, long contentLength, Locale locale, List cookies,
                                       ServletSessionCookieConfig sessionCookieConfig) {
        HttpHeaderUtil.setKeepAlive(this, isKeepAlive);
        HttpHeaders headers = headers();

        if (protocol.isHttp2()) {
            // h2 adapter
            String streamId = servletRequest.getNettyHeaders().get(HttpConstants.H2_EXT_STREAM_ID);
            if (streamId != null) {
                headers.set(HttpConstants.H2_EXT_STREAM_ID, streamId);
            }

            // h2 scheme
            if (!headers.contains(HttpConstants.H2_EXT_SCHEME)) {
                HttpScheme scheme = ssl ? HttpScheme.HTTPS : HttpScheme.HTTP;
                headers.set(HttpConstants.H2_EXT_SCHEME, scheme.name());
            }
        }

        //Content length
        if (contentLength >= 0) {
            headers.remove(HttpHeaderConstants.TRANSFER_ENCODING);
            headers.set(HttpHeaderConstants.CONTENT_LENGTH, contentLength);
        } else {
            enableTransferEncodingChunked();
        }

        //if need close client
        if (servletRequest.getInputStream0().isNeedCloseClient()) {
            headers.set(HttpHeaderConstants.CONNECTION, CLOSE);
        }

        // Time and date response header
        if (!headers.contains(HttpHeaderConstants.DATE)) {
            headers.set(HttpHeaderConstants.DATE, ServletUtil.getDateByRfcHttp());
        }

        //Content Type The content of the response header
        if (null != contentType) {
            String value = (null == characterEncoding) ? contentType :
                    RecyclableUtil.newStringBuilder()
                            .append(contentType)
                            .append(APPEND_CONTENT_TYPE)
                            .append(characterEncoding).toString();
            headers.set(HttpHeaderConstants.CONTENT_TYPE, value);
        }

        //Server information response header
        String serverHeader = servletRequest.getServletContext().getServerHeader();
        if (serverHeader != null && serverHeader.length() > 0) {
            headers.set(HttpHeaderConstants.SERVER, serverHeader);
        }

        //language
        if (locale != null && !headers.contains(HttpHeaderConstants.CONTENT_LANGUAGE)) {
            headers.set(HttpHeaderConstants.CONTENT_LANGUAGE, locale.toLanguageTag());
        }

        // Cookies processing
        //Session is handled first. If it is a new Session and the Session id is not the same as the Session id passed by the request, it needs to be written through the Cookie
        ServletHttpSession httpSession = servletRequest.getSession(false);
        if (httpSession != null && httpSession.isNew()) {
            String sessionCookieName = sessionCookieConfig.getName();
            if (sessionCookieName == null || sessionCookieName.isEmpty()) {
                sessionCookieName = HttpConstants.JSESSION_ID_COOKIE;
            }
            String sessionCookiePath = sessionCookieConfig.getPath();
            if (sessionCookiePath == null || sessionCookiePath.isEmpty()) {
                sessionCookiePath = HttpConstants.DEFAULT_SESSION_COOKIE_PATH;
            }
            String sessionCookieText = ServletUtil.encodeCookie(sessionCookieName, httpSession.getId(), sessionCookieConfig.getMaxAge(),
                    sessionCookiePath, sessionCookieConfig.getDomain(), sessionCookieConfig.isSecure(), sessionCookieConfig.isHttpOnly());
            headers.add(HttpHeaderConstants.SET_COOKIE, sessionCookieText);
        }

        //Cookies set by other businesses or frameworks are written to the response header one by one
        int cookieSize = cookies.size();
        if (cookieSize > 0) {
            for (int i = 0; i < cookieSize; i++) {
                Cookie cookie = cookies.get(i);
                String cookieText = ServletUtil.encodeCookie(cookie.getName(), cookie.getValue(), cookie.getMaxAge(), cookie.getPath(), cookie.getDomain(), cookie.getSecure(), cookie.isHttpOnly());
                headers.add(HttpHeaderConstants.SET_COOKIE, cookieText);
            }
        }
    }

}