aas/plugins/modeling/org.eclipse.papyrus.aas.aasx.import/src/org/eclipse/papyrus/aas/import2papyrus/transformations/UMLFromAASXTransformation.java

/*****************************************************************************
 * Copyright (c) 2020 CEA LIST.
 *
 *
 * All rights reserved. This program and the accompanying materials
 * are made available under the terms of the Eclipse Public License 2.0
 * which accompanies this distribution, and is available at
 * https://www.eclipse.org/legal/epl-2.0/
 *
 * SPDX-License-Identifier: EPL-2.0
 *
 * Contributors:
 *  Asma Smaoui (CEA LIST) asma.smaoui@cea.fr - Initial API and implementation
 *
 *****************************************************************************/
package org.eclipse.papyrus.aas.import2papyrus.transformations;

import java.util.Collection;
import java.util.Collections;
import java.util.HashMap;
import java.util.HashSet;
import java.util.Map;

import org.eclipse.core.resources.IContainer;
import org.eclipse.core.resources.IFile;
import org.eclipse.core.resources.IResource;
import org.eclipse.core.runtime.CoreException;
import org.eclipse.core.runtime.IProgressMonitor;
import org.eclipse.core.runtime.IStatus;
import org.eclipse.core.runtime.MultiStatus;
import org.eclipse.core.runtime.Status;
import org.eclipse.emf.common.util.Diagnostic;
import org.eclipse.emf.common.util.URI;
import org.eclipse.emf.ecore.resource.Resource;
import org.eclipse.emf.ecore.resource.ResourceSet;
import org.eclipse.emf.ecore.xmi.XMLResource;
import org.eclipse.papyrus.aas.import2papyrus.handler.Activator;
import org.eclipse.papyrus.uml.m2m.qvto.common.MigrationParameters.ThreadConfig;
import org.eclipse.papyrus.uml.m2m.qvto.common.transformation.IDependencyAnalysisHelper;
import org.eclipse.papyrus.uml.m2m.qvto.common.transformation.MigrationResourceSetImpl;
import org.eclipse.uml2.uml.resource.UMLResource;
import org.eclipse.uml2.uml.util.UMLUtil;

import io.shell.admin.aas._2._0._0Package;
import io.shell.admin.aas._2._0.util._0ResourceFactoryImpl;

public class UMLFromAASXTransformation extends AbstractImportTransformation {

	protected URI umlResourceURI;
	protected Resource umlResource;
	protected Resource aasxResource;
	protected IResource project;

	/**
	 * Constructor.
	 *
	 * @param sourceURI      The source URI.
	 * @param config         The thread config.
	 * @param analysisHelper The analyses helper.
	 */
	public UMLFromAASXTransformation(final URI sourceURI, final ThreadConfig config,
			final IDependencyAnalysisHelper analysisHelper) {
		super(sourceURI, config, analysisHelper);
		DEBUG = true;
	}

	/**
	 * Constructor.
	 *
	 * @param sourceURI The source URI.
	 */
	public UMLFromAASXTransformation(final URI sourceURI) {
		super(sourceURI);
	}

	public UMLFromAASXTransformation(final URI sourceURI, final ThreadConfig config,
			final IDependencyAnalysisHelper analysisHelper, IResource project) {
		super(sourceURI, config, analysisHelper);
		this.project = project;
		DEBUG = true;
	}

	/**
	 * 
	 * 
	 * /** {@inheritDoc}
	 * 
	 * @see org.eclipse.papyrus.migration.common.transformation.AbstractImportTransformation#loadInPapyrusProfiles()
	 */
	@Override
	protected Diagnostic loadInPapyrusProfiles() {
		resourceSet.getResource(sourceURI.trimFileExtension().appendFileExtension(UMLResource.FILE_EXTENSION), true);
		return null;
	}

	/**
	 * {@inheritDoc}
	 * 
	 * @see org.eclipse.papyrus.migration.common.transformation.AbstractImportTransformation#countSupportedElements()
	 */
	@Override
	protected int countSupportedElements() {
		return -1;
	}

	/**
	 * {@inheritDoc}
	 * 
	 * @see org.eclipse.papyrus.migration.common.transformation.AbstractImportTransformation#run(org.eclipse.core.runtime.IProgressMonitor)
	 */
	@Override
	protected IStatus run(final IProgressMonitor monitor) {
		//
		// INITIALIZATION / LOADING
		//

		monitor.subTask("Loading source model " + getModelName());

		long startLoad = System.nanoTime();

		// load the AASX input file and the UML output file

		initResourceSet(monitor);

		int numberOfElements = countSupportedElements();

		monitor.beginTask("Importing " + getModelName(), numberOfElements);
		monitor.subTask("Loading transformations (This may take a few seconds for the first import)...");

		String statusMessage = String.format("Import %s", getModelName());
		MultiStatus generationStatus = new MultiStatus(Activator.PLUGIN_ID, IStatus.OK, statusMessage, null);

		try {

			long endLoad = System.nanoTime();
			loadingTime = endLoad - startLoad;

			//
			// TRANSFORMATIONS
			//

			long startExtensions = System.nanoTime();

			long endExtensions = System.nanoTime();

			this.importExtensionsTime = endExtensions - startExtensions;

			monitor.subTask("Importing semantic model...");

			// Run the transformations here and get the output file (uml file)

			AAS2UMLSwitch aas2uml = new AAS2UMLSwitch();

			umlResource = aas2uml.doTransform(aasxResource, umlResource);

			// populate the xml Resource

			final Collection<Resource> resourcesToSave = new HashSet<>();
			resourcesToSave.add(umlResource);

			// save resources

			try {

				umlResource.save(null);
			} catch (Exception ex) {
				Activator.log.error(ex);
				generationStatus
						.add(new Status(IStatus.ERROR, Activator.PLUGIN_ID, "An exception occurred during save", ex));
			}

			long startExtensionsAfter = System.nanoTime();

			long endExtensionsAfter = System.nanoTime();
			this.importExtensionsTime += endExtensionsAfter - startExtensionsAfter;

		} finally {
			// Do nothing
		}

		monitor.subTask("Releasing memory...");
		// unloadResourceSet(this.resourceSet);
		dispose();

		monitor.done();
		return generationStatus;
	}

	/**
	 * {@inheritDoc}
	 * 
	 * @see org.eclipse.papyrus.migration.common.transformation.AbstractImportTransformation#getProfilesTransformationURI()
	 *      Only Usefull for QVTO transfo
	 */
	@Override
	protected Collection<URI> getProfilesTransformationURI() {
		return Collections.emptyList();
	}

	/**
	 * {@inheritDoc}
	 * 
	 * @see org.eclipse.papyrus.migration.common.transformation.AbstractImportTransformation#getInOutUMLModel()
	 */
	@Override
	public URI getInOutUMLModel() {
		Resource oldUMLResource = resourceSet.getResource(sourceURI, true);

		return oldUMLResource.getURI();
	}

	protected void configureResource(XMLResource resource) {
		Map<Object, Object> saveOptions = new HashMap<>();

		// default save options.

		saveOptions.put(XMLResource.OPTION_EXTENDED_META_DATA, Boolean.TRUE);
		saveOptions.put(XMLResource.OPTION_USE_ENCODED_ATTRIBUTE_STYLE, Boolean.TRUE);
		saveOptions.put(XMLResource.OPTION_SCHEMA_LOCATION, Boolean.TRUE);

		resource.setEncoding("UTF-8");
		resource.getDefaultSaveOptions().putAll(saveOptions);

		resource.getDefaultLoadOptions().put(XMLResource.OPTION_EXTENDED_META_DATA, Boolean.TRUE);
		resource.getDefaultLoadOptions().put(XMLResource.OPTION_USE_ENCODED_ATTRIBUTE_STYLE, Boolean.TRUE);
		resource.getDefaultLoadOptions().put(XMLResource.OPTION_USE_LEXICAL_HANDLER, Boolean.TRUE);
	}

	/**
	 * {@inheritDoc}
	 * 
	 * @see org.eclipse.papyrus.migration.common.transformation.AbstractImportTransformation#createUMLResource(org.eclipse.emf.ecore.resource.ResourceSet,
	 *      org.eclipse.emf.common.util.URI, org.eclipse.emf.common.util.URI) Not
	 *      usefull we already have the UML Resource
	 */
	@Override
	protected Resource createUMLResource(final ResourceSet resourceSet, final URI sourceResourceURI,
			final URI targetResourceURI) {
		return resourceSet.createResource(targetResourceURI, UMLResource.UML_5_0_0_CONTENT_TYPE_IDENTIFIER);
	}

	/**
	 * Initializes the resource set, and resolve all dependencies
	 */

	@Override
	protected void initResourceSet(IProgressMonitor monitor) {
		resourceSet = new MigrationResourceSetImpl();
		synchronized (UMLUtil.class) {
			UMLUtil.init(resourceSet);
		}
		resourceSet.getLoadOptions().put(XMLResource.OPTION_DEFER_ATTACHMENT, true);
		resourceSet.getLoadOptions().put(XMLResource.OPTION_DEFER_IDREF_RESOLUTION, true);
		resourceSet.getLoadOptions().put(XMLResource.OPTION_LAX_FEATURE_PROCESSING, Boolean.TRUE);
		resourceSet.getLoadOptions().put(XMLResource.OPTION_RECORD_UNKNOWN_FEATURE, Boolean.TRUE);
		resourceSet.getLoadOptions().put(XMLResource.OPTION_USE_PACKAGE_NS_URI_AS_LOCATION, Boolean.TRUE);
		// load AASX Register Factory and AASX resource to be loaded by an EMF
		// resourceSet
		resourceSet.getResourceFactoryRegistry().getExtensionToFactoryMap().put("xml", new _0ResourceFactoryImpl());
		resourceSet.getPackageRegistry().put(_0Package.eNS_URI, _0Package.eINSTANCE);

		monitor.subTask("Loading source model " + getModelName());

		try {

			aasxResource = resourceSet.getResource(sourceURI, true);
			if (aasxResource != null) {
				configureResource((XMLResource) aasxResource);
				IFile umlFile = findFileRecursively(project, "uml");
				umlResourceURI = URI.createPlatformResourceURI(umlFile.getFullPath().toString(), true);
				umlResource = resourceSet.getResource(umlResourceURI, true);
				configureResource((XMLResource) umlResource);
			}
		} catch (Exception ex) {
			Activator.log.error("An error occurred while loading " + getModelName(), ex);
		}
	}

	public IFile findFileRecursively(IResource container, String extention) throws CoreException {
		if (container != null && container instanceof IContainer) {

			for (IResource r : ((IContainer) container).members()) {
				if (r instanceof IFile && r.getFileExtension().equals("uml")) {
					return (IFile) r;
				}
			}
		}
		return null;
	}

	/**
	 * This allows to dispose the needed variables.
	 */
	protected void dispose() {

		umlResource = null;
		outUML = null;
		outNotation = null;
		inPapyrusProfiles = null;
		outSashModel = null;
		resourceSet = null;
		// Set the context of the QvTo to null

	}

	@Override
	protected Collection<URI> getDiagramTransformationURIs() {
		// TODO Auto-generated method stub
		return null;
	}

}