Replace Jazzlib with Zip4j for zip file handling

asm0dey · asm0dey · commit 93c15b325099 · 2024-12-03T19:27:40.000+01:00
This commit updates the codebase to utilize Zip4j instead of Jazzlib for handling zip files, enhancing functionality and reliability. It includes changes in dependency addition and modifications across several files to adapt to the new library, ensuring compatibility and fixing related test expectations.
diff --git a/epub4j-core/build.gradle.kts b/epub4j-core/build.gradle.kts
@@ -12,6 +12,7 @@ plugins {
 dependencies {
   implementation("net.sf.kxml:kxml2:2.3.0")
   implementation("xmlpull:xmlpull:1.1.3.4d_b4_min")
+  implementation("net.lingala.zip4j:zip4j:2.11.5")
 }
 
 gversion {
diff --git a/epub4j-core/src/main/java/io/documentnode/epub4j/epub/EpubReader.java b/epub4j-core/src/main/java/io/documentnode/epub4j/epub/EpubReader.java
@@ -13,8 +13,9 @@
 import java.io.InputStream;
 import java.util.Arrays;
 import java.util.List;
-import net.sf.jazzlib.ZipFile;
-import net.sf.jazzlib.ZipInputStream;
+
+import net.lingala.zip4j.ZipFile;
+import net.lingala.zip4j.io.inputstream.ZipInputStream;
 import org.w3c.dom.Document;
 import org.w3c.dom.Element;
 
diff --git a/epub4j-core/src/main/java/io/documentnode/epub4j/epub/ResourcesLoader.java b/epub4j-core/src/main/java/io/documentnode/epub4j/epub/ResourcesLoader.java
@@ -1,30 +1,23 @@
 package io.documentnode.epub4j.epub;
 
-import io.documentnode.epub4j.domain.EpubResourceProvider;
-import io.documentnode.epub4j.domain.LazyResource;
-import io.documentnode.epub4j.domain.LazyResourceProvider;
-import io.documentnode.epub4j.domain.MediaType;
-import io.documentnode.epub4j.domain.MediaTypes;
-import io.documentnode.epub4j.domain.Resource;
-import io.documentnode.epub4j.domain.Resources;
+import io.documentnode.epub4j.domain.*;
 import io.documentnode.epub4j.util.CollectionUtil;
 import io.documentnode.epub4j.util.ResourceUtil;
 import io.documentnode.minilog.Logger;
+import net.lingala.zip4j.ZipFile;
+import net.lingala.zip4j.io.inputstream.ZipInputStream;
+import net.lingala.zip4j.model.FileHeader;
+import net.lingala.zip4j.model.LocalFileHeader;
+
 import java.io.IOException;
 import java.util.Collection;
 import java.util.Collections;
-import java.util.Enumeration;
 import java.util.List;
-import net.sf.jazzlib.ZipEntry;
-import net.sf.jazzlib.ZipException;
-import net.sf.jazzlib.ZipFile;
-import net.sf.jazzlib.ZipInputStream;
 
 /**
  * Loads Resources from inputStreams, ZipFiles, etc
  *
  * @author paul
- *
  */
 public class ResourcesLoader {
 
@@ -48,24 +41,23 @@ public static Resources loadResources(ZipFile zipFile,
       List<MediaType> lazyLoadedTypes) throws IOException {
 
     LazyResourceProvider resourceProvider =
-        new EpubResourceProvider(zipFile.getName());
+        new EpubResourceProvider(zipFile.getFile().getAbsolutePath());
 
     Resources result = new Resources();
-    Enumeration<? extends ZipEntry> entries = zipFile.entries();
+    var entries = zipFile.getFileHeaders();
 
-    while (entries.hasMoreElements()) {
-      ZipEntry zipEntry = entries.nextElement();
+    for (FileHeader zipEntry : entries) {
 
       if (zipEntry == null || zipEntry.isDirectory()) {
         continue;
       }
 
-      String href = zipEntry.getName();
+      String href = zipEntry.getFileName();
 
       Resource resource;
 
       if (shouldLoadLazy(href, lazyLoadedTypes)) {
-        resource = new LazyResource(resourceProvider, zipEntry.getSize(), href);
+        resource = new LazyResource(resourceProvider, zipEntry.getUncompressedSize(), href);
       } else {
         resource = ResourceUtil
             .createResource(zipEntry, zipFile.getInputStream(zipEntry));
@@ -113,7 +105,7 @@ private static boolean shouldLoadLazy(String href,
   public static Resources loadResources(ZipInputStream zipInputStream,
       String defaultHtmlEncoding) throws IOException {
     Resources result = new Resources();
-    ZipEntry zipEntry;
+    LocalFileHeader zipEntry;
     do {
       // get next valid zipEntry
       zipEntry = getNextZipEntry(zipInputStream);
@@ -133,19 +125,16 @@ public static Resources loadResources(ZipInputStream zipInputStream,
   }
 
 
-  private static ZipEntry getNextZipEntry(ZipInputStream zipInputStream)
+  private static LocalFileHeader getNextZipEntry(ZipInputStream zipInputStream)
       throws IOException {
     try {
-      return zipInputStream.getNextEntry();
-    } catch (ZipException e) {
+      LocalFileHeader nextEntry = zipInputStream.getNextEntry();
+      return nextEntry;
+    } catch (IOException e) {
       //see <a href="https://github.com/psiegman/epublib/issues/122">Issue #122 Infinite loop</a>.
       //when reading a file that is not a real zip archive or a zero length file, zipInputStream.getNextEntry()
       //throws an exception and does not advance, so loadResources enters an infinite loop
       log.error("Invalid or damaged zip file.", e);
-      try {
-        zipInputStream.closeEntry();
-      } catch (Exception ignored) {
-      }
       throw e;
     }
   }
diff --git a/epub4j-core/src/main/java/io/documentnode/epub4j/util/ResourceUtil.java b/epub4j-core/src/main/java/io/documentnode/epub4j/util/ResourceUtil.java
@@ -2,23 +2,20 @@
 
 import io.documentnode.epub4j.Constants;
 import io.documentnode.epub4j.domain.MediaType;
+import io.documentnode.epub4j.domain.MediaTypes;
 import io.documentnode.epub4j.domain.Resource;
 import io.documentnode.epub4j.epub.EpubProcessorSupport;
-import io.documentnode.epub4j.domain.MediaTypes;
-import java.io.File;
-import java.io.FileInputStream;
-import java.io.IOException;
-import java.io.InputStream;
-import java.io.Reader;
-import java.io.UnsupportedEncodingException;
-import javax.xml.parsers.DocumentBuilder;
-import javax.xml.parsers.ParserConfigurationException;
-import net.sf.jazzlib.ZipEntry;
-import net.sf.jazzlib.ZipInputStream;
+import net.lingala.zip4j.io.inputstream.ZipInputStream;
+import net.lingala.zip4j.model.FileHeader;
+import net.lingala.zip4j.model.LocalFileHeader;
 import org.w3c.dom.Document;
 import org.xml.sax.InputSource;
 import org.xml.sax.SAXException;
 
+import javax.xml.parsers.DocumentBuilder;
+import javax.xml.parsers.ParserConfigurationException;
+import java.io.*;
+
 /**
  * Various resource utility methods
  *
@@ -60,15 +57,14 @@ public static Resource createResource(String title, String href) {
    * @return a resource created out of the given zipEntry and zipInputStream.
    * @throws IOException
    */
-  public static Resource createResource(ZipEntry zipEntry,
-      ZipInputStream zipInputStream) throws IOException {
-    return new Resource(zipInputStream, zipEntry.getName());
+  public static Resource createResource(LocalFileHeader zipEntry,
+                                        ZipInputStream zipInputStream) throws IOException {
+    return new Resource(zipInputStream, zipEntry.getFileName());
 
   }
-
-  public static Resource createResource(ZipEntry zipEntry,
-      InputStream zipInputStream) throws IOException {
-    return new Resource(zipInputStream, zipEntry.getName());
+  public static Resource createResource(FileHeader zipEntry,
+                                        ZipInputStream zipInputStream) throws IOException {
+    return new Resource(zipInputStream, zipEntry.getFileName());
 
   }
 
diff --git a/epub4j-core/src/test/java/io/documentnode/epub4j/epub/ResourcesLoaderTest.java b/epub4j-core/src/test/java/io/documentnode/epub4j/epub/ResourcesLoaderTest.java
@@ -1,9 +1,6 @@
 package io.documentnode.epub4j.epub;
 
-import io.documentnode.epub4j.domain.LazyResource;
-import io.documentnode.epub4j.domain.Resource;
-import io.documentnode.epub4j.domain.Resources;
-import io.documentnode.epub4j.domain.MediaTypes;
+import io.documentnode.epub4j.domain.*;
 import io.documentnode.epub4j.util.IOUtil;
 import java.io.File;
 import java.io.FileInputStream;
@@ -14,9 +11,9 @@
 import java.util.Arrays;
 import java.util.Collections;
 import java.util.List;
-import net.sf.jazzlib.ZipException;
-import net.sf.jazzlib.ZipFile;
-import net.sf.jazzlib.ZipInputStream;
+
+import net.lingala.zip4j.ZipFile;
+import net.lingala.zip4j.io.inputstream.ZipInputStream;
 import org.junit.AfterClass;
 import org.junit.Assert;
 import org.junit.BeforeClass;
@@ -66,7 +63,7 @@ public void testLoadResources_ZipInputStream() throws IOException {
    * Loads the Resources from a zero length file, using ZipInputStream<br/>
    * See <a href="https://github.com/psiegman/epublib/issues/122">Issue #122 Infinite loop</a>.
    */
-  @Test(expected = ZipException.class)
+  @Test(expected = IOException.class)
   public void testLoadResources_ZipInputStream_WithZeroLengthFile()
       throws IOException {
     // given
@@ -81,15 +78,16 @@ public void testLoadResources_ZipInputStream_WithZeroLengthFile()
    * Loads the Resources from a file that is not a valid zip, using ZipInputStream<br/>
    * See <a href="https://github.com/psiegman/epublib/issues/122">Issue #122 Infinite loop</a>.
    */
-  @Test(expected = ZipException.class)
+  @Test(expected = IOException.class)
   public void testLoadResources_ZipInputStream_WithInvalidFile()
       throws IOException {
     // given
     ZipInputStream zipInputStream = new ZipInputStream(
         this.getClass().getResourceAsStream("/not_a_zip.epub"));
 
     // when
-    ResourcesLoader.loadResources(zipInputStream, encoding);
+    Resources resources = ResourcesLoader.loadResources(zipInputStream, encoding);
+    resources.getAll().forEach(System.out::println);
   }
 
   /**
@@ -148,7 +146,7 @@ public void testLoadResources_ZipFile_partial_lazy() throws IOException {
     Assert
         .assertEquals(Resource.class, resources.getById("chapter1").getClass());
   }
-
+  
   private void verifyResources(Resources resources) throws IOException {
     Assert.assertNotNull(resources);
     Assert.assertEquals(12, resources.getAll().size());

Original file line number	Diff line number	Diff line change
`@@ -12,6 +12,7 @@ plugins {`
`12`	`12`	`dependencies {`
`13`	`13`	`implementation("net.sf.kxml:kxml2:2.3.0")`
`14`	`14`	`implementation("xmlpull:xmlpull:1.1.3.4d_b4_min")`
	`15`	`+ implementation("net.lingala.zip4j:zip4j:2.11.5")`
`15`	`16`	`}`
`16`	`17`
`17`	`18`	`gversion {`