[5265] | 1 | package org.greenstone.gsdl3.action;
|
---|
| 2 |
|
---|
| 3 | import org.greenstone.gsdl3.core.ModuleInterface;
|
---|
| 4 | import org.greenstone.gsdl3.util.*;
|
---|
| 5 | // XML classes
|
---|
[24988] | 6 | import org.w3c.dom.Node;
|
---|
| 7 | import org.w3c.dom.NodeList;
|
---|
| 8 | import org.w3c.dom.Text;
|
---|
| 9 | import org.w3c.dom.Document;
|
---|
| 10 | import org.w3c.dom.Element;
|
---|
[5265] | 11 |
|
---|
| 12 | import java.util.HashMap;
|
---|
| 13 | import java.util.HashSet;
|
---|
| 14 | import java.util.Vector;
|
---|
| 15 | import java.util.Map;
|
---|
| 16 | import java.util.Iterator;
|
---|
| 17 | import java.io.File;
|
---|
[25635] | 18 | import java.io.Serializable;
|
---|
[5265] | 19 |
|
---|
[13124] | 20 | import org.apache.log4j.*;
|
---|
| 21 |
|
---|
[24988] | 22 | /**
|
---|
| 23 | * action class for queries this is used when querying isn't collection
|
---|
| 24 | * specific, but it occurs across all collections in the site. The service
|
---|
| 25 | * description is assumed to be known by the xslt so we dont ask for it. we just
|
---|
| 26 | * pass all the service params to the TextQuery service of all the collections
|
---|
| 27 | */
|
---|
| 28 | public class NoCollQueryAction extends Action
|
---|
| 29 | {
|
---|
[5265] | 30 |
|
---|
[24988] | 31 | static Logger logger = Logger.getLogger(org.greenstone.gsdl3.action.NoCollQueryAction.class.getName());
|
---|
[16688] | 32 |
|
---|
[24988] | 33 | /**
|
---|
| 34 | * process - processes a request.
|
---|
| 35 | */
|
---|
| 36 | public Node process(Node message_node)
|
---|
| 37 | {
|
---|
[5265] | 38 |
|
---|
[28964] | 39 | Element message = GSXML.nodeToElement(message_node);
|
---|
[28382] | 40 | Document doc = message.getOwnerDocument();
|
---|
| 41 |
|
---|
[24988] | 42 | // get the request - assume there is only one
|
---|
| 43 | Element request = (Element) GSXML.getChildByTagName(message, GSXML.REQUEST_ELEM);
|
---|
[5265] | 44 |
|
---|
[24988] | 45 | // create the return message
|
---|
[28382] | 46 | Element result = doc.createElement(GSXML.MESSAGE_ELEM);
|
---|
[24988] | 47 | // for now we only have one type of query - subaction not used
|
---|
| 48 | Element response = basicQuery(request);
|
---|
[28382] | 49 | result.appendChild(doc.importNode(response, true));
|
---|
[24988] | 50 | return result;
|
---|
[5265] | 51 | }
|
---|
| 52 |
|
---|
[24988] | 53 | /**
|
---|
| 54 | * a generic query handler this gets the service description, does the query
|
---|
[28382] | 55 | * (just passes all the params to the service, then gets the titles for any
|
---|
[24988] | 56 | * results
|
---|
| 57 | */
|
---|
| 58 | protected Element basicQuery(Element request)
|
---|
| 59 | {
|
---|
| 60 | // the result
|
---|
[28382] | 61 | Document doc = request.getOwnerDocument();
|
---|
| 62 |
|
---|
| 63 | Element page_response = doc.createElement(GSXML.RESPONSE_ELEM);
|
---|
[5265] | 64 |
|
---|
[24988] | 65 | // extract the params from the cgi-request, and check that we have a coll specified
|
---|
| 66 | Element cgi_param_list = (Element) GSXML.getChildByTagName(request, GSXML.PARAM_ELEM + GSXML.LIST_MODIFIER);
|
---|
[25635] | 67 | HashMap<String, Serializable> params = GSXML.extractParams(cgi_param_list, false);
|
---|
[5265] | 68 |
|
---|
[24988] | 69 | String request_type = (String) params.get(GSParams.REQUEST_TYPE);
|
---|
[24993] | 70 | UserContext userContext = new UserContext(request);
|
---|
[24988] | 71 | if (request_type.equals("d"))
|
---|
| 72 | {
|
---|
| 73 | // display the query page
|
---|
| 74 | // the only info we need to return is the collection list cos the xslt does teh rest
|
---|
[5265] | 75 |
|
---|
[28382] | 76 | Element coll_list = getCollectionList(doc, userContext);
|
---|
| 77 | page_response.appendChild(doc.importNode(coll_list, true));
|
---|
[24988] | 78 | return page_response;
|
---|
[5265] | 79 |
|
---|
[24988] | 80 | }
|
---|
[5265] | 81 |
|
---|
[24988] | 82 | // else we have a query
|
---|
| 83 | String service_name = (String) params.get(GSParams.SERVICE);
|
---|
| 84 | if (service_name == null || service_name.equals(""))
|
---|
| 85 | {
|
---|
| 86 | service_name = "TextQuery";
|
---|
| 87 | }
|
---|
| 88 | String query_coll_list = (String) params.get(GSParams.COLLECTION);
|
---|
| 89 |
|
---|
| 90 | if (query_coll_list == null || query_coll_list.equals(""))
|
---|
| 91 | {
|
---|
| 92 | logger.error("no collections were specified!");
|
---|
[28382] | 93 | Element coll_list = getCollectionList(doc,userContext);
|
---|
| 94 | page_response.appendChild(doc.importNode(coll_list, true));
|
---|
[24988] | 95 | return page_response;
|
---|
| 96 | }
|
---|
| 97 |
|
---|
| 98 | // service paramList
|
---|
| 99 | HashMap service_params = (HashMap) params.get("s1");
|
---|
| 100 | if (service_params == null)
|
---|
| 101 | { // no query
|
---|
| 102 | return page_response;
|
---|
| 103 | }
|
---|
[28382] | 104 | Element query_param_list = doc.createElement(GSXML.PARAM_ELEM + GSXML.LIST_MODIFIER);
|
---|
[28964] | 105 | GSXML.addParametersToList(query_param_list, service_params);
|
---|
[24988] | 106 |
|
---|
| 107 | // we will do a query for each coll
|
---|
| 108 | String[] colls = query_coll_list.split(",");
|
---|
| 109 |
|
---|
[28382] | 110 | Element mr_query_message = doc.createElement(GSXML.MESSAGE_ELEM);
|
---|
[24988] | 111 |
|
---|
| 112 | for (int i = 0; i < colls.length; i++)
|
---|
| 113 | {
|
---|
| 114 | String to = GSPath.appendLink(colls[i], service_name);
|
---|
[28382] | 115 | Element mr_query_request = GSXML.createBasicRequest(doc, GSXML.REQUEST_TYPE_PROCESS, to, userContext);
|
---|
[24988] | 116 | mr_query_message.appendChild(mr_query_request);
|
---|
| 117 | mr_query_request.appendChild(query_param_list.cloneNode(true));
|
---|
| 118 |
|
---|
| 119 | }
|
---|
| 120 |
|
---|
| 121 | // do the query
|
---|
| 122 | Element mr_query_response = (Element) this.mr.process(mr_query_message);
|
---|
| 123 |
|
---|
| 124 | // get the Title metadata for each node - need Node title and root title
|
---|
[28382] | 125 | Element mr_meta_message = doc.createElement(GSXML.MESSAGE_ELEM);
|
---|
[24988] | 126 | NodeList responses = mr_query_response.getElementsByTagName(GSXML.RESPONSE_ELEM);
|
---|
| 127 | for (int j = 0; j < responses.getLength(); j++)
|
---|
| 128 | {
|
---|
| 129 | Element document_list = (Element) GSXML.getChildByTagName((Element) responses.item(j), GSXML.DOC_NODE_ELEM + GSXML.LIST_MODIFIER);
|
---|
| 130 | if (document_list != null)
|
---|
| 131 | {
|
---|
| 132 | String coll_name = extractCollName(((Element) responses.item(j)).getAttribute(GSXML.FROM_ATT));
|
---|
| 133 | String path = GSPath.appendLink(coll_name, "DocumentMetadataRetrieve");
|
---|
[28382] | 134 | Element mr_meta_request = GSXML.createBasicRequest(doc, GSXML.REQUEST_TYPE_PROCESS, path, userContext);
|
---|
[24988] | 135 | mr_meta_message.appendChild(mr_meta_request);
|
---|
[28382] | 136 | mr_meta_request.appendChild(doc.importNode(document_list, true));
|
---|
[24988] | 137 | // metadata params
|
---|
[28382] | 138 | Element param_list = doc.createElement(GSXML.PARAM_ELEM + GSXML.LIST_MODIFIER);
|
---|
| 139 | Element param = GSXML.createParameter(doc, "metadata", "Title");
|
---|
[24988] | 140 | param_list.appendChild(param);
|
---|
[28382] | 141 | param = GSXML.createParameter(doc, "metadata", "root_Title");
|
---|
[24988] | 142 | param_list.appendChild(param);
|
---|
| 143 | mr_meta_request.appendChild(param_list);
|
---|
| 144 |
|
---|
| 145 | }
|
---|
| 146 | }
|
---|
| 147 |
|
---|
| 148 | // do the request
|
---|
| 149 | Element mr_meta_response = (Element) this.mr.process(mr_meta_message);
|
---|
| 150 |
|
---|
| 151 | // the result
|
---|
[28382] | 152 | Element result_doc_list = doc.createElement(GSXML.DOC_NODE_ELEM + GSXML.LIST_MODIFIER);
|
---|
[24988] | 153 | page_response.appendChild(result_doc_list);
|
---|
| 154 |
|
---|
| 155 | responses = mr_meta_response.getElementsByTagName(GSXML.RESPONSE_ELEM);
|
---|
| 156 | for (int j = 0; j < responses.getLength(); j++)
|
---|
| 157 | {
|
---|
| 158 | Element document_list = (Element) GSXML.getChildByTagName((Element) responses.item(j), GSXML.DOC_NODE_ELEM + GSXML.LIST_MODIFIER);
|
---|
| 159 | String coll_name = extractCollName(((Element) responses.item(j)).getAttribute(GSXML.FROM_ATT));
|
---|
| 160 |
|
---|
| 161 | mergeDocLists(result_doc_list, document_list, coll_name);
|
---|
| 162 | }
|
---|
| 163 |
|
---|
| 164 | return page_response;
|
---|
[5265] | 165 | }
|
---|
| 166 |
|
---|
[24988] | 167 | protected String extractCollName(String path)
|
---|
| 168 | {
|
---|
| 169 | return GSPath.removeLastLink(path);
|
---|
[5265] | 170 | }
|
---|
[24988] | 171 |
|
---|
| 172 | protected void mergeDocLists(Element result_list, Element from_list, String collection)
|
---|
| 173 | {
|
---|
| 174 |
|
---|
| 175 | Document owner = result_list.getOwnerDocument();
|
---|
| 176 | Node child = from_list.getFirstChild();
|
---|
| 177 | while (child != null && child.getNodeType() == Node.ELEMENT_NODE)
|
---|
| 178 | {
|
---|
| 179 | ((Element) child).setAttribute("collection", collection);
|
---|
| 180 | result_list.appendChild(owner.importNode(child, true));
|
---|
| 181 | child = child.getNextSibling();
|
---|
| 182 | }
|
---|
| 183 |
|
---|
[5265] | 184 | }
|
---|
| 185 |
|
---|
[28382] | 186 | protected Element getCollectionList(Document doc, UserContext userContext)
|
---|
[24988] | 187 | {
|
---|
[5265] | 188 |
|
---|
[24988] | 189 | // first, get the message router info
|
---|
[28382] | 190 | Element coll_list_message = doc.createElement(GSXML.MESSAGE_ELEM);
|
---|
| 191 | Element coll_list_request = GSXML.createBasicRequest(doc, GSXML.REQUEST_TYPE_DESCRIBE, "", userContext);
|
---|
[24988] | 192 | coll_list_message.appendChild(coll_list_request);
|
---|
| 193 | Element coll_list_response = (Element) this.mr.process(coll_list_message);
|
---|
| 194 | if (coll_list_response == null)
|
---|
| 195 | {
|
---|
| 196 | logger.error("couldn't query the message router!");
|
---|
| 197 | return null;
|
---|
| 198 | }
|
---|
| 199 |
|
---|
| 200 | // second, get the display info for each collection
|
---|
| 201 | NodeList colls = coll_list_response.getElementsByTagName(GSXML.COLLECTION_ELEM);
|
---|
| 202 |
|
---|
[28382] | 203 | Element coll_param_list = doc.createElement(GSXML.PARAM_ELEM + GSXML.LIST_MODIFIER);
|
---|
| 204 | Element param = GSXML.createParameter(doc, GSXML.SUBSET_PARAM, GSXML.DISPLAY_TEXT_ELEM + GSXML.LIST_MODIFIER);
|
---|
[24988] | 205 | coll_param_list.appendChild(param);
|
---|
| 206 | // we will send all the requests in a single message
|
---|
[28382] | 207 | Element metadata_message = doc.createElement(GSXML.MESSAGE_ELEM);
|
---|
[24988] | 208 | for (int i = 0; i < colls.getLength(); i++)
|
---|
| 209 | {
|
---|
| 210 | Element c = (Element) colls.item(i);
|
---|
| 211 | String name = c.getAttribute(GSXML.NAME_ATT);
|
---|
| 212 |
|
---|
[28382] | 213 | Element metadata_request = GSXML.createBasicRequest(doc, GSXML.REQUEST_TYPE_DESCRIBE, name, userContext);
|
---|
[24988] | 214 | metadata_request.appendChild(coll_param_list.cloneNode(true));
|
---|
| 215 | metadata_message.appendChild(metadata_request);
|
---|
| 216 | }
|
---|
| 217 |
|
---|
| 218 | Element metadata_response = (Element) this.mr.process(metadata_message);
|
---|
| 219 |
|
---|
| 220 | NodeList coll_responses = metadata_response.getElementsByTagName(GSXML.RESPONSE_ELEM);
|
---|
| 221 | // check that have same number of responses as collections
|
---|
| 222 | if (colls.getLength() != coll_responses.getLength())
|
---|
| 223 | {
|
---|
| 224 | logger.error("didn't get a response for each collection - somethings gone wrong!");
|
---|
| 225 | // for now, dont use the metadata
|
---|
| 226 | }
|
---|
| 227 | else
|
---|
| 228 | {
|
---|
| 229 | for (int i = 0; i < colls.getLength(); i++)
|
---|
| 230 | {
|
---|
| 231 | Element c1 = (Element) colls.item(i);
|
---|
| 232 | Element c2 = (Element) coll_responses.item(i);
|
---|
| 233 | if (c1.getAttribute(GSXML.NAME_ATT).equals(c2.getAttribute(GSXML.FROM_ATT)))
|
---|
| 234 | {
|
---|
| 235 | //add the collection data into the original response
|
---|
| 236 | GSXML.mergeElements(c1, (Element) GSXML.getChildByTagName(c2, GSXML.COLLECTION_ELEM));
|
---|
| 237 | }
|
---|
| 238 | else
|
---|
| 239 | {
|
---|
| 240 | logger.error("response does not correspond to request!");
|
---|
| 241 | }
|
---|
| 242 |
|
---|
| 243 | }
|
---|
| 244 | }
|
---|
| 245 |
|
---|
| 246 | String path = GSPath.appendLink(GSXML.RESPONSE_ELEM, GSXML.COLLECTION_ELEM + GSXML.LIST_MODIFIER);
|
---|
| 247 | Element response = (Element) GSXML.getNodeByPath(coll_list_response, path);
|
---|
| 248 | return response;
|
---|
| 249 |
|
---|
| 250 | }
|
---|
[5265] | 251 | }
|
---|