1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
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
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
|
/*******************************************************************************
* Copyright (c) 2000, 2006 IBM Corporation and others.
* All rights reserved. This program and the accompanying materials
* are made available under the terms of the Eclipse Public License v1.0
* which accompanies this distribution, and is available at
* http://www.eclipse.org/legal/epl-v10.html
*
* Contributors:
* IBM Corporation - initial API and implementation
*******************************************************************************/
package org.eclipse.help.internal.webapp.servlet;
import java.io.BufferedInputStream;
import java.io.ByteArrayInputStream;
import java.io.IOException;
import java.io.InputStream;
import java.io.OutputStream;
import java.io.PrintWriter;
import java.io.StringWriter;
import java.io.Writer;
import java.lang.reflect.UndeclaredThrowableException;
import java.net.URL;
import java.net.URLConnection;
import java.util.Enumeration;
import java.util.Locale;
import javax.servlet.ServletContext;
import javax.servlet.http.HttpServletRequest;
import javax.servlet.http.HttpServletResponse;
import org.eclipse.help.internal.base.BaseHelpSystem;
import org.eclipse.help.internal.protocols.HelpURLStreamHandler;
import org.eclipse.help.internal.webapp.HelpWebappPlugin;
import org.eclipse.help.internal.webapp.data.ServletResources;
import org.eclipse.help.internal.webapp.data.UrlUtil;
/**
* Performs transfer of data from eclipse to a jsp/servlet
*/
public class EclipseConnector {
private static final String errorPageBegin = "<!DOCTYPE HTML PUBLIC \"-//W3C//DTD HTML 4.0 Transitional//EN\">\n" //$NON-NLS-1$
+ "<html><head>\n" //$NON-NLS-1$
+ "<meta http-equiv=\"Content-Type\" content=\"text/html; charset=UTF-8\">\n" //$NON-NLS-1$
+ "</head>\n" //$NON-NLS-1$
+ "<body><p>\n"; //$NON-NLS-1$
private static final String errorPageEnd = "</p></body></html>"; //$NON-NLS-1$
private static final IFilter filters[] = new IFilter[]{
new HighlightFilter(), new FramesetFilter(), new InjectionFilter(), new DynamicXHTMLFilter(), new BreadcrumbsFilter() };
public EclipseConnector(ServletContext context) {
}
public void transfer(HttpServletRequest req, HttpServletResponse resp)
throws IOException {
try {
String url = getURL(req);
if (url == null)
return;
if (url.toLowerCase(Locale.ENGLISH).startsWith("file:") //$NON-NLS-1$
|| url.toLowerCase(Locale.ENGLISH).startsWith("jar:") //$NON-NLS-1$
|| url.toLowerCase(Locale.ENGLISH).startsWith("platform:")) { //$NON-NLS-1$
int i = url.indexOf('?');
if (i != -1)
url = url.substring(0, i);
// ensure the file is only accessed from a local installation
if (BaseHelpSystem.getMode() == BaseHelpSystem.MODE_INFOCENTER
|| !UrlUtil.isLocalRequest(req)) {
return;
}
} else {
// enable activities matching url
// HelpBasePlugin.getActivitySupport().enableActivities(url);
url = "help:" + url; //$NON-NLS-1$
}
URLConnection con = openConnection(url, req, resp);
resp.setContentType(con.getContentType());
long maxAge = 0;
try {
// getExpiration() throws NullPointerException when URL is
// jar:file:...
long expiration = con.getExpiration();
maxAge = (expiration - System.currentTimeMillis()) / 1000;
if (maxAge < 0)
maxAge = 0;
} catch (Exception e) {
}
resp.setHeader("Cache-Control", "max-age=" + maxAge); //$NON-NLS-1$ //$NON-NLS-2$
InputStream is;
try {
is = con.getInputStream();
} catch (IOException ioe) {
if (url.toLowerCase(Locale.ENGLISH).endsWith("htm") //$NON-NLS-1$
|| url.toLowerCase(Locale.ENGLISH).endsWith("html")) { //$NON-NLS-1$
String error = errorPageBegin
+ ServletResources.getString("noTopic", req) //$NON-NLS-1$
+ errorPageEnd;
is = new ByteArrayInputStream(error.getBytes("UTF8")); //$NON-NLS-1$
} else {
return;
}
}
catch (Exception e) {
// if it's a wrapped exception, unwrap it
Throwable t = e;
if (t instanceof UndeclaredThrowableException && t.getCause() != null) {
t = t.getCause();
}
StringBuffer message = new StringBuffer();
message.append(errorPageBegin);
message.append("<p>"); //$NON-NLS-1$
message.append(ServletResources.getString(
"contentProducerException", //$NON-NLS-1$
req));
message.append("</p>"); //$NON-NLS-1$
message.append("<pre>"); //$NON-NLS-1$
Writer writer = new StringWriter();
t.printStackTrace(new PrintWriter(writer));
message.append(writer.toString());
message.append("</pre>"); //$NON-NLS-1$
message.append(errorPageEnd);
is = new ByteArrayInputStream(message.toString().getBytes("UTF8")); //$NON-NLS-1$
}
OutputStream out = resp.getOutputStream();
for (int i = 0; i < filters.length; i++) {
out = filters[i].filter(req, out);
}
transferContent(is, out);
out.close();
is.close();
} catch (Exception e) {
String msg = "Error processing help request " + getURL(req); //$NON-NLS-1$
HelpWebappPlugin.logError(msg, e);
}
}
/**
* Write the body to the response
*/
private void transferContent(InputStream inputStream, OutputStream out)
throws IOException {
try {
// Prepare the input stream for reading
BufferedInputStream dataStream = new BufferedInputStream(
inputStream);
// Create a fixed sized buffer for reading.
// We could create one with the size of availabe data...
byte[] buffer = new byte[4096];
int len = 0;
while (true) {
len = dataStream.read(buffer); // Read file into the byte array
if (len == -1)
break;
out.write(buffer, 0, len);
}
} catch (Exception e) {
}
}
/**
* Gets content from the named url (this could be and eclipse defined url)
*/
private URLConnection openConnection(String url,
HttpServletRequest request, HttpServletResponse response)
throws Exception {
URLConnection con = null;
if (BaseHelpSystem.getMode() == BaseHelpSystem.MODE_INFOCENTER) {
// it is an infocentre, add client locale to url
String locale = UrlUtil.getLocale(request, response);
if (url.indexOf('?') >= 0) {
url = url + "&lang=" + locale; //$NON-NLS-1$
} else {
url = url + "?lang=" + locale; //$NON-NLS-1$
}
}
URL helpURL;
if (url.startsWith("help:")) { //$NON-NLS-1$
helpURL = new URL("help", //$NON-NLS-1$
null, -1, url.substring("help:".length()), //$NON-NLS-1$
HelpURLStreamHandler.getDefault());
} else {
if (url.startsWith("jar:")) { //$NON-NLS-1$
// fix for bug 83929
int excl = url.indexOf("!/"); //$NON-NLS-1$
String jar = url.substring(0, excl);
String path = url.length() > excl + 2 ? url.substring(excl + 2)
: ""; //$NON-NLS-1$
url = jar.replaceAll("!", "%21") + "!/" //$NON-NLS-1$ //$NON-NLS-2$ //$NON-NLS-3$
+ path.replaceAll("!", "%21"); //$NON-NLS-1$ //$NON-NLS-2$
}
helpURL = new URL(url);
}
String protocol = helpURL.getProtocol();
if (!("help".equals(protocol) //$NON-NLS-1$
|| "file".equals(protocol) //$NON-NLS-1$
|| "platform".equals(protocol) //$NON-NLS-1$
|| "jar".equals(protocol))) { //$NON-NLS-1$
throw new IOException();
}
con = helpURL.openConnection();
con.setAllowUserInteraction(false);
con.setDoInput(true);
con.connect();
return con;
}
/**
* Extracts the url from a request
*/
private String getURL(HttpServletRequest req) {
String query = ""; //$NON-NLS-1$
boolean firstParam = true;
for (Enumeration params = req.getParameterNames(); params
.hasMoreElements();) {
String param = (String) params.nextElement();
String[] values = req.getParameterValues(param);
if (values == null)
continue;
for (int i = 0; i < values.length; i++) {
if (firstParam) {
query += "?" + param + "=" + values[i]; //$NON-NLS-1$ //$NON-NLS-2$
firstParam = false;
} else
query += "&" + param + "=" + values[i]; //$NON-NLS-1$ //$NON-NLS-2$
}
}
// the request contains the eclipse url help: or search:
String url = req.getPathInfo() + query;
if (url.startsWith("/")) //$NON-NLS-1$
url = url.substring(1);
return url;
}
}
|
