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 @Override
101 public String toSerializable(final LogEvent event) {
102 final StringBuilder buf = new StringBuilder(DEFAULT_SIZE);
103
104
105
106 buf.append("<log4j:event logger=\"");
107 String name = event.getLoggerName();
108 if (name.length() == 0) {
109 name = "root";
110 }
111 buf.append(Transform.escapeTags(name));
112 buf.append("\" timestamp=\"");
113 buf.append(event.getMillis());
114 buf.append("\" level=\"");
115 buf.append(Transform.escapeTags(String.valueOf(event.getLevel())));
116 buf.append("\" thread=\"");
117 buf.append(Transform.escapeTags(event.getThreadName()));
118 buf.append("\">\r\n");
119
120 final Message msg = event.getMessage();
121 if (msg != null) {
122 boolean xmlSupported = false;
123 if (msg instanceof MultiformatMessage) {
124 final String[] formats = ((MultiformatMessage) msg).getFormats();
125 for (final String format : formats) {
126 if (format.equalsIgnoreCase("XML")) {
127 xmlSupported = true;
128 }
129 }
130 }
131 if (xmlSupported) {
132 buf.append("<log4j:message>");
133 buf.append(((MultiformatMessage) msg).getFormattedMessage(FORMATS));
134 buf.append("</log4j:message>");
135 } else {
136 buf.append("<log4j:message><![CDATA[");
137
138
139 Transform.appendEscapingCDATA(buf, event.getMessage().getFormattedMessage());
140 buf.append("]]></log4j:message>\r\n");
141 }
142 }
143
144 if (event.getContextStack().getDepth() > 0) {
145 buf.append("<log4j:NDC><![CDATA[");
146 Transform.appendEscapingCDATA(buf, event.getContextStack().toString());
147 buf.append("]]></log4j:NDC>\r\n");
148 }
149
150 final Throwable throwable = event.getThrown();
151 if (throwable != null) {
152 final List<String> s = getThrowableString(throwable);
153 buf.append("<log4j:throwable><![CDATA[");
154 for (final String str : s) {
155 Transform.appendEscapingCDATA(buf, str);
156 buf.append("\r\n");
157 }
158 buf.append("]]></log4j:throwable>\r\n");
159 }
160
161 if (locationInfo) {
162 final StackTraceElement element = event.getSource();
163 buf.append("<log4j:locationInfo class=\"");
164 buf.append(Transform.escapeTags(element.getClassName()));
165 buf.append("\" method=\"");
166 buf.append(Transform.escapeTags(element.getMethodName()));
167 buf.append("\" file=\"");
168 buf.append(Transform.escapeTags(element.getFileName()));
169 buf.append("\" line=\"");
170 buf.append(element.getLineNumber());
171 buf.append("\"/>\r\n");
172 }
173
174 if (properties && event.getContextMap().size() > 0) {
175 buf.append("<log4j:properties>\r\n");
176 for (final Map.Entry<String, String> entry : event.getContextMap().entrySet()) {
177 buf.append("<log4j:data name=\"");
178 buf.append(Transform.escapeTags(entry.getKey()));
179 buf.append("\" value=\"");
180 buf.append(Transform.escapeTags(String.valueOf(entry.getValue())));
181 buf.append("\"/>\r\n");
182 }
183 buf.append("</log4j:properties>\r\n");
184 }
185
186 buf.append("</log4j:event>\r\n\r\n");
187
188 return buf.toString();
189 }
190
191
192
193
194
195 @Override
196 public byte[] getHeader() {
197 if (!complete) {
198 return null;
199 }
200 final StringBuilder sbuf = new StringBuilder();
201 sbuf.append("<?xml version=\"1.0\" encoding=\"");
202 sbuf.append(this.getCharset().name());
203 sbuf.append("\"?>\r\n");
204 sbuf.append("<log4j:eventSet xmlns:log4j=\"http://logging.apache.org/log4j/\">\r\n");
205 return sbuf.toString().getBytes(this.getCharset());
206 }
207
208
209
210
211
212
213 @Override
214 public byte[] getFooter() {
215 if (!complete) {
216 return null;
217 }
218 final StringBuilder sbuf = new StringBuilder();
219 sbuf.append("</log4j:eventSet>\r\n");
220 return sbuf.toString().getBytes(getCharset());
221 }
222
223
224
225
226
227
228
229 @Override
230 public Map<String, String> getContentFormat() {
231 Map<String, String> result = new HashMap<String, String>();
232 result.put("dtd", "log4j.dtd");
233 result.put("version", "1.2");
234 return result;
235 }
236
237 @Override
238
239
240
241 public String getContentType() {
242 return "text/xml; charset=" + this.getCharset();
243 }
244
245 List<String> getThrowableString(final Throwable throwable) {
246 final StringWriter sw = new StringWriter();
247 final PrintWriter pw = new PrintWriter(sw);
248 try {
249 throwable.printStackTrace(pw);
250 } catch (final RuntimeException ex) {
251
252 }
253 pw.flush();
254 final LineNumberReader reader = new LineNumberReader(new StringReader(sw.toString()));
255 final ArrayList<String> lines = new ArrayList<String>();
256 try {
257 String line = reader.readLine();
258 while (line != null) {
259 lines.add(line);
260 line = reader.readLine();
261 }
262 } catch (final IOException ex) {
263 if (ex instanceof InterruptedIOException) {
264 Thread.currentThread().interrupt();
265 }
266 lines.add(ex.toString());
267 }
268 return lines;
269 }
270
271
272
273
274
275
276
277
278
279
280 @PluginFactory
281 public static XMLLayout createLayout(@PluginAttr("locationInfo") final String locationInfo,
282 @PluginAttr("properties") final String properties,
283 @PluginAttr("complete") final String complete,
284 @PluginAttr("charset") final String charsetName) {
285 final Charset charset = Charsets.getSupportedCharset(charsetName, Charsets.UTF_8);
286 final boolean info = locationInfo == null ? false : Boolean.valueOf(locationInfo);
287 final boolean props = properties == null ? false : Boolean.valueOf(properties);
288 final boolean comp = complete == null ? false : Boolean.valueOf(complete);
289 return new XMLLayout(info, props, comp, charset);
290 }
291 }