blob: 38f60e79cda219f1f56813d94bf2762824b518db [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.io.OutputStream;<a name="line.21"></a>
<span class="sourceLineNo">022</span>import java.nio.file.FileVisitResult;<a name="line.22"></a>
<span class="sourceLineNo">023</span>import java.nio.file.Files;<a name="line.23"></a>
<span class="sourceLineNo">024</span>import java.nio.file.Path;<a name="line.24"></a>
<span class="sourceLineNo">025</span>import java.nio.file.SimpleFileVisitor;<a name="line.25"></a>
<span class="sourceLineNo">026</span>import java.nio.file.attribute.BasicFileAttributes;<a name="line.26"></a>
<span class="sourceLineNo">027</span>import java.util.concurrent.atomic.AtomicInteger;<a name="line.27"></a>
<span class="sourceLineNo">028</span><a name="line.28"></a>
<span class="sourceLineNo">029</span>import org.apache.logging.log4j.core.config.ConfigurationException;<a name="line.29"></a>
<span class="sourceLineNo">030</span>import org.apache.logging.log4j.core.config.builder.api.ConfigurationBuilder;<a name="line.30"></a>
<span class="sourceLineNo">031</span>import org.apache.logging.log4j.core.config.builder.impl.BuiltConfiguration;<a name="line.31"></a>
<span class="sourceLineNo">032</span>import org.apache.logging.log4j.core.tools.BasicCommandLineArguments;<a name="line.32"></a>
<span class="sourceLineNo">033</span>import org.apache.logging.log4j.core.tools.picocli.CommandLine;<a name="line.33"></a>
<span class="sourceLineNo">034</span>import org.apache.logging.log4j.core.tools.picocli.CommandLine.Command;<a name="line.34"></a>
<span class="sourceLineNo">035</span>import org.apache.logging.log4j.core.tools.picocli.CommandLine.Option;<a name="line.35"></a>
<span class="sourceLineNo">036</span><a name="line.36"></a>
<span class="sourceLineNo">037</span>/**<a name="line.37"></a>
<span class="sourceLineNo">038</span> * Tool for converting a Log4j 1.x properties configuration file to Log4j 2.x XML configuration file.<a name="line.38"></a>
<span class="sourceLineNo">039</span> *<a name="line.39"></a>
<span class="sourceLineNo">040</span> * &lt;p&gt;<a name="line.40"></a>
<span class="sourceLineNo">041</span> * Run with "--help" on the command line.<a name="line.41"></a>
<span class="sourceLineNo">042</span> * &lt;/p&gt;<a name="line.42"></a>
<span class="sourceLineNo">043</span> *<a name="line.43"></a>
<span class="sourceLineNo">044</span> * &lt;p&gt;<a name="line.44"></a>
<span class="sourceLineNo">045</span> * Example:<a name="line.45"></a>
<span class="sourceLineNo">046</span> * &lt;/p&gt;<a name="line.46"></a>
<span class="sourceLineNo">047</span> *<a name="line.47"></a>
<span class="sourceLineNo">048</span> * &lt;pre&gt;<a name="line.48"></a>
<span class="sourceLineNo">049</span> * java org.apache.log4j.config.Log4j1ConfigurationConverter --recurse<a name="line.49"></a>
<span class="sourceLineNo">050</span> * E:\vcs\git\apache\logging\logging-log4j2\log4j-1.2-api\src\test\resources\config-1.2\hadoop --in log4j.properties --verbose<a name="line.50"></a>
<span class="sourceLineNo">051</span> * &lt;/pre&gt;<a name="line.51"></a>
<span class="sourceLineNo">052</span> */<a name="line.52"></a>
<span class="sourceLineNo">053</span>public final class Log4j1ConfigurationConverter {<a name="line.53"></a>
<span class="sourceLineNo">054</span><a name="line.54"></a>
<span class="sourceLineNo">055</span> @Command(name = "Log4j1ConfigurationConverter")<a name="line.55"></a>
<span class="sourceLineNo">056</span> public static class CommandLineArguments extends BasicCommandLineArguments implements Runnable {<a name="line.56"></a>
<span class="sourceLineNo">057</span><a name="line.57"></a>
<span class="sourceLineNo">058</span> @Option(names = { "--failfast", "-f" }, description = "Fails on the first failure in recurse mode.")<a name="line.58"></a>
<span class="sourceLineNo">059</span> private boolean failFast;<a name="line.59"></a>
<span class="sourceLineNo">060</span><a name="line.60"></a>
<span class="sourceLineNo">061</span> @Option(names = { "--in", "-i" }, description = "Specifies the input file.")<a name="line.61"></a>
<span class="sourceLineNo">062</span> private Path pathIn;<a name="line.62"></a>
<span class="sourceLineNo">063</span><a name="line.63"></a>
<span class="sourceLineNo">064</span> @Option(names = { "--out", "-o" }, description = "Specifies the output file.")<a name="line.64"></a>
<span class="sourceLineNo">065</span> private Path pathOut;<a name="line.65"></a>
<span class="sourceLineNo">066</span><a name="line.66"></a>
<span class="sourceLineNo">067</span> @Option(names = { "--recurse", "-r" }, description = "Recurses into this folder looking for the input file")<a name="line.67"></a>
<span class="sourceLineNo">068</span> private Path recurseIntoPath;<a name="line.68"></a>
<span class="sourceLineNo">069</span><a name="line.69"></a>
<span class="sourceLineNo">070</span> @Option(names = { "--verbose", "-v" }, description = "Be verbose.")<a name="line.70"></a>
<span class="sourceLineNo">071</span> private boolean verbose;<a name="line.71"></a>
<span class="sourceLineNo">072</span><a name="line.72"></a>
<span class="sourceLineNo">073</span> public Path getPathIn() {<a name="line.73"></a>
<span class="sourceLineNo">074</span> return pathIn;<a name="line.74"></a>
<span class="sourceLineNo">075</span> }<a name="line.75"></a>
<span class="sourceLineNo">076</span><a name="line.76"></a>
<span class="sourceLineNo">077</span> public Path getPathOut() {<a name="line.77"></a>
<span class="sourceLineNo">078</span> return pathOut;<a name="line.78"></a>
<span class="sourceLineNo">079</span> }<a name="line.79"></a>
<span class="sourceLineNo">080</span><a name="line.80"></a>
<span class="sourceLineNo">081</span> public Path getRecurseIntoPath() {<a name="line.81"></a>
<span class="sourceLineNo">082</span> return recurseIntoPath;<a name="line.82"></a>
<span class="sourceLineNo">083</span> }<a name="line.83"></a>
<span class="sourceLineNo">084</span><a name="line.84"></a>
<span class="sourceLineNo">085</span> public boolean isFailFast() {<a name="line.85"></a>
<span class="sourceLineNo">086</span> return failFast;<a name="line.86"></a>
<span class="sourceLineNo">087</span> }<a name="line.87"></a>
<span class="sourceLineNo">088</span><a name="line.88"></a>
<span class="sourceLineNo">089</span> public boolean isVerbose() {<a name="line.89"></a>
<span class="sourceLineNo">090</span> return verbose;<a name="line.90"></a>
<span class="sourceLineNo">091</span> }<a name="line.91"></a>
<span class="sourceLineNo">092</span><a name="line.92"></a>
<span class="sourceLineNo">093</span> public void setFailFast(final boolean failFast) {<a name="line.93"></a>
<span class="sourceLineNo">094</span> this.failFast = failFast;<a name="line.94"></a>
<span class="sourceLineNo">095</span> }<a name="line.95"></a>
<span class="sourceLineNo">096</span><a name="line.96"></a>
<span class="sourceLineNo">097</span> public void setPathIn(final Path pathIn) {<a name="line.97"></a>
<span class="sourceLineNo">098</span> this.pathIn = pathIn;<a name="line.98"></a>
<span class="sourceLineNo">099</span> }<a name="line.99"></a>
<span class="sourceLineNo">100</span><a name="line.100"></a>
<span class="sourceLineNo">101</span> public void setPathOut(final Path pathOut) {<a name="line.101"></a>
<span class="sourceLineNo">102</span> this.pathOut = pathOut;<a name="line.102"></a>
<span class="sourceLineNo">103</span> }<a name="line.103"></a>
<span class="sourceLineNo">104</span><a name="line.104"></a>
<span class="sourceLineNo">105</span> public void setRecurseIntoPath(final Path recurseIntoPath) {<a name="line.105"></a>
<span class="sourceLineNo">106</span> this.recurseIntoPath = recurseIntoPath;<a name="line.106"></a>
<span class="sourceLineNo">107</span> }<a name="line.107"></a>
<span class="sourceLineNo">108</span><a name="line.108"></a>
<span class="sourceLineNo">109</span> public void setVerbose(final boolean verbose) {<a name="line.109"></a>
<span class="sourceLineNo">110</span> this.verbose = verbose;<a name="line.110"></a>
<span class="sourceLineNo">111</span> }<a name="line.111"></a>
<span class="sourceLineNo">112</span><a name="line.112"></a>
<span class="sourceLineNo">113</span> @Override<a name="line.113"></a>
<span class="sourceLineNo">114</span> public void run() {<a name="line.114"></a>
<span class="sourceLineNo">115</span> if (isHelp()) {<a name="line.115"></a>
<span class="sourceLineNo">116</span> CommandLine.usage(this, System.err);<a name="line.116"></a>
<span class="sourceLineNo">117</span> return;<a name="line.117"></a>
<span class="sourceLineNo">118</span> }<a name="line.118"></a>
<span class="sourceLineNo">119</span> new Log4j1ConfigurationConverter(this).run();<a name="line.119"></a>
<span class="sourceLineNo">120</span> }<a name="line.120"></a>
<span class="sourceLineNo">121</span><a name="line.121"></a>
<span class="sourceLineNo">122</span> @Override<a name="line.122"></a>
<span class="sourceLineNo">123</span> public String toString() {<a name="line.123"></a>
<span class="sourceLineNo">124</span> return "CommandLineArguments [recurseIntoPath=" + recurseIntoPath + ", verbose=" + verbose + ", pathIn="<a name="line.124"></a>
<span class="sourceLineNo">125</span> + pathIn + ", pathOut=" + pathOut + "]";<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><a name="line.128"></a>
<span class="sourceLineNo">129</span> private static final String FILE_EXT_XML = ".xml";<a name="line.129"></a>
<span class="sourceLineNo">130</span><a name="line.130"></a>
<span class="sourceLineNo">131</span> public static void main(final String[] args) {<a name="line.131"></a>
<span class="sourceLineNo">132</span> CommandLine.run(new CommandLineArguments(), System.err, args);<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> public static Log4j1ConfigurationConverter run(final CommandLineArguments cla) {<a name="line.135"></a>
<span class="sourceLineNo">136</span> final Log4j1ConfigurationConverter log4j1ConfigurationConverter = new Log4j1ConfigurationConverter(cla);<a name="line.136"></a>
<span class="sourceLineNo">137</span> log4j1ConfigurationConverter.run();<a name="line.137"></a>
<span class="sourceLineNo">138</span> return log4j1ConfigurationConverter;<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 final CommandLineArguments cla;<a name="line.141"></a>
<span class="sourceLineNo">142</span><a name="line.142"></a>
<span class="sourceLineNo">143</span> private Log4j1ConfigurationConverter(final CommandLineArguments cla) {<a name="line.143"></a>
<span class="sourceLineNo">144</span> this.cla = cla;<a name="line.144"></a>
<span class="sourceLineNo">145</span> }<a name="line.145"></a>
<span class="sourceLineNo">146</span><a name="line.146"></a>
<span class="sourceLineNo">147</span> protected void convert(final InputStream input, final OutputStream output) throws IOException {<a name="line.147"></a>
<span class="sourceLineNo">148</span> final ConfigurationBuilder&lt;BuiltConfiguration&gt; builder = new Log4j1ConfigurationParser()<a name="line.148"></a>
<span class="sourceLineNo">149</span> .buildConfigurationBuilder(input);<a name="line.149"></a>
<span class="sourceLineNo">150</span> builder.writeXmlConfiguration(output);<a name="line.150"></a>
<span class="sourceLineNo">151</span> }<a name="line.151"></a>
<span class="sourceLineNo">152</span><a name="line.152"></a>
<span class="sourceLineNo">153</span> InputStream getInputStream() throws IOException {<a name="line.153"></a>
<span class="sourceLineNo">154</span> final Path pathIn = cla.getPathIn();<a name="line.154"></a>
<span class="sourceLineNo">155</span> return pathIn == null ? System.in : new InputStreamWrapper(Files.newInputStream(pathIn), pathIn.toString());<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> OutputStream getOutputStream() throws IOException {<a name="line.158"></a>
<span class="sourceLineNo">159</span> final Path pathOut = cla.getPathOut();<a name="line.159"></a>
<span class="sourceLineNo">160</span> return pathOut == null ? System.out : Files.newOutputStream(pathOut);<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 run() {<a name="line.163"></a>
<span class="sourceLineNo">164</span> if (cla.getRecurseIntoPath() != null) {<a name="line.164"></a>
<span class="sourceLineNo">165</span> final AtomicInteger countOKs = new AtomicInteger();<a name="line.165"></a>
<span class="sourceLineNo">166</span> final AtomicInteger countFails = new AtomicInteger();<a name="line.166"></a>
<span class="sourceLineNo">167</span> try {<a name="line.167"></a>
<span class="sourceLineNo">168</span> Files.walkFileTree(cla.getRecurseIntoPath(), new SimpleFileVisitor&lt;Path&gt;() {<a name="line.168"></a>
<span class="sourceLineNo">169</span> @Override<a name="line.169"></a>
<span class="sourceLineNo">170</span> public FileVisitResult visitFile(final Path file, final BasicFileAttributes attrs)<a name="line.170"></a>
<span class="sourceLineNo">171</span> throws IOException {<a name="line.171"></a>
<span class="sourceLineNo">172</span> if (cla.getPathIn() == null || file.getFileName().equals(cla.getPathIn())) {<a name="line.172"></a>
<span class="sourceLineNo">173</span> verbose("Reading %s", file);<a name="line.173"></a>
<span class="sourceLineNo">174</span> String newFile = file.getFileName().toString();<a name="line.174"></a>
<span class="sourceLineNo">175</span> final int lastIndex = newFile.lastIndexOf(".");<a name="line.175"></a>
<span class="sourceLineNo">176</span> newFile = lastIndex &lt; 0 ? newFile + FILE_EXT_XML<a name="line.176"></a>
<span class="sourceLineNo">177</span> : newFile.substring(0, lastIndex) + FILE_EXT_XML;<a name="line.177"></a>
<span class="sourceLineNo">178</span> final Path resolved = file.resolveSibling(newFile);<a name="line.178"></a>
<span class="sourceLineNo">179</span> try (final InputStream input = new InputStreamWrapper(Files.newInputStream(file), file.toString());<a name="line.179"></a>
<span class="sourceLineNo">180</span> final OutputStream output = Files.newOutputStream(resolved)) {<a name="line.180"></a>
<span class="sourceLineNo">181</span> try {<a name="line.181"></a>
<span class="sourceLineNo">182</span> convert(input, output);<a name="line.182"></a>
<span class="sourceLineNo">183</span> countOKs.incrementAndGet();<a name="line.183"></a>
<span class="sourceLineNo">184</span> } catch (ConfigurationException | IOException e) {<a name="line.184"></a>
<span class="sourceLineNo">185</span> countFails.incrementAndGet();<a name="line.185"></a>
<span class="sourceLineNo">186</span> if (cla.isFailFast()) {<a name="line.186"></a>
<span class="sourceLineNo">187</span> throw e;<a name="line.187"></a>
<span class="sourceLineNo">188</span> }<a name="line.188"></a>
<span class="sourceLineNo">189</span> e.printStackTrace();<a name="line.189"></a>
<span class="sourceLineNo">190</span> }<a name="line.190"></a>
<span class="sourceLineNo">191</span> verbose("Wrote %s", resolved);<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> return FileVisitResult.CONTINUE;<a name="line.194"></a>
<span class="sourceLineNo">195</span> }<a name="line.195"></a>
<span class="sourceLineNo">196</span> });<a name="line.196"></a>
<span class="sourceLineNo">197</span> } catch (final IOException e) {<a name="line.197"></a>
<span class="sourceLineNo">198</span> throw new ConfigurationException(e);<a name="line.198"></a>
<span class="sourceLineNo">199</span> } finally {<a name="line.199"></a>
<span class="sourceLineNo">200</span> verbose("OK = %,d, Failures = %,d, Total = %,d", countOKs.get(), countFails.get(),<a name="line.200"></a>
<span class="sourceLineNo">201</span> countOKs.get() + countFails.get());<a name="line.201"></a>
<span class="sourceLineNo">202</span> }<a name="line.202"></a>
<span class="sourceLineNo">203</span> } else {<a name="line.203"></a>
<span class="sourceLineNo">204</span> verbose("Reading %s", cla.getPathIn());<a name="line.204"></a>
<span class="sourceLineNo">205</span> try (final InputStream input = getInputStream(); final OutputStream output = getOutputStream()) {<a name="line.205"></a>
<span class="sourceLineNo">206</span> convert(input, output);<a name="line.206"></a>
<span class="sourceLineNo">207</span> } catch (final IOException e) {<a name="line.207"></a>
<span class="sourceLineNo">208</span> throw new ConfigurationException(e);<a name="line.208"></a>
<span class="sourceLineNo">209</span> }<a name="line.209"></a>
<span class="sourceLineNo">210</span> verbose("Wrote %s", cla.getPathOut());<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><a name="line.213"></a>
<span class="sourceLineNo">214</span> private void verbose(final String template, final Object... args) {<a name="line.214"></a>
<span class="sourceLineNo">215</span> if (cla.isVerbose()) {<a name="line.215"></a>
<span class="sourceLineNo">216</span> System.err.println(String.format(template, args));<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><a name="line.219"></a>
<span class="sourceLineNo">220</span>}<a name="line.220"></a>
</pre>
</div>
</body>
</html>