fix: report the container creation date

rdeltour · rdeltour · commit d28e20f209f6 · 2024-12-23T11:20:38.000+01:00
Fix #1532
diff --git a/src/main/java/com/adobe/epubcheck/ocf/OCFChecker.java b/src/main/java/com/adobe/epubcheck/ocf/OCFChecker.java
@@ -250,16 +250,6 @@ private boolean checkContainerFile(OCFCheckerState state)
       }
       return false;
     }
-    // FIXME 2022 - report container info
-    // long l = container.getTimeEntry(OCFData.containerEntry);
-    // if (l > 0)
-    // {
-    // Date d = new Date(l);
-    // String formattedDate = new
-    // SimpleDateFormat("yyyy-MM-dd'T'HH:mm:ss'Z'").format(d);
-    // report.info(OCFData.containerEntry, FeatureEnum.CREATION_DATE,
-    // formattedDate);
-    // }
 
     ValidationContext containerFileContext = state.context()
         .url(OCFMetaFile.CONTAINER.asURL(container)).mimetype("application/xml").build();
@@ -559,9 +549,14 @@ private void reportFeatures(OCFResource resource)
   {
     for (FeatureEnum feature : resource.getProperties().keySet())
     {
-      // report.info(context.path, feature,
-      // resource.getProperties().get(feature));
-      report.info(resource.getPath(), feature, resource.getProperties().get(feature));
+      if (feature == FeatureEnum.CREATION_DATE
+          && !OCFMetaFile.CONTAINER.asPath().equals(resource.getPath()))
+      {
+        // we only report the creation date once
+        continue;
+      }
+      report.info(resource.getPath(), feature,
+          resource.getProperties().get(feature));
     }
   }
 
diff --git a/src/main/java/com/adobe/epubcheck/ocf/OCFZipResources.java b/src/main/java/com/adobe/epubcheck/ocf/OCFZipResources.java
@@ -5,6 +5,8 @@
 import java.io.InputStream;
 import java.nio.charset.StandardCharsets;
 import java.security.MessageDigest;
+import java.text.SimpleDateFormat;
+import java.util.Date;
 import java.util.Enumeration;
 import java.util.Iterator;
 import java.util.Map;
@@ -48,11 +50,14 @@ public OCFResource next()
         throws NoSuchElementException
       {
         final ZipEntry entry = entries.nextElement();
+
         final Map<FeatureEnum, String> properties = ImmutableMap.<FeatureEnum, String> builder()
             .put(FeatureEnum.SIZE, String.valueOf(entry.getSize()))
             .put(FeatureEnum.COMPRESSED_SIZE, String.valueOf(entry.getCompressedSize()))
             .put(FeatureEnum.COMPRESSION_METHOD, getCompressionMethod(entry))
             .put(FeatureEnum.SHA_256, getSHAHash(entry, zip))
+            .put(FeatureEnum.CREATION_DATE,
+                new SimpleDateFormat("yyyy-MM-dd'T'HH:mm:ss'Z'").format(new Date(entry.getTime())))
             .build();
 
         return new OCFResource()
@@ -87,7 +92,7 @@ public String getPath()
           {
             return entry.getName();
           }
-          
+
           @Override
           public String toString()
           {
diff --git a/src/test/resources/reporting/xml-report.feature b/src/test/resources/reporting/xml-report.feature
@@ -14,3 +14,8 @@
     Then the XML report is well-formed
     And XPath '//repInfo' exists
 
+  Scenario: Creation date is set
+    When checking EPUB 'minimal'
+    And XPath '//repInfo/created' exists
+
+

Original file line number	Diff line number	Diff line change
`@@ -250,16 +250,6 @@ private boolean checkContainerFile(OCFCheckerState state)`
`250`	`250`	`}`
`251`	`251`	`return false;`
`252`	`252`	`}`
`253`		`- // FIXME 2022 - report container info`
`254`		`- // long l = container.getTimeEntry(OCFData.containerEntry);`
`255`		`- // if (l > 0)`
`256`		`- // {`
`257`		`- // Date d = new Date(l);`
`258`		`- // String formattedDate = new`
`259`		`- // SimpleDateFormat("yyyy-MM-dd'T'HH:mm:ss'Z'").format(d);`
`260`		`- // report.info(OCFData.containerEntry, FeatureEnum.CREATION_DATE,`
`261`		`- // formattedDate);`
`262`		`- // }`
`263`	`253`
`264`	`254`	`ValidationContext containerFileContext = state.context()`
`265`	`255`	`.url(OCFMetaFile.CONTAINER.asURL(container)).mimetype("application/xml").build();`
`@@ -559,9 +549,14 @@ private void reportFeatures(OCFResource resource)`
`559`	`549`	`{`
`560`	`550`	`for (FeatureEnum feature : resource.getProperties().keySet())`
`561`	`551`	`{`
`562`		`- // report.info(context.path, feature,`
`563`		`- // resource.getProperties().get(feature));`
`564`		`- report.info(resource.getPath(), feature, resource.getProperties().get(feature));`
	`552`	`+ if (feature == FeatureEnum.CREATION_DATE`
	`553`	`+ && !OCFMetaFile.CONTAINER.asPath().equals(resource.getPath()))`
	`554`	`+ {`
	`555`	`+ // we only report the creation date once`
	`556`	`+ continue;`
	`557`	`+ }`
	`558`	`+ report.info(resource.getPath(), feature,`
	`559`	`+ resource.getProperties().get(feature));`
`565`	`560`	`}`
`566`	`561`	`}`
`567`	`562`