Changeset 25717


Ignore:
Timestamp:
2012-05-30T15:34:25+12:00 (12 years ago)
Author:
sjm84
Message:

Added a BaseGreenstoneServlet servlet that the other servlets now inherit from so that we can be sure that GlobalProperties is properly initialised. There is also some reformatting and import cleaning

Location:
main/trunk/greenstone3/src/java/org/greenstone
Files:
1 added
7 edited

Legend:

Unmodified
Added
Removed

  • main/trunk/greenstone3/src/java/org/greenstone/gsdl3/ClientSideServlet.java

    r23789 r25717  
    11package org.greenstone.gsdl3;
    22
    3 import org.apache.log4j.*; // Actually add logging?
     3import java.io.File;
     4import java.io.IOException;
     5import java.io.PrintWriter;
     6
     7import javax.servlet.ServletConfig;
     8import javax.servlet.ServletException;
     9import javax.servlet.http.HttpServletRequest;
     10import javax.servlet.http.HttpServletResponse;
     11
    412import org.apache.commons.lang3.StringUtils;
     13import org.greenstone.gsdl3.util.Dictionary;
    514import org.greenstone.gsdl3.util.XSLTUtil;
    6 import java.io.*;
    7 import javax.servlet.*;
    8 import javax.servlet.http.*;
    9 import org.greenstone.gsdl3.util.Dictionary;
    10 import java.util.Enumeration;
    1115
    12 public class ClientSideServlet extends HttpServlet {
    13    
    14 public void init(ServletConfig config) throws ServletException {
    15     super.init(config);
    16 }   
    17    
    18 public void doGet(HttpServletRequest request, HttpServletResponse response) throws ServletException, IOException {   
    19    
    20    String query_string = request.getQueryString();
    21    PrintWriter w = response.getWriter();
     16public class ClientSideServlet extends BaseGreenstoneServlet
     17{
     18    public void init(ServletConfig config) throws ServletException
     19    {
     20        super.init(config);
     21    }
    2222
    23     if(query_string == null)
    24         displayParamError(response);
    25    
     23    public void doGet(HttpServletRequest request, HttpServletResponse response) throws ServletException, IOException
     24    {
     25        String query_string = request.getQueryString();
     26        PrintWriter w = response.getWriter();
     27
     28        if (query_string == null)
     29            displayParamError(response);
     30
    2631        String[] parts = StringUtils.split(query_string, "&");
    27    
     32
    2833        String[] keys = null; // Array of keys to look up
    2934        String lang = "";
    30         String interface_name = ""; 
    31         String command = "";   
     35        String interface_name = "";
     36        String command = "";
    3237        String params = "";
    33        
    34         for(String part : parts) {     
    35        
     38
     39        for (String part : parts)
     40        {
     41
    3642            String[] nameval = StringUtils.split(part, '=');
    3743
    38             if(nameval.length != 2) {
     44            if (nameval.length != 2)
     45            {
    3946                displayParamError(response);
    4047                return;
    41             }           
    42            
     48            }
     49
    4350            String name = nameval[0];
    4451            String value = nameval[1];
    45            
    46             if(name.equals("k"))
     52
     53            if (name.equals("k"))
    4754                keys = StringUtils.split(value, ",");
    48             else if(name.equals("l"))
     55            else if (name.equals("l"))
    4956                lang = value;
    50             else if(name.equals("i"))
     57            else if (name.equals("i"))
    5158                interface_name = value;
    52             else if(name.equals("c"))
     59            else if (name.equals("c"))
    5360                // Alternative commands
    5461                command = value;
    55             else if(name.equals("p"))
     62            else if (name.equals("p"))
    5663                params = value;
    5764        }
    58        
    59         if(keys == null && command.equals("") && params.equals("")) {
     65
     66        if (keys == null && command.equals("") && params.equals(""))
     67        {
    6068            // Not satisfiable
    6169            displayParamError(response);
    62             return; 
     70            return;
    6371        }
    64        
     72
    6573        String bundle = "<?xml version=\"1.0\" encoding=\"iso-8859-1\" ?>\r\n<textBundle>\r\n";
    66        
    67         if(!command.equals("") && !params.equals("")) {
    68        
     74
     75        if (!command.equals("") && !params.equals(""))
     76        {
     77
    6978            // Alternative commands other than dictionary lookup
    70             String[] parameters = StringUtils.split(params, "|");           
    71             String result = null;       
    72            
    73             if(command.equals("getNumberedItem") && parameters.length == 2) {
     79            String[] parameters = StringUtils.split(params, "|");
     80            String result = null;
     81
     82            if (command.equals("getNumberedItem") && parameters.length == 2)
     83            {
    7484                result = XSLTUtil.getNumberedItem(parameters[0], Integer.parseInt(parameters[1]));
    75             } else if(command.equals("exists") && parameters.length == 2) {
     85            }
     86            else if (command.equals("exists") && parameters.length == 2)
     87            {
    7688                result = XSLTUtil.exists(parameters[0], parameters[1]) ? "true" : "false";
    77             } else if(command.equals("isImage") && parameters.length == 1) {
    78                 result = (XSLTUtil.isImage(parameters[0])) ? "true" : "false"; 
    7989            }
    80            
    81             if(result != null) {
     90            else if (command.equals("isImage") && parameters.length == 1)
     91            {
     92                result = (XSLTUtil.isImage(parameters[0])) ? "true" : "false";
     93            }
     94
     95            if (result != null)
     96            {
    8297                bundle += " <method name=\"" + command + "\" parameters=\"" + params + "\" return=\"" + result + "\" />\r\n";
    83             } else { displayParamError(response); return; }
    84         } else {
    85        
    86         for(String key : keys) {
    87        
    88             String original_key = key;
    89             String[] theParts = StringUtils.split(key, "|");
    90             String[] args = null;
    91            
    92             if(theParts.length > 1)
    93                 args = StringUtils.split(theParts[1], ";");
    94        
    95             key = theParts[0];
    96        
    97             // Straight from XSLTUtils.java (src), with some modifications
    98             if(key.equals("null")) {
    99                 bundle += " <item key=\"" + key + "\" value=\"\" />\r\n";
    100                 continue;
    10198            }
    102                
    103             Dictionary dict = new Dictionary("interface_"+interface_name, lang);
    104             String result = dict.get(key, args);
    105            
    106             if (result == null) {
    107                 String sep_interface_dir = interface_name + File.separatorChar + lang + File.separatorChar + "interface";
    108                 dict = new Dictionary(sep_interface_dir, lang);
    109                 result = dict.get(key, args); 
    110              }
     99            else
     100            {
     101                displayParamError(response);
     102                return;
     103            }
     104        }
     105        else
     106        {
    111107
    112             if (result == null && !interface_name.equals("default")) { // not found, try the default interface
    113                 dict = new Dictionary("interface_default", lang);
    114                 result = dict.get(key, args);
     108            for (String key : keys)
     109            {
     110
     111                String original_key = key;
     112                String[] theParts = StringUtils.split(key, "|");
     113                String[] args = null;
     114
     115                if (theParts.length > 1)
     116                    args = StringUtils.split(theParts[1], ";");
     117
     118                key = theParts[0];
     119
     120                // Straight from XSLTUtils.java (src), with some modifications
     121                if (key.equals("null"))
     122                {
     123                    bundle += " <item key=\"" + key + "\" value=\"\" />\r\n";
     124                    continue;
     125                }
     126
     127                Dictionary dict = new Dictionary("interface_" + interface_name, lang);
     128                String result = dict.get(key, args);
     129
     130                if (result == null)
     131                {
     132                    String sep_interface_dir = interface_name + File.separatorChar + lang + File.separatorChar + "interface";
     133                    dict = new Dictionary(sep_interface_dir, lang);
     134                    result = dict.get(key, args);
     135                }
     136
     137                if (result == null && !interface_name.equals("default"))
     138                { // not found, try the default interface
     139                    dict = new Dictionary("interface_default", lang);
     140                    result = dict.get(key, args);
     141                }
     142
     143                if (result == null)
     144                { // not found
     145                    result = "_" + original_key + "_";
     146                }
     147
     148                bundle += " <item key=\"" + encode(original_key) + "\" value=\"" + encode(result) + "\" />\r\n";
    115149            }
    116                
    117             if (result == null) { // not found
    118                 result = "_" + original_key + "_";
    119             }
     150        }
    120151
    121             bundle += " <item key=\"" + encode(original_key) + "\" value=\"" + encode(result) + "\" />\r\n";
    122         } }
    123        
    124152        bundle += "</textBundle>";
    125        
    126         response.setContentType("text/xml");           
     153
     154        response.setContentType("text/xml");
    127155
    128156        w.print(bundle);
    129157        w.close();
     158    }
     159
     160    private String encode(String s)
     161    {
     162        s = StringUtils.replace(s, "&", "&amp;");
     163        s = StringUtils.replace(s, "<", "&lt;");
     164        s = StringUtils.replace(s, ">", "&gt;");
     165        return s;
     166    }
     167
     168    private void displayParamError(HttpServletResponse response)
     169    {
     170
     171        try
     172        {
     173            PrintWriter w = response.getWriter();
     174            w.write("Invalid parameters supplied! Need key (k=), interface name (i=) and language (l=). If you specified a method call, it must be on the list of supported method calls, and you must specify a command (c=) and parameters (p=).");
     175            w.close();
     176        }
     177        catch (Exception ex)
     178        { /* Should log here */
     179        }
     180
     181    }
     182
    130183}
    131 
    132 private String encode(String s) {
    133     s = StringUtils.replace(s, "&", "&amp;");
    134     s = StringUtils.replace(s, "<", "&lt;");
    135     s = StringUtils.replace(s, ">", "&gt;");
    136     return s;
    137 }
    138 
    139 private void displayParamError(HttpServletResponse response) {
    140 
    141     try {
    142     PrintWriter w = response.getWriter();
    143     w.write("Invalid parameters supplied! Need key (k=), interface name (i=) and language (l=). If you specified a method call, it must be on the list of supported method calls, and you must specify a command (c=) and parameters (p=).");
    144     w.close();
    145     } catch (Exception ex) { /* Should log here */ }
    146    
    147 }
    148    
    149 }

  • main/trunk/greenstone3/src/java/org/greenstone/gsdl3/FileLoaderServlet.java

    r25061 r25717  
    11package org.greenstone.gsdl3;
    22
    3 import java.io.*;
     3import java.io.File;
     4import java.io.FileInputStream;
     5import java.io.FileOutputStream;
     6import java.io.IOException;
     7import java.io.PrintWriter;
    48import java.nio.channels.FileChannel;
    59import java.util.Iterator;
    … …  
    711import java.util.Map;
    812
    9 import javax.servlet.*;
    10 import javax.servlet.http.*;
     13import javax.servlet.ServletException;
     14import javax.servlet.ServletOutputStream;
     15import javax.servlet.http.HttpServletRequest;
     16import javax.servlet.http.HttpServletResponse;
    1117
    1218import org.apache.commons.fileupload.FileItem;
    … …  
    4854                            storageLocation = current.getString();
    4955                        }
    50                        
     56
    5157                        if (current.getFieldName().equals("ajaxUpload") && current.getString().equals("true"))
    5258                        {
    … …  
    6571
    6672                        uploadedFile = file;
    67                        
    68                         if(!json.toString().equals("["))
     73
     74                        if (!json.toString().equals("["))
    6975                        {
    7076                            json.append(",");
    7177                        }
    72                        
     78
    7379                        json.append("{");
    7480                        json.append("\"name\":\"" + file.getName() + "\",");
    … …  
    8288                }
    8389                json.append("]");
    84                
    85                 if(ajaxUpload)
     90
     91                if (ajaxUpload)
    8692                {
    8793                    response.setContentType("application/json");
    … …  
    8995                    writer.write(json.toString());
    9096                    writer.flush();
    91                    
     97
    9298                    return;
    9399                }
    … …  
    141147            Map<String, String[]> queryMap = request.getParameterMap();
    142148            Iterator<String> queryIter = queryMap.keySet().iterator();
    143            
    144             while(queryIter.hasNext())
     149
     150            while (queryIter.hasNext())
    145151            {
    146152                String q = queryIter.next();
    … …  
    149155                    String fileLocation = queryMap.get(q)[0];
    150156                    File fileToGet = new File(GlobalProperties.getGSDL3Home() + File.separator + fileLocation);
    151    
     157
    152158                    if (fileToGet.exists())
    153159                    {
    154160                        response.setContentType("application/octet-stream");
    155                         response.addHeader("Content-Disposition","attachment;filename=" + fileToGet.getName());
     161                        response.addHeader("Content-Disposition", "attachment;filename=" + fileToGet.getName());
    156162                        FileInputStream fis = new FileInputStream(fileToGet);
    157163                        ServletOutputStream sos = response.getOutputStream();
    158    
     164
    159165                        byte[] buffer = new byte[4096];
    160166                        int len;
    … …  
    166172                        fis.close();
    167173                        sos.close();
    168                        
     174
    169175                        return;
    170176                    }

  • main/trunk/greenstone3/src/java/org/greenstone/gsdl3/LibraryServlet.java

    r25635 r25717  
    11package org.greenstone.gsdl3;
    22
    3 import org.greenstone.gsdl3.comms.*;
    4 import org.greenstone.gsdl3.core.*;
     3import java.io.IOException;
     4import java.io.PrintWriter;
     5import java.io.Serializable;
     6import java.lang.reflect.Type;
     7import java.util.ArrayList;
     8import java.util.Enumeration;
     9import java.util.HashMap;
     10import java.util.Hashtable;
     11import java.util.Iterator;
     12import java.util.List;
     13import java.util.Map;
     14
     15import javax.servlet.ServletConfig;
     16import javax.servlet.ServletException;
     17import javax.servlet.http.Cookie;
     18import javax.servlet.http.HttpServletRequest;
     19import javax.servlet.http.HttpServletResponse;
     20import javax.servlet.http.HttpSession;
     21import javax.servlet.http.HttpSessionBindingEvent;
     22import javax.servlet.http.HttpSessionBindingListener;
     23
     24import org.apache.commons.lang3.StringUtils;
     25import org.apache.log4j.Logger;
     26import org.greenstone.gsdl3.action.PageAction;
     27import org.greenstone.gsdl3.comms.Communicator;
     28import org.greenstone.gsdl3.comms.SOAPCommunicator;
     29import org.greenstone.gsdl3.core.DefaultReceptionist;
     30import org.greenstone.gsdl3.core.MessageRouter;
     31import org.greenstone.gsdl3.core.Receptionist;
    532import org.greenstone.gsdl3.service.Authentication;
    6 import org.greenstone.gsdl3.util.*;
    7 import org.greenstone.gsdl3.action.PageAction; // used to get the default action
     33import org.greenstone.gsdl3.util.GSConstants;
     34import org.greenstone.gsdl3.util.GSParams;
     35import org.greenstone.gsdl3.util.GSXML;
     36import org.greenstone.gsdl3.util.UserContext;
     37import org.greenstone.gsdl3.util.XMLConverter;
    838import org.w3c.dom.Document;
    939import org.w3c.dom.Element;
    1040import org.w3c.dom.Node;
    1141import org.w3c.dom.NodeList;
    12 import java.io.*;
    13 
    14 import javax.servlet.*;
    15 import javax.servlet.http.*;
    16 
    17 import java.util.Enumeration;
    18 import java.util.ArrayList;
    19 import java.util.HashMap;
    20 import java.util.Iterator;
    21 import java.util.List;
    22 import java.util.Map;
    23 import java.lang.reflect.Type;
    24 import java.util.Hashtable;
    25 import org.apache.log4j.*;
    2642
    2743import com.google.gson.Gson;
    2844import com.google.gson.reflect.TypeToken;
    29 
    30 // Apache Commons
    31 import org.apache.commons.lang3.*;
    3245
    3346/**
    … …  
    4558 * @see Receptionist
    4659 */
    47 public class LibraryServlet extends HttpServlet
     60public class LibraryServlet extends BaseGreenstoneServlet
    4861{
    49 
    5062    /** the receptionist to send messages to */
    5163    protected Receptionist recept = null;
    … …  
    110122
    111123        String library_name = config.getInitParameter(GSConstants.LIBRARY_NAME);
    112         String gsdl3_home = config.getInitParameter(GSConstants.GSDL3_HOME);
    113124        String interface_name = config.getInitParameter(GSConstants.INTERFACE_NAME);
    114125

  • main/trunk/greenstone3/src/java/org/greenstone/gsdl3/OAIServer.java

    r25635 r25717  
    1919package org.greenstone.gsdl3;
    2020
    21 import org.greenstone.gsdl3.comms.*;
    22 import org.greenstone.gsdl3.core.*;
    23 import org.greenstone.gsdl3.util.*;
    24 import org.greenstone.gsdl3.action.PageAction; // used to get the default action
    25 import org.w3c.dom.*;
    26 import java.io.*;
    27 import javax.servlet.*;
    28 import javax.servlet.http.*;
    29 import java.util.Enumeration;
     21import java.io.IOException;
     22import java.io.PrintWriter;
    3023import java.util.HashSet;
    3124import java.util.Iterator;
    3225import java.util.Map;
    33 import java.util.Map.Entry;
    34 import java.io.File;
    35 
    36 import org.apache.log4j.*;
     26
     27import javax.servlet.ServletConfig;
     28import javax.servlet.ServletException;
     29import javax.servlet.http.HttpServletRequest;
     30import javax.servlet.http.HttpServletResponse;
     31
     32import org.apache.log4j.Logger;
     33import org.greenstone.gsdl3.comms.Communicator;
     34import org.greenstone.gsdl3.comms.SOAPCommunicator;
     35import org.greenstone.gsdl3.core.MessageRouter;
     36import org.greenstone.gsdl3.core.OAIReceptionist;
     37import org.greenstone.gsdl3.util.GSConstants;
     38import org.greenstone.gsdl3.util.GSParams;
     39import org.greenstone.gsdl3.util.GSXML;
     40import org.greenstone.gsdl3.util.OAIXML;
     41import org.greenstone.gsdl3.util.XMLConverter;
     42import org.w3c.dom.Document;
     43import org.w3c.dom.Element;
     44import org.w3c.dom.Node;
    3745
    3846/** a servlet to serve the OAI metadata harvesting - we are using servlets instead
    … …  
    4856/**
    4957 * OAI server configuration instructions *
    50  *
     58 * 
    5159 */
    52 public class OAIServer extends HttpServlet {
    53  
    54   /** the receptionist to send messages to */
    55   protected OAIReceptionist recept=null;
    56   /** the default language - is specified by setting a servlet param,
    57    * otherwise DEFAULT_LANG is used*/
    58   protected String default_lang= null;
    59   /** The default default - used if a default lang is not specified
    60    * in the servlet params */
    61   protected final String DEFAULT_LANG = "en";
    62 
    63   /** a converter class to parse XML and create Docs
    64    * This is only used for generating internal requests passed to MessageRouter.
    65    * The response message is generated by parsing an existing xml skeleton file (web/WEB-INF/oaixml/oaiversion2.xml, for example).
    66    */
    67   protected XMLConverter converter=null;
    68   /** container Document to create XML Nodes (but only request to the oai receptionist,
    69    *  not response (which is created in OAIXML.java) created by converter class */
    70   protected Document doc=null;
    71  
    72   /** A HashSet which contains all the legal verbs. */
    73   protected HashSet<String> verb_set = null;
    74   /** A HashSet which contains all the legal oai keys in the key/value argument pair. */
    75   protected HashSet<String> param_set = null;
    76   /** The name of the site with which we will finally be dealing, whether it is a local site or a remote site through a communicator.*/
    77   protected String site = "";
    78  
    79   // do we output the stylesheet processing instruction?
    80   protected boolean use_oai_stylesheet = true;
    81   protected String oai_stylesheet = "interfaces/oai/oai2.xsl";
    82 
    83     // there is no getQueryString() method in the HttpServletRequest returned from doPost,
    84     // since that is actually of type apache RequestFacade, and doesn't define such a method
    85     protected String queryString = null;
    86 
    87   static Logger logger = Logger.getLogger(org.greenstone.gsdl3.OAIServer.class.getName());
    88  
    89   /** initialise the servlet
    90    */
    91   public void init(ServletConfig config) throws ServletException {
    92     // always call super.init, i.e., HttpServlet.;
    93     super.init(config);
    94     this.default_lang = config.getInitParameter(GSConstants.DEFAULT_LANG);
    95    
    96     initVerbs();
    97     initParams();
    98    
    99     String site_name = config.getInitParameter(GSConstants.SITE_NAME);
    100     String remote_site_name = null;
    101     String remote_site_type = null;
    102     String remote_site_address = null;
    103    
    104     if (site_name == null) {
    105       // no local site, try for communicator (remote site)
    106       remote_site_name = config.getInitParameter("remote_site_name");
    107       remote_site_type = config.getInitParameter("remote_site_type");
    108       remote_site_address = config.getInitParameter("remote_site_address");
    109       if (remote_site_name == null || remote_site_type == null || remote_site_address == null) {
    110         System.err.println("initialisation paramters not all set!");
    111         System.err.println("if site_name is not set, then you must have remote_site_name, remote_site_type and remote_site_address set");
    112         System.exit(1);
    113       }
    114     }
    115    
    116     if (this.default_lang == null) {
    117       // choose english
    118       this.default_lang = DEFAULT_LANG;
    119     }
    120    
    121     // the receptionist -the servlet will talk to this
    122     this.recept = new OAIReceptionist();
    123    
    124     // the receptionist uses a MessageRouter or Communicator to send its requests to. We either create a MessageRouter here for the designated site (if site_name set), or we create a Communicator for a remote site. The is given to teh Receptionist, and the servlet never talks to it again.directly.
    125     if (site_name != null) {
    126       //this site_name could consist of comma separated more than one site name.
    127       String mr_name = (String)config.getInitParameter("messagerouter_class");
    128       MessageRouter message_router = null;
    129       if (mr_name == null) { // just use the normal MR *********
    130         message_router = new MessageRouter();
    131       } else { // try the specified one
    132         try {
    133           message_router = (MessageRouter)Class.forName("org.greenstone.gsdl3.core."+mr_name).newInstance();
    134         } catch (Exception e) { // cant use this new one, so use normal one
    135           System.err.println("OAIServlet configure exception when trying to use a new MessageRouter "+mr_name+": "+e.getMessage());
    136           e.printStackTrace();
    137           message_router = new MessageRouter();
    138         }
    139       }
    140      
    141       message_router.setSiteName(site_name);
    142       // lots of work is done in this step; see MessageRouter.java
    143       message_router.configure();
    144       this.recept.setSiteName(site_name);
    145       this.recept.setMessageRouter(message_router);
    146      
    147     } else {     
    148       // talking to a remote site, create a communicator
    149       Communicator communicator = null;
    150       // we need to create the XML to configure the communicator
    151       Element site_elem = this.doc.createElement(GSXML.SITE_ELEM);
    152       site_elem.setAttribute(GSXML.TYPE_ATT, remote_site_type);
    153       site_elem.setAttribute(GSXML.NAME_ATT, remote_site_name);
    154       site_elem.setAttribute(GSXML.ADDRESS_ATT, remote_site_address);
    155      
    156       if (remote_site_type.equals(GSXML.COMM_TYPE_SOAP_JAVA)) {
    157         communicator = new SOAPCommunicator();
    158       } else {
    159         System.err.println("OAIServlet.init Error: invalid Communicator type: "+remote_site_type);
    160         System.exit(1);
    161       }
    162      
    163       if (!communicator.configure(site_elem)) {
    164         System.err.println("OAIServlet.init Error: Couldn't configure communicator");
    165         System.exit(1);
    166       }
    167       this.recept.setSiteName(remote_site_name);
    168       this.recept.setMessageRouter(communicator);
    169     }
    170     // used for composing internal xml requests, but not xml responses.
    171     // the converter may be used to get pretty xml, though.   
    172     this.converter = new XMLConverter();
    173     this.doc = this.converter.newDOM();
    174 
    175     // Read in OAIConfig.xml (residing web/WEB-INF/classes/) and
    176     //use it to configure the receptionist. The init() is also called in which
    177     //the resumption token file is read in and all expired tokens cleared.
    178     Element oai_config = OAIXML.getOAIConfigXML();
    179       if (oai_config == null) {
    180         logger.error("Fail to parse oai config file OAIConfig.xml.");
    181         return;
    182       }   
    183     // pass it to the receptionist
    184     this.recept.configure(oai_config);
    185    
    186     // also, we have something we want to get from here - useOAIStylesheet
    187     this.configure(oai_config);
    188   }//end of init()
    189  
    190   private void configure(Element oai_config) {
    191     Element use_stylesheet_elem = (Element)GSXML.getChildByTagName(oai_config, OAIXML.USE_STYLESHEET);
    192     if (use_stylesheet_elem != null) {
    193       String value = GSXML.getNodeText(use_stylesheet_elem);
    194       if (value.equals("no")) {
    195     this.use_oai_stylesheet = false;
    196       }
    197     }
    198     if (this.use_oai_stylesheet) {
    199       // now see if there is a custom stylesheet specified
    200       Element stylesheet_elem = (Element)GSXML.getChildByTagName(oai_config, OAIXML.STYLESHEET);
    201       if (stylesheet_elem != null) {
    202     String value = GSXML.getNodeText(stylesheet_elem);
    203     if (!value.equals("")) {
    204       oai_stylesheet = value;
    205     }
    206       }
    207      
    208     }
    209   }
    210   private void initVerbs() {
    211     verb_set = new HashSet<String>();
    212     verb_set.add(OAIXML.GET_RECORD);
    213     verb_set.add(OAIXML.LIST_RECORDS);
    214     verb_set.add(OAIXML.LIST_IDENTIFIERS);
    215     verb_set.add(OAIXML.LIST_SETS);
    216     verb_set.add(OAIXML.LIST_METADATA_FORMATS);
    217     verb_set.add(OAIXML.IDENTIFY);
    218   }
    219  
    220   private void initParams() {
    221     param_set = new HashSet<String>();
    222     param_set.add(OAIXML.METADATA_PREFIX);
    223     param_set.add(OAIXML.FROM);
    224     param_set.add(OAIXML.UNTIL);
    225     param_set.add(OAIXML.SET);
    226     param_set.add(OAIXML.RESUMPTION_TOKEN);
    227     param_set.add(OAIXML.IDENTIFIER);
    228   }
    229   private void logUsageInfo(HttpServletRequest request){
    230     String usageInfo = "";
    231    
    232     String query = (queryString == null) ? request.getQueryString() : queryString;
    233 
    234     //logged info = general-info + session-info
    235     usageInfo =
    236       request.getContextPath()+" "+ //session id
    237       request.getServletPath()+" "+ //serlvet
    238       "["+query+"]" +" "+ //the query string
    239       "["+usageInfo.trim()+"]" +" "+ // params stored in a session
    240       request.getRemoteAddr()+" "+   //remote address
    241       request.getHeader("user-agent")+" "; //the remote brower info
    242    
    243     logger.info(usageInfo);   
    244   }
    245   /** return true if the url is in the form of baseURL?verb=...,
    246    */
    247   private boolean validate(String query, String verb) {
    248     //Here in OAIServer, only the verbs are validated. All the validation for individual verb
    249     // is taken in their doXXX() methods.
    250     if(query == null || !query.startsWith(OAIXML.VERB+"=")) {
    251       return false;
    252     }
    253     if (!verb_set.contains(verb)) {
    254       return false;
    255     }
    256     return true;
    257   }
    258   private String getVerb(String query) {
    259     if (query == null) return "";
    260     int verb_start_index = query.indexOf("=") + 1;// first occurence of '='
    261     int verb_end_index = query.indexOf("&");
    262     if(verb_end_index == -1) {
    263       return query.substring(verb_start_index);
    264     }
    265     return query.substring(verb_start_index, verb_end_index);
    266   }
    267 
    268   public void doGet(HttpServletRequest request, HttpServletResponse response)
    269     throws ServletException, IOException {
    270     logUsageInfo(request);
    271     //out.println("url="+request.getRequestURL());// /oaiserver   
    272     //out.println("query="+request.getQueryString());// is /greenstone3
    273 
    274     // oai always requires the content type be text/xml
    275     request.setCharacterEncoding("UTF-8");
    276     response.setContentType("text/xml;charset=UTF-8");
    277     PrintWriter out = response.getWriter();
    278    
    279     //
    280     String lang = request.getParameter(GSParams.LANGUAGE);
    281     if (lang==null || lang.equals("")) {
    282       // use the default
    283       lang = this.default_lang;
    284     }
    285     //we don't get the baseURL from the http request because what we get might be different from the one known publicly due to local network redirection.
    286     //For example, puka.cs.waikato.ac.nz vs www.greenstone.org
    287     //String base_url = request.getRequestURL().toString();
    288     // if called by doPost (if this was originally a POST request), var queryString would have been set
    289     String query = (queryString == null) ? request.getQueryString() : queryString;
    290     queryString = null; // reset member variable, else no doGet will work as long as the server remains running
    291 
    292     String[] pairs = (query==null)? null : query.split("&");//split into key/value pairs
    293     String verb = getVerb(query);
    294     Element xml_response = OAIXML.createBasicResponse(verb, pairs);
    295     Element verb_elem = null;
    296    
    297     if (validate(query, verb) == false) {
    298       if (verb_set.contains(verb) == false) {
    299         logger.error(OAIXML.BAD_VERB + ": " + query);
    300         verb_elem = OAIXML.createErrorElement(OAIXML.BAD_VERB, OAIXML.ILLEGAL_OAI_VERB);
    301       } else {
    302         //must be something else other than bad verbs caused an error, so bad argument
    303         logger.error(OAIXML.BAD_ARGUMENT + ": " + query);
    304         verb_elem = OAIXML.createErrorElement(OAIXML.BAD_ARGUMENT, "");
    305       }
    306       xml_response.appendChild(verb_elem);
    307 
    308       out.println("<?xml version='1.0' encoding='UTF-8' ?>");
    309       if (this.use_oai_stylesheet) {
    310     out.println("<?xml-stylesheet type='text/xsl' href='"+this.oai_stylesheet+"' ?>\n");
    311       }
    312       out.println(this.converter.getPrettyString(xml_response));
    313       return;
    314     }//end of if(validate
    315    
    316     // The query is valid, we can now
    317     // compose the request message to the receptionist
    318     Element xml_message = this.doc.createElement(GSXML.MESSAGE_ELEM);
    319     Element xml_request = this.doc.createElement(GSXML.REQUEST_ELEM);
    320     // The type attribute is set to be 'oaiService' from OAIServer to OAIReceptionist.
    321     //xml_request.setAttribute(GSXML.TYPE_ATT, OAIXML.OAI_SERVICE);
    322     xml_request.setAttribute(GSXML.LANG_ATT, lang);
    323     xml_request.setAttribute(GSXML.TO_ATT, verb);
    324     addParams(xml_request, pairs);
    325    
    326     //xml_request.setAttribute(GSXML.OUTPUT_ATT, output);????
    327     xml_message.appendChild(xml_request);
    328          
    329     Node xml_result = this.recept.process (xml_message);
    330     if (xml_result == null) {
    331       logger.info("xml_result is null");
    332       verb_elem = OAIXML.createErrorElement("Internal error", "");
    333       xml_response.appendChild(verb_elem);
    334     } else {
    335    
    336       /** All response elements are in the form (with a corresponding verb name):
    337        *                                        <message>
    338                                                   <response>
    339                                                     <verb>
    340                                                     ...
    341        *                                              <resumptionToken>
    342        *                                              .. this is optional!
    343        *                                              </resumptionToken>
    344        *                                            </verb>
    345        *                                          </response>       
    346        *                                        </message>
    347        */
    348       Node res = GSXML.getChildByTagName(xml_result, OAIXML.RESPONSE);
    349       if(res == null) {
    350         logger.info("response element in xml_result is null");
    351         verb_elem = OAIXML.createErrorElement("Internal error", "");
    352       } else {
    353         verb_elem = GSXML.getFirstElementChild(res);
    354       }
    355      
    356       if(OAIXML.oai_version.equals(OAIXML.OAI_VERSION2) ||
    357          verb_elem.getTagName().equals(OAIXML.ERROR)) {
    358         xml_response.appendChild(xml_response.getOwnerDocument().importNode(verb_elem, true));
    359       } else {
    360         GSXML.copyAllChildren(xml_response, verb_elem);
    361       }
    362     }
    363     out.println("<?xml version='1.0' encoding='UTF-8' ?>");
    364     if (this.use_oai_stylesheet) {
    365       out.println("<?xml-stylesheet type='text/xsl' href='"+this.oai_stylesheet+"' ?>\n");
    366     }
    367     out.println (this.converter.getPrettyString (xml_response));
    368     return;
    369   }
    370   /** append parameter elements to the request sent to the receptionist*/
    371   public void addParams(Element request, String[] pairs) {
    372     // no params apart from the verb
    373     if (pairs == null || pairs.length < 2) return ;
    374    
    375       /**the request xml is composed in the form: <request>
    376        *                                            <param name=.../>
    377        *                                            <param name=.../>
    378        *                                          </request>
    379        *(No paramList element in between).
    380        */   
    381     for (int i=1; i<pairs.length; i++) {
    382       //the first pair in pairs is the verb=xxx
    383       int index = pairs[i].indexOf("=");
    384       if(index != -1){ //just a double check
    385         Element param = this.doc.createElement(OAIXML.PARAM);
    386         param.setAttribute(OAIXML.NAME, pairs[i].substring(0, index));
    387         param.setAttribute(OAIXML.VALUE, OAIXML.oaiDecode(pairs[i].substring(index + 1)));
    388         request.appendChild(param);
    389       }
    390     }
    391   }
    392 
    393   // For OAI version 2.0, validation tests indicated that POST needs to be supported. Some
    394   // modification was required in order to ensure that the request is passed intact to doGet()
    395   public void doPost(HttpServletRequest request,
    396     HttpServletResponse response)
    397     throws ServletException, IOException {
    398 
    399       // the post method returns a wrapper of type RequestFacade by apache and there
    400       // is no getQueryString() method defined for it. Therefore, need to work this out
    401       // manually before calling doGet(request, response) so that doGet can work as before.
    402      
    403       queryString = "";
    404       Iterator parameter_entries = request.getParameterMap().entrySet().iterator();
    405       while(parameter_entries.hasNext()) {   
    406       Map.Entry param_entry = (Map.Entry)parameter_entries.next();
    407       String[] paramVals = (String[]) param_entry.getValue();
    408       if(paramVals != null) {
    409           if(paramVals.length > 0) {
    410           logger.error("POST request received: " + param_entry.getKey() + " - " + paramVals[0]);
    411           queryString = queryString + "&" + param_entry.getKey() + "=" + paramVals[0];
    412           }
    413       }   
    414       }
    415       if(queryString.length() > 0) {
    416       queryString = queryString.substring(1);
    417       //queryString = OAIXML.oaiEncode(queryString);
    418       }
    419       if(queryString.equals("")) {
    420       queryString = null;
    421       }
    422     doGet(request,response);   
    423   }
     60public class OAIServer extends BaseGreenstoneServlet
     61{
     62
     63    /** the receptionist to send messages to */
     64    protected OAIReceptionist recept = null;
     65    /**
     66     * the default language - is specified by setting a servlet param, otherwise
     67     * DEFAULT_LANG is used
     68     */
     69    protected String default_lang = null;
     70    /**
     71     * The default default - used if a default lang is not specified in the
     72     * servlet params
     73     */
     74    protected final String DEFAULT_LANG = "en";
     75
     76    /**
     77     * a converter class to parse XML and create Docs This is only used for
     78     * generating internal requests passed to MessageRouter. The response
     79     * message is generated by parsing an existing xml skeleton file
     80     * (web/WEB-INF/oaixml/oaiversion2.xml, for example).
     81     */
     82    protected XMLConverter converter = null;
     83    /**
     84     * container Document to create XML Nodes (but only request to the oai
     85     * receptionist, not response (which is created in OAIXML.java) created by
     86     * converter class
     87     */
     88    protected Document doc = null;
     89
     90    /** A HashSet which contains all the legal verbs. */
     91    protected HashSet<String> verb_set = null;
     92    /**
     93     * A HashSet which contains all the legal oai keys in the key/value argument
     94     * pair.
     95     */
     96    protected HashSet<String> param_set = null;
     97    /**
     98     * The name of the site with which we will finally be dealing, whether it is
     99     * a local site or a remote site through a communicator.
     100     */
     101    protected String site = "";
     102
     103    // do we output the stylesheet processing instruction?
     104    protected boolean use_oai_stylesheet = true;
     105    protected String oai_stylesheet = "interfaces/oai/oai2.xsl";
     106
     107    // there is no getQueryString() method in the HttpServletRequest returned from doPost,
     108    // since that is actually of type apache RequestFacade, and doesn't define such a method
     109    protected String queryString = null;
     110
     111    static Logger logger = Logger.getLogger(org.greenstone.gsdl3.OAIServer.class.getName());
     112
     113    /**
     114     * initialise the servlet
     115     */
     116    public void init(ServletConfig config) throws ServletException
     117    {
     118        // always call super.init, i.e., HttpServlet.;
     119        super.init(config);
     120        this.default_lang = config.getInitParameter(GSConstants.DEFAULT_LANG);
     121
     122        initVerbs();
     123        initParams();
     124
     125        String site_name = config.getInitParameter(GSConstants.SITE_NAME);
     126        String remote_site_name = null;
     127        String remote_site_type = null;
     128        String remote_site_address = null;
     129
     130        if (site_name == null)
     131        {
     132            // no local site, try for communicator (remote site)
     133            remote_site_name = config.getInitParameter("remote_site_name");
     134            remote_site_type = config.getInitParameter("remote_site_type");
     135            remote_site_address = config.getInitParameter("remote_site_address");
     136            if (remote_site_name == null || remote_site_type == null || remote_site_address == null)
     137            {
     138                System.err.println("initialisation paramters not all set!");
     139                System.err.println("if site_name is not set, then you must have remote_site_name, remote_site_type and remote_site_address set");
     140                System.exit(1);
     141            }
     142        }
     143
     144        if (this.default_lang == null)
     145        {
     146            // choose english
     147            this.default_lang = DEFAULT_LANG;
     148        }
     149
     150        // the receptionist -the servlet will talk to this
     151        this.recept = new OAIReceptionist();
     152
     153        // the receptionist uses a MessageRouter or Communicator to send its requests to. We either create a MessageRouter here for the designated site (if site_name set), or we create a Communicator for a remote site. The is given to teh Receptionist, and the servlet never talks to it again.directly.
     154        if (site_name != null)
     155        {
     156            //this site_name could consist of comma separated more than one site name.
     157            String mr_name = (String) config.getInitParameter("messagerouter_class");
     158            MessageRouter message_router = null;
     159            if (mr_name == null)
     160            { // just use the normal MR *********
     161                message_router = new MessageRouter();
     162            }
     163            else
     164            { // try the specified one
     165                try
     166                {
     167                    message_router = (MessageRouter) Class.forName("org.greenstone.gsdl3.core." + mr_name).newInstance();
     168                }
     169                catch (Exception e)
     170                { // cant use this new one, so use normal one
     171                    System.err.println("OAIServlet configure exception when trying to use a new MessageRouter " + mr_name + ": " + e.getMessage());
     172                    e.printStackTrace();
     173                    message_router = new MessageRouter();
     174                }
     175            }
     176
     177            message_router.setSiteName(site_name);
     178            // lots of work is done in this step; see MessageRouter.java
     179            message_router.configure();
     180            this.recept.setSiteName(site_name);
     181            this.recept.setMessageRouter(message_router);
     182
     183        }
     184        else
     185        {
     186            // talking to a remote site, create a communicator
     187            Communicator communicator = null;
     188            // we need to create the XML to configure the communicator
     189            Element site_elem = this.doc.createElement(GSXML.SITE_ELEM);
     190            site_elem.setAttribute(GSXML.TYPE_ATT, remote_site_type);
     191            site_elem.setAttribute(GSXML.NAME_ATT, remote_site_name);
     192            site_elem.setAttribute(GSXML.ADDRESS_ATT, remote_site_address);
     193
     194            if (remote_site_type.equals(GSXML.COMM_TYPE_SOAP_JAVA))
     195            {
     196                communicator = new SOAPCommunicator();
     197            }
     198            else
     199            {
     200                System.err.println("OAIServlet.init Error: invalid Communicator type: " + remote_site_type);
     201                System.exit(1);
     202            }
     203
     204            if (!communicator.configure(site_elem))
     205            {
     206                System.err.println("OAIServlet.init Error: Couldn't configure communicator");
     207                System.exit(1);
     208            }
     209            this.recept.setSiteName(remote_site_name);
     210            this.recept.setMessageRouter(communicator);
     211        }
     212        // used for composing internal xml requests, but not xml responses.
     213        // the converter may be used to get pretty xml, though.   
     214        this.converter = new XMLConverter();
     215        this.doc = this.converter.newDOM();
     216
     217        // Read in OAIConfig.xml (residing web/WEB-INF/classes/) and
     218        //use it to configure the receptionist. The init() is also called in which
     219        //the resumption token file is read in and all expired tokens cleared.
     220        Element oai_config = OAIXML.getOAIConfigXML();
     221        if (oai_config == null)
     222        {
     223            logger.error("Fail to parse oai config file OAIConfig.xml.");
     224            return;
     225        }
     226        // pass it to the receptionist
     227        this.recept.configure(oai_config);
     228
     229        // also, we have something we want to get from here - useOAIStylesheet
     230        this.configure(oai_config);
     231    }//end of init()
     232
     233    private void configure(Element oai_config)
     234    {
     235        Element use_stylesheet_elem = (Element) GSXML.getChildByTagName(oai_config, OAIXML.USE_STYLESHEET);
     236        if (use_stylesheet_elem != null)
     237        {
     238            String value = GSXML.getNodeText(use_stylesheet_elem);
     239            if (value.equals("no"))
     240            {
     241                this.use_oai_stylesheet = false;
     242            }
     243        }
     244        if (this.use_oai_stylesheet)
     245        {
     246            // now see if there is a custom stylesheet specified
     247            Element stylesheet_elem = (Element) GSXML.getChildByTagName(oai_config, OAIXML.STYLESHEET);
     248            if (stylesheet_elem != null)
     249            {
     250                String value = GSXML.getNodeText(stylesheet_elem);
     251                if (!value.equals(""))
     252                {
     253                    oai_stylesheet = value;
     254                }
     255            }
     256
     257        }
     258    }
     259
     260    private void initVerbs()
     261    {
     262        verb_set = new HashSet<String>();
     263        verb_set.add(OAIXML.GET_RECORD);
     264        verb_set.add(OAIXML.LIST_RECORDS);
     265        verb_set.add(OAIXML.LIST_IDENTIFIERS);
     266        verb_set.add(OAIXML.LIST_SETS);
     267        verb_set.add(OAIXML.LIST_METADATA_FORMATS);
     268        verb_set.add(OAIXML.IDENTIFY);
     269    }
     270
     271    private void initParams()
     272    {
     273        param_set = new HashSet<String>();
     274        param_set.add(OAIXML.METADATA_PREFIX);
     275        param_set.add(OAIXML.FROM);
     276        param_set.add(OAIXML.UNTIL);
     277        param_set.add(OAIXML.SET);
     278        param_set.add(OAIXML.RESUMPTION_TOKEN);
     279        param_set.add(OAIXML.IDENTIFIER);
     280    }
     281
     282    private void logUsageInfo(HttpServletRequest request)
     283    {
     284        String usageInfo = "";
     285
     286        String query = (queryString == null) ? request.getQueryString() : queryString;
     287
     288        //logged info = general-info + session-info
     289        usageInfo = request.getContextPath() + " " + //session id
     290        request.getServletPath() + " " + //serlvet
     291        "[" + query + "]" + " " + //the query string
     292        "[" + usageInfo.trim() + "]" + " " + // params stored in a session
     293        request.getRemoteAddr() + " " + //remote address
     294        request.getHeader("user-agent") + " "; //the remote brower info
     295
     296        logger.info(usageInfo);
     297    }
     298
     299    /**
     300     * return true if the url is in the form of baseURL?verb=...,
     301     */
     302    private boolean validate(String query, String verb)
     303    {
     304        //Here in OAIServer, only the verbs are validated. All the validation for individual verb
     305        // is taken in their doXXX() methods.
     306        if (query == null || !query.startsWith(OAIXML.VERB + "="))
     307        {
     308            return false;
     309        }
     310        if (!verb_set.contains(verb))
     311        {
     312            return false;
     313        }
     314        return true;
     315    }
     316
     317    private String getVerb(String query)
     318    {
     319        if (query == null)
     320            return "";
     321        int verb_start_index = query.indexOf("=") + 1;// first occurence of '='
     322        int verb_end_index = query.indexOf("&");
     323        if (verb_end_index == -1)
     324        {
     325            return query.substring(verb_start_index);
     326        }
     327        return query.substring(verb_start_index, verb_end_index);
     328    }
     329
     330    public void doGet(HttpServletRequest request, HttpServletResponse response) throws ServletException, IOException
     331    {
     332        logUsageInfo(request);
     333        //out.println("url="+request.getRequestURL());// /oaiserver   
     334        //out.println("query="+request.getQueryString());// is /greenstone3
     335
     336        // oai always requires the content type be text/xml
     337        request.setCharacterEncoding("UTF-8");
     338        response.setContentType("text/xml;charset=UTF-8");
     339        PrintWriter out = response.getWriter();
     340
     341        //
     342        String lang = request.getParameter(GSParams.LANGUAGE);
     343        if (lang == null || lang.equals(""))
     344        {
     345            // use the default
     346            lang = this.default_lang;
     347        }
     348        //we don't get the baseURL from the http request because what we get might be different from the one known publicly due to local network redirection.
     349        //For example, puka.cs.waikato.ac.nz vs www.greenstone.org
     350        //String base_url = request.getRequestURL().toString();
     351        // if called by doPost (if this was originally a POST request), var queryString would have been set
     352        String query = (queryString == null) ? request.getQueryString() : queryString;
     353        queryString = null; // reset member variable, else no doGet will work as long as the server remains running
     354
     355        String[] pairs = (query == null) ? null : query.split("&");//split into key/value pairs
     356        String verb = getVerb(query);
     357        Element xml_response = OAIXML.createBasicResponse(verb, pairs);
     358        Element verb_elem = null;
     359
     360        if (validate(query, verb) == false)
     361        {
     362            if (verb_set.contains(verb) == false)
     363            {
     364                logger.error(OAIXML.BAD_VERB + ": " + query);
     365                verb_elem = OAIXML.createErrorElement(OAIXML.BAD_VERB, OAIXML.ILLEGAL_OAI_VERB);
     366            }
     367            else
     368            {
     369                //must be something else other than bad verbs caused an error, so bad argument
     370                logger.error(OAIXML.BAD_ARGUMENT + ": " + query);
     371                verb_elem = OAIXML.createErrorElement(OAIXML.BAD_ARGUMENT, "");
     372            }
     373            xml_response.appendChild(verb_elem);
     374
     375            out.println("<?xml version='1.0' encoding='UTF-8' ?>");
     376            if (this.use_oai_stylesheet)
     377            {
     378                out.println("<?xml-stylesheet type='text/xsl' href='" + this.oai_stylesheet + "' ?>\n");
     379            }
     380            out.println(this.converter.getPrettyString(xml_response));
     381            return;
     382        }//end of if(validate
     383
     384        // The query is valid, we can now
     385        // compose the request message to the receptionist
     386        Element xml_message = this.doc.createElement(GSXML.MESSAGE_ELEM);
     387        Element xml_request = this.doc.createElement(GSXML.REQUEST_ELEM);
     388        // The type attribute is set to be 'oaiService' from OAIServer to OAIReceptionist.
     389        //xml_request.setAttribute(GSXML.TYPE_ATT, OAIXML.OAI_SERVICE);
     390        xml_request.setAttribute(GSXML.LANG_ATT, lang);
     391        xml_request.setAttribute(GSXML.TO_ATT, verb);
     392        addParams(xml_request, pairs);
     393
     394        //xml_request.setAttribute(GSXML.OUTPUT_ATT, output);????
     395        xml_message.appendChild(xml_request);
     396
     397        Node xml_result = this.recept.process(xml_message);
     398        if (xml_result == null)
     399        {
     400            logger.info("xml_result is null");
     401            verb_elem = OAIXML.createErrorElement("Internal error", "");
     402            xml_response.appendChild(verb_elem);
     403        }
     404        else
     405        {
     406
     407            /**
     408             * All response elements are in the form (with a corresponding verb
     409             * name): <message> <response> <verb> ... <resumptionToken> .. this
     410             * is optional! </resumptionToken> </verb> </response> </message>
     411             */
     412            Node res = GSXML.getChildByTagName(xml_result, OAIXML.RESPONSE);
     413            if (res == null)
     414            {
     415                logger.info("response element in xml_result is null");
     416                verb_elem = OAIXML.createErrorElement("Internal error", "");
     417            }
     418            else
     419            {
     420                verb_elem = GSXML.getFirstElementChild(res);
     421            }
     422
     423            if (OAIXML.oai_version.equals(OAIXML.OAI_VERSION2) || verb_elem.getTagName().equals(OAIXML.ERROR))
     424            {
     425                xml_response.appendChild(xml_response.getOwnerDocument().importNode(verb_elem, true));
     426            }
     427            else
     428            {
     429                GSXML.copyAllChildren(xml_response, verb_elem);
     430            }
     431        }
     432        out.println("<?xml version='1.0' encoding='UTF-8' ?>");
     433        if (this.use_oai_stylesheet)
     434        {
     435            out.println("<?xml-stylesheet type='text/xsl' href='" + this.oai_stylesheet + "' ?>\n");
     436        }
     437        out.println(this.converter.getPrettyString(xml_response));
     438        return;
     439    }
     440
     441    /** append parameter elements to the request sent to the receptionist */
     442    public void addParams(Element request, String[] pairs)
     443    {
     444        // no params apart from the verb
     445        if (pairs == null || pairs.length < 2)
     446            return;
     447
     448        /**
     449         * the request xml is composed in the form: <request> <param name=.../>
     450         * <param name=.../> </request> (No paramList element in between).
     451         */
     452        for (int i = 1; i < pairs.length; i++)
     453        {
     454            //the first pair in pairs is the verb=xxx
     455            int index = pairs[i].indexOf("=");
     456            if (index != -1)
     457            { //just a double check
     458                Element param = this.doc.createElement(OAIXML.PARAM);
     459                param.setAttribute(OAIXML.NAME, pairs[i].substring(0, index));
     460                param.setAttribute(OAIXML.VALUE, OAIXML.oaiDecode(pairs[i].substring(index + 1)));
     461                request.appendChild(param);
     462            }
     463        }
     464    }
     465
     466    // For OAI version 2.0, validation tests indicated that POST needs to be supported. Some
     467    // modification was required in order to ensure that the request is passed intact to doGet()
     468    public void doPost(HttpServletRequest request, HttpServletResponse response) throws ServletException, IOException
     469    {
     470
     471        // the post method returns a wrapper of type RequestFacade by apache and there
     472        // is no getQueryString() method defined for it. Therefore, need to work this out
     473        // manually before calling doGet(request, response) so that doGet can work as before.
     474
     475        queryString = "";
     476        Iterator parameter_entries = request.getParameterMap().entrySet().iterator();
     477        while (parameter_entries.hasNext())
     478        {
     479            Map.Entry param_entry = (Map.Entry) parameter_entries.next();
     480            String[] paramVals = (String[]) param_entry.getValue();
     481            if (paramVals != null)
     482            {
     483                if (paramVals.length > 0)
     484                {
     485                    logger.error("POST request received: " + param_entry.getKey() + " - " + paramVals[0]);
     486                    queryString = queryString + "&" + param_entry.getKey() + "=" + paramVals[0];
     487                }
     488            }
     489        }
     490        if (queryString.length() > 0)
     491        {
     492            queryString = queryString.substring(1);
     493            //queryString = OAIXML.oaiEncode(queryString);
     494        }
     495        if (queryString.equals(""))
     496        {
     497            queryString = null;
     498        }
     499        doGet(request, response);
     500    }
    424501}
    425 
    426 
    427 
    428 
    429 
    430 
    431 
    432 
    433 
    434 
    435 
    436 
    437 
    438 
    439 

  • main/trunk/greenstone3/src/java/org/greenstone/gsdl3/service/GS2Browse.java

    r25691 r25717  
    2020
    2121// Greenstone classes
     22import java.util.ArrayList;
     23import java.util.Iterator;
     24import java.util.Set;
     25import java.util.StringTokenizer;
     26
     27import org.apache.log4j.Logger;
     28import org.greenstone.gsdl3.util.DBInfo;
     29import org.greenstone.gsdl3.util.GS2MacroResolver;
     30import org.greenstone.gsdl3.util.GSFile;
     31import org.greenstone.gsdl3.util.GSXML;
    2232import org.greenstone.gsdl3.util.OID;
    23 import org.greenstone.gsdl3.util.GSXML;
    24 import org.greenstone.gsdl3.util.GSFile;
    25 import org.greenstone.gsdl3.util.MacroResolver;
    26 import org.greenstone.gsdl3.util.GS2MacroResolver;
    2733import org.greenstone.gsdl3.util.SimpleCollectionDatabase;
    28 import org.greenstone.gsdl3.util.DBInfo;
    29 // XML classes
    30 import org.w3c.dom.Document;
    3134import org.w3c.dom.Element;
    32 import org.w3c.dom.NodeList;
    33 
    34 // General Java classes
    35 import java.util.ArrayList;
    36 import java.util.StringTokenizer;
    37 import java.util.Set;
    38 import java.util.Iterator;
    39 
    40 import org.apache.log4j.*;
    4135
    4236/**

  • main/trunk/greenstone3/src/java/org/greenstone/server/Server3.java

    r25716 r25717  
    4545    public void reload()
    4646    {
    47         GlobalProperties.reload(); // properties file may have changed, so reload it
     47        GlobalProperties.loadGlobalProperties(null); // properties file may have changed, so reload it
    4848    }
    4949

  • main/trunk/greenstone3/src/java/org/greenstone/util/GlobalProperties.java

    r25387 r25717  
    3232
    3333    static Logger logger = Logger.getLogger(org.greenstone.util.GlobalProperties.class.getName());
    34     private static Properties properties = null;
     34    private static Properties properties = new Properties();
    3535    private static String properties_filename = "global.properties";
    3636    private static String gsdl3_home = null;
    3737    private static String gsdl3_web_address = null;
    38         private static String full_gsdl3_web_address = null;
    39 
    40     // Note, that if the servlet is reloadable, then it is reloaded each time the file is changed.
    41     static
    42     {
    43         //load in the properties
    44         properties = new Properties();
    45         reload();
    46     }
     38    private static String full_gsdl3_web_address = null;
    4739
    4840    /** get the value of the property 'key'. returns null if not found */
    … …  
    7668    }
    7769
    78         public static String getFullGSDL3WebAddress()
     70    public static String getFullGSDL3WebAddress()
    7971    {
    8072        return full_gsdl3_web_address;
    8173    }
    8274
    83     public static void reload()
     75    public static void loadGlobalProperties(String optionalGS3Home)
    8476    {
    8577        try
    8678        {
    87 
    8879            InputStream in = Class.forName("org.greenstone.util.GlobalProperties").getClassLoader().getResourceAsStream(properties_filename);
    8980            if (in != null)
    … …  
    9788                logger.error("couldn't load global properties!");
    9889            }
     90
    9991            gsdl3_home = properties.getProperty("gsdl3.home");
     92            if ((gsdl3_home == null || gsdl3_home.length() > 0) && optionalGS3Home != null && optionalGS3Home.length() > 0)
     93            {
     94                gsdl3_home = optionalGS3Home;
     95            }
     96
    10097            // make sure the path separators are correct
    10198            File gs3_file = new File(gsdl3_home);
Note: See TracChangeset for help on using the changeset viewer.