(Visual FoxPro) SSH ReceiveUntilMatchN

Demonstrates how to call the SSH ChannelReceiveUntilMatchN method.

Chilkat ActiveX Downloads ActiveX for 32-bit and 64-bit Windows

LOCAL loSsh
LOCAL lnSuccess
LOCAL loSaPrompts
LOCAL lcCmdOutput
LOCAL lcHostname
LOCAL lnPort
LOCAL lnChannelNum
LOCAL lcTermType
LOCAL lnWidthInChars
LOCAL lnHeightInChars
LOCAL lnPixWidth
LOCAL lnPixHeight
LOCAL lnCaseSensitiveMatch
LOCAL lnPollTimeoutMs
LOCAL n

* This example assumes the Chilkat API to have been previously unlocked.
* See Global Unlock Sample for sample code.

* For versions of Chilkat < 10.0.0, use CreateObject('Chilkat_9_5_0.Ssh')
loSsh = CreateObject('Chilkat.Ssh')

* For the sake of the example, pretend the remote shell prompt
* will be any of the following:
* For versions of Chilkat < 10.0.0, use CreateObject('Chilkat_9_5_0.StringArray')
loSaPrompts = CreateObject('Chilkat.StringArray')

loSaPrompts.Append("~$")
loSaPrompts.Append("mars#")
loSaPrompts.Append("jupiter%")
loSaPrompts.Append("chilkat$")
loSaPrompts.Append("admin>")

* Connect to an SSH server:
* Hostname may be an IP address or hostname:
lcHostname = "www.some-ssh-server.com"
lnPort = 22

lnSuccess = loSsh.Connect(lcHostname,lnPort)
IF (lnSuccess <> 1) THEN
    ? loSsh.LastErrorText
    RELEASE loSsh
    RELEASE loSaPrompts
    CANCEL
ENDIF

* Wait a max of 10 seconds when reading responses..
loSsh.IdleTimeoutMs = 10000

* Authenticate using login/password:
lnSuccess = loSsh.AuthenticatePw("myLogin","myPassword")
IF (lnSuccess <> 1) THEN
    ? loSsh.LastErrorText
    RELEASE loSsh
    RELEASE loSaPrompts
    CANCEL
ENDIF

* Open a session channel.  (It is possible to have multiple
* session channels open simultaneously.)
lnChannelNum = loSsh.OpenSessionChannel()
IF (lnChannelNum < 0) THEN
    ? loSsh.LastErrorText
    RELEASE loSsh
    RELEASE loSaPrompts
    CANCEL
ENDIF

lcTermType = "dumb"
lnWidthInChars = 120
lnHeightInChars = 40
* Use 0 for pixWidth and pixHeight when the dimensions
* are set in number-of-chars.
lnPixWidth = 0
lnPixHeight = 0
lnSuccess = loSsh.SendReqPty(lnChannelNum,lcTermType,lnWidthInChars,lnHeightInChars,lnPixWidth,lnPixHeight)
IF (lnSuccess <> 1) THEN
    ? loSsh.LastErrorText
    RELEASE loSsh
    RELEASE loSaPrompts
    CANCEL
ENDIF

* Start a shell on the channel:
lnSuccess = loSsh.SendReqShell(lnChannelNum)
IF (lnSuccess <> 1) THEN
    ? loSsh.LastErrorText
    RELEASE loSsh
    RELEASE loSaPrompts
    CANCEL
ENDIF

*  Run the 1st command in the remote shell, which will be to
*  "cd" to a subdirectory.
lnSuccess = loSsh.ChannelSendString(lnChannelNum,"cd workspace" + CHR(10),"utf-8")
IF (lnSuccess <> 1) THEN
    ? loSsh.LastErrorText
    RELEASE loSsh
    RELEASE loSaPrompts
    CANCEL
ENDIF

* Retrieve the output to the next prompt:
lnCaseSensitiveMatch = 1
lnSuccess = loSsh.ChannelReceiveUntilMatchN(lnChannelNum,loSaPrompts,"utf-8",lnCaseSensitiveMatch)
IF (lnSuccess <> 1) THEN
    ? loSsh.LastErrorText
    RELEASE loSsh
    RELEASE loSaPrompts
    CANCEL
ENDIF

*  Display what we've received so far.  This clears
*  the internal receive buffer, which is important.
*  After we send the command, we'll be reading until
*  the next command prompt.  If the command prompt
*  is already in the internal receive buffer, it'll think it's
*  already finished...
lcCmdOutput = loSsh.GetReceivedText(lnChannelNum,"utf-8")
IF (loSsh.LastMethodSuccess <> 1) THEN
    ? loSsh.LastErrorText
    RELEASE loSsh
    RELEASE loSaPrompts
    CANCEL
ENDIF

? lcCmdOutput

*  Run the 2nd command in the remote shell, which will be
*  to "ls" the directory.
lnSuccess = loSsh.ChannelSendString(lnChannelNum,"ls" + CHR(10),"utf-8")
IF (lnSuccess <> 1) THEN
    ? loSsh.LastErrorText
    RELEASE loSsh
    RELEASE loSaPrompts
    CANCEL
ENDIF

* Retrieve and display the output.
lnSuccess = loSsh.ChannelReceiveUntilMatchN(lnChannelNum,loSaPrompts,"utf-8",lnCaseSensitiveMatch)
IF (lnSuccess <> 1) THEN
    ? loSsh.LastErrorText
    RELEASE loSsh
    RELEASE loSaPrompts
    CANCEL
ENDIF

lcCmdOutput = loSsh.GetReceivedText(lnChannelNum,"utf-8")
IF (loSsh.LastMethodSuccess <> 1) THEN
    ? loSsh.LastErrorText
    RELEASE loSsh
    RELEASE loSaPrompts
    CANCEL
ENDIF

? lcCmdOutput

*  Start the final command in the remote shell.  This example
*  will send a "ls -l" command to retrieve the long format directory listing.
lnSuccess = loSsh.ChannelSendString(lnChannelNum,"ls -l" + CHR(10),"utf-8")
IF (lnSuccess <> 1) THEN
    ? loSsh.LastErrorText
    RELEASE loSsh
    RELEASE loSaPrompts
    CANCEL
ENDIF

* Send an EOF.  This tells the server that no more data will 
* be sent on this channel.  The channel remains open, and
* the SSH client may still receive output on this channel.
lnSuccess = loSsh.ChannelSendEof(lnChannelNum)
IF (lnSuccess <> 1) THEN
    ? loSsh.LastErrorText
    RELEASE loSsh
    RELEASE loSaPrompts
    CANCEL
ENDIF

* Read whatever output may already be available on the
* SSH connection.  ChannelReadAndPoll returns the number of bytes
* that are available in the channel's internal buffer that
* are ready to be "picked up" by calling GetReceivedText
* or GetReceivedData.
* A return value of -1 indicates failure.
* A return value of -2 indicates a failure via timeout.

* The ChannelReadAndPoll method waits
* for data to arrive on the connection usingi the IdleTimeoutMs
* property setting.  Once the first data arrives, it continues
* reading but instead uses the pollTimeoutMs passed in the 2nd argument:
* A return value of -2 indicates a timeout where no data is received.
lnPollTimeoutMs = 2000
n = loSsh.ChannelReadAndPoll(lnChannelNum,lnPollTimeoutMs)
IF (n < 0) THEN
    ? loSsh.LastErrorText
    RELEASE loSsh
    RELEASE loSaPrompts
    CANCEL
ENDIF

* Close the channel:
lnSuccess = loSsh.ChannelSendClose(lnChannelNum)
IF (lnSuccess <> 1) THEN
    ? loSsh.LastErrorText
    RELEASE loSsh
    RELEASE loSaPrompts
    CANCEL
ENDIF

* Perhaps we did not receive all of the commands output.
* To make sure,  call ChannelReceiveToClose to accumulate any remaining
* output until the server's corresponding "channel close" is received.
lnSuccess = loSsh.ChannelReceiveToClose(lnChannelNum)
IF (lnSuccess <> 1) THEN
    ? loSsh.LastErrorText
    RELEASE loSsh
    RELEASE loSaPrompts
    CANCEL
ENDIF

lcCmdOutput = loSsh.GetReceivedText(lnChannelNum,"utf-8")
IF (loSsh.LastMethodSuccess <> 1) THEN
    ? loSsh.LastErrorText
    RELEASE loSsh
    RELEASE loSaPrompts
    CANCEL
ENDIF

? lcCmdOutput

* Disconnect
loSsh.Disconnect()

RELEASE loSsh
RELEASE loSaPrompts