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
|
/*******************************************************************************
* Copyright (c) 2008, 2017 IBM Corporation and others.
*
* This program and the accompanying materials
* are made available under the terms of the Eclipse Public License 2.0
* which accompanies this distribution, and is available at
* https://www.eclipse.org/legal/epl-2.0/
*
* SPDX-License-Identifier: EPL-2.0
*
* Contributors:
* IBM Corporation - initial API and implementation
*******************************************************************************/
package org.eclipse.help.internal.webapp.servlet;
import java.io.IOException;
import java.util.ArrayList;
import java.util.Collections;
import java.util.Comparator;
import java.util.List;
import java.util.Locale;
import javax.servlet.ServletException;
import javax.servlet.http.HttpServlet;
import javax.servlet.http.HttpServletRequest;
import javax.servlet.http.HttpServletResponse;
import org.eclipse.core.runtime.Platform;
import org.eclipse.help.internal.webapp.HelpWebappPlugin;
import org.eclipse.help.internal.webapp.WebappResources;
import org.eclipse.help.internal.webapp.data.UrlUtil;
import org.osgi.framework.Bundle;
import org.osgi.framework.Constants;
import com.ibm.icu.text.Collator;
/**
* A servlet that provides an informational page about the plugins that make up
* the web application.
*/
public class AboutServlet extends HttpServlet {
protected static final int NUMBER_OF_COLUMNS = 4;
protected Locale locale;
protected class PluginDetails {
public String[] columns = new String[NUMBER_OF_COLUMNS];
public PluginDetails(String[] columns) {
this.columns = columns;
for (int i = 0; i < NUMBER_OF_COLUMNS; i++) {
if (columns[i] == null) {
columns[i] = ""; //$NON-NLS-1$
}
}
}
}
protected class PluginComparator implements Comparator<PluginDetails> {
public PluginComparator(int column) {
this.column = column;
}
private int column;
@Override
public int compare(PluginDetails pd1, PluginDetails pd2) {
return Collator.getInstance().compare(pd1.columns[column], pd2.columns[column]);
}
}
public AboutServlet() {
}
/**
*
*/
private static final long serialVersionUID = -1426745453574711075L;
private static final String XHTML_1 = "<!DOCTYPE html PUBLIC \"-//W3C//DTD XHTML 1.0 Strict//EN\" \"http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd\">\n<html xmlns=\"http://www.w3.org/1999/xhtml\">\n<head>\n<title>"; //$NON-NLS-1$
private static final String XHTML_2 = "</title>\n <style type = \"text/css\"> td { padding-right : 10px; }</style></head>\n<body>\n"; //$NON-NLS-1$
private static final String XHTML_3 = "</body>\n</html>"; //$NON-NLS-1$
@Override
protected void doGet(HttpServletRequest req, HttpServletResponse resp) throws ServletException, IOException {
req.setCharacterEncoding("UTF-8"); //$NON-NLS-1$
resp.setContentType("text/html; charset=UTF-8"); //$NON-NLS-1$
locale = UrlUtil.getLocaleObj(req, resp);
StringBuilder buf = new StringBuilder();
buf.append(XHTML_1);
String showParam = req.getParameter("show"); //$NON-NLS-1$
if ("agent".equalsIgnoreCase(showParam)) { //$NON-NLS-1$
getAgent(req, resp);
return;
}
if ("preferences".equalsIgnoreCase(showParam)) { //$NON-NLS-1$
getPreferences(resp);
return;
}
String sortParam = req.getParameter("sortColumn"); //$NON-NLS-1$
int sortColumn = 3;
if (sortParam != null) {
try {
sortColumn = Integer.parseInt(sortParam);
} catch (NumberFormatException e) {
}
}
String title = WebappResources.getString("aboutPlugins", locale); //$NON-NLS-1$
buf.append(UrlUtil.htmlEncode(title));
buf.append(XHTML_2);
String app = System.getProperty("eclipse.application", null); //$NON-NLS-1$
String build = System.getProperty("eclipse.buildId", null); //$NON-NLS-1$
if (app != null || build != null) {
buf.append("<p>"); //$NON-NLS-1$
if (app != null)
buf.append(WebappResources.getString("application", locale, app) + "<br/>");//$NON-NLS-1$ //$NON-NLS-2$
if (build != null)
buf.append(WebappResources.getString("buildId", locale, build) + "<br/>");//$NON-NLS-1$ //$NON-NLS-2$
buf.append("</p>"); //$NON-NLS-1$
}
buf.append("<table>"); //$NON-NLS-1$
List<PluginDetails> plugins = new ArrayList<>();
Bundle[] bundles = HelpWebappPlugin.getContext().getBundles();
for (Bundle bundle : bundles) {
plugins.add(pluginDetails(bundle));
}
Comparator<PluginDetails> pluginComparator = new PluginComparator(sortColumn);
Collections.sort(plugins, pluginComparator);
String[] headerColumns = new String[] {WebappResources.getString("provider", locale), //$NON-NLS-1$
WebappResources.getString("pluginName", locale), //$NON-NLS-1$
WebappResources.getString("version", locale), //$NON-NLS-1$
WebappResources.getString("pluginId", locale) //$NON-NLS-1$
};
PluginDetails header = new PluginDetails(headerColumns);
buf.append(headerRowFor(header));
for (PluginDetails details : plugins) {
buf.append(tableRowFor(details));
}
buf.append("</table>"); //$NON-NLS-1$
buf.append(XHTML_3);
String response = buf.toString();
resp.getWriter().write(response);
}
private void getPreferences(HttpServletResponse resp) throws IOException {
StringBuffer buf = new StringBuffer();
buf.append(XHTML_1);
String title = WebappResources.getString("preferences", locale); //$NON-NLS-1$
buf.append(UrlUtil.htmlEncode(title));
buf.append(XHTML_2);
buf.append("<h1>"); //$NON-NLS-1$
buf.append(title);
buf.append("</h1>"); //$NON-NLS-1$
PreferenceWriter writer = new PreferenceWriter(buf, locale);
writer.writePreferences();
buf.append(XHTML_3);
String response = buf.toString();
resp.getWriter().write(response);
}
private void getAgent(HttpServletRequest req, HttpServletResponse resp) throws IOException {
StringBuilder buf = new StringBuilder();
buf.append(XHTML_1);
String title = WebappResources.getString("userAgent", locale); //$NON-NLS-1$
buf.append(UrlUtil.htmlEncode(title));
buf.append(XHTML_2);
buf.append("<h1>"); //$NON-NLS-1$
buf.append(title);
buf.append("</h1>"); //$NON-NLS-1$
String agent = req.getHeader("User-Agent"); //$NON-NLS-1$
buf.append(UrlUtil.htmlEncode(agent));
buf.append(XHTML_3);
String response = buf.toString();
resp.getWriter().write(response);
}
private String headerRowFor(PluginDetails details) {
String row = "<tr>\n"; //$NON-NLS-1$
for (int i = 0; i < NUMBER_OF_COLUMNS; i++) {
row += ("<td><a href = \"about.html?sortColumn="); //$NON-NLS-1$
row += i;
row += "\">"; //$NON-NLS-1$
row += UrlUtil.htmlEncode(details.columns[i]);
row += "</a></td>\n"; //$NON-NLS-1$
}
row += "</tr>"; //$NON-NLS-1$
return row;
}
private String tableRowFor(PluginDetails details) {
String row = "<tr>\n"; //$NON-NLS-1$
for (int i = 0; i < NUMBER_OF_COLUMNS; i++) {
row += ("<td>"); //$NON-NLS-1$
row += UrlUtil.htmlEncode(details.columns[i]);
row += "</td>\n"; //$NON-NLS-1$
}
row += "</tr>"; //$NON-NLS-1$
return row;
}
protected PluginDetails pluginDetails(Bundle bundle) {
String[] values = new String[] {getResourceString(bundle, Constants.BUNDLE_VENDOR), getResourceString(bundle, Constants.BUNDLE_NAME), getResourceString(bundle, Constants.BUNDLE_VERSION), bundle.getSymbolicName()};
PluginDetails details = new PluginDetails(values);
return details;
}
private static String getResourceString(Bundle bundle, String headerName) {
String value = bundle.getHeaders().get(headerName);
return value == null ? null : Platform.getResourceString(bundle, value);
}
}
|
