io.undertow.conduits.ChunkedStreamSourceConduit Maven / Gradle / Ivy
Go to download
This artifact provides a single jar that contains all classes required to use remote EJB and JMS, including
all dependencies. It is intended for use by those not using maven, maven users should just import the EJB and
JMS BOM's instead (shaded JAR's cause lots of problems with maven, as it is very easy to inadvertently end up
with different versions on classes on the class path).
/*
* JBoss, Home of Professional Open Source.
* Copyright 2014 Red Hat, Inc., and individual contributors
* as indicated by the @author tags.
*
* 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 io.undertow.conduits;
import io.undertow.UndertowMessages;
import io.undertow.connector.ByteBufferPool;
import io.undertow.connector.PooledByteBuffer;
import io.undertow.server.Connectors;
import io.undertow.server.HttpServerExchange;
import io.undertow.server.protocol.http.HttpAttachments;
import io.undertow.server.protocol.http.HttpServerConnection;
import io.undertow.util.Attachable;
import io.undertow.util.AttachmentKey;
import io.undertow.util.HeaderMap;
import io.undertow.util.PooledAdaptor;
import org.xnio.IoUtils;
import org.xnio.channels.StreamSinkChannel;
import org.xnio.conduits.AbstractStreamSourceConduit;
import org.xnio.conduits.ConduitReadableByteChannel;
import org.xnio.conduits.PushBackStreamSourceConduit;
import org.xnio.conduits.StreamSourceConduit;
import java.io.Closeable;
import java.io.IOException;
import java.nio.ByteBuffer;
import java.nio.channels.ClosedChannelException;
import java.nio.channels.FileChannel;
/**
* Channel to de-chunkify data
*
* @author Stuart Douglas
*/
public class ChunkedStreamSourceConduit extends AbstractStreamSourceConduit {
/**
* If the response has HTTP footers they are attached to the exchange under this key. They will only be available once the exchange has been fully read.
*/
@Deprecated
public static final AttachmentKey TRAILERS = HttpAttachments.REQUEST_TRAILERS;
private final BufferWrapper bufferWrapper;
private final ConduitListener finishListener;
private final HttpServerExchange exchange;
private final Closeable closeable;
private boolean closed;
private boolean finishListenerInvoked;
private long remainingAllowed;
private final ChunkReader chunkReader;
private final PushBackStreamSourceConduit channel;
public ChunkedStreamSourceConduit(final StreamSourceConduit next, final PushBackStreamSourceConduit channel, final ByteBufferPool pool, final ConduitListener finishListener, Attachable attachable, Closeable closeable) {
this(next, new BufferWrapper() {
@Override
public PooledByteBuffer allocate() {
return pool.allocate();
}
@Override
public void pushBack(PooledByteBuffer pooled) {
channel.pushBack(new PooledAdaptor(pooled));
}
}, finishListener, attachable, null, closeable, channel);
}
public ChunkedStreamSourceConduit(final StreamSourceConduit next, final HttpServerExchange exchange, final ConduitListener finishListener) {
this(next, new BufferWrapper() {
@Override
public PooledByteBuffer allocate() {
return exchange.getConnection().getByteBufferPool().allocate();
}
@Override
public void pushBack(PooledByteBuffer pooled) {
((HttpServerConnection) exchange.getConnection()).ungetRequestBytes(pooled);
}
}, finishListener, exchange, exchange, exchange.getConnection(), null);
}
protected ChunkedStreamSourceConduit(final StreamSourceConduit next, final BufferWrapper bufferWrapper, final ConduitListener finishListener, final Attachable attachable, final HttpServerExchange exchange, final Closeable closeable, PushBackStreamSourceConduit channel) {
super(next);
this.bufferWrapper = bufferWrapper;
this.finishListener = finishListener;
this.remainingAllowed = Long.MIN_VALUE;
this.chunkReader = new ChunkReader<>(attachable, HttpAttachments.REQUEST_TRAILERS, this);
this.exchange = exchange;
this.closeable = closeable;
this.channel = channel;
}
public long transferTo(final long position, final long count, final FileChannel target) throws IOException {
try {
return target.transferFrom(new ConduitReadableByteChannel(this), position, count);
} catch (IOException | RuntimeException | Error e) {
IoUtils.safeClose(closeable);
throw e;
}
}
private void updateRemainingAllowed(final int written) throws IOException {
if (remainingAllowed == Long.MIN_VALUE) {
if (exchange == null) {
return;
} else {
long maxEntitySize = exchange.getMaxEntitySize();
if (maxEntitySize <= 0) {
return;
}
remainingAllowed = maxEntitySize;
}
}
remainingAllowed -= written;
if (remainingAllowed < 0) {
//max entity size is exceeded
Connectors.terminateRequest(exchange);
closed = true;
exchange.setPersistent(false);
finishListener.handleEvent(this);
throw UndertowMessages.MESSAGES.requestEntityWasTooLarge(exchange.getMaxEntitySize());
}
}
@Override
public long transferTo(final long count, final ByteBuffer throughBuffer, final StreamSinkChannel target) throws IOException {
try {
return IoUtils.transfer(new ConduitReadableByteChannel(this), count, throughBuffer, target);
} catch (IOException | RuntimeException | Error e) {
IoUtils.safeClose(closeable);
throw e;
}
}
@Override
public long read(final ByteBuffer[] dsts, final int offset, final int length) throws IOException {
for (int i = offset; i < length; ++i) {
if (dsts[i].hasRemaining()) {
return read(dsts[i]);
}
}
return 0;
}
@Override
public void terminateReads() throws IOException {
super.terminateReads();
if (channel != null)
channel.terminateReads();
if (!isFinished()) {
exchange.setPersistent(false);
super.terminateReads();
throw UndertowMessages.MESSAGES.chunkedChannelClosedMidChunk();
}
}
@Override
public int read(final ByteBuffer dst) throws IOException {
boolean invokeFinishListener = false;
try {
long chunkRemaining = chunkReader.getChunkRemaining();
//we have read the last chunk, we just return EOF
if (chunkRemaining == -1) {
if(!finishListenerInvoked) {
invokeFinishListener = true;
}
return -1;
}
if (closed) {
throw new ClosedChannelException();
}
PooledByteBuffer pooled = bufferWrapper.allocate();
ByteBuffer buf = pooled.getBuffer();
boolean free = true;
try {
//we need to do our initial read into a
int r = next.read(buf);
buf.flip();
if (r == -1) {
//Channel is broken, not sure how best to report it
throw new ClosedChannelException();
} else if (r == 0) {
return 0;
}
if (chunkRemaining == 0) {
chunkRemaining = chunkReader.readChunk(buf);
if (chunkRemaining <= 0) {
if(buf.hasRemaining()) {
free = false;
}
if(!finishListenerInvoked && chunkRemaining < 0) {
invokeFinishListener = true;
}
return (int) chunkRemaining;
}
}
final int originalLimit = dst.limit();
try {
//now we may have some stuff in the raw buffer
//or the raw buffer may be exhausted, and we should read directly into the destination buffer
//from the next
int read = 0;
long chunkInBuffer = Math.min(buf.remaining(), chunkRemaining);
int remaining = dst.remaining();
if (chunkInBuffer > remaining) {
//it won't fit
int orig = buf.limit();
buf.limit(buf.position() + remaining);
dst.put(buf);
buf.limit(orig);
chunkRemaining -= remaining;
updateRemainingAllowed(remaining);
free = false;
return remaining;
} else if (buf.hasRemaining()) {
int old = buf.limit();
buf.limit((int) Math.min(old, buf.position() + chunkInBuffer));
try {
dst.put(buf);
} finally {
buf.limit(old);
}
read += chunkInBuffer;
chunkRemaining -= chunkInBuffer;
}
//there is still more to read
//we attempt to just read it directly into the destination buffer
//adjusting the limit as necessary to make sure we do not read too much
if (chunkRemaining > 0) {
int old = dst.limit();
try {
if (chunkRemaining < dst.remaining()) {
dst.limit((int) (dst.position() + chunkRemaining));
}
int c = 0;
do {
c = next.read(dst);
if (c > 0) {
read += c;
chunkRemaining -= c;
}
} while (c > 0 && chunkRemaining > 0);
if (c == -1) {
throw new ClosedChannelException();
}
} finally {
dst.limit(old);
}
} else {
free = false;
}
updateRemainingAllowed(read);
return read;
} finally {
//buffer will be freed if not needed in exitRead
dst.limit(originalLimit);
}
} finally {
if (chunkRemaining >= 0) {
chunkReader.setChunkRemaining(chunkRemaining);
}
if (!free && buf.hasRemaining()) {
bufferWrapper.pushBack(pooled);
} else {
pooled.close();
}
}
} catch (IOException | RuntimeException | Error e) {
IoUtils.safeClose(closeable);
throw e;
} finally {
if(invokeFinishListener) {
finishListenerInvoked = true;
finishListener.handleEvent(this);
}
}
}
public boolean isFinished() {
return closed || chunkReader.getChunkRemaining() == -1;
}
interface BufferWrapper {
PooledByteBuffer allocate();
void pushBack(PooledByteBuffer pooled);
}
}