1
2
3
4
5
6
7
8
9
10
11
12
13
14
15 package org.htmlunit.util;
16
17 import static java.nio.charset.StandardCharsets.ISO_8859_1;
18
19 import java.io.BufferedWriter;
20 import java.io.EOFException;
21 import java.io.File;
22 import java.io.IOException;
23 import java.io.InputStream;
24 import java.io.OutputStream;
25 import java.net.URL;
26 import java.nio.charset.StandardCharsets;
27 import java.nio.file.Files;
28 import java.nio.file.StandardOpenOption;
29 import java.util.ArrayList;
30 import java.util.List;
31 import java.util.regex.Pattern;
32
33 import org.apache.commons.io.FileUtils;
34 import org.apache.commons.io.IOUtils;
35 import org.apache.commons.lang3.StringUtils;
36 import org.apache.commons.logging.Log;
37 import org.apache.commons.logging.LogFactory;
38 import org.htmlunit.FormEncodingType;
39 import org.htmlunit.HttpMethod;
40 import org.htmlunit.WebConnection;
41 import org.htmlunit.WebRequest;
42 import org.htmlunit.WebResponse;
43 import org.htmlunit.WebResponseData;
44 import org.htmlunit.javascript.JavaScriptEngine;
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68 public class DebuggingWebConnection extends WebConnectionWrapper {
69 private static final Log LOG = LogFactory.getLog(DebuggingWebConnection.class);
70
71 private static final Pattern ESCAPE_QUOTE_PATTERN = Pattern.compile("'");
72
73 private int counter_;
74 private final WebConnection wrappedWebConnection_;
75 private final File javaScriptFile_;
76 private final File reportFolder_;
77 private boolean uncompressJavaScript_ = true;
78
79
80
81
82
83
84
85
86
87 public DebuggingWebConnection(final WebConnection webConnection,
88 final String dirName) throws IOException {
89
90 super(webConnection);
91
92 wrappedWebConnection_ = webConnection;
93 final File tmpDir = new File(System.getProperty("java.io.tmpdir"));
94 reportFolder_ = new File(tmpDir, dirName);
95 if (reportFolder_.exists()) {
96 FileUtils.forceDelete(reportFolder_);
97 }
98 FileUtils.forceMkdir(reportFolder_);
99 javaScriptFile_ = new File(reportFolder_, "hu.js");
100 createOverview();
101 }
102
103
104
105
106
107 @Override
108 public WebResponse getResponse(final WebRequest request) throws IOException {
109 WebResponse response = wrappedWebConnection_.getResponse(request);
110 if (isUncompressJavaScript() && isJavaScript(response.getContentType())) {
111 response = uncompressJavaScript(response);
112 }
113 saveResponse(response, request);
114 return response;
115 }
116
117
118
119
120
121
122
123 protected WebResponse uncompressJavaScript(final WebResponse response) {
124 final WebRequest request = response.getWebRequest();
125 final String scriptName = request.getUrl().toString();
126 final String scriptSource = response.getContentAsString();
127
128
129
130 try {
131 final String decompileScript = JavaScriptEngine.uncompressJavaScript(scriptSource, scriptName);
132
133 final List<NameValuePair> responseHeaders = new ArrayList<>(response.getResponseHeaders());
134 for (int i = responseHeaders.size() - 1; i >= 0; i--) {
135 if ("content-encoding".equalsIgnoreCase(responseHeaders.get(i).getName())) {
136 responseHeaders.remove(i);
137 }
138 }
139 final WebResponseData wrd = new WebResponseData(decompileScript.getBytes(), response.getStatusCode(),
140 response.getStatusMessage(), responseHeaders);
141 return new WebResponse(wrd, response.getWebRequest().getUrl(),
142 response.getWebRequest().getHttpMethod(), response.getLoadTime());
143 }
144 catch (final Exception e) {
145 LOG.warn("Failed to decompress JavaScript response. Delivering as it.", e);
146 }
147
148 return response;
149 }
150
151
152
153
154
155
156
157 public void addMark(final String mark) throws IOException {
158 final String escapedMark = mark == null ? null : mark.replace("\"", "\\\"");
159 appendToJSFile("tab[tab.length] = \"" + escapedMark + "\";\n");
160 if (LOG.isInfoEnabled()) {
161 LOG.info("--- " + escapedMark + " ---");
162 }
163 }
164
165
166
167
168
169
170
171
172 protected void saveResponse(final WebResponse response, final WebRequest request)
173 throws IOException {
174 counter_++;
175 final String extension = chooseExtension(response.getContentType());
176 final File file = createFile(request.getUrl(), extension);
177 int length = 0;
178 try (InputStream input = response.getContentAsStream()) {
179 try (OutputStream fos = Files.newOutputStream(file.toPath())) {
180 length = IOUtils.copy(input, fos);
181 }
182 catch (final EOFException ignored) {
183
184 }
185 }
186
187 final URL url = response.getWebRequest().getUrl();
188 if (LOG.isInfoEnabled()) {
189 LOG.info("Created file " + file.getAbsolutePath() + " for response " + counter_ + ": " + url);
190 }
191
192 final StringBuilder bduiler = new StringBuilder();
193 bduiler.append("tab[tab.length] = {code: ").append(response.getStatusCode())
194 .append(", fileName: '").append(file.getName()).append("', ")
195 .append("contentType: '").append(response.getContentType())
196 .append("', method: '").append(request.getHttpMethod().name()).append("', ");
197 if (request.getHttpMethod() == HttpMethod.POST && request.getEncodingType() == FormEncodingType.URL_ENCODED) {
198 bduiler.append("postParameters: ").append(nameValueListToJsMap(request.getRequestParameters()))
199 .append(", ");
200 }
201 bduiler.append("url: '").append(escapeJSString(url.toString()))
202 .append("', loadTime: ").append(response.getLoadTime())
203 .append(", responseSize: ").append(length)
204 .append(", responseHeaders: ").append(nameValueListToJsMap(response.getResponseHeaders()))
205 .append("};\n");
206 appendToJSFile(bduiler.toString());
207 }
208
209 static String escapeJSString(final String string) {
210 return ESCAPE_QUOTE_PATTERN.matcher(string).replaceAll("\\\\'");
211 }
212
213 static String chooseExtension(final String contentType) {
214 if (isJavaScript(contentType)) {
215 return ".js";
216 }
217 else if (MimeType.TEXT_HTML.equals(contentType)) {
218 return ".html";
219 }
220 else if (MimeType.TEXT_CSS.equals(contentType)) {
221 return ".css";
222 }
223 else if (MimeType.TEXT_XML.equals(contentType)) {
224 return ".xml";
225 }
226 else if (MimeType.IMAGE_GIF.equals(contentType)) {
227 return ".gif";
228 }
229 return ".txt";
230 }
231
232
233
234
235
236
237
238 static boolean isJavaScript(final String contentType) {
239 return contentType.contains("javascript") || contentType.contains("ecmascript")
240 || (contentType.startsWith("text/") && contentType.endsWith("js"));
241 }
242
243
244
245
246
247
248 public boolean isUncompressJavaScript() {
249 return uncompressJavaScript_;
250 }
251
252
253
254
255
256
257
258
259 public void setUncompressJavaScript(final boolean decompress) {
260 uncompressJavaScript_ = decompress;
261 }
262
263 private void appendToJSFile(final String str) throws IOException {
264 try (BufferedWriter jsFileWriter = Files.newBufferedWriter(javaScriptFile_.toPath(),
265 StandardCharsets.UTF_8, StandardOpenOption.APPEND)) {
266 jsFileWriter.write(str);
267 }
268 }
269
270
271
272
273
274
275
276
277
278 private File createFile(final URL url, final String extension) throws IOException {
279 String name = url.getPath().replaceFirst("/$", "").replaceAll(".*/", "");
280 name = org.htmlunit.util.StringUtils.substringBefore(name, "?");
281 name = org.htmlunit.util.StringUtils.substringBefore(name, ";");
282 name = StringUtils.substring(name, 0, 30);
283 name = org.htmlunit.util.StringUtils.sanitizeForFileName(name);
284 if (!name.endsWith(extension)) {
285 name += extension;
286 }
287 int counter = 0;
288 while (true) {
289 final String fileName;
290 if (counter != 0) {
291 fileName = StringUtils.substringBeforeLast(name, ".")
292 + "_" + counter + "." + StringUtils.substringAfterLast(name, ".");
293 }
294 else {
295 fileName = name;
296 }
297 final File f = new File(reportFolder_, fileName);
298 if (f.createNewFile()) {
299 return f;
300 }
301 counter++;
302 }
303 }
304
305
306
307
308
309
310
311
312 static String nameValueListToJsMap(final List<NameValuePair> headers) {
313 if (headers == null || headers.isEmpty()) {
314 return "{}";
315 }
316 final StringBuilder bduiler = new StringBuilder("{");
317 for (final NameValuePair header : headers) {
318 bduiler.append('\'').append(header.getName()).append("': '")
319 .append(escapeJSString(header.getValue())).append("', ");
320 }
321 bduiler.delete(bduiler.length() - 2, bduiler.length());
322 bduiler.append('}');
323 return bduiler.toString();
324 }
325
326
327
328
329
330
331 private void createOverview() throws IOException {
332 FileUtils.writeStringToFile(javaScriptFile_, "var tab = [];\n", ISO_8859_1);
333
334 final URL indexResource = DebuggingWebConnection.class.getResource("DebuggingWebConnection.index.html");
335 if (indexResource == null) {
336 throw new RuntimeException("Missing dependency DebuggingWebConnection.index.html");
337 }
338 final File summary = new File(reportFolder_, "index.html");
339 FileUtils.copyURLToFile(indexResource, summary);
340
341 if (LOG.isInfoEnabled()) {
342 LOG.info("Summary will be in " + summary.getAbsolutePath());
343 }
344 }
345
346 File getReportFolder() {
347 return reportFolder_;
348 }
349 }