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 java.io.IOException;
20 import java.io.InterruptedIOException;
21 import java.io.LineNumberReader;
22 import java.io.PrintWriter;
23 import java.io.StringReader;
24 import java.io.StringWriter;
25 import java.nio.charset.Charset;
26 import java.util.ArrayList;
27 import java.util.HashMap;
28 import java.util.List;
29 import java.util.Map;
30
31 import org.apache.logging.log4j.core.config.plugins.Plugin;
32 import org.apache.logging.log4j.core.config.plugins.PluginAttr;
33 import org.apache.logging.log4j.core.config.plugins.PluginFactory;
34 import org.apache.logging.log4j.core.helpers.Charsets;
35 import org.apache.logging.log4j.core.helpers.Transform;
36 import org.apache.logging.log4j.core.LogEvent;
37 import org.apache.logging.log4j.message.Message;
38 import org.apache.logging.log4j.message.MultiformatMessage;
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75 @Plugin(name = "XMLLayout", category = "Core", elementType = "layout", printObject = true)
76 public class XMLLayout extends AbstractStringLayout {
77
78 private static final int DEFAULT_SIZE = 256;
79
80 private static final String[] FORMATS = new String[] {"xml"};
81
82 private final boolean locationInfo;
83 private final boolean properties;
84 private final boolean complete;
85
86 protected XMLLayout(final boolean locationInfo, final boolean properties, final boolean complete,
87 final Charset charset) {
88 super(charset);
89 this.locationInfo = locationInfo;
90 this.properties = properties;
91 this.complete = complete;
92 }
93
94
95
96
97
98
99
100 public String toSerializable(final LogEvent event) {
101 final StringBuilder buf = new StringBuilder(DEFAULT_SIZE);
102
103
104
105 buf.append("<log4j:event logger=\"");
106 String name = event.getLoggerName();
107 if (name.length() == 0) {
108 name = "root";
109 }
110 buf.append(Transform.escapeTags(name));
111 buf.append("\" timestamp=\"");
112 buf.append(event.getMillis());
113 buf.append("\" level=\"");
114 buf.append(Transform.escapeTags(String.valueOf(event.getLevel())));
115 buf.append("\" thread=\"");
116 buf.append(Transform.escapeTags(event.getThreadName()));
117 buf.append("\">\r\n");
118
119 final Message msg = event.getMessage();
120 if (msg != null) {
121 boolean xmlSupported = false;
122 if (msg instanceof MultiformatMessage) {
123 final String[] formats = ((MultiformatMessage) msg).getFormats();
124 for (final String format : formats) {
125 if (format.equalsIgnoreCase("XML")) {
126 xmlSupported = true;
127 }
128 }
129 }
130 if (xmlSupported) {
131 buf.append("<log4j:message>");
132 buf.append(((MultiformatMessage) msg).getFormattedMessage(FORMATS));
133 buf.append("</log4j:message>");
134 } else {
135 buf.append("<log4j:message><![CDATA[");
136
137
138 Transform.appendEscapingCDATA(buf, event.getMessage().getFormattedMessage());
139 buf.append("]]></log4j:message>\r\n");
140 }
141 }
142
143 if (event.getContextStack().getDepth() > 0) {
144 buf.append("<log4j:NDC><![CDATA[");
145 Transform.appendEscapingCDATA(buf, event.getContextStack().toString());
146 buf.append("]]></log4j:NDC>\r\n");
147 }
148
149 final Throwable throwable = event.getThrown();
150 if (throwable != null) {
151 final List<String> s = getThrowableString(throwable);
152 buf.append("<log4j:throwable><![CDATA[");
153 for (final String str : s) {
154 Transform.appendEscapingCDATA(buf, str);
155 buf.append("\r\n");
156 }
157 buf.append("]]></log4j:throwable>\r\n");
158 }
159
160 if (locationInfo) {
161 final StackTraceElement element = event.getSource();
162 buf.append("<log4j:locationInfo class=\"");
163 buf.append(Transform.escapeTags(element.getClassName()));
164 buf.append("\" method=\"");
165 buf.append(Transform.escapeTags(element.getMethodName()));
166 buf.append("\" file=\"");
167 buf.append(Transform.escapeTags(element.getFileName()));
168 buf.append("\" line=\"");
169 buf.append(element.getLineNumber());
170 buf.append("\"/>\r\n");
171 }
172
173 if (properties && event.getContextMap().size() > 0) {
174 buf.append("<log4j:properties>\r\n");
175 for (final Map.Entry<String, String> entry : event.getContextMap().entrySet()) {
176 buf.append("<log4j:data name=\"");
177 buf.append(Transform.escapeTags(entry.getKey()));
178 buf.append("\" value=\"");
179 buf.append(Transform.escapeTags(String.valueOf(entry.getValue())));
180 buf.append("\"/>\r\n");
181 }
182 buf.append("</log4j:properties>\r\n");
183 }
184
185 buf.append("</log4j:event>\r\n\r\n");
186
187 return buf.toString();
188 }
189
190
191
192
193
194 @Override
195 public byte[] getHeader() {
196 if (!complete) {
197 return null;
198 }
199 final StringBuilder sbuf = new StringBuilder();
200 sbuf.append("<?xml version=\"1.0\" encoding=\"UTF-8\"?>\r\n");
201 sbuf.append("<log4j:eventSet xmlns:log4j=\"http://logging.apache.org/log4j/\">\r\n");
202 return sbuf.toString().getBytes(getCharset());
203 }
204
205
206
207
208
209
210 @Override
211 public byte[] getFooter() {
212 if (!complete) {
213 return null;
214 }
215 final StringBuilder sbuf = new StringBuilder();
216 sbuf.append("</log4j:eventSet>\r\n");
217 return sbuf.toString().getBytes(getCharset());
218 }
219
220
221
222
223
224
225
226 public Map<String, String> getContentFormat() {
227 Map<String, String> result = new HashMap<String, String>();
228 result.put("dtd", "log4j.dtd");
229 result.put("version", "1.2");
230 return result;
231 }
232
233 @Override
234
235
236
237 public String getContentType() {
238 return "text/xml";
239 }
240
241 List<String> getThrowableString(final Throwable throwable) {
242 final StringWriter sw = new StringWriter();
243 final PrintWriter pw = new PrintWriter(sw);
244 try {
245 throwable.printStackTrace(pw);
246 } catch (final RuntimeException ex) {
247
248 }
249 pw.flush();
250 final LineNumberReader reader = new LineNumberReader(new StringReader(sw.toString()));
251 final ArrayList<String> lines = new ArrayList<String>();
252 try {
253 String line = reader.readLine();
254 while (line != null) {
255 lines.add(line);
256 line = reader.readLine();
257 }
258 } catch (final IOException ex) {
259 if (ex instanceof InterruptedIOException) {
260 Thread.currentThread().interrupt();
261 }
262 lines.add(ex.toString());
263 }
264 return lines;
265 }
266
267
268
269
270
271
272
273
274
275 @PluginFactory
276 public static XMLLayout createLayout(@PluginAttr("locationInfo") final String locationInfo,
277 @PluginAttr("properties") final String properties,
278 @PluginAttr("complete") final String complete,
279 @PluginAttr("charset") final String charsetName) {
280 final Charset charset = Charsets.getSupportedCharset(charsetName);
281 final boolean info = locationInfo == null ? false : Boolean.valueOf(locationInfo);
282 final boolean props = properties == null ? false : Boolean.valueOf(properties);
283 final boolean comp = complete == null ? false : Boolean.valueOf(complete);
284 return new XMLLayout(info, props, comp, charset);
285 }
286 }