source: main/trunk/greenstone3/src/java/org/greenstone/gsdl3/action/PageAction.java@ 30540

Last change on this file since 30540 was 30540, checked in by Georgiy Litvinov, 8 years ago

Added collection groups. Config file in web/sites/localsite/groupConfig.xml
PageAction now send request to CollectionGroups service to retrieve information about collections and groups.
  • Property svn:keywords set to Author Date Id Revision
File size: 15.4 KB
Line 
1package org.greenstone.gsdl3.action;
2
3import java.io.Serializable;
4import java.util.HashMap;
5
6import org.apache.log4j.Logger;
7import org.greenstone.gsdl3.util.GSParams;
8import org.greenstone.gsdl3.util.GSPath;
9import org.greenstone.gsdl3.util.GSXML;
10import org.greenstone.gsdl3.util.UserContext;
11import org.greenstone.gsdl3.util.XMLConverter;
12import org.greenstone.util.GlobalProperties;
13import org.w3c.dom.Document;
14import org.w3c.dom.Element;
15import org.w3c.dom.Node;
16import org.w3c.dom.NodeList;
17
18public class PageAction extends Action
19{
20 static Logger logger = Logger.getLogger(org.greenstone.gsdl3.action.PageAction.class.getName());
21
22 public static final String HOME_PAGE = "home";
23 public static final String ABOUT_PAGE = "about";
24 public static final String PREFS_PAGE = "pref";
25 public static final String GLI4GS3_PAGE = "gli4gs3";
26
27 public Node process(Node message_node)
28
29 {
30 Element message = GSXML.nodeToElement(message_node);
31 Document doc = XMLConverter.newDOM();
32
33 Element request = (Element) GSXML.getChildByTagName(message, GSXML.REQUEST_ELEM);
34 Element paramList = (Element) GSXML.getChildByTagName(request, GSXML.PARAM_ELEM + GSXML.LIST_MODIFIER);
35 String collection = "";
36 if (paramList != null)
37 {
38 HashMap<String, Serializable> params = GSXML.extractParams(paramList, false);
39 if (params != null && params.get(GSParams.COLLECTION) != null)
40 {
41 collection = (String) params.get(GSParams.COLLECTION);
42 }
43 }
44
45 // the page name is the subaction
46 String page_name = request.getAttribute(GSXML.SUBACTION_ATT);
47 if (page_name.equals(""))
48 { // if no page specified, assume home page
49 page_name = HOME_PAGE;
50 }
51 Element result = doc.createElement(GSXML.MESSAGE_ELEM);
52 Element response;
53 if (page_name.equals(HOME_PAGE))
54 {
55 response = homePage(request);
56 //} else if (page_name.equals(ABOUT_PAGE)) {
57 }
58 else if (page_name.equals(ABOUT_PAGE) || page_name.equals(PREFS_PAGE))
59 {
60 response = aboutPage(request);
61 //}else if (page_name.equals(PREFS_PAGE)) {
62 //response = prefsPage(request);
63 }
64 else if (page_name.equals(GLI4GS3_PAGE))
65 {
66 response = gli4gs3Page(request);
67 }
68 else
69 { // unknown page
70 response = unknownPage(request);
71 }
72
73 Element formatMessage = doc.createElement(GSXML.MESSAGE_ELEM);
74 Element formatRequest = GSXML.createBasicRequest(doc, GSXML.REQUEST_TYPE_FORMAT, collection, new UserContext(request));
75 formatMessage.appendChild(formatRequest);
76 Element formatResponseMessage = (Element) this.mr.process(formatMessage);
77 Element formatResponse = (Element) GSXML.getChildByTagName(formatResponseMessage, GSXML.RESPONSE_ELEM);
78
79 Element globalFormat = (Element) GSXML.getChildByTagName(formatResponse, GSXML.FORMAT_ELEM);
80 if (globalFormat != null)
81 {
82 response.appendChild(response.getOwnerDocument().importNode(globalFormat, true));
83 }
84
85 result.appendChild(doc.importNode(response, true));
86 logger.debug("page action result: " + this.converter.getPrettyString(result));
87
88 return result;
89 }
90
91 protected Element homePage(Element request)
92 {
93 Document doc = XMLConverter.newDOM();
94
95
96 UserContext userContext = new UserContext(request);
97 // first, get the message router info
98 Element info_message = doc.createElement(GSXML.MESSAGE_ELEM);
99 Element info_request = GSXML.createBasicRequest(doc, GSXML.REQUEST_TYPE_DESCRIBE, "", userContext);
100 //Create param list
101 Element param_list_element = doc.createElement(GSXML.PARAM_ELEM + GSXML.LIST_MODIFIER);
102 info_request.appendChild(param_list_element);
103 //Describe params without collectionlist. Collectionlist provided by CollectionGroup service
104 GSXML.addParameterToList(param_list_element, GSXML.SUBSET_PARAM, GSXML.CLUSTER_ELEM + GSXML.LIST_MODIFIER);
105 GSXML.addParameterToList(param_list_element, GSXML.SUBSET_PARAM, GSXML.SERVICE_ELEM + GSXML.LIST_MODIFIER);
106 GSXML.addParameterToList(param_list_element, GSXML.SUBSET_PARAM, GSXML.SITE_ELEM + GSXML.LIST_MODIFIER);
107 GSXML.addParameterToList(param_list_element, GSXML.SUBSET_PARAM, GSXML.METADATA_ELEM + GSXML.LIST_MODIFIER);
108 info_message.appendChild(info_request);
109 //Send request to message router
110 Element info_response_message = (Element) this.mr.process(info_message);
111 //Check if it is not null
112 if (info_response_message == null)
113 {
114 logger.error(" couldn't query the message router!");
115 return null;
116 }
117 //Check if it is not null
118 Element info_response = (Element) GSXML.getChildByTagName(info_response_message, GSXML.RESPONSE_ELEM);
119 if (info_response == null)
120 {
121 logger.error("couldn't query the message router!");
122 return null;
123 }
124
125 Element resp_service_list = (Element) GSXML.getChildByTagName(info_response, GSXML.SERVICE_ELEM + GSXML.LIST_MODIFIER);
126
127 if (resp_service_list == null) {
128 logger.error("No services available. Couldn't query the message router!");
129 return null;
130 }
131 Element groupInfoService = GSXML.getNamedElement(resp_service_list, GSXML.SERVICE_ELEM, GSXML.TYPE_ATT,
132 GSXML.SERVICE_TYPE_GROUPINFO);
133 if (groupInfoService != null) {
134 // Prepare request for CollectionGroup service to get current
135 // collections and groups list
136 Element group_info_message = doc.createElement(GSXML.MESSAGE_ELEM);
137 Element group_info_request = GSXML.createBasicRequest(doc, GSXML.TO_ATT,
138 groupInfoService.getAttribute(GSXML.NAME_ATT), userContext);
139 group_info_message.appendChild(group_info_request);
140 //Append group request if exists
141 Element paramList = (Element) GSXML.getChildByTagName(request, GSXML.PARAM_ELEM + GSXML.LIST_MODIFIER);
142 if (paramList != null) {
143 group_info_request.appendChild(doc.importNode(paramList, true));
144 }
145 Element group_info_response_message = (Element) this.mr.process(group_info_message);
146 Element group_info_response = (Element) GSXML.getChildByTagName(group_info_response_message,
147 GSXML.RESPONSE_ELEM);
148 Element collection_list = (Element) GSXML.getChildByTagName(group_info_response,
149 GSXML.COLLECTION_ELEM + GSXML.LIST_MODIFIER);
150 // Add Collection List from CollectionGroup Service to response
151 // from message router
152 info_response = (Element) doc.importNode(info_response, true);
153 if (collection_list != null) {
154 info_response.appendChild(doc.importNode(collection_list, true));
155 }
156 Element group_list = (Element) GSXML.getChildByTagName(group_info_response,
157 GSXML.GROUP_ELEM + GSXML.LIST_MODIFIER);
158 if (group_list != null) {
159 info_response.appendChild(doc.importNode(group_list, true));
160 }
161 // Send message to groupInfoType Services
162 } else {
163 // If no service with type SERVICE_TYPE_GROUPINFO could be provided
164 // request message router for all available collections
165 GSXML.addParameterToList(param_list_element, GSXML.SUBSET_PARAM,
166 GSXML.COLLECTION_ELEM + GSXML.LIST_MODIFIER);
167 info_response_message = (Element) this.mr.process(info_message);
168
169 if (info_response_message == null) {
170 logger.error(" couldn't query the message router!");
171 return null;
172 }
173 info_response = (Element) GSXML.getChildByTagName(info_response_message, GSXML.RESPONSE_ELEM);
174 if (info_response == null) {
175 logger.error("couldn't query the message router!");
176 return null;
177 }
178 }
179
180 // second, get the metadata for each collection - we only want specific
181 // elements but for now, we'll just get it all
182 Element collection_list = (Element) GSXML.getChildByTagName(info_response, GSXML.COLLECTION_ELEM + GSXML.LIST_MODIFIER);
183 //logger.debug(GSXML.xmlNodeToString(collection_list));
184 if (collection_list != null)
185 {
186 NodeList colls = GSXML.getChildrenByTagName(collection_list, GSXML.COLLECTION_ELEM);
187 if (colls.getLength() > 0)
188 {
189 sendMultipleRequests(doc, colls, null, GSXML.REQUEST_TYPE_DESCRIBE, userContext);
190 }
191 }
192
193 // get metadata for any services
194 Element service_list = (Element) GSXML.getChildByTagName(info_response, GSXML.SERVICE_ELEM + GSXML.LIST_MODIFIER);
195 if (service_list != null)
196 {
197 NodeList services = GSXML.getChildrenByTagName(service_list, GSXML.SERVICE_ELEM);
198 if (services.getLength() > 0)
199 {
200 sendMultipleRequests(doc, services, null, GSXML.REQUEST_TYPE_DESCRIBE, userContext);
201 }
202 }
203
204 // get metadata for service clusters
205 Element cluster_list = (Element) GSXML.getChildByTagName(info_response, GSXML.CLUSTER_ELEM + GSXML.LIST_MODIFIER);
206 if (cluster_list != null)
207 {
208 NodeList clusters = GSXML.getChildrenByTagName(cluster_list, GSXML.CLUSTER_ELEM);
209 if (clusters.getLength() > 0)
210 {
211 sendMultipleRequests(doc, clusters, null, GSXML.REQUEST_TYPE_DESCRIBE, userContext);
212
213 }
214 }
215
216 addSiteMetadata(info_response, userContext);
217 addInterfaceOptions(info_response);
218 // all the components have been merged into info_response
219 return info_response;
220
221 } // homePage
222
223 protected Element aboutPage(Element request)
224 {
225 Document doc = XMLConverter.newDOM();
226
227 UserContext userContext = new UserContext(request);
228 // extract the params from the cgi-request,
229 Element cgi_paramList = (Element) GSXML.getChildByTagName(request, GSXML.PARAM_ELEM + GSXML.LIST_MODIFIER);
230 HashMap<String, Serializable> params = GSXML.extractParams(cgi_paramList, false);
231
232 String coll_name = (String) params.get(GSParams.COLLECTION);
233 if (coll_name == null || coll_name.equals(""))
234 {
235 logger.error("about page requested with no collection or cluster specified!");
236 // return an empty response
237 Element response = doc.createElement(GSXML.RESPONSE_ELEM);
238 addSiteMetadata(response, userContext);
239 addInterfaceOptions(response);
240 return response;
241 }
242
243 // get the collection or cluster description
244 Element coll_about_message = doc.createElement(GSXML.MESSAGE_ELEM);
245
246 Element coll_about_request = GSXML.createBasicRequest(doc, GSXML.REQUEST_TYPE_DESCRIBE, coll_name, userContext);
247 coll_about_message.appendChild(coll_about_request);
248 Element coll_about_response = (Element) this.mr.process(coll_about_message);
249
250 // add collection type attribute to paramList
251 String col_type = "";
252 NodeList collect_elem = coll_about_response.getElementsByTagName(GSXML.COLLECTION_ELEM);
253 if (collect_elem.getLength() != 0)
254 {
255 for (int i = 0; i < collect_elem.getLength(); i++)
256 {
257 Element e = (Element) collect_elem.item(i);
258 col_type = e.getAttribute(GSXML.TYPE_ATT);
259 }
260 }
261 else
262 {
263 logger.error(GSXML.COLLECTION_ELEM + " element is null");
264 }
265
266 NodeList paramList = request.getElementsByTagName(GSXML.PARAM_ELEM + GSXML.LIST_MODIFIER);
267 if (paramList.getLength() != 0)
268 {
269 for (int i = 0; i < paramList.getLength(); i++)
270 {
271 Element e = (Element) paramList.item(i);
272 Element ct = GSXML.createParameter(request.getOwnerDocument(), GSParams.COLLECTION_TYPE, col_type.equalsIgnoreCase("mg") ? "0" : "1");
273 e.appendChild(ct);
274 }
275 }
276 else
277 {
278 logger.info("paramList is null!!");
279 }
280
281 if (coll_about_response == null)
282 {
283 return null;
284 }
285
286 // second, get the info for each service - we only want display items
287 // but for now, we'll just get it all
288 NodeList services = coll_about_response.getElementsByTagName(GSXML.SERVICE_ELEM);
289 if (services.getLength() > 0)
290 {
291 sendMultipleRequests(doc, services, coll_name, GSXML.REQUEST_TYPE_DESCRIBE, userContext);
292 }
293
294 Element response = (Element) GSXML.getChildByTagName(coll_about_response, GSXML.RESPONSE_ELEM);
295 //add the site metadata
296 addSiteMetadata(response, userContext);
297 addInterfaceOptions(response);
298 return response;
299 }
300
301 //protected Element prefsPage(Element request) {
302
303 // return null;
304 //}
305
306 /** if we dont know the page type, use this method */
307 protected Element unknownPage(Element request)
308 {
309 Document doc = XMLConverter.newDOM();
310
311 UserContext userContext = new UserContext(request);
312 String page_name = request.getAttribute(GSXML.SUBACTION_ATT);
313
314 // extract the params from the cgi-request,
315 Element cgi_paramList = (Element) GSXML.getChildByTagName(request, GSXML.PARAM_ELEM + GSXML.LIST_MODIFIER);
316 HashMap<String, Serializable> params = GSXML.extractParams(cgi_paramList, false);
317
318 String coll_name = (String) params.get(GSParams.COLLECTION);
319 if (coll_name == null || coll_name.equals(""))
320 {
321 // just return an empty response
322 Element response = doc.createElement(GSXML.RESPONSE_ELEM);
323 addSiteMetadata(response, userContext);
324 addInterfaceOptions(response);
325 return response;
326 }
327
328 // else get the coll description - actually this is the same as for the about page - should we merge these two methods??
329
330 // if there is a service specified should we get the service description instead??
331 // get the collection or cluster description
332 Element coll_about_message = doc.createElement(GSXML.MESSAGE_ELEM);
333
334 Element coll_about_request = GSXML.createBasicRequest(doc, GSXML.REQUEST_TYPE_DESCRIBE, coll_name, userContext);
335 coll_about_message.appendChild(coll_about_request);
336
337 Element coll_about_response = (Element) this.mr.process(coll_about_message);
338
339 Element response = (Element) GSXML.getChildByTagName(coll_about_response, GSXML.RESPONSE_ELEM);
340
341 //add the site metadata
342 addSiteMetadata(response, userContext);
343 addInterfaceOptions(response);
344
345 return response;
346
347 }
348
349 protected boolean sendMultipleRequests(Document doc, NodeList items, String path_prefix, String request_type, UserContext userContext)
350 {
351 // we will send all the requests in a single message
352 Element message = doc.createElement(GSXML.MESSAGE_ELEM);
353 for (int i = 0; i < items.getLength(); i++)
354 {
355 Element c = (Element) items.item(i);
356 String path = c.getAttribute(GSXML.NAME_ATT);
357 if (path_prefix != null)
358 {
359 path = GSPath.appendLink(path_prefix, path);
360 }
361 Element request = GSXML.createBasicRequest(doc, request_type, path, userContext);
362 message.appendChild(request);
363 }
364
365 Element response_message = (Element) this.mr.process(message);
366
367 NodeList responses = response_message.getElementsByTagName(GSXML.RESPONSE_ELEM);
368 // check that have same number of responses as requests
369 if (items.getLength() != responses.getLength())
370 {
371 logger.error("didn't get a response for each request - somethings gone wrong!");
372 return false;
373 }
374
375 for (int i = 0; i < items.getLength(); i++)
376 {
377 Element c1 = (Element) items.item(i);
378 Element c2 = (Element) GSXML.getChildByTagName((Element) responses.item(i), c1.getTagName());
379 if (c1 != null && c2 != null && c1.getAttribute(GSXML.NAME_ATT).endsWith(c2.getAttribute(GSXML.NAME_ATT)))
380 {
381 //add the new data into the original element
382 GSXML.mergeElements(c1, c2);
383 }
384 else
385 {
386 logger.debug(" response does not correspond to request!");
387 }
388
389 }
390
391 return true;
392
393 }
394
395 protected Element gli4gs3Page(Element request)
396 {
397 Document doc = XMLConverter.newDOM();
398
399 String lang = request.getAttribute(GSXML.LANG_ATT);
400 String uid = request.getAttribute(GSXML.USER_ID_ATT);
401
402 Element page_response = doc.createElement(GSXML.RESPONSE_ELEM);
403
404 Element applet_elem = doc.createElement("Applet");
405 page_response.appendChild(applet_elem);
406 applet_elem.setAttribute("ARCHIVE", "SignedGatherer.jar");
407 applet_elem.setAttribute("CODE", "org.greenstone.gatherer.GathererApplet");
408 applet_elem.setAttribute("CODEBASE", "applet");
409 applet_elem.setAttribute("HEIGHT", "50");
410 applet_elem.setAttribute("WIDTH", "380");
411 Element gwcgi_param_elem = doc.createElement("PARAM");
412 gwcgi_param_elem.setAttribute("name", "gwcgi");
413 String library_name = GlobalProperties.getGSDL3WebAddress();
414 gwcgi_param_elem.setAttribute("value", library_name);
415 applet_elem.appendChild(gwcgi_param_elem);
416
417 Element gsdl3_param_elem = doc.createElement("PARAM");
418 gsdl3_param_elem.setAttribute("name", "gsdl3");
419 gsdl3_param_elem.setAttribute("value", "true");
420 applet_elem.appendChild(gsdl3_param_elem);
421
422 return page_response;
423 }
424}
Note: See TracBrowser for help on using the repository browser.