Metacat

package edu.ucsb.nceas.metacat.admin.upgrade;

/**

 *  '$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-03-29 18:23:38 +0000 (Tue, 29 Mar 2011) $'

 * '$Revision: 6025 $'

 *

 * 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

 */

import java.security.NoSuchAlgorithmException;

import java.sql.SQLException;

import java.util.List;

import org.apache.commons.logging.Log;

import org.apache.commons.logging.LogFactory;

import org.dataone.service.exceptions.InvalidRequest;

import org.dataone.service.exceptions.InvalidToken;

import org.dataone.service.exceptions.NotAuthorized;

import org.dataone.service.exceptions.NotFound;

import org.dataone.service.exceptions.NotImplemented;

import org.dataone.service.exceptions.ServiceFailure;

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

import edu.ucsb.nceas.metacat.AccessionNumberException;

import edu.ucsb.nceas.metacat.IdentifierManager;

import edu.ucsb.nceas.metacat.McdbDocNotFoundException;

import edu.ucsb.nceas.metacat.admin.AdminException;

import edu.ucsb.nceas.metacat.dataone.SystemMetadataFactory;

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

import edu.ucsb.nceas.utilities.PropertyNotFoundException;

import edu.ucsb.nceas.utilities.SortedProperties;

public class GenerateSystemMetadata implements UpgradeUtilityInterface {

	private static Log log = LogFactory.getLog(GenerateSystemMetadata.class);

    public boolean upgrade() throws AdminException {

        boolean success = true;

        // include ORE?

        boolean includeOre = true;

        try {

			generateMissingSystemMetadata(includeOre);

		} catch (Exception e) {

			String msg = "Problem generating missing system metadata: " + e.getMessage();

			log.error(msg, e);

			success = false;

			throw new AdminException(msg);

		}

    	return success;

    }

    /**

     * Generate SystemMetadata for any object in the object store that does

     * not already have it.  SystemMetadata documents themselves, are, of course,

     * exempt.  This is a utility method for migration of existing object 

     * stores to DataONE where SystemMetadata is required for all objects.  See 

     * https://trac.dataone.org/ticket/591

     * @param includeOre 

     * 

     * @param token an authtoken with appropriate permissions to read all 

     * documents in the object store.  To work correctly, this should probably

     * be an adminstrative credential.

     * @throws SQLException 

     * @throws AccessionNumberException 

     * @throws NoSuchAlgorithmException 

     * @throws InvalidRequest 

     * @throws NotImplemented 

     * @throws NotFound 

     * @throws NotAuthorized 

     * @throws InvalidToken 

     * @throws PropertyNotFoundException 

     * @throws McdbDocNotFoundException 

     * @throws ServiceFailure 

     */

    public void generateMissingSystemMetadata(boolean includeOre) 

    throws ServiceFailure, McdbDocNotFoundException, PropertyNotFoundException, InvalidToken, NotAuthorized, 

    NotFound, NotImplemented, InvalidRequest, NoSuchAlgorithmException, AccessionNumberException, SQLException 

    {

        //get the list of ids with no SM

        List<String> idList = IdentifierManager.getInstance().getLocalIdsWithNoSystemMetadata(true);

        for (String localId : idList) { 

            //for each id, add a system metadata doc

        	try {

        		generateMissingSystemMetadata(localId, includeOre);

        	} catch (Exception e) {

				log.error("Error generating system metadata for: " + localId, e);

			}

        }

        log.info("generateMissingSystemMetadata(token)");

    }

    /**

     * Generate SystemMetadata for a particular object with identifier localId.

     * This is a utility method for migration of existing objects 

     * to DataONE where SystemMetadata is required for all objects.

     * 

     * @param token an authtoken with appropriate permissions to read all 

     *        documents in the object store.  To work correctly, this should

     *        be an adminstrative credential.

     * @param localId the identifier of the object to be processed

     * @param includeOre 

     * @throws ServiceFailure 

     * @throws SQLException 

     * @throws AccessionNumberException 

     * @throws NoSuchAlgorithmException 

     * @throws InvalidRequest 

     * @throws NotImplemented 

     * @throws NotFound 

     * @throws NotAuthorized 

     * @throws InvalidToken 

     * @throws PropertyNotFoundException 

     * @throws McdbDocNotFoundException 

     */

    public void generateMissingSystemMetadata(String localId, boolean includeOre) 

    throws ServiceFailure, McdbDocNotFoundException, PropertyNotFoundException, InvalidToken, NotAuthorized,

    NotFound, NotImplemented, InvalidRequest, NoSuchAlgorithmException, AccessionNumberException, SQLException 

    {

    	log.debug("generateMissingSystemMetadata() called.");

    	log.debug("Creating SystemMetadata for localId " + localId);

        SystemMetadata sm = null;

        //generate required system metadata fields from the document

        try {

        	sm = SystemMetadataFactory.createSystemMetadata(localId, includeOre);

        } catch (Exception e1) {

        	e1.printStackTrace();

        	ServiceFailure sf = new ServiceFailure("00","Exception in generateMissingSystemMetadata: " +

        			e1.getMessage());

        	sf.setStackTrace(e1.getStackTrace());

        	throw sf;

        }

        //insert the systemmetadata object or just update it

        boolean exists = IdentifierManager.getInstance().identifierExists(sm.getIdentifier().getValue());

        if (!exists) {

        	IdentifierManager.getInstance().createSystemMetadata(sm);

        }

        IdentifierManager.getInstance().updateSystemMetadata(sm);

        log.info("generateMissingSystemMetadata(token, localId)");

    }

    public static void main(String [] ags){

        try {

        	// set up the properties based on the test/deployed configuration of the workspace

        	SortedProperties testProperties = 

				new SortedProperties("test/test.properties");

			testProperties.load();

			String metacatContextDir = testProperties.getProperty("metacat.contextDir");

			PropertyService.getInstance(metacatContextDir + "/WEB-INF");

			// now run it

            GenerateSystemMetadata upgrader = new GenerateSystemMetadata();

	        upgrader.upgrade();

        } catch (Exception ex) {

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

            ex.printStackTrace();

        }

    }

}