ComponentProjectCreator.java

/*******************************************************************************
 * This file is protected by Copyright. 
 * Please refer to the COPYRIGHT file distributed with this source distribution.
 *
 * This file is part of REDHAWK IDE.
 *
 * All rights reserved.  This program and the accompanying materials are made available under 
 * the terms of the Eclipse Public License v1.0 which accompanies this distribution, and is available at 
 * http://www.eclipse.org/legal/epl-v10.html
 *******************************************************************************/
package gov.redhawk.ide.spd.generator.newcomponent;

import gov.redhawk.ide.codegen.util.ProjectCreator;
import gov.redhawk.ide.natures.ScaComponentProjectNature;
import gov.redhawk.ide.spd.IdeSpdPlugin;

import java.io.ByteArrayInputStream;
import java.io.UnsupportedEncodingException;
import java.net.URI;

import mil.jpeojtrs.sca.prf.PrfPackage;
import mil.jpeojtrs.sca.scd.ScdPackage;
import mil.jpeojtrs.sca.spd.SpdPackage;

import org.eclipse.core.resources.IFile;
import org.eclipse.core.resources.IProject;
import org.eclipse.core.runtime.CoreException;
import org.eclipse.core.runtime.IProgressMonitor;
import org.eclipse.core.runtime.IStatus;
import org.eclipse.core.runtime.Status;
import org.eclipse.core.runtime.SubMonitor;

/**
 * A utility class for creating new REDHAWK component projects.
 */
public class ComponentProjectCreator extends ProjectCreator {

	protected ComponentProjectCreator() {
	}

	/**
	 * Creates a new REDHAWK component project without any files. Should be invoked in the context of a
	 * {@link org.eclipse.ui.actions.WorkspaceModifyOperation WorkspaceModifyOperation}.
	 * 
	 * @param projectName The project name
	 * @param projectLocation the location on disk to create the project
	 * @param monitor the progress monitor to use for reporting progress to the user. It is the caller's responsibility
	 *  to call done() on the given monitor. Accepts null, indicating that no progress should be
	 *  reported and that the operation cannot be canceled.
	 * @return The newly created project
	 * @throws CoreException A problem occurs while creating the project
	 */
	public static IProject createEmptyProject(final String projectName, final URI projectLocation, final IProgressMonitor monitor) throws CoreException {
		final SubMonitor progress = SubMonitor.convert(monitor, "Creating empty project", 2);
		final String[] additionalNatureIDs = new String[] {
		        ScaComponentProjectNature.ID, "org.python.pydev.pythonNature"
		};
		final IProject project = ProjectCreator.createEmptyProject(projectName, projectLocation, additionalNatureIDs, progress.newChild(1));
		ProjectCreator.resetProject(project, progress.newChild(1));
		return project;
	}

	
	/**
	 * Creates the basic files for a component (SPD, PRF, SCD and test file) in an empty REDHAWK component project. Should
	 * be invoked in the context of a {@link org.eclipse.ui.actions.WorkspaceModifyOperation WorkspaceModifyOperation}.
	 * 
	 * @param project The project to generate files in
	 * @param projectID The project's ID (DCE)
	 * @param authorName The name of the component author
	 * @param monitor the progress monitor to use for reporting progress to the user. It is the caller's responsibility
	 *  to call done() on the given monitor. Accepts null, indicating that no progress should be
	 *  reported and that the operation cannot be canceled.
	 * @return The newly created SPD file
	 * @throws CoreException An error occurs while generating files
	 * @deprecated Please use the createComponentFiles method which takes the spdName and spdId.
	 */
	@Deprecated
	public static IFile createComponentFiles(final IProject project, final String projectID, final String authorName, final IProgressMonitor monitor)
	        throws CoreException {
		String[] tokens = project.getName().split("\\.");
		return createComponentFiles(project, tokens[tokens.length - 1], projectID, authorName, monitor);
	}
	
	/**
	 * Creates the basic files for a component (SPD, PRF, SCD and test file) in an empty REDHAWK component project. Should
	 * be invoked in the context of a {@link org.eclipse.ui.actions.WorkspaceModifyOperation WorkspaceModifyOperation}.
	 * 
	 * @param project The project to generate files in
	 * @param spdName The name of the soft package
	 * @param spdId The soft package's ID
	 * @param authorName The name of the component author
	 * @param monitor the progress monitor to use for reporting progress to the user. It is the caller's responsibility
	 *  to call done() on the given monitor. Accepts null, indicating that no progress should be
	 *  reported and that the operation cannot be canceled.
	 * @return The newly created SPD file
	 * @throws CoreException An error occurs while generating files
	 */
	public static IFile createComponentFiles(final IProject project, final String spdName, final String spdId, final String authorName, final IProgressMonitor monitor)
	        throws CoreException {
		
		final SubMonitor progress = SubMonitor.convert(monitor, "Creating REDHAWK component files", 6);
		
		final GeneratorArgs args = new GeneratorArgs();
		args.setProjectName(project.getName());
		args.setAuthorName(authorName);
		args.setSoftPkgFile(spdName + SpdPackage.FILE_EXTENSION);
		args.setSoftPkgId(spdId);
		args.setSoftPkgName(project.getName());
		args.setPrfFile(spdName + PrfPackage.FILE_EXTENSION);
		args.setScdFile(spdName + ScdPackage.FILE_EXTENSION);

		// Generate file content from templates
		final String spdContent = new SpdFileTemplate().generate(args);
		final String prfContent = new PrfFileTemplate().generate(args);
		final String scdContent = new ScdFileTemplate().generate(args);
		progress.worked(1);

		// Check that files/folders don't exist already
		final IFile spdFile = project.getFile(spdName + SpdPackage.FILE_EXTENSION);
		if (spdFile.exists()) {
			throw new CoreException(new Status(IStatus.ERROR, IdeSpdPlugin.PLUGIN_ID, "File " + spdFile.getName() + " already exists.", null));
		}

		final IFile prfFile = project.getFile(spdName + PrfPackage.FILE_EXTENSION);
		if (prfFile.exists()) {
			throw new CoreException(new Status(IStatus.ERROR, IdeSpdPlugin.PLUGIN_ID, "File " + prfFile.getName() + " already exists.", null));
		}

		final IFile scdFile = project.getFile(spdName + ScdPackage.FILE_EXTENSION);
		if (scdFile.exists()) {
			throw new CoreException(new Status(IStatus.ERROR, IdeSpdPlugin.PLUGIN_ID, "File " + scdFile.getName() + " already exists.", null));
		}

		// Write files to disk
		try {
			spdFile.create(new ByteArrayInputStream(spdContent.getBytes("UTF-8")), true, progress.newChild(1));
		} catch (final UnsupportedEncodingException e) {
			throw new CoreException(new Status(IStatus.ERROR, IdeSpdPlugin.PLUGIN_ID, "Internal Error", e));
		}

		try {
			prfFile.create(new ByteArrayInputStream(prfContent.getBytes("UTF-8")), true, progress.newChild(1));
		} catch (final UnsupportedEncodingException e) {
			throw new CoreException(new Status(IStatus.ERROR, IdeSpdPlugin.PLUGIN_ID, "Internal Error", e));
		}

		try {
			scdFile.create(new ByteArrayInputStream(scdContent.getBytes("UTF-8")), true, progress.newChild(1));
		} catch (final UnsupportedEncodingException e) {
			throw new CoreException(new Status(IStatus.ERROR, IdeSpdPlugin.PLUGIN_ID, "Internal Error", e));
		}

		return spdFile;
	}
}