Metacat

/**

 *  '$RCSfile$'

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

 *              National Center for Ecological Analysis and Synthesis

 *    Purpose: To test the ReplicationServerList class by JUnit

 *    Authors: Jing Tao

 *

 *   '$Author$'

 *     '$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.metacattest;

import edu.ucsb.nceas.metacat.*;

import edu.ucsb.nceas.metacat.client.Metacat;

import edu.ucsb.nceas.metacat.client.MetacatFactory;

import edu.ucsb.nceas.utilities.IOUtil;

import edu.ucsb.nceas.utilities.Options;

import edu.ucsb.nceas.utilities.XMLUtilities;

//import edu.ucsb.nceas.morpho.framework.*;

import junit.framework.Test;

import junit.framework.TestCase;

import junit.framework.TestResult;

import junit.framework.TestSuite;

import org.apache.commons.logging.Log;

import org.apache.commons.logging.LogFactory;

import org.w3c.dom.Document;

import org.w3c.dom.Node;

import org.w3c.dom.NodeList;

import java.io.*;

import java.net.*;

import java.util.*;

/**

 * This class is used to change the data file location for IPCC eml documents.

 * Currently IPCC eml documents point data file ti SRB server. However, the srb 

 * earthgrid is not very stable. We decided to change the online URL from srb to knb.

 * So this class will handle this case.

 * Before running this program, it needs:

 * 1. Downloaded data files from SRB

 * 2. A list of IPCC docid(with revision number) text file. If the text file is not available, it need

 * a metacat query file to search metacat to get the doicd list.

 * What the class will do:

 * 1. After getting a eml docid form the docid list, it will read the eml from Metacat.

 * 2. DOM parser will get online URL information from eml document.

 * 3. It will generate docid for data file and modify the URL in eml base on the generated docid.

 * 4. Base on old URL information, this program will find the data file in the direcotry which contains

 * the srb data file, then upload the download srb data file to Metacat with assigned docid.

 *  5. Update eml document with the new URL information (pointing to knb).

 * 

 */ 

public class UploadIPCCDataTest extends TestCase

{

	  private static final Log log = LogFactory.getLog("edu.ucsb.nceas.metacattest.UploadIPCCDataTest");

	  /* Initialize Options*/

	  static

	  {

		  try

		  {

			  Options.initialize(new File("build/tests/metacat.properties"));

			  MetaCatUtil.pathsForIndexing 

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

		  }

		  catch(Exception e)

		  {

			  System.err.println("Exception in initialize option in MetacatServletNetTest "+e.getMessage());

		  }

	  }

	  /**Constants*/

	  private static String SRBDATAFILEDIR = "/home/tao/data-file"; // Dir for storing srb data file

	  private static String DOCLISTFILE       = "docidList"; // File name which stores IPCC document id

	  private static String METACATURL      = "http://chico.dyndns.org/knb/metacat";

	  private static String USERNAME          = "uid=tao,o=NCEAS,dc=ecoinformatics,dc=org";

	  private static String PASSWORD           = "password";

	  private static String TABLEONLINEURL= "/eml/dataset/dataTable/physical/distribution/online/url";

	  private static String SPATIALONLINEURL = "/eml/dataset/spatialRaster/physical/distribution/online/url";

	  private static String SRB                           = "srb://";

	  /**

	   * Constructor to build the test

	   *

	   * @param name the name of the test method

	   */

	  public UploadIPCCDataTest(String name)

	  {

	    super(name);

	  }

	  /**

	   * Create a suite of tests to be run together

	   */

	  public static Test suite()

	  {

		   TestSuite suite = new TestSuite();

		    suite.addTest(new UploadIPCCDataTest("upload"));

		    return suite;

	 }

	  /**

	   * Upload the data file to Metacat and modify the eml documents

	   * @return

	   * @throws Exception

	   */

	  public void upload()

	  {

		      // Get eml document first

			  Vector list = getDocumentList();

			  //If list is not empty, goes through every document by handleSingleEML method -

			  //1. It will read the eml from Metacat.

			  // 2. Get online URL information from eml document by DOM parser.

			  // 3. Base on the URL information, this program will find the data file in

			  // the direcotry which contains the srb data file.

			  // 4. It will generate docid for the data file

			  // 5. Modify the eml document with the new URL information (pointing to

			  // knb) and new version number in eml,  then update it to a new version in Metacat.

			  //6. At last upload the download srb data file to Metacat with assigned docid.

              if (list != null && !list.isEmpty())

              {

            	   int size = list.size();

            	   for (int i=0; i<size; i++)

            	   {

            		   String docid = null;

            		   try

            		   {

            			   docid = (String)list.elementAt(i);

            			   handleSingleEML(docid);

            		   }

            		   catch(Exception e)

            		   {

            			   System.err.println("Failed to handle eml document "+docid + " since "+

            					   e.getMessage());

            		   }

            	   }

              }

              else

              {

            	  System.err.println("There is no EML document to handle");

              }

	  }

	  /*

	   * Does actually job to upload data file and modify eml document for a given id.

	   * Here are its tasts:

	   * 1. It will read the eml from Metacat.

	   * 2. Get online URL information from eml document by DOM parser.

	   * 3. Base on the URL information, this program will find the data file in

	   *     the direcotry which contains the srb data file.

	   * 4. It will generate docid for the data file.

	   * 5. Modify the eml document with the new URL information (pointing to

	   *     knb) and new version number in eml,  then update it to a new version in Metacat.

	   * 6.  At last upload the download srb data file to Metacat with assigned docid.

	   */	 

	  private void handleSingleEML(String docid) throws Exception

	  {

		  Metacat metacat = MetacatFactory.createMetacatConnection(METACATURL);

		  // login metacat 

		  String loginResponse = metacat.login(USERNAME, PASSWORD);

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

		  {

			  throw new Exception("login failed "+loginResponse);

		  }

		  // Reads eml document from metacat

		  Reader r = metacat.read(docid);

          Document DOMdoc = XMLUtilities.getXMLReaderAsDOMDocument(r);

          // Gets online url information. If onlineUrl is not SRB, through an exception

          String onlineUrl = getOnLineURL(DOMdoc);

          // Find the srb data file name

          // Generate docid for data file

          //String dataId = generateId();

          // Updates eml online url and package id

          //updateEMLDoc();

          // update EML document in metacat

          // upload data file to Metacat

          metacat.logout();

	  }

	  /*

	   * Gets onlineUrl value from a given eml DOM document.

	   * The online url xpath can be "/eml/dataset/dataTable/physical/distribution/online/url"

	   * or "/eml/dataset/spatialRaster/physical/distribution/online/url"

	   */

	  private String getOnLineURL(Document doc) throws Exception

	  {

		  String url = null;

		  if (doc == null)

		  {

			  throw new Exception("DOM document for this EML is null and couldn't get online url from it");

		  }

		  Node root = (Node)doc.getDocumentElement();

		  if (root == null)

		  {

			  throw new Exception("root node for this EML is null and couldn't get online url from it");

		  }

		  Node urlNode = XMLUtilities.getTextNodeWithXPath(root, TABLEONLINEURL);

		  // in table online url does exist, we will try to use another xpath - SPATIALONLEURL

		  if (urlNode == null)

		  {

			  urlNode = XMLUtilities.getTextNodeWithXPath(root, SPATIALONLINEURL);

		  }

		  // Couldn't find any matche element, throw exception

		  if(urlNode == null)

		  {

			  throw new Exception("Couldn't find any onlie url information in eml document");

		  }

		  //Gets text node value and if the url doesn't contain "srb;//", it will throw a exception

		 url = urlNode.getNodeValue();

		 if (url == null || url.indexOf(SRB)== -1)

		 {

			 throw new Exception("The online url doesn't have srb protocol and we don't need to handle");

		 }

		  return url;

	  }

      /*

       * Gets eml document list from text file. The text file format should be:

       * tao.1.1

       * tao.2.1

       */

	  private Vector getDocumentListFromFile() throws Exception

	  {

		  Vector docList = new Vector();

		  File docListFile = new File(SRBDATAFILEDIR,DOCLISTFILE);

		  FileReader docListFileReader= new FileReader(docListFile);

		  BufferedReader readDocList = new BufferedReader(docListFileReader);

		  // Read every line from the text file and put it into a vector

		  String docid = readDocList.readLine();

		  while (docid != null)

		  {

			  // If the docid string is not empty, put it into vector

			  if (!docid.trim().equals(""))

			  {

			     docList.add(docid.trim());

			  }

			  docid = readDocList.readLine();

		  }

		  return docList;

	  }

	  /*

	   * Gets eml document list from searching Metacat

	   * TO-DO: This method need to be implemented

	   */

	  private Vector getDocumentListFromMetacat()

	  {

		  Vector docList = new Vector();

		  return docList;

	  }

	  /*

	   * Get eml document list. First this method will try

	   * to get the eml document list form text file. If the result is empty or

	   * it caught an exception it will try to get eml document list from metacat.

	   */

	  private Vector getDocumentList()

	  {

		  Vector list = null;

		  try

		  {

			  //First, try to get eml doc list from text file

			  list = getDocumentListFromFile();

			  if (list == null || list.isEmpty())

			  {

				  throw new Exception("The eml doclist is empty in text file");

			  }

		  }

		  catch(Exception e)

		  {

			  System.err.println("Couldn't get eml document list from text file: "+e.getMessage());

			  // If an exception happened, try to get eml doc list from metacat

			  list = getDocumentListFromMetacat();

		  }

		  if (list != null)

		  {

			  System.out.println("the list is "+list);

		  }

		  return list;

	  }

}