Repository navigation
Expand file tree
/
Copy pathJSONLimitStreamReader.java
More file actions
516 lines (473 loc) · 19.2 KB
/
Copy pathJSONLimitStreamReader.java
File metadata and controls
516 lines (473 loc) · 19.2 KB
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
package org.json.stream;
/*
Copyright (c) 2002 JSON.org
Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:
The above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software.
The Software shall be used for Good, not Evil.
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
SOFTWARE.
*/
import org.json.JSONException;
import org.json.JSONParseException;
import org.json.stream.JSONLexer.Token;
import java.io.InputStream;
import java.io.Reader;
import java.math.BigDecimal;
import java.math.BigInteger;
import java.nio.charset.Charset;
/**
* Reads a JSON document as a stream of JSON events, using secure principles
* derived from XML parsers. Uses an iterator model to produce each event.
* Similar to a StAX event model in XML processing.
* <p>
* The {@code JSONLimitStreamReader} class is similar to the {@code JSONStreamReader}
* class, but intended to be more robust against untrusted JSON sources.
* For a more robust solution to building object structures, see
* {@link JSONLimitBuilder}.
* </p>
* <p>
* A simple example of how to use this class:</p>
* <pre>
* JSONLimitStreamReader reader = new JSONLimitStreamReader(JSON_TEXT);
* reader.withLimits(BuilderLimits.secureDefaults());
*
* while(reader.hasNext()) {
* ParseState state = reader.nextState();
* switch(state) {
* case KEY:
* System.out.println("KEY = " + reader.nextKey() );
* break;
* case NULL_VALUE:
* case BOOLEAN_VALUE:
* case NUMBER_VALUE:
* case STRING_VALUE:
* System.out.println(state + " = " + reader.nextValue());
* break;
* default:
* System.out.println(state);
* }
* }
* </pre>
* <p>
* For a streaming equivalent for writing JSON data, see the {@link org.json.JSONWriter}
* and {@link org.json.JSONStringer} classes.</p>
* @author JSON.org
* @version 2016-06-26
*/
public final class JSONLimitStreamReader extends JSONStreamReader {
private int keyLength = Integer.MAX_VALUE;
private int stringLength = Integer.MAX_VALUE;
private int mantissaDigits = Short.MAX_VALUE;
private int exponentDigits = Byte.MAX_VALUE;
/**
* Construct a {@code JSONStreamReader} from a {@code Reader}.
*
* @param reader A reader.
*/
public JSONLimitStreamReader(Reader reader) {
super(reader);
}
/**
* Construct a {@code JSONStreamReader} from an {@code InputStream} and
* a supplied {@code Charset}.
*
* @param inputStream the input stream containing the JSON data
* @param charset the character set with which to interpret the
* input stream
*/
public JSONLimitStreamReader(InputStream inputStream, Charset charset) {
super(inputStream, charset);
}
/**
* Construct a {@code JSONStreamReader} from a {@code String}.
*
* @param s A source string.
*/
public JSONLimitStreamReader(String s) {
super(s);
}
/**
* Set keyLength, stringLength, mantissaDigits, and exponentDigits
* using values from the supplied {@link BuilderLimits} object.
* <p>
* See {@link BuilderLimits#secureDefaults()} for some practical limits.</p>
*
* @param limits the limits to be set
* @return this object
*/
public JSONLimitStreamReader withLimits(BuilderLimits limits) {
this.keyLength = limits.getKeyLength();
this.stringLength = limits.getStringLength();
this.mantissaDigits = limits.getMantissaDigits();
this.exponentDigits = limits.getExponentDigits();
return this;
}
/**
* The maximum length of any key.
*
* @param keyLength the maximum length of any key
*/
public void setKeyLength(int keyLength) {
this.keyLength = (keyLength <= 0) ? Integer.MAX_VALUE : keyLength;
}
/**
* The maximum length of any string value.
*
* @param stringLength the maximum length of any string value
*/
public void setStringLength(int stringLength) {
this.stringLength = (stringLength <= 0) ? Integer.MAX_VALUE : stringLength;
}
/**
* The maximum number of mantissa digits in a number.
*
* @param mantissaDigits the maximum number of mantissa digits of any
* number value
*/
public void setMantissaDigits(int mantissaDigits) {
this.mantissaDigits = (mantissaDigits <= 0) ? Short.MAX_VALUE : mantissaDigits;
}
/**
* The maximum number of exponent digits in a number. May be 0 to indicate
* integer-only values.
*
* @param exponentDigits the maximum number of exponent digits of any
* number value
*/
public void setExponentDigits(int exponentDigits) {
this.exponentDigits = (exponentDigits < 0) ? Byte.MAX_VALUE : exponentDigits;
}
/**
* If the {@code ParseState} was {@link JSONStreamReader.ParseState#KEY},
* return the text of the key name.
* <p>
* This method advances the parser onto the next state.</p>
*
* @return the parsed text of the key
* @throws JSONException there was a problem with the source stream
*/
@Override
public String nextKey() throws JSONException {
if(state != ParseState.KEY) {
throw new JSONParseException("Invalid state", lexer.parsePosition());
}
StringBuilder builder = lexer.nextString(new StringBuilder(), keyLength);
state = ParseState.KEY_SEPARATOR;
if(lexer.nextTokenType() != Token.KEY_SEPARATOR) {
throw new JSONParseException("Expected key separator", lexer.parsePosition());
}
return builder.toString();
}
/**
* If the {@code ParseState} was {@link JSONStreamReader.ParseState#NULL_VALUE},
* {@link JSONStreamReader.ParseState#BOOLEAN_VALUE},
* {@link JSONStreamReader.ParseState#NUMBER_VALUE}, or
* {@link JSONStreamReader.ParseState#STRING_VALUE}, return the value as
* an {@code Object}. The values that can be returned here are:
* <ul>
* <li>{@code JSONObject.NULL}</li>
* <li>{@code Boolean.TRUE} or {@code Boolean.FALSE}</li>
* <li>A {@code Double}, {@code Long}, {@code Integer},
* {@code BigInteger}, or {@code BigDecimal}</li>
* <li>A {@code String}</li>
* </ul>
* <p>
* This method advances the parser onto the next state.</p>
*
* @return an Object of the type described above
*/
@Override
public Object nextValue() throws JSONException {
if (objectStack.isEmpty() || !state.isValue()) {
throw new JSONParseException("Invalid state", lexer.parsePosition());
}
Token token = objectStack.pop();
switch(token) {
case NULL_VALUE:
state = ParseState.VALUE_SEPARATOR;
return decodeNull();
case TRUE_VALUE:
state = ParseState.VALUE_SEPARATOR;
return Boolean.TRUE;
case FALSE_VALUE:
state = ParseState.VALUE_SEPARATOR;
return Boolean.FALSE;
case STRING_VALUE:
state = ParseState.VALUE_SEPARATOR;
return lexer.nextString(new StringBuilder(), stringLength).toString();
case NUMBER_VALUE: {
state = ParseState.VALUE_SEPARATOR;
StringBuilder sb = new StringBuilder();
boolean isDbl = lexer.nextNumber(sb, mantissaDigits, exponentDigits);
return decodeNumber(sb.toString(), isDbl);
}
default:
throw new JSONParseException("Invalid state", lexer.parsePosition());
}
}
/**
* If the {@code ParseState} was {@link JSONStreamReader.ParseState#STRING_VALUE},
* return the value as a {@code String}.
* <p>
* This method advances the parser onto the next state.</p>
*
* @return a String value
*/
@Override
public String nextStringValue() throws JSONException {
if ((state != ParseState.STRING_VALUE) || (objectStack.isEmpty())) {
throw new JSONParseException("Invalid state", lexer.parsePosition());
}
Token token = objectStack.pop();
if (token == Token.STRING_VALUE) {
state = ParseState.VALUE_SEPARATOR;
return lexer.nextString(new StringBuilder(), stringLength).toString();
} else {
throw new JSONParseException("Invalid state", lexer.parsePosition());
}
}
/**
* If the {@code ParseState} was {@link ParseState#STRING_VALUE},
* append the decoded value to the given {@code Appendable}.
* <p>
* This method is suitable for cases where very long {@code String} data is
* expected, for instance for base-64 encoded data.</p>
* <p>
* This method advances the parser onto the next state.</p>
*
* @param <T> the type of Appendable, returned to the caller
* @param limit the limit of how many decoded characters to append to
* the Appendable
* @param writer the writer to which the String value will be written
* @return the given Appendable object
*/
public <T extends Appendable> T appendNextStringValue(T writer, long limit) throws JSONException {
if ((state != ParseState.STRING_VALUE) || (objectStack.isEmpty())) {
throw new JSONParseException("Invalid state", lexer.parsePosition());
}
if(writer == null) {
throw new JSONException("writer is null");
}
Token token = objectStack.pop();
if (token == Token.STRING_VALUE) {
try {
state = ParseState.VALUE_SEPARATOR;
BufferedAppendable buff = bufferedAppender.with(writer);
try {
lexer.nextString(buff, limit);
} finally {
buff.close();
}
return writer;
} catch (IOException e) {
throw new JSONParseException("Error parsing string value", e,
lexer.parsePosition());
}
} else {
throw new JSONParseException("Invalid state", lexer.parsePosition());
}
}
/**
* If the {@code ParseState} was {@link JSONStreamReader.ParseState#NUMBER_VALUE},
* return the value as a {@code Number}.
* <p>
* The number type returned is one of:</p>
* <ul>
* <li>A {@code Double}</li>
* <li>A {@code Long}</li>
* <li>An {@code Integer}</li>
* <li>A {@code BigDecimal}</li>
* <li>A {@code BigInteger}</li>
* </ul>
* <p>
* This method advances the parser onto the next state.</p>
*
* @return a value that is a subclass of the {@code Number} class
*/
@Override
public Number nextNumberValue() throws JSONException {
if ((state != ParseState.NUMBER_VALUE) || (objectStack.isEmpty())) {
throw new JSONParseException("Invalid state", lexer.parsePosition());
}
Token token = objectStack.pop();
if (token == Token.NUMBER_VALUE) {
state = ParseState.VALUE_SEPARATOR;
StringBuilder sb = new StringBuilder();
boolean isDbl = lexer.nextNumber(sb, mantissaDigits, exponentDigits);
return decodeNumber(sb.toString(), isDbl);
} else {
throw new JSONParseException("Invalid state", lexer.parsePosition());
}
}
/**
* If the {@code ParseState} was {@link JSONStreamReader.ParseState#NUMBER_VALUE},
* append the number sequence to the given {@code Appendable}.
* <p>
* This method is suitable for cases where the caller wishes to perform
* their own conversion of number values into a corresponding Object type.
* </p>
* <p>
* This method advances the parser onto the next state.</p>
*
* @param <T> the type of Appendable, returned to the caller
* @param writer the writer to which the number sequence will be written
* @return the given Appendable object
*/
@Override
public <T extends Appendable> T appendNextNumberValue(T writer) throws JSONException {
if ((state != ParseState.NUMBER_VALUE) || (objectStack.isEmpty())) {
throw new JSONParseException("Invalid state", lexer.parsePosition());
}
Token token = objectStack.pop();
if (token == Token.NUMBER_VALUE) {
state = ParseState.VALUE_SEPARATOR;
lexer.nextNumber(writer, mantissaDigits, exponentDigits);
return writer;
} else {
throw new JSONParseException("Invalid state", lexer.parsePosition());
}
}
/**
* If the {@code ParseState} was {@link JSONStreamReader.ParseState#NUMBER_VALUE},
* return the value as a {@code BigDecimal}.
* <p>
* This method advances the parser onto the next state.</p>
*
* @return a number value as a {@code BigDecimal} class
*/
@Override
public BigDecimal nextBigDecimalValue() throws JSONException {
if ((state != ParseState.NUMBER_VALUE) || (objectStack.isEmpty())) {
throw new JSONParseException("Invalid state", lexer.parsePosition());
}
Token token = objectStack.pop();
if (token == Token.NUMBER_VALUE) {
state = ParseState.VALUE_SEPARATOR;
StringBuilder sb = new StringBuilder();
lexer.nextNumber(sb, mantissaDigits, exponentDigits);
return decodeBigDecimal(sb.toString());
} else {
throw new JSONParseException("Invalid state", lexer.parsePosition());
}
}
/**
* If the {@code ParseState} was {@link JSONStreamReader.ParseState#NUMBER_VALUE},
* return the value as a {@code BigInteger}.
* <p>
* If the JSON value is not parseable as a big integer, as defined by the
* JSON grammar, a {@code JSONException} will be thrown.</p>
* <p>
* This method advances the parser onto the next state.</p>
*
* @return a number value as a {@code BigInteger} class
*/
@Override
public BigInteger nextBigIntegerValue() throws JSONException {
if ((state != ParseState.NUMBER_VALUE) || (objectStack.isEmpty())) {
throw new JSONParseException("Invalid state", lexer.parsePosition());
}
Token token = objectStack.pop();
if (token == Token.NUMBER_VALUE) {
state = ParseState.VALUE_SEPARATOR;
StringBuilder sb = new StringBuilder();
boolean isDbl = lexer.nextNumber(sb, mantissaDigits, exponentDigits);
return decodeBigInteger(sb.toString(), isDbl);
} else {
throw new JSONParseException("Invalid state", lexer.parsePosition());
}
}
/**
* If the {@code ParseState} was {@link JSONStreamReader.ParseState#NUMBER_VALUE},
* return the value as a double.
* <p>
* This method advances the parser onto the next state.</p>
*
* @return a double value
*/
@Override
public double nextDoubleValue() throws JSONException {
if ((state != ParseState.NUMBER_VALUE) || (objectStack.isEmpty())) {
throw new JSONParseException("Invalid state", lexer.parsePosition());
}
Token token = objectStack.pop();
if (token == Token.NUMBER_VALUE) {
state = ParseState.VALUE_SEPARATOR;
StringBuilder sb = new StringBuilder();
boolean isDbl = lexer.nextNumber(sb, mantissaDigits, exponentDigits);
return decodeDouble(sb.toString(), isDbl);
} else {
throw new JSONParseException("Invalid state", lexer.parsePosition());
}
}
/**
* If the {@code ParseState} was {@link JSONStreamReader.ParseState#NUMBER_VALUE},
* return the value as an int.
* <p>
* If the JSON value is not parseable as an int, as defined by the JSON
* grammar, a {@code JSONException} will be thrown.</p>
* <p>
* This method advances the parser onto the next state.</p>
*
* @return an int value
*/
@Override
public int nextIntValue() throws JSONException {
if ((state != ParseState.NUMBER_VALUE) || (objectStack.isEmpty())) {
throw new JSONParseException("Invalid state", lexer.parsePosition());
}
Token token = objectStack.pop();
if (token == Token.NUMBER_VALUE) {
state = ParseState.VALUE_SEPARATOR;
StringBuilder sb = new StringBuilder();
boolean isDbl = lexer.nextNumber(sb, mantissaDigits, exponentDigits);
return decodeInt(sb.toString(), isDbl);
} else {
throw new JSONParseException("Invalid state", lexer.parsePosition());
}
}
/**
* If the {@code ParseState} was {@link JSONStreamReader.ParseState#NUMBER_VALUE},
* return the value as a long.
* <p>
* If the JSON value is not parseable as a long, as defined by the JSON
* grammar, a {@code JSONException} will be thrown.</p>
* <p>
* This method advances the parser onto the next state.</p>
*
* @return a long value
*/
@Override
public long nextLongValue() throws JSONException {
if ((state != ParseState.NUMBER_VALUE) || (objectStack.isEmpty())) {
throw new JSONParseException("Invalid state", lexer.parsePosition());
}
Token token = objectStack.pop();
if (token == Token.NUMBER_VALUE) {
state = ParseState.VALUE_SEPARATOR;
StringBuilder sb = new StringBuilder();
boolean isDbl = lexer.nextNumber(sb, mantissaDigits, exponentDigits);
return decodeLong(sb.toString(), isDbl);
} else {
throw new JSONParseException("Invalid state", lexer.parsePosition());
}
}
/**
* Returns a string representation of the stream reader, including its
* current position in the source stream.
*/
@Override
public String toString() {
return "JSONSecStreamReader " + lexer.parsePosition().getPositionDetails();
}
}