Metacat

/**

 *    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

 *     '$Date$'

 * '$Revision$'

 * This program is free software; you can redistribute it and/or modify

 * it under the terms of the GNU General Public License as published by

 * the Free Software Foundation; either version 2 of the License, or

 * (at your option) any later version.

 *

 * This program is distributed in the hope that it will be useful,

 * but WITHOUT ANY WARRANTY; without even the implied warranty of

 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the

 * GNU General Public License for more details.

 *

 * You should have received a copy of the GNU General Public License

 * along with this program; if not, write to the Free Software

 * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA

package edu.ucsb.nceas.metacat;

import java.io.IOException;

import java.net.URL;

import java.sql.PreparedStatement;

import java.sql.ResultSet;

import java.sql.SQLException;

import java.text.ParseException;

import java.text.SimpleDateFormat;

import java.util.Hashtable;

import java.util.zip.ZipOutputStream;

import javax.servlet.ServletConfig;

import javax.servlet.ServletContext;

import javax.servlet.ServletException;

import javax.servlet.http.HttpServletRequest;

import javax.servlet.http.HttpServletResponse;

import com.oreilly.servlet.multipart.MultipartParser;

import com.oreilly.servlet.multipart.ParamPart;

import com.oreilly.servlet.multipart.Part;

import org.apache.log4j.PropertyConfigurator;

 * A metadata catalog server implemented as a Java Servlet

 * 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= -- 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>

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

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

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

 * dtdtext -- XML DTD text for a new DTD to load into Metacat XML Catalog <br>

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

 * <br>

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

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

 * action=getdoctypes -- retrieve all doctypes (publicID) <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>

 * ipAddress --  filter on one or more IP addresses<br>

 * principal -- filter on one or more principals (LDAP DN syntax)<br>

 * docid -- filter on one or more document identifiers (with revision)<br>

 * event -- filter on event type (e.g., read, insert, update, delete)<br>

 * start -- filter out events before the start date-time<br>

 * end -- filter out events before the end date-time<br>

 * 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.

{

    private static Logger logMetacat = Logger.getLogger(MetaCatServlet.class);

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

            String dirPath = context.getRealPath(CONFIG_DIR);

            File propertyFile = new File(dirPath, CONFIG_NAME);

            PropertyConfigurator.configureAndWatch(LOG_CONFIG_NAME);

            try {

                options = Options.initialize(propertyFile);

                        + options.getOption("configured"));

                        + ioe.getMessage());

            connPool = DBConnectionPool.getInstance();

            resultStyleURL = MetaCatUtil.getOption("resultStyleURL");

            xmlcatalogfile = MetaCatUtil.getOption("xmlcatalogfile");

            saxparser = MetaCatUtil.getOption("saxparser");

            datafilepath = MetaCatUtil.getOption("datafilepath");

            dataDirectory = new File(datafilepath);

            servletpath = MetaCatUtil.getOption("servletpath");

            htmlpath = MetaCatUtil.getOption("htmlpath");

            checkIndexPaths();

            throw ex;

        } catch (SQLException e) {

                    + e.getMessage());

     * Close all db connections from the pool

     */

    public void destroy()

    {

        // Close all db connection

        System.out.println("Destroying MetacatServlet");

        DBConnectionPool.release();

    }

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

    }

     */

            = MetaCatUtil.getOptionList(MetaCatUtil.getOption("indexed_paths"));

            int serialNumber = -1;

            PreparedStatement pstmt = null;

            PreparedStatement pstmt1 = null;

            ResultSet rs = null;

                    //check out DBConnection

                    conn = DBConnectionPool.

                        getDBConnection("MetaCatServlet.checkIndexPaths");

                    serialNumber = conn.getCheckOutSerialNumber();

                        "SELECT * FROM xml_path_index " + "WHERE path = ?");

                    pstmt.setString(1, (String) MetaCatUtil.pathsForIndexing

                                    .elementAt(i));

                    rs = pstmt.getResultSet();

                        pstmt.close();

                        conn.increaseUsageCount(1);

                              + (String)MetaCatUtil.pathsForIndexing

                              + "n.nodedata, n.nodedatanumerical, n.parentnodeid"

                              + " FROM xml_nodes n, xml_index i WHERE"

                              + " i.path = ? and n.parentnodeid=i.nodeid and"

                              + " n.nodetype LIKE 'TEXT'");

                        pstmt.setString(1, (String) MetaCatUtil.

                                        pathsForIndexing.elementAt(i));

                        pstmt.execute();

                        rs = pstmt.getResultSet();

                                       + (String) MetaCatUtil.pathsForIndexing

                            while (rs.next()) {

                                String nodedata = rs.getString(2);

                                float nodedatanumerical = rs.getFloat(3);

                                int parentnodeid = rs.getInt(4);

                                    pstmt1 = conn.prepareStatement(

                                        "INSERT INTO xml_path_index"

                                        + " (docid, path, nodedata, "

                                        + "nodedatanumerical, parentnodeid)"

                                        + " VALUES (?, ?, ?, ?, ?)");

                                    pstmt1.setString(2, (String) MetaCatUtil.

                                                pathsForIndexing.elementAt(i));

                                    pstmt1.setString(3, nodedata);

                                    pstmt1.setFloat(4, nodedatanumerical);

                                    pstmt1.close();

                            }

                        }

                        catch (Exception e) {

                            System.out.println("Exception:" + e.getMessage());

                            e.printStackTrace();

                        }

                        pstmt.close();

                        conn.increaseUsageCount(1);

                                + (String) MetaCatUtil.pathsForIndexing.elementAt(i)

                    pstmt.close();

                    conn.increaseUsageCount(1);

                                             + e.getMessage());

                    //check in DBonnection

                    DBConnectionPool.returnDBConnection(conn, serialNumber);

                }

     * Control servlet response depending on the action parameter specified

     */

    private void handleGetOrPost(HttpServletRequest request,

            HttpServletResponse response) throws ServletException, IOException

            util = new MetaCatUtil();

        }

        /*

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

        //size is greater than initial value, shrink the connection pool

        //size to initial value

        DBConnectionPool.shrinkDBConnectionPoolSize();

        connPool.printMethodNameHavingBusyDBConnection();

        if (ctype != null && ctype.startsWith("multipart/form-data")) {

            handleMultipartForm(request, response);

        } else {

            String[] value = null;

            String[] docid = new String[3];

            Hashtable params = new Hashtable();

            Enumeration paramlist = request.getParameterNames();

                value = request.getParameterValues(name);

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

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

                    params.put("docid", docid);

                    name = "ypos";

                }

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

                    name = "xpos";

                }

            }

            if (params.isEmpty() || params == null) { return; }

            //was clicked then set the action.

                PrintWriter out = response.getWriter();

                response.setContentType("text/xml");

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

                out.println("<error>");

                out.println("Action not specified");

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

                out.close();

                return;

            }

            // by looking up the current session information for all actions

            // other than "login" and "logout"

            String username = null;

            String password = null;

            String[] groupnames = null;

            String sess_id = null;

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

                PrintWriter out = response.getWriter();

                handleLoginAction(out, params, request, response);

                out.close();

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

                PrintWriter out = response.getWriter();

                handleLogoutAction(out, params, request, response);

                out.close();

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

                PrintWriter out = response.getWriter();

                boolean success = false;

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

                // pool

                //size is greater than initial value, shrink the connection

                // pool

                //size to initial value

                success = DBConnectionPool.shrinkConnectionPoolSize();

                if (success) {

                    //if successfully shrink the pool size to initial value

                    out.println("DBConnection Pool shrunk successfully.");

                }//if

                else {

                    out.println("DBConnection pool not shrunk successfully.");

                }

                //close out put

                out.close();

            } else {

                HttpSession sess = request.getSession(true);

                if (sess.isNew() && !params.containsKey("sessionid")) {

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

                            "The session is new or no sessionid is assigned. The user is public");

                    sess.setAttribute("username", username);

                } else {

                            + "has sessionid parameter");

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

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

                                    + sess_id);

                                        + sess_id + " in hash table");

                            }

                        } else {

                            // we already store the session in login, so we

                            // don't need here

                            /*

                             * (String)sess.getId();

                             * sess.getAttribute("username") + " into session

                             * hash in handleGetOrPost method", 35);

                             */

                        }

                    } catch (IllegalStateException ise) {

                                "Error in handleGetOrPost: this shouldn't "

                                + ise.getMessage());

                    }

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

                if (username == null || (username.trim().equals(""))) {

                    username = "public";

                }

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

            // request

            // to a particular action handler

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

                PrintWriter out = response.getWriter();

                handleQuery(out, params, response, username, groupnames,

                        sess_id);

                out.close();

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

                PrintWriter out = response.getWriter();

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

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

                            sess_id);

                    out.close();

                } else {

                    out.println(

                            "Illegal action squery without \"query\" parameter");

                    out.close();

                }

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

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

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

                PrintWriter out = response.getWriter();

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

                            out, params, username, groupnames);

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

                    out.println("<error>");

                            + action);

                out.close();

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

                PrintWriter out = response.getWriter();

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

                } else {

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

                    out.println("<error>");

                out.close();

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

                PrintWriter out = response.getWriter();

                handleValidateAction(out, params);

                out.close();

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

                PrintWriter out = response.getWriter();

                handleSetAccessAction(out, params, username);

                out.close();

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

                PrintWriter out = response.getWriter();

                handleGetAccessControlAction(out, params, response, username,

                        groupnames);

                out.close();

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

                PrintWriter out = response.getWriter();

                handleGetPrincipalsAction(out, username, password);

                out.close();

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

                PrintWriter out = response.getWriter();

                handleGetDoctypesAction(out, params, response);

                out.close();

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

                PrintWriter out = response.getWriter();

                handleGetDTDSchemaAction(out, params, response);

                out.close();

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

                PrintWriter out = response.getWriter();

                handleGetMaxDocidAction(out, params, response);

                out.close();

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

                PrintWriter out = response.getWriter();

                handleGetRevisionAndDocTypeAction(out, params);

                out.close();

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

                response.setContentType("text/xml");

                PrintWriter out = response.getWriter();

                out.println(Version.getVersionAsXml());

                out.close();

                PrintWriter out = response.getWriter();

                response.setContentType("text/xml");

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

                out.println("\n<user>\n");

                out.println("\n<username>\n");

                out.println(username);

                out.println("\n</username>\n");

                if(name!=null){

                	out.println("\n<name>\n");

                	out.println(name);

                	out.println("\n</name>\n");

                }

                if(MetaCatUtil.isAdministrator(username, groupnames)){

                	out.println("<isAdministrator></isAdministrator>\n");

                }

                if(MetaCatUtil.isModerator(username, groupnames)){

                	out.println("<isModerator></isModerator>\n");

                }

                out.println("\n</user>\n");

                out.close();

                String testURL = "metacat://dev.nceas.ucsb.edu/NCEAS.897766.9";

                try {

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

                } catch (Throwable t) {

                }

                String phandler = System

                        .getProperty("java.protocol.handler.pkgs");

                response.setContentType("text/html");

                PrintWriter out = response.getWriter();

                out.println("<body bgcolor=\"white\">");

                out.println("<p>Handler property: <code>" + phandler

                        + "</code></p>");

                out.println("<p>Starting test for:<br>");

                out.println("    " + testURL + "</p>");

                try {

                    URL u = new URL(testURL);

                    out.println("<pre>");

                    out.println("Protocol: " + u.getProtocol());

                    out.println("    Host: " + u.getHost());

                    out.println("    Port: " + u.getPort());

                    out.println("    Path: " + u.getPath());

                    out.println("     Ref: " + u.getRef());

                    String pquery = u.getQuery();