1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17 package org.apache.logging.log4j.core.layout;
18
19 import org.apache.logging.log4j.Level;
20 import org.apache.logging.log4j.core.LogEvent;
21 import org.apache.logging.log4j.core.config.plugins.Plugin;
22 import org.apache.logging.log4j.core.config.plugins.PluginAttr;
23 import org.apache.logging.log4j.core.config.plugins.PluginFactory;
24 import org.apache.logging.log4j.core.helpers.Charsets;
25 import org.apache.logging.log4j.core.helpers.Constants;
26 import org.apache.logging.log4j.core.helpers.Transform;
27
28 import java.io.IOException;
29 import java.io.InterruptedIOException;
30 import java.io.LineNumberReader;
31 import java.io.PrintWriter;
32 import java.io.StringReader;
33 import java.io.StringWriter;
34 import java.lang.management.ManagementFactory;
35 import java.nio.charset.Charset;
36 import java.util.ArrayList;
37
38
39
40
41
42
43
44 @Plugin(name = "HTMLLayout", type = "Core", elementType = "layout", printObject = true)
45 public final class HTMLLayout extends AbstractStringLayout {
46
47 private static final int BUF_SIZE = 256;
48
49 private static final String TRACE_PREFIX = "<br /> ";
50
51 private static final String REGEXP = Constants.LINE_SEP.equals("\n") ? "\n" : Constants.LINE_SEP + "|\n";
52
53 private static final String DEFAULT_TITLE = "Log4J Log Messages";
54
55 private static final String DEFAULT_CONTENT_TYPE = "text/html";
56
57 private final long jvmStartTime = ManagementFactory.getRuntimeMXBean().getStartTime();
58
59
60 private final boolean locationInfo;
61
62 private final String title;
63
64 private final String contentType;
65
66
67 private enum FontSize {
68 SMALLER("smaller"), XXSMALL("xx-small"), XSMALL("x-small"), SMALL("small"), MEDIUM("medium"), LARGE("large"),
69 XLARGE("x-large"), XXLARGE("xx-large"), LARGER("larger");
70
71 private final String size;
72
73 private FontSize(final String size) {
74 this.size = size;
75 }
76
77 public String getFontSize() {
78 return size;
79 }
80
81 public static FontSize getFontSize(final String size) {
82 for (final FontSize fontSize : values()) {
83 if (fontSize.size.equals(size)) {
84 return fontSize;
85 }
86 }
87 return SMALL;
88 }
89
90 public FontSize larger() {
91 return this.ordinal() < XXLARGE.ordinal() ? FontSize.values()[this.ordinal() + 1] : this;
92 }
93 }
94
95 private final String font;
96 private final String fontSize;
97 private final String headerSize;
98
99 private HTMLLayout(final boolean locationInfo, final String title, final String contentType, final Charset charset,
100 final String font, final String fontSize, final String headerSize) {
101 super(charset);
102 this.locationInfo = locationInfo;
103 this.title = title;
104 this.contentType = contentType;
105 this.font = font;
106 this.fontSize = fontSize;
107 this.headerSize = headerSize;
108 }
109
110
111
112
113
114
115
116 public String toSerializable(final LogEvent event) {
117 final StringBuilder sbuf = new StringBuilder(BUF_SIZE);
118
119 sbuf.append(Constants.LINE_SEP).append("<tr>").append(Constants.LINE_SEP);
120
121 sbuf.append("<td>");
122 sbuf.append(event.getMillis() - jvmStartTime);
123 sbuf.append("</td>").append(Constants.LINE_SEP);
124
125 final String escapedThread = Transform.escapeTags(event.getThreadName());
126 sbuf.append("<td title=\"").append(escapedThread).append(" thread\">");
127 sbuf.append(escapedThread);
128 sbuf.append("</td>").append(Constants.LINE_SEP);
129
130 sbuf.append("<td title=\"Level\">");
131 if (event.getLevel().equals(Level.DEBUG)) {
132 sbuf.append("<font color=\"#339933\">");
133 sbuf.append(Transform.escapeTags(String.valueOf(event.getLevel())));
134 sbuf.append("</font>");
135 } else if (event.getLevel().isAtLeastAsSpecificAs(Level.WARN)) {
136 sbuf.append("<font color=\"#993300\"><strong>");
137 sbuf.append(Transform.escapeTags(String.valueOf(event.getLevel())));
138 sbuf.append("</strong></font>");
139 } else {
140 sbuf.append(Transform.escapeTags(String.valueOf(event.getLevel())));
141 }
142 sbuf.append("</td>").append(Constants.LINE_SEP);
143
144 String escapedLogger = Transform.escapeTags(event.getLoggerName());
145 if (escapedLogger.length() == 0) {
146 escapedLogger = "root";
147 }
148 sbuf.append("<td title=\"").append(escapedLogger).append(" logger\">");
149 sbuf.append(escapedLogger);
150 sbuf.append("</td>").append(Constants.LINE_SEP);
151
152 if (locationInfo) {
153 final StackTraceElement element = event.getSource();
154 sbuf.append("<td>");
155 sbuf.append(Transform.escapeTags(element.getFileName()));
156 sbuf.append(':');
157 sbuf.append(element.getLineNumber());
158 sbuf.append("</td>").append(Constants.LINE_SEP);
159 }
160
161 sbuf.append("<td title=\"Message\">");
162 sbuf.append(Transform.escapeTags(event.getMessage().getFormattedMessage()).replaceAll(REGEXP, "<br />"));
163 sbuf.append("</td>").append(Constants.LINE_SEP);
164 sbuf.append("</tr>").append(Constants.LINE_SEP);
165
166 if (event.getContextStack().getDepth() > 0) {
167 sbuf.append("<tr><td bgcolor=\"#EEEEEE\" style=\"font-size : ").append(fontSize);
168 sbuf.append(";\" colspan=\"6\" ");
169 sbuf.append("title=\"Nested Diagnostic Context\">");
170 sbuf.append("NDC: ").append(Transform.escapeTags(event.getContextStack().toString()));
171 sbuf.append("</td></tr>").append(Constants.LINE_SEP);
172 }
173
174 if (event.getContextMap().size() > 0) {
175 sbuf.append("<tr><td bgcolor=\"#EEEEEE\" style=\"font-size : ").append(fontSize);
176 sbuf.append(";\" colspan=\"6\" ");
177 sbuf.append("title=\"Mapped Diagnostic Context\">");
178 sbuf.append("MDC: ").append(Transform.escapeTags(event.getContextMap().toString()));
179 sbuf.append("</td></tr>").append(Constants.LINE_SEP);
180 }
181
182 final Throwable throwable = event.getThrown();
183 if (throwable != null) {
184 sbuf.append("<tr><td bgcolor=\"#993300\" style=\"color:White; font-size : ").append(fontSize);
185 sbuf.append(";\" colspan=\"6\">");
186 appendThrowableAsHTML(throwable, sbuf);
187 sbuf.append("</td></tr>").append(Constants.LINE_SEP);
188 }
189
190 return sbuf.toString();
191 }
192
193 @Override
194
195
196
197 public String getContentType() {
198 return "text/html";
199 }
200
201 private void appendThrowableAsHTML(final Throwable throwable, final StringBuilder sbuf) {
202 final StringWriter sw = new StringWriter();
203 final PrintWriter pw = new PrintWriter(sw);
204 try {
205 throwable.printStackTrace(pw);
206 } catch (final RuntimeException ex) {
207
208 }
209 pw.flush();
210 final LineNumberReader reader = new LineNumberReader(new StringReader(sw.toString()));
211 final ArrayList<String> lines = new ArrayList<String>();
212 try {
213 String line = reader.readLine();
214 while (line != null) {
215 lines.add(line);
216 line = reader.readLine();
217 }
218 } catch (final IOException ex) {
219 if (ex instanceof InterruptedIOException) {
220 Thread.currentThread().interrupt();
221 }
222 lines.add(ex.toString());
223 }
224 boolean first = true;
225 for (final String line : lines) {
226 if (!first) {
227 sbuf.append(TRACE_PREFIX);
228 } else {
229 first = false;
230 }
231 sbuf.append(Transform.escapeTags(line));
232 sbuf.append(Constants.LINE_SEP);
233 }
234 }
235
236
237
238
239
240 @Override
241 public byte[] getHeader() {
242 final StringBuilder sbuf = new StringBuilder();
243 sbuf.append("<!DOCTYPE HTML PUBLIC \"-//W3C//DTD HTML 4.01 Transitional//EN\" ");
244 sbuf.append("\"http://www.w3.org/TR/html4/loose.dtd\">");
245 sbuf.append(Constants.LINE_SEP);
246 sbuf.append("<html>").append(Constants.LINE_SEP);
247 sbuf.append("<head>").append(Constants.LINE_SEP);
248 sbuf.append("<title>").append(title).append("</title>").append(Constants.LINE_SEP);
249 sbuf.append("<style type=\"text/css\">").append(Constants.LINE_SEP);
250 sbuf.append("<!--").append(Constants.LINE_SEP);
251 sbuf.append("body, table {font-family:").append(font).append("; font-size: ");
252 sbuf.append(headerSize).append(";}").append(Constants.LINE_SEP);
253 sbuf.append("th {background: #336699; color: #FFFFFF; text-align: left;}").append(Constants.LINE_SEP);
254 sbuf.append("-->").append(Constants.LINE_SEP);
255 sbuf.append("</style>").append(Constants.LINE_SEP);
256 sbuf.append("</head>").append(Constants.LINE_SEP);
257 sbuf.append("<body bgcolor=\"#FFFFFF\" topmargin=\"6\" leftmargin=\"6\">").append(Constants.LINE_SEP);
258 sbuf.append("<hr size=\"1\" noshade>").append(Constants.LINE_SEP);
259 sbuf.append("Log session start time " + new java.util.Date() + "<br>").append(Constants.LINE_SEP);
260 sbuf.append("<br>").append(Constants.LINE_SEP);
261 sbuf.append(
262 "<table cellspacing=\"0\" cellpadding=\"4\" border=\"1\" bordercolor=\"#224466\" width=\"100%\">");
263 sbuf.append(Constants.LINE_SEP);
264 sbuf.append("<tr>").append(Constants.LINE_SEP);
265 sbuf.append("<th>Time</th>").append(Constants.LINE_SEP);
266 sbuf.append("<th>Thread</th>").append(Constants.LINE_SEP);
267 sbuf.append("<th>Level</th>").append(Constants.LINE_SEP);
268 sbuf.append("<th>Logger</th>").append(Constants.LINE_SEP);
269 if (locationInfo) {
270 sbuf.append("<th>File:Line</th>").append(Constants.LINE_SEP);
271 }
272 sbuf.append("<th>Message</th>").append(Constants.LINE_SEP);
273 sbuf.append("</tr>").append(Constants.LINE_SEP);
274 return sbuf.toString().getBytes(getCharset());
275 }
276
277
278
279
280
281 @Override
282 public byte[] getFooter() {
283 final StringBuilder sbuf = new StringBuilder();
284 sbuf.append("</table>").append(Constants.LINE_SEP);
285 sbuf.append("<br>").append(Constants.LINE_SEP);
286 sbuf.append("</body></html>");
287 return sbuf.toString().getBytes(getCharset());
288 }
289
290
291
292
293
294
295
296
297
298
299
300 @PluginFactory
301 public static HTMLLayout createLayout(@PluginAttr("locationInfo") final String locationInfo,
302 @PluginAttr("title") String title,
303 @PluginAttr("contentType") String contentType,
304 @PluginAttr("charset") final String charsetName,
305 @PluginAttr("fontSize") String fontSize,
306 @PluginAttr("fontName") String font) {
307 final Charset charset = Charsets.getSupportedCharset(charsetName);
308 if (font == null) {
309 font = "arial,sans-serif";
310 }
311 final FontSize fs = FontSize.getFontSize(fontSize);
312 fontSize = fs.getFontSize();
313 final String headerSize = fs.larger().getFontSize();
314 final boolean info = locationInfo == null ? false : Boolean.valueOf(locationInfo);
315 if (title == null) {
316 title = DEFAULT_TITLE;
317 }
318 if (contentType == null) {
319 contentType = DEFAULT_CONTENT_TYPE;
320 }
321 return new HTMLLayout(info, title, contentType, charset, font, fontSize, headerSize);
322 }
323 }