JSONML.toString() and XML.toString() omit escaping for literal newlines (\n), causing whitespace loss in downstream XML parsers (Regression from #1070)
まだ誰も着手していません。
評価
調査の方向性
Start with XML.mustEscape(int cp) and XML.escape in the XML class, then trace how JSONML.toString and XML.toString reach them. The known regression is that 0xA, 0xD and 0x9 no longer get escaped on output, while numeric references like must still parse on input. Check the existing tests for the #1059 and #1070 behaviour before changing anything. Done means literal newlines, carriage returns and tabs in values serialize as numeric entities, and the parsing tests still pass.
索引モデルが issue の本文から書いたものです。
説明
Hello,
When a JSONObject containing a string with newline characters (\n) is converted to XML using JSONML.toString() (or XML.toString()), the newlines are output as literal newline characters instead of being XML-escaped (e.g., to ).
Because literal newlines in attribute values or specific text nodes are subject to W3C Newline Normalization by downstream XML parsers, the structural formatting and whitespace are completely lost or altered when the generated XML is parsed by another system.
This behavior is a side effect of the fix introduced in PR #1070 (which solved #1059). While PR #1070 correctly allowed whitespace numeric character references ( ) to be accepted during parsing (deserialization), it altered XML.mustEscape(int cp) to return false for 0xA, 0xD, and 0x9. As a result, the serialization path (XML.toString / JSONML.toString) now skips escaping for literal newlines, causing a regression in how whitespaces are preserved during export.
Reproducible Example / Code Snippet
import org.json.JSONObject;
import org.json.JSONML;
import org.junit.jupiter.api.Test;
import static org.junit.jupiter.api.Assertions.assertTrue;
public class XMLNewlineEscapingTest {
@Test
public void testJSONMLToStringPreservesNewlines() {
String jsonString = "{\"tagName\":\"MyTag\", \"value\":\"Lettuce\\nTomato\\nMustard\"}";
JSONObject jo = new JSONObject(jsonString);
String xmlOutput = JSONML.toString(jo);
System.out.println("Generated XML:\n" + xmlOutput);
// Assert
// Expected: Newlines should be escaped as to survive XML normalization
// Actual: It outputs raw, literal newlines <MyTag value="Lettuce\nTomato..."/>
assertTrue(xmlOutput.contains(" "), "XML should escape literal newlines to preserve them.");
}
}
Expected Behavior
When serializing to XML, literal control characters like \n (0xA), \r (0xD), and \t (0x9) within string values should be escaped into their corresponding numeric character entities ( , , 	) to prevent downstream XML parsers from stripping or normalizing them.
Actual Behavior
The generated XML string contains raw literal line breaks, which are collapsed or lost according to standard XML whitespace processing rules when loaded by any standard XML parser.
Suggested Root Cause & Fix Hint
The serialization path (XML.escape) heavily relies on XML.mustEscape(int cp). Currently, XML.mustEscape combines both "is this character legally allowed in an XML document?" (W3C range) and "does this character need to be escaped in text/attributes?".
The library needs to differentiate between the deserialization path (where is valid and shouldn't throw an exception) and the serialization path (where a literal 0xA needs to be actively escaped to ensure data integrity).
Best regards,
Sebastian
- 主要言語
- Java
- スター
- 4.7k
- フォーク
- 2.6k
- 平均マージ
- 4日 11時間
- マージ済み PR（30日）
- 7
環境構築
- Dockerfile・Docker Compose ファイルなし
- プルリクエストのテンプレートなし
- コントリビューションガイドを読む
はじめの一歩
- issue を最後まで読み、次にプロジェクトのコントリビューションガイドを読みます。
- 着手することを issue にコメントします — 二人が同じ作業をするのを防げます。
- リポジトリをフォークし、ブランチを切って変更します。
- issue 番号を参照したプルリクエストを送ります。
stleary/JSON-java のほかの issue
-
JSONObject.toString does not use an Enum's `toString()` but its `name()`再び着手できるかも @XIAYM-gh が 46 日前に担当しましたが、オープン中のプルリクエストはありません。 オープンFix before the next release
難易度 2/5 1〜3時間 初心者へのやさしさ 78/100
-
Investigating
難易度 5/5 1週間以上 初心者へのやさしさ 45/100
-
難易度 3/5 1〜2日 初心者へのやさしさ 72/100
-
Active discussion
難易度 5/5 1週間以上 初心者へのやさしさ 35/100
-
JSONObject.toString() throws StackOverflowError (not JSONException) on self-referential cycles再び着手できるかも このイシューのプルリクエストはマージされずにクローズされました。 オープンActive discussion
難易度 4/5 3〜5日 初心者へのやさしさ 56/100
stleary/JSON-java の issue をすべて見る
似ている issue
-
pdfium-drift
難易度 1/5 1時間未満 初心者へのやさしさ 82/100
Stirling-Tools/JPDFium#176 ·
メンテナーはふだん 1 日以内に返信
-
難易度 2/5 1〜3時間 初心者へのやさしさ 72/100
hiero-ledger/hiero-consensus-node#27712 ·
メンテナーはふだん 1 日以内に返信
-
難易度 2/5 1〜3時間 初心者へのやさしさ 61/100
Vakore/ZappierGames#162 ·
-
Improve README documentation clarity and fix minor wording issues対応中かも @simplesilence が今日担当しました。 オープン
難易度 1/5 1〜3時間 初心者へのやさしさ 84/100
resilience4j/resilience4j#2567 ·
メンテナーはふだん 6 日以内に返信
-
Priority/High
難易度 2/5 1〜3時間 初心者へのやさしさ 65/100
wso2/dpdp-accelerator#417 ·
メンテナーはふだん 1 日以内に返信