| <!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.pattern;<a name="line.17"></a> |
| <span class="sourceLineNo">018</span><a name="line.18"></a> |
| <span class="sourceLineNo">019</span>import java.util.List;<a name="line.19"></a> |
| <span class="sourceLineNo">020</span><a name="line.20"></a> |
| <span class="sourceLineNo">021</span>import org.apache.logging.log4j.core.LogEvent;<a name="line.21"></a> |
| <span class="sourceLineNo">022</span>import org.apache.logging.log4j.core.config.Configuration;<a name="line.22"></a> |
| <span class="sourceLineNo">023</span>import org.apache.logging.log4j.core.config.plugins.Plugin;<a name="line.23"></a> |
| <span class="sourceLineNo">024</span>import org.apache.logging.log4j.core.layout.PatternLayout;<a name="line.24"></a> |
| <span class="sourceLineNo">025</span>import org.apache.logging.log4j.util.EnglishEnums;<a name="line.25"></a> |
| <span class="sourceLineNo">026</span>import org.apache.logging.log4j.util.PerformanceSensitive;<a name="line.26"></a> |
| <span class="sourceLineNo">027</span>import org.apache.logging.log4j.util.StringBuilders;<a name="line.27"></a> |
| <span class="sourceLineNo">028</span><a name="line.28"></a> |
| <span class="sourceLineNo">029</span>/**<a name="line.29"></a> |
| <span class="sourceLineNo">030</span> * Converter that encodes the output from a pattern using a specified format. Supported formats include HTML<a name="line.30"></a> |
| <span class="sourceLineNo">031</span> * (default) and JSON.<a name="line.31"></a> |
| <span class="sourceLineNo">032</span> */<a name="line.32"></a> |
| <span class="sourceLineNo">033</span>@Plugin(name = "encode", category = PatternConverter.CATEGORY)<a name="line.33"></a> |
| <span class="sourceLineNo">034</span>@ConverterKeys({"enc", "encode"})<a name="line.34"></a> |
| <span class="sourceLineNo">035</span>@PerformanceSensitive("allocation")<a name="line.35"></a> |
| <span class="sourceLineNo">036</span>public final class EncodingPatternConverter extends LogEventPatternConverter {<a name="line.36"></a> |
| <span class="sourceLineNo">037</span><a name="line.37"></a> |
| <span class="sourceLineNo">038</span> private final List<PatternFormatter> formatters;<a name="line.38"></a> |
| <span class="sourceLineNo">039</span> private final EscapeFormat escapeFormat;<a name="line.39"></a> |
| <span class="sourceLineNo">040</span><a name="line.40"></a> |
| <span class="sourceLineNo">041</span> /**<a name="line.41"></a> |
| <span class="sourceLineNo">042</span> * Private constructor.<a name="line.42"></a> |
| <span class="sourceLineNo">043</span> *<a name="line.43"></a> |
| <span class="sourceLineNo">044</span> * @param formatters the PatternFormatters to generate the text to manipulate.<a name="line.44"></a> |
| <span class="sourceLineNo">045</span> * @param escapeFormat the escape format strategy to use for encoding output of formatters<a name="line.45"></a> |
| <span class="sourceLineNo">046</span> */<a name="line.46"></a> |
| <span class="sourceLineNo">047</span> private EncodingPatternConverter(final List<PatternFormatter> formatters,<a name="line.47"></a> |
| <span class="sourceLineNo">048</span> final EscapeFormat escapeFormat) {<a name="line.48"></a> |
| <span class="sourceLineNo">049</span> super("encode", "encode");<a name="line.49"></a> |
| <span class="sourceLineNo">050</span> this.formatters = formatters;<a name="line.50"></a> |
| <span class="sourceLineNo">051</span> this.escapeFormat = escapeFormat;<a name="line.51"></a> |
| <span class="sourceLineNo">052</span> }<a name="line.52"></a> |
| <span class="sourceLineNo">053</span><a name="line.53"></a> |
| <span class="sourceLineNo">054</span> /**<a name="line.54"></a> |
| <span class="sourceLineNo">055</span> * Creates an EncodingPatternConverter using a pattern string and an optional escape format.<a name="line.55"></a> |
| <span class="sourceLineNo">056</span> *<a name="line.56"></a> |
| <span class="sourceLineNo">057</span> * @param config the current Configuration<a name="line.57"></a> |
| <span class="sourceLineNo">058</span> * @param options first option is the nested pattern format; second option is the escape format (optional)<a name="line.58"></a> |
| <span class="sourceLineNo">059</span> * @return instance of pattern converter.<a name="line.59"></a> |
| <span class="sourceLineNo">060</span> */<a name="line.60"></a> |
| <span class="sourceLineNo">061</span> public static EncodingPatternConverter newInstance(final Configuration config, final String[] options) {<a name="line.61"></a> |
| <span class="sourceLineNo">062</span> if (options.length > 2 || options.length == 0) {<a name="line.62"></a> |
| <span class="sourceLineNo">063</span> LOGGER.error("Incorrect number of options on escape. Expected 1 or 2, but received {}",<a name="line.63"></a> |
| <span class="sourceLineNo">064</span> options.length);<a name="line.64"></a> |
| <span class="sourceLineNo">065</span> return null;<a name="line.65"></a> |
| <span class="sourceLineNo">066</span> }<a name="line.66"></a> |
| <span class="sourceLineNo">067</span> if (options[0] == null) {<a name="line.67"></a> |
| <span class="sourceLineNo">068</span> LOGGER.error("No pattern supplied on escape");<a name="line.68"></a> |
| <span class="sourceLineNo">069</span> return null;<a name="line.69"></a> |
| <span class="sourceLineNo">070</span> }<a name="line.70"></a> |
| <span class="sourceLineNo">071</span> final EscapeFormat escapeFormat = options.length < 2 ? EscapeFormat.HTML<a name="line.71"></a> |
| <span class="sourceLineNo">072</span> : EnglishEnums.valueOf(EscapeFormat.class, options[1], EscapeFormat.HTML);<a name="line.72"></a> |
| <span class="sourceLineNo">073</span> final PatternParser parser = PatternLayout.createPatternParser(config);<a name="line.73"></a> |
| <span class="sourceLineNo">074</span> final List<PatternFormatter> formatters = parser.parse(options[0]);<a name="line.74"></a> |
| <span class="sourceLineNo">075</span> return new EncodingPatternConverter(formatters, escapeFormat);<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> /**<a name="line.78"></a> |
| <span class="sourceLineNo">079</span> * {@inheritDoc}<a name="line.79"></a> |
| <span class="sourceLineNo">080</span> */<a name="line.80"></a> |
| <span class="sourceLineNo">081</span> @Override<a name="line.81"></a> |
| <span class="sourceLineNo">082</span> public void format(final LogEvent event, final StringBuilder toAppendTo) {<a name="line.82"></a> |
| <span class="sourceLineNo">083</span> final int start = toAppendTo.length();<a name="line.83"></a> |
| <span class="sourceLineNo">084</span> for (int i = 0; i < formatters.size(); i++) {<a name="line.84"></a> |
| <span class="sourceLineNo">085</span> formatters.get(i).format(event, toAppendTo);<a name="line.85"></a> |
| <span class="sourceLineNo">086</span> }<a name="line.86"></a> |
| <span class="sourceLineNo">087</span> escapeFormat.escape(toAppendTo, start);<a name="line.87"></a> |
| <span class="sourceLineNo">088</span> }<a name="line.88"></a> |
| <span class="sourceLineNo">089</span><a name="line.89"></a> |
| <span class="sourceLineNo">090</span> private enum EscapeFormat {<a name="line.90"></a> |
| <span class="sourceLineNo">091</span> HTML {<a name="line.91"></a> |
| <span class="sourceLineNo">092</span> @Override<a name="line.92"></a> |
| <span class="sourceLineNo">093</span> void escape(final StringBuilder toAppendTo, final int start) {<a name="line.93"></a> |
| <span class="sourceLineNo">094</span> for (int i = toAppendTo.length() - 1; i >= start; i--) { // backwards: length may change<a name="line.94"></a> |
| <span class="sourceLineNo">095</span> final char c = toAppendTo.charAt(i);<a name="line.95"></a> |
| <span class="sourceLineNo">096</span> switch (c) {<a name="line.96"></a> |
| <span class="sourceLineNo">097</span> case '\r':<a name="line.97"></a> |
| <span class="sourceLineNo">098</span> toAppendTo.setCharAt(i, '\\');<a name="line.98"></a> |
| <span class="sourceLineNo">099</span> toAppendTo.insert(i + 1, 'r');<a name="line.99"></a> |
| <span class="sourceLineNo">100</span> break;<a name="line.100"></a> |
| <span class="sourceLineNo">101</span> case '\n':<a name="line.101"></a> |
| <span class="sourceLineNo">102</span> toAppendTo.setCharAt(i, '\\');<a name="line.102"></a> |
| <span class="sourceLineNo">103</span> toAppendTo.insert(i + 1, 'n');<a name="line.103"></a> |
| <span class="sourceLineNo">104</span> break;<a name="line.104"></a> |
| <span class="sourceLineNo">105</span> case '&':<a name="line.105"></a> |
| <span class="sourceLineNo">106</span> toAppendTo.setCharAt(i, '&');<a name="line.106"></a> |
| <span class="sourceLineNo">107</span> toAppendTo.insert(i + 1, "amp;");<a name="line.107"></a> |
| <span class="sourceLineNo">108</span> break;<a name="line.108"></a> |
| <span class="sourceLineNo">109</span> case '<':<a name="line.109"></a> |
| <span class="sourceLineNo">110</span> toAppendTo.setCharAt(i, '&');<a name="line.110"></a> |
| <span class="sourceLineNo">111</span> toAppendTo.insert(i + 1, "lt;");<a name="line.111"></a> |
| <span class="sourceLineNo">112</span> break;<a name="line.112"></a> |
| <span class="sourceLineNo">113</span> case '>':<a name="line.113"></a> |
| <span class="sourceLineNo">114</span> toAppendTo.setCharAt(i, '&');<a name="line.114"></a> |
| <span class="sourceLineNo">115</span> toAppendTo.insert(i + 1, "gt;");<a name="line.115"></a> |
| <span class="sourceLineNo">116</span> break;<a name="line.116"></a> |
| <span class="sourceLineNo">117</span> case '"':<a name="line.117"></a> |
| <span class="sourceLineNo">118</span> toAppendTo.setCharAt(i, '&');<a name="line.118"></a> |
| <span class="sourceLineNo">119</span> toAppendTo.insert(i + 1, "quot;");<a name="line.119"></a> |
| <span class="sourceLineNo">120</span> break;<a name="line.120"></a> |
| <span class="sourceLineNo">121</span> case '\'':<a name="line.121"></a> |
| <span class="sourceLineNo">122</span> toAppendTo.setCharAt(i, '&');<a name="line.122"></a> |
| <span class="sourceLineNo">123</span> toAppendTo.insert(i + 1, "apos;");<a name="line.123"></a> |
| <span class="sourceLineNo">124</span> break;<a name="line.124"></a> |
| <span class="sourceLineNo">125</span> case '/':<a name="line.125"></a> |
| <span class="sourceLineNo">126</span> toAppendTo.setCharAt(i, '&');<a name="line.126"></a> |
| <span class="sourceLineNo">127</span> toAppendTo.insert(i + 1, "#x2F;");<a name="line.127"></a> |
| <span class="sourceLineNo">128</span> break;<a name="line.128"></a> |
| <span class="sourceLineNo">129</span> }<a name="line.129"></a> |
| <span class="sourceLineNo">130</span> }<a name="line.130"></a> |
| <span class="sourceLineNo">131</span> }<a name="line.131"></a> |
| <span class="sourceLineNo">132</span> },<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> * JSON string escaping as defined in RFC 4627.<a name="line.135"></a> |
| <span class="sourceLineNo">136</span> *<a name="line.136"></a> |
| <span class="sourceLineNo">137</span> * @see <a href="https://www.ietf.org/rfc/rfc4627.txt">RFC 4627</a><a name="line.137"></a> |
| <span class="sourceLineNo">138</span> */<a name="line.138"></a> |
| <span class="sourceLineNo">139</span> JSON {<a name="line.139"></a> |
| <span class="sourceLineNo">140</span> @Override<a name="line.140"></a> |
| <span class="sourceLineNo">141</span> void escape(final StringBuilder toAppendTo, final int start) {<a name="line.141"></a> |
| <span class="sourceLineNo">142</span> StringBuilders.escapeJson(toAppendTo, start);<a name="line.142"></a> |
| <span class="sourceLineNo">143</span> }<a name="line.143"></a> |
| <span class="sourceLineNo">144</span> },<a name="line.144"></a> |
| <span class="sourceLineNo">145</span><a name="line.145"></a> |
| <span class="sourceLineNo">146</span> CRLF {<a name="line.146"></a> |
| <span class="sourceLineNo">147</span> @Override<a name="line.147"></a> |
| <span class="sourceLineNo">148</span> void escape(final StringBuilder toAppendTo, final int start) {<a name="line.148"></a> |
| <span class="sourceLineNo">149</span> for (int i = toAppendTo.length() - 1; i >= start; i--) { // backwards: length may change<a name="line.149"></a> |
| <span class="sourceLineNo">150</span> final char c = toAppendTo.charAt(i);<a name="line.150"></a> |
| <span class="sourceLineNo">151</span> switch (c) {<a name="line.151"></a> |
| <span class="sourceLineNo">152</span> case '\r':<a name="line.152"></a> |
| <span class="sourceLineNo">153</span> toAppendTo.setCharAt(i, '\\');<a name="line.153"></a> |
| <span class="sourceLineNo">154</span> toAppendTo.insert(i + 1, 'r');<a name="line.154"></a> |
| <span class="sourceLineNo">155</span> break;<a name="line.155"></a> |
| <span class="sourceLineNo">156</span> case '\n':<a name="line.156"></a> |
| <span class="sourceLineNo">157</span> toAppendTo.setCharAt(i, '\\');<a name="line.157"></a> |
| <span class="sourceLineNo">158</span> toAppendTo.insert(i + 1, 'n');<a name="line.158"></a> |
| <span class="sourceLineNo">159</span> break;<a name="line.159"></a> |
| <span class="sourceLineNo">160</span> }<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> },<a name="line.163"></a> |
| <span class="sourceLineNo">164</span><a name="line.164"></a> |
| <span class="sourceLineNo">165</span> /**<a name="line.165"></a> |
| <span class="sourceLineNo">166</span> * XML string escaping as defined in XML specification.<a name="line.166"></a> |
| <span class="sourceLineNo">167</span> *<a name="line.167"></a> |
| <span class="sourceLineNo">168</span> * @see <a href="https://www.w3.org/TR/xml/">XML specification</a><a name="line.168"></a> |
| <span class="sourceLineNo">169</span> */<a name="line.169"></a> |
| <span class="sourceLineNo">170</span> XML {<a name="line.170"></a> |
| <span class="sourceLineNo">171</span> @Override<a name="line.171"></a> |
| <span class="sourceLineNo">172</span> void escape(final StringBuilder toAppendTo, final int start) {<a name="line.172"></a> |
| <span class="sourceLineNo">173</span> StringBuilders.escapeXml(toAppendTo, start);<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><a name="line.176"></a> |
| <span class="sourceLineNo">177</span> /**<a name="line.177"></a> |
| <span class="sourceLineNo">178</span> * Escapes text using a standardized format from a given starting point to the end of the string.<a name="line.178"></a> |
| <span class="sourceLineNo">179</span> *<a name="line.179"></a> |
| <span class="sourceLineNo">180</span> * @param toAppendTo string buffer to escape<a name="line.180"></a> |
| <span class="sourceLineNo">181</span> * @param start where to start escaping from<a name="line.181"></a> |
| <span class="sourceLineNo">182</span> */<a name="line.182"></a> |
| <span class="sourceLineNo">183</span> abstract void escape(final StringBuilder toAppendTo, final int start);<a name="line.183"></a> |
| <span class="sourceLineNo">184</span> }<a name="line.184"></a> |
| <span class="sourceLineNo">185</span>}<a name="line.185"></a> |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| </pre> |
| </div> |
| </body> |
| </html> |