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
|
/*******************************************************************************
* Copyright (c) 2000, 2004 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.*;
import java.util.*;
import javax.servlet.*;
import javax.servlet.http.*;
import org.eclipse.core.runtime.*;
import org.eclipse.help.internal.*;
import org.eclipse.help.internal.base.*;
import org.eclipse.help.internal.search.*;
import org.eclipse.help.internal.webapp.*;
import org.eclipse.help.internal.webapp.data.*;
import org.eclipse.help.internal.workingset.*;
/**
* Returns search results. Each hits contains a prameter "resultsof" that is the
* url encoded query string.
*/
public class SearchServlet extends HttpServlet {
private static final long serialVersionUID = 1L;
private String locale;
/**
* Called by the server (via the <code>service</code> method) to allow a
* servlet to handle a GET request.
*/
protected void doGet(HttpServletRequest req, HttpServletResponse resp)
throws ServletException, IOException {
locale = UrlUtil.getLocale(req, resp);
req.setCharacterEncoding("UTF-8"); //$NON-NLS-1$
resp.setContentType("application/xml; charset=UTF-8"); //$NON-NLS-1$
resp.setHeader("Cache-Control", "max-age=0"); //$NON-NLS-1$ //$NON-NLS-2$
SearchHit[] hits = loadSearchResults(req, resp);
ResultsWriter resultsWriter = new ResultsWriter(resp.getWriter());
resultsWriter.generate(hits, resp);
resultsWriter.close();
}
/**
*
* Called by the server (via the <code>service</code> method) to allow a
* servlet to handle a POST request.
*
* Handle the search requests,
*
*/
protected void doPost(HttpServletRequest req, HttpServletResponse resp)
throws ServletException, IOException {
doGet(req, resp);
}
/**
* Call the search engine, and get results or the percentage of indexed
* documents.
*/
private SearchHit[] loadSearchResults(HttpServletRequest request,
HttpServletResponse response) {
SearchHit[] hits = null;
try {
NullProgressMonitor pm = new NullProgressMonitor();
SearchResults results = createHitCollector(request, response);
BaseHelpSystem.getSearchManager().search(
createSearchQuery(request), results, pm);
hits = results.getSearchHits();
} catch (QueryTooComplexException qe) {
hits = new SearchHit[0];
} catch (Exception e) {
HelpWebappPlugin.logError("", e); //$NON-NLS-1$
} finally {
if (hits == null)
hits = new SearchHit[0];
}
return hits;
}
private ISearchQuery createSearchQuery(HttpServletRequest request) {
String searchWord = request.getParameter("searchWord"); //$NON-NLS-1$
String fieldSearchStr = request.getParameter("fieldSearch"); //$NON-NLS-1$
boolean fieldSearch = fieldSearchStr != null ? new Boolean(
fieldSearchStr).booleanValue() : false;
return new SearchQuery(searchWord, fieldSearch, new ArrayList(), locale);
}
private SearchResults createHitCollector(HttpServletRequest request,
HttpServletResponse response) {
WorkingSet[] workingSets;
if (request.getParameterValues("scopedSearch") == null) { //$NON-NLS-1$
// scopes are working set names
workingSets = getWorkingSets(request, response);
} else {
// scopes are books (advanced search)
workingSets = createTempWorkingSets(request, response);
}
int maxHits = 500;
String maxHitsStr = request.getParameter("maxHits"); //$NON-NLS-1$
if (maxHitsStr != null) {
try {
int clientmaxHits = Integer.parseInt(maxHitsStr);
if (0 < clientmaxHits && clientmaxHits < 500) {
maxHits = clientmaxHits;
}
} catch (NumberFormatException nfe) {
}
}
return new SearchResults(workingSets, maxHits, locale);
}
/**
* @return WorkingSet[] or null
*/
private WorkingSet[] getWorkingSets(HttpServletRequest request,
HttpServletResponse response) {
String[] scopes = request.getParameterValues("scope"); //$NON-NLS-1$
if (scopes == null) {
return null;
}
// confirm working set exists and use it
WebappWorkingSetManager wsmgr = new WebappWorkingSetManager(request,
response, locale);
ArrayList workingSetCol = new ArrayList(scopes.length);
for (int s = 0; s < scopes.length; s++) {
WorkingSet ws = wsmgr.getWorkingSet(scopes[s]);
if (ws != null) {
workingSetCol.add(ws);
}
}
if (workingSetCol.size() == 0) {
return null;
}
return (WorkingSet[]) workingSetCol
.toArray(new WorkingSet[workingSetCol.size()]);
}
/**
* @return WorkingSet[] or null
*/
private WorkingSet[] createTempWorkingSets(HttpServletRequest request,
HttpServletResponse response) {
String[] scopes = request.getParameterValues("scope"); //$NON-NLS-1$
if (scopes == null) {
// it is possible that filtering is used, but all books are
// deselected
return new WorkingSet[0];
}
if (scopes.length == HelpPlugin.getTocManager().getTocs(locale).length) {
// do not filter if all books are selected
return null;
}
// create working set from books
WebappWorkingSetManager wsmgr = new WebappWorkingSetManager(request,
response, locale);
ArrayList tocs = new ArrayList(scopes.length);
for (int s = 0; s < scopes.length; s++) {
AdaptableToc toc = wsmgr.getAdaptableToc(scopes[s]);
if (toc != null) {
tocs.add(toc);
}
}
AdaptableToc[] adaptableTocs = (AdaptableToc[]) tocs
.toArray(new AdaptableToc[tocs.size()]);
WorkingSet[] workingSets = new WorkingSet[1];
workingSets[0] = wsmgr.createWorkingSet("temp", adaptableTocs); //$NON-NLS-1$
return workingSets;
}
/**
* This generates the XML file for the help navigation.
*/
private static class ResultsWriter extends XMLGenerator {
/**
* @param writer
* java.io.Writer
*/
public ResultsWriter(Writer writer) {
super(writer);
}
/**
* XML representation of search results. <pre> < hits>
* <topic label=".." score="..." toc=".." toclabel=".."/> .....
*/
public void generate(SearchHit[] hits, HttpServletResponse resp) {
println("<hits length=\"" + hits.length + "\">"); //$NON-NLS-1$ //$NON-NLS-2$
pad++;
for (int i = 0; i < hits.length; i++) {
printPad();
print("<topic label=\"" //$NON-NLS-1$
+ xmlEscape(hits[i].getLabel()) + "\"" //$NON-NLS-1$
+ " href=\"" //$NON-NLS-1$
+ hits[i].getHref() + "\"" //$NON-NLS-1$
+ " score=\"" //$NON-NLS-1$
+ Float.toString(hits[i].getScore()) + "\""); //$NON-NLS-1$
if (hits[i].getToc() != null) {
print(" toc=\"" //$NON-NLS-1$
+ hits[i].getToc().getHref() + "\"" //$NON-NLS-1$
+ " toclabel=\"" //$NON-NLS-1$
+ hits[i].getToc().getLabel() + "\""); //$NON-NLS-1$
}
print(" />"); //$NON-NLS-1$
}
pad--;
println("</hits>"); //$NON-NLS-1$
}
}
}
|
