FIX - EPUB validation module based on W3C's EPUBCheck

README.md

@@ -363,6 +363,7 @@ The `jhove-ext-modules` contains JHOVE modules developed by external parties, sp
  * PNG
  * WARC
  * GZIP
+ * EPUB
 
 These are all packaged in a single modules JAR:
 

jhove-bbt/scripts/create-1.23-target.sh

@@ -47,13 +47,41 @@ showHelp() {
 # Execution starts here
 checkParams "$@";
 if [[ -d "${targetRoot}" ]]; then
+	echo " - removing existing baseline at ${targetRoot}."
 	rm -rf "${targetRoot}"
 fi
 
-echo "Executing baseline update"
-# Copying baseline for now we're not making any changes
+echo "TEST BASELINE: Creating baseline"
+# Simply copy baseline for now we're not making any changes
+echo " - copying ${baselineRoot} baseline to ${targetRoot}"
 cp -R "${baselineRoot}" "${targetRoot}"
 
+###
+# E-PUB Module Fixes
+###
+# These copies are all OK as they're new files and don't overwrite
+if [[ -f "${candidateRoot}/errors/modules/audit-EPUB-ptc.jhove.xml" ]]; then
+	echo "   - EPUB copying EPUB audit results"
+	cp "${candidateRoot}/errors/modules/audit-EPUB-ptc.jhove.xml" "${targetRoot}/errors/modules/audit-EPUB-ptc.jhove.xml"
+fi
+if [[ -d "${candidateRoot}/errors/modules/EPUB-ptc" ]]; then
+	echo "   - EPUB copying error test reults"
+	cp -R "${candidateRoot}/errors/modules/EPUB-ptc" "${targetRoot}/errors/modules"
+fi
+if [[ -f "${candidateRoot}/examples/modules/audit-EPUB-ptc.jhove.xml" ]]; then
+	echo "   - EPUB copying JHOVE audit results"
+	cp "${candidateRoot}/examples/modules/audit-EPUB-ptc.jhove.xml" "${targetRoot}/examples/modules/audit-EPUB-ptc.jhove.xml"
+fi
+if [[ -d "${candidateRoot}/examples/modules/EPUB-ptc" ]]; then
+	echo "   - EPUB copying examples test reults"
+	cp -R "${candidateRoot}/examples/modules/EPUB-ptc" "${targetRoot}/examples/modules"
+fi
+# Replace the text for XML Parser, EPub won't build without that version and JHOVE seems fine about it.
+echo "   - EPUB replacing XML parser text"
+sed -i 's%com.sun.org.apache.xerces.internal.jaxp.SAXParserImpl$JAXPSAXParser%org.apache.xerces.jaxp.SAXParserImpl$JAXPSAXParser%' "${targetRoot}/examples/modules/XML-hul/jhoveconf.xml.jhove.xml"
+# Add line for EPUB module to JHOVE audit file
+sed -i '14 a \ \ \ <module release="1.0">EPUB-ptc</module>' "${targetRoot}/audit.jhove.xml"
+
 # Copy AIFF files across for new AES metadata see https://github.com/openpreserve/jhove/pull/518
 if [[ -d "${candidateRoot}/examples/modules/AIFF-hul" ]]; then
 	echo "Copying valid AIFF examples."
@@ -72,21 +100,21 @@ fi
 
 # Copy valid JP2K files across for new MIX metadata see https://github.com/openpreserve/jhove/pull/445
 if [[ -d "${candidateRoot}/examples/modules/JPEG2000-hul" ]]; then
-	echo "Copying valid JPEG2000 examples."
+	echo "   - Copying valid JPEG2000 examples."
 	cp -Rf "${candidateRoot}/examples/modules/JPEG2000-hul" "${targetRoot}/examples/modules/"
 fi
 if [[ -d "${candidateRoot}/errors/modules/JPEG2000-hul" ]]; then
-	echo "Copying JPEG2000 errors."
+	echo "   - Copying JPEG2000 errors."
 	cp -Rf "${candidateRoot}/errors/modules/JPEG2000-hul" "${targetRoot}/errors/modules/"
 fi
 
 # Copy WAV files across for new MIX metadata see https://github.com/openpreserve/jhove/pull/445
 if [[ -d "${candidateRoot}/examples/modules/WAVE-hul" ]]; then
-	echo "Copying valid WAVE examples."
+	echo "   - Copying valid WAVE examples."
 	cp -Rf "${candidateRoot}/examples/modules/WAVE-hul" "${targetRoot}/examples/modules/"
 fi
 if [[ -d "${candidateRoot}/errors/modules/WAVE-hul" ]]; then
-	echo "Copying WAVE errors."
+	echo "   - Copying WAVE errors."
 	cp -Rf "${candidateRoot}/errors/modules/WAVE-hul" "${targetRoot}/errors/modules/"
 fi
 
@@ -102,27 +130,27 @@ fi
 
 # Copy TIIF across for new Message IDs https://github.com/openpreserve/jhove/pull/510
 if [[ -f "${candidateRoot}/examples/modules/TIFF-hul/chase-tif-f.tif.jhove.xml" ]]; then
-	echo "Copying affected TIFF examples."
+	echo "   - Copying affected TIFF examples."
 	cp -Rf "${candidateRoot}/examples/modules/TIFF-hul/chase-tif-f.tif.jhove.xml" "${targetRoot}/examples/modules/TIFF-hul/"
 fi
 if [[ -f "${candidateRoot}/examples/modules/TIFF-hul/g3test.g3.jhove.xml" ]]; then
-	echo "Copying affected TIFF examples."
+	echo "   - Copying affected TIFF examples."
 	cp -Rf "${candidateRoot}/examples/modules/TIFF-hul/g3test.g3.jhove.xml" "${targetRoot}/examples/modules/TIFF-hul/"
 fi
 if [[ -f "${candidateRoot}/examples/modules/TIFF-hul/smallliz.tif.jhove.xml" ]]; then
-	echo "Copying affected TIFF examples."
+	echo "   - Copying affected TIFF examples."
 	cp -Rf "${candidateRoot}/examples/modules/TIFF-hul/smallliz.tif.jhove.xml" "${targetRoot}/examples/modules/TIFF-hul/"
 fi
 if [[ -f "${candidateRoot}/examples/modules/TIFF-hul/peppers.tif.jhove.xml" ]]; then
-	echo "Copying affected TIFF examples."
+	echo "   - Copying affected TIFF examples."
 	cp -Rf "${candidateRoot}/examples/modules/TIFF-hul/peppers.tif.jhove.xml" "${targetRoot}/examples/modules/TIFF-hul/"
 fi
 if [[ -f "${candidateRoot}/examples/modules/TIFF-hul/zackthecat.tif.jhove.xml" ]]; then
-	echo "Copying affected TIFF examples."
+	echo "   - Copying affected TIFF examples."
 	cp -Rf "${candidateRoot}/examples/modules/TIFF-hul/zackthecat.tif.jhove.xml" "${targetRoot}/examples/modules/TIFF-hul/"
 fi
 if [[ -f "${candidateRoot}/examples/modules/TIFF-hul/fax2d.g3.jhove.xml" ]]; then
-	echo "Copying affected TIFF examples."
+	echo "   - Copying affected TIFF examples."
 	cp -Rf "${candidateRoot}/examples/modules/TIFF-hul/fax2d.g3.jhove.xml" "${targetRoot}/examples/modules/TIFF-hul/"
 fi
 if [[ -f "${candidateRoot}/examples/modules/TIFF-hul/quad-tile.tif.jhove.xml" ]]; then
@@ -150,7 +178,6 @@ if [[ -f "${candidateRoot}/examples/modules/PDF-hul/AA_Banner.pdf.jhove.xml" ]];
 	cp -Rf "${candidateRoot}/examples/modules/PDF-hul/AA_Banner.pdf.jhove.xml" "${targetRoot}/examples/modules/PDF-hul/"
 fi
 
-
 find "${targetRoot}" -type f -name "audit.jhove.xml" -exec sed -i 's/^   <module release="1.4.1">JPEG2000-hul<\/module>$/   <module release="1.4.2">JPEG2000-hul<\/module>/' {} \;
 find "${targetRoot}" -type f -name "audit.jhove.xml" -exec sed -i 's/^   <outputHandler release="1.8">XML/   <outputHandler release="1.9">XML/' {} \;
 find "${targetRoot}" -type f -name "audit-JPEG2000-hul.jhove.xml" -exec sed -i 's/^  <release>1.4.1<\/release>$/  <release>1.4.2<\/release>/' {} \;

jhove-bbt/scripts/exec-with-to.sh

@@ -73,7 +73,7 @@ fi
 
 # kill -0 pid   Exit code indicates if a signal may be sent to $pid process.
 (
-    ((t = timeout))
+    ((t = $timeout))
 
     while ((t > 0)); do
         sleep $interval

jhove-bbt/scripts/process-modules.sh

@@ -88,15 +88,17 @@ showHelp() {
 
 # Cycle through the test module directories and invoke the correct JHOVE module
 getCorpusModules() {
-  DIRS=$(ls -l "$paramModuleLoc" | grep -E '^d' | awk '{print $9}')
-  for DIR in $DIRS ; do
-		moduleName=${DIR}
+	for DIR in "$paramModuleLoc"/*/
+	do
+	  # https://stackoverflow.com/questions/1371261/get-current-directory-name-without-full-path-in-a-bash-script
+	  moduleName="${DIR%"${DIR##*[!/]}"}" # extglob-free multi-trailing-/ trim
+	  moduleName="${moduleName##*/}"      # remove everything before the last /
 		if [[ ! -e "$paramOutputRootDir/audit-$moduleName.jhove.xml" ]]
 		then
 			bash "$SCRIPT_DIR/exec-with-to.sh" -t 10 "$paramJhoveLoc/jhove" -m "${moduleName}" -h xml -o "$paramOutputRootDir/audit-$moduleName.jhove.xml"
 		fi
 		processModuleDir "$paramModuleLoc/$moduleName"
-  done
+	done
 }
 
 processModuleDir() {

jhove-bbt/scripts/travis-test.sh

@@ -50,6 +50,7 @@ if [[ -d "${tempInstallLoc}" ]]; then
 fi
 
 # Create the test target root if it doesn't exist
+[[ -d "${TARGET_ROOT}" ]] && rm -rf "${TARGET_ROOT:?}/"*
 [[ -d "${TARGET_ROOT}" ]] || mkdir -p "${TARGET_ROOT}"
 
 # Grab the Major and Minor versions from the full Maven project version string
@@ -70,6 +71,7 @@ installJhoveFromFile "${JHOVE_INSTALLER}" "${tempInstallLoc}"
 
 [[ -d "${CANDIDATE_ROOT}/${MAJOR_MINOR_VER}" ]] || mkdir -p "${CANDIDATE_ROOT}/${MAJOR_MINOR_VER}"
 
+cat "${tempInstallLoc}/jhove"
 echo ""
 echo "Testing ${MAJOR_MINOR_VER}."
 echo "=========================="

jhove-ext-modules/pom.xml

@@ -13,6 +13,7 @@
 
   <properties>
     <jwat.version>1.0.3</jwat.version>
+    <epubcheck.version>4.2.2</epubcheck.version>
   </properties>
 
   <build>
@@ -41,9 +42,15 @@
           </execution>
         </executions>
       </plugin>
+      <plugin>
+        <groupId>org.apache.maven.plugins</groupId>
+        <artifactId>maven-surefire-plugin</artifactId>
+        <configuration>
+            <argLine>-Xss1024k</argLine>
+        </configuration>
+      </plugin>
     </plugins>
   </build>
-
   <dependencies>
     <dependency>
       <groupId>org.openpreservation.jhove</groupId>
@@ -75,5 +82,11 @@
       <artifactId>jwat-warc</artifactId>
       <version>${jwat.version}</version>
     </dependency>
+    <!-- EPUBCheck for EPUB -->
+    <dependency>
+      <groupId>org.w3c</groupId>
+      <artifactId>epubcheck</artifactId>
+      <version>${epubcheck.version}</version>
+    </dependency>
   </dependencies>
 </project>