fix: properly set the rendition fields in the JSON report

See w3c#1515
sabilyfd · Jul 6, 2023 · da643e4 · da643e4
1 parent 39234a6
commit da643e4
Show file tree

Hide file tree

Showing 48 changed files with 620 additions and 17 deletions.
diff --git a/src/main/java/com/adobe/epubcheck/opf/OPFHandler30.java b/src/main/java/com/adobe/epubcheck/opf/OPFHandler30.java
@@ -62,6 +62,7 @@
 import com.adobe.epubcheck.api.QuietReport;
 import com.adobe.epubcheck.messages.LocalizedMessages;
 import com.adobe.epubcheck.messages.MessageId;
+import com.adobe.epubcheck.opf.MetadataSet.Metadata;
 import com.adobe.epubcheck.opf.ResourceCollection.Roles;
 import com.adobe.epubcheck.util.EpubConstants;
 import com.adobe.epubcheck.util.FeatureEnum;
@@ -96,7 +97,8 @@ public class OPFHandler30 extends OPFHandler
       .put(DCTERMS_PREFIX, DCTERMS_VOCAB).put(MARC_PREFIX, MARC_VOCAB).put(ONIX_PREFIX, ONIX_VOCAB)
       .put(SCHEMA_PREFIX, SCHEMA_VOCAB).put(XSD_PREFIX, XSD_VOCAB).build();
   private static final Map<String, Vocab> RESERVED_META_VOCABS = new ImmutableMap.Builder<String, Vocab>()
-      .put("", AggregateVocab.of(META_VOCAB, META_VOCAB_CAMEL)).put(AccessibilityVocab.PREFIX, AccessibilityVocab.META_VOCAB)
+      .put("", AggregateVocab.of(META_VOCAB, META_VOCAB_CAMEL))
+      .put(AccessibilityVocab.PREFIX, AccessibilityVocab.META_VOCAB)
       .put(MediaOverlaysVocab.PREFIX, MediaOverlaysVocab.VOCAB)
       .put(RenditionVocabs.PREFIX, RenditionVocabs.META_VOCAB).putAll(RESERVED_VOCABS).build();
   private static final Map<String, Vocab> RESERVED_ITEM_VOCABS = new ImmutableMap.Builder<String, Vocab>()
@@ -646,32 +648,72 @@ private void checkLanguageTag(String language)
 
   protected void reportMetadata()
   {
+    // Report publication rendition layout
     if (getMetadata().containsPrimary(
         RenditionVocabs.META_VOCAB.get(RenditionVocabs.META_PROPERTIES.LAYOUT), "pre-paginated"))
     {
-      report.info(null, FeatureEnum.HAS_FIXED_LAYOUT, "pre-paginated");
+      report.info(null, FeatureEnum.RENDITION_LAYOUT, "pre-paginated");
+      report.info(null, FeatureEnum.HAS_FIXED_LAYOUT, "true");
+    }
+    // Report publication rendition orientation (if set)
+    Optional<Metadata> orientation = MetadataSet.tryFind(getMetadata().getAll(),
+        RenditionVocabs.META_VOCAB.get(RenditionVocabs.META_PROPERTIES.ORIENTATION),
+        Optional.absent());
+    if (orientation.isPresent())
+    {
+      report.info(null, FeatureEnum.RENDITION_ORIENTATION, orientation.get().getValue());
+    }
+    // Report publication rendition spread (if set)
+    Optional<Metadata> spread = MetadataSet.tryFind(getMetadata().getAll(),
+        RenditionVocabs.META_VOCAB.get(RenditionVocabs.META_PROPERTIES.SPREAD),
+        Optional.absent());
+    if (spread.isPresent())
+    {
+      report.info(null, FeatureEnum.RENDITION_SPREAD, spread.get().getValue());
     }
   }
 
   @Override
   protected void reportItem(OPFItem item)
   {
     super.reportItem(item);
-    boolean isFixed = getMetadata().containsPrimary(
-        RenditionVocabs.META_VOCAB.get(RenditionVocabs.META_PROPERTIES.LAYOUT), "pre-paginated");
-    if (item.getProperties().contains(
-        RenditionVocabs.ITEMREF_VOCAB.get(RenditionVocabs.ITEMREF_PROPERTIES.LAYOUT_PRE_PAGINATED)))
-    {
-      isFixed = true;
-    }
-    else if (item.getProperties().contains(
-        RenditionVocabs.ITEMREF_VOCAB.get(RenditionVocabs.ITEMREF_PROPERTIES.LAYOUT_REFLOWABLE)))
-    {
-      isFixed = false;
-    }
-    if (isFixed)
+
+    // Report rendition properties overrides
+    Set<RenditionVocabs.ITEMREF_PROPERTIES> properties = Property.filter(item.getProperties(),
+        RenditionVocabs.ITEMREF_PROPERTIES.class);
+    for (RenditionVocabs.ITEMREF_PROPERTIES property : properties)
     {
-      report.info(item.getPath(), FeatureEnum.HAS_FIXED_LAYOUT, String.valueOf(true));
+      switch (property)
+      {
+      // Rendition layout properties
+      case LAYOUT_PRE_PAGINATED:
+        report.info(item.getPath(), FeatureEnum.RENDITION_LAYOUT, "pre-paginated");
+        report.info(item.getPath(), FeatureEnum.HAS_FIXED_LAYOUT, "true");
+        break;
+      case LAYOUT_REFLOWABLE:
+        report.info(item.getPath(), FeatureEnum.RENDITION_LAYOUT, "reflowable");
+        report.info(item.getPath(), FeatureEnum.HAS_FIXED_LAYOUT, "false");
+        break;
+      // Orientation properties
+      case ORIENTATION_AUTO:
+      case ORIENTATION_LANDSCAPE:
+      case ORIENTATION_PORTRAIT:
+        report.info(item.getPath(), FeatureEnum.RENDITION_ORIENTATION,
+            property.name().substring(12).toLowerCase(Locale.ROOT));
+        break;
+      // Spread properties
+      case SPREAD_AUTO:
+      case SPREAD_BOTH:
+      case SPREAD_LANDSCAPE:
+      case SPREAD_NONE:
+      case SPREAD_PORTRAIT:
+        report.info(item.getPath(), FeatureEnum.RENDITION_SPREAD,
+            property.name().substring(7).toLowerCase(Locale.ROOT));
+        break;
+
+      default:
+        break;
+      }
     }
   }
 }
diff --git a/src/test/resources/reporting/files/layout-orientation-item/EPUB/content_001.xhtml b/src/test/resources/reporting/files/layout-orientation-item/EPUB/content_001.xhtml
@@ -0,0 +1,12 @@
+<!DOCTYPE html>
+<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
+	<head>
+		<meta charset="utf-8"/>
+		<meta name="viewport" content="width=600,height=1200" />
+		<title>Minimal EPUB</title>
+	</head>
+	<body>
+		<h1>Loomings</h1>
+		<p>Call me Ishmael.</p>
+	</body>
+</html>
diff --git a/src/test/resources/reporting/files/layout-orientation-item/EPUB/content_002.xhtml b/src/test/resources/reporting/files/layout-orientation-item/EPUB/content_002.xhtml
@@ -0,0 +1,12 @@
+<!DOCTYPE html>
+<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
+	<head>
+		<meta charset="utf-8"/>
+		<meta name="viewport" content="width=600,height=1200" />
+		<title>Minimal EPUB</title>
+	</head>
+	<body>
+		<h1>Loomings</h1>
+		<p>Call me Ishmael.</p>
+	</body>
+</html>
diff --git a/src/test/resources/reporting/files/layout-orientation-item/EPUB/nav.xhtml b/src/test/resources/reporting/files/layout-orientation-item/EPUB/nav.xhtml
@@ -0,0 +1,14 @@
+<!DOCTYPE html>
+<html xmlns="http://www.w3.org/1999/xhtml" xmlns:epub="http://www.idpf.org/2007/ops" xml:lang="en" lang="en">
+	<head>
+		<meta charset="utf-8"/>
+		<title>Minimal Nav</title>
+	</head>
+	<body>
+		<nav epub:type="toc">
+			<ol>
+				<li><a href="content_001.xhtml">content 001</a></li>
+			</ol>
+		</nav>
+	</body>
+</html>
diff --git a/src/test/resources/reporting/files/layout-orientation-item/EPUB/package.opf b/src/test/resources/reporting/files/layout-orientation-item/EPUB/package.opf
@@ -0,0 +1,19 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<package xmlns="http://www.idpf.org/2007/opf" version="3.0" xml:lang="en" unique-identifier="q">
+<metadata xmlns:dc="http://purl.org/dc/elements/1.1/">
+  <dc:title id="title">Minimal EPUB 3.0</dc:title>
+  <dc:language>en</dc:language>
+  <dc:identifier id="q">NOID</dc:identifier>
+  <meta property="dcterms:modified">2017-06-14T00:00:01Z</meta>
+  <meta property="rendition:layout">pre-paginated</meta>
+</metadata>
+<manifest>
+  <item id="content_001"  href="content_001.xhtml" media-type="application/xhtml+xml"/>
+  <item id="content_002"  href="content_002.xhtml" media-type="application/xhtml+xml"/>
+  <item id="nav"  href="nav.xhtml" media-type="application/xhtml+xml" properties="nav"/>
+</manifest>
+<spine>
+  <itemref idref="content_001" />
+  <itemref idref="content_002" properties="rendition:orientation-landscape"/>
+</spine>
+</package>
diff --git a/src/test/resources/reporting/files/layout-orientation-item/META-INF/container.xml b/src/test/resources/reporting/files/layout-orientation-item/META-INF/container.xml
@@ -0,0 +1,6 @@
+<?xml version="1.0" encoding="UTF-8" ?>
+<container version="1.0" xmlns="urn:oasis:names:tc:opendocument:xmlns:container">
+	<rootfiles>
+		<rootfile full-path="EPUB/package.opf" media-type="application/oebps-package+xml"/>
+	</rootfiles>
+</container>
diff --git a/src/test/resources/reporting/files/layout-orientation-item/mimetype b/src/test/resources/reporting/files/layout-orientation-item/mimetype
@@ -0,0 +1 @@
+application/epub+zip
diff --git a/src/test/resources/reporting/files/layout-orientation/EPUB/content_001.xhtml b/src/test/resources/reporting/files/layout-orientation/EPUB/content_001.xhtml
@@ -0,0 +1,12 @@
+<!DOCTYPE html>
+<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
+	<head>
+		<meta charset="utf-8"/>
+		<meta name="viewport" content="width=600,height=1200" />
+		<title>Minimal EPUB</title>
+	</head>
+	<body>
+		<h1>Loomings</h1>
+		<p>Call me Ishmael.</p>
+	</body>
+</html>
diff --git a/src/test/resources/reporting/files/layout-orientation/EPUB/content_002.xhtml b/src/test/resources/reporting/files/layout-orientation/EPUB/content_002.xhtml
@@ -0,0 +1,12 @@
+<!DOCTYPE html>
+<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
+	<head>
+		<meta charset="utf-8"/>
+		<meta name="viewport" content="width=600,height=1200" />
+		<title>Minimal EPUB</title>
+	</head>
+	<body>
+		<h1>Loomings</h1>
+		<p>Call me Ishmael.</p>
+	</body>
+</html>
diff --git a/src/test/resources/reporting/files/layout-orientation/EPUB/nav.xhtml b/src/test/resources/reporting/files/layout-orientation/EPUB/nav.xhtml
@@ -0,0 +1,14 @@
+<!DOCTYPE html>
+<html xmlns="http://www.w3.org/1999/xhtml" xmlns:epub="http://www.idpf.org/2007/ops" xml:lang="en" lang="en">
+	<head>
+		<meta charset="utf-8"/>
+		<title>Minimal Nav</title>
+	</head>
+	<body>
+		<nav epub:type="toc">
+			<ol>
+				<li><a href="content_001.xhtml">content 001</a></li>
+			</ol>
+		</nav>
+	</body>
+</html>
diff --git a/src/test/resources/reporting/files/layout-orientation/EPUB/package.opf b/src/test/resources/reporting/files/layout-orientation/EPUB/package.opf
@@ -0,0 +1,20 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<package xmlns="http://www.idpf.org/2007/opf" version="3.0" xml:lang="en" unique-identifier="q">
+<metadata xmlns:dc="http://purl.org/dc/elements/1.1/">
+  <dc:title id="title">Minimal EPUB 3.0</dc:title>
+  <dc:language>en</dc:language>
+  <dc:identifier id="q">NOID</dc:identifier>
+  <meta property="dcterms:modified">2017-06-14T00:00:01Z</meta>
+  <meta property="rendition:layout">pre-paginated</meta>
+  <meta property="rendition:orientation">portrait</meta>
+</metadata>
+<manifest>
+  <item id="content_001"  href="content_001.xhtml" media-type="application/xhtml+xml"/>
+  <item id="content_002"  href="content_002.xhtml" media-type="application/xhtml+xml"/>
+  <item id="nav"  href="nav.xhtml" media-type="application/xhtml+xml" properties="nav"/>
+</manifest>
+<spine>
+  <itemref idref="content_001" />
+  <itemref idref="content_002" />
+</spine>
+</package>
diff --git a/src/test/resources/reporting/files/layout-orientation/META-INF/container.xml b/src/test/resources/reporting/files/layout-orientation/META-INF/container.xml
@@ -0,0 +1,6 @@
+<?xml version="1.0" encoding="UTF-8" ?>
+<container version="1.0" xmlns="urn:oasis:names:tc:opendocument:xmlns:container">
+	<rootfiles>
+		<rootfile full-path="EPUB/package.opf" media-type="application/oebps-package+xml"/>
+	</rootfiles>
+</container>
diff --git a/src/test/resources/reporting/files/layout-orientation/mimetype b/src/test/resources/reporting/files/layout-orientation/mimetype
@@ -0,0 +1 @@
+application/epub+zip
diff --git a/src/test/resources/reporting/files/layout-paginated-item/EPUB/content_001.xhtml b/src/test/resources/reporting/files/layout-paginated-item/EPUB/content_001.xhtml
@@ -0,0 +1,11 @@
+<!DOCTYPE html>
+<html xmlns:epub="http://www.idpf.org/2007/ops" xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
+	<head>
+		<meta charset="utf-8"/>
+		<title>Minimal EPUB</title>
+	</head>
+	<body>
+		<h1>Loomings</h1>
+		<p>Call me Ishmael.</p>
+	</body>
+</html>
diff --git a/src/test/resources/reporting/files/layout-paginated-item/EPUB/content_002.xhtml b/src/test/resources/reporting/files/layout-paginated-item/EPUB/content_002.xhtml
@@ -0,0 +1,12 @@
+<!DOCTYPE html>
+<html xmlns:epub="http://www.idpf.org/2007/ops" xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
+	<head>
+		<meta charset="utf-8"/>
+		<title>Minimal EPUB</title>
+		<meta name="viewport" content="width=600,height=1200" />
+	</head>
+	<body>
+		<h1>Loomings</h1>
+		<p>Call me Ishmael.</p>
+	</body>
+</html>
diff --git a/src/test/resources/reporting/files/layout-paginated-item/EPUB/nav.xhtml b/src/test/resources/reporting/files/layout-paginated-item/EPUB/nav.xhtml
@@ -0,0 +1,14 @@
+<!DOCTYPE html>
+<html xmlns="http://www.w3.org/1999/xhtml" xmlns:epub="http://www.idpf.org/2007/ops" xml:lang="en" lang="en">
+	<head>
+		<meta charset="utf-8"/>
+		<title>Minimal Nav</title>
+	</head>
+	<body>
+		<nav epub:type="toc">
+			<ol>
+				<li><a href="content_001.xhtml">content 001</a></li>
+			</ol>
+		</nav>
+	</body>
+</html>
diff --git a/src/test/resources/reporting/files/layout-paginated-item/EPUB/package.opf b/src/test/resources/reporting/files/layout-paginated-item/EPUB/package.opf
@@ -0,0 +1,18 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<package xmlns="http://www.idpf.org/2007/opf" version="3.0" xml:lang="en" unique-identifier="q">
+<metadata xmlns:dc="http://purl.org/dc/elements/1.1/">
+  <dc:title id="title">Minimal EPUB 3.0</dc:title>
+  <dc:language>en</dc:language>
+  <dc:identifier id="q">NOID</dc:identifier>
+  <meta property="dcterms:modified">2017-06-14T00:00:01Z</meta>
+</metadata>
+<manifest>
+  <item id="content_001"  href="content_001.xhtml" media-type="application/xhtml+xml"/>
+  <item id="content_002"  href="content_002.xhtml" media-type="application/xhtml+xml"/>
+  <item id="nav"  href="nav.xhtml" media-type="application/xhtml+xml" properties="nav"/>
+</manifest>
+<spine>
+  <itemref idref="content_001" />
+  <itemref idref="content_002" properties="rendition:layout-pre-paginated"/>
+</spine>
+</package>
diff --git a/src/test/resources/reporting/files/layout-paginated-item/META-INF/container.xml b/src/test/resources/reporting/files/layout-paginated-item/META-INF/container.xml
@@ -0,0 +1,6 @@
+<?xml version="1.0" encoding="UTF-8" ?>
+<container version="1.0" xmlns="urn:oasis:names:tc:opendocument:xmlns:container">
+	<rootfiles>
+		<rootfile full-path="EPUB/package.opf" media-type="application/oebps-package+xml"/>
+	</rootfiles>
+</container>
diff --git a/src/test/resources/reporting/files/layout-paginated-item/mimetype b/src/test/resources/reporting/files/layout-paginated-item/mimetype
@@ -0,0 +1 @@
+application/epub+zip
diff --git a/src/test/resources/reporting/files/layout-paginated/EPUB/content_001.xhtml b/src/test/resources/reporting/files/layout-paginated/EPUB/content_001.xhtml
@@ -0,0 +1,12 @@
+<!DOCTYPE html>
+<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
+	<head>
+		<meta charset="utf-8"/>
+		<meta name="viewport" content="width=600,height=1200" />
+		<title>Minimal EPUB</title>
+	</head>
+	<body>
+		<h1>Loomings</h1>
+		<p>Call me Ishmael.</p>
+	</body>
+</html>
diff --git a/src/test/resources/reporting/files/layout-paginated/EPUB/nav.xhtml b/src/test/resources/reporting/files/layout-paginated/EPUB/nav.xhtml
@@ -0,0 +1,14 @@
+<!DOCTYPE html>
+<html xmlns="http://www.w3.org/1999/xhtml" xmlns:epub="http://www.idpf.org/2007/ops" xml:lang="en" lang="en">
+	<head>
+		<meta charset="utf-8"/>
+		<title>Minimal Nav</title>
+	</head>
+	<body>
+		<nav epub:type="toc">
+			<ol>
+				<li><a href="content_001.xhtml">content 001</a></li>
+			</ol>
+		</nav>
+	</body>
+</html>
diff --git a/src/test/resources/reporting/files/layout-paginated/EPUB/package.opf b/src/test/resources/reporting/files/layout-paginated/EPUB/package.opf
@@ -0,0 +1,17 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<package xmlns="http://www.idpf.org/2007/opf" version="3.0" xml:lang="en" unique-identifier="q">
+<metadata xmlns:dc="http://purl.org/dc/elements/1.1/">
+  <dc:title id="title">Minimal EPUB 3.0</dc:title>
+  <dc:language>en</dc:language>
+  <dc:identifier id="q">NOID</dc:identifier>
+  <meta property="dcterms:modified">2017-06-14T00:00:01Z</meta>
+  <meta property="rendition:layout">pre-paginated</meta>
+</metadata>
+<manifest>
+  <item id="content_001"  href="content_001.xhtml" media-type="application/xhtml+xml"/>
+  <item id="nav"  href="nav.xhtml" media-type="application/xhtml+xml" properties="nav"/>
+</manifest>
+<spine>
+  <itemref idref="content_001" />
+</spine>
+</package>
diff --git a/src/test/resources/reporting/files/layout-paginated/META-INF/container.xml b/src/test/resources/reporting/files/layout-paginated/META-INF/container.xml
@@ -0,0 +1,6 @@
+<?xml version="1.0" encoding="UTF-8" ?>
+<container version="1.0" xmlns="urn:oasis:names:tc:opendocument:xmlns:container">
+	<rootfiles>
+		<rootfile full-path="EPUB/package.opf" media-type="application/oebps-package+xml"/>
+	</rootfiles>
+</container>
diff --git a/src/test/resources/reporting/files/layout-paginated/mimetype b/src/test/resources/reporting/files/layout-paginated/mimetype
@@ -0,0 +1 @@
+application/epub+zip
diff --git a/src/test/resources/reporting/files/layout-reflowable-item/EPUB/content_001.xhtml b/src/test/resources/reporting/files/layout-reflowable-item/EPUB/content_001.xhtml
@@ -0,0 +1,12 @@
+<!DOCTYPE html>
+<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
+	<head>
+		<meta charset="utf-8"/>
+		<meta name="viewport" content="width=600,height=1200" />
+		<title>Minimal EPUB</title>
+	</head>
+	<body>
+		<h1>Loomings</h1>
+		<p>Call me Ishmael.</p>
+	</body>
+</html>