Metacat

 *  '$RCSfile$'

 *    Authors: Matt Jones, Dan Higgins, Jivka Bojilova, Chad Berkley

 *    Release: @release@

 *

 *   '$Author$'

 *

 */

import com.oreilly.servlet.multipart.FilePart;

import java.io.File;

import java.io.PrintWriter;

import java.io.StringReader;

import java.io.FileInputStream;

import java.io.BufferedInputStream;

import java.util.Enumeration;

import java.util.ResourceBundle;

import java.util.Random;

import java.util.PropertyResourceBundle;

import java.util.Vector;

import java.net.URL;

import java.sql.PreparedStatement;

import java.sql.Connection;

import java.sql.SQLException;

import java.lang.reflect.*;

import java.net.*;

import java.util.zip.*;

import javax.servlet.ServletInputStream;

import javax.servlet.http.HttpServlet;

import javax.servlet.http.HttpSession;

import javax.servlet.http.HttpUtils;

import javax.servlet.ServletOutputStream;

import org.xml.sax.SAXException;

/**

 *

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

 * action= -- export a zip format for data packadge<br>

 * action=read -- read any metadata/data file from Metacat and from Internet<br>

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

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

 * qformat=zip -- zip resultset from query<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>

 * acltext -- XML access text for a 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>

 * abstractpath -- XPath in metadata document to read from<br>

 * action=getaccesscontrol -- retrieve acl info for Metacat document<br>

 * action=getdtdschema -- retrieve a DTD or Schema file<br>

 * action=getdataguide -- retrieve a Data Guide<br>

 * action=getprincipals -- retrieve a list of principals in XML<br>

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

 * The particular combination of parameters that are valid for each

 * particular action value is quite specific.  This documentation

 */

  private ServletConfig config = null;

  private String datafilepath = null;

  private File dataDirectory = null;

  private String servletpath = null;

  private PropertyResourceBundle options = null;

  private DBConnectionPool connPool = null;

  private static final String PROLOG = "<?xml version=\"1.0\"?>";

  public static final String SCHEMALOCATIONKEYWORD = "xsi:schemaLocation";

  public static final String EML2KEYWORD ="<eml:eml";

  /**

  public void init( ServletConfig config ) throws ServletException {

      this.context = config.getServletContext();

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

      util = new MetaCatUtil();

      //initial DBConnection pool

      // Get the configuration file information

      resultStyleURL = util.getOption("resultStyleURL");

      datafilepath = util.getOption("datafilepath");

      servletpath = util.getOption("servletpath");

    } catch ( ServletException ex ) {

    } catch (SQLException e) {

    }

  /**

      // Close all db connection

      connPool.release();

  }

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

  public void doGet (HttpServletRequest request, HttpServletResponse response)

    // 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)

    handleGetOrPost(request, response);

  }

  /**

   * Control servlet response depending on the action parameter specified

   */

  private void handleGetOrPost(HttpServletRequest request,

  {

    if ( util == null ) {

        util = new MetaCatUtil();

    }

    /*MetaCatUtil.debugMessage("Connection pool size: "

                                     +connPool.getSizeOfDBConnectionPool(),10);

                                  +connPool.getFreeDBConnectionNumber(), 10);*/

    //If all DBConnection in the pool are free and DBConnection pool

    //size to initial value

    //Debug message to print out the method which have a busy DBConnection

    String ctype = request.getContentType();

      handleMultipartForm(request, response);

      String name = null;

      while (paramlist.hasMoreElements()) {

        name = (String)paramlist.nextElement();

        // Decode the docid and mouse click information

        }

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

        }

      //handle param is emptpy

      //if the user clicked on the input images, decode which image

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

      util.debugMessage("Line 230: Action is: " + action, 1);

      // This block handles session management for the servlet

      String[] groupnames = null;

      String sess_id = null;

      // handle login action

        PrintWriter out = response.getWriter();

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

        PrintWriter out = response.getWriter();

      // handle shrink DBConnection request

        //If all DBConnection in the pool are free and DBConnection pool

        //size to initial value

        HttpSession sess = request.getSession(true);

        if (sess.isNew()) {

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

          groupnames = (String[])sess.getAttribute("groupnames");

          try {

                               "happen: the session should be valid: " +

                               ise.getMessage());

        }

       // Now that we know the session is valid, we can delegate the request

      // to a particular action handler

        PrintWriter out = response.getWriter();

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

        PrintWriter out = response.getWriter();

        if(params.containsKey("query")) {

         handleSQuery(out, params,response,username,groupnames);

        } else {

          out.close();

        }

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

        handleExportAction(params, response, username, groupnames, password);

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

        handleReadAction(params, response, username,password, groupnames);

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

        PrintWriter out = response.getWriter();

        if ( (username != null) &&  !username.equals("public") ) {

          handleInsertOrUpdateAction(out,params,username,groupnames);

        } else {

          out.println("Permission denied for user"+username +" " + action);

        }

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

          handleDeleteAction(out, params, response, username, groupnames);

        } else {

          out.println("Permission denied for " + action);

        }

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

        handleValidateAction(out, params);

        out.close();

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

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

        handleGetAccessControlAction(out,params,response,username,groupnames);

        out.close();

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

        handleGetPrincipalsAction(out, username, password);

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

        handleGetDoctypesAction(out, params, response);

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

        handleGetDTDSchemaAction(out, params, response);

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

        handleGetDataGuideAction(out, params, response);

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

        handleGetMaxDocidAction(out, params, response);

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

      } else if (action.equals("login") || action.equals("logout")) {

          }

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

        }

      } else {

        out.close();

      }

      //util.closeConnections();

      // Close the stream to the client

      //out.close();

    }

  // LOGIN & LOGOUT SECTION

  /**

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

   * Do user authentication through the session.

   */

  private void handleLoginAction(PrintWriter out, Hashtable params,

               HttpServletRequest request, HttpServletResponse response) {

    AuthSession sess = null;

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

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

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

    try {

      sess = new AuthSession();

    } catch (Exception e) {

      System.out.println("error in MetacatServlet.handleLoginAction: " +

      out.println(e.getMessage());

      return;

    }

    boolean isValid = sess.authenticate(request, un, pw);

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

      out.println(sess.getMessage());

    } else {

      try {

        DBTransform trans = new DBTransform();

        response.setContentType("text/html");

        trans.transformXMLDocument(sess.getMessage(), "-//NCEAS//login//EN",

                                   "-//W3C//HTML//EN", qformat, out);

      } catch(Exception e) {

        MetaCatUtil.debugMessage("Error in MetaCatServlet.handleLoginAction: "

      }

    }

  }

  /**

   * Handle the logout request. Close the connection.

  private void handleLogoutAction(PrintWriter out, Hashtable params,

               HttpServletRequest request, HttpServletResponse response) {

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

    output.append("<logout>");

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

      out.println(output.toString());

    } else {

      try {

        DBTransform trans = new DBTransform();

        response.setContentType("text/html");

        trans.transformXMLDocument(output.toString(), "-//NCEAS//login//EN",

                                   "-//W3C//HTML//EN", qformat, out);

      } catch(Exception e) {

        MetaCatUtil.debugMessage("Error in MetaCatServlet.handleLogoutAction"

      }

    }

  // END OF LOGIN & LOGOUT SECTION

  // SQUERY & QUERY SECTION

  /**

   * Retreive the squery xml, execute it and display it

   * @param conn the database connection

   */

  protected void handleSQuery(PrintWriter out, Hashtable params,

                 HttpServletResponse response, String user, String[] groups)

  {

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

    String resultdoc = null;

    MetaCatUtil.debugMessage("xmlquery: "+xmlquery, 30);

    Hashtable doclist = runQuery(xmlquery, user, groups);

    double docListTime = System.currentTimeMillis()/1000;

    MetaCatUtil.debugMessage("Time for getting doc list: "

    resultdoc = createResultDocument(doclist, transformQuery(xmlquery));

    double toStringTime = System.currentTimeMillis()/1000;

    double outPutTime = 0;

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

      response.setContentType("text/xml");

      outPutTime = System.currentTimeMillis()/1000;

    } else {

      transformResultset(resultdoc, response, out, qformat);

      outPutTime = System.currentTimeMillis()/1000;

    }

  }

   /**

    * Create the xml query, execute it and display the results.

    * in the squery.

    * @param response the response object linked to the client

    */

                 HttpServletResponse response, String user, String[] groups)

  {

    //create the query and run it

    String xmlquery = DBQuery.createSQuery(params);

    Hashtable doclist = runQuery(xmlquery, user, groups);

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

    resultdoc = createResultDocument(doclist, transformQuery(params));

    //format and transform the results

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

      response.setContentType("text/xml");

    } else {

      transformResultset(resultdoc, response, out, qformat);

    }

  }

  /**

   * Removes the <?xml version="x"?> tag from the beginning of xmlquery

   *

   * @param xmlquery is the query to remove the <?xml version="x"?> tag from.

    //DBQuery.createSQuery is a re-calling of a previously called

    //function but it is necessary

  /**

   * removes the <?xml version="1.0"?> tag from the beginning.  This takes a

   *

   * @param xmlquery a string representing a query.

  /**

   * Run the query and return a hashtable of results.

  private Hashtable runQuery(String xmlquery, String user, String[] groups)

  {

    try

      DBQuery queryobj = new DBQuery(saxparser);

      doclist = queryobj.findDocuments(new StringReader(xmlquery),user,groups);

      return doclist;

    }

    {

                                                      + e.getMessage(), 30);

      doclist = null;

    }

  }

  /**

   * Transorms an xml resultset document to html and sends it to the browser

   *

   * @param resultdoc the string representation of the document that needs

   * @param qformat the name of the style-set to use for transformations

   */

                                    HttpServletResponse response,

                                    PrintWriter out, String qformat)