Skip to content

Apply explicit parser configuration to nested values #1077

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
Mahmoodifar wants to merge 2 commits into
base: master
Choose a base branch
from
+139 −32
Open

Apply explicit parser configuration to nested values #1077

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
0ae8d5a
fix: apply explicit parser configuration
Mahmoodifar Sep 18, 2026
9f3b527
fix: restore tokener configuration after parsing
Mahmoodifar Sep 18, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
58 changes: 33 additions & 25 deletions src/main/java/org/json/JSONArray.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -88,6 +88,9 @@ public JSONArray(JSONTokener x) throws JSONException {

/**
* Constructs a JSONArray from a JSONTokener and a JSONParserConfiguration.
* The supplied configuration applies to all values during construction,
* including nested objects and arrays. The tokener's original configuration
* is restored afterward, even if parsing fails.
*
* @param x A JSONTokener instance from which the JSONArray is constructed.
* @param jsonParserConfiguration A JSONParserConfiguration instance that controls the behavior of the parser.
Expand All @@ -108,34 +111,39 @@ public JSONArray(JSONTokener x, JSONParserConfiguration jsonParserConfiguration)
*/
JSONArray(JSONTokener x, JSONParserConfiguration jsonParserConfiguration, boolean isInitial) throws JSONException {
this();
JSONParserConfiguration originalConfiguration = x.getJsonParserConfiguration();
x.setJsonParserConfigurationInternal(jsonParserConfiguration);
try {
if (x.nextClean() != '[') {
throw x.syntaxError("A JSONArray text must start with '['");
}

if (x.nextClean() != '[') {
throw x.syntaxError("A JSONArray text must start with '['");
}

char nextChar = x.nextClean();
if (nextChar == 0) {
// array is unclosed. No ']' found, instead EOF
throw x.syntaxError("Expected a ',' or ']'");
} else if (nextChar==',' && jsonParserConfiguration.isStrictMode()) {
throw x.syntaxError("Array content starts with a ','");
}
if (nextChar != ']') {
x.back();
for (;;) {
if (x.nextClean() == ',') {
x.back();
this.myArrayList.add(JSONObject.NULL);
} else {
x.back();
this.myArrayList.add(x.nextValue());
}
if (checkForSyntaxError(x, jsonParserConfiguration, isInitial)) return;
char nextChar = x.nextClean();
if (nextChar == 0) {
// array is unclosed. No ']' found, instead EOF
throw x.syntaxError("Expected a ',' or ']'");
} else if (nextChar==',' && jsonParserConfiguration.isStrictMode()) {
throw x.syntaxError("Array content starts with a ','");
}
} else {
if (isInitial && jsonParserConfiguration.isStrictMode() && x.nextClean() != 0) {
throw x.syntaxError("Strict mode error: Unparsed characters found at end of input text");
if (nextChar != ']') {
x.back();
for (;;) {
if (x.nextClean() == ',') {
x.back();
this.myArrayList.add(JSONObject.NULL);
} else {
x.back();
this.myArrayList.add(x.nextValue());
}
if (checkForSyntaxError(x, jsonParserConfiguration, isInitial)) return;
}
} else {
if (isInitial && jsonParserConfiguration.isStrictMode() && x.nextClean() != 0) {
throw x.syntaxError("Strict mode error: Unparsed characters found at end of input text");
}
}
} finally {
x.setJsonParserConfigurationInternal(originalConfiguration);
}
}

Expand Down
22 changes: 15 additions & 7 deletions src/main/java/org/json/JSONObject.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -204,6 +204,9 @@ public JSONObject(JSONTokener x) throws JSONException {

/**
* Construct a JSONObject from a JSONTokener with custom json parse configurations.
* The supplied configuration applies to all values during construction,
* including nested objects and arrays. The tokener's original configuration
* is restored afterward, even if parsing fails.
*
* @param x
* A JSONTokener object containing the source string.
Expand Down Expand Up @@ -233,14 +236,19 @@ public JSONObject(JSONTokener x, JSONParserConfiguration jsonParserConfiguration
*/
JSONObject(JSONTokener x, JSONParserConfiguration jsonParserConfiguration, boolean isInitial) throws JSONException {
this();

if (x.nextClean() != '{') {
throw x.syntaxError("A JSONObject text must begin with '{'");
}
for (;;) {
if (parseJSONObject(x, jsonParserConfiguration, isInitial)) {
return;
JSONParserConfiguration originalConfiguration = x.getJsonParserConfiguration();
x.setJsonParserConfigurationInternal(jsonParserConfiguration);
try {
if (x.nextClean() != '{') {
throw x.syntaxError("A JSONObject text must begin with '{'");
}
for (;;) {
if (parseJSONObject(x, jsonParserConfiguration, isInitial)) {
return;
}
}
} finally {
x.setJsonParserConfigurationInternal(originalConfiguration);
}
}

Expand Down
4 changes: 4 additions & 0 deletions src/main/java/org/json/JSONTokener.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -117,6 +117,10 @@ public JSONParserConfiguration getJsonParserConfiguration() {
*/
@Deprecated
public void setJsonParserConfiguration(JSONParserConfiguration jsonParserConfiguration) {
setJsonParserConfigurationInternal(jsonParserConfiguration);
}

void setJsonParserConfigurationInternal(JSONParserConfiguration jsonParserConfiguration) {
this.jsonParserConfiguration = jsonParserConfiguration;
}

Expand Down
87 changes: 87 additions & 0 deletions src/test/java/org/json/junit/JSONParserConfigurationTest.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -16,6 +16,7 @@
import java.util.stream.Stream;

import static org.junit.Assert.assertEquals;
import static org.junit.Assert.assertSame;
import static org.junit.Assert.assertThrows;
import static org.junit.Assert.assertTrue;
import static org.junit.Assert.fail;
Expand All @@ -36,6 +37,92 @@ public void testOverwrite() {
assertEquals("duplicate key should be overwritten", "value2", jsonObject.getString("key"));
}

@Test
public void objectConstructorAppliesExplicitStrictModeToValues() {
JSONParserConfiguration configuration = new JSONParserConfiguration().withStrictMode();
JSONParserConfiguration lenient = new JSONParserConfiguration().withStrictMode(false);
for (String source : Arrays.asList(
"[]",
"{",
"{} trailing",
"{\"value\":'text'}",
"{\"value\":[1,]}",
"{\"value\":{\"nested\":1,}}")) {
JSONTokener tokener = new JSONTokener(source, lenient);
assertThrows(JSONException.class, () -> new JSONObject(tokener, configuration));
assertSame(lenient, tokener.getJsonParserConfiguration());
}
}

@Test
public void arrayConstructorAppliesExplicitStrictModeToValues() {
JSONParserConfiguration configuration = new JSONParserConfiguration().withStrictMode();
JSONParserConfiguration lenient = new JSONParserConfiguration().withStrictMode(false);
for (String source : Arrays.asList(
"{}",
"[",
"[] trailing",
"['text']",
"[[1,]]",
"[{\"nested\":1,}]")) {
JSONTokener tokener = new JSONTokener(source, lenient);
assertThrows(JSONException.class, () -> new JSONArray(tokener, configuration));
assertSame(lenient, tokener.getJsonParserConfiguration());
}
}

@Test
public void explicitConfigurationOverridesTokenerStrictMode() {
JSONParserConfiguration strict = new JSONParserConfiguration().withStrictMode();
JSONParserConfiguration lenient = new JSONParserConfiguration().withStrictMode(false);
JSONTokener objectTokener = new JSONTokener("{\"value\":[{'nested':'text',}], 'other':'text'} 'next'", strict);
JSONTokener arrayTokener = new JSONTokener("[{\"value\":['text',]},'text'] 'next'", strict);

JSONObject object = new JSONObject(objectTokener, lenient);
JSONArray array = new JSONArray(arrayTokener, lenient);

assertEquals("text", object.getJSONArray("value").getJSONObject(0).getString("nested"));
assertEquals("text", array.getJSONObject(0).getJSONArray("value").getString(0));
assertEquals("text", object.getString("other"));
assertEquals("text", array.getString(1));
assertSame(strict, objectTokener.getJsonParserConfiguration());
assertSame(strict, arrayTokener.getJsonParserConfiguration());
assertThrows(JSONException.class, () -> objectTokener.nextValue());
assertThrows(JSONException.class, () -> arrayTokener.nextValue());
}

@Test
public void objectConstructorRestoresTokenerConfiguration() {
JSONParserConfiguration original = new JSONParserConfiguration().withStrictMode(false);
JSONParserConfiguration strict = new JSONParserConfiguration().withStrictMode();
for (String source : Arrays.asList("{}", "{\"value\":[{\"nested\":\"text\"}],\"other\":true}")) {
JSONTokener tokener = new JSONTokener(source, original);
new JSONObject(tokener, strict);
assertSame(original, tokener.getJsonParserConfiguration());
}
}

@Test
public void arrayConstructorRestoresTokenerConfiguration() {
JSONParserConfiguration original = new JSONParserConfiguration().withStrictMode(false);
JSONParserConfiguration strict = new JSONParserConfiguration().withStrictMode();
for (String source : Arrays.asList("[]", "[{\"value\":[\"text\"]},true]")) {
JSONTokener tokener = new JSONTokener(source, original);
new JSONArray(tokener, strict);
assertSame(original, tokener.getJsonParserConfiguration());
}
}

@Test
public void explicitConfigurationAppliesToNestedDuplicateKeys() {
JSONParserConfiguration configuration = new JSONParserConfiguration().withOverwriteDuplicateKey(true);
JSONObject object = new JSONObject(new JSONTokener("{\"value\":[{\"key\":1,\"key\":2}]}"), configuration);
JSONArray array = new JSONArray(new JSONTokener("[{\"value\":{\"key\":1,\"key\":2}}]"), configuration);

assertEquals(2, object.getJSONArray("value").getJSONObject(0).getInt("key"));
assertEquals(2, array.getJSONObject(0).getJSONObject("value").getInt("key"));
}

@Test
public void strictModeIsCloned(){
JSONParserConfiguration jsonParserConfiguration = new JSONParserConfiguration()
Expand Down
Loading