source: main/trunk/greenstone3/src/java/org/greenstone/gsdl3/core/URLFilter.java@ 29555

Last change on this file since 29555 was 29555, checked in by kjdon, 9 years ago

removed hard coded search parameters - it should just use service defaults
  • Property svn:executable set to *
File size: 14.5 KB
Line 
1package org.greenstone.gsdl3.core;
2
3import java.io.File;
4import java.io.IOException;
5import java.util.ArrayList;
6import java.util.HashMap;
7import java.util.Map;
8
9import javax.servlet.Filter;
10import javax.servlet.FilterChain;
11import javax.servlet.FilterConfig;
12import javax.servlet.ServletException;
13import javax.servlet.ServletOutputStream;
14import javax.servlet.ServletRequest;
15import javax.servlet.ServletResponse;
16import javax.servlet.http.HttpServletRequest;
17import javax.servlet.http.HttpServletRequestWrapper;
18
19import org.apache.commons.io.FileUtils;
20import org.apache.log4j.Logger;
21import org.greenstone.gsdl3.util.GSParams;
22import org.greenstone.gsdl3.util.GSXML;
23import org.greenstone.gsdl3.util.UserContext;
24import org.greenstone.gsdl3.util.XMLConverter;
25import org.w3c.dom.Document;
26import org.w3c.dom.Element;
27import org.w3c.dom.NodeList;
28
29public class URLFilter implements Filter
30{
31 private FilterConfig _filterConfig = null;
32 private static Logger _logger = Logger.getLogger(org.greenstone.gsdl3.core.URLFilter.class.getName());
33
34 //Restricted URLs
35 protected static final String SITECONFIG_URL = "sites/[^/]+/siteConfig.xml";
36 protected static final String USERS_DB_URL = "etc/usersDB/.*";
37 protected static final ArrayList<String> _restrictedURLs;
38 static
39 {
40 ArrayList<String> restrictedURLs = new ArrayList<String>();
41 restrictedURLs.add(SITECONFIG_URL);
42 restrictedURLs.add(USERS_DB_URL);
43 _restrictedURLs = restrictedURLs;
44 }
45
46 //Constants
47 protected static final String DOCUMENT_PATH = "document";
48 protected static final String COLLECTION_PATH = "collection";
49 protected static final String PAGE_PATH = "page";
50 protected static final String SYSTEM_PATH = "system";
51
52 protected static final String METADATA_RETRIEVAL_SERVICE = "DocumentMetadataRetrieve";
53 protected static final String ASSOCIATED_FILE_PATH = "/index/assoc/";
54 protected static final String COLLECTION_FILE_PATH = "/collect/";
55 protected static final String INTERFACE_PATH = "/interfaces/";
56
57 protected static final String SYSTEM_SUBACTION_CONFIGURE = "configure";
58 protected static final String SYSTEM_SUBACTION_RECONFIGURE = "reconfigure";
59 protected static final String SYSTEM_SUBACTION_ACTIVATE = "activate";
60 protected static final String SYSTEM_SUBACTION_DEACTIVATE = "deactivate";
61
62 public void init(FilterConfig filterConfig) throws ServletException
63 {
64 this._filterConfig = filterConfig;
65 }
66
67 public void destroy()
68 {
69 this._filterConfig = null;
70 }
71
72 public void doFilter(ServletRequest request, ServletResponse response, FilterChain chain) throws IOException, ServletException
73 {
74 if (request instanceof HttpServletRequest)
75 {
76 HttpServletRequest hRequest = ((HttpServletRequest) request);
77 GSHttpServletRequestWrapper gRequest = new GSHttpServletRequestWrapper(hRequest);
78
79 String url = hRequest.getRequestURI().toString();
80
81 if (isURLRestricted(url))
82 {
83 response.getWriter().println("Access to this page is forbidden.");
84 return;
85 }
86
87 //If the user is trying to access a collection file we need to run a security check
88 if (url.contains(ASSOCIATED_FILE_PATH))
89 {
90 String dir = null;
91 int dirStart = url.indexOf(ASSOCIATED_FILE_PATH) + ASSOCIATED_FILE_PATH.length();
92 int dirEnd = -1;
93 if (dirStart < url.length() && url.indexOf("/", dirStart) != -1)
94 {
95 dirEnd = url.indexOf("/", dirStart);
96 }
97 if (dirEnd != -1)
98 {
99 dir = url.substring(dirStart, dirEnd);
100 }
101 if (dir == null)
102 {
103 return;
104 }
105
106 String collection = null;
107 int colStart = url.indexOf(COLLECTION_FILE_PATH) + COLLECTION_FILE_PATH.length();
108 int colEnd = -1;
109 if (colStart < url.length() && url.indexOf("/", colStart) != -1)
110 {
111 colEnd = url.indexOf("/", colStart);
112 }
113 if (colEnd != -1)
114 {
115 collection = url.substring(colStart, colEnd);
116 }
117 if (collection == null)
118 {
119 return;
120 }
121
122 MessageRouter gsRouter = (MessageRouter) request.getServletContext().getAttribute("GSRouter");
123 if (gsRouter == null)
124 {
125 _logger.error("Receptionist is null, stopping filter");
126 return;
127 }
128
129 Document gsDoc = XMLConverter.newDOM();
130
131 Element metaMessage = gsDoc.createElement(GSXML.MESSAGE_ELEM);
132 Element metaRequest = GSXML.createBasicRequest(gsDoc, GSXML.REQUEST_TYPE_PROCESS, collection + "/" + METADATA_RETRIEVAL_SERVICE, new UserContext());
133 metaMessage.appendChild(metaRequest);
134
135 Element paramList = gsDoc.createElement(GSXML.PARAM_ELEM + GSXML.LIST_MODIFIER);
136 metaRequest.appendChild(paramList);
137
138 Element param = gsDoc.createElement(GSXML.PARAM_ELEM);
139 paramList.appendChild(param);
140
141 param.setAttribute(GSXML.NAME_ATT, "metadata");
142 param.setAttribute(GSXML.VALUE_ATT, "contains");
143
144 Element docList = gsDoc.createElement(GSXML.DOC_NODE_ELEM + GSXML.LIST_MODIFIER);
145 metaRequest.appendChild(docList);
146
147 Element doc = gsDoc.createElement(GSXML.DOC_NODE_ELEM);
148 docList.appendChild(doc);
149
150 doc.setAttribute(GSXML.NODE_ID_ATT, dir);
151
152 Element metaResponse = (Element) gsRouter.process(metaMessage);
153
154 NodeList metadataList = metaResponse.getElementsByTagName(GSXML.METADATA_ELEM);
155 if (metadataList.getLength() == 0)
156 {
157 _logger.error("Could not find the document related to this url");
158 }
159 else
160 {
161 Element metadata = (Element) metadataList.item(0);
162 String document = metadata.getTextContent();
163
164 //Get the security info for this collection
165 Element securityMessage = gsDoc.createElement(GSXML.MESSAGE_ELEM);
166 Element securityRequest = GSXML.createBasicRequest(gsDoc, GSXML.REQUEST_TYPE_SECURITY, collection, new UserContext());
167 securityMessage.appendChild(securityRequest);
168 if (document != null && !document.equals(""))
169 {
170 securityRequest.setAttribute(GSXML.NODE_OID, document);
171 }
172
173 Element securityResponse = (Element) GSXML.getChildByTagName(gsRouter.process(securityMessage), GSXML.RESPONSE_ELEM);
174 ArrayList<String> groups = GSXML.getGroupsFromSecurityResponse(securityResponse);
175
176 if (!groups.contains(""))
177 {
178 boolean found = false;
179 for (String group : groups)
180 {
181 if (((HttpServletRequest) request).isUserInRole(group))
182 {
183 found = true;
184 break;
185 }
186 }
187
188 if (!found)
189 {
190 return;
191 }
192 }
193 }
194 }
195 else if (url.contains(INTERFACE_PATH))
196 {
197 String fileURL = url.replaceFirst(request.getServletContext().getContextPath(), "");
198 File requestedFile = new File(request.getServletContext().getRealPath(fileURL));
199 if (!requestedFile.exists())
200 {
201 int interfaceNameStart = fileURL.indexOf(INTERFACE_PATH) + INTERFACE_PATH.length();
202 int interfaceNameEnd = fileURL.indexOf("/", interfaceNameStart);
203 String interfaceName = fileURL.substring(interfaceNameStart, interfaceNameEnd);
204 String interfacesDir = fileURL.substring(0, interfaceNameStart);
205 File interfaceConfigFile = new File(request.getServletContext().getRealPath(interfacesDir + interfaceName + "/interfaceConfig.xml"));
206
207 if (interfaceConfigFile.exists())
208 {
209 Document interfaceConfigDoc = XMLConverter.getDOM(interfaceConfigFile);
210
211 String baseInterface = interfaceConfigDoc.getDocumentElement().getAttribute("baseInterface");
212 if (baseInterface.length() > 0)
213 {
214 File baseInterfaceFile = new File(request.getServletContext().getRealPath(fileURL.replace("/" + interfaceName + "/", "/" + baseInterface + "/")));
215 if (baseInterfaceFile.exists())
216 {
217 ServletOutputStream out = response.getOutputStream();
218 out.write(FileUtils.readFileToByteArray(baseInterfaceFile));
219 out.flush();
220 out.close();
221 return;
222 }
223 }
224 }
225 }
226 }
227 else
228 {
229 //If we have a jsessionid on the end of our URL we want to ignore it
230 int index;
231 if ((index = url.indexOf(";jsessionid")) != -1)
232 {
233 url = url.substring(0, index);
234 }
235 String[] segments = url.split("/");
236 for (int i = 0; i < segments.length; i++)
237 {
238 String[] additionalParameters = null;
239 String[] defaultParamValues = null;
240
241 //COLLECTION
242 if (segments[i].equals(COLLECTION_PATH) && (i + 1) < segments.length)
243 {
244 gRequest.setParameter(GSParams.COLLECTION, segments[i + 1]);
245 }
246 //DOCUMENT
247 else if (segments[i].equals(DOCUMENT_PATH) && (i + 1) < segments.length)
248 {
249 gRequest.setParameter(GSParams.DOCUMENT, segments[i + 1]);
250
251 additionalParameters = new String[] { GSParams.ACTION };
252 defaultParamValues = new String[] { "d" };
253 }
254 //PAGE
255 else if (segments[i].equals(PAGE_PATH) && (i + 1) < segments.length)
256 {
257 gRequest.setParameter(GSParams.SUBACTION, segments[i + 1]);
258
259 additionalParameters = new String[] { GSParams.ACTION };
260 defaultParamValues = new String[] { "p" };
261 }
262 //SYSTEM
263 else if (segments[i].equals(SYSTEM_PATH) && (i + 1) < segments.length)
264 {
265 String sa = segments[i + 1];
266 if (sa.equals(SYSTEM_SUBACTION_CONFIGURE) || sa.equals(SYSTEM_SUBACTION_RECONFIGURE))
267 {
268 sa = "c";
269 }
270 else if (sa.equals(SYSTEM_SUBACTION_ACTIVATE))
271 {
272 sa = "a";
273 }
274 else if (sa.equals(SYSTEM_SUBACTION_DEACTIVATE))
275 {
276 sa = "d";
277 }
278
279 if (sa.equals("c") && (i + 2) < segments.length)
280 {
281 gRequest.setParameter(GSParams.SYSTEM_CLUSTER, segments[i + 2]);
282 }
283
284 if (sa.equals("a") && (i + 2) < segments.length)
285 {
286 gRequest.setParameter(GSParams.SYSTEM_MODULE_TYPE, "collection");
287 gRequest.setParameter(GSParams.SYSTEM_MODULE_NAME, segments[i + 2]);
288 }
289
290 if (sa.equals("d") && (i + 2) < segments.length)
291 {
292 gRequest.setParameter(GSParams.SYSTEM_CLUSTER, segments[i + 2]);
293 }
294
295 gRequest.setParameter(GSParams.SUBACTION, sa);
296
297 additionalParameters = new String[] { GSParams.ACTION };
298 defaultParamValues = new String[] { "s" };
299 }
300 //ADMIN
301 else if (segments[i].equals("admin") && (i + 1) < segments.length)
302 {
303 String pageName = segments[i + 1];
304
305 gRequest.setParameter("s1.authpage", pageName);
306
307 additionalParameters = new String[] { GSParams.ACTION, GSParams.REQUEST_TYPE, GSParams.SUBACTION, GSParams.SERVICE };
308 defaultParamValues = new String[] { "g", "r", "authen", "Authentication" };
309 }
310 //BROWSE
311 else if (segments[i].equals("browse") && (i + 1) < segments.length)
312 {
313 String cl = "";
314 for (int j = 1; (i + j) < segments.length; j++)
315 {
316 String currentSegment = segments[i + j].replace("CL", "").replace("cl", "");
317 if (currentSegment.contains("."))
318 {
319 String[] subsegments = currentSegment.split("\\.");
320 for (String subsegment : subsegments)
321 {
322 subsegment = subsegment.replace("CL", "").replace("cl", "");
323
324 if (cl.length() > 0)
325 {
326 cl += ".";
327 }
328
329 if (subsegment.length() > 0)
330 {
331 cl += subsegment;
332 }
333 }
334 continue;
335 }
336 if (!currentSegment.matches("^(CL|cl)?\\d+$"))
337 {
338 continue;
339 }
340
341 if (cl.length() > 0)
342 {
343 cl += ".";
344 }
345
346 cl += currentSegment;
347 }
348
349 gRequest.setParameter("cl", "CL" + cl);
350
351 additionalParameters = new String[] { GSParams.ACTION, GSParams.REQUEST_TYPE, GSParams.SERVICE };
352 defaultParamValues = new String[] { "b", "s", "ClassifierBrowse" };
353 }
354 //QUERY
355 else if (segments[i].equals("search"))
356 {
357 String serviceName = "";
358 if ((i + 1) < segments.length)
359 {
360 serviceName = segments[i + 1];
361 gRequest.setParameter("s", serviceName);
362
363 additionalParameters = new String[] { GSParams.ACTION, GSParams.SUBACTION, GSParams.REQUEST_TYPE };
364 defaultParamValues = new String[] { "q", "", "d" };
365 }
366 if ((i + 2) < segments.length)
367 {
368 if (serviceName.equals("TextQuery") || serviceName.equals("RawQuery"))
369 {
370
371 gRequest.setParameter("s1.query", segments[i + 2]);
372 }
373 else if (serviceName.equals("FieldQuery"))
374 {
375 gRequest.setParameter("s1.fqv", segments[i + 2]);
376 }
377 else if (serviceName.equals("AdvancedFieldQuery"))
378 {
379 gRequest.setParameter("s1.fqv", segments[i + 2]);
380 }
381 }
382 }
383 if (additionalParameters != null)
384 {
385 for (int j = 0; j < additionalParameters.length; j++)
386 {
387 if (gRequest.getParameter(additionalParameters[j]) == null)
388 {
389 gRequest.setParameter(additionalParameters[j], defaultParamValues[j]);
390 }
391 }
392 }
393 }
394 }
395
396 chain.doFilter(gRequest, response);
397 }
398 else
399 {
400 //Will this ever happen?
401 System.err.println("The request was not an HttpServletRequest");
402 }
403 }
404
405 private boolean isURLRestricted(String url)
406 {
407 for (String restrictedURL : _restrictedURLs)
408 {
409 if (url.matches(".*" + restrictedURL + ".*"))
410 {
411 return true;
412 }
413 }
414
415 return false;
416 }
417
418 private class GSHttpServletRequestWrapper extends HttpServletRequestWrapper
419 {
420 private HashMap<String, String[]> _newParams = new HashMap<String, String[]>();
421
422 public GSHttpServletRequestWrapper(ServletRequest request)
423 {
424 super((HttpServletRequest) request);
425 }
426
427 public void setParameter(String paramName, String[] paramValues)
428 {
429 _newParams.put(paramName, paramValues);
430 }
431
432 public void setParameter(String paramName, String paramValue)
433 {
434 _newParams.put(paramName, new String[] { paramValue });
435 }
436
437 public String getParameter(String paramName)
438 {
439 if (super.getParameter(paramName) != null)
440 {
441 return super.getParameter(paramName);
442 }
443 else
444 {
445 if (_newParams.get(paramName) != null && _newParams.get(paramName)[0] != null)
446 {
447 return _newParams.get(paramName)[0];
448 }
449 return null;
450 }
451 }
452
453 public String[] getParameterValues(String paramName)
454 {
455 if (super.getParameterValues(paramName) != null)
456 {
457 return super.getParameterValues(paramName);
458 }
459 else
460 {
461 return _newParams.get(paramName);
462 }
463 }
464
465 public Map<String, String[]> getParameterMap()
466 {
467 HashMap<String, String[]> returnMap = new HashMap<String, String[]>();
468 returnMap.putAll(super.getParameterMap());
469 returnMap.putAll(_newParams);
470 return returnMap;
471 }
472 }
473}
Note: See TracBrowser for help on using the repository browser.