JSON-java/src/main/java/org/json/XML.java at master · valfirst/JSON-java · GitHub

History

883 lines (808 loc) · 34.4 KB

Raw

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

517

518

519

520

521

522

523

524

525

526

527

528

529

530

531

532

533

534

535

536

537

538

539

540

541

542

543

544

545

546

547

548

549

550

551

552

553

554

555

556

557

558

559

560

561

562

563

564

565

566

567

568

569

570

571

572

573

574

575

576

577

578

579

580

581

582

583

584

585

586

587

588

589

590

591

592

593

594

595

596

597

598

599

600

601

602

603

604

605

606

607

608

609

610

611

612

613

614

615

616

617

618

619

620

621

622

623

624

625

626

627

628

629

630

631

632

633

634

635

636

637

638

639

640

641

642

643

644

645

646

647

648

649

650

651

652

653

654

655

656

657

658

659

660

661

662

663

664

665

666

667

668

669

670

671

672

673

674

675

676

677

678

679

680

681

682

683

684

685

686

687

688

689

690

691

692

693

694

695

696

697

698

699

700

701

702

703

704

705

706

707

708

709

710

711

712

713

714

715

716

717

718

719

720

721

722

723

724

725

726

727

728

729

730

731

732

733

734

735

736

737

738

739

740

741

742

743

744

745

746

747

748

749

750

751

752

753

754

755

756

757

758

759

760

761

762

763

764

765

766

767

768

769

770

771

772

773

774

775

776

777

778

779

780

781

782

783

784

785

786

787

788

789

790

791

792

793

794

795

796

797

798

799

800

801

802

803

804

805

806

807

808

809

810

811

812

813

814

815

816

817

818

819

820

821

822

823

824

825

826

827

828

829

830

831

832

833

834

835

836

837

838

839

840

841

842

843

844

845

846

847

848

849

850

851

852

853

854

855

856

857

858

859

860

861

862

863

864

865

866

867

868

869

870

871

872

873

874

875

876

877

878

879

880

881

882

883

package org.json;

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 java.io.Reader;

import java.io.StringReader;

import java.math.BigDecimal;

import java.math.BigInteger;

import java.util.Iterator;

/**

* This provides static methods to convert an XML text into a JSONObject, and to

* covert a JSONObject into an XML text.

* @author JSON.org

* @version 2016-08-10

@SuppressWarnings("boxing")

public class XML {

/** The Character '&'. */

public static final Character AMP = '&';

/** The Character '''. */

public static final Character APOS = '\'';

/** The Character '!'. */

public static final Character BANG = '!';

/** The Character '='. */

public static final Character EQ = '=';

/** The Character <pre>{@code '>'. }</pre>*/

public static final Character GT = '>';

/** The Character '<'. */

public static final Character LT = '<';

/** The Character '?'. */

public static final Character QUEST = '?';

/** The Character '"'. */

public static final Character QUOT = '"';

/** The Character '/'. */

public static final Character SLASH = '/';

/**

* Null attribute name

public static final String NULL_ATTR = "xsi:nil";

public static final String TYPE_ATTR = "xsi:type";

/**

* Creates an iterator for navigating Code Points in a string instead of

* characters. Once Java7 support is dropped, this can be replaced with

* <code>

* string.codePoints()

* </code>

* which is available in Java8 and above.

* @see <a href=

* "http://stackoverflow.com/a/21791059/6030888">http://stackoverflow.com/a/21791059/6030888</a>

private static Iterable<Integer> codePointIterator(final String string) {

return new Iterable<Integer>() {

@Override

public Iterator<Integer> iterator() {

return new Iterator<Integer>() {

private int nextIndex = 0;

private int length = string.length();

@Override

public boolean hasNext() {

return this.nextIndex < this.length;

}

@Override

public Integer next() {

int result = string.codePointAt(this.nextIndex);

this.nextIndex += Character.charCount(result);

return result;

}

@Override

public void remove() {

throw new UnsupportedOperationException();

}

};

}

};

}

/**

* Replace special characters with XML escapes:

* <pre>{@code

* & (ampersand) is replaced by &amp;

* < (less than) is replaced by &lt;

* > (greater than) is replaced by &gt;

* " (double quote) is replaced by &quot;

* ' (single quote / apostrophe) is replaced by &apos;

* }</pre>

* @param string

* The string to be escaped.

* @return The escaped string.

public static String escape(String string) {

StringBuilder sb = new StringBuilder(string.length());

for (final int cp : codePointIterator(string)) {

switch (cp) {

case '&':

sb.append("&");

break;

case '<':

sb.append("<");

break;

case '>':

sb.append(">");

break;

case '"':

sb.append(""");

break;

case '\'':

sb.append("'");

break;

default:

if (mustEscape(cp)) {

sb.append("&#x");

sb.append(Integer.toHexString(cp));

sb.append(';');

} else {

sb.appendCodePoint(cp);

}

return sb.toString();

}

/**

* @param cp code point to test

* @return true if the code point is not valid for an XML

private static boolean mustEscape(int cp) {

/* Valid range from https://www.w3.org/TR/REC-xml/#charsets

* #x9 | #xA | #xD | [#x20-#xD7FF] | [#xE000-#xFFFD] | [#x10000-#x10FFFF]

* any Unicode character, excluding the surrogate blocks, FFFE, and FFFF.

// isISOControl is true when (cp >= 0 && cp <= 0x1F) || (cp >= 0x7F && cp <= 0x9F)

// all ISO control characters are out of range except tabs and new lines

return (Character.isISOControl(cp)

&& cp != 0x9

&& cp != 0xA

&& cp != 0xD

) || !(

// valid the range of acceptable characters that aren't control

(cp >= 0x20 && cp <= 0xD7FF)

|| (cp >= 0xE000 && cp <= 0xFFFD)

|| (cp >= 0x10000 && cp <= 0x10FFFF)

)

;

}

/**

* Removes XML escapes from the string.

* @param string

* string to remove escapes from

* @return string with converted entities

public static String unescape(String string) {

StringBuilder sb = new StringBuilder(string.length());

for (int i = 0, length = string.length(); i < length; i++) {

char c = string.charAt(i);

if (c == '&') {

final int semic = string.indexOf(';', i);

if (semic > i) {

final String entity = string.substring(i + 1, semic);

sb.append(XMLTokener.unescapeEntity(entity));

// skip past the entity we just parsed.

i += entity.length() + 1;

} else {

// this shouldn't happen in most cases since the parser

// errors on unclosed entries.

sb.append(c);

}

} else {

// not part of an entity

sb.append(c);

}

return sb.toString();

}

/**

* Throw an exception if the string contains whitespace. Whitespace is not

* allowed in tagNames and attributes.

* @param string

* A string.

* @throws JSONException Thrown if the string contains whitespace or is empty.

public static void noSpace(String string) throws JSONException {

int i, length = string.length();

if (length == 0) {

throw new JSONException("Empty string.");

}

for (i = 0; i < length; i += 1) {

if (Character.isWhitespace(string.charAt(i))) {

throw new JSONException("'" + string

+ "' contains a space character.");

}

/**

* Scan the content following the named tag, attaching it to the context.

* @param x

* The XMLTokener containing the source string.

* @param context

* The JSONObject that will include the new material.

* @param name

* The tag name.

* @return true if the close tag is processed.

* @throws JSONException

private static boolean parse(XMLTokener x, JSONObject context, String name, XMLParserConfiguration config)

throws JSONException {

char c;

int i;

JSONObject jsonObject = null;

String string;

String tagName;

Object token;

XMLXsiTypeConverter<?> xmlXsiTypeConverter;

// Test for and skip past these forms:

//

// <! ... >

// <![ ... ]]>

// <? ... ?>

// Report errors for these forms:

// <>

// <=

// <<

token = x.nextToken();

// <!

if (token == BANG) {

c = x.next();

if (c == '-') {

if (x.next() == '-') {

x.skipPast("-->");

return false;

}

x.back();

} else if (c == '[') {

token = x.nextToken();

if ("CDATA".equals(token)) {

if (x.next() == '[') {

string = x.nextCDATA();

if (string.length() > 0) {

context.accumulate(config.getcDataTagName(), string);

}

return false;

}

throw x.syntaxError("Expected 'CDATA['");

}

i = 1;

do {

token = x.nextMeta();

if (token == null) {

throw x.syntaxError("Missing '>' after '<!'.");

} else if (token == LT) {

i += 1;

} else if (token == GT) {

i -= 1;

}

} while (i > 0);

return false;

} else if (token == QUEST) {

// <?

x.skipPast("?>");

return false;

} else if (token == SLASH) {

// Close tag </

token = x.nextToken();

if (name == null) {

throw x.syntaxError("Mismatched close tag " + token);

}

if (!token.equals(name)) {

throw x.syntaxError("Mismatched " + name + " and " + token);

}

if (x.nextToken() != GT) {

throw x.syntaxError("Misshaped close tag");

}

return true;

} else if (token instanceof Character) {

throw x.syntaxError("Misshaped tag");

// Open tag <

} else {

tagName = (String) token;

token = null;

jsonObject = new JSONObject();

boolean nilAttributeFound = false;

xmlXsiTypeConverter = null;

for (;;) {

if (token == null) {

token = x.nextToken();

}

// attribute = value

if (token instanceof String) {

string = (String) token;

token = x.nextToken();

if (token == EQ) {

token = x.nextToken();

if (!(token instanceof String)) {

throw x.syntaxError("Missing value");

}

if (config.isConvertNilAttributeToNull()

&& NULL_ATTR.equals(string)

&& Boolean.parseBoolean((String) token)) {

nilAttributeFound = true;

} else if(config.getXsiTypeMap() != null && !config.getXsiTypeMap().isEmpty()

&& TYPE_ATTR.equals(string)) {

xmlXsiTypeConverter = config.getXsiTypeMap().get(token);

} else if (!nilAttributeFound) {

jsonObject.accumulate(string,

config.isKeepStrings()

? ((String) token)

: stringToValue((String) token));

}

token = null;

} else {

jsonObject.accumulate(string, "");

}

} else if (token == SLASH) {

// Empty tag <.../>

if (x.nextToken() != GT) {

throw x.syntaxError("Misshaped tag");

}

if (config.getForceList().contains(tagName)) {

// Force the value to be an array

if (nilAttributeFound) {

context.append(tagName, JSONObject.NULL);

} else if (jsonObject.length() > 0) {

context.append(tagName, jsonObject);

} else {

context.put(tagName, new JSONArray());

}

} else {

if (nilAttributeFound) {

context.accumulate(tagName, JSONObject.NULL);

} else if (jsonObject.length() > 0) {

context.accumulate(tagName, jsonObject);

} else {

context.accumulate(tagName, "");

}

return false;

} else if (token == GT) {

// Content, between <...> and </...>

for (;;) {

token = x.nextContent();

if (token == null) {

if (tagName != null) {

throw x.syntaxError("Unclosed tag " + tagName);

}

return false;

} else if (token instanceof String) {

string = (String) token;

if (string.length() > 0) {

if(xmlXsiTypeConverter != null) {

jsonObject.accumulate(config.getcDataTagName(),

stringToValue(string, xmlXsiTypeConverter));

} else {

jsonObject.accumulate(config.getcDataTagName(),

config.isKeepStrings() ? string : stringToValue(string));

}

} else if (token == LT) {

// Nested element

if (parse(x, jsonObject, tagName, config)) {

if (config.getForceList().contains(tagName)) {

// Force the value to be an array

if (jsonObject.length() == 0) {

context.put(tagName, new JSONArray());

} else if (jsonObject.length() == 1

&& jsonObject.opt(config.getcDataTagName()) != null) {

context.append(tagName, jsonObject.opt(config.getcDataTagName()));

} else {

context.append(tagName, jsonObject);

}

} else {

if (jsonObject.length() == 0) {

context.accumulate(tagName, "");

} else if (jsonObject.length() == 1

&& jsonObject.opt(config.getcDataTagName()) != null) {

context.accumulate(tagName, jsonObject.opt(config.getcDataTagName()));

} else {

context.accumulate(tagName, jsonObject);

}

return false;

}

} else {

throw x.syntaxError("Misshaped tag");

}

/**

* This method tries to convert the given string value to the target object

* @param string String to convert

* @param typeConverter value converter to convert string to integer, boolean e.t.c

* @return JSON value of this string or the string

public static Object stringToValue(String string, XMLXsiTypeConverter<?> typeConverter) {

if(typeConverter != null) {

return typeConverter.convert(string);

}

return stringToValue(string);

}

/**

* This method is the same as {@link JSONObject#stringToValue(String)}.

* @param string String to convert

* @return JSON value of this string or the string

// To maintain compatibility with the Android API, this method is a direct copy of

// the one in JSONObject. Changes made here should be reflected there.

// This method should not make calls out of the XML object.

public static Object stringToValue(String string) {

if ("".equals(string)) {

return string;

}

// check JSON key words true/false/null

if ("true".equalsIgnoreCase(string)) {

return Boolean.TRUE;

}

if ("false".equalsIgnoreCase(string)) {

return Boolean.FALSE;

}

if ("null".equalsIgnoreCase(string)) {

return JSONObject.NULL;

}

* If it might be a number, try converting it. If a number cannot be

* produced, then the value will just be a string.

char initial = string.charAt(0);

if ((initial >= '0' && initial <= '9') || initial == '-') {

try {

return stringToNumber(string);

} catch (Exception ignore) {

}

return string;

}

/**

* direct copy of {@link JSONObject#stringToNumber(String)} to maintain Android support.

private static Number stringToNumber(final String val) throws NumberFormatException {

char initial = val.charAt(0);

if ((initial >= '0' && initial <= '9') || initial == '-') {

// decimal representation

if (isDecimalNotation(val)) {

// Use a BigDecimal all the time so we keep the original

// representation. BigDecimal doesn't support -0.0, ensure we

// keep that by forcing a decimal.

try {

BigDecimal bd = new BigDecimal(val);

if(initial == '-' && BigDecimal.ZERO.compareTo(bd)==0) {

return Double.valueOf(-0.0);

}

return bd;

} catch (NumberFormatException retryAsDouble) {

// this is to support "Hex Floats" like this: 0x1.0P-1074

try {

Double d = Double.valueOf(val);

if(d.isNaN() || d.isInfinite()) {

throw new NumberFormatException("val ["+val+"] is not a valid number.");

}

return d;

} catch (NumberFormatException ignore) {

throw new NumberFormatException("val ["+val+"] is not a valid number.");

}

// block items like 00 01 etc. Java number parsers treat these as Octal.

if(initial == '0' && val.length() > 1) {

char at1 = val.charAt(1);

if(at1 >= '0' && at1 <= '9') {

throw new NumberFormatException("val ["+val+"] is not a valid number.");

}

} else if (initial == '-' && val.length() > 2) {

char at1 = val.charAt(1);

char at2 = val.charAt(2);

if(at1 == '0' && at2 >= '0' && at2 <= '9') {

throw new NumberFormatException("val ["+val+"] is not a valid number.");

}

// integer representation.

// This will narrow any values to the smallest reasonable Object representation

// (Integer, Long, or BigInteger)

// BigInteger down conversion: We use a similar bitLength compare as

// BigInteger#intValueExact uses. Increases GC, but objects hold

// only what they need. i.e. Less runtime overhead if the value is

// long lived.

BigInteger bi = new BigInteger(val);

if(bi.bitLength() <= 31){

return Integer.valueOf(bi.intValue());

}

if(bi.bitLength() <= 63){

return Long.valueOf(bi.longValue());

}

return bi;

}

throw new NumberFormatException("val ["+val+"] is not a valid number.");

}

/**

* direct copy of {@link JSONObject#isDecimalNotation(String)} to maintain Android support.

private static boolean isDecimalNotation(final String val) {

return val.indexOf('.') > -1 || val.indexOf('e') > -1

|| val.indexOf('E') > -1 || "-0".equals(val);

}

/**

* Convert a well-formed (but not necessarily valid) XML string into a

* JSONObject. Some information may be lost in this transformation because

* JSON is a data format and XML is a document format. XML uses elements,

* attributes, and content text, while JSON uses unordered collections of

* name/value pairs and arrays of values. JSON does not does not like to

* distinguish between elements and attributes. Sequences of similar

* elements are represented as JSONArrays. Content text may be placed in a

* "content" member. Comments, prologs, DTDs, and <pre>{@code

* <[ [ ]]>}</pre>

* are ignored.

* @param string

* The source string.

* @return A JSONObject containing the structured data from the XML string.

* @throws JSONException Thrown if there is an errors while parsing the string

public static JSONObject toJSONObject(String string) throws JSONException {

return toJSONObject(string, XMLParserConfiguration.ORIGINAL);

}

/**

* Convert a well-formed (but not necessarily valid) XML into a

* JSONObject. Some information may be lost in this transformation because

* JSON is a data format and XML is a document format. XML uses elements,

* attributes, and content text, while JSON uses unordered collections of

* name/value pairs and arrays of values. JSON does not does not like to

* distinguish between elements and attributes. Sequences of similar

* elements are represented as JSONArrays. Content text may be placed in a

* "content" member. Comments, prologs, DTDs, and <pre>{@code

* <[ [ ]]>}</pre>

* are ignored.

* @param reader The XML source reader.

* @return A JSONObject containing the structured data from the XML string.

* @throws JSONException Thrown if there is an errors while parsing the string

public static JSONObject toJSONObject(Reader reader) throws JSONException {

return toJSONObject(reader, XMLParserConfiguration.ORIGINAL);