source: main/branches/64_bit_Greenstone/greenstone3/src/java/org/greenstone/gsdl3/core/DefaultReceptionist.java@ 24007

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

Updating this branch to match the latest Greenstone3 changes

  • Property svn:keywords set to Author Date Id Revision
File size: 6.6 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 Element pc_param = GSXML.getNamedElement(param_list, GSXML.PARAM_ELEM, GSXML.NAME_ATT, "p.c");
55 if(pc_param != null)
56 {
57 coll_name = pc_param.getAttribute(GSXML.VALUE_ATT);
58 }
59 }
60
61 boolean get_service_description = false;
62 Element page_response = (Element)GSXML.getChildByTagName(page, GSXML.PAGE_RESPONSE_ELEM);
63 if (this.language_list != null) {
64 page_response.appendChild(this.language_list);
65 }
66 Element coll_description = (Element)GSXML.getChildByTagName(page_response, GSXML.COLLECTION_ELEM);
67 if (coll_description == null) {
68 // try cluster
69 coll_description = (Element)GSXML.getChildByTagName(page_response, GSXML.CLUSTER_ELEM);
70 }
71 if (coll_description == null) {
72
73 // we dont have one yet - get it
74 Element coll_about_message = this.doc.createElement(GSXML.MESSAGE_ELEM);
75 Element coll_about_request = GSXML.createBasicRequest(this.doc, GSXML.REQUEST_TYPE_DESCRIBE, coll_name, lang, uid);
76 coll_about_message.appendChild(coll_about_request);
77
78 Node coll_about_response_message = this.mr.process(coll_about_message);
79 Element coll_about_response = (Element)GSXML.getChildByTagName(coll_about_response_message, GSXML.RESPONSE_ELEM);
80 if (coll_about_response == null) {
81 return;
82 }
83 coll_description = (Element)GSXML.getChildByTagName(coll_about_response, GSXML.COLLECTION_ELEM);
84 if (coll_description==null) { // may be a cluster
85 coll_description = (Element)GSXML.getChildByTagName(coll_about_response, GSXML.CLUSTER_ELEM);
86 }
87
88 if (coll_description == null) {
89 logger.error(" no collection description, returning");
90 return;
91 }
92 // have found one, append it to the page response
93 coll_description = (Element)this.doc.importNode(coll_description, true);
94 page_response.appendChild(coll_description);
95 get_service_description = true;
96 }
97
98 // have got a coll description
99 // now get the dispay info for the services
100 Element service_list = (Element)GSXML.getChildByTagName(coll_description, GSXML.SERVICE_ELEM+GSXML.LIST_MODIFIER);
101 if (service_list == null) {
102 logger.error(" no service list, returning");
103 // something weird has gone wrong
104 return;
105 }
106
107 NodeList services = service_list.getElementsByTagName(GSXML.SERVICE_ELEM);
108 if (services.getLength()==0) {
109 logger.error("DefaultReceoptionist: no services found for colllection/cluster "+ coll_name);
110 return;
111 }
112 // check one service for display items
113 if (!get_service_description) {
114 // we dont know yet if we need to get these
115 int i=1;
116 Element test_s = (Element)services.item(0);
117 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))) {
118 test_s = (Element)services.item(i); i++;
119 }
120 if (i==services.getLength()) {
121 // we have only found retrieve or oai services, so dont need descripitons anyway
122 return;
123 }
124 if (GSXML.getChildByTagName(test_s, GSXML.DISPLAY_TEXT_ELEM) !=null) {
125 // have got descriptions already,
126 return;
127 }
128 }
129
130 // if get here, we need to get the service descriptions
131
132 // we will send all the requests in a single message
133 Element info_message = this.doc.createElement(GSXML.MESSAGE_ELEM);
134 for (int i=0; i<services.getLength(); i++) {
135 Element c = (Element)services.item(i);
136 String name = c.getAttribute(GSXML.NAME_ATT);
137 String address = GSPath.appendLink(coll_name, name);
138 Element info_request = GSXML.createBasicRequest(this.doc, GSXML.REQUEST_TYPE_DESCRIBE, address, lang, uid);
139 //Element req_param_list = this.doc.createElement(GSXML.PARAM_ELEM+GSXML.LIST_MODIFIER);
140 //req_param_list.appendChild(GSXML.createParameter(this.doc, GSXML.SUBSET_PARAM, GSXML.DISPLAY_TEXT_ELEM+GSXML.LIST_MODIFIER));
141 //info_request.appendChild(req_param_list);
142 info_message.appendChild(info_request);
143
144 }
145
146 Element info_response = (Element)this.mr.process(info_message);
147
148 NodeList service_responses = info_response.getElementsByTagName(GSXML.RESPONSE_ELEM);
149 // check that have same number of responses as collections
150 if (services.getLength() != service_responses.getLength()) {
151 logger.error(" didn't get a response for each service - somethings gone wrong!");
152 // for now, dont use the metadata
153 } else {
154 for (int i=0; i<services.getLength(); i++) {
155 Element c1 = (Element)services.item(i);
156 Element c2 = (Element)GSXML.getChildByTagName((Element)service_responses.item(i), GSXML.SERVICE_ELEM);
157 if (c1 !=null && c2 !=null && c1.getAttribute(GSXML.NAME_ATT).equals(c2.getAttribute(GSXML.NAME_ATT))) {
158 //add the service data into the original response
159 GSXML.mergeElements(c1, c2);
160 } else {
161 logger.debug(" response does not correspond to request!");
162 }
163
164 }
165 }
166 }
167}
168
Note: See TracBrowser for help on using the repository browser.