Package org.jruby.util

Class ShellLauncher

java.lang.Object

org.jruby.util.ShellLauncher

public class ShellLauncher
extends Object

This mess of a class is what happens when all Java gives you is Runtime.getRuntime().exec(). Thanks dude, that really helped.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
private static class	ShellLauncher.ChannelPumper
static class	ShellLauncher.LaunchConfig
private static interface	ShellLauncher.PidGetter
static class	ShellLauncher.POpenProcess
private static interface	ShellLauncher.Pumper
private static class	ShellLauncher.ScriptThreadProcess
private static class	ShellLauncher.StreamPumper

Field Summary

Fields

Modifier and Type	Field	Description
private static final boolean	DEBUG
private static final String[]	DEFAULT_PATH
private static final String	PATH_ENV
private static final ShellLauncher.PidGetter	PID_GETTER
private static final Class	ProcessImpl
private static final Field	ProcessImpl_handle
private static final Pattern	SHELL_METACHARACTER_PATTERN
private static final Class	UNIXProcess
private static final Field	UNIXProcess_pid
private static final Pattern	WIN_ENVVAR_PATTERN
private static final String[]	WINDOWS_EXE_SUFFIXES
private static final String[]	WINDOWS_INTERNAL_CMDS

Constructor Summary

Constructors

Constructor	Description
ShellLauncher()

Method Summary

Modifier and Type	Method	Description
private static String[]	arrayOfLength(String[] ary, int len)
static Process	buildProcess(Ruby runtime, String[] args, String[] env, File pwd)
static String	changeDirInsideJar(Ruby runtime, String arg)
private static boolean	changeDirInsideJar(Ruby runtime, String[] args)
static int	execAndWait(Ruby runtime, IRubyObject[] rawArgs)
static int	execAndWait(Ruby runtime, IRubyObject[] rawArgs, Map mergeEnv)
private static String[]	expandGlobs(Ruby runtime, String[] originalArgs)
private static boolean	filenameIsPathSearchable(String fname, boolean forExec)
static File	findPathExecutable(Ruby runtime, String fname)
static File	findPathExecutable(Ruby runtime, String fname, IRubyObject pathObject)
private static File	findPathFile(Ruby runtime, String fname, String[] path, boolean isExec)
static String[]	getCurrentEnv(Ruby runtime)
private static String[]	getCurrentEnv(Ruby runtime, Map mergeEnv)
static String[]	getModifiedEnv(Ruby runtime, Collection mergeEnv, boolean clearEnv)
private static String	getPathEntry(RubyArray initArray)
static long	getPidFromProcess(Process process)
private static String	getShell(Ruby runtime)
private static void	handleStreams(Ruby runtime, Process p, InputStream in, OutputStream out, OutputStream err)
private static void	handleStreamsNonblocking(Ruby runtime, Process p, OutputStream out, OutputStream err)
private static boolean	hasGlobCharacter(String word)
private static boolean	hasLeadingArgvArray(IRubyObject[] rawArgs)	Takes an argument array suitable for Kernel#exec or similar, and indicates whether it has a leading two-element array giving the path and argv[0] entries separately.
private static File	isValidFile(Ruby runtime, String fname, boolean isExec)
private static File	isValidFile(Ruby runtime, String fdir, String fname, boolean isExec)
(package private) static void	log(Ruby runtime, String msg)
private static String[]	parseCommandLine(ThreadContext context, Ruby runtime, IRubyObject[] rawArgs)
static ShellLauncher.POpenProcess	popen(Ruby runtime, IRubyObject[] strings, Map env, IOOptions modes)	Deprecated.
static ShellLauncher.POpenProcess	popen(Ruby runtime, IRubyObject[] strings, Map env, ModeFlags modes)
static ShellLauncher.POpenProcess	popen(Ruby runtime, IRubyObject string, Map env, ModeFlags modes)
static ShellLauncher.POpenProcess	popen(Ruby runtime, IRubyObject string, IOOptions modes)	Deprecated.
static ShellLauncher.POpenProcess	popen(Ruby runtime, IRubyObject string, ModeFlags modes)
static ShellLauncher.POpenProcess	popen3(Ruby runtime, IRubyObject[] strings)	Deprecated.
static ShellLauncher.POpenProcess	popen3(Ruby runtime, IRubyObject[] strings, boolean addShell)	Deprecated.
private static Process	popenShared(Ruby runtime, IRubyObject[] strings)
private static Process	popenShared(Ruby runtime, IRubyObject[] strings, Map env)
private static Process	popenShared(Ruby runtime, IRubyObject[] strings, Map env, boolean addShell)
static long	reflectPidFromProcess(Process process)
static Process	run(Ruby runtime, Map env, String dir, IRubyObject[] rawArgs, boolean doExecutableSearch, boolean forceExternalProcess)
static Process	run(Ruby runtime, IRubyObject string)
static Process	run(Ruby runtime, IRubyObject[] rawArgs, boolean doExecutableSearch)
static Process	run(Ruby runtime, IRubyObject[] rawArgs, boolean doExecutableSearch, boolean forceExternalProcess)
static int	runAndWait(Ruby runtime, IRubyObject[] rawArgs)
static int	runAndWait(Ruby runtime, IRubyObject[] rawArgs, OutputStream output)
static int	runAndWait(Ruby runtime, IRubyObject[] rawArgs, OutputStream output, boolean doExecutableSearch)
static long[]	runAndWaitPid(Ruby runtime, IRubyObject[] rawArgs)
static long[]	runAndWaitPid(Ruby runtime, IRubyObject[] rawArgs, OutputStream output, boolean doExecutableSearch)
static long	runExternal(Ruby runtime, IRubyObject env, IRubyObject prog, IRubyObject options, IRubyObject args, boolean wait)
static int	runExternalAndWait(Ruby runtime, IRubyObject[] rawArgs, Map mergeEnv)
static long	runExternalWithoutWait(Ruby runtime, IRubyObject[] rawArgs)
static long	runExternalWithoutWait(Ruby runtime, IRubyObject env, IRubyObject prog, IRubyObject options, IRubyObject args)
static long	runWithoutWait(Ruby runtime, IRubyObject[] rawArgs)
private static long	runWithoutWait(Ruby runtime, IRubyObject[] rawArgs, OutputStream output)
static boolean	shouldUseShell(String command)
private static File	tryFile(Ruby runtime, String fdir, String fname)
static InputStream	unwrapBufferedStream(InputStream filteredStream)	Deprecated.
static OutputStream	unwrapBufferedStream(OutputStream filteredStream)	Deprecated.
static InputStream	unwrapFilterInputStream(InputStream filteredStream)	Deprecated.
static OutputStream	unwrapFilterOutputStream(OutputStream filteredStream)	Deprecated.
private static boolean	withExeSuffix(String fname)

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Details

DEBUG

private static final boolean DEBUG

See Also:

• Constant Field Values

PATH_ENV

private static final String PATH_ENV

See Also:

• Constant Field Values

DEFAULT_PATH

private static final String[] DEFAULT_PATH

WINDOWS_EXE_SUFFIXES

private static final String[] WINDOWS_EXE_SUFFIXES

WINDOWS_INTERNAL_CMDS

private static final String[] WINDOWS_INTERNAL_CMDS

SHELL_METACHARACTER_PATTERN

private static final Pattern SHELL_METACHARACTER_PATTERN

WIN_ENVVAR_PATTERN

private static final Pattern WIN_ENVVAR_PATTERN

UNIXProcess

private static final Class UNIXProcess

UNIXProcess_pid

private static final Field UNIXProcess_pid

ProcessImpl

private static final Class ProcessImpl

ProcessImpl_handle

private static final Field ProcessImpl_handle

PID_GETTER

private static final ShellLauncher.PidGetter PID_GETTER

Constructor Details

ShellLauncher

public ShellLauncher()

Method Details

getCurrentEnv

public static String[] getCurrentEnv(Ruby runtime)

getCurrentEnv

private static String[] getCurrentEnv(Ruby runtime,
 Map mergeEnv)

getModifiedEnv

public static String[] getModifiedEnv(Ruby runtime,
 Collection mergeEnv,
 boolean clearEnv)

arrayOfLength

private static String[] arrayOfLength(String[] ary,
 int len)

filenameIsPathSearchable

private static boolean filenameIsPathSearchable(String fname,
 boolean forExec)

tryFile

private static File tryFile(Ruby runtime,
 String fdir,
 String fname)

withExeSuffix

private static boolean withExeSuffix(String fname)

isValidFile

private static File isValidFile(Ruby runtime,
 String fdir,
 String fname,
 boolean isExec)

isValidFile

private static File isValidFile(Ruby runtime,
 String fname,
 boolean isExec)

findPathFile

private static File findPathFile(Ruby runtime,
 String fname,
 String[] path,
 boolean isExec)

findPathExecutable

public static File findPathExecutable(Ruby runtime,
 String fname)

findPathExecutable

public static File findPathExecutable(Ruby runtime,
 String fname,
 IRubyObject pathObject)

runAndWait

public static int runAndWait(Ruby runtime,
 IRubyObject[] rawArgs)

runAndWaitPid

public static long[] runAndWaitPid(Ruby runtime,
 IRubyObject[] rawArgs)

runWithoutWait

public static long runWithoutWait(Ruby runtime,
 IRubyObject[] rawArgs)

runExternalAndWait

public static int runExternalAndWait(Ruby runtime,
 IRubyObject[] rawArgs,
 Map mergeEnv)

runExternalWithoutWait

public static long runExternalWithoutWait(Ruby runtime,
 IRubyObject env,
 IRubyObject prog,
 IRubyObject options,
 IRubyObject args)

runExternal

public static long runExternal(Ruby runtime,
 IRubyObject env,
 IRubyObject prog,
 IRubyObject options,
 IRubyObject args,
 boolean wait)

changeDirInsideJar

private static boolean changeDirInsideJar(Ruby runtime,
 String[] args)

changeDirInsideJar

public static String changeDirInsideJar(Ruby runtime,
 String arg)

buildProcess

public static Process buildProcess(Ruby runtime,
 String[] args,
 String[] env,
 File pwd)
                            throws IOException

Throws:

IOException

runExternalWithoutWait

public static long runExternalWithoutWait(Ruby runtime,
 IRubyObject[] rawArgs)

execAndWait

public static int execAndWait(Ruby runtime,
 IRubyObject[] rawArgs)

execAndWait

public static int execAndWait(Ruby runtime,
 IRubyObject[] rawArgs,
 Map mergeEnv)

runAndWait

public static int runAndWait(Ruby runtime,
 IRubyObject[] rawArgs,
 OutputStream output)

runAndWait

public static int runAndWait(Ruby runtime,
 IRubyObject[] rawArgs,
 OutputStream output,
 boolean doExecutableSearch)

runAndWaitPid

public static long[] runAndWaitPid(Ruby runtime,
 IRubyObject[] rawArgs,
 OutputStream output,
 boolean doExecutableSearch)

runWithoutWait

private static long runWithoutWait(Ruby runtime,
 IRubyObject[] rawArgs,
 OutputStream output)

getPidFromProcess

public static long getPidFromProcess(Process process)

reflectPidFromProcess

public static long reflectPidFromProcess(Process process)

run

public static Process run(Ruby runtime,
 IRubyObject string)
                   throws IOException

Throws:

IOException

popen

public static ShellLauncher.POpenProcess popen(Ruby runtime,
 IRubyObject string,
 ModeFlags modes)
                                        throws IOException

Throws:

IOException

popen

public static ShellLauncher.POpenProcess popen(Ruby runtime,
 IRubyObject[] strings,
 Map env,
 ModeFlags modes)
                                        throws IOException

Throws:

IOException

popen

public static ShellLauncher.POpenProcess popen(Ruby runtime,
 IRubyObject string,
 Map env,
 ModeFlags modes)
                                        throws IOException

Throws:

IOException

popen

@Deprecated
public static ShellLauncher.POpenProcess popen(Ruby runtime,
 IRubyObject string,
 IOOptions modes)
                                        throws IOException

Deprecated.

Throws:

IOException

popen

@Deprecated
public static ShellLauncher.POpenProcess popen(Ruby runtime,
 IRubyObject[] strings,
 Map env,
 IOOptions modes)
                                        throws IOException

Deprecated.

Throws:

IOException

popen3

@Deprecated
public static ShellLauncher.POpenProcess popen3(Ruby runtime,
 IRubyObject[] strings)
                                         throws IOException

Deprecated.

Throws:

IOException

popen3

@Deprecated
public static ShellLauncher.POpenProcess popen3(Ruby runtime,
 IRubyObject[] strings,
 boolean addShell)
                                         throws IOException

Deprecated.

Throws:

IOException

popenShared

private static Process popenShared(Ruby runtime,
 IRubyObject[] strings)
                            throws IOException

Throws:

IOException

popenShared

private static Process popenShared(Ruby runtime,
 IRubyObject[] strings,
 Map env)
                            throws IOException

Throws:

IOException

popenShared

private static Process popenShared(Ruby runtime,
 IRubyObject[] strings,
 Map env,
 boolean addShell)
                            throws IOException

Throws:

IOException

run

public static Process run(Ruby runtime,
 IRubyObject[] rawArgs,
 boolean doExecutableSearch)
                   throws IOException

Throws:

IOException

hasGlobCharacter

private static boolean hasGlobCharacter(String word)

expandGlobs

private static String[] expandGlobs(Ruby runtime,
 String[] originalArgs)

run

public static Process run(Ruby runtime,
 IRubyObject[] rawArgs,
 boolean doExecutableSearch,
 boolean forceExternalProcess)
                   throws IOException

Throws:

IOException

run

public static Process run(Ruby runtime,
 Map env,
 String dir,
 IRubyObject[] rawArgs,
 boolean doExecutableSearch,
 boolean forceExternalProcess)
                   throws IOException

Throws:

IOException

handleStreams

private static void handleStreams(Ruby runtime,
 Process p,
 InputStream in,
 OutputStream out,
 OutputStream err)
                           throws IOException

Throws:

IOException

handleStreamsNonblocking

private static void handleStreamsNonblocking(Ruby runtime,
 Process p,
 OutputStream out,
 OutputStream err)
                                      throws IOException

Throws:

IOException

parseCommandLine

private static String[] parseCommandLine(ThreadContext context,
 Ruby runtime,
 IRubyObject[] rawArgs)

hasLeadingArgvArray

private static boolean hasLeadingArgvArray(IRubyObject[] rawArgs)

Takes an argument array suitable for Kernel#exec or similar, and indicates whether it has a leading two-element array giving the path and argv[0] entries separately. We can't use the argv[0] entry through ProcessBuilder, so we discard it.

getPathEntry

private static String getPathEntry(RubyArray initArray)

getShell

private static String getShell(Ruby runtime)

shouldUseShell

public static boolean shouldUseShell(String command)

log

static void log(Ruby runtime,
 String msg)

unwrapBufferedStream

@Deprecated
public static OutputStream unwrapBufferedStream(OutputStream filteredStream)

Deprecated.

unwrapBufferedStream

@Deprecated
public static InputStream unwrapBufferedStream(InputStream filteredStream)

Deprecated.

unwrapFilterOutputStream

@Deprecated
public static OutputStream unwrapFilterOutputStream(OutputStream filteredStream)

Deprecated.

unwrapFilterInputStream

@Deprecated
public static InputStream unwrapFilterInputStream(InputStream filteredStream)

Deprecated.