Metacat

/**

 *        Name: MetaCatServlet.java

 *     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

 * 

 *     Version: '$Id: MetaCatServlet.java 100 2000-05-15 05:44:43Z jones $'

 */

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.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.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 oracle.xml.parser.v2.*;    //Oracle parser - DFH

import java.io.File;  //DFH

import java.io.FileInputStream; //DFH

/**

 * 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=getdocument -- display an XML document in XML or HTML<br>

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

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

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

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

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

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

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

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

   * valtext -- XML text to be validated

   * action=getdatadoc -- retreive a stored datadocument  //DFH

   * datadoc -- data document name (id)                   //DFH

 */

public class MetaCatServlet extends HttpServlet {

  private ServletConfig		config = null;

  private ServletContext	context = null;

  Connection 		conn = null;

  DBSimpleQuery		queryobj = null;

  DBReader		docreader = null;

  DBTransform		dbt = null;

  String 	user = null;

  String 	password = null;

  String 	defaultDB = null;

  String 	resultStyleURL = null;

  String 	xmlcatalogfile = null;

  String    defaultdatapath = null;  // path to directory where data files that can be downloaded will be stored

  String    executescript  = null;  // script to get data file and put it in defaultdocpath dir

  PropertyResourceBundle options = 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("Servlet Initialize");

      // Get the configuration file information

      options = (PropertyResourceBundle)PropertyResourceBundle.getBundle("edu.ucsb.nceas.metacat.metacat");

      user = (String)options.handleGetObject("user");

      password = (String)options.handleGetObject("password");

      defaultDB = (String)options.handleGetObject("defaultDB");

      resultStyleURL = (String)options.handleGetObject("resultStyleURL");

      xmlcatalogfile = (String)options.handleGetObject("xmlcatalogfile");

      defaultdatapath = (String)options.handleGetObject("defaultdatapath");

      executescript = (String)options.handleGetObject("executescript");

      try {

        // Open a connection to the database

        conn = MetaCatUtil.openDBConnection(

                "oracle.jdbc.driver.OracleDriver",

                defaultDB, user, password);

        queryobj = new DBSimpleQuery(conn);

        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 = MetaCatUtil.openDBConnection(

                "oracle.jdbc.driver.OracleDriver",

                defaultDB, user, password);

        queryobj = new DBSimpleQuery(conn);

        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();

    String name = null;

    String[] value = null;

    Hashtable params = new Hashtable();

    Enumeration paramlist = request.getParameterNames();

    while (paramlist.hasMoreElements()) {

      name = (String)paramlist.nextElement();

      value = request.getParameterValues(name);

      params.put(name,value);

    }

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

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

      handleQueryAction(out, params, response);

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

      try {

        handleGetDocumentAction(out, params, response);

      } catch (ClassNotFoundException e) {

        System.out.println(e.getMessage());

      } catch (SQLException se) {

        System.out.println(se.getMessage());

      }

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

      handlePutDocumentAction(out, params, response);

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

      handleValidateAction(out, params, response);  

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

      handleGetDataDocumentAction(out, params, response);  

    } else {

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

    }

    // Close the stream to the client

    out.close();

  }

  /** 

   * 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) {

      // Run the query

      Hashtable nodelist = null;

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

      if (queryobj != null) {

        nodelist = queryobj.findDocuments(query);

      } else {

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

	/*

        out.println(user);

        out.println(defaultDB);

        out.println(xmlcatalogfile);

        */

        return;

      }

      // Create a buffer to hold the xml result

      StringBuffer resultset = new StringBuffer();

      // Print the resulting root nodes

      Long nodeid;

      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 rootlist = nodelist.keys(); 

      while (rootlist.hasMoreElements()) {

        nodeid = (Long)rootlist.nextElement();

        document = (String)nodelist.get(nodeid);

        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 {

      // Find the document id number

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

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

      // Get the document indicated fromthe db

      String doc = docreader.readXMLDocument(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 = getDoctype(docid);

        // 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 handlePutDocumentAction(PrintWriter out, Hashtable params, 

               HttpServletResponse response) {

      // Get the document indicated

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

      StringReader xml = new StringReader(doctext[0]);

      // write the document to the database

      try {

        DBSAXWriter dbw = new DBSAXWriter(xml, conn);

      } catch (SQLException e1) {

          out.println("Error 1 loading document:<p>\n" + e1.getMessage());

      }catch (IOException e2) {

          out.println("Error 2 loading document:<p>\n" + e2.getMessage());

      }catch (ClassNotFoundException e3) {

          out.println("Error 3 loading document:<p>\n" + e3.getMessage());

      }

      // set content type and other response header fields first

      response.setContentType("text/xml");

      out.println(doctext[0]);

  }

  /** 

   * Handle the validtion request and return the results 

   * to the requestor - DFH

   */

  private void handleValidateAction(PrintWriter out, Hashtable params, HttpServletResponse response) {

      // Get the document indicated

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

      SAXParser parser = new SAXParser();           // works for both Xerces and Oracle

      parser.setValidationMode(true);               // Oracle

      GenericXMLValidate gxv = new GenericXMLValidate(parser, xmlcatalogfile);

      boolean valid = gxv.validateString(valtext[0]);

      // set content type and other response header fields first

      response.setContentType("text/plain");

      if (valid) {

        out.println("The input XML is VALID!");

      }

      else {

        out.println("The input XML is NOT VALID\n" + gxv.returnErrors());

      } 

    }

  /** 

   * Look up the document type from the database

   *

   */

  private String getDoctype(long docid) {

    // Look up the System ID of the XSL sheet

    PreparedStatement pstmt;

    String doctype = null;

    try {

      pstmt =

        conn.prepareStatement("SELECT doctype " + 

                                "FROM xml_documents " +

                               "WHERE docid = ?");

      // Bind the values to the query

      pstmt.setLong(1, new Long(docid).longValue());

      pstmt.execute();

      try {

        ResultSet rs = pstmt.getResultSet();

        try {

          boolean tableHasRows = rs.next();

          if (tableHasRows) {

            try {

              doctype  = rs.getString(1);

            } catch (SQLException e) {

              System.out.println("Error with getString: " + e.getMessage());

            }

          }

        } catch (SQLException e) {

          System.out.println("Error with next: " + e.getMessage());

        }

      } catch (SQLException e) {

        System.out.println("Error with getrset: " + e.getMessage());

      }

      pstmt.close();

    } catch (SQLException e) {

      System.out.println("Error getting id: " + e.getMessage());

    }

    return doctype;

  }

  /** 

   * Handle the document request and return the results 

   * to the requestor - DFH

   */

  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]; }  // execute script includes path

        else {     // look in defaultdatapath

                command = defaultdatapath+executescript+" "+datadoc[0];  // on Win98 one MUST include the .bat extender

        }

      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

  }

}