blob: ac1cd92ba1313032b36ee63afbfa4f5c41a09d04 [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<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,<a name="line.12"></a>
<span class="sourceLineNo">013</span> * software distributed under the License is distributed on an<a name="line.13"></a>
<span class="sourceLineNo">014</span> * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY<a name="line.14"></a>
<span class="sourceLineNo">015</span> * KIND, either express or implied. See the License for the<a name="line.15"></a>
<span class="sourceLineNo">016</span> * specific language governing permissions and limitations<a name="line.16"></a>
<span class="sourceLineNo">017</span> * under the License.<a name="line.17"></a>
<span class="sourceLineNo">018</span> *<a name="line.18"></a>
<span class="sourceLineNo">019</span> */<a name="line.19"></a>
<span class="sourceLineNo">020</span>package org.apache.mina.util;<a name="line.20"></a>
<span class="sourceLineNo">021</span><a name="line.21"></a>
<span class="sourceLineNo">022</span>import java.io.IOException;<a name="line.22"></a>
<span class="sourceLineNo">023</span>import java.io.LineNumberReader;<a name="line.23"></a>
<span class="sourceLineNo">024</span>import java.io.PrintWriter;<a name="line.24"></a>
<span class="sourceLineNo">025</span>import java.io.StringReader;<a name="line.25"></a>
<span class="sourceLineNo">026</span>import java.io.StringWriter;<a name="line.26"></a>
<span class="sourceLineNo">027</span>import java.util.ArrayList;<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> * Utility class for working with xml data<a name="line.30"></a>
<span class="sourceLineNo">031</span> *<a name="line.31"></a>
<span class="sourceLineNo">032</span> * Implementation is heavily based on org.apache.log4j.helpers.Transform<a name="line.32"></a>
<span class="sourceLineNo">033</span> * <a name="line.33"></a>
<span class="sourceLineNo">034</span> * @author &lt;a href="http://mina.apache.org"&gt;Apache MINA Project&lt;/a&gt;<a name="line.34"></a>
<span class="sourceLineNo">035</span> */<a name="line.35"></a>
<span class="sourceLineNo">036</span>public class Transform {<a name="line.36"></a>
<span class="sourceLineNo">037</span><a name="line.37"></a>
<span class="sourceLineNo">038</span> private static final String CDATA_START = "&lt;![CDATA[";<a name="line.38"></a>
<span class="sourceLineNo">039</span><a name="line.39"></a>
<span class="sourceLineNo">040</span> private static final String CDATA_END = "]]&gt;";<a name="line.40"></a>
<span class="sourceLineNo">041</span><a name="line.41"></a>
<span class="sourceLineNo">042</span> private static final String CDATA_PSEUDO_END = "]]&amp;gt;";<a name="line.42"></a>
<span class="sourceLineNo">043</span><a name="line.43"></a>
<span class="sourceLineNo">044</span> private static final String CDATA_EMBEDED_END = CDATA_END + CDATA_PSEUDO_END + CDATA_START;<a name="line.44"></a>
<span class="sourceLineNo">045</span><a name="line.45"></a>
<span class="sourceLineNo">046</span> private static final int CDATA_END_LEN = CDATA_END.length();<a name="line.46"></a>
<span class="sourceLineNo">047</span><a name="line.47"></a>
<span class="sourceLineNo">048</span> /**<a name="line.48"></a>
<span class="sourceLineNo">049</span> * This method takes a string which may contain HTML tags (ie,<a name="line.49"></a>
<span class="sourceLineNo">050</span> * &amp;lt;b&amp;gt;, &amp;lt;table&amp;gt;, etc) and replaces any<a name="line.50"></a>
<span class="sourceLineNo">051</span> * '&amp;lt;', '&amp;gt;' , '&amp;amp;' or '"'<a name="line.51"></a>
<span class="sourceLineNo">052</span> * characters with respective predefined entity references.<a name="line.52"></a>
<span class="sourceLineNo">053</span> *<a name="line.53"></a>
<span class="sourceLineNo">054</span> * @param input The text to be converted.<a name="line.54"></a>
<span class="sourceLineNo">055</span> * @return The input string with the special characters replaced.<a name="line.55"></a>
<span class="sourceLineNo">056</span> * */<a name="line.56"></a>
<span class="sourceLineNo">057</span> static public String escapeTags(final String input) {<a name="line.57"></a>
<span class="sourceLineNo">058</span> // Check if the string is null, zero length or devoid of special characters<a name="line.58"></a>
<span class="sourceLineNo">059</span> // if so, return what was sent in.<a name="line.59"></a>
<span class="sourceLineNo">060</span><a name="line.60"></a>
<span class="sourceLineNo">061</span> if (input == null<a name="line.61"></a>
<span class="sourceLineNo">062</span> || input.length() == 0<a name="line.62"></a>
<span class="sourceLineNo">063</span> || (input.indexOf('"') == -1 &amp;&amp; input.indexOf('&amp;') == -1 &amp;&amp; input.indexOf('&lt;') == -1 &amp;&amp; input<a name="line.63"></a>
<span class="sourceLineNo">064</span> .indexOf('&gt;') == -1)) {<a name="line.64"></a>
<span class="sourceLineNo">065</span> return input;<a name="line.65"></a>
<span class="sourceLineNo">066</span> }<a name="line.66"></a>
<span class="sourceLineNo">067</span><a name="line.67"></a>
<span class="sourceLineNo">068</span> StringBuilder buf = new StringBuilder(input.length() + 6);<a name="line.68"></a>
<span class="sourceLineNo">069</span> char ch;<a name="line.69"></a>
<span class="sourceLineNo">070</span><a name="line.70"></a>
<span class="sourceLineNo">071</span> int len = input.length();<a name="line.71"></a>
<span class="sourceLineNo">072</span> for (int i = 0; i &lt; len; i++) {<a name="line.72"></a>
<span class="sourceLineNo">073</span> ch = input.charAt(i);<a name="line.73"></a>
<span class="sourceLineNo">074</span> if (ch &gt; '&gt;') {<a name="line.74"></a>
<span class="sourceLineNo">075</span> buf.append(ch);<a name="line.75"></a>
<span class="sourceLineNo">076</span> } else if (ch == '&lt;') {<a name="line.76"></a>
<span class="sourceLineNo">077</span> buf.append("&amp;lt;");<a name="line.77"></a>
<span class="sourceLineNo">078</span> } else if (ch == '&gt;') {<a name="line.78"></a>
<span class="sourceLineNo">079</span> buf.append("&amp;gt;");<a name="line.79"></a>
<span class="sourceLineNo">080</span> } else if (ch == '&amp;') {<a name="line.80"></a>
<span class="sourceLineNo">081</span> buf.append("&amp;amp;");<a name="line.81"></a>
<span class="sourceLineNo">082</span> } else if (ch == '"') {<a name="line.82"></a>
<span class="sourceLineNo">083</span> buf.append("&amp;quot;");<a name="line.83"></a>
<span class="sourceLineNo">084</span> } else {<a name="line.84"></a>
<span class="sourceLineNo">085</span> buf.append(ch);<a name="line.85"></a>
<span class="sourceLineNo">086</span> }<a name="line.86"></a>
<span class="sourceLineNo">087</span> }<a name="line.87"></a>
<span class="sourceLineNo">088</span> return buf.toString();<a name="line.88"></a>
<span class="sourceLineNo">089</span> }<a name="line.89"></a>
<span class="sourceLineNo">090</span><a name="line.90"></a>
<span class="sourceLineNo">091</span> /**<a name="line.91"></a>
<span class="sourceLineNo">092</span> * Ensures that embeded CDEnd strings (]]&amp;gt;) are handled properly<a name="line.92"></a>
<span class="sourceLineNo">093</span> * within message, NDC and throwable tag text.<a name="line.93"></a>
<span class="sourceLineNo">094</span> *<a name="line.94"></a>
<span class="sourceLineNo">095</span> * @param buf StringBuffer holding the XML data to this point. The<a name="line.95"></a>
<span class="sourceLineNo">096</span> * initial CDStart (&amp;lt;![CDATA[) and final CDEnd (]]&amp;gt;) of the CDATA<a name="line.96"></a>
<span class="sourceLineNo">097</span> * section are the responsibility of the calling method.<a name="line.97"></a>
<span class="sourceLineNo">098</span> * @param str The String that is inserted into an existing CDATA Section within buf.<a name="line.98"></a>
<span class="sourceLineNo">099</span> * */<a name="line.99"></a>
<span class="sourceLineNo">100</span> static public void appendEscapingCDATA(final StringBuffer buf, final String str) {<a name="line.100"></a>
<span class="sourceLineNo">101</span> if (str != null) {<a name="line.101"></a>
<span class="sourceLineNo">102</span> int end = str.indexOf(CDATA_END);<a name="line.102"></a>
<span class="sourceLineNo">103</span> if (end &lt; 0) {<a name="line.103"></a>
<span class="sourceLineNo">104</span> buf.append(str);<a name="line.104"></a>
<span class="sourceLineNo">105</span> } else {<a name="line.105"></a>
<span class="sourceLineNo">106</span> int start = 0;<a name="line.106"></a>
<span class="sourceLineNo">107</span> while (end &gt; -1) {<a name="line.107"></a>
<span class="sourceLineNo">108</span> buf.append(str.substring(start, end));<a name="line.108"></a>
<span class="sourceLineNo">109</span> buf.append(CDATA_EMBEDED_END);<a name="line.109"></a>
<span class="sourceLineNo">110</span> start = end + CDATA_END_LEN;<a name="line.110"></a>
<span class="sourceLineNo">111</span> if (start &lt; str.length()) {<a name="line.111"></a>
<span class="sourceLineNo">112</span> end = str.indexOf(CDATA_END, start);<a name="line.112"></a>
<span class="sourceLineNo">113</span> } else {<a name="line.113"></a>
<span class="sourceLineNo">114</span> return;<a name="line.114"></a>
<span class="sourceLineNo">115</span> }<a name="line.115"></a>
<span class="sourceLineNo">116</span> }<a name="line.116"></a>
<span class="sourceLineNo">117</span> buf.append(str.substring(start));<a name="line.117"></a>
<span class="sourceLineNo">118</span> }<a name="line.118"></a>
<span class="sourceLineNo">119</span> }<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> /**<a name="line.122"></a>
<span class="sourceLineNo">123</span> * Converts a Throwable into an array of Strings<a name="line.123"></a>
<span class="sourceLineNo">124</span> * @param throwable The Throwable to convert <a name="line.124"></a>
<span class="sourceLineNo">125</span> * @return string representation of the throwable<a name="line.125"></a>
<span class="sourceLineNo">126</span> */<a name="line.126"></a>
<span class="sourceLineNo">127</span> public static String[] getThrowableStrRep(Throwable throwable) {<a name="line.127"></a>
<span class="sourceLineNo">128</span> StringWriter sw = new StringWriter();<a name="line.128"></a>
<span class="sourceLineNo">129</span> PrintWriter pw = new PrintWriter(sw);<a name="line.129"></a>
<span class="sourceLineNo">130</span> throwable.printStackTrace(pw);<a name="line.130"></a>
<span class="sourceLineNo">131</span> pw.flush();<a name="line.131"></a>
<span class="sourceLineNo">132</span> LineNumberReader reader = new LineNumberReader(new StringReader(sw.toString()));<a name="line.132"></a>
<span class="sourceLineNo">133</span> ArrayList&lt;String&gt; lines = new ArrayList&lt;String&gt;();<a name="line.133"></a>
<span class="sourceLineNo">134</span> try {<a name="line.134"></a>
<span class="sourceLineNo">135</span> String line = reader.readLine();<a name="line.135"></a>
<span class="sourceLineNo">136</span> while (line != null) {<a name="line.136"></a>
<span class="sourceLineNo">137</span> lines.add(line);<a name="line.137"></a>
<span class="sourceLineNo">138</span> line = reader.readLine();<a name="line.138"></a>
<span class="sourceLineNo">139</span> }<a name="line.139"></a>
<span class="sourceLineNo">140</span> } catch (IOException ex) {<a name="line.140"></a>
<span class="sourceLineNo">141</span> lines.add(ex.toString());<a name="line.141"></a>
<span class="sourceLineNo">142</span> }<a name="line.142"></a>
<span class="sourceLineNo">143</span> String[] rep = new String[lines.size()];<a name="line.143"></a>
<span class="sourceLineNo">144</span> lines.toArray(rep);<a name="line.144"></a>
<span class="sourceLineNo">145</span> return rep;<a name="line.145"></a>
<span class="sourceLineNo">146</span> }<a name="line.146"></a>
<span class="sourceLineNo">147</span><a name="line.147"></a>
<span class="sourceLineNo">148</span>}<a name="line.148"></a>
</pre>
</div>
</body>
</html>