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
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
|
/*
* This file is part of the LibreOffice project.
*
* This Source Code Form is subject to the terms of the Mozilla Public
* License, v. 2.0. If a copy of the MPL was not distributed with this
* file, You can obtain one at http://mozilla.org/MPL/2.0/.
*
* This file incorporates work covered by the following license notice:
*
* Licensed to the Apache Software Foundation (ASF) under one or more
* contributor license agreements. See the NOTICE file distributed
* with this work for additional information regarding copyright
* ownership. The ASF licenses this file to you under the Apache
* License, Version 2.0 (the "License"); you may not use this file
* except in compliance with the License. You may obtain a copy of
* the License at http://www.apache.org/licenses/LICENSE-2.0 .
*/
package util;
import java.io.PrintWriter;
import java.util.ArrayList;
import java.util.HashMap;
import java.util.HashSet;
import java.util.Iterator;
import com.sun.star.beans.PropertyValue;
import com.sun.star.xml.sax.XAttributeList;
import com.sun.star.xml.sax.XDocumentHandler;
import com.sun.star.xml.sax.XLocator;
public class XMLTools {
/**
* The implementation of <code>com.sun.star.xml.sax.XAttributeList</code>
* where attributes and their values can be added.
*/
public static class AttributeList implements XAttributeList {
private static class Attribute {
public String Name ;
public String Type ;
public String Value ;
}
private HashMap<String, Attribute> attrByName = new HashMap<String, Attribute>() ;
private ArrayList<Attribute> attributes = new ArrayList<Attribute>() ;
private PrintWriter log = null ;
/**
* Creates a class instance.
*/
public AttributeList() {}
/**
* Constructs a list which will report to <code>log</code>
* specified about each <code>XDocumentHandler</code> method
* call.
*/
public AttributeList(PrintWriter log) {
this.log = log ;
}
private AttributeList(XAttributeList list) {
if (list == null) return ;
for (short i = 0; i < list.getLength(); i++) {
add(list.getNameByIndex(i), list.getTypeByIndex(i),
list.getValueByIndex(i)) ;
}
}
/**
* Adds an attribute with type and value specified.
* @param name The attribute name.
* @param type Value type (usually 'CDATA' used).
* @param value Attribute value.
*/
public void add(String name, String type, String value) {
Attribute attr = new Attribute() ;
attr.Name = name ;
attr.Type = type ;
attr.Value = value ;
attributes.add(attr) ;
attrByName.put(attr.Name, attr) ;
}
/***************************************
* XAttributeList methods
****************************************/
public short getLength() {
if (log != null)
log.println("getLength() called -> " + attributes.size()) ;
return (short) attributes.size() ;
}
public String getNameByIndex(short idx) {
String name = attributes.get(idx).Name ;
if (log != null)
log.println("getNameByIndex(" + idx + ") called -> '" +
name + "'") ;
return name ;
}
public String getTypeByIndex(short idx) {
String type = attributes.get(idx).Type ;
if (log != null)
log.println("getTypeByIndex(" + idx + ") called -> '" +
type + "'") ;
return type;
}
public String getTypeByName(String name) {
String type = attrByName.get(name).Type ;
if (log != null)
log.println("getTypeByName('" + name + "') called -> '" +
type + "'") ;
return type;
}
public String getValueByIndex(short idx) {
String value = attributes.get(idx).Value ;
if (log != null)
log.println("getValueByIndex(" + idx + ") called -> '" +
value + "'") ;
return value;
}
public String getValueByName(String name) {
String value = attrByName.get(name).Value ;
if (log != null)
log.println("getValueByName('" + name + "') called -> '" +
value + "'") ;
return value;
}
}
/**
* This class writes all XML data handled into a stream specified
* in the constructor.
*/
private static class XMLWriter implements XDocumentHandler {
private PrintWriter _log = null ;
private String align = "" ;
/**
* Creates a SAX handler which writes all XML data
* handled into a <code>log</code> stream specified.
*/
private XMLWriter(PrintWriter log) {
_log = log ;
}
/**
* Creates a SAX handler which does nothing.
*/
public XMLWriter() {
}
public void processingInstruction(String appl, String data) {
if (_log == null) return ;
_log.println(align + "<?" + appl + " " + data + "?>") ;
}
public void startDocument() {
if (_log == null) return ;
_log.println("START DOCUMENT:") ;
}
public void endDocument() {
if (_log == null) return ;
_log.println("END DOCUMENT:") ;
}
public void setDocumentLocator(XLocator loc) {
if (_log == null) return ;
_log.println("DOCUMENT LOCATOR: ('" + loc.getPublicId() +
"','" + loc.getSystemId() + "')") ;
}
public void startElement(String name, XAttributeList attr) {
if (_log == null) return ;
_log.print(align + "<" + name + " ") ;
if (attr != null) {
short attrLen = attr.getLength() ;
for (short i = 0; i < attrLen; i++) {
if (i != 0) _log.print(align + " ") ;
_log.print(attr.getNameByIndex(i) + "[" +
attr.getTypeByIndex(i) + "]=\"" +
attr.getValueByIndex(i) + "\"") ;
if (i+1 != attrLen) {
_log.println() ;
}
}
}
_log.println(">") ;
align += " " ;
}
public void endElement(String name) {
if (_log == null) return ;
align = align.substring(3) ;
_log.println(align + "</" + name + ">") ;
}
public void characters(String chars) {
if (_log == null) return ;
_log.println(align + chars) ;
}
public void ignorableWhitespace(String sp) {
if (_log == null) return ;
_log.println(sp) ;
}
}
/**
* Checks if the XML structure is well formed (i.e. all tags opened must be
* closed and all tags opened inside a tag must be closed
* inside the same tag). It also checks parameters passed.
* If any collisions found appropriate error message is
* output into a stream specified. No XML data output, i.e.
* no output will be performed if no errors occur.<p>
* After document is completed there is a way to cehck
* if the XML data and structure was valid.
*/
private static class XMLWellFormChecker extends XMLWriter {
private boolean docStarted = false ;
private boolean docEnded = false ;
ArrayList<String> tagStack = new ArrayList<String>() ;
private boolean wellFormed = true ;
private boolean noOtherErrors = true ;
PrintWriter log = null ;
private boolean printXMLData = false ;
private XMLWellFormChecker(PrintWriter log) {
super() ;
this.log = log ;
}
private XMLWellFormChecker(PrintWriter log_, boolean printXMLData) {
super(printXMLData ? log_ : null) ;
this.printXMLData = printXMLData ;
this.log = log_ ;
}
/**
* Reset all values. This is important e.g. for test of XFilter
* interface, where 'filter()' method istbstarted twice.
*/
void reset() {
docStarted = false ;
docEnded = false ;
tagStack = new ArrayList<String>() ;
wellFormed = true ;
noOtherErrors = true ;
printXMLData = false ;
}
@Override
public void startDocument() {
super.startDocument();
if (docStarted) {
printError("Document is started twice.") ;
wellFormed = false ;
}
docStarted = true ;
}
@Override
public void endDocument() {
super.endDocument();
if (!docStarted) {
wellFormed = false ;
printError("Document ended but not started.") ;
}
docEnded = true ;
}
@Override
public void startElement(String name, XAttributeList attr) {
super.startElement(name, attr);
if (attr == null) {
printError("attribute list passed as parameter to startElement()"+
" method has null value for tag <" + name + ">") ;
noOtherErrors = false ;
}
tagStack.add(0, name) ;
}
@Override
public void endElement(String name) {
super.endElement(name);
if (wellFormed) {
if (tagStack.isEmpty()) {
wellFormed = false ;
printError("No tags to close (bad closing tag </" + name + ">)") ;
} else {
String startTag = tagStack.get(0) ;
tagStack.remove(0) ;
if (!startTag.equals(name)) {
wellFormed = false ;
printError("Bad closing tag: </" + name +
">; tag expected: </" + startTag + ">");
}
}
}
}
/**
* Checks if there were no errors during document handling.
* I.e. startDocument() and endDocument() must be called,
* XML must be well formed, parameters must be valid.
*/
public boolean isWellFormed() {
if (!docEnded) {
printError("Document was not ended.") ;
wellFormed = false ;
}
return wellFormed && noOtherErrors ;
}
/**
* Prints error message and all tags where error occurred inside.
* Also prints "Tag trace" in case if the full XML data isn't
* printed.
*/
void printError(String msg) {
log.println("!!! Error: " + msg) ;
if (printXMLData) return ;
log.println(" Tag trace :") ;
for (int i = 0; i < tagStack.size(); i++) {
String tag = tagStack.get(i) ;
log.println(" <" + tag + ">") ;
}
}
}
/**
* Beside structure of XML this class also can check existence
* of tags, inner tags, and character data. After document
* completion there is a way to check if required tags and
* character data was found. If there any error occurs an
* appropriate message is output.
*/
public static class XMLTagsChecker extends XMLWellFormChecker {
private HashMap<String,String> tags = new HashMap<String,String>() ;
private HashMap<String,String> chars = new HashMap<String,String>() ;
private boolean allOK = true ;
public XMLTagsChecker(PrintWriter log) {
super(log) ;
}
/**
* Adds a tag name which must be contained in the XML data.
*/
public void addTag(String tag) {
tags.put(tag, "") ;
}
/**
* Adds a tag name which must be contained in the XML data and
* must be inside the tag with name <code>outerTag</code>.
*/
public void addTagEnclosed(String tag, String outerTag) {
tags.put(tag, outerTag) ;
}
/**
* Adds a character data which must be contained in the XML data and
* must be inside the tag with name <code>outerTag</code>.
*/
public void addCharactersEnclosed(String ch, String outerTag) {
chars.put(ch, outerTag) ;
}
@Override
public void startElement(String name, XAttributeList attrs) {
super.startElement(name, attrs) ;
if (tags.containsKey(name)) {
String outerTag = tags.get(name);
if (outerTag.length() != 0) {
boolean isInTag = false ;
for (int i = 0; i < tagStack.size(); i++) {
if (outerTag.equals(tagStack.get(i))) {
isInTag = true ;
break ;
}
}
if (!isInTag) {
printError("Required tag <" + name + "> found, but is not enclosed in tag <" +
outerTag + ">") ;
allOK = false ;
}
}
tags.remove(name) ;
}
}
@Override
public void characters(String ch) {
super.characters(ch) ;
if (chars.containsKey(ch)) {
String outerTag = chars.get(ch);
if (outerTag.length() != 0) {
boolean isInTag = false ;
for (int i = 0; i < tagStack.size(); i++) {
if (outerTag.equals(tagStack.get(i))) {
isInTag = true ;
break ;
}
}
if (!isInTag) {
printError("Required characters '" + ch + "' found, but are not enclosed in tag <" +
outerTag + ">") ;
allOK = false ;
}
}
chars.remove(ch) ;
}
}
/**
* Checks if the XML data was valid and well formed and if
* all necessary tags and character data was found.
*/
public boolean checkTags() {
allOK &= isWellFormed() ;
Iterator<String> badTags = tags.keySet().iterator() ;
Iterator<String> badChars = chars.keySet().iterator() ;
if (badTags.hasNext()) {
allOK = false ;
log.println("Required tags were not found in export :") ;
while(badTags.hasNext()) {
log.println(" <" + badTags.next() + ">") ;
}
}
if (badChars.hasNext()) {
allOK = false ;
log.println("Required characters were not found in export :") ;
while(badChars.hasNext()) {
log.println(" <" + badChars.next() + ">") ;
}
}
reset();
return allOK ;
}
}
/**
* Represents an XML tag which must be found in XML data written.
* This tag can contain only its name or tag name and attribute
* name, or attribute value additionally.
*/
public static class Tag {
private String name = null;
private String[][] attrList = new String[0][3] ;
/**
* Creates tag which has only a name. Attributes don't make sense.
* @param tagName The name of the tag.
*/
public Tag(String tagName) {
name = tagName ;
}
/**
* Creates a tag with the name specified, which must have an
* attribute with name specified. The value of this attribute
* doesn't make sense.
* @param tagName The name of the tag.
* @param attrName The name of attribute which must be contained
* in the tag.
*/
public Tag(String tagName, String attrName) {
name = tagName ;
attrList = new String[1][3] ;
attrList[0][0] = attrName ;
}
/**
* Creates a tag with the name specified, which must have an
* attribute with the value specified. The type of value
* assumed to be 'CDATA'.
* @param tagName The name of the tag.
* @param attrName The name of attribute which must be contained
* in the tag.
* @param attrValue Attribute value.
*/
public Tag(String tagName, String attrName, String attrValue) {
name = tagName ;
attrList = new String[1][3] ;
attrList[0][0] = attrName ;
attrList[0][1] = "CDATA" ;
attrList[0][2] = attrValue ;
}
/**
* Creates a tag with the name specified, which must have
* attributes specified. The value of thesee attributes
* doesn't make sense.
* @param tagName The name of the tag.
* @param attrNames Array with names of attributes which must
* be contained in the tag.
*/
public Tag(String tagName, String[] attrNames) {
name = tagName ;
attrList = new String[attrNames.length][3] ;
for (int i = 0; i < attrNames.length; i++) {
attrList[i][0] = attrNames[i] ;
}
}
/**
* Creates a tag with the name specified, which must have an
* attributes with their values specified. The type of all values
* assumed to be 'CDATA'.
* @param tagName The name of the tag.
* @param attrValues An array with attribute names and their values.
* <code>attrValues[N][0]</code> element contains the name of Nth
* attribute, and <code>attrValues[N][1]</code> element contains
* value of Nth attribute, if value is <code>null</code> then the
* attribute value can be any.
*/
public Tag(String tagName, String[][] attrValues) {
name = tagName ;
attrList = new String[attrValues.length][3] ;
for (int i = 0; i < attrValues.length; i++) {
attrList[i][0] = attrValues[i][0] ;
attrList[i][1] = "CDATA" ;
attrList[i][2] = attrValues[i][1] ;
}
}
/**
* Gets tag String description.
*/
@Override
public String toString() {
String ret = "<" + name ;
for (int i = 0; i < attrList.length; i++) {
ret += " " + attrList[i][0] + "=";
if (attrList[i][2] == null) {
ret += "(not specified)";
} else {
ret += "\"" + attrList[i][2] + "\"";
}
}
ret += ">";
return ret ;
}
private boolean checkAttr(int attrListIdx, XAttributeList list) {
short j = 0 ;
int listLen = list.getLength();
while(j < listLen) {
if (attrList[attrListIdx][0].equals(list.getNameByIndex(j))) {
if (attrList[attrListIdx][2] == null) return true ;
return attrList[attrListIdx][2].equals(list.getValueByIndex(j)) ;
}
j++ ;
}
return false ;
}
/**
* Checks if this tag matches tag passed in parameters.
* I.e. if tag specifies only its name it mathes if names
* are equal (attributes don't make sense). If there are
* some attributes names specified in this tag method checks
* if all names present in attribute list <code>list</code>
* (attributes' values don't make sense). If attributes specified
* with values method checks if these attributes exist and
* have appropriate values.
*/
private boolean isMatchTo(String tagName, XAttributeList list) {
if (!name.equals(tagName)) return false;
boolean result = true ;
for (int i = 0; i < attrList.length; i++) {
result &= checkAttr(i, list) ;
}
return result ;
}
}
/**
* Class realises extended XML data checking. It has possibilities
* to check if a tag exists, if it has some attributes with
* values, and if this tag is contained in another tag (which
* also can specify any attributes). It can check if some
* character data exists inside any tag specified.
*/
public static class XMLChecker extends XMLWellFormChecker {
private HashSet<String> tagSet = new HashSet<String>() ;
private ArrayList<Tag[]> tags = new ArrayList<Tag[]>() ;
private ArrayList<Object[]> chars = new ArrayList<Object[]>() ;
private ArrayList<String> tagStack = new ArrayList<String>() ;
private ArrayList<AttributeList> attrStack = new ArrayList<AttributeList>() ;
public XMLChecker(PrintWriter log, boolean writeXML) {
super(log, writeXML) ;
}
public void addTag(Tag tag) {
tags.add(new Tag[] {tag, null}) ;
tagSet.add(tag.name) ;
}
public void addTagEnclosed(Tag tag, Tag outerTag) {
tags.add(new Tag[] {tag, outerTag}) ;
tagSet.add(tag.name) ;
}
public void addCharactersEnclosed(String ch, Tag outerTag) {
chars.add(new Object[] {ch.trim(), outerTag}) ;
}
@Override
public void startElement(String name, XAttributeList attr) {
try {
super.startElement(name, attr);
if (tagSet.contains(name)) {
for (int i = 0; i < tags.size(); i++) {
Tag[] tag = tags.get(i);
if (tag[0].isMatchTo(name, attr)) {
if (tag[1] == null) {
tags.remove(i--);
} else {
boolean isInStack = false ;
for (int j = 0; j < tagStack.size(); j++) {
if (tag[1].isMatchTo(tagStack.get(j),
attrStack.get(j))) {
isInStack = true ;
break ;
}
}
if (isInStack) {
tags.remove(i--) ;
}
}
}
}
}
tagStack.add(0, name) ;
attrStack.add(0, new AttributeList(attr));
} catch (Exception e) {
e.printStackTrace(log);
}
}
@Override
public void characters(String ch) {
super.characters(ch) ;
for (int i = 0; i < chars.size(); i++) {
Object[] chr = chars.get(i);
if (((String) chr[0]).equals(ch)) {
if (chr[1] == null) {
chars.remove(i--);
} else {
boolean isInStack = false ;
for (int j = 0; j < tagStack.size(); j++) {
if (((Tag) chr[1]).isMatchTo(tagStack.get(j),
attrStack.get(j))) {
isInStack = true ;
break ;
}
}
if (isInStack) {
chars.remove(i--) ;
}
}
}
}
}
@Override
public void endElement(String name) {
try {
super.endElement(name);
if (tagStack.size() > 0) {
tagStack.remove(0) ;
attrStack.remove(0) ;
}
} catch(Exception e) {
e.printStackTrace(log) ;
}
}
public boolean check() {
if (tags.size()> 0) {
log.println("!!! Error: Some tags were not found :") ;
for (int i = 0; i < tags.size(); i++) {
Tag[] tag = tags.get(i) ;
log.println(" Tag " + tag[0] + " was not found");
if (tag[1] != null)
log.println(" inside tag " + tag[1]) ;
}
}
if (chars.size() > 0) {
log.println("!!! Error: Some character data blocks were not found :") ;
for (int i = 0; i < chars.size(); i++) {
Object[] ch = chars.get(i) ;
log.println(" Character data \"" + ch[0] + "\" was not found ") ;
if (ch[1] != null)
log.println(" inside tag " + ch[1]) ;
}
}
if (!isWellFormed())
log.println("!!! Some errors were found in XML structure") ;
boolean result = tags.isEmpty() && chars.size() == 0 && isWellFormed();
reset();
return result;
}
}
public static PropertyValue[] createMediaDescriptor(String[] propNames, Object[] values) {
PropertyValue[] props = new PropertyValue[propNames.length] ;
for (int i = 0; i < props.length; i++) {
props[i] = new PropertyValue() ;
props[i].Name = propNames[i] ;
if (values != null && i < values.length) {
props[i].Value = values[i] ;
}
}
return props ;
}
}
|