Metacat

/**

 *  '$RCSfile$'

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

 *              National Center for Ecological Analysis and Synthesis

 *

 *   '$Author: Serhan AKIN $'

 *     '$Date: 2009-06-13 15:28:13 +0300  $'

 *

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

import java.util.*;

import javax.mail.MessagingException;

import javax.mail.internet.MimeMultipart;

import javax.servlet.http.HttpServletRequest;

import javax.servlet.http.HttpServletResponse;

import java.text.SimpleDateFormat;

import org.dataone.service.exceptions.InsufficientResources;

import org.dataone.service.exceptions.InvalidRequest;

import org.dataone.service.exceptions.InvalidSystemMetadata;

import org.dataone.service.exceptions.InvalidToken;

import org.dataone.service.exceptions.NotAuthorized;

import org.dataone.service.exceptions.NotImplemented;

import org.jibx.runtime.IBindingFactory;

import org.jibx.runtime.JiBXException;

import edu.ucsb.nceas.metacat.DBUtil;

import edu.ucsb.nceas.metacat.McdbDocNotFoundException;

import edu.ucsb.nceas.metacat.util.SessionData;

/**

 *

 * Implements Earthgrid REST API to Metacat <br/><br/>

 *

 * <ul>

 * <li>

 * <h3> EarthGrid Query Service</h3>

 * <ul><li>

 * <h3>Get & Authenticated Get:</h3>

 * is equal to Metacat's read action and returns a data file having

 * the specified <doc-id> in the resource path. For authenticated Get service, a session id must be provided

 * in the query string. <br/><br/>

 *

 * </li>

 *

 * <li>

 * <h3>Query & Authenticated Query:</h3>

 * Metacat's equivalent is squery action but this function

 * receives a Earthgrid query document and returns Earthgrid resultset document by transforming those documents

 * to Metacat's equivalents by the means of Metacat Implementation in Earthgrid library. For authenticated Query service

 * a session id must be provided in the query string. See Earthgrid (a.k.a. Ecogrid) project for XSD files of

 * query and resultset documents<br/><br/>

 *

 * <b>Returns:</b> Earthgrid resultset document<br/><br/>

 *

 * </li>

 * </ul>

 *

 * </li>

 *

 * <li>

 * <h3> EarthGrid Authentication Service</h3>

 * <ul><li>

 * <h3>Login: </h3>

 * Receives username and password parameters in POST data and

 * returns SessionId (in XML format) or failure message and uses MetacatHandler's handleLoginAction function<br/><br/>

 *

 * <b>REST URL:</b> <code>POST, [context-root]/session?op=login</code> <br/>

 * <b>POST Data:</b> username=[username]&password=[password], Content-type: <code>application/x-www-form-urlencoded</code>

 * <b>Returns:</b> sessionId in XML format<br/><br/>

 * </li>

 *

 * <li>

 * <h3>Logout: </h3>

 * Receives session Id parameters in querystring and returns xml message, calls

 * MetacatHandler's handleLogoutAction function<br/><br/>

 *

 * <b>REST URL:</b>	<code>GET, [context-root]/session?op=logout&sessionid=[sessionid]</code>   <br/>

 * <b>Returns:</b> message in XML format<br/><br/>

 * </li>

 * </ul>

 *

 * <li>

 * <h3>EarthGrid Put Service</h3>

 *

 * <ul>

 * <li><h3>Update/Insert: </h3>

 * <br/>

 * <b>Returns:</b> message in XML format<br/><br/>

 * </li>

 *

 * <li><h3>Delete: </h3>

 * <br/>

 * </li>

 * </ul>

 * </li>

 *

 * <li>

 * <h3>EarthGrid Identifier Service</h3><br/>

 *

 * <ul>

 * <li><h3>isRegistered: </h3>		<br/>

 * <b>REST URL:</b>	<code>GET, [context-root]/identifier/[doc-id]?op=isregistered</code>   <br/>

 * <b>Returns:</b> message in XML format<br/><br/>

 * </li>

 * <li><h3>getAllDocIds:</h3>		<br/>

 * <b>REST URL:</b>	<code>GET, [context-root]/identifier?op=getalldocids</code>   <br/>

 * <b>Returns:</b> document id list in XML format<br/><br/>

 * </li>

 *

 * <li><h3>addLSID Function:</h3>

 * Metacat does not support this function 		<br/>

 * <b>REST URL:</b>	<code>PUT, [context-root]/identifier/[doc-id]</code>   <br/>

 * <b>Returns:</b> error message in XML format<br/><br/>

 * </li>

 *

 * <li><h3>getNextRevision:</h3>		<br/>

 * <b>REST URL:</b>	<code>GET, [context-root]/identifier/[doc-id]?op=getnextrevision</code>   <br/>

 * <b>Returns:</b> message in XML format<br/><br/>

 * </li>

 *

 * <li><h3>getNextObject:</h3>		<br/>

 * <b>REST URL:</b>	<code>GET, [context-root]/identifier?op=getnextobject&scope=[scope]</code>   <br/>

 * <b>Returns:</b> message in XML format<br/><br/>

 * </li>

 *

 * </li>

 * </ul>

 *

 */

public class ResourceHandler {

    /**HTTP Verb GET*/

    public static final byte GET = 1;

    /**HTTP Verb POST*/

    public static final byte POST = 2;

    /**HTTP Verb PUT*/

    public static final byte PUT = 3;

    /**HTTP Verb DELETE*/

    public static final byte DELETE = 4;

    /*

     * API Resources

     */

    private static final String RESOURCE_IDENTIFIER = "identifier";

    /*

     * API Functions used as URL parameters

     */

    private static final String FUNCTION_KEYWORD = "op";

    private static final String FUNCTION_NAME_LOGIN = "login";

    private static final String FUNCTION_NAME_LOGOUT = "logout";

    private static final String FUNCTION_NAME_GETALLDOCS = "getalldocids";

    private static final String FUNCTION_NAME_GETNEXTREV = "getnextrevision";

    private static final String FUNCTION_NAME_GETNEXTOBJ = "getnextobject";

    private static final String FUNCTION_NAME_INSERT = "insert";

    private static final String FUNCTION_NAME_UPDATE = "update";

    private ServletContext servletContext;

    private Logger logMetacat;

    private MetacatHandler handler;

    private HttpServletRequest request;

    private HttpServletResponse response;

    private String username;

    private String password;

    private String sessionId;

    private String[] groupNames;

    private Hashtable<String, String[]> params;

    /**Initializes new instance by setting servlet context,request and response*/

    public ResourceHandler(ServletContext servletContext,

            HttpServletRequest request, HttpServletResponse response) {

        this.servletContext = servletContext;

        this.request = request;

        this.response = response;

    }

    /**

     * This function is called from REST APU servlet and handles each request to the servlet

     *

     * @param httpVerb (GET, POST, PUT or DELETE)

     */

    public void handle(byte httpVerb) {

        logMetacat = Logger.getLogger(ResourceHandler.class);

        try {

            String resource = request.getServletPath();

            //System.out.println("handling verb " + httpVerb + " request with resource " + resource);

            if (resource != null) {

                resource = request.getServletPath().substring(1);

                params = new Hashtable<String, String[]>();

                initParams();

                Timer timer = new Timer();

                    httpVerb == POST &&

                    params.get(FUNCTION_KEYWORD) != null) {

                    //System.out.println("function set access: " + FUNCTION_NAME_SET_ACCESS);

                        if (params.get(FUNCTION_KEYWORD)[0].equals(FUNCTION_NAME_LOGIN)) {

                            status = true;

                            status = true;

                            //System.out.println("setting access in resourceHandler");

                            setaccess();

                            status = true;

                            //System.out.println("done setting access");

                    } else if (resource.equals(RESOURCE_META)) {

                           params.get(FUNCTION_KEYWORD)[0].equals(FUNCTION_NAME_GENERATE_MISSING_SYSTEM_METADATA))

                          //a) not system metadata itself

                          //b) does not already have a system metadata id in the systemmetadata table

                          //c) not a BIN object (data)

                            generateMissingSystemMetadata();

                            status = true;

                        }

                        else

                            String objectId = request.getPathInfo();

                            if (objectId != null && objectId.length() > 1)

                            {

                                objectId = request.getPathInfo().substring(1);

                            }

                            getSystemMetadataObject(objectId);

                            status = true;

                    } else if (resource.equals(RESOURCE_OBJECTS)) {

                    String objectId = request.getPathInfo();

                    {

                        objectId = request.getPathInfo().substring(1);

                    {

                        objectId = null;

                    }

                    if (httpVerb == GET) {

                    } else if (httpVerb == POST) {

                    } else if (httpVerb == PUT) {

                    } else if (httpVerb == DELETE) {

                        deleteObject(objectId);

                        status = true;

                    }

                } else if (resource.equals(RESOURCE_IDENTIFIER)) {

                    String identifierId = request.getPathInfo();

                    if (identifierId != null && identifierId.length() > 1)

                        identifierId = request.getPathInfo().substring(1); //trim the slash

                    if (httpVerb == GET) {

                        String op = params.get(FUNCTION_KEYWORD)[0];

                        if (op.equals(FUNCTION_NAME_ISREGISTERED)) {

                            isRegistered(identifierId);

                            status = true;

                        } else if (op.equals(FUNCTION_NAME_GETALLDOCS)) {

                            getAllDocIds();

                            status = true;

                        } else if (op.equals(FUNCTION_NAME_GETNEXTREV)) {

                            getNextRevision(identifierId);

                            status = true;

                        } else if (op.equals(FUNCTION_NAME_GETNEXTOBJ)) {

                            getNextObject();

                            status = true;

                    } else if (httpVerb == PUT) {

                        //Earthgrid API > Identifier Service > addLSID Function

                        printError(

                                "This method is not supported by metacat.  To "

                                        + "add a new LSID, add a document to metacat.",

                                response);

                        status = true;

                    }

                    //handle log events

                    if(httpVerb == GET)

                    {

                        getLog();

                        status = true;

                    }

                    else

                    {

                        printError("POST, PUT, DELETE is not supported for logs.", response);

                        status = true;

                    }

                    printError("Incorrect parameters!", response);

            } else {

                printError("Incorrect resource!", response);

            }

        } catch (Exception e) {

            logMetacat.error(e.getMessage());

            e.printStackTrace();

        }

    }

    /**

     * params are token, fromDate, toDate, event.  See

     * http://mule1.dataone.org/ArchitectureDocs/mn_api_crud.html#MN_crud.getLogRecords

     * for more info

     */

    private void getLog()

    {

        OutputStream out = null;

        try

        {

            out = response.getOutputStream();

            AuthToken token = new AuthToken(sessionId);

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

            Date fromDate = null;

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

            Date toDate = null;

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

            Event event = null;

            {

            if(toDateS != null)

            {

            if(eventS != null)

            {

                event = Event.convert(eventS);

            }

            serializeServiceType(Log.class, log, out);

        }

        catch(Exception e)

        {

            String msg = "Could not get logs from CrudService: " + e.getMessage();

            ServiceFailure sf = new ServiceFailure("1490", msg);

            logMetacat.error(msg);

            e.printStackTrace();

            serializeException(sf, out);

        }

    }

    /**

     */

    private void initParams() {

        String[] value = null;

        Enumeration paramlist = request.getParameterNames();

        while (paramlist.hasMoreElements()) {

            name = (String) paramlist.nextElement();

            value = request.getParameterValues(name);

            params.put(name, value);

        }

    }

     * Load user details of metacat session from the request

     *

     */

    private void loadSessionData()

      throws Exception

    {

        SessionData sessionData = RequestUtil.getSessionData(request);

        try

        {

            username = null;

            password = null;

            groupNames = null;

            sessionId = null;

            boolean validSession = false;

            SessionService ss = SessionService.getInstance();

            System.out.println("username: " + sessionData.getUserName());

            System.out.println("sessionid: " + sessionData.getId());

               !(sessionData.getUserName().equals("public") || sessionData.getId().equals("0")))

                validSession = true;

            }

            if(validSession)

            {

                //if the session is valid, set these variables

                username = sessionData.getUserName();

                password = sessionData.getPassword();

                groupNames = sessionData.getGroupNames();

                sessionId = sessionData.getId();

                System.out.println("username: " + username);

            //if the session is not valid or the username is null, set

            //username to public

            if (username == null)

            {

            }

        }

        catch(Exception e)

        {

            throw new Exception("Could not load the session data: " + e.getMessage());

        }

    }

    /**

     * generate missing system metadata for any science metadata objects

     * that don't already have it. https://trac.dataone.org/ticket/591

     * called with POST meta/?op=generatemissingsystemmetadata

    private void generateMissingSystemMetadata()

    {

        CrudService.getInstance().generateMissingSystemMetadata(token);

    /**

     *  Earthgrid API > Identifier Service > isRegistered Function :

     *  calls MetacatHandler > handleIdIsRegisteredAction

     */

    {

        // Look up the localId for this guid

        IdentifierManager im = IdentifierManager.getInstance();

        String localId = "";

        try {

            localId = im.getLocalId(guid);

        } catch (McdbDocNotFoundException e) {

            // TODO: Need to return the proper DataONE exception

        }

        params.put("docid", new String[] { localId });

        handler.handleIdIsRegisteredAction(out, params, response);

        out.close();

    }

    /**

     * calls MetacatHandler > handleGetAllDocidsAction

     */

    private void getAllDocIds() throws IOException {

        PrintWriter out = response.getWriter();

        handler.handleGetAllDocidsAction(out, params, response);

        out.close();

    }

    /**

     * calls MetacatHandler > handleGetRevisionAndDocTypeAction

     */

    {

        params.put("docid", new String[] { guid });

        //handler.handleGetRevisionAndDocTypeAction(out, params);

        try {

            // Make sure there is a docid

            IdentifierManager im = IdentifierManager.getInstance();

            String localId = "";

            try {

                localId = im.getLocalId(guid);

            } catch (McdbDocNotFoundException e) {

                // TODO: Need to return the proper DataONE exception

            }

            DBUtil dbutil = new DBUtil();

            // Get a rev and doctype

            String revAndDocType = dbutil

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

            out.print("<next-revision>");

            out.print(revision);

            out.print("</next-revision>");

        } catch (Exception e) {

            // Handle exception

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

            out.println("<error>");

            out.println(e.getMessage());

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

        }

        out.close();

    }

    /**

     * calls MetacatHandler > handleGetMaxDocidAction

     */

    private void getNextObject() throws IOException {

        PrintWriter out = response.getWriter();

        handler.handleGetMaxDocidAction(out, params, response);

        out.close();

    }

    /**

        cs.setParamsFromRequest(request);

            { //get a specific document

                Identifier id = new Identifier();

                id.setValue(guid);

                InputStream data = cs.get(token, id);

                IOUtils.copyLarge(data, response.getOutputStream());

            }

            else

            { //call listObjects with specified params

                Date startTime = null;

                Date endTime = null;

                ObjectFormat objectFormat = null;

                boolean replicaStatus = false;

                int start = 0;

                int count = 1000;

                Enumeration paramlist = request.getParameterNames();

                while (paramlist.hasMoreElements())

                { //parse the params and make the crud call

                    String name = (String) paramlist.nextElement();

                    String[] value = (String[])request.getParameterValues(name);

                    if(name.equals("startTime") && value != null)

                        try

                        {

                          startTime = DateFormat.getDateTimeInstance().parse(value[0]);

                        }

                        catch(Exception e)

                        {  //if we can't parse it, just don't use the startTime param

                            System.out.println("Could not parse startTime: " + value[0]);

                            startTime = null;

                        }

                    }

                        try

                        {

                          endTime = DateFormat.getDateTimeInstance().parse(value[0]);

                        }

                        catch(Exception e)

                        {  //if we can't parse it, just don't use the endTime param

                            System.out.println("Could not parse endTime: " + value[0]);

                            endTime = null;

                        }

                    }

                        objectFormat = ObjectFormat.convert(value[0]);

                    }

                           value.length > 0 &&

                           (value[0].equals("true") || value[0].equals("TRUE") || value[0].equals("YES")))

                            replicaStatus = true;

                        }

                    }

                        start = new Integer(value[0]).intValue();

                    }

                        count = new Integer(value[0]).intValue();

                    }

                }

                //make the crud call

                        objectFormat + " replicaStatus: " + replicaStatus +

                        " start: " + start + " count: " + count);

                        objectFormat, replicaStatus, start, count);

                // Serialize and write it to the output stream

                try {

                    throw new ServiceFailure("1190", "Failed to serialize ObjectList: " + e.getMessage());

                }

            }

    /**

     * @param guid ID of data object to be read

     */

    private void getSystemMetadataObject(String guid) {

        cs.setParamsFromRequest(request);

        try {

            out = response.getOutputStream();

            Identifier id = new Identifier();

            id.setValue(guid);

            SystemMetadata sysmeta = cs.getSystemMetadata(token, id);

            // Serialize and write it to the output stream