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.UnsupportedEncodingException;
20 import java.nio.charset.Charset;
21 import java.nio.charset.StandardCharsets;
22
23 import org.apache.logging.log4j.core.LogEvent;
24
25
26
27
28
29
30
31
32
33
34
35 public abstract class AbstractStringLayout extends AbstractLayout<String> {
36
37
38
39
40 protected static final int DEFAULT_STRING_BUILDER_SIZE = 1024;
41
42 private final static ThreadLocal<StringBuilder> threadLocal = new ThreadLocal<>();
43
44 private static final long serialVersionUID = 1L;
45
46
47
48
49
50 private final Charset charset;
51 private final String charsetName;
52 private final boolean useCustomEncoding;
53
54 protected AbstractStringLayout(final Charset charset) {
55 this(charset, null, null);
56 }
57
58 protected AbstractStringLayout(final Charset charset, final byte[] header, final byte[] footer) {
59 super(header, footer);
60 this.charset = charset == null ? StandardCharsets.UTF_8 : charset;
61 this.charsetName = this.charset.name();
62 useCustomEncoding = isPreJava8()
63 && (StandardCharsets.ISO_8859_1.equals(charset) || StandardCharsets.US_ASCII.equals(charset));
64 }
65
66
67 private static boolean isPreJava8() {
68 final String version = System.getProperty("java.version");
69 final String[] parts = version.split("\\.");
70 try {
71 int major = Integer.parseInt(parts[1]);
72 return major < 8;
73 } catch (Exception ex) {
74 return true;
75 }
76 }
77
78
79
80
81
82
83
84
85 static byte[] toBytes(final String str, final Charset charset) {
86 if (str != null) {
87 if (StandardCharsets.ISO_8859_1.equals(charset)) {
88 return encodeSingleByteChars(str);
89 }
90 final Charset actual = charset != null ? charset : Charset.defaultCharset();
91 try {
92 return str.getBytes(actual.name());
93 } catch (UnsupportedEncodingException e) {
94 return str.getBytes(actual);
95 }
96 }
97 return null;
98 }
99
100
101
102
103
104
105 protected StringBuilder getStringBuilder() {
106 StringBuilder result = threadLocal.get();
107 if (result == null) {
108 result = new StringBuilder(DEFAULT_STRING_BUILDER_SIZE);
109 threadLocal.set(result);
110 }
111 result.setLength(0);
112 return result;
113 }
114
115 protected byte[] getBytes(final String s) {
116 if (useCustomEncoding) {
117 return encodeSingleByteChars(s);
118 }
119 try {
120 return s.getBytes(charsetName);
121 } catch (UnsupportedEncodingException e) {
122 return s.getBytes(charset);
123 }
124 }
125
126
127
128
129
130
131
132
133 private static byte[] encodeSingleByteChars(String s) {
134 final int length = s.length();
135 final byte[] result = new byte[length];
136 encodeString(s, 0, length, result);
137 return result;
138 }
139
140
141
142
143
144
145 private static int encodeIsoChars(String charArray, int charIndex, byte[] byteArray, int byteIndex, int length) {
146 int i = 0;
147 for (; i < length; i++) {
148 char c = charArray.charAt(charIndex++);
149 if (c > 255) {
150 break;
151 }
152 byteArray[(byteIndex++)] = ((byte) c);
153 }
154 return i;
155 }
156
157
158 private static int encodeString(String charArray, int charOffset, int charLength, byte[] byteArray) {
159 int byteOffset = 0;
160 int length = Math.min(charLength, byteArray.length);
161 int charDoneIndex = charOffset + length;
162 while (charOffset < charDoneIndex) {
163 int done = encodeIsoChars(charArray, charOffset, byteArray, byteOffset, length);
164 charOffset += done;
165 byteOffset += done;
166 if (done != length) {
167 char c = charArray.charAt(charOffset++);
168 if ((Character.isHighSurrogate(c)) && (charOffset < charDoneIndex)
169 && (Character.isLowSurrogate(charArray.charAt(charOffset)))) {
170 if (charLength > byteArray.length) {
171 charDoneIndex++;
172 charLength--;
173 }
174 charOffset++;
175 }
176 byteArray[(byteOffset++)] = '?';
177 length = Math.min(charDoneIndex - charOffset, byteArray.length - byteOffset);
178 }
179 }
180 return byteOffset;
181 }
182
183 protected Charset getCharset() {
184 return charset;
185 }
186
187
188
189
190 @Override
191 public String getContentType() {
192 return "text/plain";
193 }
194
195
196
197
198
199
200
201 @Override
202 public byte[] toByteArray(final LogEvent event) {
203 return getBytes(toSerializable(event));
204 }
205
206 }