blob: 1bc8e413791983a0c0953cd89791b7ad7e17b21c [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.logging.log4j.core.util;<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> * This class is borrowed from &lt;a href="https://github.com/FasterXML/jackson-core"&gt;Jackson&lt;/a&gt;.<a name="line.20"></a>
<span class="sourceLineNo">021</span> */<a name="line.21"></a>
<span class="sourceLineNo">022</span>public final class JsonUtils {<a name="line.22"></a>
<span class="sourceLineNo">023</span><a name="line.23"></a>
<span class="sourceLineNo">024</span> private static final char[] HC = "0123456789ABCDEF".toCharArray();<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> * Read-only encoding table for first 128 Unicode code points (single-byte UTF-8 characters).<a name="line.27"></a>
<span class="sourceLineNo">028</span> * Value of 0 means "no escaping"; other positive values that value is character<a name="line.28"></a>
<span class="sourceLineNo">029</span> * to use after backslash; and negative values that generic (backslash - u)<a name="line.29"></a>
<span class="sourceLineNo">030</span> * escaping is to be used.<a name="line.30"></a>
<span class="sourceLineNo">031</span> */<a name="line.31"></a>
<span class="sourceLineNo">032</span> private static final int[] ESC_CODES;<a name="line.32"></a>
<span class="sourceLineNo">033</span> static {<a name="line.33"></a>
<span class="sourceLineNo">034</span> final int[] table = new int[128];<a name="line.34"></a>
<span class="sourceLineNo">035</span> // Control chars need generic escape sequence<a name="line.35"></a>
<span class="sourceLineNo">036</span> for (int i = 0; i &lt; 32; ++i) {<a name="line.36"></a>
<span class="sourceLineNo">037</span> // 04-Mar-2011, tatu: Used to use "-(i + 1)", replaced with constant<a name="line.37"></a>
<span class="sourceLineNo">038</span> table[i] = -1;<a name="line.38"></a>
<span class="sourceLineNo">039</span> }<a name="line.39"></a>
<span class="sourceLineNo">040</span> /* Others (and some within that range too) have explicit shorter<a name="line.40"></a>
<span class="sourceLineNo">041</span> * sequences<a name="line.41"></a>
<span class="sourceLineNo">042</span> */<a name="line.42"></a>
<span class="sourceLineNo">043</span> table['"'] = '"';<a name="line.43"></a>
<span class="sourceLineNo">044</span> table['\\'] = '\\';<a name="line.44"></a>
<span class="sourceLineNo">045</span> // Escaping of slash is optional, so let's not add it<a name="line.45"></a>
<span class="sourceLineNo">046</span> table[0x08] = 'b';<a name="line.46"></a>
<span class="sourceLineNo">047</span> table[0x09] = 't';<a name="line.47"></a>
<span class="sourceLineNo">048</span> table[0x0C] = 'f';<a name="line.48"></a>
<span class="sourceLineNo">049</span> table[0x0A] = 'n';<a name="line.49"></a>
<span class="sourceLineNo">050</span> table[0x0D] = 'r';<a name="line.50"></a>
<span class="sourceLineNo">051</span> ESC_CODES = table;<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> * Temporary buffer used for composing quote/escape sequences<a name="line.55"></a>
<span class="sourceLineNo">056</span> */<a name="line.56"></a>
<span class="sourceLineNo">057</span> private final static ThreadLocal&lt;char[]&gt; _qbufLocal = new ThreadLocal&lt;&gt;();<a name="line.57"></a>
<span class="sourceLineNo">058</span><a name="line.58"></a>
<span class="sourceLineNo">059</span> private static char[] getQBuf() {<a name="line.59"></a>
<span class="sourceLineNo">060</span> char[] _qbuf = _qbufLocal.get();<a name="line.60"></a>
<span class="sourceLineNo">061</span> if (_qbuf == null) {<a name="line.61"></a>
<span class="sourceLineNo">062</span> _qbuf = new char[6];<a name="line.62"></a>
<span class="sourceLineNo">063</span> _qbuf[0] = '\\';<a name="line.63"></a>
<span class="sourceLineNo">064</span> _qbuf[2] = '0';<a name="line.64"></a>
<span class="sourceLineNo">065</span> _qbuf[3] = '0';<a name="line.65"></a>
<span class="sourceLineNo">066</span><a name="line.66"></a>
<span class="sourceLineNo">067</span> _qbufLocal.set(_qbuf);<a name="line.67"></a>
<span class="sourceLineNo">068</span> }<a name="line.68"></a>
<span class="sourceLineNo">069</span> return _qbuf;<a name="line.69"></a>
<span class="sourceLineNo">070</span> }<a name="line.70"></a>
<span class="sourceLineNo">071</span><a name="line.71"></a>
<span class="sourceLineNo">072</span> /**<a name="line.72"></a>
<span class="sourceLineNo">073</span> * Quote text contents using JSON standard quoting, and append results to a supplied {@link StringBuilder}.<a name="line.73"></a>
<span class="sourceLineNo">074</span> */<a name="line.74"></a>
<span class="sourceLineNo">075</span> public static void quoteAsString(final CharSequence input, final StringBuilder output) {<a name="line.75"></a>
<span class="sourceLineNo">076</span> final char[] qbuf = getQBuf();<a name="line.76"></a>
<span class="sourceLineNo">077</span> final int escCodeCount = ESC_CODES.length;<a name="line.77"></a>
<span class="sourceLineNo">078</span> int inPtr = 0;<a name="line.78"></a>
<span class="sourceLineNo">079</span> final int inputLen = input.length();<a name="line.79"></a>
<span class="sourceLineNo">080</span><a name="line.80"></a>
<span class="sourceLineNo">081</span> outer:<a name="line.81"></a>
<span class="sourceLineNo">082</span> while (inPtr &lt; inputLen) {<a name="line.82"></a>
<span class="sourceLineNo">083</span> tight_loop:<a name="line.83"></a>
<span class="sourceLineNo">084</span> while (true) {<a name="line.84"></a>
<span class="sourceLineNo">085</span> final char c = input.charAt(inPtr);<a name="line.85"></a>
<span class="sourceLineNo">086</span> if (c &lt; escCodeCount &amp;&amp; ESC_CODES[c] != 0) {<a name="line.86"></a>
<span class="sourceLineNo">087</span> break tight_loop;<a name="line.87"></a>
<span class="sourceLineNo">088</span> }<a name="line.88"></a>
<span class="sourceLineNo">089</span> output.append(c);<a name="line.89"></a>
<span class="sourceLineNo">090</span> if (++inPtr &gt;= inputLen) {<a name="line.90"></a>
<span class="sourceLineNo">091</span> break outer;<a name="line.91"></a>
<span class="sourceLineNo">092</span> }<a name="line.92"></a>
<span class="sourceLineNo">093</span> }<a name="line.93"></a>
<span class="sourceLineNo">094</span> // something to escape; 2 or 6-char variant?<a name="line.94"></a>
<span class="sourceLineNo">095</span> final char d = input.charAt(inPtr++);<a name="line.95"></a>
<span class="sourceLineNo">096</span> final int escCode = ESC_CODES[d];<a name="line.96"></a>
<span class="sourceLineNo">097</span> final int length = (escCode &lt; 0)<a name="line.97"></a>
<span class="sourceLineNo">098</span> ? _appendNumeric(d, qbuf)<a name="line.98"></a>
<span class="sourceLineNo">099</span> : _appendNamed(escCode, qbuf);<a name="line.99"></a>
<span class="sourceLineNo">100</span><a name="line.100"></a>
<span class="sourceLineNo">101</span> output.append(qbuf, 0, length);<a name="line.101"></a>
<span class="sourceLineNo">102</span> }<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> private static int _appendNumeric(final int value, final char[] qbuf) {<a name="line.105"></a>
<span class="sourceLineNo">106</span> qbuf[1] = 'u';<a name="line.106"></a>
<span class="sourceLineNo">107</span> // We know it's a control char, so only the last 2 chars are non-0<a name="line.107"></a>
<span class="sourceLineNo">108</span> qbuf[4] = HC[value &gt;&gt; 4];<a name="line.108"></a>
<span class="sourceLineNo">109</span> qbuf[5] = HC[value &amp; 0xF];<a name="line.109"></a>
<span class="sourceLineNo">110</span> return 6;<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> private static int _appendNamed(final int esc, final char[] qbuf) {<a name="line.113"></a>
<span class="sourceLineNo">114</span> qbuf[1] = (char) esc;<a name="line.114"></a>
<span class="sourceLineNo">115</span> return 2;<a name="line.115"></a>
<span class="sourceLineNo">116</span> }<a name="line.116"></a>
<span class="sourceLineNo">117</span><a name="line.117"></a>
<span class="sourceLineNo">118</span>}<a name="line.118"></a>
</pre>
</div>
</body>
</html>