1 | package org.greenstone.gsdl3.action;
|
---|
2 |
|
---|
3 | import org.greenstone.gsdl3.core.ModuleInterface;
|
---|
4 | import org.greenstone.gsdl3.util.*;
|
---|
5 | // XML classes
|
---|
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;
|
---|
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;
|
---|
18 |
|
---|
19 | /** action class for queries */
|
---|
20 | public class QueryAction extends Action {
|
---|
21 |
|
---|
22 | /** process - processes a request.
|
---|
23 | */
|
---|
24 | public Element process (Element message) {
|
---|
25 |
|
---|
26 | // get the request - assume there is only one
|
---|
27 | Element request = (Element)GSXML.getChildByTagName(message, GSXML.REQUEST_ELEM);
|
---|
28 |
|
---|
29 | // create the return message
|
---|
30 | Element result = doc_.createElement(GSXML.MESSAGE_ELEM);
|
---|
31 | // for now we only have one type of query - subaction not used
|
---|
32 | Element response = basicQuery(request);
|
---|
33 | result.appendChild(doc_.importNode(response, true));
|
---|
34 | return result;
|
---|
35 | }
|
---|
36 |
|
---|
37 | /** a generic query handler
|
---|
38 | * this gets the service description, does the query (just passes all teh
|
---|
39 | * params to the service, then gets the titles for any results
|
---|
40 | */
|
---|
41 | protected Element basicQuery(Element request) {
|
---|
42 |
|
---|
43 | // the result
|
---|
44 | Element page_response = doc_.createElement(GSXML.RESPONSE_ELEM);
|
---|
45 |
|
---|
46 | // extract the params from the cgi-request, and check that we have a coll specified
|
---|
47 | Element cgi_param_list = (Element)GSXML.getChildByTagName(request, GSXML.PARAM_ELEM+GSXML.LIST_MODIFIER);
|
---|
48 | HashMap params = GSXML.extractParams(cgi_param_list, false);
|
---|
49 |
|
---|
50 | String request_type = (String)params.get(GSCGI.REQUEST_TYPE_ARG);
|
---|
51 | String service_name = (String)params.get(GSCGI.SERVICE_ARG);
|
---|
52 | String collection = (String)params.get(GSCGI.COLLECTION_ARG);
|
---|
53 |
|
---|
54 | if (collection == null || collection.equals("")) {
|
---|
55 | System.err.println("QueryAction Error: no collection was specified!");
|
---|
56 | return page_response; // an empty response
|
---|
57 | }
|
---|
58 |
|
---|
59 | String lang = request.getAttribute(GSXML.LANG_ATT);
|
---|
60 | String to = GSPath.appendLink(collection, service_name);
|
---|
61 |
|
---|
62 | // part of the response is the service description
|
---|
63 | // for now get this again from the service.
|
---|
64 | // this will probably need to be cached somehow later on.
|
---|
65 | Element mr_info_message = doc_.createElement(GSXML.MESSAGE_ELEM);
|
---|
66 | Element mr_info_request = GSXML.createBasicRequest(doc_, GSXML.REQUEST_TYPE_DESCRIBE, to, lang);
|
---|
67 | mr_info_message.appendChild(mr_info_request);
|
---|
68 |
|
---|
69 | // also get the format stuff now if there is some
|
---|
70 | Element format_request = GSXML.createBasicRequest(doc_, GSXML.REQUEST_TYPE_FORMAT, to, lang);
|
---|
71 | mr_info_message.appendChild(format_request);
|
---|
72 |
|
---|
73 | // process the messages
|
---|
74 | Element mr_info_response = (Element) mr_.process(mr_info_message);
|
---|
75 |
|
---|
76 | // the two responses
|
---|
77 | NodeList responses = mr_info_response.getElementsByTagName(GSXML.RESPONSE_ELEM);
|
---|
78 | Element service_response = (Element)responses.item(0);
|
---|
79 | Element format_response = (Element)responses.item(1);
|
---|
80 |
|
---|
81 | Element service_description = (Element)doc_.importNode(GSXML.getChildByTagName(service_response, GSXML.SERVICE_ELEM), true);
|
---|
82 | page_response.appendChild(service_description);
|
---|
83 |
|
---|
84 | if (request_type.equals("d")) {// just a display request
|
---|
85 | return page_response;
|
---|
86 | }
|
---|
87 |
|
---|
88 | HashSet metadata_names = new HashSet();
|
---|
89 | // add in the default elements
|
---|
90 | metadata_names.add("Title");
|
---|
91 | // add in the format info to the stylesheet if there is any
|
---|
92 | Element format_elem = (Element)GSXML.getChildByTagName(format_response, GSXML.FORMAT_ELEM);
|
---|
93 | if (format_elem != null) {
|
---|
94 | ///ystem.out.println("QueryAction: found a format element, adding it to the page response");
|
---|
95 | // set teh format type
|
---|
96 | format_elem.setAttribute(GSXML.TYPE_ATT, "search");
|
---|
97 | // for now just add to the response
|
---|
98 | page_response.appendChild(doc_.importNode(format_elem, true));
|
---|
99 | extractMetadataNames(format_elem, metadata_names);
|
---|
100 | }
|
---|
101 |
|
---|
102 |
|
---|
103 | // do the query
|
---|
104 | Element mr_query_message = doc_.createElement(GSXML.MESSAGE_ELEM);
|
---|
105 | Element mr_query_request = GSXML.createBasicRequest(doc_, GSXML.REQUEST_TYPE_PROCESS, to, lang);
|
---|
106 | mr_query_message.appendChild(mr_query_request);
|
---|
107 |
|
---|
108 | // paramList
|
---|
109 | Element query_param_list = (Element)doc_.importNode(cgi_param_list, true);
|
---|
110 | mr_query_request.appendChild(query_param_list);
|
---|
111 |
|
---|
112 | // do the query
|
---|
113 | Element mr_query_response = (Element)mr_.process(mr_query_message);
|
---|
114 |
|
---|
115 | String path = GSPath.appendLink(GSXML.RESPONSE_ELEM, GSXML.METADATA_ELEM+GSXML.LIST_MODIFIER);
|
---|
116 | Element query_result_metadata_list = (Element) GSXML.getNodeByPath(mr_query_response, path);
|
---|
117 | if (query_result_metadata_list == null) {
|
---|
118 | System.err.println("QueryAction: Warning: No query result metadata.\n");
|
---|
119 | } else { // add it into the page response
|
---|
120 | page_response.appendChild(doc_.importNode(query_result_metadata_list, true));
|
---|
121 | }
|
---|
122 |
|
---|
123 | path = GSPath.appendLink(GSXML.RESPONSE_ELEM, GSXML.TERM_ELEM+GSXML.LIST_MODIFIER);
|
---|
124 | Element query_term_info_list = (Element) GSXML.getNodeByPath(mr_query_response, path);
|
---|
125 | if (query_term_info_list == null) {
|
---|
126 | System.err.println("QueryAction: Warning: No query term information.\n");
|
---|
127 | } else { // add it into the page response
|
---|
128 | page_response.appendChild(doc_.importNode(query_term_info_list, true));
|
---|
129 | }
|
---|
130 |
|
---|
131 | // check that there are some documents - for now check the list, but later should use a numdocs metadata elem
|
---|
132 | path = GSPath.appendLink(GSXML.RESPONSE_ELEM, GSXML.DOC_NODE_ELEM+GSXML.LIST_MODIFIER);
|
---|
133 |
|
---|
134 | Element document_list = (Element)GSXML.getNodeByPath(mr_query_response,
|
---|
135 | path);
|
---|
136 | // documentList not present if no docs found
|
---|
137 | if (document_list == null) {
|
---|
138 | return page_response;
|
---|
139 | }
|
---|
140 |
|
---|
141 | // do the metadata request
|
---|
142 | Element mr_metadata_message = doc_.createElement(GSXML.MESSAGE_ELEM);
|
---|
143 | Element mr_metadata_request = doc_.createElement(GSXML.REQUEST_ELEM);
|
---|
144 | mr_metadata_message.appendChild(mr_metadata_request);
|
---|
145 |
|
---|
146 | mr_metadata_request.setAttribute(GSXML.TYPE_ATT, GSXML.REQUEST_TYPE_PROCESS);
|
---|
147 | mr_metadata_request.setAttribute(GSXML.LANG_ATT, lang);
|
---|
148 | to = GSPath.appendLink(collection, "DocumentMetadataRetrieve"); // Hard-wired?
|
---|
149 | mr_metadata_request.setAttribute(GSXML.TO_ATT, to);
|
---|
150 |
|
---|
151 | // just get all for now - the receptionist should perhaps pass in some
|
---|
152 | // metadata that it wants, and QueryAction should look through the format stuff to see if there is any other?
|
---|
153 |
|
---|
154 | Element dm_param_list = createMetadataParamList(metadata_names);
|
---|
155 |
|
---|
156 | mr_metadata_request.appendChild(dm_param_list);
|
---|
157 |
|
---|
158 |
|
---|
159 | // add in the doc node list too
|
---|
160 | mr_metadata_request.appendChild(doc_.importNode(document_list, true));
|
---|
161 | Element mr_metadata_response = (Element) mr_.process(mr_metadata_message);
|
---|
162 |
|
---|
163 | path = GSPath.appendLink(GSXML.RESPONSE_ELEM, GSXML.DOC_NODE_ELEM+GSXML.LIST_MODIFIER);
|
---|
164 | Element query_result_document_list = (Element) GSXML.getNodeByPath(mr_metadata_response, path);
|
---|
165 |
|
---|
166 | if (query_result_document_list != null) {
|
---|
167 | page_response.appendChild(doc_.importNode(query_result_document_list, true));
|
---|
168 | }
|
---|
169 |
|
---|
170 | // System.out.println("Query page:\n" + converter_.getPrettyString(page_response));
|
---|
171 | return page_response;
|
---|
172 | }
|
---|
173 | }
|
---|