Refine offset, length size handling in Content.Sources

jetty-core/jetty-http/src/main/java/org/eclipse/jetty/http/MultiPart.java

@@ -354,7 +354,9 @@ public final Content.Source createContentSource()
         @Override
         public Content.Source newContentSource(ByteBufferPool.Sized bufferPool, long offset, long length)
         {
-            return newContentSource();
+            // We call the deprecated newContentSource() to support existing subclasses.
+            // All current implementations of Part do override newContentSource(ByteBufferPool.Sized, long, long).
+            return Content.Source.from(newContentSource(), offset, length);
         }
 
         public long getLength()
@@ -499,10 +501,19 @@ public ByteBufferPart(String name, String fileName, HttpFields fields, List<Byte
             this.content = content;
         }
 
+        @Override
+        public long getLength()
+        {
+            long length = 0;
+            for (ByteBuffer b : content)
+                length += BufferUtil.length(b);
+            return length;
+        }
+
         @Override
         public Content.Source newContentSource(ByteBufferPool.Sized bufferPool, long offset, long length)
         {
-            return new ByteBufferContentSource(content);
+            return new ByteBufferContentSource(content, offset, length);
         }
 
         @Override
@@ -535,9 +546,21 @@ public ChunksPart(String name, String fileName, HttpFields fields, List<Content.
             content.forEach(Content.Chunk::retain);
         }
 
+        @Override
+        public long getLength()
+        {
+            long length = 0;
+            for (Content.Chunk c : content)
+                length += c.size();
+            return length;
+        }
+
         @Override
         public Content.Source newContentSource(ByteBufferPool.Sized bufferPool, long offset, long length)
         {
+            long size = getLength();
+            length = TypeUtil.checkOffsetLengthSize(offset, length, size);
+
             try (AutoLock ignored = lock.lock())
             {
                 if (closed)
@@ -556,7 +579,7 @@ public Content.Source newContentSource(ByteBufferPool.Sized bufferPool, long off
                 ChunksContentSource newContentSource = new ChunksContentSource(chunks);
                 chunks.forEach(Content.Chunk::release);
                 contentSources.add(newContentSource);
-                return newContentSource;
+                return Content.Source.from(newContentSource, offset, length);
             }
         }
 
@@ -650,12 +673,19 @@ public ContentSourcePart(String name, String fileName, HttpFields fields, Conten
             this.content = Objects.requireNonNull(content);
         }
 
+        @Override
+        public long getLength()
+        {
+            return content.getLength();
+        }
+
         @Override
         public Content.Source newContentSource(ByteBufferPool.Sized bufferPool, long offset, long length)
         {
+            length = TypeUtil.checkOffsetLengthSize(offset, length, content.getLength());
             Content.Source c = content;
             content = null;
-            return c;
+            return Content.Source.from(c, offset, length);
         }
 
         @Override

jetty-core/jetty-io/src/main/java/org/eclipse/jetty/io/Content.java

@@ -42,6 +42,7 @@
 import org.eclipse.jetty.io.internal.ContentCopier;
 import org.eclipse.jetty.io.internal.ContentSourceByteBuffer;
 import org.eclipse.jetty.io.internal.ContentSourceConsumer;
+import org.eclipse.jetty.io.internal.ContentSourceRange;
 import org.eclipse.jetty.io.internal.ContentSourceRetainableByteBuffer;
 import org.eclipse.jetty.io.internal.ContentSourceString;
 import org.eclipse.jetty.util.Blocker;
@@ -169,9 +170,13 @@ interface Factory
              * Creates a new {@link Content.Source}.
              *
              * @param bufferPool the {@link ByteBufferPool.Sized} to get buffers from. {@code null} means allocate new buffers as needed.
-             * @param offset the offset byte of the resource to start from.
+             * @param offset the offset byte of the content to start from.
+             *               Must be greater than or equal to 0 and less than the content length (if known).
              * @param length the length of the content to make available, -1 for the full length.
+             *               If the size of the content is known, the length may be truncated to the content size minus the offset.
              * @return a {@link Content.Source}.
+             * @throws IndexOutOfBoundsException if the offset or length are out of range.
+             * @see TypeUtil#checkOffsetLengthSize(long, long, long)
              */
             Content.Source newContentSource(ByteBufferPool.Sized bufferPool, long offset, long length);
         }
@@ -198,16 +203,42 @@ static Content.Source from(Path path)
 
         /**
          * Create a {@code Content.Source} from a {@link Path}.
+         *
          * @param path The {@link Path}s to use as the source.
-         * @param offset The offset in bytes from which to start the source
-         * @param length The length in bytes of the source.
-         * @return A {@code Content.Source}
+         * @param offset the offset byte of the content to start from.
+         *               Must be greater than or equal to 0 and less than the content length (if known).
+         * @param length the length of the content to make available, -1 for the full length.
+         *               If the size of the content is known, the length may be truncated to the content size minus the offset.
+         * @return a {@link Content.Source}.
+         * @throws IndexOutOfBoundsException if the offset or length are out of range.
+         * @see TypeUtil#checkOffsetLengthSize(long, long, long)
          */
         static Content.Source from(Path path, long offset, long length)
         {
             return from(null, path, offset, length);
         }
 
+        /**
+         * Wrap a {@link Content.Source} to make it appear as a sub-range of the original.
+         *
+         * @param source The {@link Content.Source} to wrap.
+         * @param offset the offset byte of the content to start from.
+         *               Must be greater than or equal to 0 and less than the content length (if known).
+         * @param length the length of the content to make available, -1 for the full length.
+         *               If the size of the content is known, the length may be truncated to the content size minus the offset.
+         * @return a {@link Content.Source}.
+         * @throws IndexOutOfBoundsException if the offset or length are out of range.
+         * @see TypeUtil#checkOffsetLengthSize(long, long, long)
+         */
+        static Content.Source from(Content.Source source, long offset, long length)
+        {
+            // If the offset and length include the full content, then do not wrap.
+            if (offset == 0 && (length == -1 || length == source.getLength()))
+                return source;
+
+            return new ContentSourceRange(source, offset, length);
+        }
+
         /**
          * Create a {@code Content.Source} from a {@link Path}.
          * @param byteBufferPool The {@link org.eclipse.jetty.io.ByteBufferPool.Sized} to use for any internal buffers.
@@ -223,9 +254,13 @@ static Content.Source from(ByteBufferPool.Sized byteBufferPool, Path path)
          * Create a {@code Content.Source} from a {@link Path}.
          * @param byteBufferPool The {@link org.eclipse.jetty.io.ByteBufferPool.Sized} to use for any internal buffers.
          * @param path The {@link Path}s to use as the source.
-         * @param offset The offset in bytes from which to start the source
-         * @param length The length in bytes of the source, -1 for the full length.
-         * @return A {@code Content.Source}
+         * @param offset the offset byte of the content to start from.
+         *               Must be greater than or equal to 0 and less than the content length (if known).
+         * @param length the length of the content to make available, -1 for the full length.
+         *               If the size of the content is known, the length may be truncated to the content size minus the offset.
+         * @return a {@link Content.Source}.
+         * @throws IndexOutOfBoundsException if the offset or length are out of range.
+         * @see TypeUtil#checkOffsetLengthSize(long, long, long)
          */
         static Content.Source from(ByteBufferPool.Sized byteBufferPool, Path path, long offset, long length)
         {
@@ -247,9 +282,13 @@ static Content.Source from(ByteBufferPool.Sized byteBufferPool, ByteChannel byte
          * Create a {@code Content.Source} from a {@link ByteChannel}.
          * @param byteBufferPool The {@link org.eclipse.jetty.io.ByteBufferPool.Sized} to use for any internal buffers.
          * @param seekableByteChannel The {@link ByteChannel}s to use as the source.
-         * @param offset The offset in bytes from which to start the source
-         * @param length The length in bytes of the source.
-         * @return A {@code Content.Source}
+         * @param offset the offset byte of the content to start from.
+         *               Must be greater than or equal to 0 and less than the content length (if known).
+         * @param length the length of the content to make available, -1 for the full length.
+         *               If the size of the content is known, the length may be truncated to the content size minus the offset.
+         * @return a {@link Content.Source}.
+         * @throws IndexOutOfBoundsException if the offset or length are out of range.
+         * @see TypeUtil#checkOffsetLengthSize(long, long, long)
          */
         static Content.Source from(ByteBufferPool.Sized byteBufferPool, SeekableByteChannel seekableByteChannel, long offset, long length)
         {
@@ -276,9 +315,13 @@ static Content.Source from(ByteBufferPool.Sized byteBufferPool, InputStream inpu
          * Create a {@code Content.Source} from an {@link InputStream}.
          * @param byteBufferPool The {@link org.eclipse.jetty.io.ByteBufferPool.Sized} to use for any internal buffers.
          * @param inputStream The {@link InputStream}s to use as the source.
-         * @param offset The offset in bytes from which to start the source
-         * @param length The number of bytes to read from the source, or -1 to read to the end of the stream
-         * @return A {@code Content.Source}
+         * @param offset the offset byte of the resource to start from.
+         *               Must be greater than or equal to 0 and less than the resource size (if known).
+         * @param length the length of the content to make available, or -1 for the full length available.
+         *               The length may be truncated if the stream ends sooner.
+         * @return a {@link Content.Source}.
+         * @throws IndexOutOfBoundsException if the offset or length are out of range.
+         * @see TypeUtil#checkOffsetLengthSize(long, long, long)
          */
         static Content.Source from(ByteBufferPool.Sized byteBufferPool, InputStream inputStream, long offset, long length)
         {

jetty-core/jetty-io/src/main/java/org/eclipse/jetty/io/IOResources.java

@@ -20,12 +20,14 @@
 import java.nio.channels.SeekableByteChannel;
 import java.nio.file.Files;
 import java.nio.file.Path;
+import java.util.Objects;
 
 import org.eclipse.jetty.util.Blocker;
 import org.eclipse.jetty.util.BufferUtil;
 import org.eclipse.jetty.util.Callback;
 import org.eclipse.jetty.util.IO;
 import org.eclipse.jetty.util.IteratingNestedCallback;
+import org.eclipse.jetty.util.TypeUtil;
 import org.eclipse.jetty.util.resource.MemoryResource;
 import org.eclipse.jetty.util.resource.Resource;
 
@@ -146,10 +148,14 @@ public static RetainableByteBuffer toRetainableByteBuffer(Resource resource, Byt
      *
      * @param resource the resource from which to get a {@link Content.Source}.
      * @param bufferPool the {@link ByteBufferPool.Sized} to get buffers from. {@code null} means allocate new buffers as needed.
-     * @param offset the offset byte from which to read from.
-     * @param length the length of the content to read, -1 for the full length.
-     * @return the {@link Content.Source}.
+     * @param offset the offset byte of the resource to start from.
+     * Must be greater than or equal to 0 and less than the resource length (if known).
+     * @param length the length of the content to make available, -1 for the full length,
+     * otherwise must be greater than 0 and less than or equal to the resource length (if known) minus the offset.
+     * @return a {@link Content.Source}.
+     * @throws IndexOutOfBoundsException if the offset or length are out of range.
      * @throws IllegalArgumentException if the resource is a directory or does not exist or there is no way to access its contents.
+     * @see Objects#checkFromIndexSize(long, long, long)
      */
     public static Content.Source asContentSource(Resource resource, ByteBufferPool.Sized bufferPool, long offset, long length) throws IllegalArgumentException
     {
@@ -165,6 +171,8 @@ public static Content.Source asContentSource(Resource resource, ByteBufferPool.S
         if (path != null)
             return Content.Source.from(bufferPool, path, offset, length);
 
+        length = TypeUtil.checkOffsetLengthSize(offset, length, resource.length());
+
         // Try an optimization for MemoryResource.
         if (resource instanceof MemoryResource memoryResource)
             return Content.Source.from(BufferUtil.slice(ByteBuffer.wrap(memoryResource.getBytes()), Math.toIntExact(offset), Math.toIntExact(length)));
@@ -237,6 +245,8 @@ public static void copy(Resource resource, Content.Sink sink, ByteBufferPool.Siz
                 return;
             }
 
+            length = TypeUtil.checkOffsetLengthSize(offset, length, resource.length());
+
             // Save a Content.Source allocation for resources with a Path.
             Path path = resource.getPath();
             if (path != null)

jetty-core/jetty-io/src/main/java/org/eclipse/jetty/io/content/ByteBufferContentSource.java

@@ -20,6 +20,8 @@
 import java.util.List;
 
 import org.eclipse.jetty.io.Content;
+import org.eclipse.jetty.util.BufferUtil;
+import org.eclipse.jetty.util.TypeUtil;
 import org.eclipse.jetty.util.thread.AutoLock;
 import org.eclipse.jetty.util.thread.SerializedInvoker;
 
@@ -45,8 +47,18 @@ public ByteBufferContentSource(ByteBuffer... byteBuffers)
 
     public ByteBufferContentSource(Collection<ByteBuffer> byteBuffers)
     {
-        this.byteBuffers = byteBuffers;
-        this.length = byteBuffers.stream().mapToLong(Buffer::remaining).sum();
+        this(byteBuffers, 0, -1);
+    }
+
+    public ByteBufferContentSource(Collection<ByteBuffer> byteBuffers, long offset, long length)
+    {
+        long size = byteBuffers.stream().mapToLong(Buffer::remaining).sum();
+        length = TypeUtil.checkOffsetLengthSize(offset, length, size);
+        if (offset == 0 && size == length)
+            this.byteBuffers = byteBuffers;
+        else
+            this.byteBuffers = BufferUtil.slice(byteBuffers, offset, length);
+        this.length = length;
     }
 
     public Collection<ByteBuffer> getByteBuffers()

jetty-core/jetty-io/src/main/java/org/eclipse/jetty/io/content/InputStreamContentSource.java

@@ -24,6 +24,7 @@
 import org.eclipse.jetty.io.RetainableByteBuffer;
 import org.eclipse.jetty.util.ExceptionUtil;
 import org.eclipse.jetty.util.IO;
+import org.eclipse.jetty.util.TypeUtil;
 import org.eclipse.jetty.util.thread.AutoLock;
 import org.eclipse.jetty.util.thread.SerializedInvoker;
 
@@ -63,6 +64,7 @@ public InputStreamContentSource(InputStream inputStream, ByteBufferPool.Sized bu
 
     public InputStreamContentSource(InputStream inputStream, ByteBufferPool.Sized bufferPool, long offset, long length)
     {
+        length = TypeUtil.checkOffsetLengthSize(offset, length, -1);
         this.inputStream = Objects.requireNonNull(inputStream);
         this.bufferPool =  Objects.requireNonNullElse(bufferPool, ByteBufferPool.SIZED_NON_POOLING);
         if (length != 0)