Metacat

/**

 *  '$RCSfile$'

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

 *              National Center for Ecological Analysis and Synthesis

 *

 *   '$Author: sgarg $'

 *     '$Date: 2005-10-20 11:39:24 -0700 (Thu, 20 Oct 2005) $'

 * '$Revision: 2683 $'

 *

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

import java.io.BufferedReader;

import java.io.InputStream;

import java.io.InputStreamReader;

import java.io.PushbackReader;

import java.io.IOException;

import java.io.StringWriter;

import java.io.Reader;

import java.net.URL;

import java.util.Properties;

import edu.ucsb.nceas.utilities.HttpMessage;

import edu.ucsb.nceas.utilities.IOUtil;

import java.io.File;

/**

 *  This interface provides methods for initializing and logging in to a

 *  Metacat server, and then querying, reading, transforming, inserting,

 *  updating and deleting documents from that server.

 */

public class MetacatClient implements Metacat

{

    /** The URL string for the metacat server */

    private String metacatUrl;

    /** The session identifier for the session */

    private String sessionId;

    /**

     * Constructor to create a new instance. Protected because instances

     * should only be created by the factory MetacatFactory.

     */

    protected MetacatClient()

    {

        this.metacatUrl = null;

        this.sessionId = null;

    }

    /**

     *  Method used to log in to a metacat server. Implementations will need

     *  to cache a cookie value to make the session persistent.  Each time a

     *  call is made to one of the other methods (e.g., read), the cookie will

     *  need to be passed back to the metacat server along with the request.

     *

     *  @param username   the username of the user, like an LDAP DN

     *  @param password   the password for that user for authentication

     *  @return the response string from metacat in XML format

     *  @throws MetacatAuthException when the username/password could

     *                    not be authenticated

     */

    public String login(String username, String password)

           throws MetacatAuthException, MetacatInaccessibleException

    {

        Properties prop = new Properties();

        prop.put("action", "login");

        prop.put("qformat", "xml");

        prop.put("username", username);

        prop.put("password", password);

        String response = null;

        try {

            response = sendDataForString(prop, null, null, 0);

        } catch (Exception e) {

            throw new MetacatInaccessibleException(e.getMessage());

        }

        if (response.indexOf("<login>") == -1) {

            setSessionId("");

            throw new MetacatAuthException(response);

        } else {

            int start = response.indexOf("<sessionId>") + 11;

            int end = response.indexOf("</sessionId>");

            if ((start != -1) && (end != -1)) {

                setSessionId(response.substring(start,end));

            }

        }

        return response;

    }

    /**

     *  Method used to log in to a metacat server. Implementations will need

     *  to cache a cookie value to make the session persistent.  Each time a

     *  call is made to one of the other methods (e.g., read), the cookie will

     *  need to be passed back to the metacat server along with the request.

     *

     *  @param username   the username of the user, like an LDAP DN

     *  @param password   the password for that user for authentication

     *  @return the response string from metacat in XML format

     *  @throws MetacatAuthException when the username/password could

     *                    not be authenticated

     */

    public String getloggedinuserinfo() throws MetacatInaccessibleException

    {

        Properties prop = new Properties();

        prop.put("action", "getloggedinuserinfo");

        prop.put("qformat", "xml");

        String response = null;

        try {

            response = sendDataForString(prop, null, null, 0);

        } catch (Exception e) {

            throw new MetacatInaccessibleException(e.getMessage());

        }

        return response;

    }

    /**

     *  Method used to log out a metacat server. The Metacat server will end

     *  the session when this call is invoked.

     *

     *  @return the response string from metacat in XML format

     *  @throws MetacatInaccessibleException when the metacat server can not be

     *                                    reached or does not respond

     */

    public String logout() throws MetacatInaccessibleException, MetacatException

    {

        Properties prop = new Properties();

        prop.put("action", "logout");

        prop.put("qformat", "xml");

        String response = null;

        try {

            response = sendDataForString(prop, null, null, 0);

        } catch (Exception e) {

            throw new MetacatInaccessibleException(e.getMessage());

        }

        if (response.indexOf("<logout>") == -1) {

            throw new MetacatException(response);

        }

        setSessionId("");

        return response;

    }

    /**

     * Read an XML document from the metacat server session, accessed by docid,

     * and returned as a Reader.

     *

     * @param docid the identifier of the document to be read

     * @return a Reader for accessing the document

     * @throws InsufficientKarmaException when the user has insufficent rights

     *                                    for the operation

     * @throws MetacatInaccessibleException when the metacat server can not be

     *                                    reached or does not respond

     * @throws MetacatException when the metacat server generates another error

     */

    public Reader read(String docid) throws InsufficientKarmaException,

        MetacatInaccessibleException, MetacatException

    {

        PushbackReader pbr = null;

        Properties prop = new Properties();

        prop.put("action", "read");

        prop.put("qformat", "xml");

        prop.put("docid", docid);

        InputStream response = null;

        try {

            response = sendData(prop, null, null, 0);

        } catch (Exception e) {

            throw new MetacatInaccessibleException(e.getMessage());

        }

        pbr = new PushbackReader(new InputStreamReader(response), 512);

        try {

            char[] characters = new char[512];

            int len = pbr.read(characters, 0, 512);

            StringWriter sw = new StringWriter();

            sw.write(characters, 0, len);

            String message = sw.toString();

            sw.close();

            pbr.unread(characters, 0, len);

            if (message.indexOf("<error>") != -1) {

                if (message.indexOf("does not have permission") != -1) {

                    throw new InsufficientKarmaException(message);

                } else {

                    throw new MetacatException(message);

                }

            }

        } catch (IOException ioe) {

            throw new MetacatException(

                    "MetacatClient: Error converting Reader to String."

                    + ioe.getMessage());

        }

        return pbr;

    }

    /**

        * Read inline data from the metacat server session, accessed by

        * inlinedataid and returned as a Reader.

        *

        * @param inlinedataid the identifier of the data to be read

        * @return a Reader for accessing the document

        * @throws InsufficientKarmaException when the user has insufficent rights

        *                                    for the operation

        * @throws MetacatInaccessibleException when the metacat server can not be

        *                                    reached or does not respond

        * @throws MetacatException when the metacat server generates another error

        */

       public Reader readInlineData(String inlinedataid)

           throws InsufficientKarmaException,

           MetacatInaccessibleException, MetacatException

       {

           PushbackReader pbr = null;

           Properties prop = new Properties();

           prop.put("action", "readinlinedata");

           prop.put("inlinedataid", inlinedataid);

           InputStream response = null;

           try {

               response = sendData(prop, null, null, 0);

           } catch (Exception e) {

               throw new MetacatInaccessibleException(e.getMessage());

           }

           pbr = new PushbackReader(new InputStreamReader(response), 512);

           try {

               char[] characters = new char[512];

               int len = pbr.read(characters, 0, 512);

               StringWriter sw = new StringWriter();

               sw.write(characters, 0, len);

               String message = sw.toString();

               sw.close();

               pbr.unread(characters, 0, len);

               if (message.indexOf("<error>") != -1) {

                   if (message.indexOf("does not have permission") != -1) {

                       throw new InsufficientKarmaException(message);

                   } else {

                       throw new MetacatException(message);

                   }

               }

           } catch (IOException ioe) {

               throw new MetacatException(

                       "MetacatClient: Error converting Reader to String."

                       + ioe.getMessage());

           }

           return pbr;

       }

    /**

     * Query the metacat document store with the given metacat-compatible

     * query document, and return the result set as a Reader.

     *

     * @param xmlQuery a Reader for accessing the XML version of the query

     * @return a Reader for accessing the result set

     */

    public Reader query(Reader xmlQuery) throws MetacatInaccessibleException,

                                                IOException

    {

        Reader reader = null;

        String query = null;

        try {

          query = IOUtil.getAsString(xmlQuery, true);

        } catch (IOException ioE) {

          throw ioE;

        }

        //set up properties

        Properties prop = new Properties();

        prop.put("action", "squery");

        prop.put("qformat", "xml");

        prop.put("query", query);

        InputStream response = null;

        try {

            response = sendData(prop, null, null, 0);

        } catch (Exception e) {

            throw new MetacatInaccessibleException(e.getMessage());

        }

        reader = new InputStreamReader(response);

        return reader;

    }

    /**

     * Insert an XML document into the repository.

     *

     * @param docid the docid to insert the document

     * @param xmlDocument a Reader for accessing the XML document to be inserted

     * @param schema a Reader for accessing the DTD or XML Schema for

     *               the document

     * @return the metacat response message

     * @throws InsufficientKarmaException when the user has insufficent rights

     *                                    for the operation

     * @throws MetacatInaccessibleException when the metacat server can not be

     *                                    reached or does not respond

     * @throws MetacatException when the metacat server generates another error

     * @throws IOException when there is an error reading the xml document

     */

    public String insert(String docid, Reader xmlDocument, Reader schema)

        throws InsufficientKarmaException, MetacatException, IOException,

        MetacatInaccessibleException

    {

        Reader reader = null;

        String doctext = null;

        String schematext = null;

        try {

          doctext = IOUtil.getAsString(xmlDocument, true);

          if (schema != null) {

              schematext = IOUtil.getAsString(schema, true);

          }

        } catch (IOException ioE) {

          throw ioE;

        }

        //set up properties

        Properties prop = new Properties();

        prop.put("action", "insert");

        prop.put("docid", docid);

        prop.put("doctext", doctext);

        if (schematext != null) {

            prop.put("dtdtext", schematext);

        }

        String response = null;

        try {

            response = sendDataForString(prop, null, null, 0);

        } catch (Exception e) {

            throw new MetacatInaccessibleException(e.getMessage());

        }

        // Check for an error condition

        if (response.indexOf("<error>") != -1) {

            if (response.indexOf("does not have permission") != -1) {

                throw new InsufficientKarmaException(response);

            } else {

                throw new MetacatException(response);

            }

        }

        return response;

    }

    /**

     * Update an XML document in the repository.

     *

     * @param docid the docid to update

     * @param xmlDocument a Reader for accessing the XML text to be updated

     * @param schema a Reader for accessing the DTD or XML Schema for

     *               the document

     * @return the metacat response message

     * @throws InsufficientKarmaException when the user has insufficent rights

     *                                    for the operation

     * @throws MetacatInaccessibleException when the metacat server can not be

     *                                    reached or does not respond

     * @throws MetacatException when the metacat server generates another error

     * @throws IOException when there is an error reading the xml document

     */

    public String update(String docid, Reader xmlDocument, Reader schema)

        throws InsufficientKarmaException, MetacatException, IOException,

        MetacatInaccessibleException

    {

        Reader reader = null;

        String doctext = null;

        String schematext = null;

        try {

          doctext = IOUtil.getAsString(xmlDocument, true);

          if (schema != null) {

              schematext = IOUtil.getAsString(schema, true);

          }

        } catch (IOException ioE) {

          throw ioE;

        }

        //set up properties

        Properties prop = new Properties();

        prop.put("action", "update");

        prop.put("docid", docid);

        prop.put("doctext", doctext);

        if (schematext != null) {

            prop.put("dtdtext", schematext);

        }

        String response = null;

        try {

            response = sendDataForString(prop, null, null, 0);

        } catch (Exception e) {

            throw new MetacatInaccessibleException(e.getMessage());

        }

        // Check for an error condition

        if (response.indexOf("<error>") != -1) {

            if (response.indexOf("does not have permission") != -1) {

                throw new InsufficientKarmaException(response);

            } else {

                throw new MetacatException(response);

            }

        }

        return response;

    }

    /**

       * Upload a data document into the repository.

       *

       * @param docid the docid to insert the document

       * @param document a Reader for accessing the document to be uploaded

       * @return the metacat response message

       * @throws InsufficientKarmaException when the user has insufficent rights

       *                                    for the operation

       * @throws MetacatInaccessibleException when the metacat server can not be

       *                                    reached or does not respond

       * @throws MetacatException when the metacat server generates another error

       * @throws IOException when there is an error reading the xml document

       */

      public String upload(String docid, File file)

          throws InsufficientKarmaException, MetacatException, IOException,

          MetacatInaccessibleException

      {

          URL url = new URL(metacatUrl.trim());

          HttpMessage msg = new HttpMessage(url);

          //set up properties

          Properties arg = new Properties();

          arg.put("action", "upload");

          arg.put("docid", docid);

          Properties filenames = new Properties();

          String filename = file.getAbsolutePath();

          filenames.put("datafile", filename);

          String response = null;

          try {

            response = sendDataForString(arg, filenames, null, 0);

          } catch (Exception e) {

            throw new MetacatInaccessibleException(e.getMessage());

          }

          // Check for an error condition

          if (response.indexOf("<error>") != -1) {

            if (response.indexOf("does not have permission") != -1) {

              throw new InsufficientKarmaException(response);

            } else {

              throw new MetacatException(response);

            }

          }

          return response;

      }

        /**

          * Upload a data document into the repository.

          *

          * @param docid the docid to insert the document

          * @param document a Reader for accessing the document to be uploaded

          * @return the metacat response message

          * @throws InsufficientKarmaException when the user has insufficent rights

          *                                    for the operation

          * @throws MetacatInaccessibleException when the metacat server can not be

          *                                    reached or does not respond

          * @throws MetacatException when the metacat server generates another error

          * @throws IOException when there is an error reading the xml document

          */

      public String upload(String docid, String filename, InputStream fileData,

                           int size)

          throws InsufficientKarmaException, MetacatException, IOException,

          MetacatInaccessibleException {

          URL url = new URL(metacatUrl.trim());

          HttpMessage msg = new HttpMessage(url);

          //set up properties

          Properties arg = new Properties();

          arg.put("action", "upload");

          arg.put("docid", docid);

          Properties filenames = new Properties();

          filenames.put("datafile", filename);

          String response = null;

          try {

            response = sendDataForString(arg, filenames, fileData, size);

          } catch (Exception e) {

            throw new MetacatInaccessibleException(e.getMessage());

          }

          // Check for an error condition

          if (response.indexOf("<error>") != -1) {

            if (response.indexOf("does not have permission") != -1) {

              throw new InsufficientKarmaException(response);

            } else {

              throw new MetacatException(response);

            }

          }

          return response;

      }

    /**

     * Delete an XML document in the repository.

     *

     * @param docid the docid to delete

     * @return the metacat response message

     * @throws InsufficientKarmaException when the user has insufficent rights

     *                                    for the operation

     * @throws MetacatInaccessibleException when the metacat server can not be

     *                                    reached or does not respond

     * @throws MetacatException when the metacat server generates another error

     */

    public String delete(String docid)

        throws InsufficientKarmaException, MetacatException,

        MetacatInaccessibleException

    {

        //set up properties

        Properties prop = new Properties();

        prop.put("action", "delete");

        prop.put("docid", docid);

        String response = null;

        try {

            response = sendDataForString(prop, null, null, 0);

        } catch (Exception e) {

            throw new MetacatInaccessibleException(e.getMessage());

        }

        // Check for an error condition

        if (response.indexOf("<error>") != -1) {

            if (response.indexOf("does not have permission") != -1) {

                throw new InsufficientKarmaException(response);

            } else {

                throw new MetacatException(response);

            }

        }

        return response;

    }

    /**

     * set the access on an XML document in the repository.

     *

     * @param _docid the docid of the document for which the access should be applied.

     *

     * @param _principal the document's principal

     *

     * @param _permission the access permission to be applied to the docid

     *  {e.g. read,write,all}

     *

     * @param _permType the permission type to be applied to the document

     *  {e.g. allow or deny}

     *

     * @param _permOrder the order that the document's permissions should be

     *  processed {e.g. denyFirst or allowFirst}

     *

     *

     * @return the metacat response message

     *

     * @throws InsufficientKarmaException when the user has insufficent rights

     *                                    for the operation

     * @throws MetacatInaccessibleException when the metacat server can not be

     *                                    reached or does not respond

     * @throws MetacatException when the metacat server generates another error

     */

    public String setAccess(String _docid, String _principal, String

                            _permission, String _permType, 

                            String _permOrder )

        throws InsufficientKarmaException, MetacatException,

        MetacatInaccessibleException

    {  

        //set up properties

        Properties prop = new Properties();

        prop.put("action", "setaccess");

        prop.put("docid", _docid);

        prop.put("principal", _principal);

        prop.put("permission", _permission);

        prop.put("permType", _permType);

        prop.put("permOrder", _permOrder);

        String response = null;

        try {

            response = sendDataForString(prop, null, null, 0);

        } catch (Exception e) {

            throw new MetacatInaccessibleException(e.getMessage());

        }

        // Check for an error condition

        if (response.indexOf("<error>") != -1) {

            if (response.indexOf("does not have permission") != -1) {

                throw new InsufficientKarmaException(response);

            } else {

                throw new MetacatException(response);

            }

        }

        return response;

    }

    /**

     * When the MetacatFactory creates an instance it needs to set the

     * MetacatUrl to which connections should be made.

     *

     * @param metacatUrl the URL for the metacat server

     */

    public void setMetacatUrl(String metacatUrl)

    {

        this.metacatUrl = metacatUrl;

    }

    /**

     * Get the session identifier for this session.  This is only valid if

     * the login methods has been called successfully for this Metacat object

     * beforehand.

     *

     * @returns the sessionId as a String, or null if the session is invalid

     */

    public String getSessionId()

    {

        return this.sessionId;

    }

    /**

     * Set the session identifier for this session.  This identifier was

     * previously established with a call to login.  To continue to use the

     * same session, set the session id before making a call to one of the

     * metacat access methods (e.g., read, query, insert, etc.).

     *

     * @param String the sessionId from a previously established session

     */

    public void setSessionId(String sessionId)

    {

        this.sessionId = sessionId;

    }

    /**

     * The method will return the lasted revision in metacat server 

     * for a given document id. If some error happent, this method will throw

     * a exception.   

     * @param docId String  the given docid you want to use. the docid it self

     *                      can have or haven't revision number

     * @throws MetacatException

     */

     public int getNewestDocRevision(String docId) throws MetacatException

     {

       int rev = 0;

       //set up properties

       Properties prop = new Properties();

       prop.put("action", "getrevisionanddoctype");

       prop.put("docid", docId);

       String response = null;

        try 

        {

            response = sendDataForString(prop, null, null, 0);

            String revStr = parserRevisionResponse(response);

            Integer revObj = new Integer(revStr);

            rev = revObj.intValue();

            // Check for an error condition

           if (response.indexOf("<error>") != -1) 

           {

              throw new MetacatException(response);

           }

        } 

        catch (Exception e) 

        {

            throw new MetacatException(e.getMessage());

        }

        return rev;

     }

    /************************************************************************

     * PRIVATE METHODS

     ************************************************************************/

    /**

     * Send a request to metacat.

     *

     * @param prop the properties to be URL encoded and sent

     * @param filename  the properties to be sent to Metacat

     *                  in case of upload, otherwise null

     * @param fileData  the inputStream for the file data to be sent to Metacat

     *                  in case of upload, otherwise null

     * @param size      the size of the data being sent to Metacat

     *                  in case of upload, otherwise 0

     */

    synchronized private InputStream sendDataOnce(Properties args,

                                                  Properties filename,

                                                  InputStream fileData,

                                                  int size)

        throws Exception

    {

        InputStream returnStream = null;

        URL url = new URL(metacatUrl);

        HttpMessage msg = new HttpMessage(url);

        msg.setCookie("JSESSIONID="+this.sessionId);

        if (filename == null){

            returnStream = msg.sendPostData(args);

        } else if (fileData == null){

            returnStream = msg.sendPostData(args, filename);

        } else if (size > 0) {

            returnStream = msg.sendPostData(args, filename, fileData, size);

        } else {

            throw new MetacatException("Invalid size specified for " +

                                       "the input stream being passed");

        }

        return returnStream;

    }

    /**

     * Send a request to Metacat

     *

     * @param args  the properties to be sent to Metacat

     * @param filename  the properties to be sent to Metacat

     *                  in case of upload, otherwise null

     * @param fileData  the inputStream for the file data to be sent to Metacat

     *                  in case of upload, otherwise null

     * @param size      the size of the data being sent to Metacat

     *                  in case of upload, otherwise 0

     * @return      InputStream as returned by Metacat

     */

    synchronized private InputStream sendData(Properties args,

                                              Properties filename,

                                              InputStream fileData,

                                              int size)

        throws Exception

    {

        InputStream returnStream = null;

        /*

            Note:  The reason that there are three try statements all executing

            the same code is that there is a problem with the initial connection

            using the HTTPClient protocol handler.  These try statements make

            sure that a connection is made because it gives each connection a

            2nd and 3rd chance to work before throwing an error.

            THIS IS A TOTAL HACK.  THIS NEEDS TO BE LOOKED INTO AFTER THE BETA1

            RELEASE OF MORPHO!!!  cwb (7/24/01)

          */

        try {

           return sendDataOnce(args, filename, fileData, size);

        } catch (Exception e) {

            try {

                return sendDataOnce(args, filename, fileData, size);

            } catch (Exception e2) {

                try {

                    return sendDataOnce(args, filename, fileData, size);

                } catch (Exception e3) {

                    System.err.println(

                            "Failed to send data to metacat 3 times.");

                    throw e3;

                }

            }

        }

    }

    /**

     * Send a request to Metacat

     *

     * @param args      the properties to be sent to Metacat

     * @param filename  the properties to be sent to Metacat

     *                  in case of upload, otherwise null

     * @param fileData  the inputStream for the file data to be sent to Metacat

     *                  in case of upload, otherwise null

     * @param size      the size of the data being sent to Metacat

     *                  in case of upload, otherwise 0

     * @return          a string as returned by Metacat

     */

    synchronized private String sendDataForString(Properties args,

                                                  Properties filename,

                                                  InputStream fileData,

                                                  int size)

        throws Exception

    {

        String response = null;

        try {

            InputStreamReader returnStream =

                    new InputStreamReader(sendData(args, filename,

                                                   fileData, size));

            StringWriter sw = new StringWriter();

            int len;

            char[] characters = new char[512];

            while ((len = returnStream.read(characters, 0, 512)) != -1) {

                sw.write(characters, 0, len);

            }

            returnStream.close();

            response = sw.toString();

            sw.close();

        } catch (Exception e) {

            throw e;

        }

        return response;

    }

    /*

     * "getversionanddoctype" action will return a string from metacat server.

     * The string format is "revision;doctype"(This is bad idea, we should use xml)

     * This method will get revision string from the response string

     */

    private String parserRevisionResponse(String response) throws Exception

    {

      String revision = null;

      if (response != null)

      {

        int firstSemiCol = response.indexOf(";");

        revision = response.substring(0, firstSemiCol);

      }

      return revision;

    }

}