Metacat

/**

 *  '$RCSfile$'

 *    Purpose: A Class that implements a metadata catalog as a java Servlet

 *  Copyright: 2000 Regents of the University of California and the

 *             National Center for Ecological Analysis and Synthesis

 *    Authors: Matt Jones, Dan Higgins

 *

 *   '$Author: jones $'

 *     '$Date: 2000-06-30 18:09:44 -0700 (Fri, 30 Jun 2000) $'

 * '$Revision: 253 $'

 */

package edu.ucsb.nceas.metacat;

import java.io.PrintWriter;

import java.io.IOException;

import java.io.Reader;

import java.io.StringReader;

import java.io.BufferedReader;

import java.io.File;

import java.io.FileInputStream;

import java.util.Enumeration;

import java.util.Hashtable;

import java.util.ResourceBundle;

import java.util.PropertyResourceBundle;

import java.net.URL;

import java.net.MalformedURLException;

import java.sql.PreparedStatement;

import java.sql.ResultSet;

import java.sql.Connection;

import java.sql.SQLException;

import javax.servlet.ServletConfig;

import javax.servlet.ServletContext;

import javax.servlet.ServletException;

import javax.servlet.ServletInputStream;

import javax.servlet.http.HttpServlet;

import javax.servlet.http.HttpServletRequest;

import javax.servlet.http.HttpServletResponse;

import javax.servlet.http.HttpSession;

import javax.servlet.http.HttpUtils;

import oracle.xml.parser.v2.XSLStylesheet;

import oracle.xml.parser.v2.XSLException;

import oracle.xml.parser.v2.XMLDocumentFragment;

import oracle.xml.parser.v2.XSLProcessor;

import org.xml.sax.SAXException;

/**

 * A metadata catalog server implemented as a Java Servlet

 *

 * <p>Valid parameters are:<br>

 * action=query -- query the values of all elements and attributes

 *                     and return a result set of nodes<br>

 * action=squery -- structured query (see pathquery.dtd)<br>

 * action=insert -- insert an XML document into the database store<br>

 * action=update -- update an XML document that is in the database store<br>

 * action=delete --  delete an XML document from the database store<br>

 * action=validate -- vallidate the xml contained in valtext<br>

 * action=getdocument -- display an XML document in XML or HTML<br>

 * doctype -- document type list returned by the query (publicID)<br>

 * qformat=xml -- display resultset from query in XML<br>

 * qformat=html -- display resultset from query in HTML<br>

 * docid=34 -- display the document with the document ID number 34<br>

 * doctext -- XML text of the document to load into the database<br>

 * query -- actual query text (to go with 'action=query' or 'action=squery')<br>

 * valtext -- XML text to be validated<br>

 * action=getdatadoc -- retreive a stored datadocument<br>

 * datadoc -- data document name (id)<br>

 * <p>

 * The particular combination of parameters that are valid for each 

 * particular action value is quite specific.  This documentation

 * will be reorganized to reflect this information.

 */

public class MetaCatServlet extends HttpServlet {

  private ServletConfig		config = null;

  private ServletContext	context = null;

  private Connection 		conn = null;

  private DBQuery		queryobj = null;

  private DBReader		docreader = null;

  private DBTransform		dbt = null;

  private String 		resultStyleURL = null;

  private String 		xmlcatalogfile = null;

  private String 		saxparser = null;

  private String    		defaultdatapath = null; 

					// path to directory where data files 

					// that can be downloaded will be stored

  private String    		executescript  = null;  

					// script to get data file and put it 

                                    	// in defaultdocpath dir

  private PropertyResourceBundle options = null;

  private MetaCatUtil util = null;

  /**

   * Initialize the servlet by creating appropriate database connections

   */

  public void init( ServletConfig config ) throws ServletException {

    try {

      super.init( config );

      this.config = config;

      this.context = config.getServletContext();

      System.out.println("MetaCatServlet Initialize");

      util = new MetaCatUtil();

      // Get the configuration file information

      resultStyleURL = util.getOption("resultStyleURL");

      xmlcatalogfile = util.getOption("xmlcatalogfile");

      saxparser = util.getOption("saxparser");

      defaultdatapath = util.getOption("defaultdatapath");

      executescript = util.getOption("executescript");

      try {

        // Open a connection to the database

        conn = util.openDBConnection();

        queryobj = new DBQuery(conn,saxparser);

        docreader = new DBReader(conn);

        dbt = new DBTransform(conn);

      } catch (Exception e) {

        System.err.println("Error opening database connection");

      }

    } catch ( ServletException ex ) {

      throw ex;

    }

  }

  /** Handle "GET" method requests from HTTP clients */

  public void doGet (HttpServletRequest request, HttpServletResponse response)

    throws ServletException, IOException {

    // Process the data and send back the response

    handleGetOrPost(request, response);

  }

  /** Handle "POST" method requests from HTTP clients */

  public void doPost( HttpServletRequest request, HttpServletResponse response)

    throws ServletException, IOException {

    // Process the data and send back the response

    handleGetOrPost(request, response);

  }

  /**

   * Control servlet response depending on the action parameter specified

   */

  private void handleGetOrPost(HttpServletRequest request, 

    HttpServletResponse response) 

    throws ServletException, IOException {

    if (conn == null) {

      System.err.println("Connection to database lost.  Reopening...");

      try {

        // Open a connection to the database

        conn = util.openDBConnection();

        queryobj = new DBQuery(conn, saxparser);

        docreader = new DBReader(conn);

        dbt = new DBTransform(conn);

      } catch (Exception e) {

        System.err.println("Error opening database connection");

      }

    }

    // Get a handle to the output stream back to the client

    PrintWriter out = response.getWriter();

    //response.setContentType("text/html");

    String name = null;

    String[] value = null;

    String[] docid = new String[3];

    Hashtable params = new Hashtable();

    Enumeration paramlist = request.getParameterNames();

    while (paramlist.hasMoreElements()) {

      name = (String)paramlist.nextElement();

      value = request.getParameterValues(name);

      // Decode the docid and mouse click information

      if (name.endsWith(".y")) {

        docid[0] = name.substring(0,name.length()-2);

        //out.println("docid => " + docid[0]);

        params.put("docid", docid);

        name = "ypos";

      }

      if (name.endsWith(".x")) {

        name = "xpos";

      }

      //out.println(name + " => " + value[0]);

      params.put(name,value);

    }

    // Determine what type of request the user made

    // if the action parameter is set, use it as a default

    // but if the ypos param is set, calculate the action needed

    String action = ((String[])params.get("action"))[0];

    long ypos = 0;

    try {

      ypos = (new Long(((String[])params.get("ypos"))[0]).longValue());

      //out.println("<P>YPOS IS " + ypos);

      if (ypos <= 13) {

        action = "getdocument";

      } else if (ypos > 13 && ypos <= 27) {

        action = "validate";

      } else if (ypos > 27) {

        action = "transform";

      //} else {

      //  action = "";

      }

    } catch (Exception npe) {

      //out.println("<P>Caught exception looking for Y value.");

    }

// Jivka added 

    // handle login action

    if (action.equals("Login")) {

      handleLoginAction(out, params, request, response);

    // handle logout action  

    } else if (action.equals("Logout")) {

      HttpSession sess = request.getSession(false);

      if (sess != null) { sess.invalidate();  }    

      response.sendRedirect("/xmltodb/lib/login.html"); 

    // aware of session expiration on every request  

    } else {    

      HttpSession sess = request.getSession(false);

      if (sess == null) { 

        // session expired or has not been stored b/w user requests

        // redirect to session expiration message page

        response.sendRedirect("/xmltodb/lib/sexpire.html"); 

      }

    }    

// End of Jivka added

    if (action.equals("query") || action.equals("squery")) {

      handleQueryAction(out, params, response);

    } else if (action.equals("getdocument")) {

      try {

        handleGetDocumentAction(out, params, response);

      } catch (ClassNotFoundException e) {

        out.println(e.getMessage());

      } catch (SQLException se) {

        out.println(se.getMessage());

      }

    } else if (action.equals("insert") || action.equals("update")) {

      handleInsertOrUpdateAction(out, params, response);

    } else if (action.equals("delete")) {

      handleDeleteAction(out, params, response);

    } else if (action.equals("validate")) {

      handleValidateAction(out, params, response);  

    } else if (action.equals("getdatadoc")) {

      handleGetDataDocumentAction(out, params, response);  

    } else if (action.equals("Login")) {

    } else {

      out.println("Error: action not registered.  Please report this error.");

    }

    // Close the stream to the client

    out.close();

  }

// Jivka added

  /** 

   * Handle the Login request. Create a new session object.

   * Make a user authentication through SRB RMI Connection.

   */

  private void handleLoginAction(PrintWriter out, Hashtable params, 

               HttpServletRequest request, HttpServletResponse response) {

    String un = ((String[])params.get("username"))[0];

    String pw = ((String[])params.get("password"))[0];

    MetaCatSession sess = new MetaCatSession(request, un, pw);

    try {  

        if (sess.userAuth(pw)) {

            try {

                response.sendRedirect(

                    response.encodeRedirectUrl("/xmltodb/lib/index.html"));

            } catch ( java.io.IOException ioe) {

                sess.disconnect();            

                out.println("MetaCatServlet.handleLoginAction() - " +

                            "Error on redirect of HttpServletResponse: " + 

                            ioe.getMessage());

            }                

        } else {

            sess.disconnect();            

            out.println("SRB Connection failed. " +

                        "SRB RMI Server is not running now or " +

                        "user " + un + 

                        " has not been authenticated to use the system.");

        }    

    } catch ( java.rmi.RemoteException re) {

            sess.disconnect();            

            out.println("SRB Connection failed. " + re.getMessage());

    }        

  }

  /** 

   * Handle the database query request and return a result set, possibly

   * transformed from XML into HTML

   */

  private void handleQueryAction(PrintWriter out, Hashtable params, 

               HttpServletResponse response) {

      String action = ((String[])params.get("action"))[0];

      String query = ((String[])params.get("query"))[0]; 

      Hashtable doclist = null;

      String[] doctypeArr = null;

      String doctype = null;

      Reader xmlquery = null;

      // Run the query if it is a structured query

      // or, if it is a free-text, simple query,

      // format it first as a structured query and then run it

      if (action.equals("query")) {

        doctypeArr = (String[])params.get("doctype");

        doctype = null;

        if (doctypeArr != null) {

          doctype = ((String[])params.get("doctype"))[0]; 

        }

        if (doctype != null) {

          xmlquery = new StringReader(DBQuery.createQuery(query,doctype));

        } else {

          xmlquery = new StringReader(DBQuery.createQuery(query));

        }

      } else if (action.equals("squery")) {

        xmlquery = new StringReader(query);

      } else {

        System.err.println("Error handling query -- illegal action value");

      }

      if (queryobj != null) {

          doclist = queryobj.findDocuments(xmlquery);

      } else {

        out.println("Query Object Init failed.");

        return;

      }

      // Create a buffer to hold the xml result

      StringBuffer resultset = new StringBuffer();

      // Print the resulting root nodes

      String docid;

      String document = null;

      resultset.append("<?xml version=\"1.0\"?>\n");

      //resultset.append("<!DOCTYPE resultset PUBLIC " +

      //               "\"-//NCEAS//resultset//EN\" \"resultset.dtd\">\n");

      resultset.append("<resultset>\n");

      resultset.append("  <query>" + query + "</query>");

      Enumeration doclistkeys = doclist.keys(); 

      while (doclistkeys.hasMoreElements()) {

        docid = (String)doclistkeys.nextElement();

        document = (String)doclist.get(docid);

        resultset.append("  <document>" + document + "</document>");

      }

      resultset.append("</resultset>");

      String qformat = ((String[])params.get("qformat"))[0]; 

      if (qformat.equals("xml")) {

        // set content type and other response header fields first

        response.setContentType("text/xml");

        out.println(resultset.toString());

      } else if (qformat.equals("html")) {

        // set content type and other response header fields first

        response.setContentType("text/html");

        //out.println("Converting to HTML...");

        XMLDocumentFragment htmldoc = null;

        try {

          XSLStylesheet style = new XSLStylesheet(

                                    new URL(resultStyleURL), null);

          htmldoc = (new XSLProcessor()).processXSL(style, 

                     (Reader)(new StringReader(resultset.toString())),null);

          htmldoc.print(out);

        } catch (Exception e) {

          out.println("Error transforming document:\n" + e.getMessage());

        }

      }

  }

  /** 

   * Handle the database getdocument request and return a XML document, 

   * possibly transformed from XML into HTML

   */

  private void handleGetDocumentAction(PrintWriter out, Hashtable params, 

               HttpServletResponse response) 

               throws ClassNotFoundException, IOException, SQLException {

    String docidstr = null;

    String docid = null;

    String doc = null;

    try {

      // Find the document id number

      docidstr = ((String[])params.get("docid"))[0]; 

      //docid = (new Long(docidstr)).longValue();

      docid = docidstr;

      // Get the document indicated fromthe db

      doc = docreader.readXMLDocument(docid);

    } catch (NullPointerException npe) {

      response.setContentType("text/html");

      out.println("Error getting document ID: " + docidstr +" (" + docid + ")");

    }

      // Return the document in XML or HTML format

      String qformat = ((String[])params.get("qformat"))[0]; 

      if (qformat.equals("xml")) {

        // set content type and other response header fields first

        response.setContentType("text/xml");

        out.println(doc);

      } else if (qformat.equals("html")) {

        // set content type and other response header fields first

        response.setContentType("text/html");

        // Look up the document type

        String sourcetype = docreader.getDoctypeInfo(docid).getDoctype();

        // Transform the document to the new doctype

        dbt.transformXMLDocument(doc, sourcetype, "-//W3C//HTML//EN", out);

      }

  }

  /** 

   * Handle the database putdocument request and write an XML document 

   * to the database connection

   */

  private void handleInsertOrUpdateAction(PrintWriter out, Hashtable params, 

               HttpServletResponse response) {

    try {

      // Get the document indicated

      String[] doctext = (String[])params.get("doctext");

      StringReader xml = null;

      try {

        xml = new StringReader(doctext[0]);

        String[] action = (String[])params.get("action");

        String[] docid = (String[])params.get("docid");

        String newdocid = null;

        String doAction = null;

        if (action[0].equals("insert")) {

          doAction = "INSERT";

        } else if (action[0].equals("update")) {

          doAction = "UPDATE";

        }

        // write the document to the database

        DBWriter dbw = new DBWriter(conn, saxparser);

        try {

          String accNumber = docid[0];

          if (accNumber.equals("")) {

            accNumber = null;

          }

          newdocid = dbw.write(xml, doAction, accNumber);  

        } catch (NullPointerException npe) {

          newdocid = dbw.write(xml, doAction, null);  

        }

        // set content type and other response header fields first

        response.setContentType("text/xml");

        out.println("<?xml version=\"1.0\"?>");

        out.println("<success>");

        out.println("<docid>" + newdocid + "</docid>"); 

        out.println("</success>");

      } catch (NullPointerException npe) {

        response.setContentType("text/xml");

        out.println("<?xml version=\"1.0\"?>");

        out.println("<error>");

        out.println(npe.getMessage()); 

        out.println("</error>");

      }

    } catch (Exception e) {

      response.setContentType("text/xml");

      out.println("<?xml version=\"1.0\"?>");

      out.println("<error>");

      out.println(e.getMessage()); 

      if (e instanceof SAXException) {

        Exception e2 = ((SAXException)e).getException();

        out.println("<error>");

        out.println(e2.getMessage()); 

        out.println("</error>");

      }

      //e.printStackTrace(out);

      out.println("</error>");

    }

  }

  /** 

   * Handle the database delete request and delete an XML document 

   * from the database connection

   */

  private void handleDeleteAction(PrintWriter out, Hashtable params, 

               HttpServletResponse response) {

    String[] docid = (String[])params.get("docid");

    // delete the document from the database

    try {

      DBWriter dbw = new DBWriter(conn, saxparser);

                                      // NOTE -- NEED TO TEST HERE

                                      // FOR EXISTENCE OF PARAM

                                      // BEFORE ACCESSING ARRAY

      try {

        dbw.delete(docid[0]);

        response.setContentType("text/xml");

        out.println("<?xml version=\"1.0\"?>");

        out.println("<success>");

        out.println("Document deleted."); 

        out.println("</success>");

      } catch (AccessionNumberException ane) {

        response.setContentType("text/xml");

        out.println("<?xml version=\"1.0\"?>");

        out.println("<error>");

        out.println("Error deleting document!!!");

        out.println(ane.getMessage()); 

        out.println("</error>");

      }

    } catch (Exception e) {

      response.setContentType("text/xml");

      out.println("<?xml version=\"1.0\"?>");

      out.println("<error>");

      out.println(e.getMessage()); 

      out.println("</error>");

    }

  }

  /** 

   * Handle the validtion request and return the results to the requestor

   */

  private void handleValidateAction(PrintWriter out, Hashtable params, 

               HttpServletResponse response) {

    // Get the document indicated

    String valtext = null;

    try {

      valtext = ((String[])params.get("valtext"))[0];

    } catch (Exception nullpe) {

      String docid = null;

      try {

        // Find the document id number

        docid = ((String[])params.get("docid"))[0]; 

        // Get the document indicated fromthe db

        valtext = docreader.readXMLDocument(docid);

      } catch (NullPointerException npe) {

        response.setContentType("text/xml");

        out.println("<error>Error getting document ID: " + docid + "</error>");

      }

    }

    try {

      DBValidate valobj = new DBValidate(saxparser,conn);

      boolean valid = valobj.validateString(valtext);

      // set content type and other response header fields first

      response.setContentType("text/xml");

      out.println(valobj.returnErrors());

    } catch (NullPointerException npe2) {

      // set content type and other response header fields first

      response.setContentType("text/xml");

      out.println("<error>Error validating document.</error>"); 

    }

  }

  /** 

   * Handle the document request and return the results 

   * to the requestor

   */

  private void handleGetDataDocumentAction(PrintWriter out, Hashtable params, 

               HttpServletResponse response) {

      boolean error_flag = false;

      String error_message = "";

      // Get the document indicated

      String[] datadoc = (String[])params.get("datadoc");

      // defaultdatapath = "C:\\Temp\\";    // for testing only!!!

      // executescript = "test.bat";        // for testing only!!!

      // set content type and other response header fields first

      response.setContentType("application/octet-stream");

      if (defaultdatapath!=null) {

        if(!defaultdatapath.endsWith(System.getProperty("file.separator"))) {

          defaultdatapath=defaultdatapath+System.getProperty("file.separator");

        }

        System.out.println("Path= "+defaultdatapath+datadoc[0]);

        if (executescript!=null) {

          String command = null;

          File scriptfile = new File(executescript);

          if (scriptfile.exists()) {

            command=executescript+" "+datadoc[0]; // script includes path

        } else {     // look in defaultdatapath

            // on Win98 one MUST include the .bat extender

            command = defaultdatapath+executescript+" "+datadoc[0];  

        }

      System.out.println(command);

      try {

      Process proc = Runtime.getRuntime().exec(command);

      proc.waitFor();

      }

      catch (Exception eee) {

        System.out.println("Error running process!");

        error_flag = true;

        error_message = "Error running process!";}

      } // end executescript not null if

      File datafile = new File(defaultdatapath+datadoc[0]);

      try {

      FileInputStream fw = new FileInputStream(datafile);

      int x;

      while ((x = fw.read())!=-1) {

        out.write(x); }

        fw.close();

      } catch (Exception e) {

        System.out.println("Error in returning file\n"+e.getMessage());

        error_flag=true;

        error_message = error_message+"\nError in returning file\n"+

                        e.getMessage();

      }

    } // end defaultdatapath not null if

  }

}

/**

 * '$Log$

 * 'Revision 1.50  2000/06/30 23:42:33  bojilova

 * 'finished user auth & session tracking

 * '

 * 'Revision 1.49  2000/06/29 23:27:08  jones

 * 'Fixed bug in DBEntityResolver so that it now properly delegates to

 * 'the system id found inthe database.

 * 'Changed DBValidate to use DBEntityResolver, rather than the OASIS

 * 'catalog, and to return validation results in XML format.

 * '

 * 'Revision 1.48  2000/06/29 20:04:51  bojilova

 * 'testing login

 * '

 * 'Revision 1.36  2000/06/28 02:36:26  jones

 * 'Added feature to now ouput COMMENTs and PIs when the document is

 * 'read from the database with DBReader.

 * '

 * 'Revision 1.35  2000/06/28 00:00:47  bojilova

 * 'changed to

 * 'response.sendRedirect(response.encodeRedirectUrl("/xmltodb/lib/index.html"));

 * '

 * 'Revision 1.33  2000/06/27 04:50:33  jones

 * 'Updated javadoc documentation.

 * '

 * 'Revision 1.32  2000/06/27 04:31:07  jones

 * 'Fixed bugs associated with the new UPDATE and DELETE functions of

 * 'DBWriter.  There were problematic interactions between some static

 * 'variables used in DBEntityResolver and the way in which the

 * 'Servlet objects are re-used across multiple client invocations.

 * '

 * 'Generally cleaned up error reporting.  Now all errors and success

 * 'results are reported as XML documents from MetaCatServlet.  Need

 * 'to make the command line tools do the same.

 * '

 * 'Revision 1.31  2000/06/26 10:35:05  jones

 * 'Merged in substantial changes to DBWriter and associated classes and to

 * 'the MetaCatServlet in order to accomodate the new UPDATE and DELETE

 * 'functions.  The command line tools and the parameters for the

 * 'servlet have changed substantially.

 * '

 * 'Revision 1.30.2.6  2000/06/26 10:18:06  jones

 * 'Partial fix for MetaCatServlet INSERT?UPDATE bug.  Only will work on

 * 'the first call to the servlet.  Subsequent calls fail.  Seems to be

 * 'related to exception handling.  Multiple successive DELETE actions

 * 'work fine.

 * '

 * 'Revision 1.30.2.5  2000/06/26 09:09:53  jones

 * 'Modified MetaCatServlet and associated files to handle the UPDATE

 * 'and DELETE actions for DBWriter.

 * '

 * 'Revision 1.30.2.4  2000/06/26 00:51:06  jones

 * 'If docid passed to DBWriter.write() is not unique, classes now generate

 * 'an AccessionNumberException containing the new docid generated as a

 * 'replacement.  The docid is then extracted from the exception and

 * 'returned to the calling application for user feedback or client processing.

 * '

 * 'Revision 1.30.2.3  2000/06/25 23:38:17  jones

 * 'Added RCSfile keyword

 * '

 * 'Revision 1.30.2.2  2000/06/25 23:34:18  jones

 * 'Changed documentation formatting, added log entries at bottom of source files

 * ''

 */