Merge branch '3.2.x'

Closes gh-40379

Author: philwebb

spring-boot-project/spring-boot-tools/spring-boot-loader/src/main/java/org/springframework/boot/loader/zip/FileChannelDataBlock.java renamed to spring-boot-project/spring-boot-tools/spring-boot-loader/src/main/java/org/springframework/boot/loader/zip/FileDataBlock.java

@@ -1,5 +1,5 @@
 /*
- * Copyright 2012-2023 the original author or authors.
+ * Copyright 2012-2024 the original author or authors.
  *
  * Licensed under the Apache License, Version 2.0 (the "License");
  * you may not use this file except in compliance with the License.
@@ -16,7 +16,9 @@
 
 package org.springframework.boot.loader.zip;
 
+import java.io.File;
 import java.io.IOException;
+import java.io.RandomAccessFile;
 import java.nio.ByteBuffer;
 import java.nio.channels.ClosedByInterruptException;
 import java.nio.channels.ClosedChannelException;
@@ -29,31 +31,31 @@
 import org.springframework.boot.loader.log.DebugLogger;
 
 /**
- * Reference counted {@link DataBlock} implementation backed by a {@link FileChannel} with
+ * Reference counted {@link DataBlock} implementation backed by a {@link File} with
  * support for slicing.
  *
  * @author Phillip Webb
  */
-class FileChannelDataBlock implements CloseableDataBlock {
+class FileDataBlock implements CloseableDataBlock {
 
-	private static final DebugLogger debug = DebugLogger.get(FileChannelDataBlock.class);
+	private static final DebugLogger debug = DebugLogger.get(FileDataBlock.class);
 
-	static Tracker tracker;
+	static Tracker tracker = Tracker.NONE;
 
-	private final ManagedFileChannel channel;
+	private final FileAccess fileAccess;
 
 	private final long offset;
 
 	private final long size;
 
-	FileChannelDataBlock(Path path) throws IOException {
-		this.channel = new ManagedFileChannel(path);
+	FileDataBlock(Path path) throws IOException {
+		this.fileAccess = new FileAccess(path);
 		this.offset = 0;
 		this.size = Files.size(path);
 	}
 
-	FileChannelDataBlock(ManagedFileChannel channel, long offset, long size) {
-		this.channel = channel;
+	FileDataBlock(FileAccess fileAccess, long offset, long size) {
+		this.fileAccess = fileAccess;
 		this.offset = offset;
 		this.size = size;
 	}
@@ -78,7 +80,7 @@ public int read(ByteBuffer dst, long pos) throws IOException {
 			originalDestinationLimit = dst.limit();
 			dst.limit(dst.position() + remaining);
 		}
-		int result = this.channel.read(dst, this.offset + pos);
+		int result = this.fileAccess.read(dst, this.offset + pos);
 		if (originalDestinationLimit != -1) {
 			dst.limit(originalDestinationLimit);
 		}
@@ -91,7 +93,7 @@ public int read(ByteBuffer dst, long pos) throws IOException {
 	 * @throws IOException on I/O error
 	 */
 	void open() throws IOException {
-		this.channel.open();
+		this.fileAccess.open();
 	}
 
 	/**
@@ -101,7 +103,7 @@ void open() throws IOException {
 	 */
 	@Override
 	public void close() throws IOException {
-		this.channel.close();
+		this.fileAccess.close();
 	}
 
 	/**
@@ -111,30 +113,30 @@ public void close() throws IOException {
 	 * @throws E if the channel is closed
 	 */
 	<E extends Exception> void ensureOpen(Supplier<E> exceptionSupplier) throws E {
-		this.channel.ensureOpen(exceptionSupplier);
+		this.fileAccess.ensureOpen(exceptionSupplier);
 	}
 
 	/**
-	 * Return a new {@link FileChannelDataBlock} slice providing access to a subset of the
-	 * data. The caller is responsible for calling {@link #open()} and {@link #close()} on
-	 * the returned block.
+	 * Return a new {@link FileDataBlock} slice providing access to a subset of the data.
+	 * The caller is responsible for calling {@link #open()} and {@link #close()} on the
+	 * returned block.
 	 * @param offset the start offset for the slice relative to this block
-	 * @return a new {@link FileChannelDataBlock} instance
+	 * @return a new {@link FileDataBlock} instance
 	 * @throws IOException on I/O error
 	 */
-	FileChannelDataBlock slice(long offset) throws IOException {
+	FileDataBlock slice(long offset) throws IOException {
 		return slice(offset, this.size - offset);
 	}
 
 	/**
-	 * Return a new {@link FileChannelDataBlock} slice providing access to a subset of the
-	 * data. The caller is responsible for calling {@link #open()} and {@link #close()} on
-	 * the returned block.
+	 * Return a new {@link FileDataBlock} slice providing access to a subset of the data.
+	 * The caller is responsible for calling {@link #open()} and {@link #close()} on the
+	 * returned block.
 	 * @param offset the start offset for the slice relative to this block
 	 * @param size the size of the new slice
-	 * @return a new {@link FileChannelDataBlock} instance
+	 * @return a new {@link FileDataBlock} instance
 	 */
-	FileChannelDataBlock slice(long offset, long size) {
+	FileDataBlock slice(long offset, long size) {
 		if (offset == 0 && size == this.size) {
 			return this;
 		}
@@ -144,14 +146,14 @@ FileChannelDataBlock slice(long offset, long size) {
 		if (size < 0 || offset + size > this.size) {
 			throw new IllegalArgumentException("Size must not be negative and must be within bounds");
 		}
-		debug.log("Slicing %s at %s with size %s", this.channel, offset, size);
-		return new FileChannelDataBlock(this.channel, this.offset + offset, size);
+		debug.log("Slicing %s at %s with size %s", this.fileAccess, offset, size);
+		return new FileDataBlock(this.fileAccess, this.offset + offset, size);
 	}
 
 	/**
 	 * Manages access to underlying {@link FileChannel}.
 	 */
-	static class ManagedFileChannel {
+	static class FileAccess {
 
 		static final int BUFFER_SIZE = 1024 * 10;
 
@@ -161,6 +163,10 @@ static class ManagedFileChannel {
 
 		private FileChannel fileChannel;
 
+		private boolean fileChannelInterrupted;
+
+		private RandomAccessFile randomAccessFile;
+
 		private ByteBuffer buffer;
 
 		private long bufferPosition = -1;
@@ -169,7 +175,7 @@ static class ManagedFileChannel {
 
 		private final Object lock = new Object();
 
-		ManagedFileChannel(Path path) {
+		FileAccess(Path path) {
 			if (!Files.isRegularFile(path)) {
 				throw new IllegalArgumentException(path + " must be a regular file");
 			}
@@ -193,34 +199,45 @@ int read(ByteBuffer dst, long position) throws IOException {
 		}
 
 		private void fillBuffer(long position) throws IOException {
-			for (int i = 0; i < 10; i++) {
-				boolean interrupted = (i != 0) ? Thread.interrupted() : false;
-				try {
-					this.buffer.clear();
-					this.bufferSize = this.fileChannel.read(this.buffer, position);
-					this.bufferPosition = position;
-					return;
-				}
-				catch (ClosedByInterruptException ex) {
+			if (Thread.currentThread().isInterrupted()) {
+				fillBufferUsingRandomAccessFile(position);
+				return;
+			}
+			try {
+				if (this.fileChannelInterrupted) {
 					repairFileChannel();
+					this.fileChannelInterrupted = false;
 				}
-				finally {
-					if (interrupted) {
-						Thread.currentThread().interrupt();
-					}
-				}
+				this.buffer.clear();
+				this.bufferSize = this.fileChannel.read(this.buffer, position);
+				this.bufferPosition = position;
+			}
+			catch (ClosedByInterruptException ex) {
+				this.fileChannelInterrupted = true;
+				fillBufferUsingRandomAccessFile(position);
 			}
-			throw new ClosedByInterruptException();
 		}
 
-		private void repairFileChannel() throws IOException {
-			if (tracker != null) {
-				tracker.closedFileChannel(this.path, this.fileChannel);
+		private void fillBufferUsingRandomAccessFile(long position) throws IOException {
+			if (this.randomAccessFile == null) {
+				this.randomAccessFile = new RandomAccessFile(this.path.toFile(), "r");
+				tracker.openedFileChannel(this.path);
 			}
-			this.fileChannel = FileChannel.open(this.path, StandardOpenOption.READ);
-			if (tracker != null) {
-				tracker.openedFileChannel(this.path, this.fileChannel);
+			byte[] bytes = new byte[BUFFER_SIZE];
+			this.randomAccessFile.seek(position);
+			int len = this.randomAccessFile.read(bytes);
+			this.buffer.clear();
+			if (len > 0) {
+				this.buffer.put(bytes, 0, len);
 			}
+			this.bufferSize = len;
+			this.bufferPosition = position;
+		}
+
+		private void repairFileChannel() throws IOException {
+			tracker.closedFileChannel(this.path);
+			this.fileChannel = FileChannel.open(this.path, StandardOpenOption.READ);
+			tracker.openedFileChannel(this.path);
 		}
 
 		void open() throws IOException {
@@ -229,9 +246,7 @@ void open() throws IOException {
 					debug.log("Opening '%s'", this.path);
 					this.fileChannel = FileChannel.open(this.path, StandardOpenOption.READ);
 					this.buffer = ByteBuffer.allocateDirect(BUFFER_SIZE);
-					if (tracker != null) {
-						tracker.openedFileChannel(this.path, this.fileChannel);
-					}
+					tracker.openedFileChannel(this.path);
 				}
 				this.referenceCount++;
 				debug.log("Reference count for '%s' incremented to %s", this.path, this.referenceCount);
@@ -250,18 +265,21 @@ void close() throws IOException {
 					this.bufferPosition = -1;
 					this.bufferSize = 0;
 					this.fileChannel.close();
-					if (tracker != null) {
-						tracker.closedFileChannel(this.path, this.fileChannel);
-					}
+					tracker.closedFileChannel(this.path);
 					this.fileChannel = null;
+					if (this.randomAccessFile != null) {
+						this.randomAccessFile.close();
+						tracker.closedFileChannel(this.path);
+						this.randomAccessFile = null;
+					}
 				}
 				debug.log("Reference count for '%s' decremented to %s", this.path, this.referenceCount);
 			}
 		}
 
 		<E extends Exception> void ensureOpen(Supplier<E> exceptionSupplier) throws E {
 			synchronized (this.lock) {
-				if (this.referenceCount == 0 || !this.fileChannel.isOpen()) {
+				if (this.referenceCount == 0) {
 					throw exceptionSupplier.get();
 				}
 			}
@@ -279,9 +297,21 @@ public String toString() {
 	 */
 	interface Tracker {
 
-		void openedFileChannel(Path path, FileChannel fileChannel);
+		Tracker NONE = new Tracker() {
+
+			@Override
+			public void openedFileChannel(Path path) {
+			}
+
+			@Override
+			public void closedFileChannel(Path path) {
+			}
+
+		};
+
+		void openedFileChannel(Path path);
 
-		void closedFileChannel(Path path, FileChannel fileChannel);
+		void closedFileChannel(Path path);
 
 	}
 

spring-boot-project/spring-boot-tools/spring-boot-loader/src/main/java/org/springframework/boot/loader/zip/ZipContent.java

@@ -74,7 +74,7 @@ public final class ZipContent implements Closeable {
 
 	private final Kind kind;
 
-	private final FileChannelDataBlock data;
+	private final FileDataBlock data;
 
 	private final long centralDirectoryPos;
 
@@ -96,7 +96,7 @@ public final class ZipContent implements Closeable {
 
 	private SoftReference<Map<Class<?>, Object>> info;
 
-	private ZipContent(Source source, Kind kind, FileChannelDataBlock data, long centralDirectoryPos, long commentPos,
+	private ZipContent(Source source, Kind kind, FileDataBlock data, long centralDirectoryPos, long commentPos,
 			long commentLength, int[] lookupIndexes, int[] nameHashLookups, int[] relativeCentralDirectoryOffsetLookups,
 			NameOffsetLookups nameOffsetLookups, boolean hasJarSignatureFile) {
 		this.source = source;
@@ -449,7 +449,7 @@ private static final class Loader {
 
 		private final Source source;
 
-		private final FileChannelDataBlock data;
+		private final FileDataBlock data;
 
 		private final long centralDirectoryPos;
 
@@ -463,8 +463,7 @@ private static final class Loader {
 
 		private int cursor;
 
-		private Loader(Source source, Entry directoryEntry, FileChannelDataBlock data, long centralDirectoryPos,
-				int maxSize) {
+		private Loader(Source source, Entry directoryEntry, FileDataBlock data, long centralDirectoryPos, int maxSize) {
 			this.source = source;
 			this.data = data;
 			this.centralDirectoryPos = centralDirectoryPos;
@@ -561,7 +560,7 @@ static ZipContent load(Source source) throws IOException {
 
 		private static ZipContent loadNonNested(Source source) throws IOException {
 			debug.log("Loading non-nested zip '%s'", source.path());
-			return openAndLoad(source, Kind.ZIP, new FileChannelDataBlock(source.path()));
+			return openAndLoad(source, Kind.ZIP, new FileDataBlock(source.path()));
 		}
 
 		private static ZipContent loadNestedZip(Source source, Entry entry) throws IOException {
@@ -573,7 +572,7 @@ private static ZipContent loadNestedZip(Source source, Entry entry) throws IOExc
 			return openAndLoad(source, Kind.NESTED_ZIP, entry.getContent());
 		}
 
-		private static ZipContent openAndLoad(Source source, Kind kind, FileChannelDataBlock data) throws IOException {
+		private static ZipContent openAndLoad(Source source, Kind kind, FileDataBlock data) throws IOException {
 			try {
 				data.open();
 				return loadContent(source, kind, data);
@@ -584,7 +583,7 @@ private static ZipContent openAndLoad(Source source, Kind kind, FileChannelDataB
 			}
 		}
 
-		private static ZipContent loadContent(Source source, Kind kind, FileChannelDataBlock data) throws IOException {
+		private static ZipContent loadContent(Source source, Kind kind, FileDataBlock data) throws IOException {
 			ZipEndOfCentralDirectoryRecord.Located locatedEocd = ZipEndOfCentralDirectoryRecord.load(data);
 			ZipEndOfCentralDirectoryRecord eocd = locatedEocd.endOfCentralDirectoryRecord();
 			long eocdPos = locatedEocd.pos();
@@ -634,7 +633,7 @@ private static ZipContent loadContent(Source source, Kind kind, FileChannelDataB
 		 * @return the offset within the data where the archive begins
 		 * @throws IOException on I/O error
 		 */
-		private static long getStartOfZipContent(FileChannelDataBlock data, ZipEndOfCentralDirectoryRecord eocd,
+		private static long getStartOfZipContent(FileDataBlock data, ZipEndOfCentralDirectoryRecord eocd,
 				Zip64EndOfCentralDirectoryRecord zip64Eocd) throws IOException {
 			long specifiedOffsetToStartOfCentralDirectory = (zip64Eocd != null)
 					? zip64Eocd.offsetToStartOfCentralDirectory() : eocd.offsetToStartOfCentralDirectory();
@@ -699,7 +698,7 @@ public class Entry {
 
 		private volatile String name;
 
-		private volatile FileChannelDataBlock content;
+		private volatile FileDataBlock content;
 
 		/**
 		 * Create a new {@link Entry} instance.
@@ -789,13 +788,13 @@ public int getUncompressedSize() {
 		 * @throws IOException on I/O error
 		 */
 		public CloseableDataBlock openContent() throws IOException {
-			FileChannelDataBlock content = getContent();
+			FileDataBlock content = getContent();
 			content.open();
 			return content;
 		}
 
-		private FileChannelDataBlock getContent() throws IOException {
-			FileChannelDataBlock content = this.content;
+		private FileDataBlock getContent() throws IOException {
+			FileDataBlock content = this.content;
 			if (content == null) {
 				int pos = this.centralRecord.offsetToLocalHeader();
 				checkNotZip64Extended(pos);