blob: e1b5a337e72f380e2a7e0c26eef1bfc50dccd10d [file] [log] [blame]
<!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.log4j.config;<a name="line.17"></a>
<span class="sourceLineNo">018</span><a name="line.18"></a>
<span class="sourceLineNo">019</span>import java.io.IOException;<a name="line.19"></a>
<span class="sourceLineNo">020</span>import java.io.InputStream;<a name="line.20"></a>
<span class="sourceLineNo">021</span>import java.util.Arrays;<a name="line.21"></a>
<span class="sourceLineNo">022</span>import java.util.HashMap;<a name="line.22"></a>
<span class="sourceLineNo">023</span>import java.util.Map;<a name="line.23"></a>
<span class="sourceLineNo">024</span>import java.util.Objects;<a name="line.24"></a>
<span class="sourceLineNo">025</span>import java.util.Properties;<a name="line.25"></a>
<span class="sourceLineNo">026</span>import java.util.TreeMap;<a name="line.26"></a>
<span class="sourceLineNo">027</span><a name="line.27"></a>
<span class="sourceLineNo">028</span>import org.apache.logging.log4j.Level;<a name="line.28"></a>
<span class="sourceLineNo">029</span>import org.apache.logging.log4j.core.appender.ConsoleAppender;<a name="line.29"></a>
<span class="sourceLineNo">030</span>import org.apache.logging.log4j.core.appender.FileAppender;<a name="line.30"></a>
<span class="sourceLineNo">031</span>import org.apache.logging.log4j.core.appender.NullAppender;<a name="line.31"></a>
<span class="sourceLineNo">032</span>import org.apache.logging.log4j.core.appender.RollingFileAppender;<a name="line.32"></a>
<span class="sourceLineNo">033</span>import org.apache.logging.log4j.core.config.ConfigurationException;<a name="line.33"></a>
<span class="sourceLineNo">034</span>import org.apache.logging.log4j.core.config.builder.api.AppenderComponentBuilder;<a name="line.34"></a>
<span class="sourceLineNo">035</span>import org.apache.logging.log4j.core.config.builder.api.ComponentBuilder;<a name="line.35"></a>
<span class="sourceLineNo">036</span>import org.apache.logging.log4j.core.config.builder.api.ConfigurationBuilder;<a name="line.36"></a>
<span class="sourceLineNo">037</span>import org.apache.logging.log4j.core.config.builder.api.ConfigurationBuilderFactory;<a name="line.37"></a>
<span class="sourceLineNo">038</span>import org.apache.logging.log4j.core.config.builder.api.LayoutComponentBuilder;<a name="line.38"></a>
<span class="sourceLineNo">039</span>import org.apache.logging.log4j.core.config.builder.api.LoggerComponentBuilder;<a name="line.39"></a>
<span class="sourceLineNo">040</span>import org.apache.logging.log4j.core.config.builder.api.RootLoggerComponentBuilder;<a name="line.40"></a>
<span class="sourceLineNo">041</span>import org.apache.logging.log4j.core.config.builder.impl.BuiltConfiguration;<a name="line.41"></a>
<span class="sourceLineNo">042</span>import org.apache.logging.log4j.core.lookup.StrSubstitutor;<a name="line.42"></a>
<span class="sourceLineNo">043</span>import org.apache.logging.log4j.status.StatusLogger;<a name="line.43"></a>
<span class="sourceLineNo">044</span>import org.apache.logging.log4j.util.Strings;<a name="line.44"></a>
<span class="sourceLineNo">045</span><a name="line.45"></a>
<span class="sourceLineNo">046</span>/**<a name="line.46"></a>
<span class="sourceLineNo">047</span> * Experimental parser for Log4j 1.2 properties configuration files.<a name="line.47"></a>
<span class="sourceLineNo">048</span> *<a name="line.48"></a>
<span class="sourceLineNo">049</span> * This class is not thread-safe.<a name="line.49"></a>
<span class="sourceLineNo">050</span> * <a name="line.50"></a>
<span class="sourceLineNo">051</span> * &lt;p&gt;<a name="line.51"></a>
<span class="sourceLineNo">052</span> * From the Log4j 1.2 Javadocs:<a name="line.52"></a>
<span class="sourceLineNo">053</span> * &lt;/p&gt;<a name="line.53"></a>
<span class="sourceLineNo">054</span> * &lt;p&gt;<a name="line.54"></a>
<span class="sourceLineNo">055</span> * All option values admit variable substitution. The syntax of variable substitution is similar to that of Unix shells. The string between<a name="line.55"></a>
<span class="sourceLineNo">056</span> * an opening "${" and closing "}" is interpreted as a key. The value of the substituted variable can be defined as a system property or in<a name="line.56"></a>
<span class="sourceLineNo">057</span> * the configuration file itself. The value of the key is first searched in the system properties, and if not found there, it is then<a name="line.57"></a>
<span class="sourceLineNo">058</span> * searched in the configuration file being parsed. The corresponding value replaces the ${variableName} sequence. For example, if java.home<a name="line.58"></a>
<span class="sourceLineNo">059</span> * system property is set to /home/xyz, then every occurrence of the sequence ${java.home} will be interpreted as /home/xyz.<a name="line.59"></a>
<span class="sourceLineNo">060</span> * &lt;/p&gt;<a name="line.60"></a>
<span class="sourceLineNo">061</span> */<a name="line.61"></a>
<span class="sourceLineNo">062</span>public class Log4j1ConfigurationParser {<a name="line.62"></a>
<span class="sourceLineNo">063</span><a name="line.63"></a>
<span class="sourceLineNo">064</span> private static final String COMMA_DELIMITED_RE = "\\s*,\\s*";<a name="line.64"></a>
<span class="sourceLineNo">065</span> private static final String ROOTLOGGER = "rootLogger";<a name="line.65"></a>
<span class="sourceLineNo">066</span> private static final String ROOTCATEGORY = "rootCategory";<a name="line.66"></a>
<span class="sourceLineNo">067</span> private static final String TRUE = "true";<a name="line.67"></a>
<span class="sourceLineNo">068</span> private static final String FALSE = "false";<a name="line.68"></a>
<span class="sourceLineNo">069</span><a name="line.69"></a>
<span class="sourceLineNo">070</span> private final Properties properties = new Properties();<a name="line.70"></a>
<span class="sourceLineNo">071</span> private StrSubstitutor strSubstitutorProperties;<a name="line.71"></a>
<span class="sourceLineNo">072</span> private StrSubstitutor strSubstitutorSystem;<a name="line.72"></a>
<span class="sourceLineNo">073</span><a name="line.73"></a>
<span class="sourceLineNo">074</span> private final ConfigurationBuilder&lt;BuiltConfiguration&gt; builder = ConfigurationBuilderFactory<a name="line.74"></a>
<span class="sourceLineNo">075</span> .newConfigurationBuilder();<a name="line.75"></a>
<span class="sourceLineNo">076</span><a name="line.76"></a>
<span class="sourceLineNo">077</span> /**<a name="line.77"></a>
<span class="sourceLineNo">078</span> * Parses a Log4j 1.2 properties configuration file in ISO 8859-1 encoding into a ConfigurationBuilder.<a name="line.78"></a>
<span class="sourceLineNo">079</span> *<a name="line.79"></a>
<span class="sourceLineNo">080</span> * @param input<a name="line.80"></a>
<span class="sourceLineNo">081</span> * InputStream to read from is assumed to be ISO 8859-1, and will not be closed.<a name="line.81"></a>
<span class="sourceLineNo">082</span> * @return the populated ConfigurationBuilder, never {@literal null}<a name="line.82"></a>
<span class="sourceLineNo">083</span> * @throws IOException<a name="line.83"></a>
<span class="sourceLineNo">084</span> * if unable to read the input<a name="line.84"></a>
<span class="sourceLineNo">085</span> * @throws ConfigurationException<a name="line.85"></a>
<span class="sourceLineNo">086</span> * if the input does not contain a valid configuration<a name="line.86"></a>
<span class="sourceLineNo">087</span> */<a name="line.87"></a>
<span class="sourceLineNo">088</span> public ConfigurationBuilder&lt;BuiltConfiguration&gt; buildConfigurationBuilder(final InputStream input)<a name="line.88"></a>
<span class="sourceLineNo">089</span> throws IOException {<a name="line.89"></a>
<span class="sourceLineNo">090</span> try {<a name="line.90"></a>
<span class="sourceLineNo">091</span> properties.load(input);<a name="line.91"></a>
<span class="sourceLineNo">092</span> strSubstitutorProperties = new StrSubstitutor(properties);<a name="line.92"></a>
<span class="sourceLineNo">093</span> strSubstitutorSystem = new StrSubstitutor(System.getProperties());<a name="line.93"></a>
<span class="sourceLineNo">094</span> final String rootCategoryValue = getLog4jValue(ROOTCATEGORY);<a name="line.94"></a>
<span class="sourceLineNo">095</span> final String rootLoggerValue = getLog4jValue(ROOTLOGGER);<a name="line.95"></a>
<span class="sourceLineNo">096</span> if (rootCategoryValue == null &amp;&amp; rootLoggerValue == null) {<a name="line.96"></a>
<span class="sourceLineNo">097</span> // This is not a Log4j 1 properties configuration file.<a name="line.97"></a>
<span class="sourceLineNo">098</span> warn("Missing " + ROOTCATEGORY + " or " + ROOTLOGGER + " in " + input);<a name="line.98"></a>
<span class="sourceLineNo">099</span> // throw new ConfigurationException(<a name="line.99"></a>
<span class="sourceLineNo">100</span> // "Missing " + ROOTCATEGORY + " or " + ROOTLOGGER + " in " + input);<a name="line.100"></a>
<span class="sourceLineNo">101</span> }<a name="line.101"></a>
<span class="sourceLineNo">102</span> builder.setConfigurationName("Log4j1");<a name="line.102"></a>
<span class="sourceLineNo">103</span> // DEBUG<a name="line.103"></a>
<span class="sourceLineNo">104</span> final String debugValue = getLog4jValue("debug");<a name="line.104"></a>
<span class="sourceLineNo">105</span> if (Boolean.valueOf(debugValue)) {<a name="line.105"></a>
<span class="sourceLineNo">106</span> builder.setStatusLevel(Level.DEBUG);<a name="line.106"></a>
<span class="sourceLineNo">107</span> }<a name="line.107"></a>
<span class="sourceLineNo">108</span> // Root<a name="line.108"></a>
<span class="sourceLineNo">109</span> buildRootLogger(getLog4jValue(ROOTCATEGORY));<a name="line.109"></a>
<span class="sourceLineNo">110</span> buildRootLogger(getLog4jValue(ROOTLOGGER));<a name="line.110"></a>
<span class="sourceLineNo">111</span> // Appenders<a name="line.111"></a>
<span class="sourceLineNo">112</span> final Map&lt;String, String&gt; appenderNameToClassName = buildClassToPropertyPrefixMap();<a name="line.112"></a>
<span class="sourceLineNo">113</span> for (final Map.Entry&lt;String, String&gt; entry : appenderNameToClassName.entrySet()) {<a name="line.113"></a>
<span class="sourceLineNo">114</span> final String appenderName = entry.getKey();<a name="line.114"></a>
<span class="sourceLineNo">115</span> final String appenderClass = entry.getValue();<a name="line.115"></a>
<span class="sourceLineNo">116</span> buildAppender(appenderName, appenderClass);<a name="line.116"></a>
<span class="sourceLineNo">117</span> }<a name="line.117"></a>
<span class="sourceLineNo">118</span> // Loggers<a name="line.118"></a>
<span class="sourceLineNo">119</span> buildLoggers("log4j.category.");<a name="line.119"></a>
<span class="sourceLineNo">120</span> buildLoggers("log4j.logger.");<a name="line.120"></a>
<span class="sourceLineNo">121</span> buildProperties();<a name="line.121"></a>
<span class="sourceLineNo">122</span> return builder;<a name="line.122"></a>
<span class="sourceLineNo">123</span> } catch (final IllegalArgumentException e) {<a name="line.123"></a>
<span class="sourceLineNo">124</span> throw new ConfigurationException(e);<a name="line.124"></a>
<span class="sourceLineNo">125</span> }<a name="line.125"></a>
<span class="sourceLineNo">126</span> }<a name="line.126"></a>
<span class="sourceLineNo">127</span><a name="line.127"></a>
<span class="sourceLineNo">128</span> private void buildProperties() {<a name="line.128"></a>
<span class="sourceLineNo">129</span> for (final Map.Entry&lt;Object, Object&gt; entry : new TreeMap&lt;&gt;(properties).entrySet()) {<a name="line.129"></a>
<span class="sourceLineNo">130</span> final String key = entry.getKey().toString();<a name="line.130"></a>
<span class="sourceLineNo">131</span> if (!key.startsWith("log4j.") &amp;&amp; !key.equals(ROOTCATEGORY) &amp;&amp; !key.equals(ROOTLOGGER)) {<a name="line.131"></a>
<span class="sourceLineNo">132</span> builder.addProperty(key, Objects.toString(entry.getValue(), Strings.EMPTY));<a name="line.132"></a>
<span class="sourceLineNo">133</span> }<a name="line.133"></a>
<span class="sourceLineNo">134</span> }<a name="line.134"></a>
<span class="sourceLineNo">135</span> }<a name="line.135"></a>
<span class="sourceLineNo">136</span><a name="line.136"></a>
<span class="sourceLineNo">137</span> private void warn(final String string) {<a name="line.137"></a>
<span class="sourceLineNo">138</span> System.err.println(string);<a name="line.138"></a>
<span class="sourceLineNo">139</span> }<a name="line.139"></a>
<span class="sourceLineNo">140</span><a name="line.140"></a>
<span class="sourceLineNo">141</span> private Map&lt;String, String&gt; buildClassToPropertyPrefixMap() {<a name="line.141"></a>
<span class="sourceLineNo">142</span> final String prefix = "log4j.appender.";<a name="line.142"></a>
<span class="sourceLineNo">143</span> final int preLength = prefix.length();<a name="line.143"></a>
<span class="sourceLineNo">144</span> final Map&lt;String, String&gt; map = new HashMap&lt;&gt;();<a name="line.144"></a>
<span class="sourceLineNo">145</span> for (final Map.Entry&lt;Object, Object&gt; entry : properties.entrySet()) {<a name="line.145"></a>
<span class="sourceLineNo">146</span> final Object keyObj = entry.getKey();<a name="line.146"></a>
<span class="sourceLineNo">147</span> if (keyObj != null) {<a name="line.147"></a>
<span class="sourceLineNo">148</span> final String key = keyObj.toString();<a name="line.148"></a>
<span class="sourceLineNo">149</span> if (key.startsWith(prefix)) {<a name="line.149"></a>
<span class="sourceLineNo">150</span> if (key.indexOf('.', preLength) &lt; 0) {<a name="line.150"></a>
<span class="sourceLineNo">151</span> final String name = key.substring(preLength);<a name="line.151"></a>
<span class="sourceLineNo">152</span> final Object value = entry.getValue();<a name="line.152"></a>
<span class="sourceLineNo">153</span> if (value != null) {<a name="line.153"></a>
<span class="sourceLineNo">154</span> map.put(name, value.toString());<a name="line.154"></a>
<span class="sourceLineNo">155</span> }<a name="line.155"></a>
<span class="sourceLineNo">156</span> }<a name="line.156"></a>
<span class="sourceLineNo">157</span> }<a name="line.157"></a>
<span class="sourceLineNo">158</span> }<a name="line.158"></a>
<span class="sourceLineNo">159</span> }<a name="line.159"></a>
<span class="sourceLineNo">160</span> return map;<a name="line.160"></a>
<span class="sourceLineNo">161</span> }<a name="line.161"></a>
<span class="sourceLineNo">162</span><a name="line.162"></a>
<span class="sourceLineNo">163</span> private void buildAppender(final String appenderName, final String appenderClass) {<a name="line.163"></a>
<span class="sourceLineNo">164</span> switch (appenderClass) {<a name="line.164"></a>
<span class="sourceLineNo">165</span> case "org.apache.log4j.ConsoleAppender":<a name="line.165"></a>
<span class="sourceLineNo">166</span> buildConsoleAppender(appenderName);<a name="line.166"></a>
<span class="sourceLineNo">167</span> break;<a name="line.167"></a>
<span class="sourceLineNo">168</span> case "org.apache.log4j.FileAppender":<a name="line.168"></a>
<span class="sourceLineNo">169</span> buildFileAppender(appenderName);<a name="line.169"></a>
<span class="sourceLineNo">170</span> break;<a name="line.170"></a>
<span class="sourceLineNo">171</span> case "org.apache.log4j.DailyRollingFileAppender":<a name="line.171"></a>
<span class="sourceLineNo">172</span> buildDailyRollingFileAppender(appenderName);<a name="line.172"></a>
<span class="sourceLineNo">173</span> break;<a name="line.173"></a>
<span class="sourceLineNo">174</span> case "org.apache.log4j.RollingFileAppender":<a name="line.174"></a>
<span class="sourceLineNo">175</span> buildRollingFileAppender(appenderName);<a name="line.175"></a>
<span class="sourceLineNo">176</span> break;<a name="line.176"></a>
<span class="sourceLineNo">177</span> case "org.apache.log4j.varia.NullAppender":<a name="line.177"></a>
<span class="sourceLineNo">178</span> buildNullAppender(appenderName);<a name="line.178"></a>
<span class="sourceLineNo">179</span> break;<a name="line.179"></a>
<span class="sourceLineNo">180</span> default:<a name="line.180"></a>
<span class="sourceLineNo">181</span> reportWarning("Unknown appender class: " + appenderClass + "; ignoring appender: " + appenderName);<a name="line.181"></a>
<span class="sourceLineNo">182</span> }<a name="line.182"></a>
<span class="sourceLineNo">183</span> }<a name="line.183"></a>
<span class="sourceLineNo">184</span><a name="line.184"></a>
<span class="sourceLineNo">185</span> private void buildConsoleAppender(final String appenderName) {<a name="line.185"></a>
<span class="sourceLineNo">186</span> final AppenderComponentBuilder appenderBuilder = builder.newAppender(appenderName, ConsoleAppender.PLUGIN_NAME);<a name="line.186"></a>
<span class="sourceLineNo">187</span> final String targetValue = getLog4jAppenderValue(appenderName, "Target", "System.out");<a name="line.187"></a>
<span class="sourceLineNo">188</span> if (targetValue != null) {<a name="line.188"></a>
<span class="sourceLineNo">189</span> final ConsoleAppender.Target target;<a name="line.189"></a>
<span class="sourceLineNo">190</span> switch (targetValue) {<a name="line.190"></a>
<span class="sourceLineNo">191</span> case "System.out":<a name="line.191"></a>
<span class="sourceLineNo">192</span> target = ConsoleAppender.Target.SYSTEM_OUT;<a name="line.192"></a>
<span class="sourceLineNo">193</span> break;<a name="line.193"></a>
<span class="sourceLineNo">194</span> case "System.err":<a name="line.194"></a>
<span class="sourceLineNo">195</span> target = ConsoleAppender.Target.SYSTEM_ERR;<a name="line.195"></a>
<span class="sourceLineNo">196</span> break;<a name="line.196"></a>
<span class="sourceLineNo">197</span> default:<a name="line.197"></a>
<span class="sourceLineNo">198</span> reportWarning("Unknown value for console Target: " + targetValue);<a name="line.198"></a>
<span class="sourceLineNo">199</span> target = null;<a name="line.199"></a>
<span class="sourceLineNo">200</span> }<a name="line.200"></a>
<span class="sourceLineNo">201</span> if (target != null) {<a name="line.201"></a>
<span class="sourceLineNo">202</span> appenderBuilder.addAttribute("target", target);<a name="line.202"></a>
<span class="sourceLineNo">203</span> }<a name="line.203"></a>
<span class="sourceLineNo">204</span> }<a name="line.204"></a>
<span class="sourceLineNo">205</span> buildAttribute(appenderName, appenderBuilder, "Follow", "follow");<a name="line.205"></a>
<span class="sourceLineNo">206</span> if (FALSE.equalsIgnoreCase(getLog4jAppenderValue(appenderName, "ImmediateFlush"))) {<a name="line.206"></a>
<span class="sourceLineNo">207</span> reportWarning("ImmediateFlush=false is not supported on Console appender");<a name="line.207"></a>
<span class="sourceLineNo">208</span> }<a name="line.208"></a>
<span class="sourceLineNo">209</span> buildAppenderLayout(appenderName, appenderBuilder);<a name="line.209"></a>
<span class="sourceLineNo">210</span> builder.add(appenderBuilder);<a name="line.210"></a>
<span class="sourceLineNo">211</span> }<a name="line.211"></a>
<span class="sourceLineNo">212</span><a name="line.212"></a>
<span class="sourceLineNo">213</span> private void buildFileAppender(final String appenderName) {<a name="line.213"></a>
<span class="sourceLineNo">214</span> final AppenderComponentBuilder appenderBuilder = builder.newAppender(appenderName, FileAppender.PLUGIN_NAME);<a name="line.214"></a>
<span class="sourceLineNo">215</span> buildFileAppender(appenderName, appenderBuilder);<a name="line.215"></a>
<span class="sourceLineNo">216</span> builder.add(appenderBuilder);<a name="line.216"></a>
<span class="sourceLineNo">217</span> }<a name="line.217"></a>
<span class="sourceLineNo">218</span><a name="line.218"></a>
<span class="sourceLineNo">219</span> private void buildFileAppender(final String appenderName, final AppenderComponentBuilder appenderBuilder) {<a name="line.219"></a>
<span class="sourceLineNo">220</span> buildMandatoryAttribute(appenderName, appenderBuilder, "File", "fileName");<a name="line.220"></a>
<span class="sourceLineNo">221</span> buildAttribute(appenderName, appenderBuilder, "Append", "append");<a name="line.221"></a>
<span class="sourceLineNo">222</span> buildAttribute(appenderName, appenderBuilder, "BufferedIO", "bufferedIo");<a name="line.222"></a>
<span class="sourceLineNo">223</span> buildAttribute(appenderName, appenderBuilder, "BufferSize", "bufferSize");<a name="line.223"></a>
<span class="sourceLineNo">224</span> buildAttribute(appenderName, appenderBuilder, "ImmediateFlush", "immediateFlush");<a name="line.224"></a>
<span class="sourceLineNo">225</span> buildAppenderLayout(appenderName, appenderBuilder);<a name="line.225"></a>
<span class="sourceLineNo">226</span> }<a name="line.226"></a>
<span class="sourceLineNo">227</span><a name="line.227"></a>
<span class="sourceLineNo">228</span> private void buildDailyRollingFileAppender(final String appenderName) {<a name="line.228"></a>
<span class="sourceLineNo">229</span> final AppenderComponentBuilder appenderBuilder = builder.newAppender(appenderName,<a name="line.229"></a>
<span class="sourceLineNo">230</span> RollingFileAppender.PLUGIN_NAME);<a name="line.230"></a>
<span class="sourceLineNo">231</span> buildFileAppender(appenderName, appenderBuilder);<a name="line.231"></a>
<span class="sourceLineNo">232</span> final String fileName = getLog4jAppenderValue(appenderName, "File");<a name="line.232"></a>
<span class="sourceLineNo">233</span> final String datePattern = getLog4jAppenderValue(appenderName, "DatePattern", fileName + "'.'yyyy-MM-dd");<a name="line.233"></a>
<span class="sourceLineNo">234</span> appenderBuilder.addAttribute("filePattern", fileName + "%d{" + datePattern + "}");<a name="line.234"></a>
<span class="sourceLineNo">235</span> final ComponentBuilder&lt;?&gt; triggeringPolicy = builder.newComponent("Policies")<a name="line.235"></a>
<span class="sourceLineNo">236</span> .addComponent(builder.newComponent("TimeBasedTriggeringPolicy").addAttribute("modulate", true));<a name="line.236"></a>
<span class="sourceLineNo">237</span> appenderBuilder.addComponent(triggeringPolicy);<a name="line.237"></a>
<span class="sourceLineNo">238</span> appenderBuilder<a name="line.238"></a>
<span class="sourceLineNo">239</span> .addComponent(builder.newComponent("DefaultRolloverStrategy").addAttribute("max", Integer.MAX_VALUE));<a name="line.239"></a>
<span class="sourceLineNo">240</span> builder.add(appenderBuilder);<a name="line.240"></a>
<span class="sourceLineNo">241</span> }<a name="line.241"></a>
<span class="sourceLineNo">242</span><a name="line.242"></a>
<span class="sourceLineNo">243</span> private void buildRollingFileAppender(final String appenderName) {<a name="line.243"></a>
<span class="sourceLineNo">244</span> final AppenderComponentBuilder appenderBuilder = builder.newAppender(appenderName,<a name="line.244"></a>
<span class="sourceLineNo">245</span> RollingFileAppender.PLUGIN_NAME);<a name="line.245"></a>
<span class="sourceLineNo">246</span> buildFileAppender(appenderName, appenderBuilder);<a name="line.246"></a>
<span class="sourceLineNo">247</span> final String fileName = getLog4jAppenderValue(appenderName, "File");<a name="line.247"></a>
<span class="sourceLineNo">248</span> appenderBuilder.addAttribute("filePattern", fileName + ".%i");<a name="line.248"></a>
<span class="sourceLineNo">249</span> final String maxFileSizeString = getLog4jAppenderValue(appenderName, "MaxFileSize", "10485760");<a name="line.249"></a>
<span class="sourceLineNo">250</span> final String maxBackupIndexString = getLog4jAppenderValue(appenderName, "MaxBackupIndex", "1");<a name="line.250"></a>
<span class="sourceLineNo">251</span> final ComponentBuilder&lt;?&gt; triggeringPolicy = builder.newComponent("Policies").addComponent(<a name="line.251"></a>
<span class="sourceLineNo">252</span> builder.newComponent("SizeBasedTriggeringPolicy").addAttribute("size", maxFileSizeString));<a name="line.252"></a>
<span class="sourceLineNo">253</span> appenderBuilder.addComponent(triggeringPolicy);<a name="line.253"></a>
<span class="sourceLineNo">254</span> appenderBuilder.addComponent(<a name="line.254"></a>
<span class="sourceLineNo">255</span> builder.newComponent("DefaultRolloverStrategy").addAttribute("max", maxBackupIndexString));<a name="line.255"></a>
<span class="sourceLineNo">256</span> builder.add(appenderBuilder);<a name="line.256"></a>
<span class="sourceLineNo">257</span> }<a name="line.257"></a>
<span class="sourceLineNo">258</span><a name="line.258"></a>
<span class="sourceLineNo">259</span> private void buildAttribute(final String componentName, final ComponentBuilder componentBuilder,<a name="line.259"></a>
<span class="sourceLineNo">260</span> final String sourceAttributeName, final String targetAttributeName) {<a name="line.260"></a>
<span class="sourceLineNo">261</span> final String attributeValue = getLog4jAppenderValue(componentName, sourceAttributeName);<a name="line.261"></a>
<span class="sourceLineNo">262</span> if (attributeValue != null) {<a name="line.262"></a>
<span class="sourceLineNo">263</span> componentBuilder.addAttribute(targetAttributeName, attributeValue);<a name="line.263"></a>
<span class="sourceLineNo">264</span> }<a name="line.264"></a>
<span class="sourceLineNo">265</span> }<a name="line.265"></a>
<span class="sourceLineNo">266</span><a name="line.266"></a>
<span class="sourceLineNo">267</span> private void buildAttributeWithDefault(final String componentName, final ComponentBuilder componentBuilder,<a name="line.267"></a>
<span class="sourceLineNo">268</span> final String sourceAttributeName, final String targetAttributeName, final String defaultValue) {<a name="line.268"></a>
<span class="sourceLineNo">269</span> final String attributeValue = getLog4jAppenderValue(componentName, sourceAttributeName, defaultValue);<a name="line.269"></a>
<span class="sourceLineNo">270</span> componentBuilder.addAttribute(targetAttributeName, attributeValue);<a name="line.270"></a>
<span class="sourceLineNo">271</span> }<a name="line.271"></a>
<span class="sourceLineNo">272</span><a name="line.272"></a>
<span class="sourceLineNo">273</span> private void buildMandatoryAttribute(final String componentName, final ComponentBuilder componentBuilder,<a name="line.273"></a>
<span class="sourceLineNo">274</span> final String sourceAttributeName, final String targetAttributeName) {<a name="line.274"></a>
<span class="sourceLineNo">275</span> final String attributeValue = getLog4jAppenderValue(componentName, sourceAttributeName);<a name="line.275"></a>
<span class="sourceLineNo">276</span> if (attributeValue != null) {<a name="line.276"></a>
<span class="sourceLineNo">277</span> componentBuilder.addAttribute(targetAttributeName, attributeValue);<a name="line.277"></a>
<span class="sourceLineNo">278</span> } else {<a name="line.278"></a>
<span class="sourceLineNo">279</span> reportWarning("Missing " + sourceAttributeName + " for " + componentName);<a name="line.279"></a>
<span class="sourceLineNo">280</span> }<a name="line.280"></a>
<span class="sourceLineNo">281</span> }<a name="line.281"></a>
<span class="sourceLineNo">282</span><a name="line.282"></a>
<span class="sourceLineNo">283</span> private void buildNullAppender(final String appenderName) {<a name="line.283"></a>
<span class="sourceLineNo">284</span> final AppenderComponentBuilder appenderBuilder = builder.newAppender(appenderName, NullAppender.PLUGIN_NAME);<a name="line.284"></a>
<span class="sourceLineNo">285</span> builder.add(appenderBuilder);<a name="line.285"></a>
<span class="sourceLineNo">286</span> }<a name="line.286"></a>
<span class="sourceLineNo">287</span><a name="line.287"></a>
<span class="sourceLineNo">288</span> private void buildAppenderLayout(final String name, final AppenderComponentBuilder appenderBuilder) {<a name="line.288"></a>
<span class="sourceLineNo">289</span> final String layoutClass = getLog4jAppenderValue(name, "layout", null);<a name="line.289"></a>
<span class="sourceLineNo">290</span> if (layoutClass != null) {<a name="line.290"></a>
<span class="sourceLineNo">291</span> switch (layoutClass) {<a name="line.291"></a>
<span class="sourceLineNo">292</span> case "org.apache.log4j.PatternLayout":<a name="line.292"></a>
<span class="sourceLineNo">293</span> case "org.apache.log4j.EnhancedPatternLayout": {<a name="line.293"></a>
<span class="sourceLineNo">294</span> final String pattern = getLog4jAppenderValue(name, "layout.ConversionPattern", null)<a name="line.294"></a>
<span class="sourceLineNo">295</span><a name="line.295"></a>
<span class="sourceLineNo">296</span> // Log4j 2's %x (NDC) is not compatible with Log4j 1's<a name="line.296"></a>
<span class="sourceLineNo">297</span> // %x<a name="line.297"></a>
<span class="sourceLineNo">298</span> // Log4j 1: "foo bar baz"<a name="line.298"></a>
<span class="sourceLineNo">299</span> // Log4j 2: "[foo, bar, baz]"<a name="line.299"></a>
<span class="sourceLineNo">300</span> // Use %ndc to get the Log4j 1 format<a name="line.300"></a>
<span class="sourceLineNo">301</span> .replace("%x", "%ndc")<a name="line.301"></a>
<span class="sourceLineNo">302</span><a name="line.302"></a>
<span class="sourceLineNo">303</span> // Log4j 2's %X (MDC) is not compatible with Log4j 1's<a name="line.303"></a>
<span class="sourceLineNo">304</span> // %X<a name="line.304"></a>
<span class="sourceLineNo">305</span> // Log4j 1: "{{foo,bar}{hoo,boo}}"<a name="line.305"></a>
<span class="sourceLineNo">306</span> // Log4j 2: "{foo=bar,hoo=boo}"<a name="line.306"></a>
<span class="sourceLineNo">307</span> // Use %properties to get the Log4j 1 format<a name="line.307"></a>
<span class="sourceLineNo">308</span> .replace("%X", "%properties");<a name="line.308"></a>
<span class="sourceLineNo">309</span><a name="line.309"></a>
<span class="sourceLineNo">310</span> appenderBuilder.add(newPatternLayout(pattern));<a name="line.310"></a>
<span class="sourceLineNo">311</span> break;<a name="line.311"></a>
<span class="sourceLineNo">312</span> }<a name="line.312"></a>
<span class="sourceLineNo">313</span> case "org.apache.log4j.SimpleLayout": {<a name="line.313"></a>
<span class="sourceLineNo">314</span> appenderBuilder.add(newPatternLayout("%level - %m%n"));<a name="line.314"></a>
<span class="sourceLineNo">315</span> break;<a name="line.315"></a>
<span class="sourceLineNo">316</span> }<a name="line.316"></a>
<span class="sourceLineNo">317</span> case "org.apache.log4j.TTCCLayout": {<a name="line.317"></a>
<span class="sourceLineNo">318</span> String pattern = "%r ";<a name="line.318"></a>
<span class="sourceLineNo">319</span> if (Boolean.parseBoolean(getLog4jAppenderValue(name, "layout.ThreadPrinting", TRUE))) {<a name="line.319"></a>
<span class="sourceLineNo">320</span> pattern += "[%t] ";<a name="line.320"></a>
<span class="sourceLineNo">321</span> }<a name="line.321"></a>
<span class="sourceLineNo">322</span> pattern += "%p ";<a name="line.322"></a>
<span class="sourceLineNo">323</span> if (Boolean.parseBoolean(getLog4jAppenderValue(name, "layout.CategoryPrefixing", TRUE))) {<a name="line.323"></a>
<span class="sourceLineNo">324</span> pattern += "%c ";<a name="line.324"></a>
<span class="sourceLineNo">325</span> }<a name="line.325"></a>
<span class="sourceLineNo">326</span> if (Boolean.parseBoolean(getLog4jAppenderValue(name, "layout.ContextPrinting", TRUE))) {<a name="line.326"></a>
<span class="sourceLineNo">327</span> pattern += "%notEmpty{%ndc }";<a name="line.327"></a>
<span class="sourceLineNo">328</span> }<a name="line.328"></a>
<span class="sourceLineNo">329</span> pattern += "- %m%n";<a name="line.329"></a>
<span class="sourceLineNo">330</span> appenderBuilder.add(newPatternLayout(pattern));<a name="line.330"></a>
<span class="sourceLineNo">331</span> break;<a name="line.331"></a>
<span class="sourceLineNo">332</span> }<a name="line.332"></a>
<span class="sourceLineNo">333</span> case "org.apache.log4j.HTMLLayout": {<a name="line.333"></a>
<span class="sourceLineNo">334</span> final LayoutComponentBuilder htmlLayout = builder.newLayout("HtmlLayout");<a name="line.334"></a>
<span class="sourceLineNo">335</span> htmlLayout.addAttribute("title", getLog4jAppenderValue(name, "layout.Title", "Log4J Log Messages"));<a name="line.335"></a>
<span class="sourceLineNo">336</span> htmlLayout.addAttribute("locationInfo",<a name="line.336"></a>
<span class="sourceLineNo">337</span> Boolean.parseBoolean(getLog4jAppenderValue(name, "layout.LocationInfo", FALSE)));<a name="line.337"></a>
<span class="sourceLineNo">338</span> appenderBuilder.add(htmlLayout);<a name="line.338"></a>
<span class="sourceLineNo">339</span> break;<a name="line.339"></a>
<span class="sourceLineNo">340</span> }<a name="line.340"></a>
<span class="sourceLineNo">341</span> case "org.apache.log4j.xml.XMLLayout": {<a name="line.341"></a>
<span class="sourceLineNo">342</span> final LayoutComponentBuilder xmlLayout = builder.newLayout("Log4j1XmlLayout");<a name="line.342"></a>
<span class="sourceLineNo">343</span> xmlLayout.addAttribute("locationInfo",<a name="line.343"></a>
<span class="sourceLineNo">344</span> Boolean.parseBoolean(getLog4jAppenderValue(name, "layout.LocationInfo", FALSE)));<a name="line.344"></a>
<span class="sourceLineNo">345</span> xmlLayout.addAttribute("properties",<a name="line.345"></a>
<span class="sourceLineNo">346</span> Boolean.parseBoolean(getLog4jAppenderValue(name, "layout.Properties", FALSE)));<a name="line.346"></a>
<span class="sourceLineNo">347</span> appenderBuilder.add(xmlLayout);<a name="line.347"></a>
<span class="sourceLineNo">348</span> break;<a name="line.348"></a>
<span class="sourceLineNo">349</span> }<a name="line.349"></a>
<span class="sourceLineNo">350</span> default:<a name="line.350"></a>
<span class="sourceLineNo">351</span> reportWarning("Unknown layout class: " + layoutClass);<a name="line.351"></a>
<span class="sourceLineNo">352</span> }<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> private LayoutComponentBuilder newPatternLayout(final String pattern) {<a name="line.356"></a>
<span class="sourceLineNo">357</span> final LayoutComponentBuilder layoutBuilder = builder.newLayout("PatternLayout");<a name="line.357"></a>
<span class="sourceLineNo">358</span> if (pattern != null) {<a name="line.358"></a>
<span class="sourceLineNo">359</span> layoutBuilder.addAttribute("pattern", pattern);<a name="line.359"></a>
<span class="sourceLineNo">360</span> }<a name="line.360"></a>
<span class="sourceLineNo">361</span> return layoutBuilder;<a name="line.361"></a>
<span class="sourceLineNo">362</span> }<a name="line.362"></a>
<span class="sourceLineNo">363</span><a name="line.363"></a>
<span class="sourceLineNo">364</span> private void buildRootLogger(final String rootLoggerValue) {<a name="line.364"></a>
<span class="sourceLineNo">365</span> if (rootLoggerValue == null) {<a name="line.365"></a>
<span class="sourceLineNo">366</span> return;<a name="line.366"></a>
<span class="sourceLineNo">367</span> }<a name="line.367"></a>
<span class="sourceLineNo">368</span> final String[] rootLoggerParts = rootLoggerValue.split(COMMA_DELIMITED_RE);<a name="line.368"></a>
<span class="sourceLineNo">369</span> final String rootLoggerLevel = getLevelString(rootLoggerParts, Level.ERROR.name());<a name="line.369"></a>
<span class="sourceLineNo">370</span> final RootLoggerComponentBuilder loggerBuilder = builder.newRootLogger(rootLoggerLevel);<a name="line.370"></a>
<span class="sourceLineNo">371</span> //<a name="line.371"></a>
<span class="sourceLineNo">372</span> final String[] sortedAppenderNames = Arrays.copyOfRange(rootLoggerParts, 1, rootLoggerParts.length);<a name="line.372"></a>
<span class="sourceLineNo">373</span> Arrays.sort(sortedAppenderNames);<a name="line.373"></a>
<span class="sourceLineNo">374</span> for (final String appender : sortedAppenderNames) {<a name="line.374"></a>
<span class="sourceLineNo">375</span> loggerBuilder.add(builder.newAppenderRef(appender));<a name="line.375"></a>
<span class="sourceLineNo">376</span> }<a name="line.376"></a>
<span class="sourceLineNo">377</span> builder.add(loggerBuilder);<a name="line.377"></a>
<span class="sourceLineNo">378</span> }<a name="line.378"></a>
<span class="sourceLineNo">379</span><a name="line.379"></a>
<span class="sourceLineNo">380</span> private String getLevelString(final String[] loggerParts, final String defaultLevel) {<a name="line.380"></a>
<span class="sourceLineNo">381</span> return loggerParts.length &gt; 0 ? loggerParts[0] : defaultLevel;<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>
<span class="sourceLineNo">384</span> private void buildLoggers(final String prefix) {<a name="line.384"></a>
<span class="sourceLineNo">385</span> final int preLength = prefix.length();<a name="line.385"></a>
<span class="sourceLineNo">386</span> for (final Map.Entry&lt;Object, Object&gt; entry : properties.entrySet()) {<a name="line.386"></a>
<span class="sourceLineNo">387</span> final Object keyObj = entry.getKey();<a name="line.387"></a>
<span class="sourceLineNo">388</span> if (keyObj != null) {<a name="line.388"></a>
<span class="sourceLineNo">389</span> final String key = keyObj.toString();<a name="line.389"></a>
<span class="sourceLineNo">390</span> if (key.startsWith(prefix)) {<a name="line.390"></a>
<span class="sourceLineNo">391</span> final String name = key.substring(preLength);<a name="line.391"></a>
<span class="sourceLineNo">392</span> final Object value = entry.getValue();<a name="line.392"></a>
<span class="sourceLineNo">393</span> if (value != null) {<a name="line.393"></a>
<span class="sourceLineNo">394</span> // a Level may be followed by a list of Appender refs.<a name="line.394"></a>
<span class="sourceLineNo">395</span> final String valueStr = value.toString();<a name="line.395"></a>
<span class="sourceLineNo">396</span> final String[] split = valueStr.split(COMMA_DELIMITED_RE);<a name="line.396"></a>
<span class="sourceLineNo">397</span> final String level = getLevelString(split, null);<a name="line.397"></a>
<span class="sourceLineNo">398</span> if (level == null) {<a name="line.398"></a>
<span class="sourceLineNo">399</span> warn("Level is missing for entry " + entry);<a name="line.399"></a>
<span class="sourceLineNo">400</span> } else {<a name="line.400"></a>
<span class="sourceLineNo">401</span> final LoggerComponentBuilder newLogger = builder.newLogger(name, level);<a name="line.401"></a>
<span class="sourceLineNo">402</span> if (split.length &gt; 1) {<a name="line.402"></a>
<span class="sourceLineNo">403</span> // Add Appenders to this logger<a name="line.403"></a>
<span class="sourceLineNo">404</span> final String[] sortedAppenderNames = Arrays.copyOfRange(split, 1, split.length);<a name="line.404"></a>
<span class="sourceLineNo">405</span> Arrays.sort(sortedAppenderNames);<a name="line.405"></a>
<span class="sourceLineNo">406</span> for (final String appenderName : sortedAppenderNames) {<a name="line.406"></a>
<span class="sourceLineNo">407</span> newLogger.add(builder.newAppenderRef(appenderName));<a name="line.407"></a>
<span class="sourceLineNo">408</span> }<a name="line.408"></a>
<span class="sourceLineNo">409</span> }<a name="line.409"></a>
<span class="sourceLineNo">410</span> builder.add(newLogger);<a name="line.410"></a>
<span class="sourceLineNo">411</span> }<a name="line.411"></a>
<span class="sourceLineNo">412</span> }<a name="line.412"></a>
<span class="sourceLineNo">413</span> }<a name="line.413"></a>
<span class="sourceLineNo">414</span> }<a name="line.414"></a>
<span class="sourceLineNo">415</span> }<a name="line.415"></a>
<span class="sourceLineNo">416</span> }<a name="line.416"></a>
<span class="sourceLineNo">417</span><a name="line.417"></a>
<span class="sourceLineNo">418</span> private String getLog4jAppenderValue(final String appenderName, final String attributeName) {<a name="line.418"></a>
<span class="sourceLineNo">419</span> return getProperty("log4j.appender." + appenderName + "." + attributeName);<a name="line.419"></a>
<span class="sourceLineNo">420</span> }<a name="line.420"></a>
<span class="sourceLineNo">421</span><a name="line.421"></a>
<span class="sourceLineNo">422</span> private String getProperty(final String key) {<a name="line.422"></a>
<span class="sourceLineNo">423</span> final String value = properties.getProperty(key);<a name="line.423"></a>
<span class="sourceLineNo">424</span> final String sysValue = strSubstitutorSystem.replace(value);<a name="line.424"></a>
<span class="sourceLineNo">425</span> return strSubstitutorProperties.replace(sysValue);<a name="line.425"></a>
<span class="sourceLineNo">426</span> }<a name="line.426"></a>
<span class="sourceLineNo">427</span><a name="line.427"></a>
<span class="sourceLineNo">428</span> private String getProperty(final String key, final String defaultValue) {<a name="line.428"></a>
<span class="sourceLineNo">429</span> final String value = getProperty(key);<a name="line.429"></a>
<span class="sourceLineNo">430</span> return value == null ? defaultValue : value;<a name="line.430"></a>
<span class="sourceLineNo">431</span> }<a name="line.431"></a>
<span class="sourceLineNo">432</span><a name="line.432"></a>
<span class="sourceLineNo">433</span> private String getLog4jAppenderValue(final String appenderName, final String attributeName,<a name="line.433"></a>
<span class="sourceLineNo">434</span> final String defaultValue) {<a name="line.434"></a>
<span class="sourceLineNo">435</span> return getProperty("log4j.appender." + appenderName + "." + attributeName, defaultValue);<a name="line.435"></a>
<span class="sourceLineNo">436</span> }<a name="line.436"></a>
<span class="sourceLineNo">437</span><a name="line.437"></a>
<span class="sourceLineNo">438</span> private String getLog4jValue(final String key) {<a name="line.438"></a>
<span class="sourceLineNo">439</span> return getProperty("log4j." + key);<a name="line.439"></a>
<span class="sourceLineNo">440</span> }<a name="line.440"></a>
<span class="sourceLineNo">441</span><a name="line.441"></a>
<span class="sourceLineNo">442</span> private void reportWarning(final String msg) {<a name="line.442"></a>
<span class="sourceLineNo">443</span> StatusLogger.getLogger().warn("Log4j 1 configuration parser: " + msg);<a name="line.443"></a>
<span class="sourceLineNo">444</span> }<a name="line.444"></a>
<span class="sourceLineNo">445</span><a name="line.445"></a>
<span class="sourceLineNo">446</span>}<a name="line.446"></a>
</pre>
</div>
</body>
</html>