Skip to content
This repository was archived by the owner on Oct 4, 2020. It is now read-only.

Commit df852b2

Browse files
pjfanningpjfanning
authoredJan 11, 2018
Remove support for Piccolo (#6)
·
2.6.4
1 parent 5ecce79 commit df852b2

13 files changed

+456
-384
lines changed
 

‎CHANGES.txt

+5
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,8 @@
1+
Changes in V2.6.4 since V2.6.3
2+
3+
* Remove Piccolo support
4+
* Apply XML Entity Expansion security checks
5+
16
Changes in V2.6.3 since V2.6.2
27

38
* ArrayIndexOutOfBoundsException when writing CDATA (https://issues.apache.org/jira/browse/XMLBEANS-404)

‎build.xml

+17-106
Original file line numberDiff line numberDiff line change
@@ -15,11 +15,11 @@
1515
-->
1616
<project name="Xbean" default="default" basedir=".">
1717

18-
<property name="build.compiler" value="javac1.4"/>
19-
<property name="javac.source" value="1.4"/>
20-
<property name="javac.target" value="1.4"/>
18+
<property name="build.compiler" value="javac1.6"/>
19+
<property name="javac.source" value="1.6"/>
20+
<property name="javac.target" value="1.6"/>
2121

22-
<property name="version.base" value="2.6.3"/>
22+
<property name="version.base" value="2.6.4"/>
2323
<property name="version.rc" value=""/>
2424

2525
<!-- manifest entries -->
@@ -128,39 +128,6 @@
128128
<copy file="external/lib/saxon9-dom.jar" tofile="build/lib/saxon9-dom.jar"/>
129129
</target>
130130

131-
<target name="jsr173-bundle.downloaded">
132-
<condition property="jsr173-bundle.exists">
133-
<available file="external/lib/jsr173_1.0_api_bundle.jar"/>
134-
</condition>
135-
</target>
136-
137-
<target name="jsr173-bundle.jar"
138-
depends="jsr173-bundle.downloaded, dirs"
139-
unless="jsr173-bundle.exists">
140-
<get dest="external/lib/jsr173_1.0_api_bundle.jar"
141-
src="http://source.sakaiproject.org/maven/xmlbeans/jars/jsr173_1.0_api_bundle.jar"
142-
verbose="true" usetimestamp="true" ignoreerrors="true"/>
143-
</target>
144-
145-
<target name="jsr173_1.0.jars.extracted">
146-
<condition property="jsr173_1.0.jars.exist">
147-
<available file="build/lib/jsr173_1.0_api.jar"/>
148-
</condition>
149-
</target>
150-
151-
<target name="jsr173_1.0.jars"
152-
depends="jsr173-bundle.jar, jsr173_1.0.jars.extracted"
153-
unless="jsr173_1.0.jars.exist">
154-
<unjar src="external/lib/jsr173_1.0_api_bundle.jar" dest="external/lib" >
155-
<patternset>
156-
<include name="jsr173_1.0_api.jar"/>
157-
</patternset>
158-
</unjar>
159-
160-
<!-- copy jsr173 API jar and license files to build/lib -->
161-
<copy file="external/lib/jsr173_1.0_api.jar" tofile="build/lib/jsr173_1.0_api.jar"/>
162-
</target>
163-
164131
<!-- get resolver.jar -->
165132
<target name="check.xcresolver.zip">
166133
<condition property="xcresolver.zip.exists">
@@ -356,9 +323,6 @@
356323
<include name="xmlbeans-qname.jar"/>
357324
<include name="xbean_xpath.jar"/>
358325
<include name="resolver.jar"/>
359-
<include name="jsr173_1.0_api.jar"/>
360-
<include name="BEA Binary RI License (JSR 173).1(Clean).txt"/>
361-
<include name="README(jsr_173 api and ri).txt"/>
362326
</fileset>
363327
</copy>
364328

@@ -488,8 +452,8 @@
488452
store.classes, saaj_api.classes,
489453
marshal.classes, xpath.classes, oldxbean.jar, xsdschema.classes,
490454
xmlinputstream.classes, resolver.jar, xbean_xpath.jar,
491-
piccolo.classes, tools.classes, jamsupport.classes">
492-
<jar jarfile="build/lib/xbean.jar" index="true" duplicate="preserve">
455+
tools.classes, jamsupport.classes">
456+
<jar jarfile="build/lib/xbean.jar" index="true">
493457
<fileset dir="build/classes/xmlpublic"
494458
excludes="javax/**"/>
495459
<fileset dir="build/classes/typeholder"/>
@@ -509,7 +473,6 @@
509473
<fileset dir="build/classes/marshal"/>
510474
<fileset dir="build/classes/repackage"/>
511475
<fileset dir="build/classes/jam"/>
512-
<fileset dir="build/classes/piccolo"/>
513476
<fileset dir="build/classes/tools"/>
514477
<fileset file="LICENSE.txt"/>
515478
<fileset file="NOTICE.txt"/>
@@ -545,12 +508,10 @@
545508

546509
<!-- xmlpublic target ============================================== -->
547510

548-
<target name="xmlpublic.classes" depends="dirs, jsr173_1.0.jars">
511+
<target name="xmlpublic.classes" depends="dirs">
549512
<mkdir dir="build/classes/xmlpublic"/>
550513
<javac srcdir="src/xmlpublic" sourcepath="src/xmlinputstream" destdir="build/classes/xmlpublic" source="${javac.source}" target="${javac.target}" debug="on">
551-
<classpath>
552-
<pathelement location="build/lib/jsr173_1.0_api.jar"/>
553-
</classpath>
514+
<classpath/>
554515
</javac>
555516

556517
<!-- Need properties files for XmlError -->
@@ -586,7 +547,6 @@
586547
<mkdir dir="build/classes/typestore"/>
587548
<javac srcdir="src/typestore" destdir="build/classes/typestore" source="${javac.source}" target="${javac.target}" debug="on">
588549
<classpath>
589-
<pathelement location="build/lib/jsr173_1.0_api.jar"/>
590550
<pathelement location="build/classes/xmlinputstream"/>
591551
<pathelement location="build/classes/xmlpublic"/>
592552
<pathelement location="build/classes/common"/>
@@ -597,11 +557,10 @@
597557

598558
<!-- common target ============================================= -->
599559

600-
<target name="common.classes" depends="dirs, xmlpublic.classes, xmlinputstream.classes, jsr173_1.0.jars">
560+
<target name="common.classes" depends="dirs, xmlpublic.classes, xmlinputstream.classes">
601561
<mkdir dir="build/classes/common"/>
602562
<javac srcdir="src/common" destdir="build/classes/common" source="${javac.source}" target="${javac.target}" debug="on">
603563
<classpath>
604-
<pathelement location="build/lib/jsr173_1.0_api.jar"/>
605564
<pathelement location="build/classes/xmlinputstream"/>
606565
<pathelement location="build/classes/xmlpublic"/>
607566
</classpath>
@@ -639,7 +598,7 @@
639598

640599
<target name="typeimpl.classes" depends="dirs, store.classes,
641600
repackage.classes, xmlpublic.classes, typeholder.template, typestore.classes, xsdschema.classes,
642-
configschema.classes, toolschema.classes, jsr173_1.0.jars, jam.classes">
601+
configschema.classes, toolschema.classes, jam.classes">
643602
<mkdir dir="build/classes/typeimpl"/>
644603
<javac destdir="build/classes/typeimpl" source="${javac.source}" target="${javac.target}" debug="on">
645604
<classpath>
@@ -655,7 +614,6 @@
655614
<pathelement location="build/classes/xmlschema"/>
656615
<pathelement location="build/classes/toolschema"/>
657616
<pathelement location="build/classes/jam"/>
658-
<pathelement location="build/lib/jsr173_1.0_api.jar"/>
659617
</classpath>
660618

661619
<src path="src/typeimpl"/>
@@ -681,7 +639,6 @@
681639
<mkdir dir="build/classes/xmlcomp"/>
682640
<javac srcdir="src/xmlcomp" destdir="build/classes/xmlcomp" source="${javac.source}" target="${javac.target}" debug="on">
683641
<classpath>
684-
<pathelement location="build/lib/jsr173_1.0_api.jar"/>
685642
<pathelement location="build/classes/xmlinputstream"/>
686643
<pathelement location="build/classes/xmlpublic"/>
687644
<pathelement location="build/classes/common"/>
@@ -698,11 +655,10 @@
698655

699656
<!-- marshal target =============================================== -->
700657

701-
<target name="marshal.classes" depends="dirs, typeimpl.classes, xmlpublic.classes, jsr173_1.0.jars">
658+
<target name="marshal.classes" depends="dirs, typeimpl.classes, xmlpublic.classes">
702659
<mkdir dir="build/classes/marshal"/>
703660
<javac srcdir="src/marshal" destdir="build/classes/marshal" source="${javac.source}" target="${javac.target}" debug="on">
704661
<classpath>
705-
<pathelement location="build/lib/jsr173_1.0_api.jar"/>
706662
<pathelement location="build/classes/configschema"/>
707663
<pathelement location="build/classes/xmlinputstream"/>
708664
<pathelement location="build/classes/xmlpublic"/>
@@ -739,36 +695,32 @@
739695
<!-- store target ============================================== -->
740696

741697
<target name="store.classes"
742-
depends="dirs, common.classes, xmlpublic.classes, typestore.classes, saaj_api.classes, piccolo.classes">
698+
depends="dirs, common.classes, xmlpublic.classes, typestore.classes, saaj_api.classes">
743699
<mkdir dir="build/classes/store"/>
744700
<javac srcdir="src/store" destdir="build/classes/store" source="${javac.source}" target="${javac.target}" debug="on">
745701
<classpath id="store.compile.path">
746702
<pathelement location="build/classes/typestore"/>
747-
<pathelement location="build/lib/jsr173_1.0_api.jar"/>
748703
<pathelement location="build/classes/xmlinputstream"/>
749704
<pathelement location="build/classes/xmlpublic"/>
750705
<pathelement location="build/classes/common"/>
751706
<pathelement location="build/classes/saaj_api"/>
752-
<pathelement location="build/classes/piccolo"/>
753707
</classpath>
754708
</javac>
755709
</target>
756710

757711
<!-- tools target ============================================== -->
758712

759713
<target name="tools.classes"
760-
depends="dirs, common.classes, xmlpublic.classes, typestore.classes, saaj_api.classes, piccolo.classes,
714+
depends="dirs, common.classes, xmlpublic.classes, typestore.classes, saaj_api.classes,
761715
typeimpl.classes, xmlcomp.classes">
762716
<mkdir dir="build/classes/tools"/>
763717
<javac srcdir="src/tools" destdir="build/classes/tools" source="${javac.source}" target="${javac.target}" debug="on">
764718
<classpath id="tools.compile.path">
765719
<pathelement location="build/classes/typestore"/>
766-
<pathelement location="build/lib/jsr173_1.0_api.jar"/>
767720
<pathelement location="build/classes/xmlinputstream"/>
768721
<pathelement location="build/classes/xmlpublic"/>
769722
<pathelement location="build/classes/common"/>
770723
<pathelement location="build/classes/saaj_api"/>
771-
<pathelement location="build/classes/piccolo"/>
772724
<pathelement location="build/classes/typeimpl"/>
773725
<pathelement location="build/classes/xmlcomp"/>
774726
</classpath>
@@ -785,13 +737,11 @@
785737

786738
<path id="bootstrap.run.path">
787739
<pathelement location="build/private/lib/oldxbean.jar"/>
788-
<pathelement location="build/lib/jsr173_1.0_api.jar"/>
789740
<pathelement location="build/classes/xmlpublic"/>
790741
</path>
791742

792743
<path id="bootstrap.compile.path">
793744
<pathelement location="build/classes/xmlpublic"/>
794-
<pathelement location="build/lib/jsr173_1.0_api.jar"/>
795745
</path>
796746

797747
<property name="bootstrap.compile.path" refid="bootstrap.compile.path"/>
@@ -835,7 +785,7 @@
835785
</condition>
836786
</target>
837787

838-
<target name="xmlschema.classes" depends="xmlschema.check, xmlpublic.classes, oldxbean.jar, jsr173_1.0.jars" unless="xmlschema.notRequired">
788+
<target name="xmlschema.classes" depends="xmlschema.check, xmlpublic.classes, oldxbean.jar" unless="xmlschema.notRequired">
839789
<delete dir="build/classes/xmlschema"/>
840790
<delete dir="build/src/xmlschema"/>
841791
<java classname="${bootstrap_schema_compiler}" classpathref="bootstrap.run.path" fork="true" failonerror="true">
@@ -920,7 +870,6 @@
920870
<property name="repackage_arg" value=""/>
921871
<property name="schema_compiler" value="org.apache.xmlbeans.impl.tool.SchemaCompiler"/>
922872
<property name="bootstrap_schema_compiler" value="org.apache.xmlbeans.impl.tool.SchemaCompiler"/>
923-
<property name="piccolo_package_name" value="org.apache.xmlbeans.impl.piccolo"/>
924873
<property name="jam_package_name" value="org.apache.xmlbeans.impl.jam"/>
925874

926875
<!--
@@ -1064,7 +1013,6 @@
10641013
<pathelement location="build/classes/common"/>
10651014
<pathelement location="external/lib/junit.jar"/>
10661015
<pathelement location="build/ar/xbean.jar"/>
1067-
<pathelement location="build/lib/jsr173_1.0_api.jar"/>
10681016
<pathelement location="build/classes/xmlinputstream"/>
10691017
</path>
10701018

@@ -1074,7 +1022,7 @@
10741022
</path>
10751023

10761024

1077-
<target name="drt.classes" depends="dirs,jsr173_1.0.jars">
1025+
<target name="drt.classes" depends="dirs">
10781026
<mkdir dir="build/private/classes/drt"/>
10791027
<javac
10801028
destdir="build/private/classes/drt"
@@ -1094,7 +1042,6 @@
10941042

10951043
<path id="scomp.run.path">
10961044
<pathelement location="build/lib/xbean.jar"/>
1097-
<pathelement location="build/lib/jsr173_1.0_api.jar"/>
10981045
</path>
10991046

11001047
<target name="stsschema.check">
@@ -1119,7 +1066,7 @@
11191066
</uptodate>
11201067
</target>
11211068

1122-
<target name="jam.classes" depends="jam.classes.check, dirs, repackage.classes, jsr173_1.0.jars" unless="jam.classes.notRequired">
1069+
<target name="jam.classes" depends="jam.classes.check, dirs, repackage.classes" unless="jam.classes.notRequired">
11231070
<delete dir="build/private/jam"/>
11241071
<mkdir dir="build/private/jam"/>
11251072
<unjar src="external/lib/jam-0.1.0-src.jar" dest="build/private/jam"/>
@@ -1141,43 +1088,7 @@
11411088
source="1.4" target="1.4"
11421089
debug="on">
11431090
<src path="build/private/jam/src_repackage"/>
1144-
<classpath>
1145-
<pathelement location="build/lib/jsr173_1.0_api.jar"/>
1146-
</classpath>
1147-
</javac>
1148-
</target>
1149-
1150-
<!-- Piccolo deployment -->
1151-
<target name="piccolo.classes.check">
1152-
<uptodate property="piccolo.classes.notRequired"
1153-
targetfile="build/ar/xbean.jar">
1154-
<srcfiles dir="external/lib" includes="**/piccolo_*.jar"/>
1155-
</uptodate>
1156-
</target>
1157-
1158-
<target name="piccolo.classes" depends="piccolo.classes.check, dirs, repackage.classes" unless="piccolo.classes.notRequired">
1159-
<delete dir="build/private/piccolo"/>
1160-
<mkdir dir="build/private/piccolo"/>
1161-
<unjar src="external/lib/piccolo_apache_dist_20040711_v2.jar" dest="build/private/piccolo"/>
1162-
1163-
<echo message="Re-packaging Piccolo"/>
1164-
1165-
<java classname="repackage.Repackage" fork="true" failonerror="true">
1166-
<classpath>
1167-
<pathelement location="build/classes/repackage"/>
1168-
</classpath>
1169-
<arg line="-repackage com.bluecast:${piccolo_package_name} -f build/private/piccolo/src -t build/private/piccolo/src_repackage"/>
1170-
</java>
1171-
1172-
<delete dir="build/classes/piccolo"/>
1173-
<mkdir dir="build/classes/piccolo"/>
1174-
<javac
1175-
destdir="build/classes/piccolo"
1176-
classpath=""
1177-
source="1.3" target="1.4"
1178-
debug="on">
1179-
<src path="build/private/piccolo/src_repackage"/>
1091+
<classpath/>
11801092
</javac>
11811093
</target>
1182-
11831094
</project>

‎external/lib/piccolo.LICENSE.txt

-202
This file was deleted.

‎external/lib/piccolo_apache_dist_20040629.jar

-138 KB
Binary file not shown.

‎external/lib/piccolo_apache_dist_20040629_v2.jar

-140 KB
Binary file not shown.

‎external/lib/piccolo_apache_dist_20040711.jar

-141 KB
Binary file not shown.

‎external/lib/piccolo_apache_dist_20040711_v2.jar

-147 KB
Binary file not shown.

‎src/store/org/apache/xmlbeans/impl/store/Locale.java

+16-72
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
/* Copyright 2004 The Apache Software Foundation
1+
/* Copyright 2004-2017 The Apache Software Foundation
22
*
33
* Licensed under the Apache License, Version 2.0 (the "License");
44
* you may not use this file except in compliance with the License.
@@ -103,9 +103,6 @@
103103
import org.apache.xmlbeans.impl.values.TypeStoreUser;
104104
import org.apache.xmlbeans.impl.values.TypeStoreUserFactory;
105105

106-
import org.apache.xmlbeans.impl.piccolo.xml.Piccolo;
107-
import org.apache.xmlbeans.impl.piccolo.io.FileFormatException;
108-
109106
public final class Locale
110107
implements DOMImplementation, SaajCallback, XmlLocale
111108
{
@@ -3032,18 +3029,7 @@ public InputSource resolveEntity(String publicId, String systemId)
30323029
}
30333030
}
30343031

3035-
private static SaxLoader getPiccoloSaxLoader()
3036-
{
3037-
SaxLoader piccoloLoader = (SaxLoader) SystemCache.get().getSaxLoader();
3038-
if (piccoloLoader == null)
3039-
{
3040-
piccoloLoader = PiccoloSaxLoader.newInstance();
3041-
SystemCache.get().setSaxLoader(piccoloLoader);
3042-
}
3043-
return piccoloLoader;
3044-
}
3045-
3046-
private static SaxLoader getSaxLoader(XmlOptions options)
3032+
private static SaxLoader getSaxLoader(XmlOptions options) throws XmlException
30473033
{
30483034
options = XmlOptions.maskNull(options);
30493035

@@ -3060,31 +3046,23 @@ private static SaxLoader getSaxLoader(XmlOptions options)
30603046
er = new DefaultEntityResolver();
30613047
}
30623048

3063-
SaxLoader sl;
3064-
3065-
if (options.hasOption(XmlOptions.LOAD_USE_XMLREADER))
3066-
{
3067-
XMLReader xr = (XMLReader) options.get(
3068-
XmlOptions.LOAD_USE_XMLREADER);
3069-
3070-
if (xr == null)
3071-
throw new IllegalArgumentException("XMLReader is null");
3049+
XMLReader xr = (XMLReader) options.get(
3050+
XmlOptions.LOAD_USE_XMLREADER);
30723051

3073-
sl = new XmlReaderSaxLoader(xr);
3074-
3075-
// I've noticed that most XMLReaders don't like a null EntityResolver...
3076-
3077-
if (er != null)
3078-
xr.setEntityResolver(er);
3052+
if (xr == null) {
3053+
try {
3054+
xr = SAXHelper.newXMLReader();
3055+
} catch(Exception e) {
3056+
throw new XmlException("Problem creating XMLReader", e);
3057+
}
30793058
}
3080-
else
3081-
{
3082-
sl = getPiccoloSaxLoader();
30833059

3084-
// Piccolo doesnot mind a null entity resolver ...
3060+
SaxLoader sl = new XmlReaderSaxLoader(xr);
30853061

3086-
sl.setEntityResolver(er);
3087-
}
3062+
// I've noticed that most XMLReaders don't like a null EntityResolver...
3063+
3064+
if (er != null)
3065+
xr.setEntityResolver(er);
30883066

30893067
return sl;
30903068
}
@@ -3098,34 +3076,6 @@ private static class XmlReaderSaxLoader
30983076
}
30993077
}
31003078

3101-
private static class PiccoloSaxLoader
3102-
extends SaxLoader
3103-
{
3104-
private PiccoloSaxLoader(Piccolo p)
3105-
{
3106-
super(p, p.getStartLocator());
3107-
3108-
_piccolo = p;
3109-
}
3110-
3111-
static PiccoloSaxLoader newInstance()
3112-
{
3113-
return new PiccoloSaxLoader(new Piccolo());
3114-
}
3115-
3116-
void postLoad(Cur c)
3117-
{
3118-
XmlDocumentProperties props = getDocProps(c, true);
3119-
3120-
props.setEncoding(_piccolo.getEncoding());
3121-
props.setVersion(_piccolo.getVersion());
3122-
3123-
super.postLoad(c);
3124-
}
3125-
3126-
private Piccolo _piccolo;
3127-
}
3128-
31293079
private static abstract class SaxHandler
31303080
implements ContentHandler, LexicalHandler , DeclHandler, DTDHandler
31313081
{
@@ -3180,7 +3130,7 @@ public void startElement(String uri, String local, String qName,
31803130
if (local.length() == 0)
31813131
local = qName;
31823132

3183-
// Out current parser (Piccolo) does not error when a
3133+
// Out current parser does not error when a
31843134
// namespace is used and not defined. Check for these here
31853135

31863136
if (qName.indexOf(':') >= 0 && uri.length() == 0)
@@ -3470,12 +3420,6 @@ public Cur load(Locale l, InputSource is, XmlOptions options)
34703420

34713421
return c;
34723422
}
3473-
catch (FileFormatException e)
3474-
{
3475-
_context.abort();
3476-
3477-
throw new XmlException(e.getMessage(), e);
3478-
}
34793423
catch (XmlRuntimeException e)
34803424
{
34813425
_context.abort();

‎src/store/org/apache/xmlbeans/impl/store/NullLogger.java

+81
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,81 @@
1+
/* Copyright 2017 The Apache Software Foundation
2+
*
3+
* Licensed under the Apache License, Version 2.0 (the "License");
4+
* you may not use this file except in compliance with the License.
5+
* You may obtain a copy of the License at
6+
*
7+
* http://www.apache.org/licenses/LICENSE-2.0
8+
*
9+
* Unless required by applicable law or agreed to in writing, software
10+
* distributed under the License is distributed on an "AS IS" BASIS,
11+
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
12+
* See the License for the specific language governing permissions and
13+
* limitations under the License.
14+
*/
15+
16+
package org.apache.xmlbeans.impl.store;
17+
18+
/**
19+
* A logger class that strives to make it as easy as possible for
20+
* developers to write log calls, while simultaneously making those
21+
* calls as cheap as possible by performing lazy evaluation of the log
22+
* message.<p>
23+
*/
24+
public class NullLogger extends XBLogger {
25+
@Override
26+
public void initialize(final String cat) {
27+
// do nothing
28+
}
29+
30+
/**
31+
* Log a message
32+
*
33+
* @param level One of DEBUG, INFO, WARN, ERROR, FATAL
34+
* @param obj1 The object to log.
35+
*/
36+
37+
@Override
38+
protected void _log(final int level, final Object obj1) {
39+
// do nothing
40+
}
41+
42+
/**
43+
* Log a message
44+
*
45+
* @param level One of DEBUG, INFO, WARN, ERROR, FATAL
46+
* @param obj1 The object to log. This is converted to a string.
47+
* @param exception An exception to be logged
48+
*/
49+
@Override
50+
protected void _log(int level, Object obj1, final Throwable exception) {
51+
// do nothing
52+
}
53+
54+
/**
55+
* Log a message. Lazily appends Object parameters together.
56+
* If the last parameter is a {@link Throwable} it is logged specially.
57+
*
58+
* @param level One of DEBUG, INFO, WARN, ERROR, FATAL
59+
* @param objs the objects to place in the message
60+
*/
61+
@Override
62+
public void log(int level, Object... objs) {
63+
// do nothing
64+
}
65+
66+
67+
/**
68+
* Check if a logger is enabled to log at the specified level
69+
*
70+
* @param level One of DEBUG, INFO, WARN, ERROR, FATAL
71+
*/
72+
@Override
73+
public boolean check(final int level) {
74+
return false;
75+
}
76+
}
77+
78+
79+
80+
81+

‎src/store/org/apache/xmlbeans/impl/store/SAXHelper.java

+99
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,99 @@
1+
/* Copyright 2017 The Apache Software Foundation
2+
*
3+
* Licensed under the Apache License, Version 2.0 (the "License");
4+
* you may not use this file except in compliance with the License.
5+
* You may obtain a copy of the License at
6+
*
7+
* http://www.apache.org/licenses/LICENSE-2.0
8+
*
9+
* Unless required by applicable law or agreed to in writing, software
10+
* distributed under the License is distributed on an "AS IS" BASIS,
11+
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
12+
* See the License for the specific language governing permissions and
13+
* limitations under the License.
14+
*/
15+
16+
package org.apache.xmlbeans.impl.store;
17+
18+
import java.io.IOException;
19+
import java.io.StringReader;
20+
import java.lang.reflect.Method;
21+
import java.util.concurrent.TimeUnit;
22+
23+
import javax.xml.XMLConstants;
24+
import javax.xml.parsers.ParserConfigurationException;
25+
import javax.xml.parsers.SAXParserFactory;
26+
27+
import org.xml.sax.EntityResolver;
28+
import org.xml.sax.InputSource;
29+
import org.xml.sax.SAXException;
30+
import org.xml.sax.XMLReader;
31+
32+
/**
33+
* Provides handy methods for working with SAX parsers and readers
34+
*/
35+
public final class SAXHelper {
36+
private static final XBLogger logger = XBLogFactory.getLogger(SAXHelper.class);
37+
private static long lastLog;
38+
39+
private SAXHelper() {}
40+
41+
/**
42+
* Creates a new SAX XMLReader, with sensible defaults
43+
*/
44+
public static synchronized XMLReader newXMLReader() throws SAXException, ParserConfigurationException {
45+
XMLReader xmlReader = saxFactory.newSAXParser().getXMLReader();
46+
xmlReader.setEntityResolver(IGNORING_ENTITY_RESOLVER);
47+
trySetSAXFeature(xmlReader, XMLConstants.FEATURE_SECURE_PROCESSING);
48+
trySetXercesSecurityManager(xmlReader);
49+
return xmlReader;
50+
}
51+
52+
static final EntityResolver IGNORING_ENTITY_RESOLVER = new EntityResolver() {
53+
@Override
54+
public InputSource resolveEntity(String publicId, String systemId)
55+
throws SAXException, IOException {
56+
return new InputSource(new StringReader(""));
57+
}
58+
};
59+
60+
private static final SAXParserFactory saxFactory;
61+
static {
62+
saxFactory = SAXParserFactory.newInstance();
63+
saxFactory.setValidating(false);
64+
saxFactory.setNamespaceAware(true);
65+
}
66+
67+
private static void trySetSAXFeature(XMLReader xmlReader, String feature) {
68+
try {
69+
xmlReader.setFeature(feature, true);
70+
} catch (Exception e) {
71+
logger.log(XBLogger.WARN, "SAX Feature unsupported", feature, e);
72+
} catch (AbstractMethodError ame) {
73+
logger.log(XBLogger.WARN, "Cannot set SAX feature because outdated XML parser in classpath", feature, ame);
74+
}
75+
}
76+
77+
private static void trySetXercesSecurityManager(XMLReader xmlReader) {
78+
// Try built-in JVM one first, standalone if not
79+
for (String securityManagerClassName : new String[] {
80+
"com.sun.org.apache.xerces.internal.util.SecurityManager",
81+
"org.apache.xerces.util.SecurityManager"
82+
}) {
83+
try {
84+
Object mgr = Class.forName(securityManagerClassName).newInstance();
85+
Method setLimit = mgr.getClass().getMethod("setEntityExpansionLimit", Integer.TYPE);
86+
setLimit.invoke(mgr, 4096);
87+
xmlReader.setProperty("http://apache.org/xml/properties/security-manager", mgr);
88+
// Stop once one can be setup without error
89+
return;
90+
} catch (Throwable e) { // NOSONAR - also catch things like NoClassDefError here
91+
// throttle the log somewhat as it can spam the log otherwise
92+
if(System.currentTimeMillis() > lastLog + TimeUnit.MINUTES.toMillis(5)) {
93+
logger.log(XBLogger.WARN, "SAX Security Manager could not be setup [log suppressed for 5 minutes]", e);
94+
lastLog = System.currentTimeMillis();
95+
}
96+
}
97+
}
98+
}
99+
}

‎src/store/org/apache/xmlbeans/impl/store/XBLogFactory.java

+119
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,119 @@
1+
/* Copyright 2017 The Apache Software Foundation
2+
*
3+
* Licensed under the Apache License, Version 2.0 (the "License");
4+
* you may not use this file except in compliance with the License.
5+
* You may obtain a copy of the License at
6+
*
7+
* http://www.apache.org/licenses/LICENSE-2.0
8+
*
9+
* Unless required by applicable law or agreed to in writing, software
10+
* distributed under the License is distributed on an "AS IS" BASIS,
11+
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
12+
* See the License for the specific language governing permissions and
13+
* limitations under the License.
14+
*/
15+
16+
package org.apache.xmlbeans.impl.store;
17+
18+
import java.util.HashMap;
19+
import java.util.Map;
20+
21+
/**
22+
* Provides logging without clients having to mess with
23+
* configuration/initialization.
24+
*
25+
* @author Andrew C. Oliver (acoliver at apache dot org)
26+
* @author Marc Johnson (mjohnson at apache dot org)
27+
* @author Nicola Ken Barozzi (nicolaken at apache.org)
28+
*/
29+
public final class XBLogFactory {
30+
/**
31+
* Map of XBLogger instances, with classes as keys
32+
*/
33+
private static final Map<String,XBLogger> _loggers = new HashMap<String,XBLogger>();
34+
35+
/**
36+
* A common instance of NullLogger, as it does nothing
37+
* we only need the one
38+
*/
39+
private static final XBLogger _nullLogger = new NullLogger();
40+
/**
41+
* The name of the class to use. Initialised the
42+
* first time we need it
43+
*/
44+
static String _loggerClassName = null;
45+
46+
/**
47+
* Construct a XBLogFactory.
48+
*/
49+
private XBLogFactory() {}
50+
51+
/**
52+
* Get a logger, based on a class name
53+
*
54+
* @param theclass the class whose name defines the log
55+
*
56+
* @return a XBLogger for the specified class
57+
*/
58+
public static XBLogger getLogger(final Class<?> theclass) {
59+
return getLogger(theclass.getName());
60+
}
61+
62+
/**
63+
* Get a logger, based on a String
64+
*
65+
* @param cat the String that defines the log
66+
*
67+
* @return a XBLogger for the specified class
68+
*/
69+
public static XBLogger getLogger(final String cat) {
70+
// If we haven't found out what logger to use yet,
71+
// then do so now
72+
// Don't look it up until we're first asked, so
73+
// that our users can set the system property
74+
// between class loading and first use
75+
if(_loggerClassName == null) {
76+
try {
77+
_loggerClassName = System.getProperty("org.apache.xmlbeans.impl.store.XBLogger");
78+
} catch(Exception e) {
79+
// ignore any exception here
80+
}
81+
82+
// Use the default logger if none specified,
83+
// or none could be fetched
84+
if(_loggerClassName == null) {
85+
_loggerClassName = _nullLogger.getClass().getName();
86+
}
87+
}
88+
89+
// Short circuit for the null logger, which
90+
// ignores all categories
91+
if(_loggerClassName.equals(_nullLogger.getClass().getName())) {
92+
return _nullLogger;
93+
}
94+
95+
96+
// Fetch the right logger for them, creating
97+
// it if that's required
98+
XBLogger logger = _loggers.get(cat);
99+
if (logger == null) {
100+
try {
101+
@SuppressWarnings("unchecked")
102+
Class<? extends XBLogger> loggerClass =
103+
(Class<? extends XBLogger>) Class.forName(_loggerClassName);
104+
logger = loggerClass.newInstance();
105+
logger.initialize(cat);
106+
} catch(Exception e) {
107+
// Give up and use the null logger
108+
logger = _nullLogger;
109+
_loggerClassName = _nullLogger.getClass().getName();
110+
}
111+
112+
// Save for next time
113+
_loggers.put(cat, logger);
114+
}
115+
return logger;
116+
}
117+
}
118+
119+

‎src/store/org/apache/xmlbeans/impl/store/XBLogger.java

+115
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,115 @@
1+
/* Copyright 2017 The Apache Software Foundation
2+
*
3+
* Licensed under the Apache License, Version 2.0 (the "License");
4+
* you may not use this file except in compliance with the License.
5+
* You may obtain a copy of the License at
6+
*
7+
* http://www.apache.org/licenses/LICENSE-2.0
8+
*
9+
* Unless required by applicable law or agreed to in writing, software
10+
* distributed under the License is distributed on an "AS IS" BASIS,
11+
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
12+
* See the License for the specific language governing permissions and
13+
* limitations under the License.
14+
*/
15+
16+
package org.apache.xmlbeans.impl.store;
17+
18+
/**
19+
* A logger interface that strives to make it as easy as possible for
20+
* developers to write log calls, while simultaneously making those
21+
* calls as cheap as possible by performing lazy evaluation of the log
22+
* message.<p>
23+
*/
24+
public abstract class XBLogger {
25+
26+
public static final int DEBUG = 1;
27+
public static final int INFO = 3;
28+
public static final int WARN = 5;
29+
public static final int ERROR = 7;
30+
public static final int FATAL = 9;
31+
32+
/** Short strings for numeric log level. Use level as array index. */
33+
protected static final String LEVEL_STRINGS_SHORT[] = {"?", "D", "?", "I", "?", "W", "?", "E", "?", "F", "?"};
34+
/** Long strings for numeric log level. Use level as array index. */
35+
protected static final String LEVEL_STRINGS[] = {"?0?", "DEBUG", "?2?", "INFO", "?4?", "WARN", "?6?", "ERROR", "?8?", "FATAL", "?10+?"};
36+
37+
38+
/**
39+
* package scope so it cannot be instantiated outside of the util
40+
* package. You need a XBLogger? Go to the XBLogFactory for one
41+
*/
42+
XBLogger() {
43+
// no fields to initialize
44+
}
45+
46+
abstract public void initialize(String cat);
47+
48+
/**
49+
* Log a message
50+
*
51+
* @param level One of DEBUG, INFO, WARN, ERROR, FATAL
52+
* @param obj1 The object to log. This is converted to a string.
53+
*/
54+
abstract protected void _log(int level, Object obj1);
55+
56+
/**
57+
* Log a message
58+
*
59+
* @param level One of DEBUG, INFO, WARN, ERROR, FATAL
60+
* @param obj1 The object to log. This is converted to a string.
61+
* @param exception An exception to be logged
62+
*/
63+
abstract protected void _log(int level, Object obj1, final Throwable exception);
64+
65+
66+
/**
67+
* Check if a logger is enabled to log at the specified level
68+
* This allows code to avoid building strings or evaluating functions in
69+
* the arguments to log.
70+
*
71+
* An example:
72+
* <code><pre>
73+
* if (logger.check(XBLogger.INFO)) {
74+
* logger.log(XBLogger.INFO, "Avoid concatenating " + " strings and evaluating " + functions());
75+
* }
76+
* </pre></code>
77+
*
78+
* @param level One of DEBUG, INFO, WARN, ERROR, FATAL
79+
*/
80+
abstract public boolean check(int level);
81+
82+
/**
83+
* Log a message. Lazily appends Object parameters together.
84+
* If the last parameter is a {@link Throwable} it is logged specially.
85+
*
86+
* @param level One of DEBUG, INFO, WARN, ERROR, FATAL
87+
* @param objs the objects to place in the message
88+
*/
89+
public void log(int level, Object... objs) {
90+
if (!check(level)) return;
91+
StringBuilder sb = new StringBuilder(32);
92+
Throwable lastEx = null;
93+
for (int i=0; i<objs.length; i++) {
94+
if (i == objs.length-1 && objs[i] instanceof Throwable) {
95+
lastEx = (Throwable)objs[i];
96+
} else {
97+
sb.append(objs[i]);
98+
}
99+
}
100+
101+
String msg = sb.toString();
102+
msg = msg.replaceAll("[\r\n]+", " "); // log forging escape
103+
104+
// somehow this ambiguity works and doesn't lead to a loop,
105+
// but it's confusing ...
106+
if (lastEx == null) {
107+
_log(level, msg);
108+
} else {
109+
_log(level, msg, lastEx);
110+
}
111+
}
112+
}
113+
114+
115+

‎test/src/xmlobject/checkin/CDataTest.java

+4-4
Original file line numberDiff line numberDiff line change
@@ -53,8 +53,8 @@ public void testCData1()
5353
throws Exception
5454
{
5555
String xmlText = "<a><![CDATA[cdata text]]></a>";
56-
57-
checkCData(xmlText, xmlText, xmlText);
56+
String resultText = "<a>cdata text</a>";
57+
checkCData(xmlText, resultText, resultText);
5858
}
5959

6060
public void testCData2()
@@ -64,10 +64,10 @@ public void testCData2()
6464
"<b><![CDATA[cdata text]]> regular text</b>" + NL +
6565
"</a>";
6666
String expected1 = "<a>\n" +
67-
"<b><![CDATA[cdata text regular text]]></b>\n" +
67+
"<b>cdata text regular text</b>\n" +
6868
"</a>";
6969
String expected2 = "<a>" + NL +
70-
" <b><![CDATA[cdata text regular text]]></b>" + NL +
70+
" <b>cdata text regular text</b>" + NL +
7171
"</a>";
7272

7373
checkCData(xmlText, expected1, expected2);

0 commit comments

Comments
 (0)
This repository has been archived.