| <!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.layout;<a name="line.17"></a> |
| <span class="sourceLineNo">018</span><a name="line.18"></a> |
| <span class="sourceLineNo">019</span>import java.io.IOException;<a name="line.19"></a> |
| <span class="sourceLineNo">020</span>import java.io.InterruptedIOException;<a name="line.20"></a> |
| <span class="sourceLineNo">021</span>import java.io.LineNumberReader;<a name="line.21"></a> |
| <span class="sourceLineNo">022</span>import java.io.PrintWriter;<a name="line.22"></a> |
| <span class="sourceLineNo">023</span>import java.io.StringReader;<a name="line.23"></a> |
| <span class="sourceLineNo">024</span>import java.io.StringWriter;<a name="line.24"></a> |
| <span class="sourceLineNo">025</span>import java.lang.management.ManagementFactory;<a name="line.25"></a> |
| <span class="sourceLineNo">026</span>import java.nio.charset.Charset;<a name="line.26"></a> |
| <span class="sourceLineNo">027</span>import java.nio.charset.StandardCharsets;<a name="line.27"></a> |
| <span class="sourceLineNo">028</span>import java.util.ArrayList;<a name="line.28"></a> |
| <span class="sourceLineNo">029</span><a name="line.29"></a> |
| <span class="sourceLineNo">030</span>import org.apache.logging.log4j.Level;<a name="line.30"></a> |
| <span class="sourceLineNo">031</span>import org.apache.logging.log4j.core.Layout;<a name="line.31"></a> |
| <span class="sourceLineNo">032</span>import org.apache.logging.log4j.core.LogEvent;<a name="line.32"></a> |
| <span class="sourceLineNo">033</span>import org.apache.logging.log4j.core.config.LoggerConfig;<a name="line.33"></a> |
| <span class="sourceLineNo">034</span>import org.apache.logging.log4j.core.config.Node;<a name="line.34"></a> |
| <span class="sourceLineNo">035</span>import org.apache.logging.log4j.core.config.plugins.Plugin;<a name="line.35"></a> |
| <span class="sourceLineNo">036</span>import org.apache.logging.log4j.core.config.plugins.PluginAttribute;<a name="line.36"></a> |
| <span class="sourceLineNo">037</span>import org.apache.logging.log4j.core.config.plugins.PluginBuilderAttribute;<a name="line.37"></a> |
| <span class="sourceLineNo">038</span>import org.apache.logging.log4j.core.config.plugins.PluginBuilderFactory;<a name="line.38"></a> |
| <span class="sourceLineNo">039</span>import org.apache.logging.log4j.core.config.plugins.PluginFactory;<a name="line.39"></a> |
| <span class="sourceLineNo">040</span>import org.apache.logging.log4j.core.util.Transform;<a name="line.40"></a> |
| <span class="sourceLineNo">041</span>import org.apache.logging.log4j.util.Strings;<a name="line.41"></a> |
| <span class="sourceLineNo">042</span><a name="line.42"></a> |
| <span class="sourceLineNo">043</span>/**<a name="line.43"></a> |
| <span class="sourceLineNo">044</span> * Outputs events as rows in an HTML table on an HTML page.<a name="line.44"></a> |
| <span class="sourceLineNo">045</span> * <p><a name="line.45"></a> |
| <span class="sourceLineNo">046</span> * Appenders using this layout should have their encoding set to UTF-8 or UTF-16, otherwise events containing non ASCII<a name="line.46"></a> |
| <span class="sourceLineNo">047</span> * characters could result in corrupted log files.<a name="line.47"></a> |
| <span class="sourceLineNo">048</span> * </p><a name="line.48"></a> |
| <span class="sourceLineNo">049</span> */<a name="line.49"></a> |
| <span class="sourceLineNo">050</span>@Plugin(name = "HtmlLayout", category = Node.CATEGORY, elementType = Layout.ELEMENT_TYPE, printObject = true)<a name="line.50"></a> |
| <span class="sourceLineNo">051</span>public final class HtmlLayout extends AbstractStringLayout {<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> * Default font family: {@value}.<a name="line.54"></a> |
| <span class="sourceLineNo">055</span> */<a name="line.55"></a> |
| <span class="sourceLineNo">056</span> public static final String DEFAULT_FONT_FAMILY = "arial,sans-serif";<a name="line.56"></a> |
| <span class="sourceLineNo">057</span><a name="line.57"></a> |
| <span class="sourceLineNo">058</span> private static final String TRACE_PREFIX = "<br />&nbsp;&nbsp;&nbsp;&nbsp;";<a name="line.58"></a> |
| <span class="sourceLineNo">059</span> private static final String REGEXP = Strings.LINE_SEPARATOR.equals("\n") ? "\n" : Strings.LINE_SEPARATOR + "|\n";<a name="line.59"></a> |
| <span class="sourceLineNo">060</span> private static final String DEFAULT_TITLE = "Log4j Log Messages";<a name="line.60"></a> |
| <span class="sourceLineNo">061</span> private static final String DEFAULT_CONTENT_TYPE = "text/html";<a name="line.61"></a> |
| <span class="sourceLineNo">062</span><a name="line.62"></a> |
| <span class="sourceLineNo">063</span> private final long jvmStartTime = ManagementFactory.getRuntimeMXBean().getStartTime();<a name="line.63"></a> |
| <span class="sourceLineNo">064</span><a name="line.64"></a> |
| <span class="sourceLineNo">065</span> // Print no location info by default<a name="line.65"></a> |
| <span class="sourceLineNo">066</span> private final boolean locationInfo;<a name="line.66"></a> |
| <span class="sourceLineNo">067</span> private final String title;<a name="line.67"></a> |
| <span class="sourceLineNo">068</span> private final String contentType;<a name="line.68"></a> |
| <span class="sourceLineNo">069</span> private final String font;<a name="line.69"></a> |
| <span class="sourceLineNo">070</span> private final String fontSize;<a name="line.70"></a> |
| <span class="sourceLineNo">071</span> private final String headerSize;<a name="line.71"></a> |
| <span class="sourceLineNo">072</span><a name="line.72"></a> |
| <span class="sourceLineNo">073</span> /**Possible font sizes */<a name="line.73"></a> |
| <span class="sourceLineNo">074</span> public static enum FontSize {<a name="line.74"></a> |
| <span class="sourceLineNo">075</span> SMALLER("smaller"), XXSMALL("xx-small"), XSMALL("x-small"), SMALL("small"), MEDIUM("medium"), LARGE("large"),<a name="line.75"></a> |
| <span class="sourceLineNo">076</span> XLARGE("x-large"), XXLARGE("xx-large"), LARGER("larger");<a name="line.76"></a> |
| <span class="sourceLineNo">077</span><a name="line.77"></a> |
| <span class="sourceLineNo">078</span> private final String size;<a name="line.78"></a> |
| <span class="sourceLineNo">079</span><a name="line.79"></a> |
| <span class="sourceLineNo">080</span> private FontSize(final String size) {<a name="line.80"></a> |
| <span class="sourceLineNo">081</span> this.size = size;<a name="line.81"></a> |
| <span class="sourceLineNo">082</span> }<a name="line.82"></a> |
| <span class="sourceLineNo">083</span><a name="line.83"></a> |
| <span class="sourceLineNo">084</span> public String getFontSize() {<a name="line.84"></a> |
| <span class="sourceLineNo">085</span> return size;<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> public static FontSize getFontSize(final String size) {<a name="line.88"></a> |
| <span class="sourceLineNo">089</span> for (final FontSize fontSize : values()) {<a name="line.89"></a> |
| <span class="sourceLineNo">090</span> if (fontSize.size.equals(size)) {<a name="line.90"></a> |
| <span class="sourceLineNo">091</span> return fontSize;<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> return SMALL;<a name="line.94"></a> |
| <span class="sourceLineNo">095</span> }<a name="line.95"></a> |
| <span class="sourceLineNo">096</span><a name="line.96"></a> |
| <span class="sourceLineNo">097</span> public FontSize larger() {<a name="line.97"></a> |
| <span class="sourceLineNo">098</span> return this.ordinal() < XXLARGE.ordinal() ? FontSize.values()[this.ordinal() + 1] : this;<a name="line.98"></a> |
| <span class="sourceLineNo">099</span> }<a name="line.99"></a> |
| <span class="sourceLineNo">100</span> }<a name="line.100"></a> |
| <span class="sourceLineNo">101</span><a name="line.101"></a> |
| <span class="sourceLineNo">102</span> private HtmlLayout(final boolean locationInfo, final String title, final String contentType, final Charset charset,<a name="line.102"></a> |
| <span class="sourceLineNo">103</span> final String font, final String fontSize, final String headerSize) {<a name="line.103"></a> |
| <span class="sourceLineNo">104</span> super(charset);<a name="line.104"></a> |
| <span class="sourceLineNo">105</span> this.locationInfo = locationInfo;<a name="line.105"></a> |
| <span class="sourceLineNo">106</span> this.title = title;<a name="line.106"></a> |
| <span class="sourceLineNo">107</span> this.contentType = addCharsetToContentType(contentType);<a name="line.107"></a> |
| <span class="sourceLineNo">108</span> this.font = font;<a name="line.108"></a> |
| <span class="sourceLineNo">109</span> this.fontSize = fontSize;<a name="line.109"></a> |
| <span class="sourceLineNo">110</span> this.headerSize = headerSize;<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> * For testing purposes.<a name="line.114"></a> |
| <span class="sourceLineNo">115</span> */<a name="line.115"></a> |
| <span class="sourceLineNo">116</span> public String getTitle() {<a name="line.116"></a> |
| <span class="sourceLineNo">117</span> return title;<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> * For testing purposes.<a name="line.121"></a> |
| <span class="sourceLineNo">122</span> */<a name="line.122"></a> |
| <span class="sourceLineNo">123</span> public boolean isLocationInfo() {<a name="line.123"></a> |
| <span class="sourceLineNo">124</span> return locationInfo;<a name="line.124"></a> |
| <span class="sourceLineNo">125</span> }<a name="line.125"></a> |
| <span class="sourceLineNo">126</span><a name="line.126"></a> |
| <span class="sourceLineNo">127</span> @Override<a name="line.127"></a> |
| <span class="sourceLineNo">128</span> public boolean requiresLocation() {<a name="line.128"></a> |
| <span class="sourceLineNo">129</span> return locationInfo;<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> private String addCharsetToContentType(final String contentType) {<a name="line.132"></a> |
| <span class="sourceLineNo">133</span> if (contentType == null) {<a name="line.133"></a> |
| <span class="sourceLineNo">134</span> return DEFAULT_CONTENT_TYPE + "; charset=" + getCharset();<a name="line.134"></a> |
| <span class="sourceLineNo">135</span> }<a name="line.135"></a> |
| <span class="sourceLineNo">136</span> return contentType.contains("charset") ? contentType : contentType + "; charset=" + getCharset();<a name="line.136"></a> |
| <span class="sourceLineNo">137</span> }<a name="line.137"></a> |
| <span class="sourceLineNo">138</span><a name="line.138"></a> |
| <span class="sourceLineNo">139</span> /**<a name="line.139"></a> |
| <span class="sourceLineNo">140</span> * Formats as a String.<a name="line.140"></a> |
| <span class="sourceLineNo">141</span> *<a name="line.141"></a> |
| <span class="sourceLineNo">142</span> * @param event The Logging Event.<a name="line.142"></a> |
| <span class="sourceLineNo">143</span> * @return A String containing the LogEvent as HTML.<a name="line.143"></a> |
| <span class="sourceLineNo">144</span> */<a name="line.144"></a> |
| <span class="sourceLineNo">145</span> @Override<a name="line.145"></a> |
| <span class="sourceLineNo">146</span> public String toSerializable(final LogEvent event) {<a name="line.146"></a> |
| <span class="sourceLineNo">147</span> final StringBuilder sbuf = getStringBuilder();<a name="line.147"></a> |
| <span class="sourceLineNo">148</span><a name="line.148"></a> |
| <span class="sourceLineNo">149</span> sbuf.append(Strings.LINE_SEPARATOR).append("<tr>").append(Strings.LINE_SEPARATOR);<a name="line.149"></a> |
| <span class="sourceLineNo">150</span><a name="line.150"></a> |
| <span class="sourceLineNo">151</span> sbuf.append("<td>");<a name="line.151"></a> |
| <span class="sourceLineNo">152</span> sbuf.append(event.getTimeMillis() - jvmStartTime);<a name="line.152"></a> |
| <span class="sourceLineNo">153</span> sbuf.append("</td>").append(Strings.LINE_SEPARATOR);<a name="line.153"></a> |
| <span class="sourceLineNo">154</span><a name="line.154"></a> |
| <span class="sourceLineNo">155</span> final String escapedThread = Transform.escapeHtmlTags(event.getThreadName());<a name="line.155"></a> |
| <span class="sourceLineNo">156</span> sbuf.append("<td title=\"").append(escapedThread).append(" thread\">");<a name="line.156"></a> |
| <span class="sourceLineNo">157</span> sbuf.append(escapedThread);<a name="line.157"></a> |
| <span class="sourceLineNo">158</span> sbuf.append("</td>").append(Strings.LINE_SEPARATOR);<a name="line.158"></a> |
| <span class="sourceLineNo">159</span><a name="line.159"></a> |
| <span class="sourceLineNo">160</span> sbuf.append("<td title=\"Level\">");<a name="line.160"></a> |
| <span class="sourceLineNo">161</span> if (event.getLevel().equals(Level.DEBUG)) {<a name="line.161"></a> |
| <span class="sourceLineNo">162</span> sbuf.append("<font color=\"#339933\">");<a name="line.162"></a> |
| <span class="sourceLineNo">163</span> sbuf.append(Transform.escapeHtmlTags(String.valueOf(event.getLevel())));<a name="line.163"></a> |
| <span class="sourceLineNo">164</span> sbuf.append("</font>");<a name="line.164"></a> |
| <span class="sourceLineNo">165</span> } else if (event.getLevel().isMoreSpecificThan(Level.WARN)) {<a name="line.165"></a> |
| <span class="sourceLineNo">166</span> sbuf.append("<font color=\"#993300\"><strong>");<a name="line.166"></a> |
| <span class="sourceLineNo">167</span> sbuf.append(Transform.escapeHtmlTags(String.valueOf(event.getLevel())));<a name="line.167"></a> |
| <span class="sourceLineNo">168</span> sbuf.append("</strong></font>");<a name="line.168"></a> |
| <span class="sourceLineNo">169</span> } else {<a name="line.169"></a> |
| <span class="sourceLineNo">170</span> sbuf.append(Transform.escapeHtmlTags(String.valueOf(event.getLevel())));<a name="line.170"></a> |
| <span class="sourceLineNo">171</span> }<a name="line.171"></a> |
| <span class="sourceLineNo">172</span> sbuf.append("</td>").append(Strings.LINE_SEPARATOR);<a name="line.172"></a> |
| <span class="sourceLineNo">173</span><a name="line.173"></a> |
| <span class="sourceLineNo">174</span> String escapedLogger = Transform.escapeHtmlTags(event.getLoggerName());<a name="line.174"></a> |
| <span class="sourceLineNo">175</span> if (Strings.isEmpty(escapedLogger)) {<a name="line.175"></a> |
| <span class="sourceLineNo">176</span> escapedLogger = LoggerConfig.ROOT;<a name="line.176"></a> |
| <span class="sourceLineNo">177</span> }<a name="line.177"></a> |
| <span class="sourceLineNo">178</span> sbuf.append("<td title=\"").append(escapedLogger).append(" logger\">");<a name="line.178"></a> |
| <span class="sourceLineNo">179</span> sbuf.append(escapedLogger);<a name="line.179"></a> |
| <span class="sourceLineNo">180</span> sbuf.append("</td>").append(Strings.LINE_SEPARATOR);<a name="line.180"></a> |
| <span class="sourceLineNo">181</span><a name="line.181"></a> |
| <span class="sourceLineNo">182</span> if (locationInfo) {<a name="line.182"></a> |
| <span class="sourceLineNo">183</span> final StackTraceElement element = event.getSource();<a name="line.183"></a> |
| <span class="sourceLineNo">184</span> sbuf.append("<td>");<a name="line.184"></a> |
| <span class="sourceLineNo">185</span> sbuf.append(Transform.escapeHtmlTags(element.getFileName()));<a name="line.185"></a> |
| <span class="sourceLineNo">186</span> sbuf.append(':');<a name="line.186"></a> |
| <span class="sourceLineNo">187</span> sbuf.append(element.getLineNumber());<a name="line.187"></a> |
| <span class="sourceLineNo">188</span> sbuf.append("</td>").append(Strings.LINE_SEPARATOR);<a name="line.188"></a> |
| <span class="sourceLineNo">189</span> }<a name="line.189"></a> |
| <span class="sourceLineNo">190</span><a name="line.190"></a> |
| <span class="sourceLineNo">191</span> sbuf.append("<td title=\"Message\">");<a name="line.191"></a> |
| <span class="sourceLineNo">192</span> sbuf.append(Transform.escapeHtmlTags(event.getMessage().getFormattedMessage()).replaceAll(REGEXP, "<br />"));<a name="line.192"></a> |
| <span class="sourceLineNo">193</span> sbuf.append("</td>").append(Strings.LINE_SEPARATOR);<a name="line.193"></a> |
| <span class="sourceLineNo">194</span> sbuf.append("</tr>").append(Strings.LINE_SEPARATOR);<a name="line.194"></a> |
| <span class="sourceLineNo">195</span><a name="line.195"></a> |
| <span class="sourceLineNo">196</span> if (event.getContextStack() != null && !event.getContextStack().isEmpty()) {<a name="line.196"></a> |
| <span class="sourceLineNo">197</span> sbuf.append("<tr><td bgcolor=\"#EEEEEE\" style=\"font-size : ").append(fontSize);<a name="line.197"></a> |
| <span class="sourceLineNo">198</span> sbuf.append(";\" colspan=\"6\" ");<a name="line.198"></a> |
| <span class="sourceLineNo">199</span> sbuf.append("title=\"Nested Diagnostic Context\">");<a name="line.199"></a> |
| <span class="sourceLineNo">200</span> sbuf.append("NDC: ").append(Transform.escapeHtmlTags(event.getContextStack().toString()));<a name="line.200"></a> |
| <span class="sourceLineNo">201</span> sbuf.append("</td></tr>").append(Strings.LINE_SEPARATOR);<a name="line.201"></a> |
| <span class="sourceLineNo">202</span> }<a name="line.202"></a> |
| <span class="sourceLineNo">203</span><a name="line.203"></a> |
| <span class="sourceLineNo">204</span> if (event.getContextData() != null && !event.getContextData().isEmpty()) {<a name="line.204"></a> |
| <span class="sourceLineNo">205</span> sbuf.append("<tr><td bgcolor=\"#EEEEEE\" style=\"font-size : ").append(fontSize);<a name="line.205"></a> |
| <span class="sourceLineNo">206</span> sbuf.append(";\" colspan=\"6\" ");<a name="line.206"></a> |
| <span class="sourceLineNo">207</span> sbuf.append("title=\"Mapped Diagnostic Context\">");<a name="line.207"></a> |
| <span class="sourceLineNo">208</span> sbuf.append("MDC: ").append(Transform.escapeHtmlTags(event.getContextData().toMap().toString()));<a name="line.208"></a> |
| <span class="sourceLineNo">209</span> sbuf.append("</td></tr>").append(Strings.LINE_SEPARATOR);<a name="line.209"></a> |
| <span class="sourceLineNo">210</span> }<a name="line.210"></a> |
| <span class="sourceLineNo">211</span><a name="line.211"></a> |
| <span class="sourceLineNo">212</span> final Throwable throwable = event.getThrown();<a name="line.212"></a> |
| <span class="sourceLineNo">213</span> if (throwable != null) {<a name="line.213"></a> |
| <span class="sourceLineNo">214</span> sbuf.append("<tr><td bgcolor=\"#993300\" style=\"color:White; font-size : ").append(fontSize);<a name="line.214"></a> |
| <span class="sourceLineNo">215</span> sbuf.append(";\" colspan=\"6\">");<a name="line.215"></a> |
| <span class="sourceLineNo">216</span> appendThrowableAsHtml(throwable, sbuf);<a name="line.216"></a> |
| <span class="sourceLineNo">217</span> sbuf.append("</td></tr>").append(Strings.LINE_SEPARATOR);<a name="line.217"></a> |
| <span class="sourceLineNo">218</span> }<a name="line.218"></a> |
| <span class="sourceLineNo">219</span><a name="line.219"></a> |
| <span class="sourceLineNo">220</span> return sbuf.toString();<a name="line.220"></a> |
| <span class="sourceLineNo">221</span> }<a name="line.221"></a> |
| <span class="sourceLineNo">222</span><a name="line.222"></a> |
| <span class="sourceLineNo">223</span> @Override<a name="line.223"></a> |
| <span class="sourceLineNo">224</span> /**<a name="line.224"></a> |
| <span class="sourceLineNo">225</span> * @return The content type.<a name="line.225"></a> |
| <span class="sourceLineNo">226</span> */<a name="line.226"></a> |
| <span class="sourceLineNo">227</span> public String getContentType() {<a name="line.227"></a> |
| <span class="sourceLineNo">228</span> return contentType;<a name="line.228"></a> |
| <span class="sourceLineNo">229</span> }<a name="line.229"></a> |
| <span class="sourceLineNo">230</span><a name="line.230"></a> |
| <span class="sourceLineNo">231</span> private void appendThrowableAsHtml(final Throwable throwable, final StringBuilder sbuf) {<a name="line.231"></a> |
| <span class="sourceLineNo">232</span> final StringWriter sw = new StringWriter();<a name="line.232"></a> |
| <span class="sourceLineNo">233</span> final PrintWriter pw = new PrintWriter(sw);<a name="line.233"></a> |
| <span class="sourceLineNo">234</span> try {<a name="line.234"></a> |
| <span class="sourceLineNo">235</span> throwable.printStackTrace(pw);<a name="line.235"></a> |
| <span class="sourceLineNo">236</span> } catch (final RuntimeException ex) {<a name="line.236"></a> |
| <span class="sourceLineNo">237</span> // Ignore the exception.<a name="line.237"></a> |
| <span class="sourceLineNo">238</span> }<a name="line.238"></a> |
| <span class="sourceLineNo">239</span> pw.flush();<a name="line.239"></a> |
| <span class="sourceLineNo">240</span> final LineNumberReader reader = new LineNumberReader(new StringReader(sw.toString()));<a name="line.240"></a> |
| <span class="sourceLineNo">241</span> final ArrayList<String> lines = new ArrayList<>();<a name="line.241"></a> |
| <span class="sourceLineNo">242</span> try {<a name="line.242"></a> |
| <span class="sourceLineNo">243</span> String line = reader.readLine();<a name="line.243"></a> |
| <span class="sourceLineNo">244</span> while (line != null) {<a name="line.244"></a> |
| <span class="sourceLineNo">245</span> lines.add(line);<a name="line.245"></a> |
| <span class="sourceLineNo">246</span> line = reader.readLine();<a name="line.246"></a> |
| <span class="sourceLineNo">247</span> }<a name="line.247"></a> |
| <span class="sourceLineNo">248</span> } catch (final IOException ex) {<a name="line.248"></a> |
| <span class="sourceLineNo">249</span> if (ex instanceof InterruptedIOException) {<a name="line.249"></a> |
| <span class="sourceLineNo">250</span> Thread.currentThread().interrupt();<a name="line.250"></a> |
| <span class="sourceLineNo">251</span> }<a name="line.251"></a> |
| <span class="sourceLineNo">252</span> lines.add(ex.toString());<a name="line.252"></a> |
| <span class="sourceLineNo">253</span> }<a name="line.253"></a> |
| <span class="sourceLineNo">254</span> boolean first = true;<a name="line.254"></a> |
| <span class="sourceLineNo">255</span> for (final String line : lines) {<a name="line.255"></a> |
| <span class="sourceLineNo">256</span> if (!first) {<a name="line.256"></a> |
| <span class="sourceLineNo">257</span> sbuf.append(TRACE_PREFIX);<a name="line.257"></a> |
| <span class="sourceLineNo">258</span> } else {<a name="line.258"></a> |
| <span class="sourceLineNo">259</span> first = false;<a name="line.259"></a> |
| <span class="sourceLineNo">260</span> }<a name="line.260"></a> |
| <span class="sourceLineNo">261</span> sbuf.append(Transform.escapeHtmlTags(line));<a name="line.261"></a> |
| <span class="sourceLineNo">262</span> sbuf.append(Strings.LINE_SEPARATOR);<a name="line.262"></a> |
| <span class="sourceLineNo">263</span> }<a name="line.263"></a> |
| <span class="sourceLineNo">264</span> }<a name="line.264"></a> |
| <span class="sourceLineNo">265</span><a name="line.265"></a> |
| <span class="sourceLineNo">266</span> private StringBuilder appendLs(final StringBuilder sbuilder, final String s) {<a name="line.266"></a> |
| <span class="sourceLineNo">267</span> sbuilder.append(s).append(Strings.LINE_SEPARATOR);<a name="line.267"></a> |
| <span class="sourceLineNo">268</span> return sbuilder;<a name="line.268"></a> |
| <span class="sourceLineNo">269</span> }<a name="line.269"></a> |
| <span class="sourceLineNo">270</span><a name="line.270"></a> |
| <span class="sourceLineNo">271</span> private StringBuilder append(final StringBuilder sbuilder, final String s) {<a name="line.271"></a> |
| <span class="sourceLineNo">272</span> sbuilder.append(s);<a name="line.272"></a> |
| <span class="sourceLineNo">273</span> return sbuilder;<a name="line.273"></a> |
| <span class="sourceLineNo">274</span> }<a name="line.274"></a> |
| <span class="sourceLineNo">275</span><a name="line.275"></a> |
| <span class="sourceLineNo">276</span> /**<a name="line.276"></a> |
| <span class="sourceLineNo">277</span> * Returns appropriate HTML headers.<a name="line.277"></a> |
| <span class="sourceLineNo">278</span> * @return The header as a byte array.<a name="line.278"></a> |
| <span class="sourceLineNo">279</span> */<a name="line.279"></a> |
| <span class="sourceLineNo">280</span> @Override<a name="line.280"></a> |
| <span class="sourceLineNo">281</span> public byte[] getHeader() {<a name="line.281"></a> |
| <span class="sourceLineNo">282</span> final StringBuilder sbuf = new StringBuilder();<a name="line.282"></a> |
| <span class="sourceLineNo">283</span> append(sbuf, "<!DOCTYPE HTML PUBLIC \"-//W3C//DTD HTML 4.01 Transitional//EN\" ");<a name="line.283"></a> |
| <span class="sourceLineNo">284</span> appendLs(sbuf, "\"http://www.w3.org/TR/html4/loose.dtd\">");<a name="line.284"></a> |
| <span class="sourceLineNo">285</span> appendLs(sbuf, "<html>");<a name="line.285"></a> |
| <span class="sourceLineNo">286</span> appendLs(sbuf, "<head>");<a name="line.286"></a> |
| <span class="sourceLineNo">287</span> append(sbuf, "<meta charset=\"");<a name="line.287"></a> |
| <span class="sourceLineNo">288</span> append(sbuf, getCharset().toString());<a name="line.288"></a> |
| <span class="sourceLineNo">289</span> appendLs(sbuf, "\"/>");<a name="line.289"></a> |
| <span class="sourceLineNo">290</span> append(sbuf, "<title>").append(title);<a name="line.290"></a> |
| <span class="sourceLineNo">291</span> appendLs(sbuf, "</title>");<a name="line.291"></a> |
| <span class="sourceLineNo">292</span> appendLs(sbuf, "<style type=\"text/css\">");<a name="line.292"></a> |
| <span class="sourceLineNo">293</span> appendLs(sbuf, "<!--");<a name="line.293"></a> |
| <span class="sourceLineNo">294</span> append(sbuf, "body, table {font-family:").append(font).append("; font-size: ");<a name="line.294"></a> |
| <span class="sourceLineNo">295</span> appendLs(sbuf, headerSize).append(";}");<a name="line.295"></a> |
| <span class="sourceLineNo">296</span> appendLs(sbuf, "th {background: #336699; color: #FFFFFF; text-align: left;}");<a name="line.296"></a> |
| <span class="sourceLineNo">297</span> appendLs(sbuf, "-->");<a name="line.297"></a> |
| <span class="sourceLineNo">298</span> appendLs(sbuf, "</style>");<a name="line.298"></a> |
| <span class="sourceLineNo">299</span> appendLs(sbuf, "</head>");<a name="line.299"></a> |
| <span class="sourceLineNo">300</span> appendLs(sbuf, "<body bgcolor=\"#FFFFFF\" topmargin=\"6\" leftmargin=\"6\">");<a name="line.300"></a> |
| <span class="sourceLineNo">301</span> appendLs(sbuf, "<hr size=\"1\" noshade=\"noshade\">");<a name="line.301"></a> |
| <span class="sourceLineNo">302</span> appendLs(sbuf, "Log session start time " + new java.util.Date() + "<br>");<a name="line.302"></a> |
| <span class="sourceLineNo">303</span> appendLs(sbuf, "<br>");<a name="line.303"></a> |
| <span class="sourceLineNo">304</span> appendLs(sbuf,<a name="line.304"></a> |
| <span class="sourceLineNo">305</span> "<table cellspacing=\"0\" cellpadding=\"4\" border=\"1\" bordercolor=\"#224466\" width=\"100%\">");<a name="line.305"></a> |
| <span class="sourceLineNo">306</span> appendLs(sbuf, "<tr>");<a name="line.306"></a> |
| <span class="sourceLineNo">307</span> appendLs(sbuf, "<th>Time</th>");<a name="line.307"></a> |
| <span class="sourceLineNo">308</span> appendLs(sbuf, "<th>Thread</th>");<a name="line.308"></a> |
| <span class="sourceLineNo">309</span> appendLs(sbuf, "<th>Level</th>");<a name="line.309"></a> |
| <span class="sourceLineNo">310</span> appendLs(sbuf, "<th>Logger</th>");<a name="line.310"></a> |
| <span class="sourceLineNo">311</span> if (locationInfo) {<a name="line.311"></a> |
| <span class="sourceLineNo">312</span> appendLs(sbuf, "<th>File:Line</th>");<a name="line.312"></a> |
| <span class="sourceLineNo">313</span> }<a name="line.313"></a> |
| <span class="sourceLineNo">314</span> appendLs(sbuf, "<th>Message</th>");<a name="line.314"></a> |
| <span class="sourceLineNo">315</span> appendLs(sbuf, "</tr>");<a name="line.315"></a> |
| <span class="sourceLineNo">316</span> return sbuf.toString().getBytes(getCharset());<a name="line.316"></a> |
| <span class="sourceLineNo">317</span> }<a name="line.317"></a> |
| <span class="sourceLineNo">318</span><a name="line.318"></a> |
| <span class="sourceLineNo">319</span> /**<a name="line.319"></a> |
| <span class="sourceLineNo">320</span> * Returns the appropriate HTML footers.<a name="line.320"></a> |
| <span class="sourceLineNo">321</span> * @return the footer as a byte array.<a name="line.321"></a> |
| <span class="sourceLineNo">322</span> */<a name="line.322"></a> |
| <span class="sourceLineNo">323</span> @Override<a name="line.323"></a> |
| <span class="sourceLineNo">324</span> public byte[] getFooter() {<a name="line.324"></a> |
| <span class="sourceLineNo">325</span> final StringBuilder sbuf = new StringBuilder();<a name="line.325"></a> |
| <span class="sourceLineNo">326</span> appendLs(sbuf, "</table>");<a name="line.326"></a> |
| <span class="sourceLineNo">327</span> appendLs(sbuf, "<br>");<a name="line.327"></a> |
| <span class="sourceLineNo">328</span> appendLs(sbuf, "</body></html>");<a name="line.328"></a> |
| <span class="sourceLineNo">329</span> return getBytes(sbuf.toString());<a name="line.329"></a> |
| <span class="sourceLineNo">330</span> }<a name="line.330"></a> |
| <span class="sourceLineNo">331</span><a name="line.331"></a> |
| <span class="sourceLineNo">332</span> /**<a name="line.332"></a> |
| <span class="sourceLineNo">333</span> * Creates an HTML Layout.<a name="line.333"></a> |
| <span class="sourceLineNo">334</span> * @param locationInfo If "true", location information will be included. The default is false.<a name="line.334"></a> |
| <span class="sourceLineNo">335</span> * @param title The title to include in the file header. If none is specified the default title will be used.<a name="line.335"></a> |
| <span class="sourceLineNo">336</span> * @param contentType The content type. Defaults to "text/html".<a name="line.336"></a> |
| <span class="sourceLineNo">337</span> * @param charset The character set to use. If not specified, the default will be used.<a name="line.337"></a> |
| <span class="sourceLineNo">338</span> * @param fontSize The font size of the text.<a name="line.338"></a> |
| <span class="sourceLineNo">339</span> * @param font The font to use for the text.<a name="line.339"></a> |
| <span class="sourceLineNo">340</span> * @return An HTML Layout.<a name="line.340"></a> |
| <span class="sourceLineNo">341</span> */<a name="line.341"></a> |
| <span class="sourceLineNo">342</span> @PluginFactory<a name="line.342"></a> |
| <span class="sourceLineNo">343</span> public static HtmlLayout createLayout(<a name="line.343"></a> |
| <span class="sourceLineNo">344</span> @PluginAttribute(value = "locationInfo") final boolean locationInfo,<a name="line.344"></a> |
| <span class="sourceLineNo">345</span> @PluginAttribute(value = "title", defaultString = DEFAULT_TITLE) final String title,<a name="line.345"></a> |
| <span class="sourceLineNo">346</span> @PluginAttribute("contentType") String contentType,<a name="line.346"></a> |
| <span class="sourceLineNo">347</span> @PluginAttribute(value = "charset", defaultString = "UTF-8") final Charset charset,<a name="line.347"></a> |
| <span class="sourceLineNo">348</span> @PluginAttribute("fontSize") String fontSize,<a name="line.348"></a> |
| <span class="sourceLineNo">349</span> @PluginAttribute(value = "fontName", defaultString = DEFAULT_FONT_FAMILY) final String font) {<a name="line.349"></a> |
| <span class="sourceLineNo">350</span> final FontSize fs = FontSize.getFontSize(fontSize);<a name="line.350"></a> |
| <span class="sourceLineNo">351</span> fontSize = fs.getFontSize();<a name="line.351"></a> |
| <span class="sourceLineNo">352</span> final String headerSize = fs.larger().getFontSize();<a name="line.352"></a> |
| <span class="sourceLineNo">353</span> if (contentType == null) {<a name="line.353"></a> |
| <span class="sourceLineNo">354</span> contentType = DEFAULT_CONTENT_TYPE + "; charset=" + charset;<a name="line.354"></a> |
| <span class="sourceLineNo">355</span> }<a name="line.355"></a> |
| <span class="sourceLineNo">356</span> return new HtmlLayout(locationInfo, title, contentType, charset, font, fontSize, headerSize);<a name="line.356"></a> |
| <span class="sourceLineNo">357</span> }<a name="line.357"></a> |
| <span class="sourceLineNo">358</span><a name="line.358"></a> |
| <span class="sourceLineNo">359</span> /**<a name="line.359"></a> |
| <span class="sourceLineNo">360</span> * Creates an HTML Layout using the default settings.<a name="line.360"></a> |
| <span class="sourceLineNo">361</span> *<a name="line.361"></a> |
| <span class="sourceLineNo">362</span> * @return an HTML Layout.<a name="line.362"></a> |
| <span class="sourceLineNo">363</span> */<a name="line.363"></a> |
| <span class="sourceLineNo">364</span> public static HtmlLayout createDefaultLayout() {<a name="line.364"></a> |
| <span class="sourceLineNo">365</span> return newBuilder().build();<a name="line.365"></a> |
| <span class="sourceLineNo">366</span> }<a name="line.366"></a> |
| <span class="sourceLineNo">367</span><a name="line.367"></a> |
| <span class="sourceLineNo">368</span> @PluginBuilderFactory<a name="line.368"></a> |
| <span class="sourceLineNo">369</span> public static Builder newBuilder() {<a name="line.369"></a> |
| <span class="sourceLineNo">370</span> return new Builder();<a name="line.370"></a> |
| <span class="sourceLineNo">371</span> }<a name="line.371"></a> |
| <span class="sourceLineNo">372</span><a name="line.372"></a> |
| <span class="sourceLineNo">373</span> public static class Builder implements org.apache.logging.log4j.core.util.Builder<HtmlLayout> {<a name="line.373"></a> |
| <span class="sourceLineNo">374</span><a name="line.374"></a> |
| <span class="sourceLineNo">375</span> @PluginBuilderAttribute<a name="line.375"></a> |
| <span class="sourceLineNo">376</span> private boolean locationInfo = false;<a name="line.376"></a> |
| <span class="sourceLineNo">377</span><a name="line.377"></a> |
| <span class="sourceLineNo">378</span> @PluginBuilderAttribute<a name="line.378"></a> |
| <span class="sourceLineNo">379</span> private String title = DEFAULT_TITLE;<a name="line.379"></a> |
| <span class="sourceLineNo">380</span><a name="line.380"></a> |
| <span class="sourceLineNo">381</span> @PluginBuilderAttribute<a name="line.381"></a> |
| <span class="sourceLineNo">382</span> private String contentType = null; // defer default value in order to use specified charset<a name="line.382"></a> |
| <span class="sourceLineNo">383</span><a name="line.383"></a> |
| <span class="sourceLineNo">384</span> @PluginBuilderAttribute<a name="line.384"></a> |
| <span class="sourceLineNo">385</span> private Charset charset = StandardCharsets.UTF_8;<a name="line.385"></a> |
| <span class="sourceLineNo">386</span><a name="line.386"></a> |
| <span class="sourceLineNo">387</span> @PluginBuilderAttribute<a name="line.387"></a> |
| <span class="sourceLineNo">388</span> private FontSize fontSize = FontSize.SMALL;<a name="line.388"></a> |
| <span class="sourceLineNo">389</span><a name="line.389"></a> |
| <span class="sourceLineNo">390</span> @PluginBuilderAttribute<a name="line.390"></a> |
| <span class="sourceLineNo">391</span> private String fontName = DEFAULT_FONT_FAMILY;<a name="line.391"></a> |
| <span class="sourceLineNo">392</span><a name="line.392"></a> |
| <span class="sourceLineNo">393</span> private Builder() {<a name="line.393"></a> |
| <span class="sourceLineNo">394</span> }<a name="line.394"></a> |
| <span class="sourceLineNo">395</span><a name="line.395"></a> |
| <span class="sourceLineNo">396</span> public Builder withLocationInfo(final boolean locationInfo) {<a name="line.396"></a> |
| <span class="sourceLineNo">397</span> this.locationInfo = locationInfo;<a name="line.397"></a> |
| <span class="sourceLineNo">398</span> return this;<a name="line.398"></a> |
| <span class="sourceLineNo">399</span> }<a name="line.399"></a> |
| <span class="sourceLineNo">400</span><a name="line.400"></a> |
| <span class="sourceLineNo">401</span> public Builder withTitle(final String title) {<a name="line.401"></a> |
| <span class="sourceLineNo">402</span> this.title = title;<a name="line.402"></a> |
| <span class="sourceLineNo">403</span> return this;<a name="line.403"></a> |
| <span class="sourceLineNo">404</span> }<a name="line.404"></a> |
| <span class="sourceLineNo">405</span><a name="line.405"></a> |
| <span class="sourceLineNo">406</span> public Builder withContentType(final String contentType) {<a name="line.406"></a> |
| <span class="sourceLineNo">407</span> this.contentType = contentType;<a name="line.407"></a> |
| <span class="sourceLineNo">408</span> return this;<a name="line.408"></a> |
| <span class="sourceLineNo">409</span> }<a name="line.409"></a> |
| <span class="sourceLineNo">410</span><a name="line.410"></a> |
| <span class="sourceLineNo">411</span> public Builder withCharset(final Charset charset) {<a name="line.411"></a> |
| <span class="sourceLineNo">412</span> this.charset = charset;<a name="line.412"></a> |
| <span class="sourceLineNo">413</span> return this;<a name="line.413"></a> |
| <span class="sourceLineNo">414</span> }<a name="line.414"></a> |
| <span class="sourceLineNo">415</span><a name="line.415"></a> |
| <span class="sourceLineNo">416</span> public Builder withFontSize(final FontSize fontSize) {<a name="line.416"></a> |
| <span class="sourceLineNo">417</span> this.fontSize = fontSize;<a name="line.417"></a> |
| <span class="sourceLineNo">418</span> return this;<a name="line.418"></a> |
| <span class="sourceLineNo">419</span> }<a name="line.419"></a> |
| <span class="sourceLineNo">420</span><a name="line.420"></a> |
| <span class="sourceLineNo">421</span> public Builder withFontName(final String fontName) {<a name="line.421"></a> |
| <span class="sourceLineNo">422</span> this.fontName = fontName;<a name="line.422"></a> |
| <span class="sourceLineNo">423</span> return this;<a name="line.423"></a> |
| <span class="sourceLineNo">424</span> }<a name="line.424"></a> |
| <span class="sourceLineNo">425</span><a name="line.425"></a> |
| <span class="sourceLineNo">426</span> @Override<a name="line.426"></a> |
| <span class="sourceLineNo">427</span> public HtmlLayout build() {<a name="line.427"></a> |
| <span class="sourceLineNo">428</span> // TODO: extract charset from content-type<a name="line.428"></a> |
| <span class="sourceLineNo">429</span> if (contentType == null) {<a name="line.429"></a> |
| <span class="sourceLineNo">430</span> contentType = DEFAULT_CONTENT_TYPE + "; charset=" + charset;<a name="line.430"></a> |
| <span class="sourceLineNo">431</span> }<a name="line.431"></a> |
| <span class="sourceLineNo">432</span> return new HtmlLayout(locationInfo, title, contentType, charset, fontName, fontSize.getFontSize(),<a name="line.432"></a> |
| <span class="sourceLineNo">433</span> fontSize.larger().getFontSize());<a name="line.433"></a> |
| <span class="sourceLineNo">434</span> }<a name="line.434"></a> |
| <span class="sourceLineNo">435</span> }<a name="line.435"></a> |
| <span class="sourceLineNo">436</span>}<a name="line.436"></a> |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| </pre> |
| </div> |
| </body> |
| </html> |
