| <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd"> |
| <html lang="en"> |
| <head> |
| <title>Source code</title> |
| <link rel="stylesheet" type="text/css" href="../../../../../../../../stylesheet.css" title="Style"> |
| </head> |
| <body> |
| <div class="sourceContainer"> |
| <pre><span class="sourceLineNo">001</span>/*<a name="line.1"></a> |
| <span class="sourceLineNo">002</span> * Licensed to the Apache Software Foundation (ASF) under one or more<a name="line.2"></a> |
| <span class="sourceLineNo">003</span> * contributor license agreements. See the NOTICE file distributed with<a name="line.3"></a> |
| <span class="sourceLineNo">004</span> * this work for additional information regarding copyright ownership.<a name="line.4"></a> |
| <span class="sourceLineNo">005</span> * The ASF licenses this file to You under the Apache license, Version 2.0<a name="line.5"></a> |
| <span class="sourceLineNo">006</span> * (the "License"); you may not use this file except in compliance with<a name="line.6"></a> |
| <span class="sourceLineNo">007</span> * the License. You may obtain a copy of the License at<a name="line.7"></a> |
| <span class="sourceLineNo">008</span> *<a name="line.8"></a> |
| <span class="sourceLineNo">009</span> * http://www.apache.org/licenses/LICENSE-2.0<a name="line.9"></a> |
| <span class="sourceLineNo">010</span> *<a name="line.10"></a> |
| <span class="sourceLineNo">011</span> * Unless required by applicable law or agreed to in writing, software<a name="line.11"></a> |
| <span class="sourceLineNo">012</span> * distributed under the License is distributed on an "AS IS" BASIS,<a name="line.12"></a> |
| <span class="sourceLineNo">013</span> * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.<a name="line.13"></a> |
| <span class="sourceLineNo">014</span> * See the license for the specific language governing permissions and<a name="line.14"></a> |
| <span class="sourceLineNo">015</span> * limitations under the license.<a name="line.15"></a> |
| <span class="sourceLineNo">016</span> */<a name="line.16"></a> |
| <span class="sourceLineNo">017</span>package org.apache.logging.log4j.core.config.xml;<a name="line.17"></a> |
| <span class="sourceLineNo">018</span><a name="line.18"></a> |
| <span class="sourceLineNo">019</span>import java.io.ByteArrayInputStream;<a name="line.19"></a> |
| <span class="sourceLineNo">020</span>import java.io.File;<a name="line.20"></a> |
| <span class="sourceLineNo">021</span>import java.io.IOException;<a name="line.21"></a> |
| <span class="sourceLineNo">022</span>import java.io.InputStream;<a name="line.22"></a> |
| <span class="sourceLineNo">023</span>import java.util.ArrayList;<a name="line.23"></a> |
| <span class="sourceLineNo">024</span>import java.util.Arrays;<a name="line.24"></a> |
| <span class="sourceLineNo">025</span>import java.util.List;<a name="line.25"></a> |
| <span class="sourceLineNo">026</span>import java.util.Map;<a name="line.26"></a> |
| <span class="sourceLineNo">027</span>import javax.xml.XMLConstants;<a name="line.27"></a> |
| <span class="sourceLineNo">028</span>import javax.xml.parsers.DocumentBuilder;<a name="line.28"></a> |
| <span class="sourceLineNo">029</span>import javax.xml.parsers.DocumentBuilderFactory;<a name="line.29"></a> |
| <span class="sourceLineNo">030</span>import javax.xml.parsers.ParserConfigurationException;<a name="line.30"></a> |
| <span class="sourceLineNo">031</span>import javax.xml.transform.stream.StreamSource;<a name="line.31"></a> |
| <span class="sourceLineNo">032</span>import javax.xml.validation.Schema;<a name="line.32"></a> |
| <span class="sourceLineNo">033</span>import javax.xml.validation.SchemaFactory;<a name="line.33"></a> |
| <span class="sourceLineNo">034</span>import javax.xml.validation.Validator;<a name="line.34"></a> |
| <span class="sourceLineNo">035</span><a name="line.35"></a> |
| <span class="sourceLineNo">036</span>import org.apache.logging.log4j.core.LoggerContext;<a name="line.36"></a> |
| <span class="sourceLineNo">037</span>import org.apache.logging.log4j.core.config.AbstractConfiguration;<a name="line.37"></a> |
| <span class="sourceLineNo">038</span>import org.apache.logging.log4j.core.config.Configuration;<a name="line.38"></a> |
| <span class="sourceLineNo">039</span>import org.apache.logging.log4j.core.config.ConfigurationSource;<a name="line.39"></a> |
| <span class="sourceLineNo">040</span>import org.apache.logging.log4j.core.config.Node;<a name="line.40"></a> |
| <span class="sourceLineNo">041</span>import org.apache.logging.log4j.core.config.Reconfigurable;<a name="line.41"></a> |
| <span class="sourceLineNo">042</span>import org.apache.logging.log4j.core.config.plugins.util.PluginType;<a name="line.42"></a> |
| <span class="sourceLineNo">043</span>import org.apache.logging.log4j.core.config.plugins.util.ResolverUtil;<a name="line.43"></a> |
| <span class="sourceLineNo">044</span>import org.apache.logging.log4j.core.config.status.StatusConfiguration;<a name="line.44"></a> |
| <span class="sourceLineNo">045</span>import org.apache.logging.log4j.core.util.Closer;<a name="line.45"></a> |
| <span class="sourceLineNo">046</span>import org.apache.logging.log4j.core.util.Loader;<a name="line.46"></a> |
| <span class="sourceLineNo">047</span>import org.apache.logging.log4j.core.util.Patterns;<a name="line.47"></a> |
| <span class="sourceLineNo">048</span>import org.apache.logging.log4j.core.util.Throwables;<a name="line.48"></a> |
| <span class="sourceLineNo">049</span>import org.w3c.dom.Attr;<a name="line.49"></a> |
| <span class="sourceLineNo">050</span>import org.w3c.dom.Document;<a name="line.50"></a> |
| <span class="sourceLineNo">051</span>import org.w3c.dom.Element;<a name="line.51"></a> |
| <span class="sourceLineNo">052</span>import org.w3c.dom.NamedNodeMap;<a name="line.52"></a> |
| <span class="sourceLineNo">053</span>import org.w3c.dom.NodeList;<a name="line.53"></a> |
| <span class="sourceLineNo">054</span>import org.w3c.dom.Text;<a name="line.54"></a> |
| <span class="sourceLineNo">055</span>import org.xml.sax.InputSource;<a name="line.55"></a> |
| <span class="sourceLineNo">056</span>import org.xml.sax.SAXException;<a name="line.56"></a> |
| <span class="sourceLineNo">057</span><a name="line.57"></a> |
| <span class="sourceLineNo">058</span>/**<a name="line.58"></a> |
| <span class="sourceLineNo">059</span> * Creates a Node hierarchy from an XML file.<a name="line.59"></a> |
| <span class="sourceLineNo">060</span> */<a name="line.60"></a> |
| <span class="sourceLineNo">061</span>public class XmlConfiguration extends AbstractConfiguration implements Reconfigurable {<a name="line.61"></a> |
| <span class="sourceLineNo">062</span><a name="line.62"></a> |
| <span class="sourceLineNo">063</span> private static final String XINCLUDE_FIXUP_LANGUAGE =<a name="line.63"></a> |
| <span class="sourceLineNo">064</span> "http://apache.org/xml/features/xinclude/fixup-language";<a name="line.64"></a> |
| <span class="sourceLineNo">065</span> private static final String XINCLUDE_FIXUP_BASE_URIS =<a name="line.65"></a> |
| <span class="sourceLineNo">066</span> "http://apache.org/xml/features/xinclude/fixup-base-uris";<a name="line.66"></a> |
| <span class="sourceLineNo">067</span> private static final String[] VERBOSE_CLASSES = new String[] {ResolverUtil.class.getName()};<a name="line.67"></a> |
| <span class="sourceLineNo">068</span> private static final String LOG4J_XSD = "Log4j-config.xsd";<a name="line.68"></a> |
| <span class="sourceLineNo">069</span><a name="line.69"></a> |
| <span class="sourceLineNo">070</span> private final List<Status> status = new ArrayList<>();<a name="line.70"></a> |
| <span class="sourceLineNo">071</span> private Element rootElement;<a name="line.71"></a> |
| <span class="sourceLineNo">072</span> private boolean strict;<a name="line.72"></a> |
| <span class="sourceLineNo">073</span> private String schemaResource;<a name="line.73"></a> |
| <span class="sourceLineNo">074</span><a name="line.74"></a> |
| <span class="sourceLineNo">075</span> public XmlConfiguration(final LoggerContext loggerContext, final ConfigurationSource configSource) {<a name="line.75"></a> |
| <span class="sourceLineNo">076</span> super(loggerContext, configSource);<a name="line.76"></a> |
| <span class="sourceLineNo">077</span> final File configFile = configSource.getFile();<a name="line.77"></a> |
| <span class="sourceLineNo">078</span> byte[] buffer = null;<a name="line.78"></a> |
| <span class="sourceLineNo">079</span><a name="line.79"></a> |
| <span class="sourceLineNo">080</span> try {<a name="line.80"></a> |
| <span class="sourceLineNo">081</span> final InputStream configStream = configSource.getInputStream();<a name="line.81"></a> |
| <span class="sourceLineNo">082</span> try {<a name="line.82"></a> |
| <span class="sourceLineNo">083</span> buffer = toByteArray(configStream);<a name="line.83"></a> |
| <span class="sourceLineNo">084</span> } finally {<a name="line.84"></a> |
| <span class="sourceLineNo">085</span> Closer.closeSilently(configStream);<a name="line.85"></a> |
| <span class="sourceLineNo">086</span> }<a name="line.86"></a> |
| <span class="sourceLineNo">087</span> final InputSource source = new InputSource(new ByteArrayInputStream(buffer));<a name="line.87"></a> |
| <span class="sourceLineNo">088</span> source.setSystemId(configSource.getLocation());<a name="line.88"></a> |
| <span class="sourceLineNo">089</span> final DocumentBuilder documentBuilder = newDocumentBuilder(true);<a name="line.89"></a> |
| <span class="sourceLineNo">090</span> Document document;<a name="line.90"></a> |
| <span class="sourceLineNo">091</span> try {<a name="line.91"></a> |
| <span class="sourceLineNo">092</span> document = documentBuilder.parse(source);<a name="line.92"></a> |
| <span class="sourceLineNo">093</span> } catch (final Exception e) {<a name="line.93"></a> |
| <span class="sourceLineNo">094</span> // LOG4J2-1127<a name="line.94"></a> |
| <span class="sourceLineNo">095</span> final Throwable throwable = Throwables.getRootCause(e);<a name="line.95"></a> |
| <span class="sourceLineNo">096</span> if (throwable instanceof UnsupportedOperationException) {<a name="line.96"></a> |
| <span class="sourceLineNo">097</span> LOGGER.warn(<a name="line.97"></a> |
| <span class="sourceLineNo">098</span> "The DocumentBuilder {} does not support an operation: {}."<a name="line.98"></a> |
| <span class="sourceLineNo">099</span> + "Trying again without XInclude...",<a name="line.99"></a> |
| <span class="sourceLineNo">100</span> documentBuilder, e);<a name="line.100"></a> |
| <span class="sourceLineNo">101</span> document = newDocumentBuilder(false).parse(source);<a name="line.101"></a> |
| <span class="sourceLineNo">102</span> } else {<a name="line.102"></a> |
| <span class="sourceLineNo">103</span> throw e;<a name="line.103"></a> |
| <span class="sourceLineNo">104</span> }<a name="line.104"></a> |
| <span class="sourceLineNo">105</span> }<a name="line.105"></a> |
| <span class="sourceLineNo">106</span> rootElement = document.getDocumentElement();<a name="line.106"></a> |
| <span class="sourceLineNo">107</span> final Map<String, String> attrs = processAttributes(rootNode, rootElement);<a name="line.107"></a> |
| <span class="sourceLineNo">108</span> final StatusConfiguration statusConfig = new StatusConfiguration().withVerboseClasses(VERBOSE_CLASSES)<a name="line.108"></a> |
| <span class="sourceLineNo">109</span> .withStatus(getDefaultStatus());<a name="line.109"></a> |
| <span class="sourceLineNo">110</span> int monitorIntervalSeconds = 0;<a name="line.110"></a> |
| <span class="sourceLineNo">111</span> for (final Map.Entry<String, String> entry : attrs.entrySet()) {<a name="line.111"></a> |
| <span class="sourceLineNo">112</span> final String key = entry.getKey();<a name="line.112"></a> |
| <span class="sourceLineNo">113</span> final String value = getStrSubstitutor().replace(entry.getValue());<a name="line.113"></a> |
| <span class="sourceLineNo">114</span> if ("status".equalsIgnoreCase(key)) {<a name="line.114"></a> |
| <span class="sourceLineNo">115</span> statusConfig.withStatus(value);<a name="line.115"></a> |
| <span class="sourceLineNo">116</span> } else if ("dest".equalsIgnoreCase(key)) {<a name="line.116"></a> |
| <span class="sourceLineNo">117</span> statusConfig.withDestination(value);<a name="line.117"></a> |
| <span class="sourceLineNo">118</span> } else if ("shutdownHook".equalsIgnoreCase(key)) {<a name="line.118"></a> |
| <span class="sourceLineNo">119</span> isShutdownHookEnabled = !"disable".equalsIgnoreCase(value);<a name="line.119"></a> |
| <span class="sourceLineNo">120</span> } else if ("shutdownTimeout".equalsIgnoreCase(key)) {<a name="line.120"></a> |
| <span class="sourceLineNo">121</span> shutdownTimeoutMillis = Long.parseLong(value);<a name="line.121"></a> |
| <span class="sourceLineNo">122</span> } else if ("verbose".equalsIgnoreCase(key)) {<a name="line.122"></a> |
| <span class="sourceLineNo">123</span> statusConfig.withVerbosity(value);<a name="line.123"></a> |
| <span class="sourceLineNo">124</span> } else if ("packages".equalsIgnoreCase(key)) {<a name="line.124"></a> |
| <span class="sourceLineNo">125</span> pluginPackages.addAll(Arrays.asList(value.split(Patterns.COMMA_SEPARATOR)));<a name="line.125"></a> |
| <span class="sourceLineNo">126</span> } else if ("name".equalsIgnoreCase(key)) {<a name="line.126"></a> |
| <span class="sourceLineNo">127</span> setName(value);<a name="line.127"></a> |
| <span class="sourceLineNo">128</span> } else if ("strict".equalsIgnoreCase(key)) {<a name="line.128"></a> |
| <span class="sourceLineNo">129</span> strict = Boolean.parseBoolean(value);<a name="line.129"></a> |
| <span class="sourceLineNo">130</span> } else if ("schema".equalsIgnoreCase(key)) {<a name="line.130"></a> |
| <span class="sourceLineNo">131</span> schemaResource = value;<a name="line.131"></a> |
| <span class="sourceLineNo">132</span> } else if ("monitorInterval".equalsIgnoreCase(key)) {<a name="line.132"></a> |
| <span class="sourceLineNo">133</span> monitorIntervalSeconds = Integer.parseInt(value);<a name="line.133"></a> |
| <span class="sourceLineNo">134</span> } else if ("advertiser".equalsIgnoreCase(key)) {<a name="line.134"></a> |
| <span class="sourceLineNo">135</span> createAdvertiser(value, configSource, buffer, "text/xml");<a name="line.135"></a> |
| <span class="sourceLineNo">136</span> }<a name="line.136"></a> |
| <span class="sourceLineNo">137</span> }<a name="line.137"></a> |
| <span class="sourceLineNo">138</span> initializeWatchers(this, configSource, monitorIntervalSeconds);<a name="line.138"></a> |
| <span class="sourceLineNo">139</span> statusConfig.initialize();<a name="line.139"></a> |
| <span class="sourceLineNo">140</span> } catch (final SAXException | IOException | ParserConfigurationException e) {<a name="line.140"></a> |
| <span class="sourceLineNo">141</span> LOGGER.error("Error parsing " + configSource.getLocation(), e);<a name="line.141"></a> |
| <span class="sourceLineNo">142</span> }<a name="line.142"></a> |
| <span class="sourceLineNo">143</span> if (strict && schemaResource != null && buffer != null) {<a name="line.143"></a> |
| <span class="sourceLineNo">144</span> try (InputStream is = Loader.getResourceAsStream(schemaResource, XmlConfiguration.class.getClassLoader())) {<a name="line.144"></a> |
| <span class="sourceLineNo">145</span> if (is != null) {<a name="line.145"></a> |
| <span class="sourceLineNo">146</span> final javax.xml.transform.Source src = new StreamSource(is, LOG4J_XSD);<a name="line.146"></a> |
| <span class="sourceLineNo">147</span> final SchemaFactory factory = SchemaFactory.newInstance(XMLConstants.W3C_XML_SCHEMA_NS_URI);<a name="line.147"></a> |
| <span class="sourceLineNo">148</span> Schema schema = null;<a name="line.148"></a> |
| <span class="sourceLineNo">149</span> try {<a name="line.149"></a> |
| <span class="sourceLineNo">150</span> schema = factory.newSchema(src);<a name="line.150"></a> |
| <span class="sourceLineNo">151</span> } catch (final SAXException ex) {<a name="line.151"></a> |
| <span class="sourceLineNo">152</span> LOGGER.error("Error parsing Log4j schema", ex);<a name="line.152"></a> |
| <span class="sourceLineNo">153</span> }<a name="line.153"></a> |
| <span class="sourceLineNo">154</span> if (schema != null) {<a name="line.154"></a> |
| <span class="sourceLineNo">155</span> final Validator validator = schema.newValidator();<a name="line.155"></a> |
| <span class="sourceLineNo">156</span> try {<a name="line.156"></a> |
| <span class="sourceLineNo">157</span> validator.validate(new StreamSource(new ByteArrayInputStream(buffer)));<a name="line.157"></a> |
| <span class="sourceLineNo">158</span> } catch (final IOException ioe) {<a name="line.158"></a> |
| <span class="sourceLineNo">159</span> LOGGER.error("Error reading configuration for validation", ioe);<a name="line.159"></a> |
| <span class="sourceLineNo">160</span> } catch (final SAXException ex) {<a name="line.160"></a> |
| <span class="sourceLineNo">161</span> LOGGER.error("Error validating configuration", ex);<a name="line.161"></a> |
| <span class="sourceLineNo">162</span> }<a name="line.162"></a> |
| <span class="sourceLineNo">163</span> }<a name="line.163"></a> |
| <span class="sourceLineNo">164</span> }<a name="line.164"></a> |
| <span class="sourceLineNo">165</span> } catch (final Exception ex) {<a name="line.165"></a> |
| <span class="sourceLineNo">166</span> LOGGER.error("Unable to access schema {}", this.schemaResource, ex);<a name="line.166"></a> |
| <span class="sourceLineNo">167</span> }<a name="line.167"></a> |
| <span class="sourceLineNo">168</span> }<a name="line.168"></a> |
| <span class="sourceLineNo">169</span><a name="line.169"></a> |
| <span class="sourceLineNo">170</span> if (getName() == null) {<a name="line.170"></a> |
| <span class="sourceLineNo">171</span> setName(configSource.getLocation());<a name="line.171"></a> |
| <span class="sourceLineNo">172</span> }<a name="line.172"></a> |
| <span class="sourceLineNo">173</span> }<a name="line.173"></a> |
| <span class="sourceLineNo">174</span><a name="line.174"></a> |
| <span class="sourceLineNo">175</span> /**<a name="line.175"></a> |
| <span class="sourceLineNo">176</span> * Creates a new DocumentBuilder suitable for parsing a configuration file.<a name="line.176"></a> |
| <span class="sourceLineNo">177</span> *<a name="line.177"></a> |
| <span class="sourceLineNo">178</span> * @param xIncludeAware enabled XInclude<a name="line.178"></a> |
| <span class="sourceLineNo">179</span> * @return a new DocumentBuilder<a name="line.179"></a> |
| <span class="sourceLineNo">180</span> * @throws ParserConfigurationException<a name="line.180"></a> |
| <span class="sourceLineNo">181</span> */<a name="line.181"></a> |
| <span class="sourceLineNo">182</span> static DocumentBuilder newDocumentBuilder(final boolean xIncludeAware) throws ParserConfigurationException {<a name="line.182"></a> |
| <span class="sourceLineNo">183</span> final DocumentBuilderFactory factory = DocumentBuilderFactory.newInstance();<a name="line.183"></a> |
| <span class="sourceLineNo">184</span> factory.setNamespaceAware(true);<a name="line.184"></a> |
| <span class="sourceLineNo">185</span><a name="line.185"></a> |
| <span class="sourceLineNo">186</span> disableDtdProcessing(factory);<a name="line.186"></a> |
| <span class="sourceLineNo">187</span><a name="line.187"></a> |
| <span class="sourceLineNo">188</span> if (xIncludeAware) {<a name="line.188"></a> |
| <span class="sourceLineNo">189</span> enableXInclude(factory);<a name="line.189"></a> |
| <span class="sourceLineNo">190</span> }<a name="line.190"></a> |
| <span class="sourceLineNo">191</span> return factory.newDocumentBuilder();<a name="line.191"></a> |
| <span class="sourceLineNo">192</span> }<a name="line.192"></a> |
| <span class="sourceLineNo">193</span><a name="line.193"></a> |
| <span class="sourceLineNo">194</span> private static void disableDtdProcessing(final DocumentBuilderFactory factory) {<a name="line.194"></a> |
| <span class="sourceLineNo">195</span> factory.setValidating(false);<a name="line.195"></a> |
| <span class="sourceLineNo">196</span> factory.setExpandEntityReferences(false);<a name="line.196"></a> |
| <span class="sourceLineNo">197</span> setFeature(factory, "http://xml.org/sax/features/external-general-entities", false);<a name="line.197"></a> |
| <span class="sourceLineNo">198</span> setFeature(factory, "http://xml.org/sax/features/external-parameter-entities", false);<a name="line.198"></a> |
| <span class="sourceLineNo">199</span> setFeature(factory, "http://apache.org/xml/features/nonvalidating/load-external-dtd", false);<a name="line.199"></a> |
| <span class="sourceLineNo">200</span> }<a name="line.200"></a> |
| <span class="sourceLineNo">201</span><a name="line.201"></a> |
| <span class="sourceLineNo">202</span> private static void setFeature(final DocumentBuilderFactory factory, final String featureName, final boolean value) {<a name="line.202"></a> |
| <span class="sourceLineNo">203</span> try {<a name="line.203"></a> |
| <span class="sourceLineNo">204</span> factory.setFeature(featureName, value);<a name="line.204"></a> |
| <span class="sourceLineNo">205</span> } catch (Exception | LinkageError e) {<a name="line.205"></a> |
| <span class="sourceLineNo">206</span> getStatusLogger().error("Caught {} setting feature {} to {} on DocumentBuilderFactory {}: {}",<a name="line.206"></a> |
| <span class="sourceLineNo">207</span> e.getClass().getCanonicalName(), featureName, value, factory, e, e);<a name="line.207"></a> |
| <span class="sourceLineNo">208</span> }<a name="line.208"></a> |
| <span class="sourceLineNo">209</span> }<a name="line.209"></a> |
| <span class="sourceLineNo">210</span><a name="line.210"></a> |
| <span class="sourceLineNo">211</span> /**<a name="line.211"></a> |
| <span class="sourceLineNo">212</span> * Enables XInclude for the given DocumentBuilderFactory<a name="line.212"></a> |
| <span class="sourceLineNo">213</span> *<a name="line.213"></a> |
| <span class="sourceLineNo">214</span> * @param factory a DocumentBuilderFactory<a name="line.214"></a> |
| <span class="sourceLineNo">215</span> */<a name="line.215"></a> |
| <span class="sourceLineNo">216</span> private static void enableXInclude(final DocumentBuilderFactory factory) {<a name="line.216"></a> |
| <span class="sourceLineNo">217</span> try {<a name="line.217"></a> |
| <span class="sourceLineNo">218</span> // Alternative: We set if a system property on the command line is set, for example:<a name="line.218"></a> |
| <span class="sourceLineNo">219</span> // -DLog4j.XInclude=true<a name="line.219"></a> |
| <span class="sourceLineNo">220</span> factory.setXIncludeAware(true);<a name="line.220"></a> |
| <span class="sourceLineNo">221</span> } catch (final UnsupportedOperationException e) {<a name="line.221"></a> |
| <span class="sourceLineNo">222</span> LOGGER.warn("The DocumentBuilderFactory [{}] does not support XInclude: {}", factory, e);<a name="line.222"></a> |
| <span class="sourceLineNo">223</span> } catch (@SuppressWarnings("ErrorNotRethrown") final AbstractMethodError | NoSuchMethodError err) {<a name="line.223"></a> |
| <span class="sourceLineNo">224</span> LOGGER.warn("The DocumentBuilderFactory [{}] is out of date and does not support XInclude: {}", factory,<a name="line.224"></a> |
| <span class="sourceLineNo">225</span> err);<a name="line.225"></a> |
| <span class="sourceLineNo">226</span> }<a name="line.226"></a> |
| <span class="sourceLineNo">227</span> try {<a name="line.227"></a> |
| <span class="sourceLineNo">228</span> // Alternative: We could specify all features and values with system properties like:<a name="line.228"></a> |
| <span class="sourceLineNo">229</span> // -DLog4j.DocumentBuilderFactory.Feature="http://apache.org/xml/features/xinclude/fixup-base-uris true"<a name="line.229"></a> |
| <span class="sourceLineNo">230</span> factory.setFeature(XINCLUDE_FIXUP_BASE_URIS, true);<a name="line.230"></a> |
| <span class="sourceLineNo">231</span> } catch (final ParserConfigurationException e) {<a name="line.231"></a> |
| <span class="sourceLineNo">232</span> LOGGER.warn("The DocumentBuilderFactory [{}] does not support the feature [{}]: {}", factory,<a name="line.232"></a> |
| <span class="sourceLineNo">233</span> XINCLUDE_FIXUP_BASE_URIS, e);<a name="line.233"></a> |
| <span class="sourceLineNo">234</span> } catch (@SuppressWarnings("ErrorNotRethrown") final AbstractMethodError err) {<a name="line.234"></a> |
| <span class="sourceLineNo">235</span> LOGGER.warn("The DocumentBuilderFactory [{}] is out of date and does not support setFeature: {}", factory,<a name="line.235"></a> |
| <span class="sourceLineNo">236</span> err);<a name="line.236"></a> |
| <span class="sourceLineNo">237</span> }<a name="line.237"></a> |
| <span class="sourceLineNo">238</span> try {<a name="line.238"></a> |
| <span class="sourceLineNo">239</span> factory.setFeature(XINCLUDE_FIXUP_LANGUAGE, true);<a name="line.239"></a> |
| <span class="sourceLineNo">240</span> } catch (final ParserConfigurationException e) {<a name="line.240"></a> |
| <span class="sourceLineNo">241</span> LOGGER.warn("The DocumentBuilderFactory [{}] does not support the feature [{}]: {}", factory,<a name="line.241"></a> |
| <span class="sourceLineNo">242</span> XINCLUDE_FIXUP_LANGUAGE, e);<a name="line.242"></a> |
| <span class="sourceLineNo">243</span> } catch (@SuppressWarnings("ErrorNotRethrown") final AbstractMethodError err) {<a name="line.243"></a> |
| <span class="sourceLineNo">244</span> LOGGER.warn("The DocumentBuilderFactory [{}] is out of date and does not support setFeature: {}", factory,<a name="line.244"></a> |
| <span class="sourceLineNo">245</span> err);<a name="line.245"></a> |
| <span class="sourceLineNo">246</span> }<a name="line.246"></a> |
| <span class="sourceLineNo">247</span> }<a name="line.247"></a> |
| <span class="sourceLineNo">248</span><a name="line.248"></a> |
| <span class="sourceLineNo">249</span> @Override<a name="line.249"></a> |
| <span class="sourceLineNo">250</span> public void setup() {<a name="line.250"></a> |
| <span class="sourceLineNo">251</span> if (rootElement == null) {<a name="line.251"></a> |
| <span class="sourceLineNo">252</span> LOGGER.error("No logging configuration");<a name="line.252"></a> |
| <span class="sourceLineNo">253</span> return;<a name="line.253"></a> |
| <span class="sourceLineNo">254</span> }<a name="line.254"></a> |
| <span class="sourceLineNo">255</span> constructHierarchy(rootNode, rootElement);<a name="line.255"></a> |
| <span class="sourceLineNo">256</span> if (status.size() > 0) {<a name="line.256"></a> |
| <span class="sourceLineNo">257</span> for (final Status s : status) {<a name="line.257"></a> |
| <span class="sourceLineNo">258</span> LOGGER.error("Error processing element {} ({}): {}", s.name, s.element, s.errorType);<a name="line.258"></a> |
| <span class="sourceLineNo">259</span> }<a name="line.259"></a> |
| <span class="sourceLineNo">260</span> return;<a name="line.260"></a> |
| <span class="sourceLineNo">261</span> }<a name="line.261"></a> |
| <span class="sourceLineNo">262</span> rootElement = null;<a name="line.262"></a> |
| <span class="sourceLineNo">263</span> }<a name="line.263"></a> |
| <span class="sourceLineNo">264</span><a name="line.264"></a> |
| <span class="sourceLineNo">265</span> @Override<a name="line.265"></a> |
| <span class="sourceLineNo">266</span> public Configuration reconfigure() {<a name="line.266"></a> |
| <span class="sourceLineNo">267</span> try {<a name="line.267"></a> |
| <span class="sourceLineNo">268</span> final ConfigurationSource source = getConfigurationSource().resetInputStream();<a name="line.268"></a> |
| <span class="sourceLineNo">269</span> if (source == null) {<a name="line.269"></a> |
| <span class="sourceLineNo">270</span> return null;<a name="line.270"></a> |
| <span class="sourceLineNo">271</span> }<a name="line.271"></a> |
| <span class="sourceLineNo">272</span> final XmlConfiguration config = new XmlConfiguration(getLoggerContext(), source);<a name="line.272"></a> |
| <span class="sourceLineNo">273</span> return config.rootElement == null ? null : config;<a name="line.273"></a> |
| <span class="sourceLineNo">274</span> } catch (final IOException ex) {<a name="line.274"></a> |
| <span class="sourceLineNo">275</span> LOGGER.error("Cannot locate file {}", getConfigurationSource(), ex);<a name="line.275"></a> |
| <span class="sourceLineNo">276</span> }<a name="line.276"></a> |
| <span class="sourceLineNo">277</span> return null;<a name="line.277"></a> |
| <span class="sourceLineNo">278</span> }<a name="line.278"></a> |
| <span class="sourceLineNo">279</span><a name="line.279"></a> |
| <span class="sourceLineNo">280</span> private void constructHierarchy(final Node node, final Element element) {<a name="line.280"></a> |
| <span class="sourceLineNo">281</span> processAttributes(node, element);<a name="line.281"></a> |
| <span class="sourceLineNo">282</span> final StringBuilder buffer = new StringBuilder();<a name="line.282"></a> |
| <span class="sourceLineNo">283</span> final NodeList list = element.getChildNodes();<a name="line.283"></a> |
| <span class="sourceLineNo">284</span> final List<Node> children = node.getChildren();<a name="line.284"></a> |
| <span class="sourceLineNo">285</span> for (int i = 0; i < list.getLength(); i++) {<a name="line.285"></a> |
| <span class="sourceLineNo">286</span> final org.w3c.dom.Node w3cNode = list.item(i);<a name="line.286"></a> |
| <span class="sourceLineNo">287</span> if (w3cNode instanceof Element) {<a name="line.287"></a> |
| <span class="sourceLineNo">288</span> final Element child = (Element) w3cNode;<a name="line.288"></a> |
| <span class="sourceLineNo">289</span> final String name = getType(child);<a name="line.289"></a> |
| <span class="sourceLineNo">290</span> final PluginType<?> type = pluginManager.getPluginType(name);<a name="line.290"></a> |
| <span class="sourceLineNo">291</span> final Node childNode = new Node(node, name, type);<a name="line.291"></a> |
| <span class="sourceLineNo">292</span> constructHierarchy(childNode, child);<a name="line.292"></a> |
| <span class="sourceLineNo">293</span> if (type == null) {<a name="line.293"></a> |
| <span class="sourceLineNo">294</span> final String value = childNode.getValue();<a name="line.294"></a> |
| <span class="sourceLineNo">295</span> if (!childNode.hasChildren() && value != null) {<a name="line.295"></a> |
| <span class="sourceLineNo">296</span> node.getAttributes().put(name, value);<a name="line.296"></a> |
| <span class="sourceLineNo">297</span> } else {<a name="line.297"></a> |
| <span class="sourceLineNo">298</span> status.add(new Status(name, element, ErrorType.CLASS_NOT_FOUND));<a name="line.298"></a> |
| <span class="sourceLineNo">299</span> }<a name="line.299"></a> |
| <span class="sourceLineNo">300</span> } else {<a name="line.300"></a> |
| <span class="sourceLineNo">301</span> children.add(childNode);<a name="line.301"></a> |
| <span class="sourceLineNo">302</span> }<a name="line.302"></a> |
| <span class="sourceLineNo">303</span> } else if (w3cNode instanceof Text) {<a name="line.303"></a> |
| <span class="sourceLineNo">304</span> final Text data = (Text) w3cNode;<a name="line.304"></a> |
| <span class="sourceLineNo">305</span> buffer.append(data.getData());<a name="line.305"></a> |
| <span class="sourceLineNo">306</span> }<a name="line.306"></a> |
| <span class="sourceLineNo">307</span> }<a name="line.307"></a> |
| <span class="sourceLineNo">308</span><a name="line.308"></a> |
| <span class="sourceLineNo">309</span> final String text = buffer.toString().trim();<a name="line.309"></a> |
| <span class="sourceLineNo">310</span> if (text.length() > 0 || (!node.hasChildren() && !node.isRoot())) {<a name="line.310"></a> |
| <span class="sourceLineNo">311</span> node.setValue(text);<a name="line.311"></a> |
| <span class="sourceLineNo">312</span> }<a name="line.312"></a> |
| <span class="sourceLineNo">313</span> }<a name="line.313"></a> |
| <span class="sourceLineNo">314</span><a name="line.314"></a> |
| <span class="sourceLineNo">315</span> private String getType(final Element element) {<a name="line.315"></a> |
| <span class="sourceLineNo">316</span> if (strict) {<a name="line.316"></a> |
| <span class="sourceLineNo">317</span> final NamedNodeMap attrs = element.getAttributes();<a name="line.317"></a> |
| <span class="sourceLineNo">318</span> for (int i = 0; i < attrs.getLength(); ++i) {<a name="line.318"></a> |
| <span class="sourceLineNo">319</span> final org.w3c.dom.Node w3cNode = attrs.item(i);<a name="line.319"></a> |
| <span class="sourceLineNo">320</span> if (w3cNode instanceof Attr) {<a name="line.320"></a> |
| <span class="sourceLineNo">321</span> final Attr attr = (Attr) w3cNode;<a name="line.321"></a> |
| <span class="sourceLineNo">322</span> if (attr.getName().equalsIgnoreCase("type")) {<a name="line.322"></a> |
| <span class="sourceLineNo">323</span> final String type = attr.getValue();<a name="line.323"></a> |
| <span class="sourceLineNo">324</span> attrs.removeNamedItem(attr.getName());<a name="line.324"></a> |
| <span class="sourceLineNo">325</span> return type;<a name="line.325"></a> |
| <span class="sourceLineNo">326</span> }<a name="line.326"></a> |
| <span class="sourceLineNo">327</span> }<a name="line.327"></a> |
| <span class="sourceLineNo">328</span> }<a name="line.328"></a> |
| <span class="sourceLineNo">329</span> }<a name="line.329"></a> |
| <span class="sourceLineNo">330</span> return element.getTagName();<a name="line.330"></a> |
| <span class="sourceLineNo">331</span> }<a name="line.331"></a> |
| <span class="sourceLineNo">332</span><a name="line.332"></a> |
| <span class="sourceLineNo">333</span> private Map<String, String> processAttributes(final Node node, final Element element) {<a name="line.333"></a> |
| <span class="sourceLineNo">334</span> final NamedNodeMap attrs = element.getAttributes();<a name="line.334"></a> |
| <span class="sourceLineNo">335</span> final Map<String, String> attributes = node.getAttributes();<a name="line.335"></a> |
| <span class="sourceLineNo">336</span><a name="line.336"></a> |
| <span class="sourceLineNo">337</span> for (int i = 0; i < attrs.getLength(); ++i) {<a name="line.337"></a> |
| <span class="sourceLineNo">338</span> final org.w3c.dom.Node w3cNode = attrs.item(i);<a name="line.338"></a> |
| <span class="sourceLineNo">339</span> if (w3cNode instanceof Attr) {<a name="line.339"></a> |
| <span class="sourceLineNo">340</span> final Attr attr = (Attr) w3cNode;<a name="line.340"></a> |
| <span class="sourceLineNo">341</span> if (attr.getName().equals("xml:base")) {<a name="line.341"></a> |
| <span class="sourceLineNo">342</span> continue;<a name="line.342"></a> |
| <span class="sourceLineNo">343</span> }<a name="line.343"></a> |
| <span class="sourceLineNo">344</span> attributes.put(attr.getName(), attr.getValue());<a name="line.344"></a> |
| <span class="sourceLineNo">345</span> }<a name="line.345"></a> |
| <span class="sourceLineNo">346</span> }<a name="line.346"></a> |
| <span class="sourceLineNo">347</span> return attributes;<a name="line.347"></a> |
| <span class="sourceLineNo">348</span> }<a name="line.348"></a> |
| <span class="sourceLineNo">349</span><a name="line.349"></a> |
| <span class="sourceLineNo">350</span> @Override<a name="line.350"></a> |
| <span class="sourceLineNo">351</span> public String toString() {<a name="line.351"></a> |
| <span class="sourceLineNo">352</span> return getClass().getSimpleName() + "[location=" + getConfigurationSource() + "]";<a name="line.352"></a> |
| <span class="sourceLineNo">353</span> }<a name="line.353"></a> |
| <span class="sourceLineNo">354</span><a name="line.354"></a> |
| <span class="sourceLineNo">355</span> /**<a name="line.355"></a> |
| <span class="sourceLineNo">356</span> * The error that occurred.<a name="line.356"></a> |
| <span class="sourceLineNo">357</span> */<a name="line.357"></a> |
| <span class="sourceLineNo">358</span> private enum ErrorType {<a name="line.358"></a> |
| <span class="sourceLineNo">359</span> CLASS_NOT_FOUND<a name="line.359"></a> |
| <span class="sourceLineNo">360</span> }<a name="line.360"></a> |
| <span class="sourceLineNo">361</span><a name="line.361"></a> |
| <span class="sourceLineNo">362</span> /**<a name="line.362"></a> |
| <span class="sourceLineNo">363</span> * Status for recording errors.<a name="line.363"></a> |
| <span class="sourceLineNo">364</span> */<a name="line.364"></a> |
| <span class="sourceLineNo">365</span> private static class Status {<a name="line.365"></a> |
| <span class="sourceLineNo">366</span> private final Element element;<a name="line.366"></a> |
| <span class="sourceLineNo">367</span> private final String name;<a name="line.367"></a> |
| <span class="sourceLineNo">368</span> private final ErrorType errorType;<a name="line.368"></a> |
| <span class="sourceLineNo">369</span><a name="line.369"></a> |
| <span class="sourceLineNo">370</span> public Status(final String name, final Element element, final ErrorType errorType) {<a name="line.370"></a> |
| <span class="sourceLineNo">371</span> this.name = name;<a name="line.371"></a> |
| <span class="sourceLineNo">372</span> this.element = element;<a name="line.372"></a> |
| <span class="sourceLineNo">373</span> this.errorType = errorType;<a name="line.373"></a> |
| <span class="sourceLineNo">374</span> }<a name="line.374"></a> |
| <span class="sourceLineNo">375</span><a name="line.375"></a> |
| <span class="sourceLineNo">376</span> @Override<a name="line.376"></a> |
| <span class="sourceLineNo">377</span> public String toString() {<a name="line.377"></a> |
| <span class="sourceLineNo">378</span> return "Status [name=" + name + ", element=" + element + ", errorType=" + errorType + "]";<a name="line.378"></a> |
| <span class="sourceLineNo">379</span> }<a name="line.379"></a> |
| <span class="sourceLineNo">380</span><a name="line.380"></a> |
| <span class="sourceLineNo">381</span> }<a name="line.381"></a> |
| <span class="sourceLineNo">382</span><a name="line.382"></a> |
| <span class="sourceLineNo">383</span>}<a name="line.383"></a> |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| </pre> |
| </div> |
| </body> |
| </html> |
