"{ Package: 'stx:libbasic' }"

"{ NameSpace: Smalltalk }"

Object subclass:#OSProcess

	instanceVariableNames:'pid command environment directory inStream outStream errorStream

		auxStream showWindow lineWise newPgrp exitStatus finishSema

		shufflerProcesses streamsToClose terminateActionBlock'

	classVariableNames:''

	poolDictionaries:''

	category:'System-Support'

!

OSProcess subclass:#RemoteOSProcess

	instanceVariableNames:'host'

	classVariableNames:'MethodPerHost'

	poolDictionaries:''

	privateIn:OSProcess

!

!OSProcess class methodsFor:'documentation'!

documentation

"

    Instances of OSProcess represent operating system processes that can be executed.

    (as opposed to Smalltalk processes).

    Both local and remote processes are suported.

    commandString:

     If command is a String, the commandString is passed to a shell for execution

     - see the description of 'sh -c' in your UNIX manual ('cmd.exe' in your Windows manual).

     Regular input/output redirection and pipes etc. are supported as supported by

     the underlying OS's command interpreter (i.e. some limits apply to MSDOS)

     With an empty command, the shell will read commands from the passed input stream.

     If command is an Array, the first element is the command to be executed,

     and the other elements are the arguments to the command. 

     No shell is invoked in this case. Any redirection or piping can then be done

     by Smalltalk code (including piping through smalltalk streams & filters).

    [author:]

        Stefan Vogel (stefan@zwerg)

    [instance variables:]

        pid         SmallInteger    the process id

        command     String          the command line of the running command.

    [class variables:]

    [see also:]

        Process

"

!

examples

"

  send command's output to the Transcript:

                                                            [exBegin]

    OSProcess new 

        terminateActionBlock:[:status | Transcript showCR:status. Transcript showCR:status isError];

        command:'lsxxxx -l';

        outStream:Transcript;

        lineWise:true;

        startProcess.

                                                            [exEnd]

  send command's output to my stdout (see console):

                                                            [exBegin]

    OSProcess new 

        command:'ls -l';

        outStream:Stdout;

        execute.

                                                            [exEnd]

  send command's output to a Smalltalk stream:

                                                            [exBegin]

    |outStream|

    outStream := '' writeStream.

    OSProcess new 

        command:'ls -l';

        outStream:outStream;

        execute.

    outStream contents inspect.

                                                            [exEnd]

  feed it from a smalltalk stream, get command's output into a Smalltalk stream:

                                                            [exBegin]

    |inStream outStream|

    inStream := 'hello world' readStream.

    outStream := '' writeStream.

    OSProcess new 

        command:'tr ''a-z'' ''A-Z''';

        inStream:inStream;

        outStream:outStream;

        execute.

    outStream contents inspect.

                                                            [exEnd]

  again, send output to a Smalltalk stream;

  watch the stream getting filled after 10 seconds:

                                                            [exBegin]

    |outStream|

    outStream := '' writeStream.

    OSProcess new 

        command:'ls -l; sleep 10; echo =================================; echo hallo after 10s; echo >&2 +++++++++++++++++++++; cat >&2';

        outStream:outStream;

        errorStream:outStream;

        startProcess.

    outStream inspect

                                                            [exEnd]

  separate stdout and stderr:

                                                            [exBegin]

    |outStream errStream|

    outStream := '' writeStream.

    errStream := '' writeStream.

    OSProcess new 

        command:'ls -l && ls >&2';

        outStream:outStream;

        errorStream:errStream;

        startProcess.

    outStream inspect.

    errStream inspect.

                                                            [exEnd]

  Execute commands in shell/cmd.exe and read them from stdin:

                                                            [exBegin]

    |outStream|

    outStream := '' writeStream.

    OSProcess new 

        command:'';

        inStream:'ls -l' readStream;

        outStream:outStream;

        lineWise:true;

        execute.

    outStream contents inspect

                                                            [exEnd]

  Execute on a remote host (you must have the appropriate ssh setup):

                                                            [exBegin]

    |outStream|

    outStream := '' writeStream.

    (OSProcess onHost:'exeptn') 

        command:'ls -l';

        outStream:outStream;

        lineWise:true;

        execute.

    outStream contents inspect

                                                            [exEnd]

"

! !

!OSProcess class methodsFor:'instance creation'!

command:aCommandString

    "return an initialized instance to execute aCommandString

     in the current directory (for a local process)"

    ^ self new command:aCommandString.

!

command:aCommandString directory:aStringOrFilename

    "return an initialized instance to execute aCommandString 

     in a given directory (for a local process)"

    ^ self new command:aCommandString directory:aStringOrFilename.

!

commandStringForProgramName:executableFile arguments:arrayOfStrings

    ^ String streamContents:[:s |

        s nextPutAll:(self possiblyQuoted:executableFile asFilename pathName).

    ]

!

new

    "return an initialized instance for a local process"

    ^ self basicNew initialize.

!

onHost:aHost

    "return an initialized instance for a remote process running on another host"

    (SocketAddress hostName:aHost) isLocal ifTrue:[

        ^ self basicNew initialize.

    ].

    ^ RemoteOSProcess basicNew host:aHost; initialize.

    "

     OSProcess onHost:'localhost'

     OSProcess onHost:'exeptn'

     (OSProcess new) command:'ls'

     (OSProcess onHost:'exeptn') command:'ls'

    "

!

possiblyQuoted:aString

    "should we quote or escape?"

    ^ String streamContents:[:s |

        aString do:[:ch |

            (ch isSeparator or:[ch = $\]) ifTrue:[

                s nextPut:$\

            ].

            s nextPut:ch

        ]

    ]

    "

     self possiblyQuoted:'foo bar' 

     self possiblyQuoted:'foo\bar'

    "

!

programName:executableFile arguments:arrayOfStrings initialEnvironment:stringDictionary

    "similar to command:, but with separate command and arguments"

    ^ self new

        command:(self commandStringForProgramName:executableFile arguments:arrayOfStrings);

        environment:stringDictionary;

        yourself

! !

!OSProcess class methodsFor:'class initialization'!

initialize

    "Backward compatibility: Win32Process is an alias for OSProcess"

    Win32Process := self.

! !

!OSProcess class methodsFor:'queries'!

defaultShellPath

    OperatingSystem isUNIXlike ifTrue:[

        ^ OperatingSystem getEnvironment:'SHELL' 

    ].

    ^ 'cmd'

! !

!OSProcess methodsFor:'accessing'!

auxStream

    ^ auxStream

!

auxStream:something

    "set an auxiliary input stream that will be available to the command as

     file descriptor 3"

    auxStream := something.

    "Modified (comment): / 23-02-2017 / 10:56:57 / Maren"

!

command

    "the OS (shell-) command"

    ^ command

    "Created: / 10.11.1998 / 21:27:07 / cg"

!

command:aStringOrArray 

    "set the command to be executed.

     If aStringOrArray is a String, the commandString is passed to a shell for execution

     - see the description of 'sh -c' in your UNIX manual ('cmd.exe' in your Windows manual).

     With an empty command, the shell will read commands from the passed input stream.

     If aCommandString is an Array, the first element is the command to be executed,

     and the other elements are the arguments to the command. 

     No shell is invoked in this case."

    command := aStringOrArray.

!

command:commandStringArg directory:stringOrFilenameArg

    "set the command to be executed and directory, where to execute.

     If aStringOrArray is a String, the commandString is passed to a shell for execution

     - see the description of 'sh -c' in your UNIX manual ('cmd.exe' in your Windows manual).

     If aCommandString is an Array, the first element is the command to be executed,

     and the other elements are the arguments to the command. No shell is invoked in this case."

    command := commandStringArg.

    directory := stringOrFilenameArg.

!

command:commandArg environment:environmentArg directory:directoryArg inStream:inStreamArg outStream:outStreamArg errorStream:errorStreamArg auxStream:auxStreamArg showWindow:showWindowArg lineWise:lineWiseArg 

    "set the command to be executed & directory, where to execute.

     and input/output streams.

     See comments in individual setters for more info"

    command := commandArg.

    environment := environmentArg.

    directory := directoryArg.

    inStream := inStreamArg.

    outStream := outStreamArg.

    errorStream := errorStreamArg.

    auxStream := auxStreamArg.

    showWindow := showWindowArg.

    lineWise := lineWiseArg.

!

directory

    "the directory where executed"

    ^ directory

    "Created: / 10.11.1998 / 21:21:52 / cg"

!

directory:aStringOrFilename

    "set the directory that will be set as the current directory of the command to be executed"

    directory := aStringOrFilename.

!

environment

    "the shell environment"

    ^ environment

    "Created: / 10.11.1998 / 21:26:34 / cg"

!

environment:aDictionary

    "set the environment variables of the command to be executed"

    environment := aDictionary.

!

errorStream

    ^ errorStream

    "Created: / 10.11.1998 / 21:26:34 / cg"

!

errorStream:aStream

    "set the stream where the stderr output of the command is directed to"

    errorStream := aStream.

!

exitStatus

    "answer the exit status of the command or nil, if the command has not yet been finished"

    ^ exitStatus

!

exitStatus:something

    "set the value of the instance variable 'exitStatus' (automatically generated)"

    exitStatus := something.

    "Created: / 10.11.1998 / 21:24:55 / cg"

!

finishSema

    "wait on this semaphore if you want to wait until the OS process has finished.

     There may be multiple waiters, so it is a good idea to do a #waitUncounted"

    ^ finishSema

    "Modified (comment): / 23-02-2017 / 10:53:17 / Maren"

!

inStream

    ^ inStream

    "Created: / 10.11.1998 / 21:26:34 / cg"

!

inStream:aStream

    "set the stream where the stdin input of the command is read from"

    inStream := aStream.

!

lineWise

    ^ lineWise

!

lineWise:aBoolean

    "When setting to true, read linewise from the command's output and error.

     This is a bit slower than lineWise = false.

     You may use it also when streaming to e.g. Transcript"

    lineWise := aBoolean.

!

newPgrp

    ^ newPgrp

!

newPgrp:aBoolean

    "if aBoolean is true, a new process group will be created for the command and its subprocesses"

    newPgrp := aBoolean.

!

outStream

    "the stream where the stdout output of the command is directed to"

    ^ outStream

    "Created: / 10.11.1998 / 21:26:34 / cg"

!

outStream:aStream

    "set the stream where the stdout output of the command is directed to"

    outStream := aStream.

!

pid

    "answer the pid of the process the command is running in or nil, if the command has not yet been started."

    ^ pid

!

showWindow

    ^ showWindow

!

showWindow:aBooleanOrNil

    "This parameter is ignored on Unix systems.

     You can control (have to - sigh) if a window should be shown for the command or not.

     This is the OS's H_SHOWWINDOW argument.

     If you pass nil as showWindow-argument, the OS's default is used for the particular

     command, which is correct most of the time: i.e. a notepad will open its window, other (non-UI)

     executables will not.

     However, some command-line executables show a window, even if they should not.

     (and also, there seems to be an inconsistency between windows7 and newer windows: in newer,

     a shell command opens a cmd-window, whereas in windows7 it did not)

     In this case, pass an explicit false argument to suppress it."

    showWindow := aBooleanOrNil.

!

terminateActionBlock

    "the (user provided) callback block,

     that will be executed when the command has finished or was terminated.

     If non-nil, it will be called with optional argument:status and:self, the OSProcess."

    ^ terminateActionBlock