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