blob: a3d0c840199c4ba47ed87a389de626f1e2bbdf9b [file] [log] [blame]
/*******************************************************************************
* Copyright (c) 2000, 2003 IBM Corporation and others.
* All rights reserved. This program and the accompanying materials
* are made available under the terms of the Common Public License v1.0
* which accompanies this distribution, and is available at
* http://www.eclipse.org/legal/cpl-v10.html
*
* Contributors:
* IBM Corporation - initial API and implementation
*******************************************************************************/
package org.eclipse.ant.ui.internal.launchConfigurations;
import java.net.URL;
import java.text.MessageFormat;
import java.util.HashMap;
import java.util.Iterator;
import java.util.Map;
import org.eclipse.ant.core.AntCorePlugin;
import org.eclipse.ant.core.AntCorePreferences;
import org.eclipse.ant.core.AntRunner;
import org.eclipse.ant.core.Property;
import org.eclipse.ant.ui.internal.model.AntUIPlugin;
import org.eclipse.ant.ui.internal.model.AntUtil;
import org.eclipse.ant.ui.internal.model.IAntUIConstants;
import org.eclipse.core.runtime.CoreException;
import org.eclipse.core.runtime.IPath;
import org.eclipse.core.runtime.IProgressMonitor;
import org.eclipse.core.runtime.IStatus;
import org.eclipse.core.runtime.Status;
import org.eclipse.debug.core.ILaunch;
import org.eclipse.debug.core.ILaunchConfiguration;
import org.eclipse.debug.core.ILaunchConfigurationWorkingCopy;
import org.eclipse.debug.core.ILaunchManager;
import org.eclipse.debug.core.model.ILaunchConfigurationDelegate;
import org.eclipse.debug.core.model.IProcess;
import org.eclipse.jdt.internal.launching.JavaLocalApplicationLaunchConfigurationDelegate;
import org.eclipse.jdt.launching.IJavaLaunchConfigurationConstants;
import org.eclipse.jface.dialogs.ErrorDialog;
import org.eclipse.ui.externaltools.internal.launchConfigurations.ExternalToolsUtil;
import org.eclipse.ui.externaltools.internal.program.launchConfigurations.BackgroundResourceRefresher;
import org.eclipse.ui.externaltools.internal.variable.ExpandVariableContext;
/**
* Launch delegate for ant builds
*/
public class AntLaunchDelegate implements ILaunchConfigurationDelegate {
private static final String ANT_LOGGER_CLASS = "org.eclipse.ant.ui.internal.antsupport.logger.AntProcessBuildLogger"; //$NON-NLS-1$
private static final String NULL_LOGGER_CLASS = "org.eclipse.ant.ui.internal.antsupport.logger.NullBuildLogger"; //$NON-NLS-1$
private static final String BASE_DIR_PREFIX = "-Dbasedir="; //$NON-NLS-1$
private static final String INPUT_HANDLER_CLASS = "org.eclipse.ant.ui.internal.antsupport.inputhandler.AntInputHandler"; //$NON-NLS-1$
/**
* @see org.eclipse.debug.core.model.ILaunchConfigurationDelegate#launch(org.eclipse.debug.core.ILaunchConfiguration, java.lang.String, org.eclipse.debug.core.ILaunch, org.eclipse.core.runtime.IProgressMonitor)
*/
public void launch(ILaunchConfiguration configuration, String mode, ILaunch launch, IProgressMonitor monitor) throws CoreException {
if (monitor.isCanceled()) {
return;
}
String vmTypeID= null;
try {
vmTypeID = configuration.getAttribute(IJavaLaunchConfigurationConstants.ATTR_VM_INSTALL_TYPE, (String)null);
} catch (CoreException ce) {
AntUIPlugin.log(ce);
}
if (ExternalToolsUtil.isBackground(configuration)) {
monitor.beginTask(MessageFormat.format(AntLaunchConfigurationMessages.getString("AntLaunchDelegate.Launching_{0}_1"), new String[] {configuration.getName()}), 10); //$NON-NLS-1$
} else {
monitor.beginTask(MessageFormat.format(AntLaunchConfigurationMessages.getString("AntLaunchDelegate.Running_{0}_2"), new String[] {configuration.getName()}), 100); //$NON-NLS-1$
}
// get variable context
ExpandVariableContext resourceContext = ExternalToolsUtil.getVariableContext();
monitor.worked(1);
if (monitor.isCanceled()) {
return;
}
// resolve location
IPath location = ExternalToolsUtil.getLocation(configuration, resourceContext);
monitor.worked(1);
if (monitor.isCanceled()) {
return;
}
if (vmTypeID == null && AntRunner.isBuildRunning()) {
IStatus status= new Status(IStatus.ERROR, IAntUIConstants.PLUGIN_ID, 1, MessageFormat.format(AntLaunchConfigurationMessages.getString("AntLaunchDelegate.Build_In_Progress"), new String[]{location.toOSString()}), null); //$NON-NLS-1$
throw new CoreException(status);
}
// resolve working directory
IPath workingDirectory = ExternalToolsUtil.getWorkingDirectory(configuration, resourceContext);
String baseDir = null;
if (workingDirectory != null) {
baseDir = workingDirectory.toOSString();
}
monitor.worked(1);
if (monitor.isCanceled()) {
return;
}
// link the process to its build logger via a timestamp
long timeStamp = System.currentTimeMillis();
String idStamp = Long.toString(timeStamp);
String idProperty = "-D" + AntProcess.ATTR_ANT_PROCESS_ID + "=" + idStamp; //$NON-NLS-1$ //$NON-NLS-2$
// resolve arguments
String[] arguments = ExternalToolsUtil.getArguments(configuration, resourceContext);
int argLength = 1; // at least one user property - timestamp
if (arguments != null) {
argLength += arguments.length;
}
if (baseDir != null && baseDir.length() > 0) {
argLength++;
}
String[] runnerArgs = new String[argLength];
if (arguments != null) {
System.arraycopy(arguments, 0, runnerArgs, 0, arguments.length);
}
if (baseDir != null && baseDir.length() > 0) {
runnerArgs[runnerArgs.length - 2] = BASE_DIR_PREFIX + baseDir;
}
runnerArgs[runnerArgs.length -1] = idProperty;
Map userProperties= AntUtil.getProperties(configuration);
String[] propertyFiles= AntUtil.getPropertyFiles(configuration);
String[] targets = AntUtil.getTargetsFromConfig(configuration);
URL[] customClasspath= AntUtil.getCustomClasspath(configuration);
String antHome= AntUtil.getAntHome(configuration);
AntRunner runner= null;
if (vmTypeID == null) {
runner= new AntRunner();
runner.setBuildFileLocation(location.toOSString());
if (ExternalToolsUtil.getCaptureOutput(configuration)) {
runner.addBuildLogger(ANT_LOGGER_CLASS);
} else {
runner.addBuildLogger(NULL_LOGGER_CLASS);
}
runner.setInputHandler(INPUT_HANDLER_CLASS);
runner.setArguments(runnerArgs);
if (userProperties != null) {
runner.addUserProperties(userProperties);
}
if (propertyFiles != null) {
runner.setPropertyFiles(propertyFiles);
}
if (targets != null) {
runner.setExecutionTargets(targets);
}
if (customClasspath != null) {
runner.setCustomClasspath(customClasspath);
}
if (antHome != null) {
runner.setAntHome(antHome);
}
}
monitor.worked(1);
if (monitor.isCanceled()) {
return;
}
StringBuffer commandLine= generateCommandLine(location, arguments, userProperties, propertyFiles, targets, antHome, vmTypeID != null);
if (vmTypeID != null) {
monitor.beginTask(MessageFormat.format(AntLaunchConfigurationMessages.getString("AntLaunchDelegate.Launching_{0}_1"), new String[] {configuration.getName()}), 10); //$NON-NLS-1$
runInSeparateVM(configuration, launch, monitor, idStamp, commandLine);
return;
}
Map attributes= new HashMap();
attributes.put(IProcess.ATTR_PROCESS_TYPE, IAntUIConstants.ID_ANT_PROCESS_TYPE);
attributes.put(AntProcess.ATTR_ANT_PROCESS_ID, idStamp);
final AntProcess process = new AntProcess(location.toOSString(), launch, attributes);
setProcessAttributes(process, idStamp, commandLine);
if (ExternalToolsUtil.isBackground(configuration)) {
final AntRunner finalRunner= runner;
Runnable r = new Runnable() {
public void run() {
try {
finalRunner.run(process);
} catch (final CoreException e) {
AntUIPlugin.getStandardDisplay().asyncExec(new Runnable() {
public void run() {
ErrorDialog.openError(null, AntLaunchConfigurationMessages.getString("AntLaunchDelegate.Failure"), null, e.getStatus()); //$NON-NLS-1$
}
});
}
process.terminated();
}
};
Thread background = new Thread(r);
background.start();
monitor.worked(1);
// refresh resources after process finishes
if (ExternalToolsUtil.getRefreshScope(configuration) != null) {
BackgroundResourceRefresher refresher = new BackgroundResourceRefresher(configuration, process, resourceContext);
refresher.startBackgroundRefresh();
}
} else {
// execute the build
try {
runner.run(monitor);
} catch (CoreException e) {
process.terminated();
throw e;
}
process.terminated();
// refresh resources
ExternalToolsUtil.refreshResources(configuration, resourceContext, monitor);
}
monitor.done();
}
private void setProcessAttributes(IProcess process, String idStamp, StringBuffer commandLine) {
// link the process to its build logger via a timestamp
process.setAttribute(IProcess.ATTR_PROCESS_TYPE, IAntUIConstants.ID_ANT_PROCESS_TYPE);
process.setAttribute(AntProcess.ATTR_ANT_PROCESS_ID, idStamp);
// create "fake" command line for the process
if (commandLine != null) {
process.setAttribute(IProcess.ATTR_CMDLINE, commandLine.toString());
}
}
private StringBuffer generateCommandLine(IPath location, String[] arguments, Map userProperties, String[] propertyFiles, String[] targets, String antHome, boolean separateVM) {
StringBuffer commandLine= new StringBuffer();
if (!separateVM) {
commandLine.append("ant"); //$NON-NLS-1$
}
if (arguments != null) {
for (int i = 0; i < arguments.length; i++) {
String arg = arguments[i];
commandLine.append(' ');
commandLine.append(arg);
}
}
AntCorePreferences prefs= AntCorePlugin.getPlugin().getPreferences();
//global
String[] files= prefs.getCustomPropertyFiles();
for (int i = 0; i < files.length; i++) {
String path = files[i];
commandLine.append(" -propertyfile "); //$NON-NLS-1$
commandLine.append(path);
}
//"local" configuration
if (propertyFiles != null) {
for (int i = 0; i < propertyFiles.length; i++) {
String path = propertyFiles[i];
commandLine.append(" -propertyfile "); //$NON-NLS-1$
commandLine.append(path);
}
}
//"local" configuration
if (userProperties != null) {
Iterator keys = userProperties.keySet().iterator();
String key;
while (keys.hasNext()) {
key= (String)keys.next();
appendProperty(commandLine, key, (String)userProperties.get(key));
}
}
//global
Property[] properties= prefs.getCustomProperties();
String key;
for (int i = 0; i < properties.length; i++) {
Property property = properties[i];
key= property.getName();
if (userProperties == null || userProperties.get(key) == null) {
appendProperty(commandLine, key, property.getValue());
}
}
if (antHome != null) {
commandLine.append(" -Dant.home=");
commandLine.append(antHome);
}
if (!separateVM) {
commandLine.append(" -inputhandler "); //$NON-NLS-1$
commandLine.append(INPUT_HANDLER_CLASS);
commandLine.append(" -logger "); //$NON-NLS-1$
commandLine.append(ANT_LOGGER_CLASS);
}
commandLine.append(" -buildfile \""); //$NON-NLS-1$
commandLine.append(location.toOSString() + "\"");
if (targets != null) {
for (int i = 0; i < targets.length; i++) {
commandLine.append(" "); //$NON-NLS-1$
commandLine.append(targets[i]);
}
}
return commandLine;
}
private void appendProperty(StringBuffer commandLine, String name, String value){
commandLine.append(" -D"); //$NON-NLS-1$
commandLine.append(name);
commandLine.append('=');
commandLine.append(value);
}
private void runInSeparateVM(ILaunchConfiguration configuration, ILaunch launch, IProgressMonitor monitor, String idStamp, StringBuffer commandLine) throws CoreException {
ILaunchConfigurationWorkingCopy copy= configuration.getWorkingCopy();
copy.setAttribute(IJavaLaunchConfigurationConstants.ATTR_PROGRAM_ARGUMENTS, commandLine.toString());
JavaLocalApplicationLaunchConfigurationDelegate delegate= new JavaLocalApplicationLaunchConfigurationDelegate();
delegate.launch(copy, ILaunchManager.RUN_MODE, launch, monitor);
IProcess[] processes= launch.getProcesses();
for (int i = 0; i < processes.length; i++) {
IProcess process = processes[i];
setProcessAttributes(process, idStamp, null);
}
}
}