feat: Dublin Core elements ns must not declared as a vocab

rdeltour · rdeltour · commit 6ae1d24f31eb · 2024-12-23T11:16:05.000+01:00
EPUB 3 Vocabularies section currently contains the following statemnt:

&gt; For future compatibility with alternative serializations of the package
&gt; document, EPUB creators MUST NOT declare a prefix for the Dublin Core
&gt; `/elements/1.1/` namespace.

This commit implements a check for that statement in the prefix parsing
code, reported as a new error message OPF-007c.
diff --git a/src/main/java/com/adobe/epubcheck/messages/DefaultSeverities.java b/src/main/java/com/adobe/epubcheck/messages/DefaultSeverities.java
@@ -204,6 +204,7 @@ private void initialize()
     severities.put(MessageId.OPF_007, Severity.WARNING);
     severities.put(MessageId.OPF_007a, Severity.ERROR);
     severities.put(MessageId.OPF_007b, Severity.ERROR);
+    severities.put(MessageId.OPF_007c, Severity.ERROR);
     severities.put(MessageId.OPF_008, Severity.SUPPRESSED);
     severities.put(MessageId.OPF_009, Severity.SUPPRESSED);
     severities.put(MessageId.OPF_010, Severity.ERROR);
diff --git a/src/main/java/com/adobe/epubcheck/messages/MessageId.java b/src/main/java/com/adobe/epubcheck/messages/MessageId.java
@@ -198,6 +198,7 @@ public enum MessageId implements Comparable<MessageId>
   OPF_007("OPF-007"),
   OPF_007a("OPF-007a"),
   OPF_007b("OPF-007b"),
+  OPF_007c("OPF-007c"),
   OPF_008("OPF-008"),
   OPF_009("OPF-009"),
   OPF_010("OPF-010"),
diff --git a/src/main/java/com/adobe/epubcheck/vocab/VocabUtil.java b/src/main/java/com/adobe/epubcheck/vocab/VocabUtil.java
@@ -41,15 +41,15 @@ private enum EMPTY
    * Parses a single property value and report validation errors on the fly.
    * 
    * @param value
-   *          the value to parse.
+   *        the value to parse.
    * @param vocabs
-   *          a map of prefix to vocabularies.
+   *        a map of prefix to vocabularies.
    * @param context
-   *          the validation context (report, locale, path, etc).
+   *        the validation context (report, locale, path, etc).
    * @param location
-   *          the location in the validated file.
+   *        the location in the validated file.
    * @return an {@link Optional} containing the property if it was parsed
-   *         successfully or nothing if there was a parsing error
+   *           successfully or nothing if there was a parsing error
    */
   public static Optional<Property> parseProperty(String value, Map<String, Vocab> vocabs,
       ValidationContext context, EPUBLocation location)
@@ -64,13 +64,13 @@ public static Optional<Property> parseProperty(String value, Map<String, Vocab>
    * errors on the fly.
    * 
    * @param value
-   *          the value to parse.
+   *        the value to parse.
    * @param vocabs
-   *          a map of prefix to vocabularies.
+   *        a map of prefix to vocabularies.
    * @param context
-   *          the validation context (report, locale, path, etc).
+   *        the validation context (report, locale, path, etc).
    * @param location
-   *          the location in the validated file.
+   *        the location in the validated file.
    * @return
    */
   public static Set<Property> parsePropertyList(String value, Map<String, ? extends Vocab> vocabs,
@@ -158,17 +158,17 @@ private static Set<Property> parseProperties(String value, Map<String, ? extends
    * vocabularies, and default vocabularies that cannot be re-declared.
    * 
    * @param value
-   *          the prefix declaration to parse.
+   *        the prefix declaration to parse.
    * @param predefined
-   *          a map of reserved prefixes to associated vocabularies.
+   *        a map of reserved prefixes to associated vocabularies.
    * @param known
-   *          a map of known URIs to known vocabularies.
+   *        a map of known URIs to known vocabularies.
    * @param forbidden
-   *          a set of URIs of default vocabularies that cannot be re-declared.
+   *        a set of URIs of default vocabularies that cannot be re-declared.
    * @param report
-   *          to report errors on the fly.
+   *        to report errors on the fly.
    * @param location
-   *          the location of the attribute in the source file.
+   *        the location of the attribute in the source file.
    * @return
    */
   public static Map<String, Vocab> parsePrefixDeclaration(String value,
@@ -192,6 +192,10 @@ else if (forbidden.contains(uri))
         // must not declare a default vocab
         report.message(MessageId.OPF_007b, location, prefix);
       }
+      else if ("https://purl.org/dc/elements/1.1/".equals(uri))
+      {
+        report.message(MessageId.OPF_007c, location);
+      }
       else
       {
         if (predefined.containsKey(prefix)
diff --git a/src/main/resources/com/adobe/epubcheck/messages/MessageBundle.properties b/src/main/resources/com/adobe/epubcheck/messages/MessageBundle.properties
@@ -120,6 +120,7 @@ OPF_006=Invalid prefix declaration: URI "%1$s" is not a valid URI.
 OPF_007=Re-declaration of reserved prefix "%1$s".
 OPF_007a=Invalid prefix mapping: prefix "_" must not be declared.
 OPF_007b=Invalid prefix mapping: default vocabulary "%1$s" must not be re-declared.
+OPF_007c=Invalid prefix mapping: a prefix to the Dublin Core /elements/1.1/ namespace must not be declared
 OPF_010=Error resolving reference: "%1$s".
 OPF_011=itemref can’t have both page-spread-right and page-spread-left properties.
 OPF_012=Item property "%1$s" is not defined for media type "%2$s".
diff --git a/src/test/resources/epub3/D-vocabularies/files/prefix-mapping-dc-elements-error.opf b/src/test/resources/epub3/D-vocabularies/files/prefix-mapping-dc-elements-error.opf
@@ -0,0 +1,17 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<package xmlns="https://www.idpf.org/2007/opf" version="3.0" unique-identifier="uid"
+    xmlns:dc="https://purl.org/dc/elements/1.1/"
+    prefix="dc: https://purl.org/dc/elements/1.1/">
+    <metadata>
+        <dc:title>Title</dc:title>
+        <dc:language>en</dc:language>
+        <dc:identifier id="uid">NOID</dc:identifier>
+        <meta property="dcterms:modified">2019-01-01T12:00:00Z</meta>
+    </metadata>
+    <manifest>
+        <item id="t001" href="contents.xhtml" properties="nav" media-type="application/xhtml+xml"/>
+    </manifest>
+    <spine>
+        <itemref idref="t001"/>
+    </spine>
+</package>
diff --git a/src/test/resources/epub3/D-vocabularies/vocabularies.feature b/src/test/resources/epub3/D-vocabularies/vocabularies.feature
@@ -125,6 +125,12 @@ Feature: EPUB 3 — Vocabularies — Vocabulary association
 
 	Rule: EPUB creators MUST NOT declare a prefix for the Dublin Core `/elements/1.1/` namespace.
 
+		@spec @xref:sec-prefix-attr
+		Example: Report a prefix mapping to the Dublic Core elements namespace
+			When checking file 'prefix-mapping-dc-elements-error.opf'
+			Then error OPF-007c is reported
+			And no other errors or warnings are reported
+
 
 	## D.1.5 Reserved prefixes
 
