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

Last change on this file since 24993 was 24993, checked in by sjm84, 12 years ago

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