Merge pull request #20 from Col-E/refactoring

Author: Col-E

README.md

@@ -50,4 +50,4 @@ implementation group: 'software.coley', name: 'lljzip', version: zipVersion
 implementation "software.coley:lljzip:${zipVersion}"
 ```
 
-For example usage see the [tests](src/test/java/software/coley/llzip).
+For example usage see the [tests](src/test/java/software/coley/lljzip).

pom.xml

@@ -6,7 +6,7 @@
 
     <groupId>software.coley</groupId>
     <artifactId>lljzip</artifactId>
-    <version>1.6.2</version>
+    <version>2.0.0</version>
 
     <name>LL Java ZIP</name>
     <description>Lower level ZIP support for Java</description>
@@ -41,6 +41,13 @@
             <artifactId>slf4j-api</artifactId>
             <version>1.7.36</version>
         </dependency>
+        <!-- https://mvnrepository.com/artifact/com.google.code.findbugs/jsr305 -->
+        <dependency>
+            <groupId>com.google.code.findbugs</groupId>
+            <artifactId>jsr305</artifactId>
+            <version>3.0.2</version>
+            <scope>compile</scope>
+        </dependency>
         <!-- https://mvnrepository.com/artifact/ch.qos.logback/logback-classic -->
         <dependency>
             <groupId>ch.qos.logback</groupId>

src/main/java/software/coley/llzip/ZipIO.java renamed to src/main/java/software/coley/lljzip/ZipIO.java

@@ -1,15 +1,15 @@
-package software.coley.llzip;
-
-import software.coley.llzip.format.model.CentralDirectoryFileHeader;
-import software.coley.llzip.format.model.EndOfCentralDirectory;
-import software.coley.llzip.format.model.ZipArchive;
-import software.coley.llzip.format.read.ForwardScanZipReaderStrategy;
-import software.coley.llzip.format.read.JvmZipReaderStrategy;
-import software.coley.llzip.format.read.NaiveLocalFileZipReaderStrategy;
-import software.coley.llzip.format.read.ZipReaderStrategy;
-import software.coley.llzip.util.BufferData;
-import software.coley.llzip.util.ByteData;
-import software.coley.llzip.util.FileMapUtil;
+package software.coley.lljzip;
+
+import software.coley.lljzip.format.model.CentralDirectoryFileHeader;
+import software.coley.lljzip.format.model.EndOfCentralDirectory;
+import software.coley.lljzip.format.model.ZipArchive;
+import software.coley.lljzip.format.read.ForwardScanZipReader;
+import software.coley.lljzip.format.read.JvmZipReader;
+import software.coley.lljzip.format.read.NaiveLocalFileZipReader;
+import software.coley.lljzip.format.read.ZipReader;
+import software.coley.lljzip.util.BufferData;
+import software.coley.lljzip.util.ByteData;
+import software.coley.lljzip.util.FileMapUtil;
 
 import java.io.FileNotFoundException;
 import java.io.IOException;
@@ -19,16 +19,17 @@
 /**
  * IO wrappers for reading {@link ZipArchive} contents.
  * <ul>
- *     <li>For JAR files or anything intended to be read by the JVM use the JVM operations which use {@link JvmZipReaderStrategy}.</li>
- *     <li>For regular ZIP files use {@link ForwardScanZipReaderStrategy}.</li>
- *     <li>For ZIP files without {@link CentralDirectoryFileHeader} or {@link EndOfCentralDirectory} items, use {@link NaiveLocalFileZipReaderStrategy}</li>
+ *     <li>For JAR files or anything intended to be read by the JVM use the JVM operations which use {@link JvmZipReader}.</li>
+ *     <li>For regular ZIP files use {@link ForwardScanZipReader}.</li>
+ *     <li>For ZIP files without {@link CentralDirectoryFileHeader} or {@link EndOfCentralDirectory} items, use {@link NaiveLocalFileZipReader}</li>
  * </ul>
+ * You can fully control zip parsing via {@link #read(ByteData, ZipReader)} by passing a customized reader implementation.
  *
  * @author Matt Coley
  */
 public class ZipIO {
 	/**
-	 * Creates an archive using the {@link ForwardScanZipReaderStrategy}.
+	 * Creates an archive using the {@link ForwardScanZipReader}.
 	 *
 	 * @param data
 	 * 		Zip bytes.
@@ -39,11 +40,11 @@ public class ZipIO {
 	 * 		When the archive bytes cannot be read from, usually indicating a malformed zip.
 	 */
 	public static ZipArchive readStandard(ByteData data) throws IOException {
-		return read(data, new ForwardScanZipReaderStrategy());
+		return read(data, new ForwardScanZipReader());
 	}
 
 	/**
-	 * Creates an archive using the {@link ForwardScanZipReaderStrategy}.
+	 * Creates an archive using the {@link ForwardScanZipReader}.
 	 *
 	 * @param data
 	 * 		Zip bytes.
@@ -54,11 +55,11 @@ public static ZipArchive readStandard(ByteData data) throws IOException {
 	 * 		When the archive bytes cannot be read from, usually indicating a malformed zip.
 	 */
 	public static ZipArchive readStandard(byte[] data) throws IOException {
-		return read(data, new ForwardScanZipReaderStrategy());
+		return read(data, new ForwardScanZipReader());
 	}
 
 	/**
-	 * Creates an archive using the {@link ForwardScanZipReaderStrategy}.
+	 * Creates an archive using the {@link ForwardScanZipReader}.
 	 *
 	 * @param data
 	 * 		Zip path.
@@ -69,11 +70,11 @@ public static ZipArchive readStandard(byte[] data) 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 ForwardScanZipReaderStrategy());
+		return read(data, new ForwardScanZipReader());
 	}
 
 	/**
-	 * Creates an archive using the {@link NaiveLocalFileZipReaderStrategy}.
+	 * Creates an archive using the {@link NaiveLocalFileZipReader}.
 	 *
 	 * @param data
 	 * 		Zip bytes.
@@ -84,11 +85,11 @@ public static ZipArchive readStandard(Path data) throws IOException {
 	 * 		When the archive bytes cannot be read from, usually indicating a malformed zip.
 	 */
 	public static ZipArchive readNaive(ByteData data) throws IOException {
-		return read(data, new NaiveLocalFileZipReaderStrategy());
+		return read(data, new NaiveLocalFileZipReader());
 	}
 
 	/**
-	 * Creates an archive using the {@link NaiveLocalFileZipReaderStrategy}.
+	 * Creates an archive using the {@link NaiveLocalFileZipReader}.
 	 *
 	 * @param data
 	 * 		Zip bytes.
@@ -99,11 +100,11 @@ public static ZipArchive readNaive(ByteData data) throws IOException {
 	 * 		When the archive bytes cannot be read from, usually indicating a malformed zip.
 	 */
 	public static ZipArchive readNaive(byte[] data) throws IOException {
-		return read(data, new NaiveLocalFileZipReaderStrategy());
+		return read(data, new NaiveLocalFileZipReader());
 	}
 
 	/**
-	 * Creates an archive using the {@link NaiveLocalFileZipReaderStrategy}.
+	 * Creates an archive using the {@link NaiveLocalFileZipReader}.
 	 *
 	 * @param data
 	 * 		Zip path.
@@ -114,11 +115,11 @@ public static ZipArchive readNaive(byte[] data) throws IOException {
 	 * 		When the archive bytes cannot be read from, usually indicating a malformed zip.
 	 */
 	public static ZipArchive readNaive(Path data) throws IOException {
-		return read(data, new NaiveLocalFileZipReaderStrategy());
+		return read(data, new NaiveLocalFileZipReader());
 	}
 
 	/**
-	 * Creates an archive using the {@link JvmZipReaderStrategy} which handles some edge cases not usually
+	 * Creates an archive using the {@link JvmZipReader} which handles some edge cases not usually
 	 * expected from zip files.
 	 *
 	 * @param data
@@ -130,11 +131,11 @@ public static ZipArchive readNaive(Path data) throws IOException {
 	 * 		When the archive bytes cannot be read from, usually indicating a malformed zip.
 	 */
 	public static ZipArchive readJvm(ByteData data) throws IOException {
-		return read(data, new JvmZipReaderStrategy());
+		return read(data, new JvmZipReader());
 	}
 
 	/**
-	 * Creates an archive using the {@link JvmZipReaderStrategy} which handles some edge cases not usually
+	 * Creates an archive using the {@link JvmZipReader} which handles some edge cases not usually
 	 * expected from zip files.
 	 *
 	 * @param data
@@ -146,11 +147,11 @@ public static ZipArchive readJvm(ByteData data) throws IOException {
 	 * 		When the archive bytes cannot be read from, usually indicating a malformed zip.
 	 */
 	public static ZipArchive readJvm(byte[] data) throws IOException {
-		return read(data, new JvmZipReaderStrategy());
+		return read(data, new JvmZipReader());
 	}
 
 	/**
-	 * Creates an archive using the {@link JvmZipReaderStrategy} which handles some edge cases not usually
+	 * Creates an archive using the {@link JvmZipReader} which handles some edge cases not usually
 	 * expected from zip files.
 	 *
 	 * @param path
@@ -162,7 +163,7 @@ public static ZipArchive readJvm(byte[] data) 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());
+		return read(path, new JvmZipReader());
 	}
 
 	/**
@@ -176,22 +177,15 @@ public static ZipArchive readJvm(Path path) throws IOException {
 	 * @throws IOException
 	 * 		When the archive bytes cannot be read from, usually indicating a malformed zip.
 	 */
-	public static ZipArchive read(ByteData data, ZipReaderStrategy strategy) throws IOException {
+	public static ZipArchive read(byte[] data, ZipReader 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)
-		// - Even if we only want to read local/central file entries, those are even larger at a minimum
-		if (data.length() < 22)
-			throw new IOException("Not enough bytes to read Central-Directory-File-Header, minimum=22");
-		// Create instance
-		ZipArchive zip = new ZipArchive(data);
-		strategy.read(zip, data);
-		return zip;
+		return read(BufferData.wrap(data), strategy);
 	}
 
 	/**
-	 * @param data
-	 * 		Zip bytes.
+	 * @param path
+	 * 		Zip path.
 	 * @param strategy
 	 * 		Zip reader implementation.
 	 *
@@ -200,15 +194,17 @@ public static ZipArchive read(ByteData data, ZipReaderStrategy strategy) throws
 	 * @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)
+	public static ZipArchive read(Path path, ZipReader strategy) throws IOException {
+		if (path == null)
 			throw new IOException("Data is null!");
-		return read(BufferData.wrap(data), strategy);
+		if (!Files.isRegularFile(path))
+			throw new FileNotFoundException(path.toString());
+		return read(FileMapUtil.map(path), strategy);
 	}
 
 	/**
-	 * @param path
-	 * 		Zip path.
+	 * @param data
+	 * 		Zip bytes.
 	 * @param strategy
 	 * 		Zip reader implementation.
 	 *
@@ -217,11 +213,18 @@ public static ZipArchive read(byte[] data, ZipReaderStrategy strategy) throws IO
 	 * @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)
+	public static ZipArchive read(ByteData data, ZipReader strategy) throws IOException {
+		if (data == null)
 			throw new IOException("Data is null!");
-		if (!Files.isRegularFile(path))
-			throw new FileNotFoundException(path.toString());
-		return read(FileMapUtil.map(path), strategy);
+
+		// The fixed size elements of a CDFH is 22 bytes (plus the variable size bits which can be 0)
+		// - Even if we only want to read local/central file entries, those are even larger at a minimum
+		if (data.length() < 22)
+			throw new IOException("Not enough bytes to read Central-Directory-File-Header, minimum=22");
+
+		// Create instance
+		ZipArchive zip = new ZipArchive(data);
+		strategy.read(zip, data);
+		return zip;
 	}
 }

src/main/java/software/coley/llzip/format/ZipPatterns.java renamed to src/main/java/software/coley/lljzip/format/ZipPatterns.java

@@ -1,9 +1,9 @@
-package software.coley.llzip.format;
+package software.coley.lljzip.format;
 
-import software.coley.llzip.format.model.CentralDirectoryFileHeader;
-import software.coley.llzip.format.model.EndOfCentralDirectory;
-import software.coley.llzip.format.model.LocalFileHeader;
-import software.coley.llzip.util.ByteDataUtil;
+import software.coley.lljzip.format.model.CentralDirectoryFileHeader;
+import software.coley.lljzip.format.model.EndOfCentralDirectory;
+import software.coley.lljzip.format.model.LocalFileHeader;
+import software.coley.lljzip.util.ByteDataUtil;
 
 /**
  * Patterns for usage in {@link ByteDataUtil} methods.
@@ -43,4 +43,12 @@ public interface ZipPatterns {
 	 * Header for {@link EndOfCentralDirectory}, as a {@code s4/quad/int}
 	 */
 	int END_OF_CENTRAL_DIRECTORY_QUAD = 0x06_05_4B_50;
+	/**
+	 * Optional header for the data descriptor section
+	 */
+	int[] DATA_DESCRIPTOR = {0x08, 0x07, 0x4b, 0x50};
+	/**
+	 * Optional header for the data descriptor section, as a {@code s4/quad/int}
+	 */
+	int DATA_DESCRIPTOR_QUAD = 0x08_07_4b_50;
 }

src/main/java/software/coley/llzip/format/compression/Decompressor.java renamed to src/main/java/software/coley/lljzip/format/compression/Decompressor.java

@@ -1,7 +1,7 @@
-package software.coley.llzip.format.compression;
+package software.coley.lljzip.format.compression;
 
-import software.coley.llzip.format.model.LocalFileHeader;
-import software.coley.llzip.util.ByteData;
+import software.coley.lljzip.format.model.LocalFileHeader;
+import software.coley.lljzip.util.ByteData;
 
 import java.io.IOException;
 

src/main/java/software/coley/llzip/format/compression/DeflateDecompressor.java renamed to src/main/java/software/coley/lljzip/format/compression/DeflateDecompressor.java

@@ -1,8 +1,8 @@
-package software.coley.llzip.format.compression;
+package software.coley.lljzip.format.compression;
 
-import software.coley.llzip.format.model.LocalFileHeader;
-import software.coley.llzip.util.ByteData;
-import software.coley.llzip.util.FastWrapOutputStream;
+import software.coley.lljzip.format.model.LocalFileHeader;
+import software.coley.lljzip.util.ByteData;
+import software.coley.lljzip.util.FastWrapOutputStream;
 
 import java.io.IOException;
 import java.util.zip.DataFormatException;
@@ -15,6 +15,12 @@
  * @author Matt Coley
  */
 public class DeflateDecompressor implements Decompressor {
+	public static final DeflateDecompressor INSTANCE = new DeflateDecompressor();
+
+	private DeflateDecompressor() {
+		// deny construction
+	}
+
 	@Override
 	public ByteData decompress(LocalFileHeader header, ByteData data) throws IOException {
 		if (header.getCompressionMethod() != ZipCompressions.DEFLATED)

src/main/java/software/coley/llzip/format/compression/DeflateEntry.java renamed to src/main/java/software/coley/lljzip/format/compression/DeflateEntry.java

@@ -1,6 +1,6 @@
-package software.coley.llzip.format.compression;
+package software.coley.lljzip.format.compression;
 
-import software.coley.llzip.util.InflaterHackery;
+import software.coley.lljzip.util.InflaterHackery;
 
 import java.util.zip.Inflater;