Visual FoxPro

Receive from an SSH Channel Until Any Pattern Matches

Demonstrates the Chilkat Ssh.ChannelReceiveUntilMatchN method, which works like ChannelReceiveUntilMatch but returns when any pattern in a StringArray matches. The arguments are the channel number, the pattern array, the charset, and case sensitivity. The array must contain at least one element.

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: A command often has more than one possible outcome, and your code should react to whichever occurs rather than hang waiting for one specific string. A common non-interactive pattern is to have the command print one marker on success and a different marker on failure, then match on the set. (With no PTY there is no shell prompt to match against, so markers you emit yourself are the dependable signal.) The first matching content in the stream wins; array order does not override an earlier token. Empty elements are ignored and duplicates are allowed.

Chilkat Visual FoxPro Downloads

Download Chilkat for Visual FoxPro

Visual FoxPro

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

lnSuccess = 0

*  Demonstrates the Ssh.ChannelReceiveUntilMatchN method, which receives text until ANY pattern
*  in a StringArray is matched.  The 1st argument is the channel number, the 2nd is the array of
*  patterns, the 3rd is the charset, and the 4th selects case-sensitive matching.

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 match on.  Instead, run a command that prints one marker on success
*  and a different marker on failure, then wait for whichever appears first.
lnSuccess = loSsh.ChannelSendString(lnChannelNum,"test -f /etc/hosts && echo OK_MARKER || echo ERR_MARKER" + CHR(10),"utf-8")
IF (lnSuccess = 0) THEN
    ? loSsh.LastErrorText
    RELEASE loSsh
    CANCEL
ENDIF

loPatterns = CreateObject('Chilkat.StringArray')
loPatterns.Append("OK_MARKER")
loPatterns.Append("ERR_MARKER")

*  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

lnCaseSensitive = 0
lnSuccess = loSsh.ChannelReceiveUntilMatchN(lnChannelNum,loPatterns,"utf-8",lnCaseSensitive)
IF (lnSuccess = 0) THEN
    ? loSsh.LastErrorText
    RELEASE loSsh
    RELEASE loPatterns
    CANCEL
ENDIF

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

? lcOutput

loSsh.Disconnect()

RELEASE loSsh
RELEASE loPatterns