Metacat

/**

 *  '$RCSfile$'

 *    Purpose: A Class for upgrading the database to version 1.5

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

 *             National Center for Ecological Analysis and Synthesis

 *    Authors: Saurabh Garg

 *

 *   '$Author: leinfelder $'

 *     '$Date: 2011-12-16 11:00:44 -0800 (Fri, 16 Dec 2011) $'

 * '$Revision: 6800 $'

 *

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

import java.io.BufferedInputStream;

import java.io.IOException;

import java.io.InputStream;

import java.math.BigInteger;

import java.security.NoSuchAlgorithmException;

import java.sql.SQLException;

import java.util.ArrayList;

import java.util.Collections;

import java.util.Date;

import java.util.HashMap;

import java.util.Hashtable;

import java.util.List;

import java.util.Map;

import java.util.Vector;

import javax.xml.parsers.ParserConfigurationException;

import javax.xml.xpath.XPathExpressionException;

import org.apache.commons.beanutils.BeanUtils;

import org.apache.commons.io.IOUtils;

import org.apache.log4j.Logger;

import org.apache.wicket.protocol.http.MockHttpServletRequest;

import org.dataone.client.ObjectFormatCache;

import org.dataone.ore.ResourceMapFactory;

import org.dataone.service.exceptions.BaseException;

import org.dataone.service.exceptions.NotFound;

import org.dataone.service.types.v1.AccessPolicy;

import org.dataone.service.types.v1.Checksum;

import org.dataone.service.types.v1.Identifier;

import org.dataone.service.types.v1.NodeReference;

import org.dataone.service.types.v1.ObjectFormatIdentifier;

import org.dataone.service.types.v1.Session;

import org.dataone.service.types.v1.Subject;

import org.dataone.service.types.v1.SystemMetadata;

import org.dataone.service.types.v1.util.ChecksumUtil;

import org.dataone.service.util.DateTimeMarshaller;

import org.dspace.foresite.ResourceMap;

import org.ecoinformatics.datamanager.DataManager;

import org.ecoinformatics.datamanager.database.DatabaseConnectionPoolInterface;

import org.ecoinformatics.datamanager.parser.DataPackage;

import org.jibx.runtime.JiBXException;

import org.xml.sax.SAXException;

import edu.ucsb.nceas.metacat.AccessionNumber;

import edu.ucsb.nceas.metacat.AccessionNumberException;

import edu.ucsb.nceas.metacat.DBUtil;

import edu.ucsb.nceas.metacat.IdentifierManager;

import edu.ucsb.nceas.metacat.McdbDocNotFoundException;

import edu.ucsb.nceas.metacat.McdbException;

import edu.ucsb.nceas.metacat.MetaCatServlet;

import edu.ucsb.nceas.metacat.MetacatHandler;

import edu.ucsb.nceas.metacat.accesscontrol.AccessControlException;

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

import edu.ucsb.nceas.metacat.dataone.hazelcast.HazelcastService;

import edu.ucsb.nceas.metacat.dataquery.MetacatDatabaseConnectionPoolFactory;

import edu.ucsb.nceas.metacat.properties.PropertyService;

import edu.ucsb.nceas.metacat.replication.ReplicationService;

import edu.ucsb.nceas.metacat.shared.AccessException;

import edu.ucsb.nceas.metacat.shared.HandlerException;

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

import edu.ucsb.nceas.utilities.ParseLSIDException;

import edu.ucsb.nceas.utilities.PropertyNotFoundException;

public class SystemMetadataFactory {

	private static final String resourceMapPrefix = "resourceMap_";

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

	/**

	 * Creates a system metadata object for insertion into metacat

	 * 

	 * @param localId

	 *            The local document identifier

	 * @param user

	 *            The user submitting the system metadata document

	 * @param groups

	 *            The groups the user belongs to

	 * 

	 * @return sysMeta The system metadata object created

	 * @throws SAXException 

	 * @throws HandlerException 

	 * @throws AccessControlException 

	 * @throws AccessException 

	 */

	public static SystemMetadata createSystemMetadata(String localId, boolean includeORE)

			throws McdbException, McdbDocNotFoundException, SQLException,

			IOException, AccessionNumberException, ClassNotFoundException,

			InsufficientKarmaException, ParseLSIDException,

			PropertyNotFoundException, BaseException, NoSuchAlgorithmException,

			JiBXException, AccessControlException, HandlerException, SAXException, AccessException {

		logMetacat.debug("MetacatHandler.createSystemMetadata() called.");

		logMetacat.debug("provided localId: " + localId);

		// create system metadata for the document

		SystemMetadata sysMeta = new SystemMetadata();

		sysMeta.setSerialVersion(BigInteger.valueOf(1));

		int rev = IdentifierManager.getInstance().getLatestRevForLocalId(localId);

		AccessionNumber accNum = new AccessionNumber(localId, "NONE");

		String guid = null;

		try {

			// get the guid if it exists

			guid = IdentifierManager.getInstance().getGUID(accNum.getDocid(), rev);

		} catch (McdbDocNotFoundException dnfe) {

			// otherwise create the mapping

			logMetacat.debug("There was a problem getting the guid from "

							+ "the given localId (docid and revision). The error message was: "

							+ dnfe.getMessage());

			logMetacat.debug("No guid in the identifier table.  adding it for " + localId);

			IdentifierManager.getInstance().createMapping(localId, localId);

			logMetacat.debug("Mapping created for " + localId);

			logMetacat.debug("accessionNumber: " + accNum);

			guid = IdentifierManager.getInstance().getGUID(accNum.getDocid(), rev);

		}

		Identifier identifier = new Identifier();

		identifier.setValue(guid);

		// set the id

		sysMeta.setIdentifier(identifier);

		// get the data or metadata object

		InputStream inputStream;

		try {

			inputStream = MetacatHandler.read(localId);

		} catch (ParseLSIDException ple) {

			logMetacat.debug("There was a problem parsing the LSID from "

					+ localId + ". The error message was: " + ple.getMessage());

			throw ple;

		} catch (PropertyNotFoundException pnfe) {

			logMetacat.debug("There was a problem finding a property. "

					+ "The error message was: " + pnfe.getMessage());

			throw pnfe;

		} catch (McdbException me) {

			logMetacat.debug("There was a Metacat problem. "

					+ "The error message was: " + me.getMessage());

			throw me;

		} catch (SQLException sqle) {

			logMetacat.debug("There was a SQL problem. "

					+ "The error message was: " + sqle.getMessage());

			throw sqle;

		} catch (ClassNotFoundException cnfe) {

			logMetacat.debug("There was a problem finding a class. "

					+ "The error message was: " + cnfe.getMessage());

			throw cnfe;

		} catch (IOException ioe) {

			logMetacat.debug("There was an I/O exception. "

					+ "The error message was: " + ioe.getMessage());

			throw ioe;

		} // end try()

		// get additional docinfo

		Hashtable<String, String> docInfo = ReplicationService.getDocumentInfoMap(localId);

		// set the default object format

		String doctype = docInfo.get("doctype");

		ObjectFormatIdentifier fmtid = null;

		// set the object format, fall back to defaults

		try {

			fmtid = ObjectFormatCache.getInstance().getFormat(doctype).getFormatId();

		} catch (NotFound nfe) {

			try {

				// format is not registered, use default

				if (doctype.trim().equals("BIN")) {

					fmtid = ObjectFormatCache.getInstance().getFormat(

							"application/octet-stream").getFormatId();

				} else {

					fmtid = ObjectFormatCache.getInstance().getFormat(

							"text/plain").getFormatId();

				}

			} catch (NotFound nf) {

				logMetacat.error("There was a problem getting the default format "

								+ "from the ObjectFormatCache: "

								+ nf.getMessage());

				throw nf;

			}

		}

		sysMeta.setFormatId(fmtid);

		logMetacat.debug("The ObjectFormat for " + localId + " is " + fmtid.getValue());

		// create the checksum

		inputStream = MetacatHandler.read(localId);

		String algorithm = "MD5";

		Checksum checksum = ChecksumUtil.checksum(inputStream, algorithm);

		sysMeta.setChecksum(checksum);

		// set the size

		inputStream = MetacatHandler.read(localId);

		String sizeStr = new Long(sizeOfStream(inputStream)).toString();

		sysMeta.setSize(new BigInteger(sizeStr));

		// submitter

		Subject submitter = new Subject();

		submitter.setValue(docInfo.get("user_updated"));

		sysMeta.setSubmitter(submitter);

		// rights holder

		Subject owner = new Subject();

		owner.setValue(docInfo.get("user_owner"));

		sysMeta.setRightsHolder(owner);

		// dates

		String createdDateString = docInfo.get("date_created");

		String updatedDateString = docInfo.get("date_updated");

		Date createdDate = DateTimeMarshaller.deserializeDateToUTC(createdDateString);

		Date updatedDate = DateTimeMarshaller.deserializeDateToUTC(updatedDateString);  

		sysMeta.setDateUploaded(createdDate);

		sysMeta.setDateSysMetadataModified(updatedDate);

		// set the revision history

		String docidWithoutRev = accNum.getDocid();

		Identifier obsoletedBy = null;

		Identifier obsoletes = null;

		Vector<Integer> revisions = DBUtil.getRevListFromRevisionTable(docidWithoutRev);

		// ensure this ordering since processing depends on it

		Collections.sort(revisions);

		for (int existingRev: revisions) {

			// use the docid+rev as the guid

			String existingPid = docidWithoutRev + "." + existingRev;

			if (existingRev < rev) {

				// it's the old docid, until it's not

				obsoletes = new Identifier();

				obsoletes.setValue(existingPid);

			}

			if (existingRev > rev) {

				// it's the newer docid

				obsoletedBy = new Identifier();

				obsoletedBy.setValue(existingPid);

				// only want the version just after it

				break;

			}

		}

		// set them on our object

		sysMeta.setObsoletedBy(obsoletedBy);

		sysMeta.setObsoletes(obsoletes);

		// update the system metadata for the object[s] we are revising

		if (obsoletedBy != null) {

			//SystemMetadata obsoletedBySysMeta = HazelcastService.getInstance().getSystemMetadataMap().get(obsoletedBy);

			SystemMetadata obsoletedBySysMeta = IdentifierManager.getInstance().getSystemMetadata(obsoletedBy.getValue());

			if (obsoletedBySysMeta != null) {

				obsoletedBySysMeta.setObsoletes(identifier);

				HazelcastService.getInstance().getSystemMetadataMap().put(obsoletedBy, obsoletedBySysMeta);

			}

		}

		if (obsoletes != null) {

			//SystemMetadata obsoletesSysMeta = HazelcastService.getInstance().getSystemMetadataMap().get(obsoletes);

			SystemMetadata obsoletesSysMeta = IdentifierManager.getInstance().getSystemMetadata(obsoletes.getValue());

			if (obsoletesSysMeta != null) {

				obsoletesSysMeta.setObsoletedBy(identifier);

				HazelcastService.getInstance().getSystemMetadataMap().put(obsoletes, obsoletesSysMeta);

			}

		}

		// look up the access control policy we have in metacat

		AccessPolicy accessPolicy = IdentifierManager.getInstance().getAccessPolicy(guid);

		sysMeta.setAccessPolicy(accessPolicy);

		// authoritative node

		NodeReference nr = new NodeReference();

		nr.setValue(PropertyService.getProperty("dataone.memberNodeId"));

		sysMeta.setOriginMemberNode(nr);

		sysMeta.setAuthoritativeMemberNode(nr);

		// further parse EML documents to get data object format,

		// describes and describedBy information

		if (fmtid == ObjectFormatCache.getInstance().getFormat(

				"eml://ecoinformatics.org/eml-2.0.0").getFormatId()

				|| fmtid == ObjectFormatCache.getInstance().getFormat(

						"eml://ecoinformatics.org/eml-2.0.1").getFormatId()

				|| fmtid == ObjectFormatCache.getInstance().getFormat(

						"eml://ecoinformatics.org/eml-2.1.0").getFormatId()

				|| fmtid == ObjectFormatCache.getInstance().getFormat(

						"eml://ecoinformatics.org/eml-2.1.1").getFormatId()) {

			try {

				inputStream = MetacatHandler.read(localId);

				DatabaseConnectionPoolInterface connectionPool = 

					MetacatDatabaseConnectionPoolFactory.getDatabaseConnectionPoolInterface();

				DataManager dataManager = 

					DataManager.getInstance(connectionPool, connectionPool.getDBAdapterName());

				DataPackage dataPackage = dataManager.parseMetadata(inputStream);

				// iterate through the data objects in the EML doc and add sysmeta

				logMetacat.debug("In createSystemMetadata() the number of data "

								+ "entities is: "

								+ dataPackage.getEntityNumber());

				// for generating the ORE map

	            Map<Identifier, List<Identifier>> idMap = new HashMap<Identifier, List<Identifier>>();

	            List<Identifier> dataIds = new ArrayList<Identifier>();

				// iterate through data objects described by the EML

	            if (dataPackage.getEntityList() != null) {

					for (int j = 0; j < dataPackage.getEntityList().length; j++) {

						String dataDocUrl = dataPackage.getEntityList()[j].getURL();

						String dataDocMimeType = dataPackage.getEntityList()[j].getDataFormat();

						// default to binary

						if (dataDocMimeType == null) {

							dataDocMimeType = ObjectFormatCache.getInstance()

									.getFormat("application/octet-stream")

									.getFormatId().getValue();

						}

						String dataDocLocalId = "";

						logMetacat.debug("Data local ID: " + dataDocLocalId);

						logMetacat.debug("Data URL     : " + dataDocUrl);

						logMetacat.debug("Data mime    : " + dataDocMimeType);

						// we only handle ecogrid urls right now

						String ecogridPrefix = "ecogrid://knb/";

						if (dataDocUrl.trim().startsWith(ecogridPrefix)) {

							dataDocLocalId = dataDocUrl.substring(dataDocUrl

									.indexOf(ecogridPrefix)

									+ ecogridPrefix.length());

							// look up the guid for the data

							String dataDocid = DocumentUtil.getSmartDocId(dataDocLocalId);

							int dataRev = DocumentUtil.getRevisionFromAccessionNumber(dataDocLocalId);

							// check if data system metadata exists already

							SystemMetadata dataSysMeta = null;

							String dataGuidString = null;

							Identifier dataGuid = new Identifier();

							try {

								// look for the identifier

								dataGuidString = IdentifierManager.getInstance().getGUID(dataDocid, dataRev);

								// set it

								dataGuid.setValue(dataGuidString);

								// look up the system metadata

								try {

									dataSysMeta = HazelcastService.getInstance().getSystemMetadataMap().get(dataGuid);

								} catch (Exception e) {

									// probably not in the system

									dataSysMeta = null;

								}

								//dataSysMeta = IdentifierManager.getInstance().getSystemMetadata(dataGuidString);

							} catch (McdbDocNotFoundException nf) {

								// we didn't find it

								dataSysMeta = null;

							}

							// we'll have to generate it	

							if (dataSysMeta == null) {

								// System metadata for data doesn't exist yet, so create it

								logMetacat.debug("There was not an existing system metadata document for " + dataDocLocalId);

								try {

									logMetacat.debug("Creating a system metadata " + "document for " + dataDocLocalId);

									dataSysMeta = createSystemMetadata(dataDocLocalId, includeORE);

									// now look it up again

									dataGuidString = IdentifierManager.getInstance().getGUID(dataDocid, dataRev);

									// set the guid

									dataGuid.setValue(dataGuidString);

									// set object format

									logMetacat.debug("Updating system metadata for "

													+ dataGuid.getValue() + " to "

													+ dataDocMimeType);

									try {

										ObjectFormatIdentifier fmt = 

											ObjectFormatCache.getInstance().getFormat(dataDocMimeType).getFormatId();

										dataSysMeta.setFormatId(fmt);

									} catch (NotFound nfe) {

										logMetacat.debug("Couldn't find format identifier for: "

														+ dataDocMimeType

														+ ". Setting it to application/octet-stream.");

										ObjectFormatIdentifier newFmtid = new ObjectFormatIdentifier();

										newFmtid.setValue("application/octet-stream");

									}

									// update the values

									HazelcastService.getInstance().getSystemMetadataMap().put(dataSysMeta.getIdentifier(), dataSysMeta);

								} catch (McdbDocNotFoundException mdnf) {

									mdnf.printStackTrace();

									throw mdnf;

								} catch (NumberFormatException nfe) {

									nfe.printStackTrace();

									throw nfe;

								} catch (AccessionNumberException ane) {

									ane.printStackTrace();

									throw ane;

								} catch (SQLException sqle) {

									sqle.printStackTrace();

									throw sqle;

								} catch (NoSuchAlgorithmException nsae) {

									nsae.printStackTrace();

									throw nsae;

								} catch (IOException ioe) {

									ioe.printStackTrace();

									throw ioe;

								} catch (PropertyNotFoundException pnfe) {

									pnfe.printStackTrace();

									throw pnfe;

								} catch (BaseException be) {

									be.printStackTrace();

									throw be;

								}	

							}

							// part of the ORE package

							dataIds.add(dataGuid);

						} // end if (EML package)

					} // end for (data entities)

	            } // data entities not null

				// ORE map

				if (includeORE) {

					// can we generate them?

			        if (!dataIds.isEmpty()) {

			        	// it doesn't exist in the system?

			        	if (!oreExistsFor(sysMeta.getIdentifier())) {

				            // generate the ORE map for this datapackage

				            Identifier resourceMapId = new Identifier();

				            // want to be able to run this over and over again for now

				            resourceMapId.setValue(resourceMapPrefix + sysMeta.getIdentifier().getValue());

				            idMap.put(sysMeta.getIdentifier(), dataIds);

				            ResourceMap rm = ResourceMapFactory.getInstance().createResourceMap(resourceMapId, idMap);

				            String resourceMapXML = ResourceMapFactory.getInstance().serializeResourceMap(rm);

				            // copy most of the same system metadata as the packaging metadata

				            SystemMetadata resourceMapSysMeta = new SystemMetadata();

				            BeanUtils.copyProperties(resourceMapSysMeta, sysMeta);

				            resourceMapSysMeta.setIdentifier(resourceMapId);

				            Checksum oreChecksum = ChecksumUtil.checksum(IOUtils.toInputStream(resourceMapXML, MetaCatServlet.DEFAULT_ENCODING), "MD5");

							resourceMapSysMeta.setChecksum(oreChecksum);

				            ObjectFormatIdentifier formatId = ObjectFormatCache.getInstance().getFormat("http://www.openarchives.org/ore/terms").getFormatId();

							resourceMapSysMeta.setFormatId(formatId);

							resourceMapSysMeta.setSize(BigInteger.valueOf(sizeOfStream(IOUtils.toInputStream(resourceMapXML, MetaCatServlet.DEFAULT_ENCODING))));

							// set the revision graph

							resourceMapSysMeta.setObsoletes(null);

							resourceMapSysMeta.setObsoletedBy(null);

							// look up the resource map that this one obsoletes

							if (sysMeta.getObsoletes() != null) {

								Identifier resourceMapObsoletes = new Identifier();

								resourceMapObsoletes.setValue(resourceMapPrefix + sysMeta.getObsoletes().getValue());

								resourceMapSysMeta.setObsoletes(resourceMapObsoletes);

								SystemMetadata resourceMapObsoletesSystemMetadata = HazelcastService.getInstance().getSystemMetadataMap().get(resourceMapObsoletes);

								if (resourceMapObsoletesSystemMetadata != null) {

									resourceMapObsoletesSystemMetadata.setObsoletedBy(resourceMapId);

									HazelcastService.getInstance().getSystemMetadataMap().put(resourceMapObsoletes, resourceMapObsoletesSystemMetadata);

								}

							}

							// look up the resource map that this one is obsoletedBy

							if (sysMeta.getObsoletedBy() != null) {

								Identifier resourceMapObsoletedBy = new Identifier();

								resourceMapObsoletedBy.setValue(resourceMapPrefix + sysMeta.getObsoletedBy().getValue());

								resourceMapSysMeta.setObsoletedBy(resourceMapObsoletedBy);

								SystemMetadata resourceMapObsoletedBySystemMetadata = HazelcastService.getInstance().getSystemMetadataMap().get(resourceMapObsoletedBy);

								if (resourceMapObsoletedBySystemMetadata != null) {

									resourceMapObsoletedBySystemMetadata.setObsoletes(resourceMapId);

									HazelcastService.getInstance().getSystemMetadataMap().put(resourceMapObsoletedBy, resourceMapObsoletedBySystemMetadata);

								}

							}

							// save it locally

							Session session = new Session();

							session.setSubject(submitter);

							MockHttpServletRequest request = new MockHttpServletRequest(null, null, null);

							MNodeService.getInstance(request).create(

									session, 

									resourceMapId, 

									IOUtils.toInputStream(resourceMapXML, MetaCatServlet.DEFAULT_ENCODING), 

									resourceMapSysMeta);

			        	}

			        }

				}

			} catch (ParserConfigurationException pce) {

				logMetacat.debug("There was a problem parsing the EML document. "

								+ "The error message was: " + pce.getMessage());

			} catch (SAXException saxe) {

				logMetacat.debug("There was a problem traversing the EML document. "

								+ "The error message was: " + saxe.getMessage());

			} catch (XPathExpressionException xpee) {

				logMetacat.debug("There was a problem searching the EML document. "

								+ "The error message was: " + xpee.getMessage());

			} catch (Exception e) {

				logMetacat.debug("There was a problem creating System Metadata. "

								+ "The error message was: " + e.getMessage());

				e.printStackTrace();

			} // end try()

		} // end if()

		return sysMeta;

	}

	/**

	 * Determines if we already have registered an ORE map for this package

	 * @param guid of the EML/packaging object

	 * @return true if there is an ORE map for the given package

	 */

	private static boolean oreExistsFor(Identifier guid) {

		// TODO: implement call to CN.search()

		return false;

	}

	/**

	 * Find the size (in bytes) of a stream. Note: This needs to refactored out

	 * of MetacatHandler and into a utility when stream i/o in Metacat is

	 * evaluated.

	 * 

	 * @param is The InputStream of bytes

	 * 

	 * @return size The size in bytes of the input stream as a long

	 * 

	 * @throws IOException

	 */

	private static long sizeOfStream(InputStream is) throws IOException {

		long size = 0;

		byte[] b = new byte[1024];

		int numread = is.read(b, 0, 1024);

		while (numread != -1) {

			size += numread;

			numread = is.read(b, 0, 1024);

		}

		return size;

	}

}