eclipse-ee4j / jaxb-dtd-parser

DTD Parser

SAX-like API for parsing XML DTDs.

This project is part of Eclipse Implementation of JAXB.

License

DTD Parser is licensed under a license - EDL 1.0.

Contributing

We use contribution policy, which means we can only accept contributions under the terms of Eclipse Contributor Agreement.

Links

• Javadoc
• Mailing list
• Nightly build job

jaxb-dtd-parser's Issues

Unclear License Type

License file says this component is under BSD-3-Clause license, while notice file says it's under EPL-1.0 license. Which one is it then?

Release to OSSRH staging repository

• Uptake new Eclipse versions of dependencies. Use GlassFish 5.1 Release Tracker wiki to find components versions to use.

• Release to OSSRH staging repository

• Update GlassFish 5.1 Release Tracker with released version number.

How to release first versions of EE4J components

Occurrence constants are misspelled

The constants for occurrence constraints are all missing a second r. As these constants are already part of public API and cannot be changed without breaking backwards compatibility, it's probably best to deprecate the misspelled ones and add new ones with proper spelling and the same values:

+   public final short OCCURRENCE_ZERO_OR_MORE = 0;
+
+   @Deprecated
    public final short OCCURENCE_ZERO_OR_MORE = 0;
+
+   public final short OCCURRENCE_ONE_OR_MORE = 1;
+
+   @Deprecated
    public final short OCCURENCE_ONE_OR_MORE = 1;
+
+   public final short OCCURRENCE_ZERO_OR_ONE = 2;
+
+   @Deprecated
    public final short OCCURENCE_ZERO_OR_ONE = 2;
+
+   public final short OCCURRENCE_ONCE = 3;
+
+   @Deprecated
    public final short OCCURENCE_ONCE = 3;

Release CI/CD pipeline

We need to create a release CI/CD pipeline for this project.

Use these documents as a reference:

• How to release the first Eclipse version of projects
• JSONP release job

Place holder issue for Pull Request 2

This is a place holder issue for Pull request from javaee/jaxb-dtd-parser#2

Build CI/CD pipeline

This task is for creating a basic build CI/CD pipeline for this project on Eclipse infrastructure. More information is here: https://ci.eclipse.org/.

"Illegal parameter entity reference syntax" on W3C DTD for SMIL 3.0

Using dtd-parser trunk code I cannot parse W3C SMIL DTDs. I'm using XJC
2.2.3 to generate JAXB classes for SMIL 3.0:

----- console output -----
$xjc -dtd -d
/data/Dev/Java/XML/SMIL/w3c/org.w3c.smil30.dtd/src/output/java -p
org.w3c.smil30 /data/Dev/Java/XML/SMIL/w3c/DTD/SMIL30Language.dtd
parsing a schema...
[ERROR] Illegal parameter entity reference syntax
line 81 of file:/data/Dev/Java/XML/SMIL/w3c/DTD/SMIL-layout.mod

Failed to parse a schema.

---

In the extract below line 81 is %SMIL.common-layout-attrs;
----- dtd extract -----

---

I really don't see what's wrong, and I doubt W3C would produce invalid
DTD.
So I guess it's some sort of bug in dtd-parser.

DTDs can be downloaded at this url:
http://www.w3.org/TR/SMIL/DTD.zip

More info on SMIL DTDs:
http://www.w3.org/TR/SMIL/smil-DTD.html

Any help would be great.

Merry Xmas!

Environment

Arch Linux 64 bit, JDK 6

Affected Versions

[current]

Place holder issue for Pull Request 3

This is a place holder issue for Pull request from javaee/jaxb-dtd-parser#3

Address PMC requirements

All EE4J projects must follow PMC requirements described here:
https://www.eclipse.org/ee4j/news/?date=2018-02-16

Public Release

Last CTS runs indicate no failures in this component. It's time to make a public release. Before the release make sure that Eclipse Release Review is passed and all dependencies have been released.

Parser parses #IMPLIED use attributes as NORMAL (and vice versa)

I believe that there is a fundamental flaw in the DTDParser's attribute use parsing. Using various test DTDs, it appears that attributes with #IMPLIED default declarations are assigned attribute use USE_NORMAL. Vice versa, attributes with a declared default value (and neither #IMPLIED, #REQUIRED nor #FIXED designation) do appear as USE_IMPLIED.

The following test case, I believe, demonstrates this issue with a very simple DTD:

import java.io.StringReader;
import java.util.HashMap;
import java.util.Map;
import com.sun.xml.dtdparser.DTDParser;
import com.sun.xml.dtdparser.DTDHandlerBase;
import com.sun.xml.dtdparser.DTDEventListener;
import org.junit.Test;
import org.xml.sax.InputSource;
import org.xml.sax.SAXException;
import static org.junit.Assert.assertEquals;

public class AttributeUseTest
{
  Map<String, Short> attributes = new HashMap<>();

  public AttributeUseTest() throws Exception
  {
    String dtd =
    """
      <!ELEMENT root EMPTY>
      <!ATTLIST root
        normal CDATA "default"
        implied CDATA #IMPLIED
        required CDATA #REQUIRED
        fixed CDATA #FIXED "default"
      >
    """;
    DTDEventListener handler = new DTDHandlerBase()
    {
      @Override
      public void attributeDecl(String element, String name, String type, String[] enums, short use, String defaultValue) throws SAXException
      {
          attributes.put(name, use);
      }
    };
    InputSource input = new InputSource(new StringReader(dtd));
    DTDParser parser = new DTDParser();
    parser.setDtdHandler(handler);
    parser.parse(input);
  }

  @Test
  public void testNormalAttribute()
  {
    assertEquals(DTDEventListener.USE_NORMAL, attributes.get("normal").shortValue());
  }

  @Test
  public void testImpliedAttribute()
  {
    assertEquals(DTDEventListener.USE_IMPLIED, attributes.get("implied").shortValue());
  }

  @Test
  public void testRequiredAttribute()
  {
      assertEquals(DTDEventListener.USE_REQUIRED, attributes.get("required").shortValue());
  }

  @Test
  public void testFixedAttribute()
  {
      assertEquals(DTDEventListener.USE_FIXED, attributes.get("fixed").shortValue());
  }
}

The test cases for #REQUIRED and #FIXED pass as expected, but the two other test cases both fail.

As I ran this in the debugger, I noticed some strange looking code in DTDParser.maybeAttlistDecl():

jaxb-dtd-parser/dtd-parser/src/main/java/com/sun/xml/dtdparser/DTDParser.java

Lines 1517 to 1518 in c9b1bb6

	} else if (!peek("#IMPLIED")) {
	attributeUse = DTDEventListener.USE_IMPLIED;

Intuitively, the negation !peek("#IMPLIED") (instead of just peek("#IMPLIED")) seems incorrect here, since it would select USE_IMPLIED specifically if #IMPLIED was not present. This explains why attributes without any default declarations end up being recognized as implied.

Further down, USE_NORMAL is assigned as a fallback value:

jaxb-dtd-parser/dtd-parser/src/main/java/com/sun/xml/dtdparser/DTDParser.java

Lines 1538 to 1540 in c9b1bb6

	} else {
	// TODO: this looks like an fatal error.
	attributeUse = DTDEventListener.USE_NORMAL;

This explains why #IMPLIED attributes (which do not get recognized further up, due to the negation) are designated as USE_NORMAL.