Switch to byte buffers

Author: xxDark

src/main/java/software/coley/llzip/ZipCompressions.java

@@ -4,6 +4,7 @@
 import software.coley.llzip.strategy.DeflateDecompressor;
 
 import java.io.IOException;
+import java.nio.ByteBuffer;
 
 /**
  * Constants for {@link LocalFileHeader#getCompressionMethod()}.
@@ -202,7 +203,7 @@ static String getName(int method) {
 	 * @throws IOException
 	 * 		When the decompression failed.
 	 */
-	static byte[] decompress(LocalFileHeader header) throws IOException {
+	static ByteBuffer decompress(LocalFileHeader header) throws IOException {
 		int method = header.getCompressionMethod();
 		switch (method) {
 			case STRORED:

src/main/java/software/coley/llzip/ZipIO.java

@@ -4,14 +4,36 @@
 import software.coley.llzip.strategy.JvmZipReaderStrategy;
 import software.coley.llzip.strategy.ZipReaderStrategy;
 
+import java.io.FileNotFoundException;
 import java.io.IOException;
+import java.nio.ByteBuffer;
+import java.nio.ByteOrder;
+import java.nio.channels.FileChannel;
+import java.nio.file.Files;
+import java.nio.file.Path;
+import java.nio.file.StandardOpenOption;
 
 /**
  * IO wrappers for reading {@link ZipArchive} contents.
  *
  * @author Matt Coley
  */
 public class ZipIO {
+	/**
+	 * Creates an archive using the {@link DefaultZipReaderStrategy}.
+	 *
+	 * @param data
+	 * 		Zip bytes.
+	 *
+	 * @return Archive from bytes.
+	 *
+	 * @throws IOException
+	 * 		When the archive bytes cannot be read from, usually indicating a malformed zip.
+	 */
+	public static ZipArchive readStandard(ByteBuffer data) throws IOException {
+		return read(data, new DefaultZipReaderStrategy());
+	}
+
 	/**
 	 * Creates an archive using the {@link DefaultZipReaderStrategy}.
 	 *
@@ -26,6 +48,36 @@ public class ZipIO {
 	public static ZipArchive readStandard(byte[] data) throws IOException {
 		return read(data, new DefaultZipReaderStrategy());
 	}
+	/**
+	 * Creates an archive using the {@link DefaultZipReaderStrategy}.
+	 *
+	 * @param data
+	 * 		Zip path.
+	 *
+	 * @return Archive from bytes.
+	 *
+	 * @throws IOException
+	 * 		When the archive bytes cannot be read from, usually indicating a malformed zip.
+	 */
+	public static ZipArchive readStandard(Path data) throws IOException {
+		return read(data, new DefaultZipReaderStrategy());
+	}
+
+	/**
+	 * Creates an archive using the {@link JvmZipReaderStrategy} which handles some edge cases not usually
+	 * expected from zip files.
+	 *
+	 * @param data
+	 * 		Zip bytes.
+	 *
+	 * @return Archive from bytes.
+	 *
+	 * @throws IOException
+	 * 		When the archive bytes cannot be read from, usually indicating a malformed zip.
+	 */
+	public static ZipArchive readJvm(ByteBuffer data) throws IOException {
+		return read(data, new JvmZipReaderStrategy());
+	}
 
 	/**
 	 * Creates an archive using the {@link JvmZipReaderStrategy} which handles some edge cases not usually
@@ -43,6 +95,22 @@ public static ZipArchive readJvm(byte[] data) throws IOException {
 		return read(data, new JvmZipReaderStrategy());
 	}
 
+	/**
+	 * Creates an archive using the {@link JvmZipReaderStrategy} which handles some edge cases not usually
+	 * expected from zip files.
+	 *
+	 * @param path
+	 * 		Zip path.
+	 *
+	 * @return Archive from bytes.
+	 *
+	 * @throws IOException
+	 * 		When the archive bytes cannot be read from, usually indicating a malformed zip.
+	 */
+	public static ZipArchive readJvm(Path path) throws IOException {
+		return read(path, new JvmZipReaderStrategy());
+	}
+
 	/**
 	 * @param data
 	 * 		Zip bytes.
@@ -54,15 +122,55 @@ public static ZipArchive readJvm(byte[] data) throws IOException {
 	 * @throws IOException
 	 * 		When the archive bytes cannot be read from, usually indicating a malformed zip.
 	 */
-	public static ZipArchive read(byte[] data, ZipReaderStrategy strategy) throws IOException {
+	public static ZipArchive read(ByteBuffer data, ZipReaderStrategy strategy) throws IOException {
 		if (data == null)
 			throw new IOException("Data is null!");
 		// The fixed size elements of a CDFH is 22 bytes (plus the variable size bits which can be 0)
-		if (data.length < 22)
+		if (data.remaining() < 22)
 			throw new IOException("Not enough bytes to read Central-Directory-File-Header, minimum=22");
 		// Create instance
 		ZipArchive zip = new ZipArchive();
 		strategy.read(zip, data);
 		return zip;
 	}
+
+	/**
+	 * @param data
+	 * 		Zip bytes.
+	 * @param strategy
+	 * 		Zip reader implementation.
+	 *
+	 * @return Archive from bytes.
+	 *
+	 * @throws IOException
+	 * 		When the archive bytes cannot be read from, usually indicating a malformed zip.
+	 */
+	public static ZipArchive read(byte[] data, ZipReaderStrategy strategy) throws IOException {
+		if (data == null)
+			throw new IOException("Data is null!");
+		return read(ByteBuffer.wrap(data).order(ByteOrder.LITTLE_ENDIAN), strategy);
+	}
+
+	/**
+	 * @param path
+	 * 		Zip path.
+	 * @param strategy
+	 * 		Zip reader implementation.
+	 *
+	 * @return Archive from bytes.
+	 *
+	 * @throws IOException
+	 * 		When the archive bytes cannot be read from, usually indicating a malformed zip.
+	 */
+	public static ZipArchive read(Path path, ZipReaderStrategy strategy) throws IOException {
+		if (path == null)
+			throw new IOException("Data is null!");
+		if (!Files.isRegularFile(path))
+			throw new FileNotFoundException(path.toString());
+		ByteBuffer buffer;
+		try (FileChannel fc = FileChannel.open(path, StandardOpenOption.READ)) {
+			buffer = fc.map(FileChannel.MapMode.READ_ONLY, 0L, fc.size());
+		}
+		return read(buffer.order(ByteOrder.LITTLE_ENDIAN), strategy);
+	}
 }

src/main/java/software/coley/llzip/ZipPatterns.java

@@ -3,10 +3,10 @@
 import software.coley.llzip.part.CentralDirectoryFileHeader;
 import software.coley.llzip.part.EndOfCentralDirectory;
 import software.coley.llzip.part.LocalFileHeader;
-import software.coley.llzip.util.Array;
+import software.coley.llzip.util.Buffers;
 
 /**
- * Patterns for usage in {@link Array} methods.
+ * Patterns for usage in {@link Buffers} methods.
  *
  * @author Matt Coley
  */

src/main/java/software/coley/llzip/part/CentralDirectoryFileHeader.java

@@ -2,9 +2,9 @@
 
 import software.coley.llzip.ZipCompressions;
 import software.coley.llzip.strategy.Decompressor;
-import software.coley.llzip.util.Array;
+import software.coley.llzip.util.Buffers;
 
-import java.util.Arrays;
+import java.nio.ByteBuffer;
 import java.util.Objects;
 
 /**
@@ -32,37 +32,40 @@ public class CentralDirectoryFileHeader implements ZipPart, ZipRead {
 	private int internalFileAttributes;
 	private int externalFileAttributes;
 	private int relativeOffsetOfLocalHeader;
-	private String fileName;
-	private byte[] extraField;
-	private String fileComment;
+	private ByteBuffer fileName;
+	private ByteBuffer extraField;
+	private ByteBuffer fileComment;
+
+	private transient String fileNameCache;
+	private transient String fileCommentCache;
 
 	@Override
-	public void read(byte[] data, int offset) {
+	public void read(ByteBuffer data, int offset) {
 		this.offset = offset;
-		versionMadeBy = Array.readWord(data, offset + 4);
-		versionNeededToExtract = Array.readWord(data, offset + 6);
-		generalPurposeBitFlag = Array.readWord(data, offset + 8);
-		compressionMethod = Array.readWord(data, offset + 10);
-		lastModFileTime = Array.readWord(data, offset + 12);
-		lastModFileDate = Array.readWord(data, offset + 14);
-		crc32 = Array.readQuad(data, offset + 16);
-		compressedSize = Array.readQuad(data, offset + 20);
-		uncompressedSize = Array.readQuad(data, offset + 24);
-		fileNameLength = Array.readWord(data, offset + 28);
-		extraFieldLength = Array.readWord(data, offset + 30);
-		fileCommentLength = Array.readWord(data, offset + 32);
-		diskNumberStart = Array.readWord(data, offset + 34);
-		internalFileAttributes = Array.readWord(data, offset + 36);
-		externalFileAttributes = Array.readQuad(data, offset + 38);
-		relativeOffsetOfLocalHeader = Array.readQuad(data, offset + 42);
-		fileName = Array.readString(data, offset + 46, fileNameLength);
-		extraField = Array.readArray(data, offset + 46 + fileNameLength, extraFieldLength);
-		fileComment = Array.readString(data, offset + 46 + fileNameLength + extraFieldLength, fileCommentLength);
+		versionMadeBy = Buffers.readWord(data, offset + 4);
+		versionNeededToExtract = Buffers.readWord(data, offset + 6);
+		generalPurposeBitFlag = Buffers.readWord(data, offset + 8);
+		compressionMethod = Buffers.readWord(data, offset + 10);
+		lastModFileTime = Buffers.readWord(data, offset + 12);
+		lastModFileDate = Buffers.readWord(data, offset + 14);
+		crc32 = Buffers.readQuad(data, offset + 16);
+		compressedSize = Buffers.readQuad(data, offset + 20);
+		uncompressedSize = Buffers.readQuad(data, offset + 24);
+		fileNameLength = Buffers.readWord(data, offset + 28);
+		extraFieldLength = Buffers.readWord(data, offset + 30);
+		fileCommentLength = Buffers.readWord(data, offset + 32);
+		diskNumberStart = Buffers.readWord(data, offset + 34);
+		internalFileAttributes = Buffers.readWord(data, offset + 36);
+		externalFileAttributes = Buffers.readQuad(data, offset + 38);
+		relativeOffsetOfLocalHeader = Buffers.readQuad(data, offset + 42);
+		fileName = Buffers.slice(data, offset + 46, fileNameLength);
+		extraField = Buffers.slice(data, offset + 46 + fileNameLength, extraFieldLength);
+		fileComment = Buffers.slice(data, offset + 46 + fileNameLength + extraFieldLength, fileCommentLength);
 	}
 
 	@Override
 	public int length() {
-		return 46 + fileName.length() + extraField.length + fileComment.length();
+		return 46 + Buffers.length(fileName) + Buffers.length(extraField) + Buffers.length(fileComment);
 	}
 
 	@Override
@@ -363,49 +366,74 @@ public void setRelativeOffsetOfLocalHeader(int relativeOffsetOfLocalHeader) {
 	 *
 	 * @return File name.
 	 */
-	public String getFileName() {
+	public ByteBuffer getFileName() {
 		return fileName;
 	}
 
 	/**
 	 * @param fileName
 	 * 		File name.
 	 */
-	public void setFileName(String fileName) {
+	public void setFileName(ByteBuffer fileName) {
 		this.fileName = fileName;
 	}
 
+	/**
+	 * Should match {@link CentralDirectoryFileHeader#getFileName()} but is not a strict requirement.
+	 * If they do not match, the central directory file name should be trusted instead.
+	 *
+	 * @return File name.
+	 */
+	public String getFileNameAsString() {
+		String fileNameCache = this.fileNameCache;
+		if (fileNameCache == null) {
+			return this.fileNameCache = Buffers.toString(fileName);
+		}
+		return fileNameCache;
+	}
+
 	/**
 	 * @return May be used for extra compression information,
 	 * depending on the {@link #getCompressionMethod() compression method} used.
 	 */
-	public byte[] getExtraField() {
+	public ByteBuffer getExtraField() {
 		return extraField;
 	}
 
 	/**
 	 * @param extraField
 	 * 		Extra field bytes.
 	 */
-	public void setExtraField(byte[] extraField) {
+	public void setExtraField(ByteBuffer extraField) {
 		this.extraField = extraField;
 	}
 
 	/**
 	 * @return File comment.
 	 */
-	public String getFileComment() {
+	public ByteBuffer getFileComment() {
 		return fileComment;
 	}
 
 	/**
 	 * @param fileComment
 	 * 		File comment.
 	 */
-	public void setFileComment(String fileComment) {
+	public void setFileComment(ByteBuffer fileComment) {
 		this.fileComment = fileComment;
 	}
 
+	/**
+	 * @return File comment.
+	 */
+	public String getFileCommentAsString() {
+		String fileCommentCache = this.fileCommentCache;
+		if (fileCommentCache == null) {
+			return this.fileCommentCache = Buffers.toString(fileComment);
+		}
+		return fileCommentCache;
+	}
+
 	@Override
 	public String toString() {
 		return "CentralDirectoryFileHeader{" +
@@ -426,7 +454,7 @@ public String toString() {
 				", externalFileAttributes=" + externalFileAttributes +
 				", relativeOffsetOfLocalHeader=" + relativeOffsetOfLocalHeader +
 				", fileName='" + fileName + '\'' +
-				", extraField=" + Arrays.toString(extraField) +
+				", extraField=" + Buffers.toString(extraField) +
 				", fileComment='" + fileComment + '\'' +
 				'}';
 	}
@@ -455,7 +483,7 @@ public boolean equals(Object o) {
 				relativeOffsetOfLocalHeader == that.relativeOffsetOfLocalHeader &&
 				Objects.equals(linkedFileHeader, that.linkedFileHeader) &&
 				fileName.equals(that.fileName) &&
-				Arrays.equals(extraField, that.extraField) &&
+				Buffers.equals(extraField, that.extraField) &&
 				fileComment.equals(that.fileComment);
 	}
 
@@ -465,7 +493,7 @@ public int hashCode() {
 				compressionMethod, lastModFileTime, lastModFileDate, crc32, compressedSize, uncompressedSize,
 				fileNameLength, extraFieldLength, fileCommentLength, diskNumberStart, internalFileAttributes,
 				externalFileAttributes, relativeOffsetOfLocalHeader, fileName, fileComment);
-		result = 31 * result + Arrays.hashCode(extraField);
+		result = 31 * result + extraField.hashCode();
 		return result;
 	}
 }