| <!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.util;<a name="line.17"></a> |
| <span class="sourceLineNo">018</span><a name="line.18"></a> |
| <span class="sourceLineNo">019</span>import org.apache.logging.log4j.util.Strings;<a name="line.19"></a> |
| <span class="sourceLineNo">020</span><a name="line.20"></a> |
| <span class="sourceLineNo">021</span><a name="line.21"></a> |
| <span class="sourceLineNo">022</span>/**<a name="line.22"></a> |
| <span class="sourceLineNo">023</span> * Utility class for transforming strings.<a name="line.23"></a> |
| <span class="sourceLineNo">024</span> */<a name="line.24"></a> |
| <span class="sourceLineNo">025</span>public final class Transform {<a name="line.25"></a> |
| <span class="sourceLineNo">026</span><a name="line.26"></a> |
| <span class="sourceLineNo">027</span> private static final String CDATA_START = "<![CDATA[";<a name="line.27"></a> |
| <span class="sourceLineNo">028</span> private static final String CDATA_END = "]]>";<a name="line.28"></a> |
| <span class="sourceLineNo">029</span> private static final String CDATA_PSEUDO_END = "]]&gt;";<a name="line.29"></a> |
| <span class="sourceLineNo">030</span> private static final String CDATA_EMBEDED_END = CDATA_END + CDATA_PSEUDO_END + CDATA_START;<a name="line.30"></a> |
| <span class="sourceLineNo">031</span> private static final int CDATA_END_LEN = CDATA_END.length();<a name="line.31"></a> |
| <span class="sourceLineNo">032</span><a name="line.32"></a> |
| <span class="sourceLineNo">033</span> private Transform() {<a name="line.33"></a> |
| <span class="sourceLineNo">034</span> }<a name="line.34"></a> |
| <span class="sourceLineNo">035</span><a name="line.35"></a> |
| <span class="sourceLineNo">036</span> /**<a name="line.36"></a> |
| <span class="sourceLineNo">037</span> * This method takes a string which may contain HTML tags (ie,<a name="line.37"></a> |
| <span class="sourceLineNo">038</span> * &lt;b&gt;, &lt;table&gt;, etc) and replaces any<a name="line.38"></a> |
| <span class="sourceLineNo">039</span> * '&lt;', '&gt;' , '&amp;' or '&quot;'<a name="line.39"></a> |
| <span class="sourceLineNo">040</span> * characters with respective predefined entity references.<a name="line.40"></a> |
| <span class="sourceLineNo">041</span> *<a name="line.41"></a> |
| <span class="sourceLineNo">042</span> * @param input The text to be converted.<a name="line.42"></a> |
| <span class="sourceLineNo">043</span> * @return The input string with the special characters replaced.<a name="line.43"></a> |
| <span class="sourceLineNo">044</span> */<a name="line.44"></a> |
| <span class="sourceLineNo">045</span> public static String escapeHtmlTags(final String input) {<a name="line.45"></a> |
| <span class="sourceLineNo">046</span> // Check if the string is null, zero length or devoid of special characters<a name="line.46"></a> |
| <span class="sourceLineNo">047</span> // if so, return what was sent in.<a name="line.47"></a> |
| <span class="sourceLineNo">048</span><a name="line.48"></a> |
| <span class="sourceLineNo">049</span> if (Strings.isEmpty(input)<a name="line.49"></a> |
| <span class="sourceLineNo">050</span> || (input.indexOf('"') == -1 &&<a name="line.50"></a> |
| <span class="sourceLineNo">051</span> input.indexOf('&') == -1 &&<a name="line.51"></a> |
| <span class="sourceLineNo">052</span> input.indexOf('<') == -1 &&<a name="line.52"></a> |
| <span class="sourceLineNo">053</span> input.indexOf('>') == -1)) {<a name="line.53"></a> |
| <span class="sourceLineNo">054</span> return input;<a name="line.54"></a> |
| <span class="sourceLineNo">055</span> }<a name="line.55"></a> |
| <span class="sourceLineNo">056</span><a name="line.56"></a> |
| <span class="sourceLineNo">057</span> //Use a StringBuilder in lieu of String concatenation -- it is<a name="line.57"></a> |
| <span class="sourceLineNo">058</span> //much more efficient this way.<a name="line.58"></a> |
| <span class="sourceLineNo">059</span><a name="line.59"></a> |
| <span class="sourceLineNo">060</span> final StringBuilder buf = new StringBuilder(input.length() + 6);<a name="line.60"></a> |
| <span class="sourceLineNo">061</span><a name="line.61"></a> |
| <span class="sourceLineNo">062</span> final int len = input.length();<a name="line.62"></a> |
| <span class="sourceLineNo">063</span> for (int i = 0; i < len; i++) {<a name="line.63"></a> |
| <span class="sourceLineNo">064</span> final char ch = input.charAt(i);<a name="line.64"></a> |
| <span class="sourceLineNo">065</span> if (ch > '>') {<a name="line.65"></a> |
| <span class="sourceLineNo">066</span> buf.append(ch);<a name="line.66"></a> |
| <span class="sourceLineNo">067</span> } else if (ch == '<') {<a name="line.67"></a> |
| <span class="sourceLineNo">068</span> buf.append("&lt;");<a name="line.68"></a> |
| <span class="sourceLineNo">069</span> } else if (ch == '>') {<a name="line.69"></a> |
| <span class="sourceLineNo">070</span> buf.append("&gt;");<a name="line.70"></a> |
| <span class="sourceLineNo">071</span> } else if (ch == '&') {<a name="line.71"></a> |
| <span class="sourceLineNo">072</span> buf.append("&amp;");<a name="line.72"></a> |
| <span class="sourceLineNo">073</span> } else if (ch == '"') {<a name="line.73"></a> |
| <span class="sourceLineNo">074</span> buf.append("&quot;");<a name="line.74"></a> |
| <span class="sourceLineNo">075</span> } else {<a name="line.75"></a> |
| <span class="sourceLineNo">076</span> buf.append(ch);<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> return buf.toString();<a name="line.79"></a> |
| <span class="sourceLineNo">080</span> }<a name="line.80"></a> |
| <span class="sourceLineNo">081</span><a name="line.81"></a> |
| <span class="sourceLineNo">082</span> /**<a name="line.82"></a> |
| <span class="sourceLineNo">083</span> * Ensures that embedded CDEnd strings (]]&gt;) are handled properly<a name="line.83"></a> |
| <span class="sourceLineNo">084</span> * within message, NDC and throwable tag text.<a name="line.84"></a> |
| <span class="sourceLineNo">085</span> *<a name="line.85"></a> |
| <span class="sourceLineNo">086</span> * @param buf StringBuilder holding the XML data to this point. The<a name="line.86"></a> |
| <span class="sourceLineNo">087</span> * initial CDStart (&lt;![CDATA[) and final CDEnd (]]&gt;) of the CDATA<a name="line.87"></a> |
| <span class="sourceLineNo">088</span> * section are the responsibility of the calling method.<a name="line.88"></a> |
| <span class="sourceLineNo">089</span> * @param str The String that is inserted into an existing CDATA Section within buf.<a name="line.89"></a> |
| <span class="sourceLineNo">090</span> */<a name="line.90"></a> |
| <span class="sourceLineNo">091</span> public static void appendEscapingCData(final StringBuilder buf, final String str) {<a name="line.91"></a> |
| <span class="sourceLineNo">092</span> if (str != null) {<a name="line.92"></a> |
| <span class="sourceLineNo">093</span> int end = str.indexOf(CDATA_END);<a name="line.93"></a> |
| <span class="sourceLineNo">094</span> if (end < 0) {<a name="line.94"></a> |
| <span class="sourceLineNo">095</span> buf.append(str);<a name="line.95"></a> |
| <span class="sourceLineNo">096</span> } else {<a name="line.96"></a> |
| <span class="sourceLineNo">097</span> int start = 0;<a name="line.97"></a> |
| <span class="sourceLineNo">098</span> while (end > -1) {<a name="line.98"></a> |
| <span class="sourceLineNo">099</span> buf.append(str.substring(start, end));<a name="line.99"></a> |
| <span class="sourceLineNo">100</span> buf.append(CDATA_EMBEDED_END);<a name="line.100"></a> |
| <span class="sourceLineNo">101</span> start = end + CDATA_END_LEN;<a name="line.101"></a> |
| <span class="sourceLineNo">102</span> if (start < str.length()) {<a name="line.102"></a> |
| <span class="sourceLineNo">103</span> end = str.indexOf(CDATA_END, start);<a name="line.103"></a> |
| <span class="sourceLineNo">104</span> } else {<a name="line.104"></a> |
| <span class="sourceLineNo">105</span> return;<a name="line.105"></a> |
| <span class="sourceLineNo">106</span> }<a name="line.106"></a> |
| <span class="sourceLineNo">107</span> }<a name="line.107"></a> |
| <span class="sourceLineNo">108</span> buf.append(str.substring(start));<a name="line.108"></a> |
| <span class="sourceLineNo">109</span> }<a name="line.109"></a> |
| <span class="sourceLineNo">110</span> }<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> /**<a name="line.113"></a> |
| <span class="sourceLineNo">114</span> * This method takes a string which may contain JSON reserved chars and<a name="line.114"></a> |
| <span class="sourceLineNo">115</span> * escapes them.<a name="line.115"></a> |
| <span class="sourceLineNo">116</span> *<a name="line.116"></a> |
| <span class="sourceLineNo">117</span> * @param input The text to be converted.<a name="line.117"></a> |
| <span class="sourceLineNo">118</span> * @return The input string with the special characters replaced.<a name="line.118"></a> |
| <span class="sourceLineNo">119</span> */<a name="line.119"></a> |
| <span class="sourceLineNo">120</span> public static String escapeJsonControlCharacters(final String input) {<a name="line.120"></a> |
| <span class="sourceLineNo">121</span> // Check if the string is null, zero length or devoid of special characters<a name="line.121"></a> |
| <span class="sourceLineNo">122</span> // if so, return what was sent in.<a name="line.122"></a> |
| <span class="sourceLineNo">123</span><a name="line.123"></a> |
| <span class="sourceLineNo">124</span> // TODO: escaped Unicode chars.<a name="line.124"></a> |
| <span class="sourceLineNo">125</span><a name="line.125"></a> |
| <span class="sourceLineNo">126</span> if (Strings.isEmpty(input)<a name="line.126"></a> |
| <span class="sourceLineNo">127</span> || (input.indexOf('"') == -1 &&<a name="line.127"></a> |
| <span class="sourceLineNo">128</span> input.indexOf('\\') == -1 &&<a name="line.128"></a> |
| <span class="sourceLineNo">129</span> input.indexOf('/') == -1 &&<a name="line.129"></a> |
| <span class="sourceLineNo">130</span> input.indexOf('\b') == -1 &&<a name="line.130"></a> |
| <span class="sourceLineNo">131</span> input.indexOf('\f') == -1 &&<a name="line.131"></a> |
| <span class="sourceLineNo">132</span> input.indexOf('\n') == -1 &&<a name="line.132"></a> |
| <span class="sourceLineNo">133</span> input.indexOf('\r') == -1 &&<a name="line.133"></a> |
| <span class="sourceLineNo">134</span> input.indexOf('\t') == -1)) {<a name="line.134"></a> |
| <span class="sourceLineNo">135</span> return input;<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> final StringBuilder buf = new StringBuilder(input.length() + 6);<a name="line.138"></a> |
| <span class="sourceLineNo">139</span><a name="line.139"></a> |
| <span class="sourceLineNo">140</span> final int len = input.length();<a name="line.140"></a> |
| <span class="sourceLineNo">141</span> for (int i = 0; i < len; i++) {<a name="line.141"></a> |
| <span class="sourceLineNo">142</span> final char ch = input.charAt(i);<a name="line.142"></a> |
| <span class="sourceLineNo">143</span> final String escBs = "\\";<a name="line.143"></a> |
| <span class="sourceLineNo">144</span> switch (ch) {<a name="line.144"></a> |
| <span class="sourceLineNo">145</span> case '"':<a name="line.145"></a> |
| <span class="sourceLineNo">146</span> buf.append(escBs);<a name="line.146"></a> |
| <span class="sourceLineNo">147</span> buf.append(ch);<a name="line.147"></a> |
| <span class="sourceLineNo">148</span> break;<a name="line.148"></a> |
| <span class="sourceLineNo">149</span> case '\\':<a name="line.149"></a> |
| <span class="sourceLineNo">150</span> buf.append(escBs);<a name="line.150"></a> |
| <span class="sourceLineNo">151</span> buf.append(ch);<a name="line.151"></a> |
| <span class="sourceLineNo">152</span> break;<a name="line.152"></a> |
| <span class="sourceLineNo">153</span> case '/':<a name="line.153"></a> |
| <span class="sourceLineNo">154</span> buf.append(escBs);<a name="line.154"></a> |
| <span class="sourceLineNo">155</span> buf.append(ch);<a name="line.155"></a> |
| <span class="sourceLineNo">156</span> break;<a name="line.156"></a> |
| <span class="sourceLineNo">157</span> case '\b':<a name="line.157"></a> |
| <span class="sourceLineNo">158</span> buf.append(escBs);<a name="line.158"></a> |
| <span class="sourceLineNo">159</span> buf.append('b');<a name="line.159"></a> |
| <span class="sourceLineNo">160</span> break;<a name="line.160"></a> |
| <span class="sourceLineNo">161</span> case '\f':<a name="line.161"></a> |
| <span class="sourceLineNo">162</span> buf.append(escBs);<a name="line.162"></a> |
| <span class="sourceLineNo">163</span> buf.append('f');<a name="line.163"></a> |
| <span class="sourceLineNo">164</span> break;<a name="line.164"></a> |
| <span class="sourceLineNo">165</span> case '\n':<a name="line.165"></a> |
| <span class="sourceLineNo">166</span> buf.append(escBs);<a name="line.166"></a> |
| <span class="sourceLineNo">167</span> buf.append('n');<a name="line.167"></a> |
| <span class="sourceLineNo">168</span> break;<a name="line.168"></a> |
| <span class="sourceLineNo">169</span> case '\r':<a name="line.169"></a> |
| <span class="sourceLineNo">170</span> buf.append(escBs);<a name="line.170"></a> |
| <span class="sourceLineNo">171</span> buf.append('r');<a name="line.171"></a> |
| <span class="sourceLineNo">172</span> break;<a name="line.172"></a> |
| <span class="sourceLineNo">173</span> case '\t':<a name="line.173"></a> |
| <span class="sourceLineNo">174</span> buf.append(escBs);<a name="line.174"></a> |
| <span class="sourceLineNo">175</span> buf.append('t');<a name="line.175"></a> |
| <span class="sourceLineNo">176</span> break;<a name="line.176"></a> |
| <span class="sourceLineNo">177</span> default:<a name="line.177"></a> |
| <span class="sourceLineNo">178</span> buf.append(ch);<a name="line.178"></a> |
| <span class="sourceLineNo">179</span> }<a name="line.179"></a> |
| <span class="sourceLineNo">180</span> }<a name="line.180"></a> |
| <span class="sourceLineNo">181</span> return buf.toString();<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> |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| </pre> |
| </div> |
| </body> |
| </html> |
