Merge remote-tracking branch 'apache/master' into feat/file-systems

Author: ppkarwasz

.github/workflows/codeql-analysis.yml

@@ -62,7 +62,7 @@ jobs:
 
     # Initializes the CodeQL tools for scanning.
     - name: Initialize CodeQL
-      uses: github/codeql-action/init@3c3833e0f8c1c83d449a7478aa59c036a9165498    # 3.29.5
+      uses: github/codeql-action/init@2d92b76c45b91eb80fc44c74ce3fce0ee94e8f9d    # 3.29.5
       with:
         languages: ${{ matrix.language }}
         # If you wish to specify custom queries, you can do so here or in a config file.
@@ -73,7 +73,7 @@ jobs:
     # Autobuild attempts to build any compiled languages  (C/C++, C#, or Java).
     # If this step fails, then you should remove it and run the build manually (see below)
     - name: Autobuild
-      uses: github/codeql-action/autobuild@3c3833e0f8c1c83d449a7478aa59c036a9165498    # 3.29.5
+      uses: github/codeql-action/autobuild@2d92b76c45b91eb80fc44c74ce3fce0ee94e8f9d    # 3.29.5
 
     # ℹ️ Command-line programs to run using the OS shell.
     # 📚 https://git.io/JvXDl
@@ -87,4 +87,4 @@ jobs:
     #   make release
 
     - name: Perform CodeQL Analysis
-      uses: github/codeql-action/analyze@3c3833e0f8c1c83d449a7478aa59c036a9165498    # 3.29.5
+      uses: github/codeql-action/analyze@2d92b76c45b91eb80fc44c74ce3fce0ee94e8f9d    # 3.29.5

.github/workflows/scorecards-analysis.yml

@@ -66,6 +66,6 @@ jobs:
           retention-days: 5
 
       - name: "Upload to code-scanning"
-        uses: github/codeql-action/upload-sarif@3c3833e0f8c1c83d449a7478aa59c036a9165498    # 3.29.5
+        uses: github/codeql-action/upload-sarif@2d92b76c45b91eb80fc44c74ce3fce0ee94e8f9d    # 3.29.5
         with:
           sarif_file: results.sarif

src/changes/changes.xml

@@ -50,6 +50,9 @@ The <action> type attribute can be add,update,fix,remove.
       <action type="fix" dev="ggregory"                due-to="Gary Gregory">When testing on Java 21 and up, enable -XX:+EnableDynamicAgentLoading.</action>
       <action type="fix" dev="ggregory"                due-to="Gary Gregory">When testing on Java 24 and up, don't fail FileUtilsListFilesTest for a different behavior in the JRE.</action>
       <action type="fix" dev="ggregory"                due-to="Stanislav Fort, Gary Gregory">ValidatingObjectInputStream does not validate dynamic proxy interfaces.</action>
+      <action type="fix" dev="pkarwasz"                due-to="Piotr P. Karwasz">BoundedInputStream.getRemaining() now reports Long.MAX_VALUE instead of 0 when no limit is set.</action>
+      <action type="fix" dev="pkarwasz"                due-to="Piotr P. Karwasz">BoundedInputStream.available() correctly accounts for the maximum read limit.</action>
+      <action type="fix" dev="ggregory"                due-to="Gary Gregory, Piotr P. Karwasz">Deprecate IOUtils.readFully(InputStream, int) in favor of toByteArray(InputStream, int).</action>
       <!-- ADD -->
       <action dev="ggregory" type="add"                due-to="strangelookingnerd, Gary Gregory">FileUtils#byteCountToDisplaySize() supports Zettabyte, Yottabyte, Ronnabyte and Quettabyte #763.</action>
       <action dev="ggregory" type="add"                due-to="strangelookingnerd, Gary Gregory">Add org.apache.commons.io.FileUtils.ONE_RB #763.</action>
@@ -61,7 +64,9 @@ The <action> type attribute can be add,update,fix,remove.
       <!-- UPDATE -->
       <action type="update" dev="ggregory"             due-to="Gary Gregory, Dependabot">Bump org.apache.commons:commons-parent from 85 to 87 #774.</action>
       <action type="update" dev="ggregory"             due-to="Gary Gregory">[test] Bump commons-codec:commons-codec from 1.18.0 to 1.19.0.</action>
-      <action type="update" dev="ggregory"             due-to="Gary Gregory">[test] Bump commons.bytebuddy.version from 1.17.6 to 1.17.7 #769.</action> 
+      <action type="update" dev="ggregory"             due-to="Gary Gregory">[test] Bump commons.bytebuddy.version from 1.17.6 to 1.17.7 #769.</action>
+      <!-- REMOVE -->
+      <action type="remove" dev="pkarwasz"             due-to="Piotr P. Karwasz">Inline private constant field ProxyInputStream.exceptionHandler #780.</action>
   </release>
     <release version="2.20.0" date="2025-07-13" description="Version 2.20.0: Java 8 or later is required.">
       <!-- FIX -->

src/main/java/org/apache/commons/io/IOUtils.java

@@ -2030,11 +2030,11 @@ public static void readFully(final InputStream input, final byte[] buffer, final
      * @throws IllegalArgumentException if length is negative.
      * @throws EOFException             if the number of bytes read was incorrect.
      * @since 2.5
+     * @deprecated Use {@link #toByteArray(InputStream, int)}.
      */
+    @Deprecated
     public static byte[] readFully(final InputStream input, final int length) throws IOException {
-        final byte[] buffer = byteArray(length);
-        readFully(input, buffer, 0, buffer.length);
-        return buffer;
+        return toByteArray(input, length);
     }
 
     /**

src/main/java/org/apache/commons/io/input/BoundedInputStream.java

@@ -73,12 +73,12 @@
  *   .get();
  * }
  * </pre>
- * <h2>Listening for the max count reached</h2>
+ * <h2>Listening for the maximum count reached</h2>
  * <pre>{@code
  * BoundedInputStream s = BoundedInputStream.builder()
  *   .setPath(Paths.get("MyFile.xml"))
  *   .setMaxCount(1024)
- *   .setOnMaxCount((max, count) -> System.out.printf("Max count %,d reached with a last read count of %,d%n", max, count))
+ *   .setOnMaxCount((max, count) -> System.out.printf("Maximum count %,d reached with a last read count of %,d%n", max, count))
  *   .get();
  * }
  * </pre>
@@ -98,7 +98,7 @@ abstract static class AbstractBuilder<T extends AbstractBuilder<T>> extends Prox
         /** The current count of bytes counted. */
         private long count;
 
-        /** The max count of bytes to read. */
+        /** The maximum count of bytes to read. */
         private long maxCount = EOF;
 
         private IOBiConsumer<Long, Long> onMaxCount = IOBiConsumer.noop();
@@ -156,7 +156,8 @@ public T setMaxCount(final long maxCount) {
         /**
          * Sets the default {@link BoundedInputStream#onMaxLength(long, long)} behavior, {@code null} resets to a NOOP.
          * <p>
-         * The first Long is the max count of bytes to read. The second Long is the count of bytes read.
+         * The first Long is the number of bytes remaining to read before the maximum is reached count of bytes to read. The second Long is the count of bytes
+         * read.
          * </p>
          * <p>
          * This does <em>not</em> override a {@code BoundedInputStream} subclass' implementation of the {@link BoundedInputStream#onMaxLength(long, long)}
@@ -299,7 +300,7 @@ public static Builder builder() {
     /** The current mark. */
     private long mark;
 
-    /** The max count of bytes to read. */
+    /** The maximum count of bytes to read. */
     private final long maxCount;
 
     private final IOBiConsumer<Long, Long> onMaxCount;
@@ -350,15 +351,15 @@ public BoundedInputStream(final InputStream in) {
      */
     @Deprecated
     public BoundedInputStream(final InputStream inputStream, final long maxCount) {
-        // Some badly designed methods - e.g. the Servlet API - overload length
+        // Some badly designed methods, for example the Servlet API, overload length
         // such that "-1" means stream finished
         this(inputStream, builder().setMaxCount(maxCount));
     }
 
     /**
      * Adds the number of read bytes to the count.
      *
-     * @param n number of bytes read, or -1 if no more bytes are available
+     * @param n number of bytes read, or -1 if no more bytes are available.
      * @throws IOException Not thrown here but subclasses may throw.
      * @since 2.0
      */
@@ -370,16 +371,11 @@ protected synchronized void afterRead(final int n) throws IOException {
         super.afterRead(n);
     }
 
-    /**
-     * {@inheritDoc}
-     */
     @Override
     public int available() throws IOException {
-        if (isMaxCount()) {
-            onMaxLength(maxCount, getCount());
-            return 0;
-        }
-        return in.available();
+        // Safe cast: value is between 0 and Integer.MAX_VALUE
+        final int remaining = (int) Math.min(getRemaining(), Integer.MAX_VALUE);
+        return Math.min(super.available(), remaining);
     }
 
     /**
@@ -405,19 +401,19 @@ public synchronized long getCount() {
     }
 
     /**
-     * Gets the max count of bytes to read.
+     * Gets the maximum number of bytes to read.
      *
-     * @return The max count of bytes to read.
+     * @return The maximum number of bytes to read, or {@value IOUtils#EOF} if unbounded.
      * @since 2.16.0
      */
     public long getMaxCount() {
         return maxCount;
     }
 
     /**
-     * Gets the max count of bytes to read.
+     * Gets the maximum count of bytes to read.
      *
-     * @return The max count of bytes to read.
+     * @return The maximum count of bytes to read.
      * @since 2.12.0
      * @deprecated Use {@link #getMaxCount()}.
      */
@@ -427,13 +423,21 @@ public long getMaxLength() {
     }
 
     /**
-     * Gets how many bytes remain to read.
+     * Gets the number of bytes remaining to read before the maximum is reached.
+     *
+     * <p>
+     * This method does <strong>not</strong> report the bytes available in the
+     * underlying stream; it only reflects the remaining allowance imposed by this
+     * {@code BoundedInputStream}.
+     * </p>
      *
-     * @return bytes how many bytes remain to read.
+     * @return The number of bytes remaining to read before the maximum is reached,
+     *         or {@link Long#MAX_VALUE} if no bound is set.
      * @since 2.16.0
      */
     public long getRemaining() {
-        return Math.max(0, getMaxCount() - getCount());
+        final long maxCount = getMaxCount();
+        return maxCount == EOF ? Long.MAX_VALUE : Math.max(0, maxCount - getCount());
     }
 
     private boolean isMaxCount() {
@@ -452,7 +456,7 @@ public boolean isPropagateClose() {
     /**
      * Invokes the delegate's {@link InputStream#mark(int)} method.
      *
-     * @param readLimit read ahead limit
+     * @param readLimit read ahead limit.
      */
     @Override
     public synchronized void mark(final int readLimit) {
@@ -463,7 +467,7 @@ public synchronized void mark(final int readLimit) {
     /**
      * Invokes the delegate's {@link InputStream#markSupported()} method.
      *
-     * @return true if mark is supported, otherwise false
+     * @return true if mark is supported, otherwise false.
      */
     @Override
     public boolean markSupported() {
@@ -476,7 +480,7 @@ public boolean markSupported() {
      * Delegates to the consumer set in {@link Builder#setOnMaxCount(IOBiConsumer)}.
      * </p>
      *
-     * @param max The max count of bytes to read.
+     * @param max The maximum count of bytes to read.
      * @param count     The count of bytes read.
      * @throws IOException Subclasses may throw.
      * @since 2.12.0
@@ -505,7 +509,7 @@ public int read() throws IOException {
     /**
      * Invokes the delegate's {@link InputStream#read(byte[])} method.
      *
-     * @param b the buffer to read the bytes into
+     * @param b the buffer to read the bytes into.
      * @return the number of bytes read or -1 if the end of stream or the limit has been reached.
      * @throws IOException if an I/O error occurs.
      */
@@ -517,9 +521,9 @@ public int read(final byte[] b) throws IOException {
     /**
      * Invokes the delegate's {@link InputStream#read(byte[], int, int)} method.
      *
-     * @param b   the buffer to read the bytes into
-     * @param off The start offset
-     * @param len The number of bytes to read
+     * @param b   the buffer to read the bytes into.
+     * @param off The start offset.
+     * @param len The number of bytes to read.
      * @return the number of bytes read or -1 if the end of stream or the limit has been reached.
      * @throws IOException if an I/O error occurs.
      */
@@ -558,8 +562,8 @@ public synchronized void setPropagateClose(final boolean propagateClose) {
     /**
      * Invokes the delegate's {@link InputStream#skip(long)} method.
      *
-     * @param n the number of bytes to skip
-     * @return the actual number of bytes skipped
+     * @param n the number of bytes to skip.
+     * @return the actual number of bytes skipped.
      * @throws IOException if an I/O error occurs.
      */
     @Override
@@ -576,7 +580,7 @@ private long toReadLen(final long len) {
     /**
      * Invokes the delegate's {@link InputStream#toString()} method.
      *
-     * @return the delegate's {@link InputStream#toString()}
+     * @return the delegate's {@link InputStream#toString()}.
      */
     @Override
     public String toString() {

src/main/java/org/apache/commons/io/input/ProxyInputStream.java

@@ -24,8 +24,6 @@
 
 import org.apache.commons.io.IOUtils;
 import org.apache.commons.io.build.AbstractStreamBuilder;
-import org.apache.commons.io.function.Erase;
-import org.apache.commons.io.function.IOConsumer;
 import org.apache.commons.io.function.IOIntConsumer;
 
 /**
@@ -102,11 +100,6 @@ public B setAfterRead(final IOIntConsumer afterRead) {
      */
     private volatile boolean closed;
 
-    /**
-     * Handles exceptions.
-     */
-    private final IOConsumer<IOException> exceptionHandler;
-
     private final IOIntConsumer afterRead;
 
     /**
@@ -130,7 +123,6 @@ protected ProxyInputStream(final AbstractBuilder<?, ?> builder) throws IOExcepti
     public ProxyInputStream(final InputStream proxy) {
         // the delegate is stored in a protected superclass variable named 'in'.
         super(proxy);
-        this.exceptionHandler = Erase::rethrow;
         this.afterRead = IOIntConsumer.NOOP;
     }
 
@@ -144,7 +136,6 @@ public ProxyInputStream(final InputStream proxy) {
     protected ProxyInputStream(final InputStream proxy, final AbstractBuilder<?, ?> builder) {
         // the delegate is stored in a protected superclass instance variable named 'in'.
         super(proxy);
-        this.exceptionHandler = Erase::rethrow;
         this.afterRead = builder.getAfterRead() != null ? builder.getAfterRead() : IOIntConsumer.NOOP;
     }
 
@@ -245,7 +236,7 @@ public void close() throws IOException {
      * @since 2.0
      */
     protected void handleIOException(final IOException e) throws IOException {
-        exceptionHandler.accept(e);
+        throw e;
     }
 
     /**