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

Last change on this file since 28964 was 28964, checked in by kjdon, 10 years ago

nodeToElement now in GSXML. Some param changes for a few GSXML methods
  • Property svn:keywords set to Author Date Id Revision
File size: 12.1 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 Element message = GSXML.nodeToElement(message_node);
30 Document doc = XMLConverter.newDOM();
31
32 Element request = (Element) GSXML.getChildByTagName(message, GSXML.REQUEST_ELEM);
33 Element paramList = (Element) GSXML.getChildByTagName(request, GSXML.PARAM_ELEM + GSXML.LIST_MODIFIER);
34 String collection = "";
35 if (paramList != null)
36 {
37 HashMap<String, Serializable> params = GSXML.extractParams(paramList, false);
38 if (params != null && params.get(GSParams.COLLECTION) != null)
39 {
40 collection = (String) params.get(GSParams.COLLECTION);
41 }
42 }
43
44 // the page name is the subaction
45 String page_name = request.getAttribute(GSXML.SUBACTION_ATT);
46 if (page_name.equals(""))
47 { // if no page specified, assume home page
48 page_name = HOME_PAGE;
49 }
50 Element result = doc.createElement(GSXML.MESSAGE_ELEM);
51 Element response;
52 if (page_name.equals(HOME_PAGE))
53 {
54 response = homePage(request);
55 //} else if (page_name.equals(ABOUT_PAGE)) {
56 }
57 else if (page_name.equals(ABOUT_PAGE) || page_name.equals(PREFS_PAGE))
58 {
59 response = aboutPage(request);
60 //}else if (page_name.equals(PREFS_PAGE)) {
61 //response = prefsPage(request);
62 }
63 else if (page_name.equals(GLI4GS3_PAGE))
64 {
65 response = gli4gs3Page(request);
66 }
67 else
68 { // unknown page
69 response = unknownPage(request);
70 }
71
72 Element formatMessage = doc.createElement(GSXML.MESSAGE_ELEM);
73 Element formatRequest = GSXML.createBasicRequest(doc, GSXML.REQUEST_TYPE_FORMAT, collection, new UserContext(request));
74 formatMessage.appendChild(formatRequest);
75 Element formatResponseMessage = (Element) this.mr.process(formatMessage);
76 Element formatResponse = (Element) GSXML.getChildByTagName(formatResponseMessage, GSXML.RESPONSE_ELEM);
77
78 Element globalFormat = (Element) GSXML.getChildByTagName(formatResponse, GSXML.FORMAT_ELEM);
79 if (globalFormat != null)
80 {
81 response.appendChild(response.getOwnerDocument().importNode(globalFormat, true));
82 }
83
84 result.appendChild(doc.importNode(response, true));
85 logger.debug("page action result: " + this.converter.getPrettyString(result));
86
87 return result;
88 }
89
90 protected Element homePage(Element request)
91 {
92 Document doc = XMLConverter.newDOM();
93
94 UserContext userContext = new UserContext(request);
95 // first, get the message router info
96 Element info_message = doc.createElement(GSXML.MESSAGE_ELEM);
97 Element coll_list_request = GSXML.createBasicRequest(doc, GSXML.REQUEST_TYPE_DESCRIBE, "", userContext);
98 info_message.appendChild(coll_list_request);
99 Element info_response_message = (Element) this.mr.process(info_message);
100 if (info_response_message == null)
101 {
102 logger.error(" couldn't query the message router!");
103 return null;
104 }
105 Element info_response = (Element) GSXML.getChildByTagName(info_response_message, GSXML.RESPONSE_ELEM);
106 if (info_response == null)
107 {
108 logger.error("couldn't query the message router!");
109 return null;
110 }
111
112 // second, get the metadata for each collection - we only want specific
113 // elements but for now, we'll just get it all
114 Element collection_list = (Element) GSXML.getChildByTagName(info_response, GSXML.COLLECTION_ELEM + GSXML.LIST_MODIFIER);
115 logger.debug(GSXML.xmlNodeToString(collection_list));
116 if (collection_list != null)
117 {
118 NodeList colls = GSXML.getChildrenByTagName(collection_list, GSXML.COLLECTION_ELEM);
119 if (colls.getLength() > 0)
120 {
121 sendMultipleRequests(doc, colls, null, GSXML.REQUEST_TYPE_DESCRIBE, userContext);
122 }
123 }
124
125 // get metadata for any services
126 Element service_list = (Element) GSXML.getChildByTagName(info_response, GSXML.SERVICE_ELEM + GSXML.LIST_MODIFIER);
127 if (service_list != null)
128 {
129 NodeList services = GSXML.getChildrenByTagName(service_list, GSXML.SERVICE_ELEM);
130 if (services.getLength() > 0)
131 {
132 sendMultipleRequests(doc, services, null, GSXML.REQUEST_TYPE_DESCRIBE, userContext);
133 }
134 }
135
136 // get metadata for service clusters
137 Element cluster_list = (Element) GSXML.getChildByTagName(info_response, GSXML.CLUSTER_ELEM + GSXML.LIST_MODIFIER);
138 if (cluster_list != null)
139 {
140 NodeList clusters = GSXML.getChildrenByTagName(cluster_list, GSXML.CLUSTER_ELEM);
141 if (clusters.getLength() > 0)
142 {
143 sendMultipleRequests(doc, clusters, null, GSXML.REQUEST_TYPE_DESCRIBE, userContext);
144
145 }
146 }
147
148 addSiteMetadata(info_response, userContext);
149 addInterfaceOptions(info_response);
150 // all the components have been merged into info_response
151 return info_response;
152
153 } // homePage
154
155 protected Element aboutPage(Element request)
156 {
157 Document doc = XMLConverter.newDOM();
158
159 UserContext userContext = new UserContext(request);
160 // extract the params from the cgi-request,
161 Element cgi_paramList = (Element) GSXML.getChildByTagName(request, GSXML.PARAM_ELEM + GSXML.LIST_MODIFIER);
162 HashMap<String, Serializable> params = GSXML.extractParams(cgi_paramList, false);
163
164 String coll_name = (String) params.get(GSParams.COLLECTION);
165 if (coll_name == null || coll_name.equals(""))
166 {
167 logger.error("about page requested with no collection or cluster specified!");
168 // return an empty response
169 Element response = doc.createElement(GSXML.RESPONSE_ELEM);
170 addSiteMetadata(response, userContext);
171 addInterfaceOptions(response);
172 return response;
173 }
174
175 // get the collection or cluster description
176 Element coll_about_message = doc.createElement(GSXML.MESSAGE_ELEM);
177
178 Element coll_about_request = GSXML.createBasicRequest(doc, GSXML.REQUEST_TYPE_DESCRIBE, coll_name, userContext);
179 coll_about_message.appendChild(coll_about_request);
180 Element coll_about_response = (Element) this.mr.process(coll_about_message);
181
182 // add collection type attribute to paramList
183 String col_type = "";
184 NodeList collect_elem = coll_about_response.getElementsByTagName(GSXML.COLLECTION_ELEM);
185 if (collect_elem.getLength() != 0)
186 {
187 for (int i = 0; i < collect_elem.getLength(); i++)
188 {
189 Element e = (Element) collect_elem.item(i);
190 col_type = e.getAttribute(GSXML.TYPE_ATT);
191 }
192 }
193 else
194 {
195 logger.error(GSXML.COLLECTION_ELEM + " element is null");
196 }
197
198 NodeList paramList = request.getElementsByTagName(GSXML.PARAM_ELEM + GSXML.LIST_MODIFIER);
199 if (paramList.getLength() != 0)
200 {
201 for (int i = 0; i < paramList.getLength(); i++)
202 {
203 Element e = (Element) paramList.item(i);
204 Element ct = GSXML.createParameter(request.getOwnerDocument(), GSParams.COLLECTION_TYPE, col_type.equalsIgnoreCase("mg") ? "0" : "1");
205 e.appendChild(ct);
206 }
207 }
208 else
209 {
210 logger.info("paramList is null!!");
211 }
212
213 if (coll_about_response == null)
214 {
215 return null;
216 }
217
218 // second, get the info for each service - we only want display items
219 // but for now, we'll just get it all
220 NodeList services = coll_about_response.getElementsByTagName(GSXML.SERVICE_ELEM);
221 if (services.getLength() > 0)
222 {
223 sendMultipleRequests(doc, services, coll_name, GSXML.REQUEST_TYPE_DESCRIBE, userContext);
224 }
225
226 Element response = (Element) GSXML.getChildByTagName(coll_about_response, GSXML.RESPONSE_ELEM);
227 //add the site metadata
228 addSiteMetadata(response, userContext);
229 addInterfaceOptions(response);
230 return response;
231 }
232
233 //protected Element prefsPage(Element request) {
234
235 // return null;
236 //}
237
238 /** if we dont know the page type, use this method */
239 protected Element unknownPage(Element request)
240 {
241 Document doc = XMLConverter.newDOM();
242
243 UserContext userContext = new UserContext(request);
244 String page_name = request.getAttribute(GSXML.SUBACTION_ATT);
245
246 // extract the params from the cgi-request,
247 Element cgi_paramList = (Element) GSXML.getChildByTagName(request, GSXML.PARAM_ELEM + GSXML.LIST_MODIFIER);
248 HashMap<String, Serializable> params = GSXML.extractParams(cgi_paramList, false);
249
250 String coll_name = (String) params.get(GSParams.COLLECTION);
251 if (coll_name == null || coll_name.equals(""))
252 {
253 // just return an empty response
254 Element response = doc.createElement(GSXML.RESPONSE_ELEM);
255 addSiteMetadata(response, userContext);
256 addInterfaceOptions(response);
257 return response;
258 }
259
260 // else get the coll description - actually this is the same as for the about page - should we merge these two methods??
261
262 // if there is a service specified should we get the service description instead??
263 // get the collection or cluster description
264 Element coll_about_message = doc.createElement(GSXML.MESSAGE_ELEM);
265
266 Element coll_about_request = GSXML.createBasicRequest(doc, GSXML.REQUEST_TYPE_DESCRIBE, coll_name, userContext);
267 coll_about_message.appendChild(coll_about_request);
268
269 Element coll_about_response = (Element) this.mr.process(coll_about_message);
270
271 Element response = (Element) GSXML.getChildByTagName(coll_about_response, GSXML.RESPONSE_ELEM);
272
273 //add the site metadata
274 addSiteMetadata(response, userContext);
275 addInterfaceOptions(response);
276
277 return response;
278
279 }
280
281 protected boolean sendMultipleRequests(Document doc, NodeList items, String path_prefix, String request_type, UserContext userContext)
282 {
283 // we will send all the requests in a single message
284 Element message = doc.createElement(GSXML.MESSAGE_ELEM);
285 for (int i = 0; i < items.getLength(); i++)
286 {
287 Element c = (Element) items.item(i);
288 String path = c.getAttribute(GSXML.NAME_ATT);
289 if (path_prefix != null)
290 {
291 path = GSPath.appendLink(path_prefix, path);
292 }
293 Element request = GSXML.createBasicRequest(doc, request_type, path, userContext);
294 message.appendChild(request);
295 }
296
297 Element response_message = (Element) this.mr.process(message);
298
299 NodeList responses = response_message.getElementsByTagName(GSXML.RESPONSE_ELEM);
300 // check that have same number of responses as requests
301 if (items.getLength() != responses.getLength())
302 {
303 logger.error("didn't get a response for each request - somethings gone wrong!");
304 return false;
305 }
306
307 for (int i = 0; i < items.getLength(); i++)
308 {
309 Element c1 = (Element) items.item(i);
310 Element c2 = (Element) GSXML.getChildByTagName((Element) responses.item(i), c1.getTagName());
311 if (c1 != null && c2 != null && c1.getAttribute(GSXML.NAME_ATT).endsWith(c2.getAttribute(GSXML.NAME_ATT)))
312 {
313 //add the new data into the original element
314 GSXML.mergeElements(c1, c2);
315 }
316 else
317 {
318 logger.debug(" response does not correspond to request!");
319 }
320
321 }
322
323 return true;
324
325 }
326
327 protected Element gli4gs3Page(Element request)
328 {
329 Document doc = XMLConverter.newDOM();
330
331 String lang = request.getAttribute(GSXML.LANG_ATT);
332 String uid = request.getAttribute(GSXML.USER_ID_ATT);
333
334 Element page_response = doc.createElement(GSXML.RESPONSE_ELEM);
335
336 Element applet_elem = doc.createElement("Applet");
337 page_response.appendChild(applet_elem);
338 applet_elem.setAttribute("ARCHIVE", "SignedGatherer.jar");
339 applet_elem.setAttribute("CODE", "org.greenstone.gatherer.GathererApplet");
340 applet_elem.setAttribute("CODEBASE", "applet");
341 applet_elem.setAttribute("HEIGHT", "50");
342 applet_elem.setAttribute("WIDTH", "380");
343 Element gwcgi_param_elem = doc.createElement("PARAM");
344 gwcgi_param_elem.setAttribute("name", "gwcgi");
345 String library_name = GlobalProperties.getGSDL3WebAddress();
346 gwcgi_param_elem.setAttribute("value", library_name);
347 applet_elem.appendChild(gwcgi_param_elem);
348
349 Element gsdl3_param_elem = doc.createElement("PARAM");
350 gsdl3_param_elem.setAttribute("name", "gsdl3");
351 gsdl3_param_elem.setAttribute("value", "true");
352 applet_elem.appendChild(gsdl3_param_elem);
353
354 return page_response;
355 }
356}
Note: See TracBrowser for help on using the repository browser.