Visual FoxPro

Receive from an SSH Channel Until a Pattern Matches

Demonstrates the Chilkat Ssh.ChannelReceiveUntilMatch method, which receives text until the accumulated text matches a pattern. The arguments are the channel number, the pattern, the charset, and whether matching is case-sensitive. Existing buffered text is checked before waiting for more network data.

Important: Set the ReadTimeoutMs property before calling this method. It defaults to 0, meaning no limit, so without it the call waits forever if the received data never contains a match.

Background: Driving a shell channel means knowing when the remote side has finished talking. With no PTY requested the shell is non-interactive and never prints a prompt, so the reliable signal is a marker you deliberately echo after your command. This method automates "read until you see X." The pattern syntax is deliberately minimal: literal characters plus *, which matches zero or more characters and can span line breaks. ? and bracket classes are not supported, and backslash does not escape a literal *.

Chilkat Visual FoxPro Downloads

Download Chilkat for Visual FoxPro

Visual FoxPro

LOCAL lnSuccess
LOCAL loSsh
LOCAL lnSshPort
LOCAL lcPassword
LOCAL lnChannelNum
LOCAL lnCaseSensitive
LOCAL lcOutput

lnSuccess = 0

*  Demonstrates the Ssh.ChannelReceiveUntilMatch method, which receives text until the
*  accumulated text matches a pattern.  The 1st argument is the channel number, the 2nd is the
*  pattern, the 3rd is the charset, and the 4th selects case-sensitive matching.  The pattern
*  supports literal characters plus "*", which matches zero or more characters.

loSsh = CreateObject('Chilkat.Ssh')

lnSshPort = 22
lnSuccess = loSsh.Connect("ssh.example.com",lnSshPort)
IF (lnSuccess = 0) THEN
    ? loSsh.LastErrorText
    RELEASE loSsh
    CANCEL
ENDIF

*  Normally you would not hard-code the password in source.  You should instead obtain it
*  from an interactive prompt, environment variable, or a secrets vault.
lcPassword = "mySshPassword"

lnSuccess = loSsh.AuthenticatePw("mySshLogin",lcPassword)
IF (lnSuccess = 0) THEN
    ? loSsh.LastErrorText
    RELEASE loSsh
    CANCEL
ENDIF

lnChannelNum = loSsh.OpenSessionChannel()
IF (lnChannelNum < 0) THEN
    ? loSsh.LastErrorText
    RELEASE loSsh
    CANCEL
ENDIF

*  Start a shell WITHOUT requesting a PTY.  Without a PTY the shell sees it is connected to a
*  raw data pipe and enters non-interactive mode: it suppresses the command prompt, does not
*  echo typed commands back, and skips interactive login scripts.  The output is therefore
*  clean and easily parseable -- but because no prompt is ever sent, code must not wait for
*  one.  Instead, have each command print a predictable marker, or wait for EOF / channel close.
lnSuccess = loSsh.SendReqShell(lnChannelNum)
IF (lnSuccess = 0) THEN
    ? loSsh.LastErrorText
    RELEASE loSsh
    CANCEL
ENDIF

*  There is no prompt to wait for, so make the command itself announce when it has finished
*  by echoing a marker after it.
lnSuccess = loSsh.ChannelSendString(lnChannelNum,"ls -l /tmp; echo DONE_MARKER" + CHR(10),"utf-8")
IF (lnSuccess = 0) THEN
    ? loSsh.LastErrorText
    RELEASE loSsh
    CANCEL
ENDIF

*  IMPORTANT: Set a read timeout before receiving until a match.  ReadTimeoutMs defaults to 0,
*  which means no limit -- without it, this call waits forever if the received data never
*  contains a match.
loSsh.ReadTimeoutMs = 15000

*  Receive until the marker appears in the output.
lnCaseSensitive = 0
lnSuccess = loSsh.ChannelReceiveUntilMatch(lnChannelNum,"DONE_MARKER","utf-8",lnCaseSensitive)
IF (lnSuccess = 0) THEN
    ? loSsh.LastErrorText
    RELEASE loSsh
    CANCEL
ENDIF

lcOutput = loSsh.GetReceivedText(lnChannelNum,"utf-8")
IF (loSsh.LastMethodSuccess = 0) THEN
    ? loSsh.LastErrorText
    RELEASE loSsh
    CANCEL
ENDIF

? lcOutput

loSsh.Disconnect()

RELEASE loSsh