EDIT

/**

* Copyright (C) 2008 EDIT

* European Distributed Institute of Taxonomy

* http://www.e-taxonomy.eu

 *

 * The contents of this file are subject to the Mozilla Public License Version 1.1

 * See LICENSE.TXT at the top of this package for the full license terms.

*/

package eu.etaxonomy.cdm.io.jaxb;

import java.io.File;

import java.net.URI;

import java.net.URISyntaxException;

import java.util.Collection;

import java.util.List;

import org.apache.log4j.Logger;

import org.springframework.stereotype.Component;

import org.springframework.transaction.TransactionStatus;

import eu.etaxonomy.cdm.config.Configuration;

import eu.etaxonomy.cdm.io.common.CdmImportBase;

import eu.etaxonomy.cdm.io.common.ICdmIO;

import eu.etaxonomy.cdm.io.common.IImportConfigurator;

import eu.etaxonomy.cdm.model.agent.AgentBase;

import eu.etaxonomy.cdm.model.common.DefinedTermBase;

import eu.etaxonomy.cdm.model.common.LanguageStringBase;

import eu.etaxonomy.cdm.model.common.TermVocabulary;

import eu.etaxonomy.cdm.model.common.User;

import eu.etaxonomy.cdm.model.description.DescriptionBase;

import eu.etaxonomy.cdm.model.description.FeatureNode;

import eu.etaxonomy.cdm.model.description.FeatureTree;

import eu.etaxonomy.cdm.model.media.Media;

import eu.etaxonomy.cdm.model.name.HomotypicalGroup;

import eu.etaxonomy.cdm.model.name.TaxonName;

import eu.etaxonomy.cdm.model.name.TypeDesignationBase;

import eu.etaxonomy.cdm.model.occurrence.SpecimenOrObservationBase;

import eu.etaxonomy.cdm.model.reference.Reference;

import eu.etaxonomy.cdm.model.taxon.Classification;

import eu.etaxonomy.cdm.model.taxon.TaxonBase;

import eu.etaxonomy.cdm.model.taxon.TaxonNode;

/**

 * @author a.babadshanjan

 * @since 13.11.2008

 */

@Component

public class JaxbImport

            extends CdmImportBase<JaxbImportConfigurator, JaxbImportState>

            implements ICdmIO<JaxbImportState> {

    private static final long serialVersionUID = -96388140688227297L;

    private static final Logger logger = Logger.getLogger(JaxbImport.class);

	private CdmDocumentBuilder cdmDocumentBuilder = null;

	/** Reads data from an XML file and stores them into a CDM DB.

     *

     * @param config

     * @param stores (not used)

     */

	@Override

	protected void doInvoke(JaxbImportState state) {

		JaxbImportConfigurator jaxbImpConfig = state.getConfig();

		URI uri;

    	String urlFileName = jaxbImpConfig.getSource().toString();

		try {

    		uri = new URI(urlFileName);

		} catch (URISyntaxException ex) {

			logger.error("File not found");

			state.setUnsuccessfull();

			return;

    	}

		logger.info("Deserializing " + urlFileName + " to DB " ); //+ dbname

		DataSet dataSet = new DataSet();

        // unmarshalling XML file

		try {

			cdmDocumentBuilder = new CdmDocumentBuilder();

			logger.info("Unmarshalling " + urlFileName);

			File file = new File(uri);

			logger.debug("Absolute path: " + file.getAbsolutePath());

			dataSet = cdmDocumentBuilder.unmarshal(DataSet.class, file);

		} catch (Exception e) {

			logger.error("Unmarshalling error");

			e.printStackTrace();

		}

		// save data in DB

		logger.info("Saving data to DB... "); //+ dbname

		saveData(state, dataSet);

		return;

	}

	/**  Saves data in DB */

	private void saveData (JaxbImportState state, DataSet dataSet) {

		JaxbImportConfigurator jaxbImpConfig = state.getConfig();

		boolean success = true;

		Collection<TaxonBase> taxonBases;

		List<? extends AgentBase> agents;

		List<DefinedTermBase> terms;

		List<User> users;

		List<Reference> references;

		List<TaxonName> taxonomicNames;

		List<DescriptionBase> descriptions;

		List<TypeDesignationBase> typeDesignations;

		List<SpecimenOrObservationBase> occurrences;

		List<FeatureTree> featureTrees;

		List<FeatureNode> featureNodes;

		List<Media> media;

		List<LanguageStringBase> languageData;

		List<TermVocabulary<DefinedTermBase>> termVocabularies;

		List<HomotypicalGroup> homotypicalGroups;

		TransactionStatus txStatus = startTransaction();

		//TransactionStatus txStatus = null;

		// Have single transactions per service save call. Otherwise, getting

		// H2 HYT00 error (timeout locking table DEFINEDTERMBASE) when running from editor.

		try {

			if (jaxbImpConfig.isDoUser() == true) {

				/*

				 * this is a crucial call, otherwise the password will not be set correctly

				 * and the whole authentication will not work

				 *

				 *  a bit preliminary, should be used only if the complete database is replaced

				 */

				authenticate(Configuration.adminLogin, Configuration.adminPassword);

				logger.info("Users: " + (users = dataSet.getUsers()).size());

				for (User user : users) {

					List<User> usersList = getUserService().listByUsername(user.getUsername(),null, null, null, null, null, null);

					if (usersList.isEmpty()){

						getUserService().save(user);

					}else{

//						User existingUser = usersList.get(0);

//						user.setId(existingUser.getId());

//						getUserService().merge(user);

						//merging does not yet work because of #4102

					}

				}

			}

		} catch (Exception ex) {

			logger.error("Error saving users");

			ex.printStackTrace();

			success = false;

		}

		if ((jaxbImpConfig.isDoTerms() == true)

				&& (terms = dataSet.getTerms()).size() > 0) {

			//txStatus = startTransaction();

			success &= saveTerms(terms);

			//commitTransaction(txStatus);

		}

		if ((jaxbImpConfig.isDoTermVocabularies() == true)

				&& (termVocabularies = dataSet.getTermVocabularies()).size() > 0) {

			//txStatus = startTransaction();

			success &= saveTermVocabularies(termVocabularies);

		}

		// TODO: Have separate data save methods

//		txStatus = startTransaction();

//		try {

//			if (jaxbImpConfig.isDoLanguageData() == true) {

//				if ((languageData = dataSet.getLanguageData()).size() > 0) {

//					logger.info("Language data: " + languageData.size());

//					getTermService().saveLanguageDataAll(languageData);

//				}

//			}

//		} catch (Exception ex) {

//			logger.error("Error saving language data");

//			ret = false;

//		}

//		commitTransaction(txStatus);

		//txStatus = startTransaction();

		try {

			if (jaxbImpConfig.isDoAuthors() == true) {

				if ((agents = dataSet.getAgents()).size() > 0) {

					logger.info("Agents: " + agents.size());

					getAgentService().saveOrUpdate((Collection)agents);

				}

			}

		} catch (Exception ex) {

			logger.error("Error saving agents");

			success = false;

		}

		//commitTransaction(txStatus);

		//txStatus = startTransaction();

		try {

			if (jaxbImpConfig.getDoReferences() != IImportConfigurator.DO_REFERENCES.NONE) {

				if ((references = dataSet.getReferences()).size() > 0) {

					logger.info("References: " + references.size());

					getReferenceService().saveOrUpdate(references);

					logger.info("ready...");

				}

			}

		} catch (Exception ex) {

			ex.printStackTrace();

			logger.error("Error saving references");

			success = false;

		}

		//commitTransaction(txStatus);

		//txStatus = startTransaction();

		try {

			if (jaxbImpConfig.isDoTaxonNames() == true) {

				if ((taxonomicNames = dataSet.getTaxonomicNames()).size() > 0) {

					logger.info("Taxonomic names: " + taxonomicNames.size());

					getNameService().saveOrUpdate(taxonomicNames);

				}

			}

		} catch (Exception ex) {

			logger.error("Error saving taxon names");

			success = false;

		}

		//commitTransaction(txStatus);

		//txStatus = startTransaction();

		try {

			if (jaxbImpConfig.isDoHomotypicalGroups() == true) {

				if ((homotypicalGroups = dataSet.getHomotypicalGroups()).size() > 0) {

					logger.info("Homotypical groups: " + homotypicalGroups.size());

					getNameService().saveAllHomotypicalGroups(homotypicalGroups);

				}

			}

		} catch (Exception ex) {

			logger.error("Error saving homotypical groups");

			success = false;

		}

		//commitTransaction(txStatus);

		//txStatus = startTransaction();

		// Need to get the taxa and the synonyms here.

		try {

			if (jaxbImpConfig.isDoTaxa() == true) {

				if ( dataSet.getTaxonBases().size() > 0) {

					List taxa = dataSet.getTaxonBases();

					dataSet.getTaxonBases();

					logger.info("Taxon bases: " + taxa.size());

					taxa.iterator();

					getTaxonService().saveOrUpdate(taxa);

					/*while (taxBases.hasNext()){

						getTaxonService().save(taxBases.next());

					}*/

					//getTaxonService().saveTaxonAll(taxonBases);

				}

			}

		} catch (Exception ex) {

			logger.error("Error saving taxa");

			ex.printStackTrace();

			success = false;

		}

		//commitTransaction(txStatus);

		//txStatus = startTransaction();

		// NomenclaturalStatus, TypeDesignations

		try {

			if (jaxbImpConfig.isDoTypeDesignations() == true) {

				if ((typeDesignations = dataSet.getTypeDesignations()).size() > 0) {

					logger.info("Type Designations: " + typeDesignations.size());

					getNameService().saveTypeDesignationAll(typeDesignations);

				}

			}

		} catch (Exception ex) {

			logger.error("Error saving type designations");

			success = false;

		}

		//commitTransaction(txStatus);

		// TODO: Implement dataSet.getDescriptions() and IDescriptionService.saveDescriptionAll()

//		if ((descriptions = dataSet.getDescriptions()) != null) {

//		logger.info("Saving " + descriptions.size() + " descriptions");

//		getDescriptionService().saveDescriptionAll(descriptions);

//		}

		//txStatus = startTransaction();

		try {

			if (jaxbImpConfig.isDoOccurrence() == true) {

				if ((occurrences = dataSet.getOccurrences()).size() > 0) {

					logger.info("Occurrences: " + occurrences.size());

					getOccurrenceService().saveOrUpdate(occurrences);

				}

			}

		} catch (Exception ex) {

			logger.error("Error saving occurrences");

			success = false;

		}

		//commitTransaction(txStatus);

		//txStatus = startTransaction();

		try {

			if (jaxbImpConfig.isDoFeatureData() == true) {

				if ((featureTrees = dataSet.getFeatureTrees()).size() > 0) {

					logger.info("Feature data: " + featureTrees.size());

					getFeatureTreeService().saveOrUpdate(featureTrees);

				}

			}

		} catch (Exception ex) {

			logger.error("Error saving feature data");

			success = false;

		}

		//commitTransaction(txStatus);

		//txStatus = startTransaction();

		try {

			if (jaxbImpConfig.isDoMedia() == true) {

				if ((media = dataSet.getMedia()).size() > 0) {

					logger.info("Media: " + media.size());

					getMediaService().saveOrUpdate(media);

				}

			}

		} catch (Exception ex) {

			logger.error("Error saving media");

			success = false;

		}

		if (jaxbImpConfig.isDoClassificationData() == true) {

			logger.info("# Classification");

			Collection<TaxonNode> nodes = dataSet.getTaxonNodes();

			Collection<Classification> classifications = dataSet.getClassifications();

			getClassificationService().saveTaxonNodeAll(nodes);

			for (Classification tree: classifications){

				getClassificationService().saveOrUpdate(tree);

			}

		}

		commitTransaction(txStatus);

		logger.info("All data saved");

		if (!success){

			state.setUnsuccessfull();

		}

		return;

	}

	private boolean saveTermVocabularies(

			List<TermVocabulary<DefinedTermBase>> termVocabularies) {

		boolean success = true;

		logger.info("Term vocabularies: " + termVocabularies.size());

		try {

			getVocabularyService().saveOrUpdate((List)termVocabularies);

		} catch (Exception ex) {

			logger.error("Error saving term vocabularies");

			success = false;

		}

		return success;

	}

	private boolean saveTerms(List<DefinedTermBase> terms) {

		boolean success = true;

		logger.info("Terms: " + terms.size());

		try {

			getTermService().save(terms);

		} catch (Exception ex) {

			logger.error("Error saving terms");

			ex.printStackTrace();

			success = false;

		}

		return success;

	}

	@Override

	protected boolean doCheck(JaxbImportState state) {

		boolean result = true;

		logger.warn("No validation implemented for Jaxb import");

		return result;

	}

	@Override

	protected boolean isIgnore(JaxbImportState state) {

		return false;

	}

}