| <!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<a name="line.2"></a> |
| <span class="sourceLineNo">003</span> * or more contributor license agreements. See the NOTICE file<a name="line.3"></a> |
| <span class="sourceLineNo">004</span> * distributed with this work for additional information<a name="line.4"></a> |
| <span class="sourceLineNo">005</span> * regarding copyright ownership. The ASF licenses this file<a name="line.5"></a> |
| <span class="sourceLineNo">006</span> * to you under the Apache License, Version 2.0 (the<a name="line.6"></a> |
| <span class="sourceLineNo">007</span> * "License"); you may not use this file except in compliance<a name="line.7"></a> |
| <span class="sourceLineNo">008</span> * with the License. You may obtain a copy of the License at<a name="line.8"></a> |
| <span class="sourceLineNo">009</span> *<a name="line.9"></a> |
| <span class="sourceLineNo">010</span> * http://www.apache.org/licenses/LICENSE-2.0<a name="line.10"></a> |
| <span class="sourceLineNo">011</span> *<a name="line.11"></a> |
| <span class="sourceLineNo">012</span> * Unless required by applicable law or agreed to in writing, software<a name="line.12"></a> |
| <span class="sourceLineNo">013</span> * distributed under the License is distributed on an "AS IS" BASIS,<a name="line.13"></a> |
| <span class="sourceLineNo">014</span> * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.<a name="line.14"></a> |
| <span class="sourceLineNo">015</span> * See the License for the specific language governing permissions and<a name="line.15"></a> |
| <span class="sourceLineNo">016</span> * limitations under the License.<a name="line.16"></a> |
| <span class="sourceLineNo">017</span> */<a name="line.17"></a> |
| <span class="sourceLineNo">018</span>package org.apache.hadoop.hbase.http;<a name="line.18"></a> |
| <span class="sourceLineNo">019</span><a name="line.19"></a> |
| <span class="sourceLineNo">020</span>import java.io.ByteArrayOutputStream;<a name="line.20"></a> |
| <span class="sourceLineNo">021</span>import java.io.IOException;<a name="line.21"></a> |
| <span class="sourceLineNo">022</span>import java.io.OutputStream;<a name="line.22"></a> |
| <span class="sourceLineNo">023</span>import org.apache.hadoop.hbase.util.Bytes;<a name="line.23"></a> |
| <span class="sourceLineNo">024</span>import org.apache.yetus.audience.InterfaceAudience;<a name="line.24"></a> |
| <span class="sourceLineNo">025</span><a name="line.25"></a> |
| <span class="sourceLineNo">026</span>/**<a name="line.26"></a> |
| <span class="sourceLineNo">027</span> * This class is responsible for quoting HTML characters.<a name="line.27"></a> |
| <span class="sourceLineNo">028</span> */<a name="line.28"></a> |
| <span class="sourceLineNo">029</span>@InterfaceAudience.Private<a name="line.29"></a> |
| <span class="sourceLineNo">030</span>public final class HtmlQuoting {<a name="line.30"></a> |
| <span class="sourceLineNo">031</span> private static final byte[] ampBytes = Bytes.toBytes("&amp;");<a name="line.31"></a> |
| <span class="sourceLineNo">032</span> private static final byte[] aposBytes = Bytes.toBytes("&apos;");<a name="line.32"></a> |
| <span class="sourceLineNo">033</span> private static final byte[] gtBytes = Bytes.toBytes("&gt;");<a name="line.33"></a> |
| <span class="sourceLineNo">034</span> private static final byte[] ltBytes = Bytes.toBytes("&lt;");<a name="line.34"></a> |
| <span class="sourceLineNo">035</span> private static final byte[] quotBytes = Bytes.toBytes("&quot;");<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> * Does the given string need to be quoted?<a name="line.38"></a> |
| <span class="sourceLineNo">039</span> * @param data the string to check<a name="line.39"></a> |
| <span class="sourceLineNo">040</span> * @param off the starting position<a name="line.40"></a> |
| <span class="sourceLineNo">041</span> * @param len the number of bytes to check<a name="line.41"></a> |
| <span class="sourceLineNo">042</span> * @return does the string contain any of the active html characters?<a name="line.42"></a> |
| <span class="sourceLineNo">043</span> */<a name="line.43"></a> |
| <span class="sourceLineNo">044</span> public static boolean needsQuoting(byte[] data, int off, int len) {<a name="line.44"></a> |
| <span class="sourceLineNo">045</span> if (off + len > data.length) {<a name="line.45"></a> |
| <span class="sourceLineNo">046</span> throw new IllegalStateException(<a name="line.46"></a> |
| <span class="sourceLineNo">047</span> "off+len=" + off + len + " should be lower" + " than data length=" + data.length);<a name="line.47"></a> |
| <span class="sourceLineNo">048</span> }<a name="line.48"></a> |
| <span class="sourceLineNo">049</span> for (int i = off; i < off + len; ++i) {<a name="line.49"></a> |
| <span class="sourceLineNo">050</span> switch (data[i]) {<a name="line.50"></a> |
| <span class="sourceLineNo">051</span> case '&':<a name="line.51"></a> |
| <span class="sourceLineNo">052</span> case '<':<a name="line.52"></a> |
| <span class="sourceLineNo">053</span> case '>':<a name="line.53"></a> |
| <span class="sourceLineNo">054</span> case '\'':<a name="line.54"></a> |
| <span class="sourceLineNo">055</span> case '"':<a name="line.55"></a> |
| <span class="sourceLineNo">056</span> return true;<a name="line.56"></a> |
| <span class="sourceLineNo">057</span> default:<a name="line.57"></a> |
| <span class="sourceLineNo">058</span> break;<a name="line.58"></a> |
| <span class="sourceLineNo">059</span> }<a name="line.59"></a> |
| <span class="sourceLineNo">060</span> }<a name="line.60"></a> |
| <span class="sourceLineNo">061</span> return false;<a name="line.61"></a> |
| <span class="sourceLineNo">062</span> }<a name="line.62"></a> |
| <span class="sourceLineNo">063</span><a name="line.63"></a> |
| <span class="sourceLineNo">064</span> /**<a name="line.64"></a> |
| <span class="sourceLineNo">065</span> * Does the given string need to be quoted?<a name="line.65"></a> |
| <span class="sourceLineNo">066</span> * @param str the string to check<a name="line.66"></a> |
| <span class="sourceLineNo">067</span> * @return does the string contain any of the active html characters?<a name="line.67"></a> |
| <span class="sourceLineNo">068</span> */<a name="line.68"></a> |
| <span class="sourceLineNo">069</span> public static boolean needsQuoting(String str) {<a name="line.69"></a> |
| <span class="sourceLineNo">070</span> if (str == null) {<a name="line.70"></a> |
| <span class="sourceLineNo">071</span> return false;<a name="line.71"></a> |
| <span class="sourceLineNo">072</span> }<a name="line.72"></a> |
| <span class="sourceLineNo">073</span> byte[] bytes = Bytes.toBytes(str);<a name="line.73"></a> |
| <span class="sourceLineNo">074</span> return needsQuoting(bytes, 0, bytes.length);<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> /**<a name="line.77"></a> |
| <span class="sourceLineNo">078</span> * Quote all of the active HTML characters in the given string as they are added to the buffer.<a name="line.78"></a> |
| <span class="sourceLineNo">079</span> * @param output the stream to write the output to<a name="line.79"></a> |
| <span class="sourceLineNo">080</span> * @param buffer the byte array to take the characters from<a name="line.80"></a> |
| <span class="sourceLineNo">081</span> * @param off the index of the first byte to quote<a name="line.81"></a> |
| <span class="sourceLineNo">082</span> * @param len the number of bytes to quote<a name="line.82"></a> |
| <span class="sourceLineNo">083</span> */<a name="line.83"></a> |
| <span class="sourceLineNo">084</span> public static void quoteHtmlChars(OutputStream output, byte[] buffer, int off, int len)<a name="line.84"></a> |
| <span class="sourceLineNo">085</span> throws IOException {<a name="line.85"></a> |
| <span class="sourceLineNo">086</span> for (int i = off; i < off + len; i++) {<a name="line.86"></a> |
| <span class="sourceLineNo">087</span> switch (buffer[i]) {<a name="line.87"></a> |
| <span class="sourceLineNo">088</span> case '&':<a name="line.88"></a> |
| <span class="sourceLineNo">089</span> output.write(ampBytes);<a name="line.89"></a> |
| <span class="sourceLineNo">090</span> break;<a name="line.90"></a> |
| <span class="sourceLineNo">091</span> case '<':<a name="line.91"></a> |
| <span class="sourceLineNo">092</span> output.write(ltBytes);<a name="line.92"></a> |
| <span class="sourceLineNo">093</span> break;<a name="line.93"></a> |
| <span class="sourceLineNo">094</span> case '>':<a name="line.94"></a> |
| <span class="sourceLineNo">095</span> output.write(gtBytes);<a name="line.95"></a> |
| <span class="sourceLineNo">096</span> break;<a name="line.96"></a> |
| <span class="sourceLineNo">097</span> case '\'':<a name="line.97"></a> |
| <span class="sourceLineNo">098</span> output.write(aposBytes);<a name="line.98"></a> |
| <span class="sourceLineNo">099</span> break;<a name="line.99"></a> |
| <span class="sourceLineNo">100</span> case '"':<a name="line.100"></a> |
| <span class="sourceLineNo">101</span> output.write(quotBytes);<a name="line.101"></a> |
| <span class="sourceLineNo">102</span> break;<a name="line.102"></a> |
| <span class="sourceLineNo">103</span> default:<a name="line.103"></a> |
| <span class="sourceLineNo">104</span> output.write(buffer, i, 1);<a name="line.104"></a> |
| <span class="sourceLineNo">105</span> break;<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> }<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> * Quote the given item to make it html-safe.<a name="line.111"></a> |
| <span class="sourceLineNo">112</span> * @param item the string to quote<a name="line.112"></a> |
| <span class="sourceLineNo">113</span> * @return the quoted string<a name="line.113"></a> |
| <span class="sourceLineNo">114</span> */<a name="line.114"></a> |
| <span class="sourceLineNo">115</span> public static String quoteHtmlChars(String item) {<a name="line.115"></a> |
| <span class="sourceLineNo">116</span> if (item == null) {<a name="line.116"></a> |
| <span class="sourceLineNo">117</span> return null;<a name="line.117"></a> |
| <span class="sourceLineNo">118</span> }<a name="line.118"></a> |
| <span class="sourceLineNo">119</span> byte[] bytes = Bytes.toBytes(item);<a name="line.119"></a> |
| <span class="sourceLineNo">120</span> if (needsQuoting(bytes, 0, bytes.length)) {<a name="line.120"></a> |
| <span class="sourceLineNo">121</span> ByteArrayOutputStream buffer = new ByteArrayOutputStream();<a name="line.121"></a> |
| <span class="sourceLineNo">122</span> try {<a name="line.122"></a> |
| <span class="sourceLineNo">123</span> quoteHtmlChars(buffer, bytes, 0, bytes.length);<a name="line.123"></a> |
| <span class="sourceLineNo">124</span> } catch (IOException ioe) {<a name="line.124"></a> |
| <span class="sourceLineNo">125</span> // Won't happen, since it is a bytearrayoutputstream<a name="line.125"></a> |
| <span class="sourceLineNo">126</span> }<a name="line.126"></a> |
| <span class="sourceLineNo">127</span> return buffer.toString();<a name="line.127"></a> |
| <span class="sourceLineNo">128</span> } else {<a name="line.128"></a> |
| <span class="sourceLineNo">129</span> return item;<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> * Return an output stream that quotes all of the output.<a name="line.134"></a> |
| <span class="sourceLineNo">135</span> * @param out the stream to write the quoted output to<a name="line.135"></a> |
| <span class="sourceLineNo">136</span> * @return a new stream that the application show write to<a name="line.136"></a> |
| <span class="sourceLineNo">137</span> */<a name="line.137"></a> |
| <span class="sourceLineNo">138</span> public static OutputStream quoteOutputStream(final OutputStream out) {<a name="line.138"></a> |
| <span class="sourceLineNo">139</span> return new OutputStream() {<a name="line.139"></a> |
| <span class="sourceLineNo">140</span> private byte[] data = new byte[1];<a name="line.140"></a> |
| <span class="sourceLineNo">141</span><a name="line.141"></a> |
| <span class="sourceLineNo">142</span> @Override<a name="line.142"></a> |
| <span class="sourceLineNo">143</span> public void write(byte[] data, int off, int len) throws IOException {<a name="line.143"></a> |
| <span class="sourceLineNo">144</span> quoteHtmlChars(out, data, off, len);<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> @Override<a name="line.147"></a> |
| <span class="sourceLineNo">148</span> public void write(int b) throws IOException {<a name="line.148"></a> |
| <span class="sourceLineNo">149</span> data[0] = (byte) b;<a name="line.149"></a> |
| <span class="sourceLineNo">150</span> quoteHtmlChars(out, data, 0, 1);<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> @Override<a name="line.153"></a> |
| <span class="sourceLineNo">154</span> public void flush() throws IOException {<a name="line.154"></a> |
| <span class="sourceLineNo">155</span> out.flush();<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> @Override<a name="line.158"></a> |
| <span class="sourceLineNo">159</span> public void close() throws IOException {<a name="line.159"></a> |
| <span class="sourceLineNo">160</span> out.close();<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> * Remove HTML quoting from a string.<a name="line.166"></a> |
| <span class="sourceLineNo">167</span> * @param item the string to unquote<a name="line.167"></a> |
| <span class="sourceLineNo">168</span> * @return the unquoted string<a name="line.168"></a> |
| <span class="sourceLineNo">169</span> */<a name="line.169"></a> |
| <span class="sourceLineNo">170</span> public static String unquoteHtmlChars(String item) {<a name="line.170"></a> |
| <span class="sourceLineNo">171</span> if (item == null) {<a name="line.171"></a> |
| <span class="sourceLineNo">172</span> return null;<a name="line.172"></a> |
| <span class="sourceLineNo">173</span> }<a name="line.173"></a> |
| <span class="sourceLineNo">174</span> int next = item.indexOf('&');<a name="line.174"></a> |
| <span class="sourceLineNo">175</span> // nothing was quoted<a name="line.175"></a> |
| <span class="sourceLineNo">176</span> if (next == -1) {<a name="line.176"></a> |
| <span class="sourceLineNo">177</span> return item;<a name="line.177"></a> |
| <span class="sourceLineNo">178</span> }<a name="line.178"></a> |
| <span class="sourceLineNo">179</span> int len = item.length();<a name="line.179"></a> |
| <span class="sourceLineNo">180</span> int posn = 0;<a name="line.180"></a> |
| <span class="sourceLineNo">181</span> StringBuilder buffer = new StringBuilder();<a name="line.181"></a> |
| <span class="sourceLineNo">182</span> while (next != -1) {<a name="line.182"></a> |
| <span class="sourceLineNo">183</span> buffer.append(item.substring(posn, next));<a name="line.183"></a> |
| <span class="sourceLineNo">184</span> if (item.startsWith("&amp;", next)) {<a name="line.184"></a> |
| <span class="sourceLineNo">185</span> buffer.append('&');<a name="line.185"></a> |
| <span class="sourceLineNo">186</span> next += 5;<a name="line.186"></a> |
| <span class="sourceLineNo">187</span> } else if (item.startsWith("&apos;", next)) {<a name="line.187"></a> |
| <span class="sourceLineNo">188</span> buffer.append('\'');<a name="line.188"></a> |
| <span class="sourceLineNo">189</span> next += 6;<a name="line.189"></a> |
| <span class="sourceLineNo">190</span> } else if (item.startsWith("&gt;", next)) {<a name="line.190"></a> |
| <span class="sourceLineNo">191</span> buffer.append('>');<a name="line.191"></a> |
| <span class="sourceLineNo">192</span> next += 4;<a name="line.192"></a> |
| <span class="sourceLineNo">193</span> } else if (item.startsWith("&lt;", next)) {<a name="line.193"></a> |
| <span class="sourceLineNo">194</span> buffer.append('<');<a name="line.194"></a> |
| <span class="sourceLineNo">195</span> next += 4;<a name="line.195"></a> |
| <span class="sourceLineNo">196</span> } else if (item.startsWith("&quot;", next)) {<a name="line.196"></a> |
| <span class="sourceLineNo">197</span> buffer.append('"');<a name="line.197"></a> |
| <span class="sourceLineNo">198</span> next += 6;<a name="line.198"></a> |
| <span class="sourceLineNo">199</span> } else {<a name="line.199"></a> |
| <span class="sourceLineNo">200</span> int end = item.indexOf(';', next) + 1;<a name="line.200"></a> |
| <span class="sourceLineNo">201</span> if (end == 0) {<a name="line.201"></a> |
| <span class="sourceLineNo">202</span> end = len;<a name="line.202"></a> |
| <span class="sourceLineNo">203</span> }<a name="line.203"></a> |
| <span class="sourceLineNo">204</span> throw new IllegalArgumentException("Bad HTML quoting for " + item.substring(next, end));<a name="line.204"></a> |
| <span class="sourceLineNo">205</span> }<a name="line.205"></a> |
| <span class="sourceLineNo">206</span> posn = next;<a name="line.206"></a> |
| <span class="sourceLineNo">207</span> next = item.indexOf('&', posn);<a name="line.207"></a> |
| <span class="sourceLineNo">208</span> }<a name="line.208"></a> |
| <span class="sourceLineNo">209</span> buffer.append(item.substring(posn, len));<a name="line.209"></a> |
| <span class="sourceLineNo">210</span> return buffer.toString();<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> public static void main(String[] args) {<a name="line.213"></a> |
| <span class="sourceLineNo">214</span> if (args.length == 0) {<a name="line.214"></a> |
| <span class="sourceLineNo">215</span> throw new IllegalArgumentException("Please provide some arguments");<a name="line.215"></a> |
| <span class="sourceLineNo">216</span> }<a name="line.216"></a> |
| <span class="sourceLineNo">217</span> for (String arg : args) {<a name="line.217"></a> |
| <span class="sourceLineNo">218</span> System.out.println("Original: " + arg);<a name="line.218"></a> |
| <span class="sourceLineNo">219</span> String quoted = quoteHtmlChars(arg);<a name="line.219"></a> |
| <span class="sourceLineNo">220</span> System.out.println("Quoted: " + quoted);<a name="line.220"></a> |
| <span class="sourceLineNo">221</span> String unquoted = unquoteHtmlChars(quoted);<a name="line.221"></a> |
| <span class="sourceLineNo">222</span> System.out.println("Unquoted: " + unquoted);<a name="line.222"></a> |
| <span class="sourceLineNo">223</span> System.out.println();<a name="line.223"></a> |
| <span class="sourceLineNo">224</span> }<a name="line.224"></a> |
| <span class="sourceLineNo">225</span> }<a name="line.225"></a> |
| <span class="sourceLineNo">226</span><a name="line.226"></a> |
| <span class="sourceLineNo">227</span> private HtmlQuoting() {<a name="line.227"></a> |
| <span class="sourceLineNo">228</span> }<a name="line.228"></a> |
| <span class="sourceLineNo">229</span>}<a name="line.229"></a> |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| </pre> |
| </div> |
| </body> |
| </html> |