source: main/trunk/greenstone3/src/java/org/greenstone/gsdl3/core/DefaultReceptionist.java@ 23814

Last change on this file since 23814 was 23814, checked in by sjm84, 13 years ago

Some small modifications to allow a permanent search bar to be present in GS3 collections
  • Property svn:keywords set to Author Date Id Revision
File size: 6.8 KB
Line 
1package org.greenstone.gsdl3.core;
2
3import org.greenstone.gsdl3.util.*;
4import org.greenstone.gsdl3.action.*;
5// XML classes
6import org.w3c.dom.Node;
7import org.w3c.dom.NodeList;
8import org.w3c.dom.Document;
9import org.w3c.dom.Element;
10
11// other java classes
12import java.io.File;
13import java.util.HashMap;
14import java.util.Enumeration;
15
16import org.apache.log4j.*;
17
18/** The default greenstone receptionist - needs some extra info for each page
19*/
20public class DefaultReceptionist extends TransformingReceptionist {
21
22 static Logger logger = Logger.getLogger(org.greenstone.gsdl3.core.DefaultReceptionist.class.getName());
23
24 /** add in the collection description to the page, then for each service, add in the service description */
25 protected void addExtraInfo(Element page) {
26 super.addExtraInfo(page);
27
28 Element page_request = (Element)GSXML.getChildByTagName(page, GSXML.PAGE_REQUEST_ELEM);
29 // if it is a system request, then we don't bother with this.
30 String action = page_request.getAttribute(GSXML.ACTION_ATT);
31 if (action.equals("s")) {
32 logger.error("HACK: don't ask for coll info if system action");
33 return;
34 }
35 logger.debug("add extra info, page request="+this.converter.getString(page_request));
36 // is a collection defined?
37 Element param_list = (Element)GSXML.getChildByTagName(page_request, GSXML.PARAM_ELEM+GSXML.LIST_MODIFIER);
38 if (param_list==null) { // must be the original home page
39 logger.debug(" no param list, assuming home page");
40 return;
41 }
42 Element coll_param = GSXML.getNamedElement(param_list, GSXML.PARAM_ELEM, GSXML.NAME_ATT, GSParams.COLLECTION);
43 if (coll_param == null) {
44 logger.debug(" coll param is null, returning");
45 return;
46 }
47
48 // see if the collection/cluster element is already there
49 String coll_name = coll_param.getAttribute(GSXML.VALUE_ATT);
50 String lang = page_request.getAttribute(GSXML.LANG_ATT);
51 String uid = page_request.getAttribute(GSXML.USER_ID_ATT);
52
53 if (coll_name.equals("")) {
54 coll_name = GSXML.getNamedElement(param_list, GSXML.PARAM_ELEM, GSXML.NAME_ATT, "p.c").getAttribute(GSXML.VALUE_ATT);
55 logger.debug("*%*%*%* new collname = " + coll_name);
56 }
57
58 boolean get_service_description = false;
59 Element page_response = (Element)GSXML.getChildByTagName(page, GSXML.PAGE_RESPONSE_ELEM);
60 if (this.language_list != null) {
61 page_response.appendChild(this.language_list);
62 }
63 Element coll_description = (Element)GSXML.getChildByTagName(page_response, GSXML.COLLECTION_ELEM);
64 if (coll_description == null) {
65 // try cluster
66 coll_description = (Element)GSXML.getChildByTagName(page_response, GSXML.CLUSTER_ELEM);
67 }
68 if (coll_description == null) {
69
70 logger.debug("*%*%*%* No collection element, getting one");
71
72 // we dont have one yet - get it
73 Element coll_about_message = this.doc.createElement(GSXML.MESSAGE_ELEM);
74 Element coll_about_request = GSXML.createBasicRequest(this.doc, GSXML.REQUEST_TYPE_DESCRIBE, coll_name, lang, uid);
75 coll_about_message.appendChild(coll_about_request);
76
77 Node coll_about_response_message = this.mr.process(coll_about_message);
78 Element coll_about_response = (Element)GSXML.getChildByTagName(coll_about_response_message, GSXML.RESPONSE_ELEM);
79 if (coll_about_response == null) {
80 return;
81 }
82 coll_description = (Element)GSXML.getChildByTagName(coll_about_response, GSXML.COLLECTION_ELEM);
83 if (coll_description==null) { // may be a cluster
84 coll_description = (Element)GSXML.getChildByTagName(coll_about_response, GSXML.CLUSTER_ELEM);
85 }
86
87 if (coll_description == null) {
88 logger.error(" no collection description, returning");
89 return;
90 }
91 // have found one, append it to the page response
92 coll_description = (Element)this.doc.importNode(coll_description, true);
93 page_response.appendChild(coll_description);
94 get_service_description = true;
95 }
96
97 // have got a coll description
98
99 logger.debug("*%*%*%* Getting display information about the services");
100
101 // now get the dispay info for the services
102 Element service_list = (Element)GSXML.getChildByTagName(coll_description, GSXML.SERVICE_ELEM+GSXML.LIST_MODIFIER);
103 if (service_list == null) {
104 logger.error(" no service list, returning");
105 // something weird has gone wrong
106 return;
107 }
108
109 NodeList services = service_list.getElementsByTagName(GSXML.SERVICE_ELEM);
110 if (services.getLength()==0) {
111 logger.error("DefaultReceoptionist: no services found for colllection/cluster "+ coll_name);
112 return;
113 }
114 // check one service for display items
115 if (!get_service_description) {
116 // we dont know yet if we need to get these
117 int i=1;
118 Element test_s = (Element)services.item(0);
119 while (i<services.getLength() && (test_s.getAttribute(GSXML.TYPE_ATT).equals(GSXML.SERVICE_TYPE_RETRIEVE) || test_s.getAttribute(GSXML.TYPE_ATT).equals(GSXML.SERVICE_TYPE_OAI))) {
120 test_s = (Element)services.item(i); i++;
121 }
122 if (i==services.getLength()) {
123 // we have only found retrieve or oai services, so dont need descripitons anyway
124 return;
125 }
126 if (GSXML.getChildByTagName(test_s, GSXML.DISPLAY_TEXT_ELEM) !=null) {
127 // have got descriptions already,
128 return;
129 }
130 }
131
132
133 logger.debug("*%*%*%* Off to get the service descriptions");
134
135 // if get here, we need to get the service descriptions
136
137 // we will send all the requests in a single message
138 Element info_message = this.doc.createElement(GSXML.MESSAGE_ELEM);
139 for (int i=0; i<services.getLength(); i++) {
140 Element c = (Element)services.item(i);
141 String name = c.getAttribute(GSXML.NAME_ATT);
142 String address = GSPath.appendLink(coll_name, name);
143 Element info_request = GSXML.createBasicRequest(this.doc, GSXML.REQUEST_TYPE_DESCRIBE, address, lang, uid);
144 //Element req_param_list = this.doc.createElement(GSXML.PARAM_ELEM+GSXML.LIST_MODIFIER);
145 //req_param_list.appendChild(GSXML.createParameter(this.doc, GSXML.SUBSET_PARAM, GSXML.DISPLAY_TEXT_ELEM+GSXML.LIST_MODIFIER));
146 //info_request.appendChild(req_param_list);
147 info_message.appendChild(info_request);
148
149 }
150
151 Element info_response = (Element)this.mr.process(info_message);
152
153 NodeList service_responses = info_response.getElementsByTagName(GSXML.RESPONSE_ELEM);
154 // check that have same number of responses as collections
155 if (services.getLength() != service_responses.getLength()) {
156 logger.error(" didn't get a response for each service - somethings gone wrong!");
157 // for now, dont use the metadata
158 } else {
159 for (int i=0; i<services.getLength(); i++) {
160 Element c1 = (Element)services.item(i);
161 Element c2 = (Element)GSXML.getChildByTagName((Element)service_responses.item(i), GSXML.SERVICE_ELEM);
162 if (c1 !=null && c2 !=null && c1.getAttribute(GSXML.NAME_ATT).equals(c2.getAttribute(GSXML.NAME_ATT))) {
163 //add the service data into the original response
164 GSXML.mergeElements(c1, c2);
165 } else {
166 logger.debug(" response does not correspond to request!");
167 }
168
169 }
170 }
171 }
172}
173
Note: See TracBrowser for help on using the repository browser.