bug 261976: CommandLauncher to report about $PATH problems and related

clean-up

build/org.eclipse.cdt.make.core/src/org/eclipse/cdt/make/core/MakeBuilder.java

@@ -256,24 +256,12 @@ public class MakeBuilder extends ACBuilder {
 				getProject().setSessionProperty(qName, !monitor.isCanceled() && !isClean ? new Integer(streamMon.getWorkDone()) : null);
 
 				if (errMsg != null) {
-					StringBuffer buf = new StringBuffer(buildCommand.toString() + " "); //$NON-NLS-1$
+					consoleErr.write((errMsg + '\n').getBytes());
-					for (String buildArgument : buildArguments) {
-						buf.append(buildArgument);
-						buf.append(' ');
-					}
-
-					String errorDesc = MakeMessages.getFormattedString("MakeBuilder.buildError", buf.toString()); //$NON-NLS-1$
-					buf = new StringBuffer(errorDesc);
-					buf.append(System.getProperty("line.separator", "\n")); //$NON-NLS-1$ //$NON-NLS-2$
-					buf.append("(").append(errMsg).append(")"); //$NON-NLS-1$ //$NON-NLS-2$
-					cos.write(buf.toString().getBytes());
-					cos.flush();
 				}
 
 				stdout.close();
 				stderr.close();
 
-				monitor.subTask(MakeMessages.getString("MakeBuilder.Creating_Markers")); //$NON-NLS-1$
 				consoleOut.close();
 				consoleErr.close();
 				cos.close();

build/org.eclipse.cdt.make.core/src/org/eclipse/cdt/make/internal/core/MakeMessages.properties

@@ -13,7 +13,6 @@
 AbstractGCCBOPConsoleParser_EnteringDirectory=Entering directory
 AbstractGCCBOPConsoleParser_LeavingDirectory=Leaving directory
 
-MakeBuilder.buildError=Error launching builder ({0})
 MakeBuilder.Invoking_Make_Builder=Invoking Make Builder...
 MakeBuilder.Invoking_Command=Invoking Command: 
 MakeBuilder.Updating_project=Updating project...
@@ -41,9 +40,7 @@ ExternalScannerInfoProvider.Reading_Specs=Reading specs ...
 ExternalScannerInfoProvider.Invoking_Command=Invoking Command: 
 ExternalScannerInfoProvider.Parsing_Output=Parsing output ... 
 ExternalScannerInfoProvider.Creating_Markers=Generating markers ... 
-# Error_Prefix affects generation of markers in the Problems view
+ExternalScannerInfoProvider.Provider_Error=Warning: Error launching external scanner info generator ({0})
-ExternalScannerInfoProvider.Error_Prefix=Warning: 
-ExternalScannerInfoProvider.Provider_Error=Error launching external scanner info generator ({0})
 ExternalScannerInfoProvider.Working_Directory=Working directory: {0}
 ExternalScannerInfoProvider.Program_Not_In_Path=Program ''{0}'' is not found in $PATH
 

build/org.eclipse.cdt.make.core/src/org/eclipse/cdt/make/internal/core/scannerconfig2/DefaultRunSIProvider.java

@@ -37,7 +37,6 @@ import org.eclipse.cdt.make.internal.core.StreamMonitor;
 import org.eclipse.cdt.make.internal.core.scannerconfig.ScannerConfigUtil;
 import org.eclipse.cdt.make.internal.core.scannerconfig.ScannerInfoConsoleParserFactory;
 import org.eclipse.cdt.utils.EFSExtensionManager;
-import org.eclipse.cdt.utils.PathUtil;
 import org.eclipse.core.resources.IProject;
 import org.eclipse.core.resources.IResource;
 import org.eclipse.core.runtime.IPath;
@@ -55,11 +54,9 @@ import org.osgi.service.prefs.BackingStoreException;
  * @author vhirsl
  */
 public class DefaultRunSIProvider implements IExternalScannerInfoProvider {
-    private static final String EXTERNAL_SI_PROVIDER_ERROR = "ExternalScannerInfoProvider.Provider_Error"; //$NON-NLS-1$
 	private static final String GMAKE_ERROR_PARSER_ID = "org.eclipse.cdt.core.GmakeErrorParser"; //$NON-NLS-1$
 	private static final String PREF_CONSOLE_ENABLED = "org.eclipse.cdt.make.core.scanner.discovery.console.enabled"; //$NON-NLS-1$
 	private static final String NEWLINE = System.getProperty("line.separator", "\n"); //$NON-NLS-1$ //$NON-NLS-2$
-	private static final String PATH_ENV = "PATH"; //$NON-NLS-1$
 
 	protected IResource resource;
 	protected String providerId;
@@ -127,10 +124,11 @@ public class DefaultRunSIProvider implements IExternalScannerInfoProvider {
 			launcher.showCommand(true);
 
 			String[] comandLineOptions = getCommandLineOptions();
+			IPath program = getCommandToLaunch();
 			String params = coligate(comandLineOptions);
 
 			monitor.subTask(MakeMessages.getString("ExternalScannerInfoProvider.Invoking_Command")  //$NON-NLS-1$
-                    + getCommandToLaunch() + params);
+					+ program + params);
 
 			ErrorParserManager epm = new ErrorParserManager(currentProject, markerGenerator, new String[] {GMAKE_ERROR_PARSER_ID});
 			epm.setOutputStream(cos);
@@ -142,10 +140,10 @@ public class DefaultRunSIProvider implements IExternalScannerInfoProvider {
 					stdout, stderr, currentProject, context, providerId, buildInfo, collector, markerGenerator);
 			OutputStream consoleOut = (sniffer == null ? cos : sniffer.getOutputStream());
 			OutputStream consoleErr = (sniffer == null ? cos : sniffer.getErrorStream());
-            Process p = launcher.execute(getCommandToLaunch(), comandLineOptions, setEnvironment(launcher, env), fWorkingDirectory, monitor);
+			Process p = launcher.execute(program, comandLineOptions, setEnvironment(launcher, env), fWorkingDirectory, monitor);
 			if (p != null) {
 				try {
-                    // Close the input of the Process explicitely.
+					// Close the input of the Process explicitly.
 					// We will never write to it.
 					p.getOutputStream().close();
 				} catch (IOException e) {
@@ -154,37 +152,13 @@ public class DefaultRunSIProvider implements IExternalScannerInfoProvider {
 					errMsg = launcher.getErrorMessage();
 				}
 				monitor.subTask(MakeMessages.getString("ExternalScannerInfoProvider.Parsing_Output")); //$NON-NLS-1$
-            }
+			} else {
-            else {
 				errMsg = launcher.getErrorMessage();
 			}
 
 			if (errMsg != null) {
-				String errorPrefix = MakeMessages.getString("ExternalScannerInfoProvider.Error_Prefix"); //$NON-NLS-1$
-				String program = fCompileCommand.toString();
-
-				String msg = MakeMessages.getFormattedString(EXTERNAL_SI_PROVIDER_ERROR, program+params);
-				printLine(consoleErr, errorPrefix + msg + NEWLINE);
-
-				// Launching failed, trying to figure out possible cause
-				Properties envMap = getEnvMap(launcher, env);
-				String envPath = envMap.getProperty(PATH_ENV);
-				if (envPath == null) {
-					envPath = System.getenv(PATH_ENV);
-				}
-				if (!fCompileCommand.isAbsolute() && PathUtil.findProgramLocation(program, envPath) == null) {
 				printLine(consoleErr, errMsg);
-					msg = MakeMessages.getFormattedString("ExternalScannerInfoProvider.Working_Directory", fWorkingDirectory); //$NON-NLS-1$
+				printLine(consoleErr, MakeMessages.getFormattedString("ExternalScannerInfoProvider.Provider_Error", program + params) + NEWLINE); //$NON-NLS-1$
-					msg = MakeMessages.getFormattedString("ExternalScannerInfoProvider.Program_Not_In_Path", program); //$NON-NLS-1$
-					printLine(consoleErr, errorPrefix + msg + NEWLINE);
-					printLine(consoleErr, PATH_ENV + "=[" + envPath + "]" + NEWLINE); //$NON-NLS-1$ //$NON-NLS-2$
-				} else {
-					printLine(consoleErr, errorPrefix + errMsg);
-					msg = MakeMessages.getFormattedString("ExternalScannerInfoProvider.Working_Directory", fWorkingDirectory); //$NON-NLS-1$
-					printLine(consoleErr, PATH_ENV + "=[" + envPath + "]" + NEWLINE); //$NON-NLS-1$ //$NON-NLS-2$
-				}
-
-				monitor.subTask(MakeMessages.getString("ExternalScannerInfoProvider.Creating_Markers")); //$NON-NLS-1$
 			}
 
 			consoleOut.close();

build/org.eclipse.cdt.managedbuilder.core/src/org/eclipse/cdt/managedbuilder/core/ExternalBuildRunner.java

@@ -47,7 +47,6 @@ import org.eclipse.cdt.managedbuilder.macros.IBuildMacroProvider;
 import org.eclipse.cdt.newmake.internal.core.StreamMonitor;
 import org.eclipse.cdt.utils.CommandLineUtil;
 import org.eclipse.cdt.utils.EFSExtensionManager;
-import org.eclipse.cdt.utils.PathUtil;
 import org.eclipse.core.resources.IMarker;
 import org.eclipse.core.resources.IProject;
 import org.eclipse.core.resources.IResource;
@@ -208,29 +207,12 @@ public class ExternalBuildRunner extends AbstractBuildRunner {
 					} catch (CoreException e) {
 					}
 				} else {
-					buf = new StringBuffer(launcher.getCommandLine()).append(NEWLINE);
 					errMsg = launcher.getErrorMessage();
 				}
 				project.setSessionProperty(qName, !monitor.isCanceled() && !isClean ? new Integer(streamMon.getWorkDone()) : null);
 
 				if (errMsg != null) {
-					// Launching failed, trying to figure out possible cause
+					consoleErr.write(errMsg.getBytes());
-					String errorPrefix = ManagedMakeMessages.getResourceString("ManagedMakeBuilder.error.prefix"); //$NON-NLS-1$
-					String buildCommandStr = buildCommand.toString();
-					String envPath = envMap.get(PATH_ENV);
-					if (envPath==null) {
-						envPath = System.getenv(PATH_ENV);
-					}
-					if (PathUtil.findProgramLocation(buildCommandStr, envPath)==null) {
-						buf.append(errMsg).append(NEWLINE);
-						errMsg = ManagedMakeMessages.getFormattedString("ManagedMakeBuilder.message.program.not.in.path", buildCommandStr); //$NON-NLS-1$
-						buf.append(errorPrefix).append(errMsg).append(NEWLINE);
-						buf.append(NEWLINE);
-						buf.append(PATH_ENV+"=["+envPath+"]").append(NEWLINE); //$NON-NLS-1$//$NON-NLS-2$
-					} else {
-						buf.append(errorPrefix).append(errMsg).append(NEWLINE);
-					}
-					consoleErr.write(buf.toString().getBytes());
 					consoleErr.flush();
 				}
 

build/org.eclipse.cdt.managedbuilder.core/src/org/eclipse/cdt/managedbuilder/internal/buildmodel/CommandBuilder.java

@@ -21,8 +21,6 @@ import java.util.Set;
 import org.eclipse.cdt.core.CommandLauncher;
 import org.eclipse.cdt.core.ICommandLauncher;
 import org.eclipse.cdt.managedbuilder.buildmodel.IBuildCommand;
-import org.eclipse.cdt.managedbuilder.internal.core.ManagedMakeMessages;
-import org.eclipse.cdt.utils.PathUtil;
 import org.eclipse.core.runtime.CoreException;
 import org.eclipse.core.runtime.IProgressMonitor;
 import org.eclipse.core.runtime.SubProgressMonitor;
@@ -90,9 +88,7 @@ public class CommandBuilder implements IBuildModelBuilder {
 	 * @see org.eclipse.cdt.managedbuilder.internal.builddescription.IBuildDescriptionBuilder#build(java.io.OutputStream, java.io.OutputStream, org.eclipse.core.runtime.IProgressMonitor)
 	 */
 	@Override
-	public int build(OutputStream out, OutputStream err,
+	public int build(OutputStream out, OutputStream err, IProgressMonitor monitor){
-			IProgressMonitor monitor){
-
 		//TODO: should we display the command line here?
 		monitor.beginTask("", getNumCommands());	//$NON-NLS-1$
 		monitor.subTask(""/*getCommandLine()*/);	//$NON-NLS-1$
@@ -112,17 +108,18 @@ public class CommandBuilder implements IBuildModelBuilder {
 			return STATUS_ERROR_LAUNCH;
 		}
 
+		int st = ICommandLauncher.ILLEGAL_COMMAND;
 		if (fProcess != null) {
 			try {
 				// Close the input of the process since we will never write to it
 				fProcess.getOutputStream().close();
 			} catch (IOException e) {
 			}
+			//wrapping out and err streams to avoid their closure
+			st = launcher.waitAndRead(wrap(out), wrap(err),
+					new SubProgressMonitor(monitor,	getNumCommands()));
 		}
 
-		//wrapping out and err streams to avoid their closure
-		int st = launcher.waitAndRead(wrap(out), wrap(err),
-				new SubProgressMonitor(monitor,	getNumCommands()));
 		switch(st){
 		case ICommandLauncher.OK:
 			if(fProcess.exitValue() != 0)
@@ -143,19 +140,7 @@ public class CommandBuilder implements IBuildModelBuilder {
 			if(DbgUtil.DEBUG)
 				DbgUtil.trace("error launching the command: " + fErrMsg);	//$NON-NLS-1$
 
-			String program = fCmd.getCommand().toOSString();
-			String envPath = fCmd.getEnvironment().get(PATH_ENV);
-			if (envPath==null) {
-				envPath = System.getenv(PATH_ENV);
-			}
-			if (PathUtil.findProgramLocation(program, envPath)==null) {
 			printMessage(fErrMsg, out);
-				String errMsg = ManagedMakeMessages.getFormattedString("ManagedMakeBuilder.message.program.not.in.path", program); //$NON-NLS-1$
-				printErrorMessage(errMsg + NEWLINE, out);
-				printMessage(null, PATH_ENV+"=["+envPath+"]", out); //$NON-NLS-1$//$NON-NLS-2$
-			} else {
-				printErrorMessage(fErrMsg, out);
-			}
 			break;
 		}
 
@@ -185,14 +170,10 @@ public class CommandBuilder implements IBuildModelBuilder {
 		return list.toArray(new String[list.size()]);
 	}
 
-	private void printMessage(String prefix, String msg, OutputStream os){
+	protected void printMessage(String msg, OutputStream os){
 		if (os != null) {
-			if (prefix==null) {
-				prefix=""; //$NON-NLS-1$
-			}
-			msg = prefix + msg + NEWLINE;
 			try {
-				os.write(msg.getBytes());
+				os.write((msg + NEWLINE).getBytes());
 				os.flush();
 			} catch (IOException e) {
 				// ignore;
@@ -201,22 +182,6 @@ public class CommandBuilder implements IBuildModelBuilder {
 
 	}
 
-	protected void printMessage(String msg, OutputStream os){
-		if (os != null) {
-			msg = ManagedMakeMessages.getFormattedString("InternalBuilder.msg.header", msg); //$NON-NLS-1$
-			printMessage(null, msg, os);
-		}
-
-	}
-
-	private void printErrorMessage(String msg, OutputStream os){
-		if (os != null) {
-			String errorPrefix = ManagedMakeMessages.getResourceString("ManagedMakeBuilder.error.prefix"); //$NON-NLS-1$
-			printMessage(errorPrefix, msg, os);
-		}
-
-	}
-
 	public int getNumCommands() {
 		return 1;
 	}

build/org.eclipse.cdt.managedbuilder.core/src/org/eclipse/cdt/managedbuilder/internal/core/GeneratedMakefileBuilder.java

@@ -1125,9 +1125,7 @@ public class GeneratedMakefileBuilder extends ACBuilder {
 				// Report either the success or failure of our mission
 				buf = new StringBuffer();
 				if (errMsg != null && errMsg.length() > 0) {
-					String errorDesc = ManagedMakeMessages.getResourceString(BUILD_ERROR);
+					buf.append(errMsg).append(NEWLINE);
-					buf.append(errorDesc).append(NEWLINE);
-					buf.append("(").append(errMsg).append(")"); //$NON-NLS-1$ //$NON-NLS-2$ 
 				} else {
 					// Report a successful build
 					String successMsg = ManagedMakeMessages.getFormattedString(BUILD_FINISHED,

core/org.eclipse.cdt.core/src/org/eclipse/cdt/core/CommandLauncher.java

@@ -35,6 +35,7 @@ public class CommandLauncher implements ICommandLauncher {
 	public final static int OK = ICommandLauncher.OK;
 
 	private static final String PATH_ENV = "PATH"; //$NON-NLS-1$
+	private static final String NEWLINE = System.getProperty("line.separator", "\n"); //$NON-NLS-1$ //$NON-NLS-2$
 
 	protected Process fProcess;
 	protected boolean fShowCommand;
@@ -42,8 +43,6 @@ public class CommandLauncher implements ICommandLauncher {
 	private Properties fEnvironment = null;
 
 	protected String fErrorMessage = ""; //$NON-NLS-1$
-
-	private String lineSeparator;
 	private IProject fProject;
 
 	/**
@@ -59,7 +58,6 @@ public class CommandLauncher implements ICommandLauncher {
 	public CommandLauncher() {
 		fProcess = null;
 		fShowCommand = false;
-		lineSeparator = System.getProperty("line.separator", "\n"); //$NON-NLS-1$ //$NON-NLS-2$
 	}
 
 	/* (non-Javadoc)
@@ -161,21 +159,16 @@ public class CommandLauncher implements ICommandLauncher {
 	 * @see org.eclipse.cdt.core.ICommandLauncher#execute(IPath, String[], String[], IPath, IProgressMonitor)
 	 */
 	@Override
-	public Process execute(IPath commandPath, String[] args, String[] env, IPath changeToDirectory, IProgressMonitor monitor) throws CoreException {
+	public Process execute(IPath commandPath, String[] args, String[] env, IPath workingDirectory, IProgressMonitor monitor) throws CoreException {
-		try {
+		Boolean isFound = null;
 		String command = commandPath.toOSString();
+		String envPathValue = (String) getEnvironment().get(PATH_ENV);
+		try {
 			fCommandArgs = constructCommandArray(command, args);
-			fEnvironment = parseEnv(env);
-
-			File file = null;
-
-			if(changeToDirectory != null)
-				file = changeToDirectory.toFile();
-
 			if (Platform.getOS().equals(Platform.OS_WIN32)) {
 				// Handle cygwin link
-				String envPathValue = (String) getEnvironment().get(PATH_ENV);
 				IPath location = PathUtil.findProgramLocation(command, envPathValue);
+				isFound = location != null;
 				if (location != null) {
 					try {
 						fCommandArgs[0] = Cygwin.cygwinToWindowsPath(location.toString(), envPathValue);
@@ -185,11 +178,33 @@ public class CommandLauncher implements ICommandLauncher {
 				}
 			}
 
-			fProcess = ProcessFactory.getFactory().exec(fCommandArgs, env, file);
+			fEnvironment = parseEnv(env);
+			File dir = workingDirectory != null ? workingDirectory.toFile() : null;
+
+			fProcess = ProcessFactory.getFactory().exec(fCommandArgs, env, dir);
 			fCommandArgs[0] = command; // to print original command on the console
 			fErrorMessage = ""; //$NON-NLS-1$
 		} catch (IOException e) {
-			setErrorMessage(e.getMessage());
+			if (isFound == null) {
+				IPath location = PathUtil.findProgramLocation(command, envPathValue);
+				isFound = location != null;
+			}
+
+			String errorMessage = getCommandLineQuoted(fCommandArgs, true);
+			String exMsg = e.getMessage();
+			if (exMsg != null && !exMsg.isEmpty()) {
+				errorMessage = errorMessage + exMsg + NEWLINE;
+			}
+
+			if (!isFound) {
+				if (envPathValue == null) {
+					envPathValue = System.getenv(PATH_ENV);
+				}
+				errorMessage = errorMessage + NEWLINE
+						+ "Error: Program \"" + command + "\" not found in PATH" + NEWLINE
+						+ "PATH=[" + envPathValue + "]" + NEWLINE;
+			}
+			setErrorMessage(errorMessage);
 			fProcess = null;
 		}
 		return fProcess;
@@ -254,23 +269,10 @@ public class CommandLauncher implements ICommandLauncher {
 		return state;
 	}
 
-	@SuppressWarnings("nls")
 	protected void printCommandLine(OutputStream os) {
 		if (os != null) {
-			StringBuffer buf = new StringBuffer();
-			if (fCommandArgs != null) {
-				for (String commandArg : getCommandArgs()) {
-					if (commandArg.contains(" ") || commandArg.contains("\"") || commandArg.contains("\\")) {
-						commandArg = '"' + commandArg.replaceAll("\\\\", "\\\\\\\\").replaceAll("\"", "\\\\\"") + '"';
-					}
-					buf.append(commandArg);
-					buf.append(' ');
-				}
-				buf.append(lineSeparator);
-			}
-
 			try {
-				os.write(buf.toString().getBytes());
+				os.write(getCommandLineQuoted(getCommandArgs(), true).getBytes());
 				os.flush();
 			} catch (IOException e) {
 				// ignore;
@@ -278,18 +280,26 @@ public class CommandLauncher implements ICommandLauncher {
 		}
 	}
 
-	protected String getCommandLine(String[] commandArgs) {
+	@SuppressWarnings("nls")
+	private String getCommandLineQuoted(String[] commandArgs, boolean quote) {
 		StringBuffer buf = new StringBuffer();
-		if (fCommandArgs != null) {
+		if (commandArgs != null) {
 			for (String commandArg : commandArgs) {
+				if (quote && (commandArg.contains(" ") || commandArg.contains("\"") || commandArg.contains("\\"))) {
+					commandArg = '"' + commandArg.replaceAll("\\\\", "\\\\\\\\").replaceAll("\"", "\\\\\"") + '"';
+				}
 				buf.append(commandArg);
 				buf.append(' ');
 			}
-			buf.append(lineSeparator);
+			buf.append(NEWLINE);
 		}
 		return buf.toString();
 	}
 
+	protected String getCommandLine(String[] commandArgs) {
+		return getCommandLineQuoted(commandArgs, false);
+	}
+
 
 	/**
 	 * @since 5.1

core/org.eclipse.cdt.core/src/org/eclipse/cdt/core/ICommandLauncher.java

@@ -55,6 +55,7 @@ public interface ICommandLauncher {
 	 * execution.
 	 *
 	 * @return A String corresponding to the error, or <code>null</code> if there has been no error.
+	 *   The message could be multi-line, however it is NOT guaranteed that it ends with end of line.
 	 */
 	public  String getErrorMessage();
 
@@ -95,7 +96,7 @@ public interface ICommandLauncher {
 	 * @param env The list of environment variables in variable=value format.
 	 * @throws CoreException if there is an error executing the command.
 	 */
-	public Process execute(IPath commandPath, String[] args, String[] env, IPath changeToDirectory, IProgressMonitor monitor) throws CoreException;
+	public Process execute(IPath commandPath, String[] args, String[] env, IPath workingDirectory, IProgressMonitor monitor) throws CoreException;
 
 	/**
 	 * Reads output form the process to the streams.