/**
* Licensed to the Apache Software Foundation (ASF) under one
* or more contributor license agreements. See the NOTICE file
* distributed with this work for additional information
* regarding copyright ownership. The ASF 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
*
* 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 org.jooby.internal.netty;
import static io.netty.channel.ChannelFutureListener.CLOSE;
import java.io.InputStream;
import java.nio.ByteBuffer;
import java.nio.channels.FileChannel;
import java.util.Collections;
import java.util.List;
import java.util.Optional;
import org.jooby.spi.NativeResponse;
import com.google.common.collect.ImmutableList;
import com.google.common.io.ByteStreams;
import io.netty.buffer.ByteBuf;
import io.netty.buffer.Unpooled;
import io.netty.channel.ChannelFuture;
import io.netty.channel.ChannelHandlerContext;
import io.netty.channel.ChannelPipeline;
import io.netty.channel.DefaultFileRegion;
import io.netty.handler.codec.http.DefaultFullHttpResponse;
import io.netty.handler.codec.http.DefaultHttpHeaders;
import io.netty.handler.codec.http.DefaultHttpResponse;
import io.netty.handler.codec.http.HttpChunkedInput;
import io.netty.handler.codec.http.HttpHeaderNames;
import io.netty.handler.codec.http.HttpHeaderValues;
import io.netty.handler.codec.http.HttpHeaders;
import io.netty.handler.codec.http.HttpResponseStatus;
import io.netty.handler.codec.http.HttpVersion;
import io.netty.handler.codec.http.LastHttpContent;
import io.netty.handler.codec.http2.HttpConversionUtil;
import io.netty.handler.ssl.SslHandler;
import io.netty.handler.stream.ChunkedNioFile;
import io.netty.handler.stream.ChunkedStream;
import io.netty.handler.stream.ChunkedWriteHandler;
import io.netty.util.Attribute;
public class NettyResponse implements NativeResponse {
private ChannelHandlerContext ctx;
private boolean keepAlive;
private HttpResponseStatus status;
private HttpHeaders headers;
private boolean committed;
private int bufferSize;
public NettyResponse(final ChannelHandlerContext ctx, final int bufferSize,
final boolean keepAlive) {
this(ctx, bufferSize, keepAlive, null);
}
public NettyResponse(final ChannelHandlerContext ctx, final int bufferSize,
final boolean keepAlive, final String streamId) {
this.ctx = ctx;
this.bufferSize = bufferSize;
this.keepAlive = keepAlive;
this.headers = new DefaultHttpHeaders();
if (streamId != null) {
headers.set(HttpConversionUtil.ExtensionHeaderNames.STREAM_ID.text(), streamId);
}
this.status = HttpResponseStatus.OK;
}
@Override
public List<String> headers(final String name) {
List<String> headers = this.headers.getAll(name);
return headers == null ? Collections.emptyList() : ImmutableList.copyOf(headers);
}
@Override
public Optional<String> header(final String name) {
return Optional.ofNullable(this.headers.get(name));
}
@Override
public void header(final String name, final String value) {
headers.set(name, value);
}
@Override
public void header(final String name, final Iterable<String> values) {
headers.remove(name)
.add(name, values);
}
@Override
public void send(final byte[] bytes) throws Exception {
send(Unpooled.wrappedBuffer(bytes));
}
@Override
public void send(final ByteBuffer buffer) throws Exception {
send(Unpooled.wrappedBuffer(buffer));
}
@Override
public void send(final InputStream stream) throws Exception {
byte[] chunk = new byte[bufferSize];
int count = ByteStreams.read(stream, chunk, 0, bufferSize);
if (count <= 0) {
return;
}
ByteBuf buffer = Unpooled.wrappedBuffer(chunk, 0, count);
if (count < bufferSize) {
send(buffer);
} else {
DefaultHttpResponse rsp = new DefaultHttpResponse(HttpVersion.HTTP_1_1, status);
if (!headers.contains(HttpHeaderNames.CONTENT_LENGTH)) {
headers.set(HttpHeaderNames.TRANSFER_ENCODING, HttpHeaderValues.CHUNKED);
} else {
if (keepAlive) {
headers.set(HttpHeaderNames.CONNECTION, HttpHeaderValues.KEEP_ALIVE);
}
}
// dump headers
rsp.headers().set(headers);
ChannelHandlerContext ctx = this.ctx;
ctx.channel().attr(NettyRequest.NEED_FLUSH).set(false);
// add chunker
chunkHandler(ctx.pipeline());
// group all write
ctx.channel().eventLoop().execute(() -> {
// send headers
ctx.write(rsp);
// send head chunk
ctx.write(buffer);
// send tail
ctx.write(new ChunkedStream(stream, bufferSize));
keepAlive(ctx.writeAndFlush(LastHttpContent.EMPTY_LAST_CONTENT));
});
}
committed = true;
}
@Override
public void send(final FileChannel channel) throws Exception {
send(channel, 0, channel.size());
}
@Override
public void send(final FileChannel channel, final long offset, final long count)
throws Exception {
DefaultHttpResponse rsp = new DefaultHttpResponse(HttpVersion.HTTP_1_1, status);
if (!headers.contains(HttpHeaderNames.CONTENT_LENGTH)) {
headers.remove(HttpHeaderNames.TRANSFER_ENCODING);
headers.set(HttpHeaderNames.CONTENT_LENGTH, count);
}
if (keepAlive) {
headers.set(HttpHeaderNames.CONNECTION, HttpHeaderValues.KEEP_ALIVE);
}
// dump headers
rsp.headers().set(headers);
ChannelHandlerContext ctx = this.ctx;
ctx.channel().attr(NettyRequest.NEED_FLUSH).set(false);
ChannelPipeline pipeline = ctx.pipeline();
boolean ssl = pipeline.get(SslHandler.class) != null;
if (ssl) {
// add chunker
chunkHandler(pipeline);
// Create the chunked input here already, to properly handle the IOException
HttpChunkedInput chunkedInput = new HttpChunkedInput(
new ChunkedNioFile(channel, offset, count, bufferSize));
ctx.channel().eventLoop().execute(() -> {
// send headers
ctx.write(rsp);
// chunked file
keepAlive(ctx.writeAndFlush(chunkedInput));
});
} else {
ctx.channel().eventLoop().execute(() -> {
// send headers
ctx.write(rsp);
// file region
ctx.write(new DefaultFileRegion(channel, offset, count));
keepAlive(ctx.writeAndFlush(LastHttpContent.EMPTY_LAST_CONTENT));
});
}
committed = true;
}
private void send(final ByteBuf buffer) throws Exception {
DefaultFullHttpResponse rsp = new DefaultFullHttpResponse(HttpVersion.HTTP_1_1, status, buffer);
if (!headers.contains(HttpHeaderNames.CONTENT_LENGTH)) {
headers.remove(HttpHeaderNames.TRANSFER_ENCODING)
.set(HttpHeaderNames.CONTENT_LENGTH, buffer.readableBytes());
}
if (keepAlive) {
headers.set(HttpHeaderNames.CONNECTION, HttpHeaderValues.KEEP_ALIVE);
}
// dump headers
rsp.headers().set(headers);
Attribute<Boolean> async = ctx.channel().attr(NettyRequest.ASYNC);
boolean isAsync = async != null && async.get() == Boolean.TRUE;
if (isAsync) {
// we need flush, from async
keepAlive(ctx.writeAndFlush(rsp));
} else {
keepAlive(ctx.write(rsp));
}
committed = true;
}
private void keepAlive(final ChannelFuture future) {
if (headers.contains(HttpHeaderNames.CONTENT_LENGTH)) {
if (!keepAlive) {
future.addListener(CLOSE);
}
} else {
// content len is not set, just close the connection regardless keep alive or not.
future.addListener(CLOSE);
}
}
@Override
public int statusCode() {
return status.code();
}
@Override
public void statusCode(final int code) {
this.status = HttpResponseStatus.valueOf(code);
}
@Override
public boolean committed() {
return committed;
}
@Override
public void end() {
if (ctx != null) {
Attribute<NettyWebSocket> ws = ctx.channel().attr(NettyWebSocket.KEY);
if (ws != null && ws.get() != null) {
status = HttpResponseStatus.SWITCHING_PROTOCOLS;
ws.get().hankshake();
ctx = null;
committed = true;
return;
}
if (!committed) {
DefaultHttpResponse rsp = new DefaultFullHttpResponse(HttpVersion.HTTP_1_1, status);
// dump headers
rsp.headers().set(headers);
keepAlive(ctx.write(rsp));
}
committed = true;
ctx = null;
}
}
@Override
public void reset() {
headers.clear();
status = HttpResponseStatus.OK;
}
private void chunkHandler(final ChannelPipeline pipeline) {
if (pipeline.get("chunker") == null) {
pipeline.addAfter("codec", "chunker", new ChunkedWriteHandler());
}
}
}