[3340] | 1 | package org.greenstone.gsdl3.action;
|
---|
| 2 |
|
---|
| 3 | import org.greenstone.gsdl3.core.ModuleInterface;
|
---|
| 4 | import org.greenstone.gsdl3.util.*;
|
---|
| 5 | // XML classes
|
---|
[24867] | 6 | import org.w3c.dom.Node;
|
---|
| 7 | import org.w3c.dom.NodeList;
|
---|
| 8 | import org.w3c.dom.Element;
|
---|
| 9 | import org.w3c.dom.Document;
|
---|
[3340] | 10 |
|
---|
[3935] | 11 | // other java stuff
|
---|
| 12 | import java.io.File;
|
---|
[4257] | 13 | import java.util.Vector;
|
---|
[4695] | 14 | import java.util.HashMap;
|
---|
[4856] | 15 | import java.util.HashSet;
|
---|
| 16 | import java.util.Iterator;
|
---|
[4695] | 17 |
|
---|
[13124] | 18 | import org.apache.log4j.*;
|
---|
| 19 |
|
---|
[3568] | 20 | /** base class for Actions */
|
---|
[24867] | 21 | abstract public class Action
|
---|
| 22 | {
|
---|
| 23 | /** the system set up variables */
|
---|
| 24 | protected HashMap config_params = null;
|
---|
| 25 | /** container Document to create XML Nodes */
|
---|
| 26 | protected Document doc = null;
|
---|
| 27 | /** a converter class to parse XML and create Docs */
|
---|
| 28 | protected XMLConverter converter = null;
|
---|
| 29 | /**
|
---|
| 30 | * a reference to the message router that it must talk to to get info. it
|
---|
| 31 | * may be a communicator acting as a proxy, but it doesn't care about that
|
---|
| 32 | */
|
---|
| 33 | protected ModuleInterface mr = null;
|
---|
[3340] | 34 |
|
---|
[24867] | 35 | static Logger logger = Logger.getLogger(org.greenstone.gsdl3.action.Action.class.getName());
|
---|
[3340] | 36 |
|
---|
[24867] | 37 | public Action()
|
---|
| 38 | {
|
---|
| 39 | this.converter = new XMLConverter();
|
---|
| 40 | this.doc = this.converter.newDOM();
|
---|
| 41 | }
|
---|
[13124] | 42 |
|
---|
[24867] | 43 | /** the config variables must be set before configure is called */
|
---|
| 44 | public void setConfigParams(HashMap params)
|
---|
| 45 | {
|
---|
| 46 | this.config_params = params;
|
---|
| 47 | }
|
---|
[20402] | 48 |
|
---|
[24867] | 49 | /** sets the message router */
|
---|
| 50 | public void setMessageRouter(ModuleInterface m)
|
---|
| 51 | {
|
---|
| 52 | this.mr = m;
|
---|
| 53 | }
|
---|
[3893] | 54 |
|
---|
[24867] | 55 | public boolean configure()
|
---|
| 56 | {
|
---|
| 57 | // does nothing yet
|
---|
| 58 | return true;
|
---|
| 59 | }
|
---|
[4980] | 60 |
|
---|
[24867] | 61 | /**
|
---|
| 62 | * process takes an xml representation of cgi args and returns the page of
|
---|
| 63 | * results - may be in html/xml/other depending on the output att of the
|
---|
| 64 | * request
|
---|
| 65 | */
|
---|
| 66 | public String process(String xml_in)
|
---|
| 67 | {
|
---|
[6248] | 68 |
|
---|
[24867] | 69 | Document message_doc = this.converter.getDOM(xml_in);
|
---|
| 70 | if (message_doc == null)
|
---|
| 71 | {
|
---|
| 72 | logger.error("Couldn't parse request");
|
---|
| 73 | logger.error(xml_in);
|
---|
| 74 | return null;
|
---|
| 75 | }
|
---|
| 76 | Node result = process(message_doc);
|
---|
| 77 | return this.converter.getString(result);
|
---|
[24219] | 78 | }
|
---|
[24087] | 79 |
|
---|
[24867] | 80 | /** the main process method - must be implemented in subclass */
|
---|
| 81 | abstract public Node process(Node xml_in);
|
---|
[24087] | 82 |
|
---|
[24867] | 83 | /**
|
---|
| 84 | * tell the param class what its arguments are if an action has its own
|
---|
| 85 | * arguments, this should add them to the params object - particularly
|
---|
| 86 | * important for args that should not be saved
|
---|
| 87 | */
|
---|
| 88 | public boolean getActionParameters(GSParams params)
|
---|
| 89 | {
|
---|
| 90 | return true;
|
---|
| 91 | }
|
---|
[24087] | 92 |
|
---|
[24867] | 93 | protected void extractMetadataNames(Element format, HashSet meta_names)
|
---|
| 94 | {
|
---|
| 95 | //NodeList nodes = format.getElementsByTagNameNS("metadata", "http://www.greenstone.org/configformat");
|
---|
| 96 | NodeList metadata_nodes = format.getElementsByTagName("gsf:metadata");
|
---|
| 97 | for (int i = 0; i < metadata_nodes.getLength(); i++)
|
---|
| 98 | {
|
---|
| 99 | Element elem = (Element) metadata_nodes.item(i);
|
---|
| 100 | StringBuffer metadata = new StringBuffer();
|
---|
| 101 | String all = elem.getAttribute("multiple");
|
---|
| 102 | String name = elem.getAttribute("name");
|
---|
| 103 | String select = elem.getAttribute("select");
|
---|
| 104 | String sep = elem.getAttribute("separator");
|
---|
| 105 | if (all.equals("true"))
|
---|
| 106 | {
|
---|
| 107 | metadata.append("all");
|
---|
| 108 | metadata.append(GSConstants.META_RELATION_SEP);
|
---|
| 109 | }
|
---|
| 110 | if (!select.equals(""))
|
---|
| 111 | {
|
---|
| 112 | metadata.append(select);
|
---|
| 113 | metadata.append(GSConstants.META_RELATION_SEP);
|
---|
| 114 | }
|
---|
| 115 | if (!sep.equals(""))
|
---|
| 116 | {
|
---|
| 117 | metadata.append(GSConstants.META_SEPARATOR_SEP);
|
---|
| 118 | metadata.append(sep);
|
---|
| 119 | metadata.append(GSConstants.META_SEPARATOR_SEP);
|
---|
| 120 | metadata.append(GSConstants.META_RELATION_SEP);
|
---|
| 121 | }
|
---|
[24219] | 122 |
|
---|
[24867] | 123 | metadata.append(name);
|
---|
| 124 | meta_names.add(metadata.toString());
|
---|
| 125 | }
|
---|
[4856] | 126 |
|
---|
[24867] | 127 | // The XSL tranform for
|
---|
| 128 | // gsf:link type="source"
|
---|
| 129 | // makes use of 'assocfilepath' so need to make sure it's asked for
|
---|
[4856] | 130 |
|
---|
[24867] | 131 | NodeList link_nodes = format.getElementsByTagName("gsf:link");
|
---|
| 132 | for (int i = 0; i < link_nodes.getLength(); i++)
|
---|
| 133 | {
|
---|
| 134 | Element elem = (Element) link_nodes.item(i);
|
---|
| 135 | String type = elem.getAttribute("type");
|
---|
| 136 | if (type.equals("source"))
|
---|
| 137 | {
|
---|
| 138 | meta_names.add("assocfilepath");
|
---|
| 139 | meta_names.add("srclinkFile");
|
---|
| 140 | }
|
---|
| 141 | }
|
---|
[19984] | 142 |
|
---|
[24867] | 143 | // get all the metadata necessary for when the user has used "gsf:equivlink"
|
---|
| 144 | // so that we can build up the equivlink from the metadata components it needs
|
---|
| 145 | link_nodes = format.getElementsByTagName("gsf:equivlinkgs3");
|
---|
| 146 | if (link_nodes != null)
|
---|
| 147 | {
|
---|
[19984] | 148 |
|
---|
[24867] | 149 | String[] equivlink_metanames = { "equivDocIcon", "equivDocLink", "/equivDocLink" };
|
---|
[3340] | 150 |
|
---|
[24867] | 151 | for (int i = 0; i < equivlink_metanames.length; i++)
|
---|
| 152 | {
|
---|
| 153 | StringBuffer metadata = new StringBuffer();
|
---|
| 154 | metadata.append("all"); // this means the attr multiple = true;
|
---|
| 155 | metadata.append(GSConstants.META_RELATION_SEP);
|
---|
[3935] | 156 |
|
---|
[24867] | 157 | metadata.append(GSConstants.META_SEPARATOR_SEP);
|
---|
| 158 | metadata.append(','); // attr separator = ","
|
---|
| 159 | metadata.append(GSConstants.META_SEPARATOR_SEP);
|
---|
| 160 | metadata.append(GSConstants.META_RELATION_SEP);
|
---|
[3935] | 161 |
|
---|
[24867] | 162 | // the name of the metadata we're retrieving
|
---|
| 163 | metadata.append(equivlink_metanames[i]);
|
---|
| 164 | meta_names.add(metadata.toString());
|
---|
| 165 | }
|
---|
| 166 | }
|
---|
| 167 | }
|
---|
[3935] | 168 |
|
---|
[24867] | 169 | protected Element createMetadataParamList(HashSet metadata_names)
|
---|
| 170 | {
|
---|
| 171 | Element param_list = this.doc.createElement(GSXML.PARAM_ELEM + GSXML.LIST_MODIFIER);
|
---|
| 172 |
|
---|
| 173 | Element param = null;
|
---|
| 174 | Iterator i = metadata_names.iterator();
|
---|
| 175 | while (i.hasNext())
|
---|
| 176 | {
|
---|
| 177 | String name = (String) i.next();
|
---|
| 178 | param = this.doc.createElement(GSXML.PARAM_ELEM);
|
---|
| 179 | param_list.appendChild(param);
|
---|
| 180 | param.setAttribute(GSXML.NAME_ATT, "metadata");
|
---|
| 181 | param.setAttribute(GSXML.VALUE_ATT, name);
|
---|
| 182 |
|
---|
| 183 | }
|
---|
| 184 | return param_list;
|
---|
| 185 | }
|
---|
| 186 |
|
---|
| 187 | protected boolean processErrorElements(Element message, Element page)
|
---|
| 188 | {
|
---|
| 189 | NodeList error_nodes = message.getElementsByTagName(GSXML.ERROR_ELEM);
|
---|
| 190 | if (error_nodes.getLength() == 0)
|
---|
| 191 | {
|
---|
| 192 | return false;
|
---|
| 193 | }
|
---|
| 194 | Document owner = page.getOwnerDocument();
|
---|
| 195 | for (int i = 0; i < error_nodes.getLength(); i++)
|
---|
| 196 | {
|
---|
| 197 | page.appendChild(owner.importNode(error_nodes.item(i), true));
|
---|
| 198 | }
|
---|
| 199 | return true;
|
---|
| 200 | }
|
---|
| 201 |
|
---|
| 202 | /**
|
---|
| 203 | * Takes an XML element and adds the metadata of the current site to it.
|
---|
| 204 | * Useful for adding the current site's metadata to a response before
|
---|
| 205 | * sending it
|
---|
| 206 | *
|
---|
| 207 | * @param element
|
---|
| 208 | * the element to add site metadata to
|
---|
| 209 | * @param lang
|
---|
| 210 | * the current language
|
---|
| 211 | * @param uid
|
---|
| 212 | * the current user id
|
---|
| 213 | */
|
---|
| 214 | protected void addSiteMetadata(Element element, String lang, String uid)
|
---|
| 215 | {
|
---|
| 216 | //ADD SITE METADATA
|
---|
| 217 | Element metadata_request = GSXML.createBasicRequest(this.doc, GSXML.REQUEST_TYPE_DESCRIBE, "", lang, uid);
|
---|
| 218 | //create a hashmap of params
|
---|
| 219 | HashMap subset_params = new HashMap(1);
|
---|
| 220 | subset_params.put(GSXML.SUBSET_PARAM, GSXML.METADATA_ELEM + GSXML.LIST_MODIFIER);
|
---|
| 221 | //create the element to put the params in
|
---|
| 222 | Element param_list = this.doc.createElement(GSXML.PARAM_ELEM + GSXML.LIST_MODIFIER);
|
---|
| 223 | //put them in
|
---|
| 224 | GSXML.addParametersToList(this.doc, param_list, subset_params);
|
---|
| 225 | metadata_request.appendChild(param_list);
|
---|
| 226 | //create the message
|
---|
| 227 | Element metadata_message = this.doc.createElement(GSXML.MESSAGE_ELEM);
|
---|
| 228 | metadata_message.appendChild(metadata_request);
|
---|
| 229 | //get response
|
---|
| 230 | Element metadata_response_message = (Element) this.mr.process(metadata_message);
|
---|
| 231 | //drill down to response
|
---|
| 232 | Element metadata_response = (Element) GSXML.getChildByTagName(metadata_response_message, GSXML.RESPONSE_ELEM);
|
---|
| 233 | //merge in metadata
|
---|
| 234 | GSXML.mergeMetadataLists(element, metadata_response);
|
---|
| 235 | }
|
---|
| 236 |
|
---|
| 237 | }
|
---|