fix Issue 177 (support incomplet json messages)

README.md

@@ -22,6 +22,7 @@ So I do not use my json-smart anymore. I had fun with this project. If you want
 ### *V 2.6.0* (next version)
 
 * JSONObject merge support overwrite as parameter. [PR 238](https://github.com/netplex/json-smart-v2/pull/238)
+* Add `JSONParser.ACCEPT_INCOMPLETE` to allow parsing partial and incomplete JSON without error [PR 254](https://github.com/netplex/json-smart-v2/pull/254)
 
 ### *V 2.5.2* (2025-02-12)
 

json-smart/src/main/java/net/minidev/json/JSONArray.java

@@ -26,8 +26,7 @@
  * @author FangYidong <[email protected]>
  * @author Uriel Chemouni <[email protected]>
  */
-public class JSONArray extends ArrayList<Object>
-    implements List<Object>, JSONAwareEx, JSONStreamAwareEx {
+public class JSONArray extends ArrayList<Object> implements JSONAwareEx, JSONStreamAwareEx {
   private static final long serialVersionUID = 9106884089231309568L;
 
   public JSONArray() {}
@@ -76,13 +75,21 @@ public static void writeJSONString(
     JsonWriter.JSONIterableWriter.writeJSONString(list, out, compression);
   }
 
+  /**
+   * Encode a list into JSON text and write it to out. If this list is also a JSONStreamAware or a
+   * JSONAware, JSONStreamAware and JSONAware specific behaviours will be ignored at this top level.
+   *
+   * @param list
+   * @param out
+   * @throws IOException
+   */
   public static void writeJSONString(List<? extends Object> list, Appendable out)
       throws IOException {
     writeJSONString(list, out, JSONValue.COMPRESSION);
   }
 
   /**
-   * Appends the specified element and returns this. Handy alternative to add(E e) method.
+   * Appends the specified element and returns this. same effect that add(E e) method.
    *
    * @param element element to be appended to this array.
    * @return this
@@ -92,6 +99,11 @@ public JSONArray appendElement(Object element) {
     return this;
   }
 
+  /**
+   * Merges the specified object into this array. can trigger an add(E e) or addAll(E e) method.
+   *
+   * @param o2
+   */
   public void merge(Object o2) {
     JSONObject.merge(this, o2);
   }
@@ -119,10 +131,21 @@ public String toString(JSONStyle compression) {
     return toJSONString(compression);
   }
 
+  /**
+   * JSONStreamAwareEx interface
+   *
+   * @param out output stream
+   */
   public void writeJSONString(Appendable out) throws IOException {
     writeJSONString(this, out, JSONValue.COMPRESSION);
   }
 
+  /**
+   * JSONStreamAwareEx interface
+   *
+   * @param out output stream
+   * @param compression compression param
+   */
   public void writeJSONString(Appendable out, JSONStyle compression) throws IOException {
     writeJSONString(this, out, compression);
   }

json-smart/src/main/java/net/minidev/json/JSONUtil.java

@@ -45,10 +45,11 @@ else if (dest == double.class)
         if (obj instanceof Number) return ((Number) obj).doubleValue();
         else return Double.valueOf(obj.toString());
       else if (dest == char.class) {
-        String asString = dest.toString();
+        String asString = obj.toString();
         if (asString.length() > 0) return Character.valueOf(asString.charAt(0));
       } else if (dest == boolean.class) {
-        return (Boolean) obj;
+        if (obj instanceof Number) return ((Number) obj).intValue() != 0;
+        if (obj instanceof String) return Boolean.valueOf((String) obj);
       }
       throw new RuntimeException(
           "Primitive: Can not convert " + obj.getClass().getName() + " to " + dest.getName());
@@ -73,9 +74,13 @@ else if (dest == char.class) {
         if (obj instanceof Number) return Double.valueOf(((Number) obj).doubleValue());
         else return Double.valueOf(obj.toString());
       if (dest == Character.class) {
-        String asString = dest.toString();
+        String asString = obj.toString();
         if (asString.length() > 0) return Character.valueOf(asString.charAt(0));
       }
+      if (dest == Boolean.class) {
+        if (obj instanceof Number) return ((Number) obj).intValue() != 0;
+        if (obj instanceof String) return Boolean.valueOf((String) obj);
+      }
       throw new RuntimeException(
           "Object: Can not Convert " + obj.getClass().getName() + " to " + dest.getName());
     }
@@ -94,10 +99,11 @@ public static Object convertToX(Object obj, Class<?> dest) {
       else if (dest == float.class) return Float.valueOf(obj.toString());
       else if (dest == double.class) return Double.valueOf(obj.toString());
       else if (dest == char.class) {
-        String asString = dest.toString();
+        String asString = obj.toString();
         if (asString.length() > 0) return Character.valueOf(asString.charAt(0));
       } else if (dest == boolean.class) {
-        return (Boolean) obj;
+        if (obj instanceof Number) return ((Number) obj).intValue() != 0;
+        if (obj instanceof String) return Boolean.valueOf((String) obj);
       }
       throw new RuntimeException(
           "Primitive: Can not convert " + obj.getClass().getName() + " to " + dest.getName());
@@ -122,9 +128,13 @@ else if (dest == char.class) {
         if (obj instanceof Number) return Double.valueOf(((Number) obj).doubleValue());
         else return Double.valueOf(obj.toString());
       if (dest == Character.class) {
-        String asString = dest.toString();
+        String asString = obj.toString();
         if (asString.length() > 0) return Character.valueOf(asString.charAt(0));
       }
+      if (dest == Boolean.class) {
+        if (obj instanceof Number) return ((Number) obj).intValue() != 0;
+        if (obj instanceof String) return Boolean.valueOf((String) obj);
+      }
       throw new RuntimeException(
           "Object: Can not Convert " + obj.getClass().getName() + " to " + dest.getName());
     }

json-smart/src/main/java/net/minidev/json/parser/JSONParser.java

@@ -101,11 +101,29 @@ public class JSONParser {
   public static final int LIMIT_JSON_DEPTH = 4096;
 
   /**
-   * smart mode, fastest parsing mode. accept lots of non standard json syntax
+   * If the parser is in stream mode
+   *
+   * <p>Stream mode is used to parse a stream of json data. It will not throw exception on
+   * incomplete data.
+   *
+   * @since 2.6
+   */
+  public static final int ACCEPT_INCOMPLETE = 8192;
+
+  /**
+   * smart mode, fastest parsing mode. accept lots of non standard json syntax ACCEPT_INCOMPLETE
+   * feature is not enabled. in this mode, for backward compatibility
    *
    * @since 1.0.6
    */
-  public static final int MODE_PERMISSIVE = -1;
+  public static final int MODE_PERMISSIVE = -1 & ~ACCEPT_INCOMPLETE;
+
+  /*
+   * smart mode, fastest parsing mode. accept lots of non standard json syntax
+   * ACCEPT_INCOMPLETE feature is enabled.
+   * @since 2.6
+   */
+  public static final int MODE_PERMISSIVE_WITH_INCOMPLETE = -1;
 
   /**
    * strict RFC4627 mode.

json-smart/src/main/java/net/minidev/json/parser/JSONParserBase.java

@@ -89,6 +89,7 @@ abstract class JSONParserBase {
   protected final boolean reject127;
   protected final boolean unrestictBigDigit;
   protected final boolean limitJsonDepth;
+  protected final boolean acceptIncomplete;
 
   public JSONParserBase(int permissiveMode) {
     this.acceptNaN = (permissiveMode & JSONParser.ACCEPT_NAN) > 0;
@@ -106,6 +107,7 @@ public JSONParserBase(int permissiveMode) {
     this.reject127 = (permissiveMode & JSONParser.REJECT_127_CHAR) > 0;
     this.unrestictBigDigit = (permissiveMode & JSONParser.BIG_DIGIT_UNRESTRICTED) > 0;
     this.limitJsonDepth = (permissiveMode & JSONParser.LIMIT_JSON_DEPTH) > 0;
+    this.acceptIncomplete = (permissiveMode & JSONParser.ACCEPT_INCOMPLETE) > 0;
   }
 
   public void checkControleChar() throws ParseException {
@@ -313,6 +315,10 @@ protected <T> T readArray(JsonReaderI<T> mapper) throws ParseException, IOExcept
           needData = true;
           continue;
         case EOI:
+          if (acceptIncomplete) {
+            this.depth--;
+            return mapper.convert(current);
+          }
           throw new ParseException(pos - 1, ERROR_UNEXPECTED_EOF, "EOF");
         default:
           mapper.addValue(current, readMain(mapper, stopArray));
@@ -491,6 +497,11 @@ protected Object readMain(JsonReaderI<?> mapper, boolean stop[])
           if (!acceptNonQuote) throw new ParseException(pos, ERROR_UNEXPECTED_TOKEN, xs);
           //
           return xs;
+        case EOI:
+          if (acceptIncomplete) {
+            return null;
+          }
+          throw new ParseException(pos - 1, ERROR_UNEXPECTED_EOF, "EOF");
         // digits
         case '0':
         case '1':
@@ -527,6 +538,7 @@ protected <T> T readObject(JsonReaderI<T> mapper) throws ParseException, IOExcep
     if (limitJsonDepth && ++this.depth > MAX_DEPTH) {
       throw new ParseException(pos, ERROR_UNEXPECTED_JSON_DEPTH, c);
     }
+    // Store the appropriate read method in a variable
     Object current = mapper.createObject();
     boolean needData = false;
     boolean acceptData = true;
@@ -572,7 +584,14 @@ protected <T> T readObject(JsonReaderI<T> mapper) throws ParseException, IOExcep
           skipSpace();
 
           if (c != ':') {
-            if (c == EOI) throw new ParseException(pos - 1, ERROR_UNEXPECTED_EOF, null);
+            if (c == EOI) {
+              if (acceptIncomplete) {
+                this.depth--;
+                mapper.setValue(current, key, null);
+                return mapper.convert(current);
+              }
+              throw new ParseException(pos - 1, ERROR_UNEXPECTED_EOF, null);
+            }
             throw new ParseException(pos - 1, ERROR_UNEXPECTED_CHAR, c);
           }
           readNoEnd(); /* skip : */
@@ -593,8 +612,13 @@ protected <T> T readObject(JsonReaderI<T> mapper) throws ParseException, IOExcep
             //
             return mapper.convert(current);
           }
-          if (c == EOI) // Fixed on 18/10/2011 reported by vladimir
-          throw new ParseException(pos - 1, ERROR_UNEXPECTED_EOF, null);
+          if (c == EOI) { // Fixed on 18/10/2011 reported by vladimir
+            if (acceptIncomplete) {
+              this.depth--;
+              return mapper.convert(current);
+            }
+            throw new ParseException(pos - 1, ERROR_UNEXPECTED_EOF, null);
+          }
           // if c==, continue
           if (c == ',') acceptData = needData = true;
           else throw new ParseException(pos - 1, ERROR_UNEXPECTED_TOKEN, c);
@@ -615,6 +639,10 @@ protected void readString2() throws ParseException, IOException {
       read();
       switch (c) {
         case EOI:
+          if (acceptIncomplete) {
+            xs = sb.toString();
+            return;
+          }
           throw new ParseException(pos - 1, ERROR_UNEXPECTED_EOF, null);
         case '"':
         case '\'':

json-smart/src/main/java/net/minidev/json/parser/JSONParserByteArray.java

@@ -96,6 +96,7 @@ protected void readS() {
   protected void readNoEnd() throws ParseException {
     if (++pos >= len) {
       this.c = EOI;
+      if (super.acceptIncomplete) return;
       throw new ParseException(pos - 1, ERROR_UNEXPECTED_EOF, "EOF");
     } else this.c = (char) in[pos];
   }

json-smart/src/main/java/net/minidev/json/parser/JSONParserMemory.java

@@ -113,7 +113,13 @@ protected void readString() throws ParseException, IOException {
       throw new ParseException(pos, ERROR_UNEXPECTED_CHAR, c);
     }
     int tmpP = indexOf(c, pos + 1);
-    if (tmpP == -1) throw new ParseException(len, ERROR_UNEXPECTED_EOF, null);
+    if (tmpP == -1) {
+      if (acceptIncomplete) {
+        readString2();
+        return;
+      }
+      throw new ParseException(len, ERROR_UNEXPECTED_EOF, null);
+    }
     extractString(pos + 1, tmpP);
     if (xs.indexOf('\\') == -1) {
       checkControleChar();

json-smart/src/main/java/net/minidev/json/parser/JSONParserReader.java

@@ -82,8 +82,11 @@ protected void readS() throws IOException {
 
   protected void readNoEnd() throws ParseException, IOException {
     int i = in.read();
-    if (i == -1) throw new ParseException(pos - 1, ERROR_UNEXPECTED_EOF, "EOF");
+    if (i == -1) {
+      this.c = EOI;
+      if (super.acceptIncomplete) return;
+      throw new ParseException(pos - 1, ERROR_UNEXPECTED_EOF, "EOF");
+    }
     c = (char) i;
-    //
   }
 }

json-smart/src/main/java/net/minidev/json/parser/JSONParserString.java

@@ -93,6 +93,7 @@ protected void readS() {
   protected void readNoEnd() throws ParseException {
     if (++pos >= len) {
       this.c = EOI;
+      if (super.acceptIncomplete) return;
       throw new ParseException(pos - 1, ERROR_UNEXPECTED_EOF, "EOF");
     } else this.c = in.charAt(pos);
   }

json-smart/src/test/java/net/minidev/json/test/JSONIncompletModeTest.java

@@ -0,0 +1,80 @@
+package net.minidev.json.test;
+
+import static org.junit.jupiter.api.Assertions.assertEquals;
+
+import net.minidev.json.JSONArray;
+import net.minidev.json.JSONObject;
+import net.minidev.json.parser.JSONParser;
+import org.junit.jupiter.api.Test;
+
+/** TODO make the same tests in stream and bytes mode */
+public class JSONIncompletModeTest {
+
+  @Test
+  public void testArraySimple() throws Exception {
+    String s = "[1";
+    JSONParser p = new JSONParser(JSONParser.MODE_JSON_SIMPLE | JSONParser.ACCEPT_INCOMPLETE);
+    JSONArray array = (JSONArray) p.parse(s);
+    assertEquals(Long.valueOf(1), (Long) array.get(0));
+  }
+
+  @Test
+  public void testArrayInObject1() throws Exception {
+    String s = "{\"obj\":[1";
+    String result = "{\"obj\":[1]}";
+
+    JSONParser p = new JSONParser(JSONParser.MODE_JSON_SIMPLE | JSONParser.ACCEPT_INCOMPLETE);
+    JSONObject array = (JSONObject) p.parse(s);
+    assertEquals(result, array.toJSONString());
+  }
+
+  @Test
+  public void testObjectCut() throws Exception {
+    String s = "{\"obj\":";
+    String result = "{\"obj\":null}";
+
+    JSONParser p = new JSONParser(JSONParser.MODE_JSON_SIMPLE | JSONParser.ACCEPT_INCOMPLETE);
+    JSONObject array = (JSONObject) p.parse(s);
+    assertEquals(result, array.toJSONString());
+  }
+
+  @Test
+  public void testObjectCut2() throws Exception {
+    String s = "{\"obj\"";
+    String result = "{\"obj\":null}";
+
+    JSONParser p = new JSONParser(JSONParser.MODE_JSON_SIMPLE | JSONParser.ACCEPT_INCOMPLETE);
+    JSONObject array = (JSONObject) p.parse(s);
+    assertEquals(result, array.toJSONString());
+  }
+
+  @Test
+  public void testObjectCut3() throws Exception {
+    String s = "{\"obj";
+    String result = "{\"obj\":null}";
+
+    JSONParser p = new JSONParser(JSONParser.MODE_JSON_SIMPLE | JSONParser.ACCEPT_INCOMPLETE);
+    JSONObject array = (JSONObject) p.parse(s);
+    assertEquals(result, array.toJSONString());
+  }
+
+  @Test
+  public void testObjectCut4() throws Exception {
+    String s = "{\"obj\":\"";
+    String result = "{\"obj\":\"\"}";
+
+    JSONParser p = new JSONParser(JSONParser.MODE_JSON_SIMPLE | JSONParser.ACCEPT_INCOMPLETE);
+    JSONObject array = (JSONObject) p.parse(s);
+    assertEquals(result, array.toJSONString());
+  }
+
+  @Test
+  public void testStringCut() throws Exception {
+    String s = "\"obj";
+    String result = "obj";
+
+    JSONParser p = new JSONParser(JSONParser.MODE_JSON_SIMPLE | JSONParser.ACCEPT_INCOMPLETE);
+    String array = (String) p.parse(s);
+    assertEquals(result, array);
+  }
+}