Fix #291, handling of entity references in Node/DocumentFragments

Author: pdvrieze

Changelog.md

@@ -19,6 +19,9 @@ Changes:
 Fixes:
 - Fix trimming of strings inside a mixed context where there is an
   `@XmlIgnoreSpace(true)` annotation.
+- Fix handling of entity references in handling generic value holders
+  (node, compactFragment). This addresses bug #291 with two separate,
+  but equivalent errors. 
 
 # 0.91.1
 *(May 15, 2025)

core/base/src/commonMain/kotlin/nl/adaptivity/xmlutil/DomWriter.kt

@@ -1,21 +1,21 @@
 /*
- * Copyright (c) 2024.
+ * Copyright (c) 2024-2025.
  *
  * This file is part of xmlutil.
  *
- * This file is licenced to you under the Apache License, Version 2.0 (the
- * "License"); you may not use this file except in compliance
- * with the License.  You should have received a copy of the license with the source distribution.
- * Alternatively, you may obtain a copy of the License at
+ * This file is licenced to you under the Apache License, Version 2.0
+ * (the "License"); you may not use this file except in compliance
+ * with the License.  You should have  received a copy of the license
+ * with the source distribution. Alternatively, you may obtain a copy
+ * of the License at
  *
  *   http://www.apache.org/licenses/LICENSE-2.0
  *
- * Unless required by applicable law or agreed to in writing,
- * software distributed under the License is distributed on an
- * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
- * KIND, either express or implied.  See the License for the
- * specific language governing permissions and limitations
- * under the License.
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+ * implied.  See the License for the specific language governing
+ * permissions and limitations under the License.
  */
 
 @file:Suppress("DEPRECATION")
@@ -237,7 +237,16 @@ public class DomWriter @Deprecated("Don't use directly. Instead create an instan
 
     override fun entityRef(text: String) {
         lastTagDepth = TAG_DEPTH_NOT_TAG
-        throw UnsupportedOperationException("Creating entity references is not supported (or incorrect) in most browsers")
+        when (text) { // handle the built in entities as regular text (which will escape where needed)
+            "amp" -> text("&")
+            "quot" -> text("\"")
+            "lt" -> text("<")
+            "gt" -> text(">")
+            "apos" -> text("'")
+
+            else ->
+                throw UnsupportedOperationException("Creating entity references is not supported (or incorrect) in most browsers: $text")
+        }
     }
 
     override fun processingInstruction(text: String) {

core/base/src/commonMain/kotlin/nl/adaptivity/xmlutil/XmlReaderNS.kt

@@ -1,21 +1,21 @@
 /*
- * Copyright (c) 2024.
+ * Copyright (c) 2024-2025.
  *
  * This file is part of xmlutil.
  *
- * This file is licenced to you under the Apache License, Version 2.0 (the
- * "License"); you may not use this file except in compliance
- * with the License.  You should have received a copy of the license with the source distribution.
- * Alternatively, you may obtain a copy of the License at
+ * This file is licenced to you under the Apache License, Version 2.0
+ * (the "License"); you may not use this file except in compliance
+ * with the License.  You should have  received a copy of the license
+ * with the source distribution. Alternatively, you may obtain a copy
+ * of the License at
  *
  *   http://www.apache.org/licenses/LICENSE-2.0
  *
- * Unless required by applicable law or agreed to in writing,
- * software distributed under the License is distributed on an
- * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
- * KIND, either express or implied.  See the License for the
- * specific language governing permissions and limitations
- * under the License.
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+ * implied.  See the License for the specific language governing
+ * permissions and limitations under the License.
  */
 
 
@@ -83,12 +83,13 @@ public fun XmlReader.siblingsToFragment(): CompactFragment {
                 EventType.IGNORABLE_WHITESPACE ->
                     if (text.isNotEmpty()) appendable.append(text.xmlEncode())
 
+                EventType.ENTITY_REF,
                 EventType.TEXT,
                 EventType.CDSECT ->
                     appendable.append(text.xmlEncode())
 
                 else -> {
-                } // ignore
+                } // ignore, note this also removes any xml comments
             }
             type = if (hasNext()) next() else break
         }

core/base/src/commonMain/kotlin/nl/adaptivity/xmlutil/XmlWriter.kt

@@ -1,21 +1,21 @@
 /*
- * Copyright (c) 2024.
+ * Copyright (c) 2024-2025.
  *
  * This file is part of xmlutil.
  *
- * This file is licenced to you under the Apache License, Version 2.0 (the
- * "License"); you may not use this file except in compliance
- * with the License.  You should have received a copy of the license with the source distribution.
- * Alternatively, you may obtain a copy of the License at
+ * This file is licenced to you under the Apache License, Version 2.0
+ * (the "License"); you may not use this file except in compliance
+ * with the License.  You should have  received a copy of the license
+ * with the source distribution. Alternatively, you may obtain a copy
+ * of the License at
  *
  *   http://www.apache.org/licenses/LICENSE-2.0
  *
- * Unless required by applicable law or agreed to in writing,
- * software distributed under the License is distributed on an
- * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
- * KIND, either express or implied.  See the License for the
- * specific language governing permissions and limitations
- * under the License.
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+ * implied.  See the License for the specific language governing
+ * permissions and limitations under the License.
  */
 @file:JvmMultifileClass
 @file:JvmName("XmlWriterUtil")
@@ -326,7 +326,7 @@ public fun XmlWriter.writeCurrentEvent(reader: XmlReader) {
 
         EventType.END_DOCUMENT -> endDocument()
 
-        EventType.ENTITY_REF -> entityRef(reader.text)
+        EventType.ENTITY_REF -> entityRef(reader.localName)
 
         EventType.IGNORABLE_WHITESPACE -> ignorableWhitespace(reader.text)
 

core/base/src/jvmCommonMain/kotlin/nl/adaptivity/xmlutil/core/impl/dom/TextImpl.kt

@@ -1,21 +1,21 @@
 /*
- * Copyright (c) 2024.
+ * Copyright (c) 2024-2025.
  *
  * This file is part of xmlutil.
  *
- * This file is licenced to you under the Apache License, Version 2.0 (the
- * "License"); you may not use this file except in compliance
- * with the License.  You should have received a copy of the license with the source distribution.
- * Alternatively, you may obtain a copy of the License at
+ * This file is licenced to you under the Apache License, Version 2.0
+ * (the "License"); you may not use this file except in compliance
+ * with the License.  You should have  received a copy of the license
+ * with the source distribution. Alternatively, you may obtain a copy
+ * of the License at
  *
  *   http://www.apache.org/licenses/LICENSE-2.0
  *
- * Unless required by applicable law or agreed to in writing,
- * software distributed under the License is distributed on an
- * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
- * KIND, either express or implied.  See the License for the
- * specific language governing permissions and limitations
- * under the License.
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+ * implied.  See the License for the specific language governing
+ * permissions and limitations under the License.
  */
 
 package nl.adaptivity.xmlutil.core.impl.dom
@@ -34,4 +34,7 @@ internal open class TextImpl(delegate: Text) : CharacterDataImpl<Text>(delegate)
     override fun replaceWholeText(content: String): IText =
         delegate.replaceWholeText(content).wrap()
 
+    override fun toString(): String {
+        return delegate.toString()
+    }
 }

serialization/src/commonMain/kotlin/nl/adaptivity/xmlutil/serialization/XML.kt

@@ -787,8 +787,11 @@ public class XML(
 
     public companion object : StringFormat {
 
+        @Suppress("DEPRECATION")
         public val defaultInstance: XML = XML {
-            policy = DefaultXmlSerializationPolicy(try { defaultSharedFormatCache() } catch(e: Error) { FormatCache.Dummy }) {}
+            policy = DefaultXmlSerializationPolicy(
+                runCatching { defaultSharedFormatCache() }.getOrElse { FormatCache.Dummy }
+            ) {}
         }
         override val serializersModule: SerializersModule
             get() = defaultInstance.serializersModule

serialization/src/commonTest/kotlin/nl/adaptivity/xml/serialization/regressions/EntityInNode291.kt

@@ -0,0 +1,119 @@
+/*
+ * Copyright (c) 2025.
+ *
+ * This file is part of xmlutil.
+ *
+ * This file is licenced to you under the Apache License, Version 2.0
+ * (the "License"); you may not use this file except in compliance
+ * with the License.  You should have  received a copy of the license
+ * with the source distribution. Alternatively, you may obtain a copy
+ * of the License at
+ *
+ *   http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+ * implied.  See the License for the specific language governing
+ * permissions and limitations under the License.
+ */
+
+package nl.adaptivity.xml.serialization.regressions
+
+import io.github.pdvrieze.xmlutil.testutil.assertXmlEquals
+import kotlinx.serialization.SerialName
+import kotlinx.serialization.Serializable
+import kotlinx.serialization.decodeFromString
+import kotlinx.serialization.encodeToString
+import nl.adaptivity.xmlutil.dom2.Node
+import nl.adaptivity.xmlutil.dom2.Text
+import nl.adaptivity.xmlutil.dom2.data
+import nl.adaptivity.xmlutil.serialization.XML
+import nl.adaptivity.xmlutil.serialization.XmlValue
+import nl.adaptivity.xmlutil.util.CompactFragment
+import nl.adaptivity.xmlutil.xmlStreaming
+import kotlin.test.Test
+import kotlin.test.assertEquals
+import kotlin.test.assertIs
+
+class EntityInNode291 {
+    val expectedXml = "<Tag>&amp;Content</Tag>"
+
+    val xml = XML {
+        recommended_0_90_2()
+        defaultToGenericParser = true
+    }
+
+    @SerialName("Tag")
+    @Serializable
+    data class Tag(@XmlValue val content: String)
+
+    @SerialName("Tag")
+    @Serializable
+    data class NodeTag(@XmlValue val content: List<Node>)
+
+    @SerialName("Tag")
+    @Serializable
+    data class CFTag(@XmlValue val content: CompactFragment)
+
+    @SerialName("Tag")
+    @Serializable
+    data class CFListTag(@XmlValue val content: List<CompactFragment>)
+
+    @Test
+    fun assertSerializeTag() {
+        val data = Tag("&Content")
+        assertXmlEquals(expectedXml, xml.encodeToString(data))
+    }
+
+    @Test
+    fun assertDeserializeTag() {
+        val expected = Tag("&Content")
+        assertEquals(expected, xml.decodeFromString(expectedXml))
+    }
+
+    @Test
+    fun assertSerializeNodeTag() {
+        val document = xmlStreaming.genericDomImplementation.createDocument()
+        val data = NodeTag(listOf(document.createTextNode("&Content")))
+        assertXmlEquals(expectedXml, xml.encodeToString(data))
+    }
+
+    @Test
+    fun assertDeserializeNodeTag() {
+        val actual = xml.decodeFromString<NodeTag>(expectedXml)
+        assertEquals(2, actual.content.size, "Unexpected content: ${actual.content.joinToString()}")
+        val textNode1 = assertIs<Text>(actual.content[0])
+        val textNode2 = assertIs<Text>(actual.content[1])
+        assertEquals("&", textNode1.data)
+        assertEquals("Content", textNode2.data)
+    }
+
+    @Test
+    fun assertSerializeCFTag() {
+        val data = CFTag(CompactFragment("&amp;Content"))
+        assertXmlEquals(expectedXml, xml.encodeToString(data))
+    }
+
+    @Test
+    fun assertDeserializeCFTag() {
+        val actual = xml.decodeFromString<CFTag>(expectedXml)
+        assertEquals("&amp;Content", actual.content.contentString)
+    }
+
+    @Test
+    fun assertSerializeCFListTag() {
+        val data = CFListTag(listOf(CompactFragment("&amp;Content")))
+        assertXmlEquals(expectedXml, xml.encodeToString(data))
+    }
+
+    @Test
+    fun assertDeserializeCFListTag() {
+        val actual = xml.decodeFromString<CFListTag>(expectedXml)
+        assertEquals(2, actual.content.size, "Unexpected content: ${actual.content.joinToString()}")
+        val textNode1 = actual.content[0]
+        val textNode2 = actual.content[1]
+        assertEquals("&", textNode1.contentString)
+        assertEquals("Content", textNode2.contentString)
+    }
+}